tree-pass.h (TDF_EH): Define.
[official-gcc.git] / gcc / doc / invoke.texi
blobcbef029120c25bade052fd870ba7710b68e032cb
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 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
311 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
312 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
313 -ftest-coverage  -ftime-report -fvar-tracking @gol
314 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
315 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
316 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
317 -fdebug-prefix-map=@var{old}=@var{new} @gol
318 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
319 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
320 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
321 -print-multi-directory  -print-multi-lib @gol
322 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
323 -print-sysroot -print-sysroot-headers-suffix @gol
324 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
326 @item Optimization Options
327 @xref{Optimize Options,,Options that Control Optimization}.
328 @gccoptlist{
329 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
330 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
331 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
332 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
333 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
334 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
335 -fdata-sections -fdce -fdce @gol
336 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
337 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
338 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
339 -fforward-propagate -ffunction-sections @gol
340 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
341 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
342 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
343 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
344 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
345 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
346 -fira-region=@var{region} -fira-coalesce -fno-ira-share-save-slots @gol
347 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
348 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
349 -floop-block -floop-interchange -floop-strip-mine @gol
350 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
351 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
352 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
353 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
354 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
355 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
356 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
357 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
358 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
359 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
360 -fprofile-generate=@var{path} @gol
361 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
362 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
363 -freorder-blocks-and-partition -freorder-functions @gol
364 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
365 -frounding-math -fsched2-use-superblocks @gol
366 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
367 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
368 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
369 -fsched-spec-insn-heuristic -fsched-reg-pressure-heuristic @gol
370 -fsched-rank-heuristic -fsched-last-insn-heuristic @gol
371 -fsched-dep-count-heuristic @gol
372 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
373 -fselective-scheduling -fselective-scheduling2 @gol
374 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
375 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
376 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
377 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
378 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
379 -ftree-copyrename -ftree-dce @gol
380 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
381 -ftree-phiprop -ftree-loop-distribution @gol
382 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
383 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
384 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
385 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
386 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
387 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
388 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
389 -fwhole-program @gol
390 --param @var{name}=@var{value}
391 -O  -O0  -O1  -O2  -O3  -Os}
393 @item Preprocessor Options
394 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
395 @gccoptlist{-A@var{question}=@var{answer} @gol
396 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
397 -C  -dD  -dI  -dM  -dN @gol
398 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
399 -idirafter @var{dir} @gol
400 -include @var{file}  -imacros @var{file} @gol
401 -iprefix @var{file}  -iwithprefix @var{dir} @gol
402 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
403 -imultilib @var{dir} -isysroot @var{dir} @gol
404 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
405 -P  -fworking-directory  -remap @gol
406 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
407 -Xpreprocessor @var{option}}
409 @item Assembler Option
410 @xref{Assembler Options,,Passing Options to the Assembler}.
411 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
413 @item Linker Options
414 @xref{Link Options,,Options for Linking}.
415 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
416 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
417 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
418 -shared-libgcc  -symbolic @gol
419 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
420 -u @var{symbol}}
422 @item Directory Options
423 @xref{Directory Options,,Options for Directory Search}.
424 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
425 -specs=@var{file}  -I- --sysroot=@var{dir}}
427 @item Target Options
428 @c I wrote this xref this way to avoid overfull hbox. -- rms
429 @xref{Target Options}.
430 @gccoptlist{-V @var{version}  -b @var{machine}}
432 @item Machine Dependent Options
433 @xref{Submodel Options,,Hardware Models and Configurations}.
434 @c This list is ordered alphanumerically by subsection name.
435 @c Try and put the significant identifier (CPU or system) first,
436 @c so users have a clue at guessing where the ones they want will be.
438 @emph{ARC Options}
439 @gccoptlist{-EB  -EL @gol
440 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
441 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
443 @emph{ARM Options}
444 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
445 -mabi=@var{name} @gol
446 -mapcs-stack-check  -mno-apcs-stack-check @gol
447 -mapcs-float  -mno-apcs-float @gol
448 -mapcs-reentrant  -mno-apcs-reentrant @gol
449 -msched-prolog  -mno-sched-prolog @gol
450 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
451 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
452 -mfp16-format=@var{name}
453 -mthumb-interwork  -mno-thumb-interwork @gol
454 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
455 -mstructure-size-boundary=@var{n} @gol
456 -mabort-on-noreturn @gol
457 -mlong-calls  -mno-long-calls @gol
458 -msingle-pic-base  -mno-single-pic-base @gol
459 -mpic-register=@var{reg} @gol
460 -mnop-fun-dllimport @gol
461 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
462 -mpoke-function-name @gol
463 -mthumb  -marm @gol
464 -mtpcs-frame  -mtpcs-leaf-frame @gol
465 -mcaller-super-interworking  -mcallee-super-interworking @gol
466 -mtp=@var{name} @gol
467 -mword-relocations @gol
468 -mfix-cortex-m3-ldrd}
470 @emph{AVR Options}
471 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
472 -mcall-prologues  -mtiny-stack  -mint8}
474 @emph{Blackfin Options}
475 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
476 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
477 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
478 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
479 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
480 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
481 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
482 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
483 -micplb}
485 @emph{CRIS Options}
486 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
487 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
488 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
489 -mstack-align  -mdata-align  -mconst-align @gol
490 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
491 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
492 -mmul-bug-workaround  -mno-mul-bug-workaround}
494 @emph{CRX Options}
495 @gccoptlist{-mmac -mpush-args}
497 @emph{Darwin Options}
498 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
499 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
500 -client_name  -compatibility_version  -current_version @gol
501 -dead_strip @gol
502 -dependency-file  -dylib_file  -dylinker_install_name @gol
503 -dynamic  -dynamiclib  -exported_symbols_list @gol
504 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
505 -force_flat_namespace  -headerpad_max_install_names @gol
506 -iframework @gol
507 -image_base  -init  -install_name  -keep_private_externs @gol
508 -multi_module  -multiply_defined  -multiply_defined_unused @gol
509 -noall_load   -no_dead_strip_inits_and_terms @gol
510 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
511 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
512 -private_bundle  -read_only_relocs  -sectalign @gol
513 -sectobjectsymbols  -whyload  -seg1addr @gol
514 -sectcreate  -sectobjectsymbols  -sectorder @gol
515 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
516 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
517 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
518 -single_module  -static  -sub_library  -sub_umbrella @gol
519 -twolevel_namespace  -umbrella  -undefined @gol
520 -unexported_symbols_list  -weak_reference_mismatches @gol
521 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
522 -mkernel -mone-byte-bool}
524 @emph{DEC Alpha Options}
525 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
526 -mieee  -mieee-with-inexact  -mieee-conformant @gol
527 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
528 -mtrap-precision=@var{mode}  -mbuild-constants @gol
529 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
530 -mbwx  -mmax  -mfix  -mcix @gol
531 -mfloat-vax  -mfloat-ieee @gol
532 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
533 -msmall-text  -mlarge-text @gol
534 -mmemory-latency=@var{time}}
536 @emph{DEC Alpha/VMS Options}
537 @gccoptlist{-mvms-return-codes}
539 @emph{FR30 Options}
540 @gccoptlist{-msmall-model -mno-lsim}
542 @emph{FRV Options}
543 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
544 -mhard-float  -msoft-float @gol
545 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
546 -mdouble  -mno-double @gol
547 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
548 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
549 -mlinked-fp  -mlong-calls  -malign-labels @gol
550 -mlibrary-pic  -macc-4  -macc-8 @gol
551 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
552 -moptimize-membar -mno-optimize-membar @gol
553 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
554 -mvliw-branch  -mno-vliw-branch @gol
555 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
556 -mno-nested-cond-exec  -mtomcat-stats @gol
557 -mTLS -mtls @gol
558 -mcpu=@var{cpu}}
560 @emph{GNU/Linux Options}
561 @gccoptlist{-muclibc}
563 @emph{H8/300 Options}
564 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
566 @emph{HPPA Options}
567 @gccoptlist{-march=@var{architecture-type} @gol
568 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
569 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
570 -mfixed-range=@var{register-range} @gol
571 -mjump-in-delay -mlinker-opt -mlong-calls @gol
572 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
573 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
574 -mno-jump-in-delay  -mno-long-load-store @gol
575 -mno-portable-runtime  -mno-soft-float @gol
576 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
577 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
578 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
579 -munix=@var{unix-std}  -nolibdld  -static  -threads}
581 @emph{i386 and x86-64 Options}
582 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
583 -mfpmath=@var{unit} @gol
584 -masm=@var{dialect}  -mno-fancy-math-387 @gol
585 -mno-fp-ret-in-387  -msoft-float @gol
586 -mno-wide-multiply  -mrtd  -malign-double @gol
587 -mpreferred-stack-boundary=@var{num}
588 -mincoming-stack-boundary=@var{num}
589 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
590 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
591 -maes -mpclmul @gol
592 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
593 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
594 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
595 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
596 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
597 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
598 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
599 -mcmodel=@var{code-model} -mabi=@var{name} @gol
600 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
601 -mfused-madd -mno-fused-madd -msse2avx}
603 @emph{IA-64 Options}
604 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
605 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
606 -mconstant-gp  -mauto-pic  -mfused-madd @gol
607 -minline-float-divide-min-latency @gol
608 -minline-float-divide-max-throughput @gol
609 -mno-inline-float-divide @gol
610 -minline-int-divide-min-latency @gol
611 -minline-int-divide-max-throughput  @gol
612 -mno-inline-int-divide @gol
613 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
614 -mno-inline-sqrt @gol
615 -mdwarf2-asm -mearly-stop-bits @gol
616 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
617 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
618 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
619 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
620 -msched-spec-ldc -msched-spec-control-ldc @gol
621 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
622 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
623 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
624 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
626 @emph{M32R/D Options}
627 @gccoptlist{-m32r2 -m32rx -m32r @gol
628 -mdebug @gol
629 -malign-loops -mno-align-loops @gol
630 -missue-rate=@var{number} @gol
631 -mbranch-cost=@var{number} @gol
632 -mmodel=@var{code-size-model-type} @gol
633 -msdata=@var{sdata-type} @gol
634 -mno-flush-func -mflush-func=@var{name} @gol
635 -mno-flush-trap -mflush-trap=@var{number} @gol
636 -G @var{num}}
638 @emph{M32C Options}
639 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
641 @emph{M680x0 Options}
642 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
643 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
644 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
645 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
646 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
647 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
648 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
649 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
650 -mxgot -mno-xgot}
652 @emph{M68hc1x Options}
653 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
654 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
655 -msoft-reg-count=@var{count}}
657 @emph{MCore Options}
658 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
659 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
660 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
661 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
662 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
664 @emph{MeP Options}
665 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
666 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
667 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
668 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
669 -mtiny=@var{n}}
671 @emph{MIPS Options}
672 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
673 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
674 -mips64  -mips64r2 @gol
675 -mips16  -mno-mips16  -mflip-mips16 @gol
676 -minterlink-mips16  -mno-interlink-mips16 @gol
677 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
678 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
679 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
680 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
681 -mfpu=@var{fpu-type} @gol
682 -msmartmips  -mno-smartmips @gol
683 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
684 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
685 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
686 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
687 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
688 -membedded-data  -mno-embedded-data @gol
689 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
690 -mcode-readable=@var{setting} @gol
691 -msplit-addresses  -mno-split-addresses @gol
692 -mexplicit-relocs  -mno-explicit-relocs @gol
693 -mcheck-zero-division  -mno-check-zero-division @gol
694 -mdivide-traps  -mdivide-breaks @gol
695 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
696 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
697 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
698 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
699 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
700 -mflush-func=@var{func}  -mno-flush-func @gol
701 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
702 -mfp-exceptions -mno-fp-exceptions @gol
703 -mvr4130-align -mno-vr4130-align -msynci -mno-synci}
705 @emph{MMIX Options}
706 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
707 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
708 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
709 -mno-base-addresses  -msingle-exit  -mno-single-exit}
711 @emph{MN10300 Options}
712 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
713 -mam33  -mno-am33 @gol
714 -mam33-2  -mno-am33-2 @gol
715 -mreturn-pointer-on-d0 @gol
716 -mno-crt0  -mrelax}
718 @emph{PDP-11 Options}
719 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
720 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
721 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
722 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
723 -mbranch-expensive  -mbranch-cheap @gol
724 -msplit  -mno-split  -munix-asm  -mdec-asm}
726 @emph{picoChip Options}
727 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
728 -msymbol-as-address -mno-inefficient-warnings}
730 @emph{PowerPC Options}
731 See RS/6000 and PowerPC Options.
733 @emph{RS/6000 and PowerPC Options}
734 @gccoptlist{-mcpu=@var{cpu-type} @gol
735 -mtune=@var{cpu-type} @gol
736 -mpower  -mno-power  -mpower2  -mno-power2 @gol
737 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
738 -maltivec  -mno-altivec @gol
739 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
740 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
741 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
742 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
743 -mnew-mnemonics  -mold-mnemonics @gol
744 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
745 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
746 -malign-power  -malign-natural @gol
747 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
748 -msingle-float -mdouble-float -msimple-fpu @gol
749 -mstring  -mno-string  -mupdate  -mno-update @gol
750 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
751 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
752 -mstrict-align  -mno-strict-align  -mrelocatable @gol
753 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
754 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
755 -mdynamic-no-pic  -maltivec  -mswdiv @gol
756 -mprioritize-restricted-insns=@var{priority} @gol
757 -msched-costly-dep=@var{dependence_type} @gol
758 -minsert-sched-nops=@var{scheme} @gol
759 -mcall-sysv  -mcall-netbsd @gol
760 -maix-struct-return  -msvr4-struct-return @gol
761 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
762 -misel -mno-isel @gol
763 -misel=yes  -misel=no @gol
764 -mspe -mno-spe @gol
765 -mspe=yes  -mspe=no @gol
766 -mpaired @gol
767 -mgen-cell-microcode -mwarn-cell-microcode @gol
768 -mvrsave -mno-vrsave @gol
769 -mmulhw -mno-mulhw @gol
770 -mdlmzb -mno-dlmzb @gol
771 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
772 -mprototype  -mno-prototype @gol
773 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
774 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
776 @emph{S/390 and zSeries Options}
777 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
778 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
779 -mlong-double-64 -mlong-double-128 @gol
780 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
781 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
782 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
783 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
784 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
786 @emph{Score Options}
787 @gccoptlist{-meb -mel @gol
788 -mnhwloop @gol
789 -muls @gol
790 -mmac @gol
791 -mscore5 -mscore5u -mscore7 -mscore7d}
793 @emph{SH Options}
794 @gccoptlist{-m1  -m2  -m2e @gol
795 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
796 -m3  -m3e @gol
797 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
798 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
799 -m5-64media  -m5-64media-nofpu @gol
800 -m5-32media  -m5-32media-nofpu @gol
801 -m5-compact  -m5-compact-nofpu @gol
802 -mb  -ml  -mdalign  -mrelax @gol
803 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
804 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
805 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
806 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
807 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
808 -minvalid-symbols}
810 @emph{SPARC Options}
811 @gccoptlist{-mcpu=@var{cpu-type} @gol
812 -mtune=@var{cpu-type} @gol
813 -mcmodel=@var{code-model} @gol
814 -m32  -m64  -mapp-regs  -mno-app-regs @gol
815 -mfaster-structs  -mno-faster-structs @gol
816 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
817 -mhard-quad-float  -msoft-quad-float @gol
818 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
819 -mstack-bias  -mno-stack-bias @gol
820 -munaligned-doubles  -mno-unaligned-doubles @gol
821 -mv8plus  -mno-v8plus  -mvis  -mno-vis
822 -threads -pthreads -pthread}
824 @emph{SPU Options}
825 @gccoptlist{-mwarn-reloc -merror-reloc @gol
826 -msafe-dma -munsafe-dma @gol
827 -mbranch-hints @gol
828 -msmall-mem -mlarge-mem -mstdmain @gol
829 -mfixed-range=@var{register-range}}
831 @emph{System V Options}
832 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
834 @emph{V850 Options}
835 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
836 -mprolog-function  -mno-prolog-function  -mspace @gol
837 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
838 -mapp-regs  -mno-app-regs @gol
839 -mdisable-callt  -mno-disable-callt @gol
840 -mv850e1 @gol
841 -mv850e @gol
842 -mv850  -mbig-switch}
844 @emph{VAX Options}
845 @gccoptlist{-mg  -mgnu  -munix}
847 @emph{VxWorks Options}
848 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
849 -Xbind-lazy  -Xbind-now}
851 @emph{x86-64 Options}
852 See i386 and x86-64 Options.
854 @emph{i386 and x86-64 Windows Options}
855 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
856 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows}
858 @emph{Xstormy16 Options}
859 @gccoptlist{-msim}
861 @emph{Xtensa Options}
862 @gccoptlist{-mconst16 -mno-const16 @gol
863 -mfused-madd  -mno-fused-madd @gol
864 -mserialize-volatile  -mno-serialize-volatile @gol
865 -mtext-section-literals  -mno-text-section-literals @gol
866 -mtarget-align  -mno-target-align @gol
867 -mlongcalls  -mno-longcalls}
869 @emph{zSeries Options}
870 See S/390 and zSeries Options.
872 @item Code Generation Options
873 @xref{Code Gen Options,,Options for Code Generation Conventions}.
874 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
875 -ffixed-@var{reg}  -fexceptions @gol
876 -fnon-call-exceptions  -funwind-tables @gol
877 -fasynchronous-unwind-tables @gol
878 -finhibit-size-directive  -finstrument-functions @gol
879 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
880 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
881 -fno-common  -fno-ident @gol
882 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
883 -fno-jump-tables @gol
884 -frecord-gcc-switches @gol
885 -freg-struct-return  -fshort-enums @gol
886 -fshort-double  -fshort-wchar @gol
887 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
888 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
889 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
890 -fargument-noalias-global  -fargument-noalias-anything @gol
891 -fleading-underscore  -ftls-model=@var{model} @gol
892 -ftrapv  -fwrapv  -fbounds-check @gol
893 -fvisibility}
894 @end table
896 @menu
897 * Overall Options::     Controlling the kind of output:
898                         an executable, object files, assembler files,
899                         or preprocessed source.
900 * C Dialect Options::   Controlling the variant of C language compiled.
901 * C++ Dialect Options:: Variations on C++.
902 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
903                         and Objective-C++.
904 * Language Independent Options:: Controlling how diagnostics should be
905                         formatted.
906 * Warning Options::     How picky should the compiler be?
907 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
908 * Optimize Options::    How much optimization?
909 * Preprocessor Options:: Controlling header files and macro definitions.
910                          Also, getting dependency information for Make.
911 * Assembler Options::   Passing options to the assembler.
912 * Link Options::        Specifying libraries and so on.
913 * Directory Options::   Where to find header files and libraries.
914                         Where to find the compiler executable files.
915 * Spec Files::          How to pass switches to sub-processes.
916 * Target Options::      Running a cross-compiler, or an old version of GCC.
917 @end menu
919 @node Overall Options
920 @section Options Controlling the Kind of Output
922 Compilation can involve up to four stages: preprocessing, compilation
923 proper, assembly and linking, always in that order.  GCC is capable of
924 preprocessing and compiling several files either into several
925 assembler input files, or into one assembler input file; then each
926 assembler input file produces an object file, and linking combines all
927 the object files (those newly compiled, and those specified as input)
928 into an executable file.
930 @cindex file name suffix
931 For any given input file, the file name suffix determines what kind of
932 compilation is done:
934 @table @gcctabopt
935 @item @var{file}.c
936 C source code which must be preprocessed.
938 @item @var{file}.i
939 C source code which should not be preprocessed.
941 @item @var{file}.ii
942 C++ source code which should not be preprocessed.
944 @item @var{file}.m
945 Objective-C source code.  Note that you must link with the @file{libobjc}
946 library to make an Objective-C program work.
948 @item @var{file}.mi
949 Objective-C source code which should not be preprocessed.
951 @item @var{file}.mm
952 @itemx @var{file}.M
953 Objective-C++ source code.  Note that you must link with the @file{libobjc}
954 library to make an Objective-C++ program work.  Note that @samp{.M} refers
955 to a literal capital M@.
957 @item @var{file}.mii
958 Objective-C++ source code which should not be preprocessed.
960 @item @var{file}.h
961 C, C++, Objective-C or Objective-C++ header file to be turned into a
962 precompiled header.
964 @item @var{file}.cc
965 @itemx @var{file}.cp
966 @itemx @var{file}.cxx
967 @itemx @var{file}.cpp
968 @itemx @var{file}.CPP
969 @itemx @var{file}.c++
970 @itemx @var{file}.C
971 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
972 the last two letters must both be literally @samp{x}.  Likewise,
973 @samp{.C} refers to a literal capital C@.
975 @item @var{file}.mm
976 @itemx @var{file}.M
977 Objective-C++ source code which must be preprocessed.
979 @item @var{file}.mii
980 Objective-C++ source code which should not be preprocessed.
982 @item @var{file}.hh
983 @itemx @var{file}.H
984 @itemx @var{file}.hp
985 @itemx @var{file}.hxx
986 @itemx @var{file}.hpp
987 @itemx @var{file}.HPP
988 @itemx @var{file}.h++
989 @itemx @var{file}.tcc
990 C++ header file to be turned into a precompiled header.
992 @item @var{file}.f
993 @itemx @var{file}.for
994 @itemx @var{file}.ftn
995 Fixed form Fortran source code which should not be preprocessed.
997 @item @var{file}.F
998 @itemx @var{file}.FOR
999 @itemx @var{file}.fpp
1000 @itemx @var{file}.FPP
1001 @itemx @var{file}.FTN
1002 Fixed form Fortran source code which must be preprocessed (with the traditional
1003 preprocessor).
1005 @item @var{file}.f90
1006 @itemx @var{file}.f95
1007 @itemx @var{file}.f03
1008 @itemx @var{file}.f08
1009 Free form Fortran source code which should not be preprocessed.
1011 @item @var{file}.F90
1012 @itemx @var{file}.F95
1013 @itemx @var{file}.F03
1014 @itemx @var{file}.F08
1015 Free form Fortran source code which must be preprocessed (with the
1016 traditional preprocessor).
1018 @c FIXME: Descriptions of Java file types.
1019 @c @var{file}.java
1020 @c @var{file}.class
1021 @c @var{file}.zip
1022 @c @var{file}.jar
1024 @item @var{file}.ads
1025 Ada source code file which contains a library unit declaration (a
1026 declaration of a package, subprogram, or generic, or a generic
1027 instantiation), or a library unit renaming declaration (a package,
1028 generic, or subprogram renaming declaration).  Such files are also
1029 called @dfn{specs}.
1031 @item @var{file}.adb
1032 Ada source code file containing a library unit body (a subprogram or
1033 package body).  Such files are also called @dfn{bodies}.
1035 @c GCC also knows about some suffixes for languages not yet included:
1036 @c Pascal:
1037 @c @var{file}.p
1038 @c @var{file}.pas
1039 @c Ratfor:
1040 @c @var{file}.r
1042 @item @var{file}.s
1043 Assembler code.
1045 @item @var{file}.S
1046 @itemx @var{file}.sx
1047 Assembler code which must be preprocessed.
1049 @item @var{other}
1050 An object file to be fed straight into linking.
1051 Any file name with no recognized suffix is treated this way.
1052 @end table
1054 @opindex x
1055 You can specify the input language explicitly with the @option{-x} option:
1057 @table @gcctabopt
1058 @item -x @var{language}
1059 Specify explicitly the @var{language} for the following input files
1060 (rather than letting the compiler choose a default based on the file
1061 name suffix).  This option applies to all following input files until
1062 the next @option{-x} option.  Possible values for @var{language} are:
1063 @smallexample
1064 c  c-header  c-cpp-output
1065 c++  c++-header  c++-cpp-output
1066 objective-c  objective-c-header  objective-c-cpp-output
1067 objective-c++ objective-c++-header objective-c++-cpp-output
1068 assembler  assembler-with-cpp
1070 f77  f77-cpp-input f95  f95-cpp-input
1071 java
1072 @end smallexample
1074 @item -x none
1075 Turn off any specification of a language, so that subsequent files are
1076 handled according to their file name suffixes (as they are if @option{-x}
1077 has not been used at all).
1079 @item -pass-exit-codes
1080 @opindex pass-exit-codes
1081 Normally the @command{gcc} program will exit with the code of 1 if any
1082 phase of the compiler returns a non-success return code.  If you specify
1083 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1084 numerically highest error produced by any phase that returned an error
1085 indication.  The C, C++, and Fortran frontends return 4, if an internal
1086 compiler error is encountered.
1087 @end table
1089 If you only want some of the stages of compilation, you can use
1090 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1091 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1092 @command{gcc} is to stop.  Note that some combinations (for example,
1093 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1095 @table @gcctabopt
1096 @item -c
1097 @opindex c
1098 Compile or assemble the source files, but do not link.  The linking
1099 stage simply is not done.  The ultimate output is in the form of an
1100 object file for each source file.
1102 By default, the object file name for a source file is made by replacing
1103 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1105 Unrecognized input files, not requiring compilation or assembly, are
1106 ignored.
1108 @item -S
1109 @opindex S
1110 Stop after the stage of compilation proper; do not assemble.  The output
1111 is in the form of an assembler code file for each non-assembler input
1112 file specified.
1114 By default, the assembler file name for a source file is made by
1115 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1117 Input files that don't require compilation are ignored.
1119 @item -E
1120 @opindex E
1121 Stop after the preprocessing stage; do not run the compiler proper.  The
1122 output is in the form of preprocessed source code, which is sent to the
1123 standard output.
1125 Input files which don't require preprocessing are ignored.
1127 @cindex output file option
1128 @item -o @var{file}
1129 @opindex o
1130 Place output in file @var{file}.  This applies regardless to whatever
1131 sort of output is being produced, whether it be an executable file,
1132 an object file, an assembler file or preprocessed C code.
1134 If @option{-o} is not specified, the default is to put an executable
1135 file in @file{a.out}, the object file for
1136 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1137 assembler file in @file{@var{source}.s}, a precompiled header file in
1138 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1139 standard output.
1141 @item -v
1142 @opindex v
1143 Print (on standard error output) the commands executed to run the stages
1144 of compilation.  Also print the version number of the compiler driver
1145 program and of the preprocessor and the compiler proper.
1147 @item -###
1148 @opindex ###
1149 Like @option{-v} except the commands are not executed and all command
1150 arguments are quoted.  This is useful for shell scripts to capture the
1151 driver-generated command lines.
1153 @item -pipe
1154 @opindex pipe
1155 Use pipes rather than temporary files for communication between the
1156 various stages of compilation.  This fails to work on some systems where
1157 the assembler is unable to read from a pipe; but the GNU assembler has
1158 no trouble.
1160 @item -combine
1161 @opindex combine
1162 If you are compiling multiple source files, this option tells the driver
1163 to pass all the source files to the compiler at once (for those
1164 languages for which the compiler can handle this).  This will allow
1165 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1166 language for which this is supported is C@.  If you pass source files for
1167 multiple languages to the driver, using this option, the driver will invoke
1168 the compiler(s) that support IMA once each, passing each compiler all the
1169 source files appropriate for it.  For those languages that do not support
1170 IMA this option will be ignored, and the compiler will be invoked once for
1171 each source file in that language.  If you use this option in conjunction
1172 with @option{-save-temps}, the compiler will generate multiple
1173 pre-processed files
1174 (one for each source file), but only one (combined) @file{.o} or
1175 @file{.s} file.
1177 @item --help
1178 @opindex help
1179 Print (on the standard output) a description of the command line options
1180 understood by @command{gcc}.  If the @option{-v} option is also specified
1181 then @option{--help} will also be passed on to the various processes
1182 invoked by @command{gcc}, so that they can display the command line options
1183 they accept.  If the @option{-Wextra} option has also been specified
1184 (prior to the @option{--help} option), then command line options which
1185 have no documentation associated with them will also be displayed.
1187 @item --target-help
1188 @opindex target-help
1189 Print (on the standard output) a description of target-specific command
1190 line options for each tool.  For some targets extra target-specific
1191 information may also be printed.
1193 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1194 Print (on the standard output) a description of the command line
1195 options understood by the compiler that fit into all specified classes
1196 and qualifiers.  These are the supported classes:
1198 @table @asis
1199 @item @samp{optimizers}
1200 This will display all of the optimization options supported by the
1201 compiler.
1203 @item @samp{warnings}
1204 This will display all of the options controlling warning messages
1205 produced by the compiler.
1207 @item @samp{target}
1208 This will display target-specific options.  Unlike the
1209 @option{--target-help} option however, target-specific options of the
1210 linker and assembler will not be displayed.  This is because those
1211 tools do not currently support the extended @option{--help=} syntax.
1213 @item @samp{params}
1214 This will display the values recognized by the @option{--param}
1215 option.
1217 @item @var{language}
1218 This will display the options supported for @var{language}, where
1219 @var{language} is the name of one of the languages supported in this
1220 version of GCC.
1222 @item @samp{common}
1223 This will display the options that are common to all languages.
1224 @end table
1226 These are the supported qualifiers:
1228 @table @asis
1229 @item @samp{undocumented}
1230 Display only those options which are undocumented.
1232 @item @samp{joined}
1233 Display options which take an argument that appears after an equal
1234 sign in the same continuous piece of text, such as:
1235 @samp{--help=target}.
1237 @item @samp{separate}
1238 Display options which take an argument that appears as a separate word
1239 following the original option, such as: @samp{-o output-file}.
1240 @end table
1242 Thus for example to display all the undocumented target-specific
1243 switches supported by the compiler the following can be used:
1245 @smallexample
1246 --help=target,undocumented
1247 @end smallexample
1249 The sense of a qualifier can be inverted by prefixing it with the
1250 @samp{^} character, so for example to display all binary warning
1251 options (i.e., ones that are either on or off and that do not take an
1252 argument), which have a description the following can be used:
1254 @smallexample
1255 --help=warnings,^joined,^undocumented
1256 @end smallexample
1258 The argument to @option{--help=} should not consist solely of inverted
1259 qualifiers.
1261 Combining several classes is possible, although this usually
1262 restricts the output by so much that there is nothing to display.  One
1263 case where it does work however is when one of the classes is
1264 @var{target}.  So for example to display all the target-specific
1265 optimization options the following can be used:
1267 @smallexample
1268 --help=target,optimizers
1269 @end smallexample
1271 The @option{--help=} option can be repeated on the command line.  Each
1272 successive use will display its requested class of options, skipping
1273 those that have already been displayed.
1275 If the @option{-Q} option appears on the command line before the
1276 @option{--help=} option, then the descriptive text displayed by
1277 @option{--help=} is changed.  Instead of describing the displayed
1278 options, an indication is given as to whether the option is enabled,
1279 disabled or set to a specific value (assuming that the compiler
1280 knows this at the point where the @option{--help=} option is used).
1282 Here is a truncated example from the ARM port of @command{gcc}:
1284 @smallexample
1285   % gcc -Q -mabi=2 --help=target -c
1286   The following options are target specific:
1287   -mabi=                                2
1288   -mabort-on-noreturn                   [disabled]
1289   -mapcs                                [disabled]
1290 @end smallexample
1292 The output is sensitive to the effects of previous command line
1293 options, so for example it is possible to find out which optimizations
1294 are enabled at @option{-O2} by using:
1296 @smallexample
1297 -Q -O2 --help=optimizers
1298 @end smallexample
1300 Alternatively you can discover which binary optimizations are enabled
1301 by @option{-O3} by using:
1303 @smallexample
1304 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1305 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1306 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1307 @end smallexample
1309 @item -no-canonical-prefixes
1310 @opindex no-canonical-prefixes
1311 Do not expand any symbolic links, resolve references to @samp{/../}
1312 or @samp{/./}, or make the path absolute when generating a relative
1313 prefix.
1315 @item --version
1316 @opindex version
1317 Display the version number and copyrights of the invoked GCC@.
1319 @item -wrapper
1320 @opindex wrapper
1321 Invoke all subcommands under a wrapper program. It takes a single
1322 comma separated list as an argument, which will be used to invoke
1323 the wrapper:
1325 @smallexample
1326 gcc -c t.c -wrapper gdb,--args
1327 @end smallexample
1329 This will invoke all subprograms of gcc under "gdb --args",
1330 thus cc1 invocation will be "gdb --args cc1 ...".
1332 @item -fplugin=@var{name}.so
1333 Load the plugin code in file @var{name}.so, assumed to be a
1334 shared object to be dlopen'd by the compiler.  The base name of
1335 the shared object file is used to identify the plugin for the
1336 purposes of argument parsing (See
1337 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1338 Each plugin should define the callback functions specified in the
1339 Plugins API.
1341 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1342 Define an argument called @var{key} with a value of @var{value}
1343 for the plugin called @var{name}.
1345 @include @value{srcdir}/../libiberty/at-file.texi
1346 @end table
1348 @node Invoking G++
1349 @section Compiling C++ Programs
1351 @cindex suffixes for C++ source
1352 @cindex C++ source file suffixes
1353 C++ source files conventionally use one of the suffixes @samp{.C},
1354 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1355 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1356 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1357 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1358 files with these names and compiles them as C++ programs even if you
1359 call the compiler the same way as for compiling C programs (usually
1360 with the name @command{gcc}).
1362 @findex g++
1363 @findex c++
1364 However, the use of @command{gcc} does not add the C++ library.
1365 @command{g++} is a program that calls GCC and treats @samp{.c},
1366 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1367 files unless @option{-x} is used, and automatically specifies linking
1368 against the C++ library.  This program is also useful when
1369 precompiling a C header file with a @samp{.h} extension for use in C++
1370 compilations.  On many systems, @command{g++} is also installed with
1371 the name @command{c++}.
1373 @cindex invoking @command{g++}
1374 When you compile C++ programs, you may specify many of the same
1375 command-line options that you use for compiling programs in any
1376 language; or command-line options meaningful for C and related
1377 languages; or options that are meaningful only for C++ programs.
1378 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1379 explanations of options for languages related to C@.
1380 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1381 explanations of options that are meaningful only for C++ programs.
1383 @node C Dialect Options
1384 @section Options Controlling C Dialect
1385 @cindex dialect options
1386 @cindex language dialect options
1387 @cindex options, dialect
1389 The following options control the dialect of C (or languages derived
1390 from C, such as C++, Objective-C and Objective-C++) that the compiler
1391 accepts:
1393 @table @gcctabopt
1394 @cindex ANSI support
1395 @cindex ISO support
1396 @item -ansi
1397 @opindex ansi
1398 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1399 equivalent to @samp{-std=c++98}.
1401 This turns off certain features of GCC that are incompatible with ISO
1402 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1403 such as the @code{asm} and @code{typeof} keywords, and
1404 predefined macros such as @code{unix} and @code{vax} that identify the
1405 type of system you are using.  It also enables the undesirable and
1406 rarely used ISO trigraph feature.  For the C compiler,
1407 it disables recognition of C++ style @samp{//} comments as well as
1408 the @code{inline} keyword.
1410 The alternate keywords @code{__asm__}, @code{__extension__},
1411 @code{__inline__} and @code{__typeof__} continue to work despite
1412 @option{-ansi}.  You would not want to use them in an ISO C program, of
1413 course, but it is useful to put them in header files that might be included
1414 in compilations done with @option{-ansi}.  Alternate predefined macros
1415 such as @code{__unix__} and @code{__vax__} are also available, with or
1416 without @option{-ansi}.
1418 The @option{-ansi} option does not cause non-ISO programs to be
1419 rejected gratuitously.  For that, @option{-pedantic} is required in
1420 addition to @option{-ansi}.  @xref{Warning Options}.
1422 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1423 option is used.  Some header files may notice this macro and refrain
1424 from declaring certain functions or defining certain macros that the
1425 ISO standard doesn't call for; this is to avoid interfering with any
1426 programs that might use these names for other things.
1428 Functions that would normally be built in but do not have semantics
1429 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1430 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1431 built-in functions provided by GCC}, for details of the functions
1432 affected.
1434 @item -std=
1435 @opindex std
1436 Determine the language standard. @xref{Standards,,Language Standards
1437 Supported by GCC}, for details of these standard versions.  This option
1438 is currently only supported when compiling C or C++.
1440 The compiler can accept several base standards, such as @samp{c89} or
1441 @samp{c++98}, and GNU dialects of those standards, such as
1442 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1443 compiler will accept all programs following that standard and those
1444 using GNU extensions that do not contradict it.  For example,
1445 @samp{-std=c89} turns off certain features of GCC that are
1446 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1447 keywords, but not other GNU extensions that do not have a meaning in
1448 ISO C90, such as omitting the middle term of a @code{?:}
1449 expression. On the other hand, by specifying a GNU dialect of a
1450 standard, all features the compiler support are enabled, even when
1451 those features change the meaning of the base standard and some
1452 strict-conforming programs may be rejected.  The particular standard
1453 is used by @option{-pedantic} to identify which features are GNU
1454 extensions given that version of the standard. For example
1455 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1456 comments, while @samp{-std=gnu99 -pedantic} would not.
1458 A value for this option must be provided; possible values are
1460 @table @samp
1461 @item c89
1462 @itemx iso9899:1990
1463 Support all ISO C90 programs (certain GNU extensions that conflict
1464 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1466 @item iso9899:199409
1467 ISO C90 as modified in amendment 1.
1469 @item c99
1470 @itemx c9x
1471 @itemx iso9899:1999
1472 @itemx iso9899:199x
1473 ISO C99.  Note that this standard is not yet fully supported; see
1474 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1475 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1477 @item gnu89
1478 GNU dialect of ISO C90 (including some C99 features). This
1479 is the default for C code.
1481 @item gnu99
1482 @itemx gnu9x
1483 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1484 this will become the default.  The name @samp{gnu9x} is deprecated.
1486 @item c++98
1487 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1488 C++ code.
1490 @item gnu++98
1491 GNU dialect of @option{-std=c++98}.  This is the default for
1492 C++ code.
1494 @item c++0x
1495 The working draft of the upcoming ISO C++0x standard. This option
1496 enables experimental features that are likely to be included in
1497 C++0x. The working draft is constantly changing, and any feature that is
1498 enabled by this flag may be removed from future versions of GCC if it is
1499 not part of the C++0x standard.
1501 @item gnu++0x
1502 GNU dialect of @option{-std=c++0x}. This option enables
1503 experimental features that may be removed in future versions of GCC.
1504 @end table
1506 @item -fgnu89-inline
1507 @opindex fgnu89-inline
1508 The option @option{-fgnu89-inline} tells GCC to use the traditional
1509 GNU semantics for @code{inline} functions when in C99 mode.
1510 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1511 is accepted and ignored by GCC versions 4.1.3 up to but not including
1512 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1513 C99 mode.  Using this option is roughly equivalent to adding the
1514 @code{gnu_inline} function attribute to all inline functions
1515 (@pxref{Function Attributes}).
1517 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1518 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1519 specifies the default behavior).  This option was first supported in
1520 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1522 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1523 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1524 in effect for @code{inline} functions.  @xref{Common Predefined
1525 Macros,,,cpp,The C Preprocessor}.
1527 @item -aux-info @var{filename}
1528 @opindex aux-info
1529 Output to the given filename prototyped declarations for all functions
1530 declared and/or defined in a translation unit, including those in header
1531 files.  This option is silently ignored in any language other than C@.
1533 Besides declarations, the file indicates, in comments, the origin of
1534 each declaration (source file and line), whether the declaration was
1535 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1536 @samp{O} for old, respectively, in the first character after the line
1537 number and the colon), and whether it came from a declaration or a
1538 definition (@samp{C} or @samp{F}, respectively, in the following
1539 character).  In the case of function definitions, a K&R-style list of
1540 arguments followed by their declarations is also provided, inside
1541 comments, after the declaration.
1543 @item -fno-asm
1544 @opindex fno-asm
1545 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1546 keyword, so that code can use these words as identifiers.  You can use
1547 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1548 instead.  @option{-ansi} implies @option{-fno-asm}.
1550 In C++, this switch only affects the @code{typeof} keyword, since
1551 @code{asm} and @code{inline} are standard keywords.  You may want to
1552 use the @option{-fno-gnu-keywords} flag instead, which has the same
1553 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1554 switch only affects the @code{asm} and @code{typeof} keywords, since
1555 @code{inline} is a standard keyword in ISO C99.
1557 @item -fno-builtin
1558 @itemx -fno-builtin-@var{function}
1559 @opindex fno-builtin
1560 @cindex built-in functions
1561 Don't recognize built-in functions that do not begin with
1562 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1563 functions provided by GCC}, for details of the functions affected,
1564 including those which are not built-in functions when @option{-ansi} or
1565 @option{-std} options for strict ISO C conformance are used because they
1566 do not have an ISO standard meaning.
1568 GCC normally generates special code to handle certain built-in functions
1569 more efficiently; for instance, calls to @code{alloca} may become single
1570 instructions that adjust the stack directly, and calls to @code{memcpy}
1571 may become inline copy loops.  The resulting code is often both smaller
1572 and faster, but since the function calls no longer appear as such, you
1573 cannot set a breakpoint on those calls, nor can you change the behavior
1574 of the functions by linking with a different library.  In addition,
1575 when a function is recognized as a built-in function, GCC may use
1576 information about that function to warn about problems with calls to
1577 that function, or to generate more efficient code, even if the
1578 resulting code still contains calls to that function.  For example,
1579 warnings are given with @option{-Wformat} for bad calls to
1580 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1581 known not to modify global memory.
1583 With the @option{-fno-builtin-@var{function}} option
1584 only the built-in function @var{function} is
1585 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1586 function is named that is not built-in in this version of GCC, this
1587 option is ignored.  There is no corresponding
1588 @option{-fbuiltin-@var{function}} option; if you wish to enable
1589 built-in functions selectively when using @option{-fno-builtin} or
1590 @option{-ffreestanding}, you may define macros such as:
1592 @smallexample
1593 #define abs(n)          __builtin_abs ((n))
1594 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1595 @end smallexample
1597 @item -fhosted
1598 @opindex fhosted
1599 @cindex hosted environment
1601 Assert that compilation takes place in a hosted environment.  This implies
1602 @option{-fbuiltin}.  A hosted environment is one in which the
1603 entire standard library is available, and in which @code{main} has a return
1604 type of @code{int}.  Examples are nearly everything except a kernel.
1605 This is equivalent to @option{-fno-freestanding}.
1607 @item -ffreestanding
1608 @opindex ffreestanding
1609 @cindex hosted environment
1611 Assert that compilation takes place in a freestanding environment.  This
1612 implies @option{-fno-builtin}.  A freestanding environment
1613 is one in which the standard library may not exist, and program startup may
1614 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1615 This is equivalent to @option{-fno-hosted}.
1617 @xref{Standards,,Language Standards Supported by GCC}, for details of
1618 freestanding and hosted environments.
1620 @item -fopenmp
1621 @opindex fopenmp
1622 @cindex openmp parallel
1623 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1624 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1625 compiler generates parallel code according to the OpenMP Application
1626 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1627 implies @option{-pthread}, and thus is only supported on targets that
1628 have support for @option{-pthread}.
1630 @item -fms-extensions
1631 @opindex fms-extensions
1632 Accept some non-standard constructs used in Microsoft header files.
1634 Some cases of unnamed fields in structures and unions are only
1635 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1636 fields within structs/unions}, for details.
1638 @item -trigraphs
1639 @opindex trigraphs
1640 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1641 options for strict ISO C conformance) implies @option{-trigraphs}.
1643 @item -no-integrated-cpp
1644 @opindex no-integrated-cpp
1645 Performs a compilation in two passes: preprocessing and compiling.  This
1646 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1647 @option{-B} option.  The user supplied compilation step can then add in
1648 an additional preprocessing step after normal preprocessing but before
1649 compiling.  The default is to use the integrated cpp (internal cpp)
1651 The semantics of this option will change if "cc1", "cc1plus", and
1652 "cc1obj" are merged.
1654 @cindex traditional C language
1655 @cindex C language, traditional
1656 @item -traditional
1657 @itemx -traditional-cpp
1658 @opindex traditional-cpp
1659 @opindex traditional
1660 Formerly, these options caused GCC to attempt to emulate a pre-standard
1661 C compiler.  They are now only supported with the @option{-E} switch.
1662 The preprocessor continues to support a pre-standard mode.  See the GNU
1663 CPP manual for details.
1665 @item -fcond-mismatch
1666 @opindex fcond-mismatch
1667 Allow conditional expressions with mismatched types in the second and
1668 third arguments.  The value of such an expression is void.  This option
1669 is not supported for C++.
1671 @item -flax-vector-conversions
1672 @opindex flax-vector-conversions
1673 Allow implicit conversions between vectors with differing numbers of
1674 elements and/or incompatible element types.  This option should not be
1675 used for new code.
1677 @item -funsigned-char
1678 @opindex funsigned-char
1679 Let the type @code{char} be unsigned, like @code{unsigned char}.
1681 Each kind of machine has a default for what @code{char} should
1682 be.  It is either like @code{unsigned char} by default or like
1683 @code{signed char} by default.
1685 Ideally, a portable program should always use @code{signed char} or
1686 @code{unsigned char} when it depends on the signedness of an object.
1687 But many programs have been written to use plain @code{char} and
1688 expect it to be signed, or expect it to be unsigned, depending on the
1689 machines they were written for.  This option, and its inverse, let you
1690 make such a program work with the opposite default.
1692 The type @code{char} is always a distinct type from each of
1693 @code{signed char} or @code{unsigned char}, even though its behavior
1694 is always just like one of those two.
1696 @item -fsigned-char
1697 @opindex fsigned-char
1698 Let the type @code{char} be signed, like @code{signed char}.
1700 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1701 the negative form of @option{-funsigned-char}.  Likewise, the option
1702 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1704 @item -fsigned-bitfields
1705 @itemx -funsigned-bitfields
1706 @itemx -fno-signed-bitfields
1707 @itemx -fno-unsigned-bitfields
1708 @opindex fsigned-bitfields
1709 @opindex funsigned-bitfields
1710 @opindex fno-signed-bitfields
1711 @opindex fno-unsigned-bitfields
1712 These options control whether a bit-field is signed or unsigned, when the
1713 declaration does not use either @code{signed} or @code{unsigned}.  By
1714 default, such a bit-field is signed, because this is consistent: the
1715 basic integer types such as @code{int} are signed types.
1716 @end table
1718 @node C++ Dialect Options
1719 @section Options Controlling C++ Dialect
1721 @cindex compiler options, C++
1722 @cindex C++ options, command line
1723 @cindex options, C++
1724 This section describes the command-line options that are only meaningful
1725 for C++ programs; but you can also use most of the GNU compiler options
1726 regardless of what language your program is in.  For example, you
1727 might compile a file @code{firstClass.C} like this:
1729 @smallexample
1730 g++ -g -frepo -O -c firstClass.C
1731 @end smallexample
1733 @noindent
1734 In this example, only @option{-frepo} is an option meant
1735 only for C++ programs; you can use the other options with any
1736 language supported by GCC@.
1738 Here is a list of options that are @emph{only} for compiling C++ programs:
1740 @table @gcctabopt
1742 @item -fabi-version=@var{n}
1743 @opindex fabi-version
1744 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1745 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1746 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1747 the version that conforms most closely to the C++ ABI specification.
1748 Therefore, the ABI obtained using version 0 will change as ABI bugs
1749 are fixed.
1751 The default is version 2.
1753 @item -fno-access-control
1754 @opindex fno-access-control
1755 Turn off all access checking.  This switch is mainly useful for working
1756 around bugs in the access control code.
1758 @item -fcheck-new
1759 @opindex fcheck-new
1760 Check that the pointer returned by @code{operator new} is non-null
1761 before attempting to modify the storage allocated.  This check is
1762 normally unnecessary because the C++ standard specifies that
1763 @code{operator new} will only return @code{0} if it is declared
1764 @samp{throw()}, in which case the compiler will always check the
1765 return value even without this option.  In all other cases, when
1766 @code{operator new} has a non-empty exception specification, memory
1767 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1768 @samp{new (nothrow)}.
1770 @item -fconserve-space
1771 @opindex fconserve-space
1772 Put uninitialized or runtime-initialized global variables into the
1773 common segment, as C does.  This saves space in the executable at the
1774 cost of not diagnosing duplicate definitions.  If you compile with this
1775 flag and your program mysteriously crashes after @code{main()} has
1776 completed, you may have an object that is being destroyed twice because
1777 two definitions were merged.
1779 This option is no longer useful on most targets, now that support has
1780 been added for putting variables into BSS without making them common.
1782 @item -ffriend-injection
1783 @opindex ffriend-injection
1784 Inject friend functions into the enclosing namespace, so that they are
1785 visible outside the scope of the class in which they are declared.
1786 Friend functions were documented to work this way in the old Annotated
1787 C++ Reference Manual, and versions of G++ before 4.1 always worked
1788 that way.  However, in ISO C++ a friend function which is not declared
1789 in an enclosing scope can only be found using argument dependent
1790 lookup.  This option causes friends to be injected as they were in
1791 earlier releases.
1793 This option is for compatibility, and may be removed in a future
1794 release of G++.
1796 @item -fno-elide-constructors
1797 @opindex fno-elide-constructors
1798 The C++ standard allows an implementation to omit creating a temporary
1799 which is only used to initialize another object of the same type.
1800 Specifying this option disables that optimization, and forces G++ to
1801 call the copy constructor in all cases.
1803 @item -fno-enforce-eh-specs
1804 @opindex fno-enforce-eh-specs
1805 Don't generate code to check for violation of exception specifications
1806 at runtime.  This option violates the C++ standard, but may be useful
1807 for reducing code size in production builds, much like defining
1808 @samp{NDEBUG}.  This does not give user code permission to throw
1809 exceptions in violation of the exception specifications; the compiler
1810 will still optimize based on the specifications, so throwing an
1811 unexpected exception will result in undefined behavior.
1813 @item -ffor-scope
1814 @itemx -fno-for-scope
1815 @opindex ffor-scope
1816 @opindex fno-for-scope
1817 If @option{-ffor-scope} is specified, the scope of variables declared in
1818 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1819 as specified by the C++ standard.
1820 If @option{-fno-for-scope} is specified, the scope of variables declared in
1821 a @i{for-init-statement} extends to the end of the enclosing scope,
1822 as was the case in old versions of G++, and other (traditional)
1823 implementations of C++.
1825 The default if neither flag is given to follow the standard,
1826 but to allow and give a warning for old-style code that would
1827 otherwise be invalid, or have different behavior.
1829 @item -fno-gnu-keywords
1830 @opindex fno-gnu-keywords
1831 Do not recognize @code{typeof} as a keyword, so that code can use this
1832 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1833 @option{-ansi} implies @option{-fno-gnu-keywords}.
1835 @item -fno-implicit-templates
1836 @opindex fno-implicit-templates
1837 Never emit code for non-inline templates which are instantiated
1838 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1839 @xref{Template Instantiation}, for more information.
1841 @item -fno-implicit-inline-templates
1842 @opindex fno-implicit-inline-templates
1843 Don't emit code for implicit instantiations of inline templates, either.
1844 The default is to handle inlines differently so that compiles with and
1845 without optimization will need the same set of explicit instantiations.
1847 @item -fno-implement-inlines
1848 @opindex fno-implement-inlines
1849 To save space, do not emit out-of-line copies of inline functions
1850 controlled by @samp{#pragma implementation}.  This will cause linker
1851 errors if these functions are not inlined everywhere they are called.
1853 @item -fms-extensions
1854 @opindex fms-extensions
1855 Disable pedantic warnings about constructs used in MFC, such as implicit
1856 int and getting a pointer to member function via non-standard syntax.
1858 @item -fno-nonansi-builtins
1859 @opindex fno-nonansi-builtins
1860 Disable built-in declarations of functions that are not mandated by
1861 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1862 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1864 @item -fno-operator-names
1865 @opindex fno-operator-names
1866 Do not treat the operator name keywords @code{and}, @code{bitand},
1867 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1868 synonyms as keywords.
1870 @item -fno-optional-diags
1871 @opindex fno-optional-diags
1872 Disable diagnostics that the standard says a compiler does not need to
1873 issue.  Currently, the only such diagnostic issued by G++ is the one for
1874 a name having multiple meanings within a class.
1876 @item -fpermissive
1877 @opindex fpermissive
1878 Downgrade some diagnostics about nonconformant code from errors to
1879 warnings.  Thus, using @option{-fpermissive} will allow some
1880 nonconforming code to compile.
1882 @item -fno-pretty-templates
1883 @opindex fno-pretty-templates
1884 When an error message refers to a specialization of a function
1885 template, the compiler will normally print the signature of the
1886 template followed by the template arguments and any typedefs or
1887 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1888 rather than @code{void f(int)}) so that it's clear which template is
1889 involved.  When an error message refers to a specialization of a class
1890 template, the compiler will omit any template arguments which match
1891 the default template arguments for that template.  If either of these
1892 behaviors make it harder to understand the error message rather than
1893 easier, using @option{-fno-pretty-templates} will disable them.
1895 @item -frepo
1896 @opindex frepo
1897 Enable automatic template instantiation at link time.  This option also
1898 implies @option{-fno-implicit-templates}.  @xref{Template
1899 Instantiation}, for more information.
1901 @item -fno-rtti
1902 @opindex fno-rtti
1903 Disable generation of information about every class with virtual
1904 functions for use by the C++ runtime type identification features
1905 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1906 of the language, you can save some space by using this flag.  Note that
1907 exception handling uses the same information, but it will generate it as
1908 needed. The @samp{dynamic_cast} operator can still be used for casts that
1909 do not require runtime type information, i.e.@: casts to @code{void *} or to
1910 unambiguous base classes.
1912 @item -fstats
1913 @opindex fstats
1914 Emit statistics about front-end processing at the end of the compilation.
1915 This information is generally only useful to the G++ development team.
1917 @item -ftemplate-depth-@var{n}
1918 @opindex ftemplate-depth
1919 Set the maximum instantiation depth for template classes to @var{n}.
1920 A limit on the template instantiation depth is needed to detect
1921 endless recursions during template class instantiation.  ANSI/ISO C++
1922 conforming programs must not rely on a maximum depth greater than 17.
1924 @item -fno-threadsafe-statics
1925 @opindex fno-threadsafe-statics
1926 Do not emit the extra code to use the routines specified in the C++
1927 ABI for thread-safe initialization of local statics.  You can use this
1928 option to reduce code size slightly in code that doesn't need to be
1929 thread-safe.
1931 @item -fuse-cxa-atexit
1932 @opindex fuse-cxa-atexit
1933 Register destructors for objects with static storage duration with the
1934 @code{__cxa_atexit} function rather than the @code{atexit} function.
1935 This option is required for fully standards-compliant handling of static
1936 destructors, but will only work if your C library supports
1937 @code{__cxa_atexit}.
1939 @item -fno-use-cxa-get-exception-ptr
1940 @opindex fno-use-cxa-get-exception-ptr
1941 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1942 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1943 if the runtime routine is not available.
1945 @item -fvisibility-inlines-hidden
1946 @opindex fvisibility-inlines-hidden
1947 This switch declares that the user does not attempt to compare
1948 pointers to inline methods where the addresses of the two functions
1949 were taken in different shared objects.
1951 The effect of this is that GCC may, effectively, mark inline methods with
1952 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1953 appear in the export table of a DSO and do not require a PLT indirection
1954 when used within the DSO@.  Enabling this option can have a dramatic effect
1955 on load and link times of a DSO as it massively reduces the size of the
1956 dynamic export table when the library makes heavy use of templates.
1958 The behavior of this switch is not quite the same as marking the
1959 methods as hidden directly, because it does not affect static variables
1960 local to the function or cause the compiler to deduce that
1961 the function is defined in only one shared object.
1963 You may mark a method as having a visibility explicitly to negate the
1964 effect of the switch for that method.  For example, if you do want to
1965 compare pointers to a particular inline method, you might mark it as
1966 having default visibility.  Marking the enclosing class with explicit
1967 visibility will have no effect.
1969 Explicitly instantiated inline methods are unaffected by this option
1970 as their linkage might otherwise cross a shared library boundary.
1971 @xref{Template Instantiation}.
1973 @item -fvisibility-ms-compat
1974 @opindex fvisibility-ms-compat
1975 This flag attempts to use visibility settings to make GCC's C++
1976 linkage model compatible with that of Microsoft Visual Studio.
1978 The flag makes these changes to GCC's linkage model:
1980 @enumerate
1981 @item
1982 It sets the default visibility to @code{hidden}, like
1983 @option{-fvisibility=hidden}.
1985 @item
1986 Types, but not their members, are not hidden by default.
1988 @item
1989 The One Definition Rule is relaxed for types without explicit
1990 visibility specifications which are defined in more than one different
1991 shared object: those declarations are permitted if they would have
1992 been permitted when this option was not used.
1993 @end enumerate
1995 In new code it is better to use @option{-fvisibility=hidden} and
1996 export those classes which are intended to be externally visible.
1997 Unfortunately it is possible for code to rely, perhaps accidentally,
1998 on the Visual Studio behavior.
2000 Among the consequences of these changes are that static data members
2001 of the same type with the same name but defined in different shared
2002 objects will be different, so changing one will not change the other;
2003 and that pointers to function members defined in different shared
2004 objects may not compare equal.  When this flag is given, it is a
2005 violation of the ODR to define types with the same name differently.
2007 @item -fno-weak
2008 @opindex fno-weak
2009 Do not use weak symbol support, even if it is provided by the linker.
2010 By default, G++ will use weak symbols if they are available.  This
2011 option exists only for testing, and should not be used by end-users;
2012 it will result in inferior code and has no benefits.  This option may
2013 be removed in a future release of G++.
2015 @item -nostdinc++
2016 @opindex nostdinc++
2017 Do not search for header files in the standard directories specific to
2018 C++, but do still search the other standard directories.  (This option
2019 is used when building the C++ library.)
2020 @end table
2022 In addition, these optimization, warning, and code generation options
2023 have meanings only for C++ programs:
2025 @table @gcctabopt
2026 @item -fno-default-inline
2027 @opindex fno-default-inline
2028 Do not assume @samp{inline} for functions defined inside a class scope.
2029 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2030 functions will have linkage like inline functions; they just won't be
2031 inlined by default.
2033 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2034 @opindex Wabi
2035 @opindex Wno-abi
2036 Warn when G++ generates code that is probably not compatible with the
2037 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2038 all such cases, there are probably some cases that are not warned about,
2039 even though G++ is generating incompatible code.  There may also be
2040 cases where warnings are emitted even though the code that is generated
2041 will be compatible.
2043 You should rewrite your code to avoid these warnings if you are
2044 concerned about the fact that code generated by G++ may not be binary
2045 compatible with code generated by other compilers.
2047 The known incompatibilities at this point include:
2049 @itemize @bullet
2051 @item
2052 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2053 pack data into the same byte as a base class.  For example:
2055 @smallexample
2056 struct A @{ virtual void f(); int f1 : 1; @};
2057 struct B : public A @{ int f2 : 1; @};
2058 @end smallexample
2060 @noindent
2061 In this case, G++ will place @code{B::f2} into the same byte
2062 as@code{A::f1}; other compilers will not.  You can avoid this problem
2063 by explicitly padding @code{A} so that its size is a multiple of the
2064 byte size on your platform; that will cause G++ and other compilers to
2065 layout @code{B} identically.
2067 @item
2068 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2069 tail padding when laying out virtual bases.  For example:
2071 @smallexample
2072 struct A @{ virtual void f(); char c1; @};
2073 struct B @{ B(); char c2; @};
2074 struct C : public A, public virtual B @{@};
2075 @end smallexample
2077 @noindent
2078 In this case, G++ will not place @code{B} into the tail-padding for
2079 @code{A}; other compilers will.  You can avoid this problem by
2080 explicitly padding @code{A} so that its size is a multiple of its
2081 alignment (ignoring virtual base classes); that will cause G++ and other
2082 compilers to layout @code{C} identically.
2084 @item
2085 Incorrect handling of bit-fields with declared widths greater than that
2086 of their underlying types, when the bit-fields appear in a union.  For
2087 example:
2089 @smallexample
2090 union U @{ int i : 4096; @};
2091 @end smallexample
2093 @noindent
2094 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2095 union too small by the number of bits in an @code{int}.
2097 @item
2098 Empty classes can be placed at incorrect offsets.  For example:
2100 @smallexample
2101 struct A @{@};
2103 struct B @{
2104   A a;
2105   virtual void f ();
2108 struct C : public B, public A @{@};
2109 @end smallexample
2111 @noindent
2112 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2113 it should be placed at offset zero.  G++ mistakenly believes that the
2114 @code{A} data member of @code{B} is already at offset zero.
2116 @item
2117 Names of template functions whose types involve @code{typename} or
2118 template template parameters can be mangled incorrectly.
2120 @smallexample
2121 template <typename Q>
2122 void f(typename Q::X) @{@}
2124 template <template <typename> class Q>
2125 void f(typename Q<int>::X) @{@}
2126 @end smallexample
2128 @noindent
2129 Instantiations of these templates may be mangled incorrectly.
2131 @end itemize
2133 It also warns psABI related changes.  The known psABI changes at this
2134 point include:
2136 @itemize @bullet
2138 @item
2139 For SYSV/x86-64, when passing union with long double, it is changed to
2140 pass in memory as specified in psABI.  For example:
2142 @smallexample
2143 union U @{
2144   long double ld;
2145   int i;
2147 @end smallexample
2149 @noindent
2150 @code{union U} will always be passed in memory.
2152 @end itemize
2154 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2155 @opindex Wctor-dtor-privacy
2156 @opindex Wno-ctor-dtor-privacy
2157 Warn when a class seems unusable because all the constructors or
2158 destructors in that class are private, and it has neither friends nor
2159 public static member functions.
2161 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2162 @opindex Wnon-virtual-dtor
2163 @opindex Wno-non-virtual-dtor
2164 Warn when a class has virtual functions and accessible non-virtual
2165 destructor, in which case it would be possible but unsafe to delete
2166 an instance of a derived class through a pointer to the base class.
2167 This warning is also enabled if -Weffc++ is specified.
2169 @item -Wreorder @r{(C++ and Objective-C++ only)}
2170 @opindex Wreorder
2171 @opindex Wno-reorder
2172 @cindex reordering, warning
2173 @cindex warning for reordering of member initializers
2174 Warn when the order of member initializers given in the code does not
2175 match the order in which they must be executed.  For instance:
2177 @smallexample
2178 struct A @{
2179   int i;
2180   int j;
2181   A(): j (0), i (1) @{ @}
2183 @end smallexample
2185 The compiler will rearrange the member initializers for @samp{i}
2186 and @samp{j} to match the declaration order of the members, emitting
2187 a warning to that effect.  This warning is enabled by @option{-Wall}.
2188 @end table
2190 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2192 @table @gcctabopt
2193 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2194 @opindex Weffc++
2195 @opindex Wno-effc++
2196 Warn about violations of the following style guidelines from Scott Meyers'
2197 @cite{Effective C++} book:
2199 @itemize @bullet
2200 @item
2201 Item 11:  Define a copy constructor and an assignment operator for classes
2202 with dynamically allocated memory.
2204 @item
2205 Item 12:  Prefer initialization to assignment in constructors.
2207 @item
2208 Item 14:  Make destructors virtual in base classes.
2210 @item
2211 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2213 @item
2214 Item 23:  Don't try to return a reference when you must return an object.
2216 @end itemize
2218 Also warn about violations of the following style guidelines from
2219 Scott Meyers' @cite{More Effective C++} book:
2221 @itemize @bullet
2222 @item
2223 Item 6:  Distinguish between prefix and postfix forms of increment and
2224 decrement operators.
2226 @item
2227 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2229 @end itemize
2231 When selecting this option, be aware that the standard library
2232 headers do not obey all of these guidelines; use @samp{grep -v}
2233 to filter out those warnings.
2235 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2236 @opindex Wstrict-null-sentinel
2237 @opindex Wno-strict-null-sentinel
2238 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2239 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2240 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2241 it is guaranteed to be of the same size as a pointer.  But this use is
2242 not portable across different compilers.
2244 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2245 @opindex Wno-non-template-friend
2246 @opindex Wnon-template-friend
2247 Disable warnings when non-templatized friend functions are declared
2248 within a template.  Since the advent of explicit template specification
2249 support in G++, if the name of the friend is an unqualified-id (i.e.,
2250 @samp{friend foo(int)}), the C++ language specification demands that the
2251 friend declare or define an ordinary, nontemplate function.  (Section
2252 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2253 could be interpreted as a particular specialization of a templatized
2254 function.  Because this non-conforming behavior is no longer the default
2255 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2256 check existing code for potential trouble spots and is on by default.
2257 This new compiler behavior can be turned off with
2258 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2259 but disables the helpful warning.
2261 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2262 @opindex Wold-style-cast
2263 @opindex Wno-old-style-cast
2264 Warn if an old-style (C-style) cast to a non-void type is used within
2265 a C++ program.  The new-style casts (@samp{dynamic_cast},
2266 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2267 less vulnerable to unintended effects and much easier to search for.
2269 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2270 @opindex Woverloaded-virtual
2271 @opindex Wno-overloaded-virtual
2272 @cindex overloaded virtual fn, warning
2273 @cindex warning for overloaded virtual fn
2274 Warn when a function declaration hides virtual functions from a
2275 base class.  For example, in:
2277 @smallexample
2278 struct A @{
2279   virtual void f();
2282 struct B: public A @{
2283   void f(int);
2285 @end smallexample
2287 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2288 like:
2290 @smallexample
2291 B* b;
2292 b->f();
2293 @end smallexample
2295 will fail to compile.
2297 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2298 @opindex Wno-pmf-conversions
2299 @opindex Wpmf-conversions
2300 Disable the diagnostic for converting a bound pointer to member function
2301 to a plain pointer.
2303 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2304 @opindex Wsign-promo
2305 @opindex Wno-sign-promo
2306 Warn when overload resolution chooses a promotion from unsigned or
2307 enumerated type to a signed type, over a conversion to an unsigned type of
2308 the same size.  Previous versions of G++ would try to preserve
2309 unsignedness, but the standard mandates the current behavior.
2311 @smallexample
2312 struct A @{
2313   operator int ();
2314   A& operator = (int);
2317 main ()
2319   A a,b;
2320   a = b;
2322 @end smallexample
2324 In this example, G++ will synthesize a default @samp{A& operator =
2325 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2326 @end table
2328 @node Objective-C and Objective-C++ Dialect Options
2329 @section Options Controlling Objective-C and Objective-C++ Dialects
2331 @cindex compiler options, Objective-C and Objective-C++
2332 @cindex Objective-C and Objective-C++ options, command line
2333 @cindex options, Objective-C and Objective-C++
2334 (NOTE: This manual does not describe the Objective-C and Objective-C++
2335 languages themselves.  See @xref{Standards,,Language Standards
2336 Supported by GCC}, for references.)
2338 This section describes the command-line options that are only meaningful
2339 for Objective-C and Objective-C++ programs, but you can also use most of
2340 the language-independent GNU compiler options.
2341 For example, you might compile a file @code{some_class.m} like this:
2343 @smallexample
2344 gcc -g -fgnu-runtime -O -c some_class.m
2345 @end smallexample
2347 @noindent
2348 In this example, @option{-fgnu-runtime} is an option meant only for
2349 Objective-C and Objective-C++ programs; you can use the other options with
2350 any language supported by GCC@.
2352 Note that since Objective-C is an extension of the C language, Objective-C
2353 compilations may also use options specific to the C front-end (e.g.,
2354 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2355 C++-specific options (e.g., @option{-Wabi}).
2357 Here is a list of options that are @emph{only} for compiling Objective-C
2358 and Objective-C++ programs:
2360 @table @gcctabopt
2361 @item -fconstant-string-class=@var{class-name}
2362 @opindex fconstant-string-class
2363 Use @var{class-name} as the name of the class to instantiate for each
2364 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2365 class name is @code{NXConstantString} if the GNU runtime is being used, and
2366 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2367 @option{-fconstant-cfstrings} option, if also present, will override the
2368 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2369 to be laid out as constant CoreFoundation strings.
2371 @item -fgnu-runtime
2372 @opindex fgnu-runtime
2373 Generate object code compatible with the standard GNU Objective-C
2374 runtime.  This is the default for most types of systems.
2376 @item -fnext-runtime
2377 @opindex fnext-runtime
2378 Generate output compatible with the NeXT runtime.  This is the default
2379 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2380 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2381 used.
2383 @item -fno-nil-receivers
2384 @opindex fno-nil-receivers
2385 Assume that all Objective-C message dispatches (e.g.,
2386 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2387 is not @code{nil}.  This allows for more efficient entry points in the runtime
2388 to be used.  Currently, this option is only available in conjunction with
2389 the NeXT runtime on Mac OS X 10.3 and later.
2391 @item -fobjc-call-cxx-cdtors
2392 @opindex fobjc-call-cxx-cdtors
2393 For each Objective-C class, check if any of its instance variables is a
2394 C++ object with a non-trivial default constructor.  If so, synthesize a
2395 special @code{- (id) .cxx_construct} instance method that will run
2396 non-trivial default constructors on any such instance variables, in order,
2397 and then return @code{self}.  Similarly, check if any instance variable
2398 is a C++ object with a non-trivial destructor, and if so, synthesize a
2399 special @code{- (void) .cxx_destruct} method that will run
2400 all such default destructors, in reverse order.
2402 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2403 thusly generated will only operate on instance variables declared in the
2404 current Objective-C class, and not those inherited from superclasses.  It
2405 is the responsibility of the Objective-C runtime to invoke all such methods
2406 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2407 will be invoked by the runtime immediately after a new object
2408 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2409 be invoked immediately before the runtime deallocates an object instance.
2411 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2412 support for invoking the @code{- (id) .cxx_construct} and
2413 @code{- (void) .cxx_destruct} methods.
2415 @item -fobjc-direct-dispatch
2416 @opindex fobjc-direct-dispatch
2417 Allow fast jumps to the message dispatcher.  On Darwin this is
2418 accomplished via the comm page.
2420 @item -fobjc-exceptions
2421 @opindex fobjc-exceptions
2422 Enable syntactic support for structured exception handling in Objective-C,
2423 similar to what is offered by C++ and Java.  This option is
2424 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2425 earlier.
2427 @smallexample
2428   @@try @{
2429     @dots{}
2430        @@throw expr;
2431     @dots{}
2432   @}
2433   @@catch (AnObjCClass *exc) @{
2434     @dots{}
2435       @@throw expr;
2436     @dots{}
2437       @@throw;
2438     @dots{}
2439   @}
2440   @@catch (AnotherClass *exc) @{
2441     @dots{}
2442   @}
2443   @@catch (id allOthers) @{
2444     @dots{}
2445   @}
2446   @@finally @{
2447     @dots{}
2448       @@throw expr;
2449     @dots{}
2450   @}
2451 @end smallexample
2453 The @code{@@throw} statement may appear anywhere in an Objective-C or
2454 Objective-C++ program; when used inside of a @code{@@catch} block, the
2455 @code{@@throw} may appear without an argument (as shown above), in which case
2456 the object caught by the @code{@@catch} will be rethrown.
2458 Note that only (pointers to) Objective-C objects may be thrown and
2459 caught using this scheme.  When an object is thrown, it will be caught
2460 by the nearest @code{@@catch} clause capable of handling objects of that type,
2461 analogously to how @code{catch} blocks work in C++ and Java.  A
2462 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2463 any and all Objective-C exceptions not caught by previous @code{@@catch}
2464 clauses (if any).
2466 The @code{@@finally} clause, if present, will be executed upon exit from the
2467 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2468 regardless of whether any exceptions are thrown, caught or rethrown
2469 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2470 of the @code{finally} clause in Java.
2472 There are several caveats to using the new exception mechanism:
2474 @itemize @bullet
2475 @item
2476 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2477 idioms provided by the @code{NSException} class, the new
2478 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2479 systems, due to additional functionality needed in the (NeXT) Objective-C
2480 runtime.
2482 @item
2483 As mentioned above, the new exceptions do not support handling
2484 types other than Objective-C objects.   Furthermore, when used from
2485 Objective-C++, the Objective-C exception model does not interoperate with C++
2486 exceptions at this time.  This means you cannot @code{@@throw} an exception
2487 from Objective-C and @code{catch} it in C++, or vice versa
2488 (i.e., @code{throw @dots{} @@catch}).
2489 @end itemize
2491 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2492 blocks for thread-safe execution:
2494 @smallexample
2495   @@synchronized (ObjCClass *guard) @{
2496     @dots{}
2497   @}
2498 @end smallexample
2500 Upon entering the @code{@@synchronized} block, a thread of execution shall
2501 first check whether a lock has been placed on the corresponding @code{guard}
2502 object by another thread.  If it has, the current thread shall wait until
2503 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2504 the current thread will place its own lock on it, execute the code contained in
2505 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2506 making @code{guard} available to other threads).
2508 Unlike Java, Objective-C does not allow for entire methods to be marked
2509 @code{@@synchronized}.  Note that throwing exceptions out of
2510 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2511 to be unlocked properly.
2513 @item -fobjc-gc
2514 @opindex fobjc-gc
2515 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2517 @item -freplace-objc-classes
2518 @opindex freplace-objc-classes
2519 Emit a special marker instructing @command{ld(1)} not to statically link in
2520 the resulting object file, and allow @command{dyld(1)} to load it in at
2521 run time instead.  This is used in conjunction with the Fix-and-Continue
2522 debugging mode, where the object file in question may be recompiled and
2523 dynamically reloaded in the course of program execution, without the need
2524 to restart the program itself.  Currently, Fix-and-Continue functionality
2525 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2526 and later.
2528 @item -fzero-link
2529 @opindex fzero-link
2530 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2531 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2532 compile time) with static class references that get initialized at load time,
2533 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2534 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2535 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2536 for individual class implementations to be modified during program execution.
2538 @item -gen-decls
2539 @opindex gen-decls
2540 Dump interface declarations for all classes seen in the source file to a
2541 file named @file{@var{sourcename}.decl}.
2543 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2544 @opindex Wassign-intercept
2545 @opindex Wno-assign-intercept
2546 Warn whenever an Objective-C assignment is being intercepted by the
2547 garbage collector.
2549 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2550 @opindex Wno-protocol
2551 @opindex Wprotocol
2552 If a class is declared to implement a protocol, a warning is issued for
2553 every method in the protocol that is not implemented by the class.  The
2554 default behavior is to issue a warning for every method not explicitly
2555 implemented in the class, even if a method implementation is inherited
2556 from the superclass.  If you use the @option{-Wno-protocol} option, then
2557 methods inherited from the superclass are considered to be implemented,
2558 and no warning is issued for them.
2560 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2561 @opindex Wselector
2562 @opindex Wno-selector
2563 Warn if multiple methods of different types for the same selector are
2564 found during compilation.  The check is performed on the list of methods
2565 in the final stage of compilation.  Additionally, a check is performed
2566 for each selector appearing in a @code{@@selector(@dots{})}
2567 expression, and a corresponding method for that selector has been found
2568 during compilation.  Because these checks scan the method table only at
2569 the end of compilation, these warnings are not produced if the final
2570 stage of compilation is not reached, for example because an error is
2571 found during compilation, or because the @option{-fsyntax-only} option is
2572 being used.
2574 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2575 @opindex Wstrict-selector-match
2576 @opindex Wno-strict-selector-match
2577 Warn if multiple methods with differing argument and/or return types are
2578 found for a given selector when attempting to send a message using this
2579 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2580 is off (which is the default behavior), the compiler will omit such warnings
2581 if any differences found are confined to types which share the same size
2582 and alignment.
2584 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2585 @opindex Wundeclared-selector
2586 @opindex Wno-undeclared-selector
2587 Warn if a @code{@@selector(@dots{})} expression referring to an
2588 undeclared selector is found.  A selector is considered undeclared if no
2589 method with that name has been declared before the
2590 @code{@@selector(@dots{})} expression, either explicitly in an
2591 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2592 an @code{@@implementation} section.  This option always performs its
2593 checks as soon as a @code{@@selector(@dots{})} expression is found,
2594 while @option{-Wselector} only performs its checks in the final stage of
2595 compilation.  This also enforces the coding style convention
2596 that methods and selectors must be declared before being used.
2598 @item -print-objc-runtime-info
2599 @opindex print-objc-runtime-info
2600 Generate C header describing the largest structure that is passed by
2601 value, if any.
2603 @end table
2605 @node Language Independent Options
2606 @section Options to Control Diagnostic Messages Formatting
2607 @cindex options to control diagnostics formatting
2608 @cindex diagnostic messages
2609 @cindex message formatting
2611 Traditionally, diagnostic messages have been formatted irrespective of
2612 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2613 below can be used to control the diagnostic messages formatting
2614 algorithm, e.g.@: how many characters per line, how often source location
2615 information should be reported.  Right now, only the C++ front end can
2616 honor these options.  However it is expected, in the near future, that
2617 the remaining front ends would be able to digest them correctly.
2619 @table @gcctabopt
2620 @item -fmessage-length=@var{n}
2621 @opindex fmessage-length
2622 Try to format error messages so that they fit on lines of about @var{n}
2623 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2624 the front ends supported by GCC@.  If @var{n} is zero, then no
2625 line-wrapping will be done; each error message will appear on a single
2626 line.
2628 @opindex fdiagnostics-show-location
2629 @item -fdiagnostics-show-location=once
2630 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2631 reporter to emit @emph{once} source location information; that is, in
2632 case the message is too long to fit on a single physical line and has to
2633 be wrapped, the source location won't be emitted (as prefix) again,
2634 over and over, in subsequent continuation lines.  This is the default
2635 behavior.
2637 @item -fdiagnostics-show-location=every-line
2638 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2639 messages reporter to emit the same source location information (as
2640 prefix) for physical lines that result from the process of breaking
2641 a message which is too long to fit on a single line.
2643 @item -fdiagnostics-show-option
2644 @opindex fdiagnostics-show-option
2645 This option instructs the diagnostic machinery to add text to each
2646 diagnostic emitted, which indicates which command line option directly
2647 controls that diagnostic, when such an option is known to the
2648 diagnostic machinery.
2650 @item -Wcoverage-mismatch
2651 @opindex Wcoverage-mismatch
2652 Warn if feedback profiles do not match when using the
2653 @option{-fprofile-use} option.
2654 If a source file was changed between @option{-fprofile-gen} and
2655 @option{-fprofile-use}, the files with the profile feedback can fail
2656 to match the source file and GCC can not use the profile feedback
2657 information.  By default, GCC emits an error message in this case.
2658 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2659 error.  GCC does not use appropriate feedback profiles, so using this
2660 option can result in poorly optimized code.  This option is useful
2661 only in the case of very minor changes such as bug fixes to an
2662 existing code-base.
2664 @end table
2666 @node Warning Options
2667 @section Options to Request or Suppress Warnings
2668 @cindex options to control warnings
2669 @cindex warning messages
2670 @cindex messages, warning
2671 @cindex suppressing warnings
2673 Warnings are diagnostic messages that report constructions which
2674 are not inherently erroneous but which are risky or suggest there
2675 may have been an error.
2677 The following language-independent options do not enable specific
2678 warnings but control the kinds of diagnostics produced by GCC.
2680 @table @gcctabopt
2681 @cindex syntax checking
2682 @item -fsyntax-only
2683 @opindex fsyntax-only
2684 Check the code for syntax errors, but don't do anything beyond that.
2686 @item -w
2687 @opindex w
2688 Inhibit all warning messages.
2690 @item -Werror
2691 @opindex Werror
2692 @opindex Wno-error
2693 Make all warnings into errors.
2695 @item -Werror=
2696 @opindex Werror=
2697 @opindex Wno-error=
2698 Make the specified warning into an error.  The specifier for a warning
2699 is appended, for example @option{-Werror=switch} turns the warnings
2700 controlled by @option{-Wswitch} into errors.  This switch takes a
2701 negative form, to be used to negate @option{-Werror} for specific
2702 warnings, for example @option{-Wno-error=switch} makes
2703 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2704 is in effect.  You can use the @option{-fdiagnostics-show-option}
2705 option to have each controllable warning amended with the option which
2706 controls it, to determine what to use with this option.
2708 Note that specifying @option{-Werror=}@var{foo} automatically implies
2709 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2710 imply anything.
2712 @item -Wfatal-errors
2713 @opindex Wfatal-errors
2714 @opindex Wno-fatal-errors
2715 This option causes the compiler to abort compilation on the first error
2716 occurred rather than trying to keep going and printing further error
2717 messages.
2719 @end table
2721 You can request many specific warnings with options beginning
2722 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2723 implicit declarations.  Each of these specific warning options also
2724 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2725 example, @option{-Wno-implicit}.  This manual lists only one of the
2726 two forms, whichever is not the default.  For further,
2727 language-specific options also refer to @ref{C++ Dialect Options} and
2728 @ref{Objective-C and Objective-C++ Dialect Options}.
2730 @table @gcctabopt
2731 @item -pedantic
2732 @opindex pedantic
2733 Issue all the warnings demanded by strict ISO C and ISO C++;
2734 reject all programs that use forbidden extensions, and some other
2735 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2736 version of the ISO C standard specified by any @option{-std} option used.
2738 Valid ISO C and ISO C++ programs should compile properly with or without
2739 this option (though a rare few will require @option{-ansi} or a
2740 @option{-std} option specifying the required version of ISO C)@.  However,
2741 without this option, certain GNU extensions and traditional C and C++
2742 features are supported as well.  With this option, they are rejected.
2744 @option{-pedantic} does not cause warning messages for use of the
2745 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2746 warnings are also disabled in the expression that follows
2747 @code{__extension__}.  However, only system header files should use
2748 these escape routes; application programs should avoid them.
2749 @xref{Alternate Keywords}.
2751 Some users try to use @option{-pedantic} to check programs for strict ISO
2752 C conformance.  They soon find that it does not do quite what they want:
2753 it finds some non-ISO practices, but not all---only those for which
2754 ISO C @emph{requires} a diagnostic, and some others for which
2755 diagnostics have been added.
2757 A feature to report any failure to conform to ISO C might be useful in
2758 some instances, but would require considerable additional work and would
2759 be quite different from @option{-pedantic}.  We don't have plans to
2760 support such a feature in the near future.
2762 Where the standard specified with @option{-std} represents a GNU
2763 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2764 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2765 extended dialect is based.  Warnings from @option{-pedantic} are given
2766 where they are required by the base standard.  (It would not make sense
2767 for such warnings to be given only for features not in the specified GNU
2768 C dialect, since by definition the GNU dialects of C include all
2769 features the compiler supports with the given option, and there would be
2770 nothing to warn about.)
2772 @item -pedantic-errors
2773 @opindex pedantic-errors
2774 Like @option{-pedantic}, except that errors are produced rather than
2775 warnings.
2777 @item -Wall
2778 @opindex Wall
2779 @opindex Wno-all
2780 This enables all the warnings about constructions that some users
2781 consider questionable, and that are easy to avoid (or modify to
2782 prevent the warning), even in conjunction with macros.  This also
2783 enables some language-specific warnings described in @ref{C++ Dialect
2784 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2786 @option{-Wall} turns on the following warning flags:
2788 @gccoptlist{-Waddress   @gol
2789 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2790 -Wc++0x-compat  @gol
2791 -Wchar-subscripts  @gol
2792 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2793 -Wimplicit-int  @gol
2794 -Wimplicit-function-declaration  @gol
2795 -Wcomment  @gol
2796 -Wformat   @gol
2797 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2798 -Wmissing-braces  @gol
2799 -Wnonnull  @gol
2800 -Wparentheses  @gol
2801 -Wpointer-sign  @gol
2802 -Wreorder   @gol
2803 -Wreturn-type  @gol
2804 -Wsequence-point  @gol
2805 -Wsign-compare @r{(only in C++)}  @gol
2806 -Wstrict-aliasing  @gol
2807 -Wstrict-overflow=1  @gol
2808 -Wswitch  @gol
2809 -Wtrigraphs  @gol
2810 -Wuninitialized  @gol
2811 -Wunknown-pragmas  @gol
2812 -Wunused-function  @gol
2813 -Wunused-label     @gol
2814 -Wunused-value     @gol
2815 -Wunused-variable  @gol
2816 -Wvolatile-register-var @gol
2819 Note that some warning flags are not implied by @option{-Wall}.  Some of
2820 them warn about constructions that users generally do not consider
2821 questionable, but which occasionally you might wish to check for;
2822 others warn about constructions that are necessary or hard to avoid in
2823 some cases, and there is no simple way to modify the code to suppress
2824 the warning. Some of them are enabled by @option{-Wextra} but many of
2825 them must be enabled individually.
2827 @item -Wextra
2828 @opindex W
2829 @opindex Wextra
2830 @opindex Wno-extra
2831 This enables some extra warning flags that are not enabled by
2832 @option{-Wall}. (This option used to be called @option{-W}.  The older
2833 name is still supported, but the newer name is more descriptive.)
2835 @gccoptlist{-Wclobbered  @gol
2836 -Wempty-body  @gol
2837 -Wignored-qualifiers @gol
2838 -Wmissing-field-initializers  @gol
2839 -Wmissing-parameter-type @r{(C only)}  @gol
2840 -Wold-style-declaration @r{(C only)}  @gol
2841 -Woverride-init  @gol
2842 -Wsign-compare  @gol
2843 -Wtype-limits  @gol
2844 -Wuninitialized  @gol
2845 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2848 The option @option{-Wextra} also prints warning messages for the
2849 following cases:
2851 @itemize @bullet
2853 @item
2854 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2855 @samp{>}, or @samp{>=}.
2857 @item
2858 (C++ only) An enumerator and a non-enumerator both appear in a
2859 conditional expression.
2861 @item
2862 (C++ only) Ambiguous virtual bases.
2864 @item
2865 (C++ only) Subscripting an array which has been declared @samp{register}.
2867 @item
2868 (C++ only) Taking the address of a variable which has been declared
2869 @samp{register}.
2871 @item
2872 (C++ only) A base class is not initialized in a derived class' copy
2873 constructor.
2875 @end itemize
2877 @item -Wchar-subscripts
2878 @opindex Wchar-subscripts
2879 @opindex Wno-char-subscripts
2880 Warn if an array subscript has type @code{char}.  This is a common cause
2881 of error, as programmers often forget that this type is signed on some
2882 machines.
2883 This warning is enabled by @option{-Wall}.
2885 @item -Wcomment
2886 @opindex Wcomment
2887 @opindex Wno-comment
2888 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2889 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2890 This warning is enabled by @option{-Wall}.
2892 @item -Wformat
2893 @opindex Wformat
2894 @opindex Wno-format
2895 @opindex ffreestanding
2896 @opindex fno-builtin
2897 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2898 the arguments supplied have types appropriate to the format string
2899 specified, and that the conversions specified in the format string make
2900 sense.  This includes standard functions, and others specified by format
2901 attributes (@pxref{Function Attributes}), in the @code{printf},
2902 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2903 not in the C standard) families (or other target-specific families).
2904 Which functions are checked without format attributes having been
2905 specified depends on the standard version selected, and such checks of
2906 functions without the attribute specified are disabled by
2907 @option{-ffreestanding} or @option{-fno-builtin}.
2909 The formats are checked against the format features supported by GNU
2910 libc version 2.2.  These include all ISO C90 and C99 features, as well
2911 as features from the Single Unix Specification and some BSD and GNU
2912 extensions.  Other library implementations may not support all these
2913 features; GCC does not support warning about features that go beyond a
2914 particular library's limitations.  However, if @option{-pedantic} is used
2915 with @option{-Wformat}, warnings will be given about format features not
2916 in the selected standard version (but not for @code{strfmon} formats,
2917 since those are not in any version of the C standard).  @xref{C Dialect
2918 Options,,Options Controlling C Dialect}.
2920 Since @option{-Wformat} also checks for null format arguments for
2921 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2923 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2924 aspects of format checking, the options @option{-Wformat-y2k},
2925 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2926 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2927 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2929 @item -Wformat-y2k
2930 @opindex Wformat-y2k
2931 @opindex Wno-format-y2k
2932 If @option{-Wformat} is specified, also warn about @code{strftime}
2933 formats which may yield only a two-digit year.
2935 @item -Wno-format-contains-nul
2936 @opindex Wno-format-contains-nul
2937 @opindex Wformat-contains-nul
2938 If @option{-Wformat} is specified, do not warn about format strings that
2939 contain NUL bytes.
2941 @item -Wno-format-extra-args
2942 @opindex Wno-format-extra-args
2943 @opindex Wformat-extra-args
2944 If @option{-Wformat} is specified, do not warn about excess arguments to a
2945 @code{printf} or @code{scanf} format function.  The C standard specifies
2946 that such arguments are ignored.
2948 Where the unused arguments lie between used arguments that are
2949 specified with @samp{$} operand number specifications, normally
2950 warnings are still given, since the implementation could not know what
2951 type to pass to @code{va_arg} to skip the unused arguments.  However,
2952 in the case of @code{scanf} formats, this option will suppress the
2953 warning if the unused arguments are all pointers, since the Single
2954 Unix Specification says that such unused arguments are allowed.
2956 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2957 @opindex Wno-format-zero-length
2958 @opindex Wformat-zero-length
2959 If @option{-Wformat} is specified, do not warn about zero-length formats.
2960 The C standard specifies that zero-length formats are allowed.
2962 @item -Wformat-nonliteral
2963 @opindex Wformat-nonliteral
2964 @opindex Wno-format-nonliteral
2965 If @option{-Wformat} is specified, also warn if the format string is not a
2966 string literal and so cannot be checked, unless the format function
2967 takes its format arguments as a @code{va_list}.
2969 @item -Wformat-security
2970 @opindex Wformat-security
2971 @opindex Wno-format-security
2972 If @option{-Wformat} is specified, also warn about uses of format
2973 functions that represent possible security problems.  At present, this
2974 warns about calls to @code{printf} and @code{scanf} functions where the
2975 format string is not a string literal and there are no format arguments,
2976 as in @code{printf (foo);}.  This may be a security hole if the format
2977 string came from untrusted input and contains @samp{%n}.  (This is
2978 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2979 in future warnings may be added to @option{-Wformat-security} that are not
2980 included in @option{-Wformat-nonliteral}.)
2982 @item -Wformat=2
2983 @opindex Wformat=2
2984 @opindex Wno-format=2
2985 Enable @option{-Wformat} plus format checks not included in
2986 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2987 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2989 @item -Wnonnull @r{(C and Objective-C only)}
2990 @opindex Wnonnull
2991 @opindex Wno-nonnull
2992 Warn about passing a null pointer for arguments marked as
2993 requiring a non-null value by the @code{nonnull} function attribute.
2995 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2996 can be disabled with the @option{-Wno-nonnull} option.
2998 @item -Wjump-misses-init @r{(C, Objective-C only)}
2999 @opindex Wjump-misses-init
3000 @opindex Wno-jump-misses-init
3001 Warn if a @code{goto} statement or a @code{switch} statement jumps
3002 forward across the initialization of a variable, or jumps backward to a
3003 label after the variable has been initialized.  This only warns about
3004 variables which are initialized when they are declared.  This warning is
3005 only supported for C and Objective C; in C++ this sort of branch is an
3006 error in any case.
3008 @option{-Wjump-misses-init} is included in @option{-Wall} and
3009 @option{-Wc++-compat}.  It can be disabled with the
3010 @option{-Wno-jump-misses-init} option.
3012 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3013 @opindex Winit-self
3014 @opindex Wno-init-self
3015 Warn about uninitialized variables which are initialized with themselves.
3016 Note this option can only be used with the @option{-Wuninitialized} option.
3018 For example, GCC will warn about @code{i} being uninitialized in the
3019 following snippet only when @option{-Winit-self} has been specified:
3020 @smallexample
3021 @group
3022 int f()
3024   int i = i;
3025   return i;
3027 @end group
3028 @end smallexample
3030 @item -Wimplicit-int @r{(C and Objective-C only)}
3031 @opindex Wimplicit-int
3032 @opindex Wno-implicit-int
3033 Warn when a declaration does not specify a type.
3034 This warning is enabled by @option{-Wall}.
3036 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3037 @opindex Wimplicit-function-declaration
3038 @opindex Wno-implicit-function-declaration
3039 Give a warning whenever a function is used before being declared. In
3040 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3041 enabled by default and it is made into an error by
3042 @option{-pedantic-errors}. This warning is also enabled by
3043 @option{-Wall}.
3045 @item -Wimplicit
3046 @opindex Wimplicit
3047 @opindex Wno-implicit
3048 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3049 This warning is enabled by @option{-Wall}.
3051 @item -Wignored-qualifiers @r{(C and C++ only)}
3052 @opindex Wignored-qualifiers
3053 @opindex Wno-ignored-qualifiers
3054 Warn if the return type of a function has a type qualifier
3055 such as @code{const}.  For ISO C such a type qualifier has no effect,
3056 since the value returned by a function is not an lvalue.
3057 For C++, the warning is only emitted for scalar types or @code{void}.
3058 ISO C prohibits qualified @code{void} return types on function
3059 definitions, so such return types always receive a warning
3060 even without this option.
3062 This warning is also enabled by @option{-Wextra}.
3064 @item -Wmain
3065 @opindex Wmain
3066 @opindex Wno-main
3067 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3068 a function with external linkage, returning int, taking either zero
3069 arguments, two, or three arguments of appropriate types.  This warning
3070 is enabled by default in C++ and is enabled by either @option{-Wall}
3071 or @option{-pedantic}.
3073 @item -Wmissing-braces
3074 @opindex Wmissing-braces
3075 @opindex Wno-missing-braces
3076 Warn if an aggregate or union initializer is not fully bracketed.  In
3077 the following example, the initializer for @samp{a} is not fully
3078 bracketed, but that for @samp{b} is fully bracketed.
3080 @smallexample
3081 int a[2][2] = @{ 0, 1, 2, 3 @};
3082 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3083 @end smallexample
3085 This warning is enabled by @option{-Wall}.
3087 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3088 @opindex Wmissing-include-dirs
3089 @opindex Wno-missing-include-dirs
3090 Warn if a user-supplied include directory does not exist.
3092 @item -Wparentheses
3093 @opindex Wparentheses
3094 @opindex Wno-parentheses
3095 Warn if parentheses are omitted in certain contexts, such
3096 as when there is an assignment in a context where a truth value
3097 is expected, or when operators are nested whose precedence people
3098 often get confused about.
3100 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3101 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3102 interpretation from that of ordinary mathematical notation.
3104 Also warn about constructions where there may be confusion to which
3105 @code{if} statement an @code{else} branch belongs.  Here is an example of
3106 such a case:
3108 @smallexample
3109 @group
3111   if (a)
3112     if (b)
3113       foo ();
3114   else
3115     bar ();
3117 @end group
3118 @end smallexample
3120 In C/C++, every @code{else} branch belongs to the innermost possible
3121 @code{if} statement, which in this example is @code{if (b)}.  This is
3122 often not what the programmer expected, as illustrated in the above
3123 example by indentation the programmer chose.  When there is the
3124 potential for this confusion, GCC will issue a warning when this flag
3125 is specified.  To eliminate the warning, add explicit braces around
3126 the innermost @code{if} statement so there is no way the @code{else}
3127 could belong to the enclosing @code{if}.  The resulting code would
3128 look like this:
3130 @smallexample
3131 @group
3133   if (a)
3134     @{
3135       if (b)
3136         foo ();
3137       else
3138         bar ();
3139     @}
3141 @end group
3142 @end smallexample
3144 This warning is enabled by @option{-Wall}.
3146 @item -Wsequence-point
3147 @opindex Wsequence-point
3148 @opindex Wno-sequence-point
3149 Warn about code that may have undefined semantics because of violations
3150 of sequence point rules in the C and C++ standards.
3152 The C and C++ standards defines the order in which expressions in a C/C++
3153 program are evaluated in terms of @dfn{sequence points}, which represent
3154 a partial ordering between the execution of parts of the program: those
3155 executed before the sequence point, and those executed after it.  These
3156 occur after the evaluation of a full expression (one which is not part
3157 of a larger expression), after the evaluation of the first operand of a
3158 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3159 function is called (but after the evaluation of its arguments and the
3160 expression denoting the called function), and in certain other places.
3161 Other than as expressed by the sequence point rules, the order of
3162 evaluation of subexpressions of an expression is not specified.  All
3163 these rules describe only a partial order rather than a total order,
3164 since, for example, if two functions are called within one expression
3165 with no sequence point between them, the order in which the functions
3166 are called is not specified.  However, the standards committee have
3167 ruled that function calls do not overlap.
3169 It is not specified when between sequence points modifications to the
3170 values of objects take effect.  Programs whose behavior depends on this
3171 have undefined behavior; the C and C++ standards specify that ``Between
3172 the previous and next sequence point an object shall have its stored
3173 value modified at most once by the evaluation of an expression.
3174 Furthermore, the prior value shall be read only to determine the value
3175 to be stored.''.  If a program breaks these rules, the results on any
3176 particular implementation are entirely unpredictable.
3178 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3179 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3180 diagnosed by this option, and it may give an occasional false positive
3181 result, but in general it has been found fairly effective at detecting
3182 this sort of problem in programs.
3184 The standard is worded confusingly, therefore there is some debate
3185 over the precise meaning of the sequence point rules in subtle cases.
3186 Links to discussions of the problem, including proposed formal
3187 definitions, may be found on the GCC readings page, at
3188 @w{@uref{http://gcc.gnu.org/readings.html}}.
3190 This warning is enabled by @option{-Wall} for C and C++.
3192 @item -Wreturn-type
3193 @opindex Wreturn-type
3194 @opindex Wno-return-type
3195 Warn whenever a function is defined with a return-type that defaults
3196 to @code{int}.  Also warn about any @code{return} statement with no
3197 return-value in a function whose return-type is not @code{void}
3198 (falling off the end of the function body is considered returning
3199 without a value), and about a @code{return} statement with an
3200 expression in a function whose return-type is @code{void}.
3202 For C++, a function without return type always produces a diagnostic
3203 message, even when @option{-Wno-return-type} is specified.  The only
3204 exceptions are @samp{main} and functions defined in system headers.
3206 This warning is enabled by @option{-Wall}.
3208 @item -Wswitch
3209 @opindex Wswitch
3210 @opindex Wno-switch
3211 Warn whenever a @code{switch} statement has an index of enumerated type
3212 and lacks a @code{case} for one or more of the named codes of that
3213 enumeration.  (The presence of a @code{default} label prevents this
3214 warning.)  @code{case} labels outside the enumeration range also
3215 provoke warnings when this option is used (even if there is a
3216 @code{default} label).
3217 This warning is enabled by @option{-Wall}.
3219 @item -Wswitch-default
3220 @opindex Wswitch-default
3221 @opindex Wno-switch-default
3222 Warn whenever a @code{switch} statement does not have a @code{default}
3223 case.
3225 @item -Wswitch-enum
3226 @opindex Wswitch-enum
3227 @opindex Wno-switch-enum
3228 Warn whenever a @code{switch} statement has an index of enumerated type
3229 and lacks a @code{case} for one or more of the named codes of that
3230 enumeration.  @code{case} labels outside the enumeration range also
3231 provoke warnings when this option is used.  The only difference
3232 between @option{-Wswitch} and this option is that this option gives a
3233 warning about an omitted enumeration code even if there is a
3234 @code{default} label.
3236 @item -Wsync-nand @r{(C and C++ only)}
3237 @opindex Wsync-nand
3238 @opindex Wno-sync-nand
3239 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3240 built-in functions are used.  These functions changed semantics in GCC 4.4.
3242 @item -Wtrigraphs
3243 @opindex Wtrigraphs
3244 @opindex Wno-trigraphs
3245 Warn if any trigraphs are encountered that might change the meaning of
3246 the program (trigraphs within comments are not warned about).
3247 This warning is enabled by @option{-Wall}.
3249 @item -Wunused-function
3250 @opindex Wunused-function
3251 @opindex Wno-unused-function
3252 Warn whenever a static function is declared but not defined or a
3253 non-inline static function is unused.
3254 This warning is enabled by @option{-Wall}.
3256 @item -Wunused-label
3257 @opindex Wunused-label
3258 @opindex Wno-unused-label
3259 Warn whenever a label is declared but not used.
3260 This warning is enabled by @option{-Wall}.
3262 To suppress this warning use the @samp{unused} attribute
3263 (@pxref{Variable Attributes}).
3265 @item -Wunused-parameter
3266 @opindex Wunused-parameter
3267 @opindex Wno-unused-parameter
3268 Warn whenever a function parameter is unused aside from its declaration.
3270 To suppress this warning use the @samp{unused} attribute
3271 (@pxref{Variable Attributes}).
3273 @item -Wno-unused-result
3274 @opindex Wunused-result
3275 @opindex Wno-unused-result
3276 Do not warn if a caller of a function marked with attribute
3277 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3278 its return value. The default is @option{-Wunused-result}.
3280 @item -Wunused-variable
3281 @opindex Wunused-variable
3282 @opindex Wno-unused-variable
3283 Warn whenever a local variable or non-constant static variable is unused
3284 aside from its declaration.
3285 This warning is enabled by @option{-Wall}.
3287 To suppress this warning use the @samp{unused} attribute
3288 (@pxref{Variable Attributes}).
3290 @item -Wunused-value
3291 @opindex Wunused-value
3292 @opindex Wno-unused-value
3293 Warn whenever a statement computes a result that is explicitly not
3294 used. To suppress this warning cast the unused expression to
3295 @samp{void}. This includes an expression-statement or the left-hand
3296 side of a comma expression that contains no side effects. For example,
3297 an expression such as @samp{x[i,j]} will cause a warning, while
3298 @samp{x[(void)i,j]} will not.
3300 This warning is enabled by @option{-Wall}.
3302 @item -Wunused
3303 @opindex Wunused
3304 @opindex Wno-unused
3305 All the above @option{-Wunused} options combined.
3307 In order to get a warning about an unused function parameter, you must
3308 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3309 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3311 @item -Wuninitialized
3312 @opindex Wuninitialized
3313 @opindex Wno-uninitialized
3314 Warn if an automatic variable is used without first being initialized
3315 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3316 warn if a non-static reference or non-static @samp{const} member
3317 appears in a class without constructors.
3319 If you want to warn about code which uses the uninitialized value of the
3320 variable in its own initializer, use the @option{-Winit-self} option.
3322 These warnings occur for individual uninitialized or clobbered
3323 elements of structure, union or array variables as well as for
3324 variables which are uninitialized or clobbered as a whole.  They do
3325 not occur for variables or elements declared @code{volatile}.  Because
3326 these warnings depend on optimization, the exact variables or elements
3327 for which there are warnings will depend on the precise optimization
3328 options and version of GCC used.
3330 Note that there may be no warning about a variable that is used only
3331 to compute a value that itself is never used, because such
3332 computations may be deleted by data flow analysis before the warnings
3333 are printed.
3335 These warnings are made optional because GCC is not smart
3336 enough to see all the reasons why the code might be correct
3337 despite appearing to have an error.  Here is one example of how
3338 this can happen:
3340 @smallexample
3341 @group
3343   int x;
3344   switch (y)
3345     @{
3346     case 1: x = 1;
3347       break;
3348     case 2: x = 4;
3349       break;
3350     case 3: x = 5;
3351     @}
3352   foo (x);
3354 @end group
3355 @end smallexample
3357 @noindent
3358 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3359 always initialized, but GCC doesn't know this.  Here is
3360 another common case:
3362 @smallexample
3364   int save_y;
3365   if (change_y) save_y = y, y = new_y;
3366   @dots{}
3367   if (change_y) y = save_y;
3369 @end smallexample
3371 @noindent
3372 This has no bug because @code{save_y} is used only if it is set.
3374 @cindex @code{longjmp} warnings
3375 This option also warns when a non-volatile automatic variable might be
3376 changed by a call to @code{longjmp}.  These warnings as well are possible
3377 only in optimizing compilation.
3379 The compiler sees only the calls to @code{setjmp}.  It cannot know
3380 where @code{longjmp} will be called; in fact, a signal handler could
3381 call it at any point in the code.  As a result, you may get a warning
3382 even when there is in fact no problem because @code{longjmp} cannot
3383 in fact be called at the place which would cause a problem.
3385 Some spurious warnings can be avoided if you declare all the functions
3386 you use that never return as @code{noreturn}.  @xref{Function
3387 Attributes}.
3389 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3391 @item -Wunknown-pragmas
3392 @opindex Wunknown-pragmas
3393 @opindex Wno-unknown-pragmas
3394 @cindex warning for unknown pragmas
3395 @cindex unknown pragmas, warning
3396 @cindex pragmas, warning of unknown
3397 Warn when a #pragma directive is encountered which is not understood by
3398 GCC@.  If this command line option is used, warnings will even be issued
3399 for unknown pragmas in system header files.  This is not the case if
3400 the warnings were only enabled by the @option{-Wall} command line option.
3402 @item -Wno-pragmas
3403 @opindex Wno-pragmas
3404 @opindex Wpragmas
3405 Do not warn about misuses of pragmas, such as incorrect parameters,
3406 invalid syntax, or conflicts between pragmas.  See also
3407 @samp{-Wunknown-pragmas}.
3409 @item -Wstrict-aliasing
3410 @opindex Wstrict-aliasing
3411 @opindex Wno-strict-aliasing
3412 This option is only active when @option{-fstrict-aliasing} is active.
3413 It warns about code which might break the strict aliasing rules that the
3414 compiler is using for optimization.  The warning does not catch all
3415 cases, but does attempt to catch the more common pitfalls.  It is
3416 included in @option{-Wall}.
3417 It is equivalent to @option{-Wstrict-aliasing=3}
3419 @item -Wstrict-aliasing=n
3420 @opindex Wstrict-aliasing=n
3421 @opindex Wno-strict-aliasing=n
3422 This option is only active when @option{-fstrict-aliasing} is active.
3423 It warns about code which might break the strict aliasing rules that the
3424 compiler is using for optimization.
3425 Higher levels correspond to higher accuracy (fewer false positives).
3426 Higher levels also correspond to more effort, similar to the way -O works.
3427 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3428 with n=3.
3430 Level 1: Most aggressive, quick, least accurate.
3431 Possibly useful when higher levels
3432 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3433 false negatives.  However, it has many false positives.
3434 Warns for all pointer conversions between possibly incompatible types,
3435 even if never dereferenced.  Runs in the frontend only.
3437 Level 2: Aggressive, quick, not too precise.
3438 May still have many false positives (not as many as level 1 though),
3439 and few false negatives (but possibly more than level 1).
3440 Unlike level 1, it only warns when an address is taken.  Warns about
3441 incomplete types.  Runs in the frontend only.
3443 Level 3 (default for @option{-Wstrict-aliasing}):
3444 Should have very few false positives and few false
3445 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3446 Takes care of the common punn+dereference pattern in the frontend:
3447 @code{*(int*)&some_float}.
3448 If optimization is enabled, it also runs in the backend, where it deals
3449 with multiple statement cases using flow-sensitive points-to information.
3450 Only warns when the converted pointer is dereferenced.
3451 Does not warn about incomplete types.
3453 @item -Wstrict-overflow
3454 @itemx -Wstrict-overflow=@var{n}
3455 @opindex Wstrict-overflow
3456 @opindex Wno-strict-overflow
3457 This option is only active when @option{-fstrict-overflow} is active.
3458 It warns about cases where the compiler optimizes based on the
3459 assumption that signed overflow does not occur.  Note that it does not
3460 warn about all cases where the code might overflow: it only warns
3461 about cases where the compiler implements some optimization.  Thus
3462 this warning depends on the optimization level.
3464 An optimization which assumes that signed overflow does not occur is
3465 perfectly safe if the values of the variables involved are such that
3466 overflow never does, in fact, occur.  Therefore this warning can
3467 easily give a false positive: a warning about code which is not
3468 actually a problem.  To help focus on important issues, several
3469 warning levels are defined.  No warnings are issued for the use of
3470 undefined signed overflow when estimating how many iterations a loop
3471 will require, in particular when determining whether a loop will be
3472 executed at all.
3474 @table @gcctabopt
3475 @item -Wstrict-overflow=1
3476 Warn about cases which are both questionable and easy to avoid.  For
3477 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3478 compiler will simplify this to @code{1}.  This level of
3479 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3480 are not, and must be explicitly requested.
3482 @item -Wstrict-overflow=2
3483 Also warn about other cases where a comparison is simplified to a
3484 constant.  For example: @code{abs (x) >= 0}.  This can only be
3485 simplified when @option{-fstrict-overflow} is in effect, because
3486 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3487 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3488 @option{-Wstrict-overflow=2}.
3490 @item -Wstrict-overflow=3
3491 Also warn about other cases where a comparison is simplified.  For
3492 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3494 @item -Wstrict-overflow=4
3495 Also warn about other simplifications not covered by the above cases.
3496 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3498 @item -Wstrict-overflow=5
3499 Also warn about cases where the compiler reduces the magnitude of a
3500 constant involved in a comparison.  For example: @code{x + 2 > y} will
3501 be simplified to @code{x + 1 >= y}.  This is reported only at the
3502 highest warning level because this simplification applies to many
3503 comparisons, so this warning level will give a very large number of
3504 false positives.
3505 @end table
3507 @item -Warray-bounds
3508 @opindex Wno-array-bounds
3509 @opindex Warray-bounds
3510 This option is only active when @option{-ftree-vrp} is active
3511 (default for -O2 and above). It warns about subscripts to arrays
3512 that are always out of bounds. This warning is enabled by @option{-Wall}.
3514 @item -Wno-div-by-zero
3515 @opindex Wno-div-by-zero
3516 @opindex Wdiv-by-zero
3517 Do not warn about compile-time integer division by zero.  Floating point
3518 division by zero is not warned about, as it can be a legitimate way of
3519 obtaining infinities and NaNs.
3521 @item -Wsystem-headers
3522 @opindex Wsystem-headers
3523 @opindex Wno-system-headers
3524 @cindex warnings from system headers
3525 @cindex system headers, warnings from
3526 Print warning messages for constructs found in system header files.
3527 Warnings from system headers are normally suppressed, on the assumption
3528 that they usually do not indicate real problems and would only make the
3529 compiler output harder to read.  Using this command line option tells
3530 GCC to emit warnings from system headers as if they occurred in user
3531 code.  However, note that using @option{-Wall} in conjunction with this
3532 option will @emph{not} warn about unknown pragmas in system
3533 headers---for that, @option{-Wunknown-pragmas} must also be used.
3535 @item -Wfloat-equal
3536 @opindex Wfloat-equal
3537 @opindex Wno-float-equal
3538 Warn if floating point values are used in equality comparisons.
3540 The idea behind this is that sometimes it is convenient (for the
3541 programmer) to consider floating-point values as approximations to
3542 infinitely precise real numbers.  If you are doing this, then you need
3543 to compute (by analyzing the code, or in some other way) the maximum or
3544 likely maximum error that the computation introduces, and allow for it
3545 when performing comparisons (and when producing output, but that's a
3546 different problem).  In particular, instead of testing for equality, you
3547 would check to see whether the two values have ranges that overlap; and
3548 this is done with the relational operators, so equality comparisons are
3549 probably mistaken.
3551 @item -Wtraditional @r{(C and Objective-C only)}
3552 @opindex Wtraditional
3553 @opindex Wno-traditional
3554 Warn about certain constructs that behave differently in traditional and
3555 ISO C@.  Also warn about ISO C constructs that have no traditional C
3556 equivalent, and/or problematic constructs which should be avoided.
3558 @itemize @bullet
3559 @item
3560 Macro parameters that appear within string literals in the macro body.
3561 In traditional C macro replacement takes place within string literals,
3562 but does not in ISO C@.
3564 @item
3565 In traditional C, some preprocessor directives did not exist.
3566 Traditional preprocessors would only consider a line to be a directive
3567 if the @samp{#} appeared in column 1 on the line.  Therefore
3568 @option{-Wtraditional} warns about directives that traditional C
3569 understands but would ignore because the @samp{#} does not appear as the
3570 first character on the line.  It also suggests you hide directives like
3571 @samp{#pragma} not understood by traditional C by indenting them.  Some
3572 traditional implementations would not recognize @samp{#elif}, so it
3573 suggests avoiding it altogether.
3575 @item
3576 A function-like macro that appears without arguments.
3578 @item
3579 The unary plus operator.
3581 @item
3582 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3583 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3584 constants.)  Note, these suffixes appear in macros defined in the system
3585 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3586 Use of these macros in user code might normally lead to spurious
3587 warnings, however GCC's integrated preprocessor has enough context to
3588 avoid warning in these cases.
3590 @item
3591 A function declared external in one block and then used after the end of
3592 the block.
3594 @item
3595 A @code{switch} statement has an operand of type @code{long}.
3597 @item
3598 A non-@code{static} function declaration follows a @code{static} one.
3599 This construct is not accepted by some traditional C compilers.
3601 @item
3602 The ISO type of an integer constant has a different width or
3603 signedness from its traditional type.  This warning is only issued if
3604 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3605 typically represent bit patterns, are not warned about.
3607 @item
3608 Usage of ISO string concatenation is detected.
3610 @item
3611 Initialization of automatic aggregates.
3613 @item
3614 Identifier conflicts with labels.  Traditional C lacks a separate
3615 namespace for labels.
3617 @item
3618 Initialization of unions.  If the initializer is zero, the warning is
3619 omitted.  This is done under the assumption that the zero initializer in
3620 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3621 initializer warnings and relies on default initialization to zero in the
3622 traditional C case.
3624 @item
3625 Conversions by prototypes between fixed/floating point values and vice
3626 versa.  The absence of these prototypes when compiling with traditional
3627 C would cause serious problems.  This is a subset of the possible
3628 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3630 @item
3631 Use of ISO C style function definitions.  This warning intentionally is
3632 @emph{not} issued for prototype declarations or variadic functions
3633 because these ISO C features will appear in your code when using
3634 libiberty's traditional C compatibility macros, @code{PARAMS} and
3635 @code{VPARAMS}.  This warning is also bypassed for nested functions
3636 because that feature is already a GCC extension and thus not relevant to
3637 traditional C compatibility.
3638 @end itemize
3640 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3641 @opindex Wtraditional-conversion
3642 @opindex Wno-traditional-conversion
3643 Warn if a prototype causes a type conversion that is different from what
3644 would happen to the same argument in the absence of a prototype.  This
3645 includes conversions of fixed point to floating and vice versa, and
3646 conversions changing the width or signedness of a fixed point argument
3647 except when the same as the default promotion.
3649 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3650 @opindex Wdeclaration-after-statement
3651 @opindex Wno-declaration-after-statement
3652 Warn when a declaration is found after a statement in a block.  This
3653 construct, known from C++, was introduced with ISO C99 and is by default
3654 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3655 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3657 @item -Wundef
3658 @opindex Wundef
3659 @opindex Wno-undef
3660 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3662 @item -Wno-endif-labels
3663 @opindex Wno-endif-labels
3664 @opindex Wendif-labels
3665 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3667 @item -Wshadow
3668 @opindex Wshadow
3669 @opindex Wno-shadow
3670 Warn whenever a local variable shadows another local variable, parameter or
3671 global variable or whenever a built-in function is shadowed.
3673 @item -Wlarger-than=@var{len}
3674 @opindex Wlarger-than=@var{len}
3675 @opindex Wlarger-than-@var{len}
3676 Warn whenever an object of larger than @var{len} bytes is defined.
3678 @item -Wframe-larger-than=@var{len}
3679 @opindex Wframe-larger-than
3680 Warn if the size of a function frame is larger than @var{len} bytes.
3681 The computation done to determine the stack frame size is approximate
3682 and not conservative.
3683 The actual requirements may be somewhat greater than @var{len}
3684 even if you do not get a warning.  In addition, any space allocated
3685 via @code{alloca}, variable-length arrays, or related constructs
3686 is not included by the compiler when determining
3687 whether or not to issue a warning.
3689 @item -Wunsafe-loop-optimizations
3690 @opindex Wunsafe-loop-optimizations
3691 @opindex Wno-unsafe-loop-optimizations
3692 Warn if the loop cannot be optimized because the compiler could not
3693 assume anything on the bounds of the loop indices.  With
3694 @option{-funsafe-loop-optimizations} warn if the compiler made
3695 such assumptions.
3697 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3698 @opindex Wno-pedantic-ms-format
3699 @opindex Wpedantic-ms-format
3700 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3701 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3702 depending on the MS runtime, when you are using the options @option{-Wformat}
3703 and @option{-pedantic} without gnu-extensions.
3705 @item -Wpointer-arith
3706 @opindex Wpointer-arith
3707 @opindex Wno-pointer-arith
3708 Warn about anything that depends on the ``size of'' a function type or
3709 of @code{void}.  GNU C assigns these types a size of 1, for
3710 convenience in calculations with @code{void *} pointers and pointers
3711 to functions.  In C++, warn also when an arithmetic operation involves
3712 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3714 @item -Wtype-limits
3715 @opindex Wtype-limits
3716 @opindex Wno-type-limits
3717 Warn if a comparison is always true or always false due to the limited
3718 range of the data type, but do not warn for constant expressions.  For
3719 example, warn if an unsigned variable is compared against zero with
3720 @samp{<} or @samp{>=}.  This warning is also enabled by
3721 @option{-Wextra}.
3723 @item -Wbad-function-cast @r{(C and Objective-C only)}
3724 @opindex Wbad-function-cast
3725 @opindex Wno-bad-function-cast
3726 Warn whenever a function call is cast to a non-matching type.
3727 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3729 @item -Wc++-compat @r{(C and Objective-C only)}
3730 Warn about ISO C constructs that are outside of the common subset of
3731 ISO C and ISO C++, e.g.@: request for implicit conversion from
3732 @code{void *} to a pointer to non-@code{void} type.
3734 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3735 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3736 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3737 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3739 @item -Wcast-qual
3740 @opindex Wcast-qual
3741 @opindex Wno-cast-qual
3742 Warn whenever a pointer is cast so as to remove a type qualifier from
3743 the target type.  For example, warn if a @code{const char *} is cast
3744 to an ordinary @code{char *}.
3746 Also warn when making a cast which introduces a type qualifier in an
3747 unsafe way.  For example, casting @code{char **} to @code{const char **}
3748 is unsafe, as in this example:
3750 @smallexample
3751   /* p is char ** value.  */
3752   const char **q = (const char **) p;
3753   /* Assignment of readonly string to const char * is OK.  */
3754   *q = "string";
3755   /* Now char** pointer points to read-only memory.  */
3756   **p = 'b';
3757 @end smallexample
3759 @item -Wcast-align
3760 @opindex Wcast-align
3761 @opindex Wno-cast-align
3762 Warn whenever a pointer is cast such that the required alignment of the
3763 target is increased.  For example, warn if a @code{char *} is cast to
3764 an @code{int *} on machines where integers can only be accessed at
3765 two- or four-byte boundaries.
3767 @item -Wwrite-strings
3768 @opindex Wwrite-strings
3769 @opindex Wno-write-strings
3770 When compiling C, give string constants the type @code{const
3771 char[@var{length}]} so that copying the address of one into a
3772 non-@code{const} @code{char *} pointer will get a warning.  These
3773 warnings will help you find at compile time code that can try to write
3774 into a string constant, but only if you have been very careful about
3775 using @code{const} in declarations and prototypes.  Otherwise, it will
3776 just be a nuisance. This is why we did not make @option{-Wall} request
3777 these warnings.
3779 When compiling C++, warn about the deprecated conversion from string
3780 literals to @code{char *}.  This warning is enabled by default for C++
3781 programs.
3783 @item -Wclobbered
3784 @opindex Wclobbered
3785 @opindex Wno-clobbered
3786 Warn for variables that might be changed by @samp{longjmp} or
3787 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3789 @item -Wconversion
3790 @opindex Wconversion
3791 @opindex Wno-conversion
3792 Warn for implicit conversions that may alter a value. This includes
3793 conversions between real and integer, like @code{abs (x)} when
3794 @code{x} is @code{double}; conversions between signed and unsigned,
3795 like @code{unsigned ui = -1}; and conversions to smaller types, like
3796 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3797 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3798 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3799 conversions between signed and unsigned integers can be disabled by
3800 using @option{-Wno-sign-conversion}.
3802 For C++, also warn for conversions between @code{NULL} and non-pointer
3803 types; confusing overload resolution for user-defined conversions; and
3804 conversions that will never use a type conversion operator:
3805 conversions to @code{void}, the same type, a base class or a reference
3806 to them. Warnings about conversions between signed and unsigned
3807 integers are disabled by default in C++ unless
3808 @option{-Wsign-conversion} is explicitly enabled.
3810 @item -Wempty-body
3811 @opindex Wempty-body
3812 @opindex Wno-empty-body
3813 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3814 while} statement.  This warning is also enabled by @option{-Wextra}.
3816 @item -Wenum-compare
3817 @opindex Wenum-compare
3818 @opindex Wno-enum-compare
3819 Warn about a comparison between values of different enum types. In C++
3820 this warning is enabled by default.  In C this warning is enabled by
3821 @option{-Wall}.
3823 @item -Wsign-compare
3824 @opindex Wsign-compare
3825 @opindex Wno-sign-compare
3826 @cindex warning for comparison of signed and unsigned values
3827 @cindex comparison of signed and unsigned values, warning
3828 @cindex signed and unsigned values, comparison warning
3829 Warn when a comparison between signed and unsigned values could produce
3830 an incorrect result when the signed value is converted to unsigned.
3831 This warning is also enabled by @option{-Wextra}; to get the other warnings
3832 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3834 @item -Wsign-conversion
3835 @opindex Wsign-conversion
3836 @opindex Wno-sign-conversion
3837 Warn for implicit conversions that may change the sign of an integer
3838 value, like assigning a signed integer expression to an unsigned
3839 integer variable. An explicit cast silences the warning. In C, this
3840 option is enabled also by @option{-Wconversion}.
3842 @item -Waddress
3843 @opindex Waddress
3844 @opindex Wno-address
3845 Warn about suspicious uses of memory addresses. These include using
3846 the address of a function in a conditional expression, such as
3847 @code{void func(void); if (func)}, and comparisons against the memory
3848 address of a string literal, such as @code{if (x == "abc")}.  Such
3849 uses typically indicate a programmer error: the address of a function
3850 always evaluates to true, so their use in a conditional usually
3851 indicate that the programmer forgot the parentheses in a function
3852 call; and comparisons against string literals result in unspecified
3853 behavior and are not portable in C, so they usually indicate that the
3854 programmer intended to use @code{strcmp}.  This warning is enabled by
3855 @option{-Wall}.
3857 @item -Wlogical-op
3858 @opindex Wlogical-op
3859 @opindex Wno-logical-op
3860 Warn about suspicious uses of logical operators in expressions.
3861 This includes using logical operators in contexts where a
3862 bit-wise operator is likely to be expected.
3864 @item -Waggregate-return
3865 @opindex Waggregate-return
3866 @opindex Wno-aggregate-return
3867 Warn if any functions that return structures or unions are defined or
3868 called.  (In languages where you can return an array, this also elicits
3869 a warning.)
3871 @item -Wno-attributes
3872 @opindex Wno-attributes
3873 @opindex Wattributes
3874 Do not warn if an unexpected @code{__attribute__} is used, such as
3875 unrecognized attributes, function attributes applied to variables,
3876 etc.  This will not stop errors for incorrect use of supported
3877 attributes.
3879 @item -Wno-builtin-macro-redefined
3880 @opindex Wno-builtin-macro-redefined
3881 @opindex Wbuiltin-macro-redefined
3882 Do not warn if certain built-in macros are redefined.  This suppresses
3883 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3884 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3886 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3887 @opindex Wstrict-prototypes
3888 @opindex Wno-strict-prototypes
3889 Warn if a function is declared or defined without specifying the
3890 argument types.  (An old-style function definition is permitted without
3891 a warning if preceded by a declaration which specifies the argument
3892 types.)
3894 @item -Wold-style-declaration @r{(C and Objective-C only)}
3895 @opindex Wold-style-declaration
3896 @opindex Wno-old-style-declaration
3897 Warn for obsolescent usages, according to the C Standard, in a
3898 declaration. For example, warn if storage-class specifiers like
3899 @code{static} are not the first things in a declaration.  This warning
3900 is also enabled by @option{-Wextra}.
3902 @item -Wold-style-definition @r{(C and Objective-C only)}
3903 @opindex Wold-style-definition
3904 @opindex Wno-old-style-definition
3905 Warn if an old-style function definition is used.  A warning is given
3906 even if there is a previous prototype.
3908 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3909 @opindex Wmissing-parameter-type
3910 @opindex Wno-missing-parameter-type
3911 A function parameter is declared without a type specifier in K&R-style
3912 functions:
3914 @smallexample
3915 void foo(bar) @{ @}
3916 @end smallexample
3918 This warning is also enabled by @option{-Wextra}.
3920 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3921 @opindex Wmissing-prototypes
3922 @opindex Wno-missing-prototypes
3923 Warn if a global function is defined without a previous prototype
3924 declaration.  This warning is issued even if the definition itself
3925 provides a prototype.  The aim is to detect global functions that fail
3926 to be declared in header files.
3928 @item -Wmissing-declarations
3929 @opindex Wmissing-declarations
3930 @opindex Wno-missing-declarations
3931 Warn if a global function is defined without a previous declaration.
3932 Do so even if the definition itself provides a prototype.
3933 Use this option to detect global functions that are not declared in
3934 header files.  In C++, no warnings are issued for function templates,
3935 or for inline functions, or for functions in anonymous namespaces.
3937 @item -Wmissing-field-initializers
3938 @opindex Wmissing-field-initializers
3939 @opindex Wno-missing-field-initializers
3940 @opindex W
3941 @opindex Wextra
3942 @opindex Wno-extra
3943 Warn if a structure's initializer has some fields missing.  For
3944 example, the following code would cause such a warning, because
3945 @code{x.h} is implicitly zero:
3947 @smallexample
3948 struct s @{ int f, g, h; @};
3949 struct s x = @{ 3, 4 @};
3950 @end smallexample
3952 This option does not warn about designated initializers, so the following
3953 modification would not trigger a warning:
3955 @smallexample
3956 struct s @{ int f, g, h; @};
3957 struct s x = @{ .f = 3, .g = 4 @};
3958 @end smallexample
3960 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3961 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3963 @item -Wmissing-noreturn
3964 @opindex Wmissing-noreturn
3965 @opindex Wno-missing-noreturn
3966 Warn about functions which might be candidates for attribute @code{noreturn}.
3967 Note these are only possible candidates, not absolute ones.  Care should
3968 be taken to manually verify functions actually do not ever return before
3969 adding the @code{noreturn} attribute, otherwise subtle code generation
3970 bugs could be introduced.  You will not get a warning for @code{main} in
3971 hosted C environments.
3973 @item -Wmissing-format-attribute
3974 @opindex Wmissing-format-attribute
3975 @opindex Wno-missing-format-attribute
3976 @opindex Wformat
3977 @opindex Wno-format
3978 Warn about function pointers which might be candidates for @code{format}
3979 attributes.  Note these are only possible candidates, not absolute ones.
3980 GCC will guess that function pointers with @code{format} attributes that
3981 are used in assignment, initialization, parameter passing or return
3982 statements should have a corresponding @code{format} attribute in the
3983 resulting type.  I.e.@: the left-hand side of the assignment or
3984 initialization, the type of the parameter variable, or the return type
3985 of the containing function respectively should also have a @code{format}
3986 attribute to avoid the warning.
3988 GCC will also warn about function definitions which might be
3989 candidates for @code{format} attributes.  Again, these are only
3990 possible candidates.  GCC will guess that @code{format} attributes
3991 might be appropriate for any function that calls a function like
3992 @code{vprintf} or @code{vscanf}, but this might not always be the
3993 case, and some functions for which @code{format} attributes are
3994 appropriate may not be detected.
3996 @item -Wno-multichar
3997 @opindex Wno-multichar
3998 @opindex Wmultichar
3999 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4000 Usually they indicate a typo in the user's code, as they have
4001 implementation-defined values, and should not be used in portable code.
4003 @item -Wnormalized=<none|id|nfc|nfkc>
4004 @opindex Wnormalized=
4005 @cindex NFC
4006 @cindex NFKC
4007 @cindex character set, input normalization
4008 In ISO C and ISO C++, two identifiers are different if they are
4009 different sequences of characters.  However, sometimes when characters
4010 outside the basic ASCII character set are used, you can have two
4011 different character sequences that look the same.  To avoid confusion,
4012 the ISO 10646 standard sets out some @dfn{normalization rules} which
4013 when applied ensure that two sequences that look the same are turned into
4014 the same sequence.  GCC can warn you if you are using identifiers which
4015 have not been normalized; this option controls that warning.
4017 There are four levels of warning that GCC supports.  The default is
4018 @option{-Wnormalized=nfc}, which warns about any identifier which is
4019 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4020 recommended form for most uses.
4022 Unfortunately, there are some characters which ISO C and ISO C++ allow
4023 in identifiers that when turned into NFC aren't allowable as
4024 identifiers.  That is, there's no way to use these symbols in portable
4025 ISO C or C++ and have all your identifiers in NFC@.
4026 @option{-Wnormalized=id} suppresses the warning for these characters.
4027 It is hoped that future versions of the standards involved will correct
4028 this, which is why this option is not the default.
4030 You can switch the warning off for all characters by writing
4031 @option{-Wnormalized=none}.  You would only want to do this if you
4032 were using some other normalization scheme (like ``D''), because
4033 otherwise you can easily create bugs that are literally impossible to see.
4035 Some characters in ISO 10646 have distinct meanings but look identical
4036 in some fonts or display methodologies, especially once formatting has
4037 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4038 LETTER N'', will display just like a regular @code{n} which has been
4039 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4040 normalization scheme to convert all these into a standard form as
4041 well, and GCC will warn if your code is not in NFKC if you use
4042 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4043 about every identifier that contains the letter O because it might be
4044 confused with the digit 0, and so is not the default, but may be
4045 useful as a local coding convention if the programming environment is
4046 unable to be fixed to display these characters distinctly.
4048 @item -Wno-deprecated
4049 @opindex Wno-deprecated
4050 @opindex Wdeprecated
4051 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4053 @item -Wno-deprecated-declarations
4054 @opindex Wno-deprecated-declarations
4055 @opindex Wdeprecated-declarations
4056 Do not warn about uses of functions (@pxref{Function Attributes}),
4057 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4058 Attributes}) marked as deprecated by using the @code{deprecated}
4059 attribute.
4061 @item -Wno-overflow
4062 @opindex Wno-overflow
4063 @opindex Woverflow
4064 Do not warn about compile-time overflow in constant expressions.
4066 @item -Woverride-init @r{(C and Objective-C only)}
4067 @opindex Woverride-init
4068 @opindex Wno-override-init
4069 @opindex W
4070 @opindex Wextra
4071 @opindex Wno-extra
4072 Warn if an initialized field without side effects is overridden when
4073 using designated initializers (@pxref{Designated Inits, , Designated
4074 Initializers}).
4076 This warning is included in @option{-Wextra}.  To get other
4077 @option{-Wextra} warnings without this one, use @samp{-Wextra
4078 -Wno-override-init}.
4080 @item -Wpacked
4081 @opindex Wpacked
4082 @opindex Wno-packed
4083 Warn if a structure is given the packed attribute, but the packed
4084 attribute has no effect on the layout or size of the structure.
4085 Such structures may be mis-aligned for little benefit.  For
4086 instance, in this code, the variable @code{f.x} in @code{struct bar}
4087 will be misaligned even though @code{struct bar} does not itself
4088 have the packed attribute:
4090 @smallexample
4091 @group
4092 struct foo @{
4093   int x;
4094   char a, b, c, d;
4095 @} __attribute__((packed));
4096 struct bar @{
4097   char z;
4098   struct foo f;
4100 @end group
4101 @end smallexample
4103 @item -Wpacked-bitfield-compat
4104 @opindex Wpacked-bitfield-compat
4105 @opindex Wno-packed-bitfield-compat
4106 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4107 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4108 the change can lead to differences in the structure layout.  GCC
4109 informs you when the offset of such a field has changed in GCC 4.4.
4110 For example there is no longer a 4-bit padding between field @code{a}
4111 and @code{b} in this structure:
4113 @smallexample
4114 struct foo
4116   char a:4;
4117   char b:8;
4118 @} __attribute__ ((packed));
4119 @end smallexample
4121 This warning is enabled by default.  Use
4122 @option{-Wno-packed-bitfield-compat} to disable this warning.
4124 @item -Wpadded
4125 @opindex Wpadded
4126 @opindex Wno-padded
4127 Warn if padding is included in a structure, either to align an element
4128 of the structure or to align the whole structure.  Sometimes when this
4129 happens it is possible to rearrange the fields of the structure to
4130 reduce the padding and so make the structure smaller.
4132 @item -Wredundant-decls
4133 @opindex Wredundant-decls
4134 @opindex Wno-redundant-decls
4135 Warn if anything is declared more than once in the same scope, even in
4136 cases where multiple declaration is valid and changes nothing.
4138 @item -Wnested-externs @r{(C and Objective-C only)}
4139 @opindex Wnested-externs
4140 @opindex Wno-nested-externs
4141 Warn if an @code{extern} declaration is encountered within a function.
4143 @item -Wunreachable-code
4144 @opindex Wunreachable-code
4145 @opindex Wno-unreachable-code
4146 Warn if the compiler detects that code will never be executed.
4148 This option is intended to warn when the compiler detects that at
4149 least a whole line of source code will never be executed, because
4150 some condition is never satisfied or because it is after a
4151 procedure that never returns.
4153 It is possible for this option to produce a warning even though there
4154 are circumstances under which part of the affected line can be executed,
4155 so care should be taken when removing apparently-unreachable code.
4157 For instance, when a function is inlined, a warning may mean that the
4158 line is unreachable in only one inlined copy of the function.
4160 This option is not made part of @option{-Wall} because in a debugging
4161 version of a program there is often substantial code which checks
4162 correct functioning of the program and is, hopefully, unreachable
4163 because the program does work.  Another common use of unreachable
4164 code is to provide behavior which is selectable at compile-time.
4166 @item -Winline
4167 @opindex Winline
4168 @opindex Wno-inline
4169 Warn if a function can not be inlined and it was declared as inline.
4170 Even with this option, the compiler will not warn about failures to
4171 inline functions declared in system headers.
4173 The compiler uses a variety of heuristics to determine whether or not
4174 to inline a function.  For example, the compiler takes into account
4175 the size of the function being inlined and the amount of inlining
4176 that has already been done in the current function.  Therefore,
4177 seemingly insignificant changes in the source program can cause the
4178 warnings produced by @option{-Winline} to appear or disappear.
4180 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4181 @opindex Wno-invalid-offsetof
4182 @opindex Winvalid-offsetof
4183 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4184 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4185 to a non-POD type is undefined.  In existing C++ implementations,
4186 however, @samp{offsetof} typically gives meaningful results even when
4187 applied to certain kinds of non-POD types. (Such as a simple
4188 @samp{struct} that fails to be a POD type only by virtue of having a
4189 constructor.)  This flag is for users who are aware that they are
4190 writing nonportable code and who have deliberately chosen to ignore the
4191 warning about it.
4193 The restrictions on @samp{offsetof} may be relaxed in a future version
4194 of the C++ standard.
4196 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4197 @opindex Wno-int-to-pointer-cast
4198 @opindex Wint-to-pointer-cast
4199 Suppress warnings from casts to pointer type of an integer of a
4200 different size.
4202 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4203 @opindex Wno-pointer-to-int-cast
4204 @opindex Wpointer-to-int-cast
4205 Suppress warnings from casts from a pointer to an integer type of a
4206 different size.
4208 @item -Winvalid-pch
4209 @opindex Winvalid-pch
4210 @opindex Wno-invalid-pch
4211 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4212 the search path but can't be used.
4214 @item -Wlong-long
4215 @opindex Wlong-long
4216 @opindex Wno-long-long
4217 Warn if @samp{long long} type is used.  This is enabled by either
4218 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4219 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4221 @item -Wvariadic-macros
4222 @opindex Wvariadic-macros
4223 @opindex Wno-variadic-macros
4224 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4225 alternate syntax when in pedantic ISO C99 mode.  This is default.
4226 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4228 @item -Wvla
4229 @opindex Wvla
4230 @opindex Wno-vla
4231 Warn if variable length array is used in the code.
4232 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4233 the variable length array.
4235 @item -Wvolatile-register-var
4236 @opindex Wvolatile-register-var
4237 @opindex Wno-volatile-register-var
4238 Warn if a register variable is declared volatile.  The volatile
4239 modifier does not inhibit all optimizations that may eliminate reads
4240 and/or writes to register variables.  This warning is enabled by
4241 @option{-Wall}.
4243 @item -Wdisabled-optimization
4244 @opindex Wdisabled-optimization
4245 @opindex Wno-disabled-optimization
4246 Warn if a requested optimization pass is disabled.  This warning does
4247 not generally indicate that there is anything wrong with your code; it
4248 merely indicates that GCC's optimizers were unable to handle the code
4249 effectively.  Often, the problem is that your code is too big or too
4250 complex; GCC will refuse to optimize programs when the optimization
4251 itself is likely to take inordinate amounts of time.
4253 @item -Wpointer-sign @r{(C and Objective-C only)}
4254 @opindex Wpointer-sign
4255 @opindex Wno-pointer-sign
4256 Warn for pointer argument passing or assignment with different signedness.
4257 This option is only supported for C and Objective-C@.  It is implied by
4258 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4259 @option{-Wno-pointer-sign}.
4261 @item -Wstack-protector
4262 @opindex Wstack-protector
4263 @opindex Wno-stack-protector
4264 This option is only active when @option{-fstack-protector} is active.  It
4265 warns about functions that will not be protected against stack smashing.
4267 @item -Wno-mudflap
4268 @opindex Wno-mudflap
4269 Suppress warnings about constructs that cannot be instrumented by
4270 @option{-fmudflap}.
4272 @item -Woverlength-strings
4273 @opindex Woverlength-strings
4274 @opindex Wno-overlength-strings
4275 Warn about string constants which are longer than the ``minimum
4276 maximum'' length specified in the C standard.  Modern compilers
4277 generally allow string constants which are much longer than the
4278 standard's minimum limit, but very portable programs should avoid
4279 using longer strings.
4281 The limit applies @emph{after} string constant concatenation, and does
4282 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4283 C99, it was raised to 4095.  C++98 does not specify a normative
4284 minimum maximum, so we do not diagnose overlength strings in C++@.
4286 This option is implied by @option{-pedantic}, and can be disabled with
4287 @option{-Wno-overlength-strings}.
4289 @item -Wunsuffixed-float-constants
4290 @opindex Wunsuffixed-float-constants
4292 GCC will issue a warning for any floating constant that does not have
4293 a suffix.  When used together with @option{-Wsystem-headers} it will
4294 warn about such constants in system header files.  This can be useful
4295 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4296 from the decimal floating-point extension to C99.
4297 @end table
4299 @node Debugging Options
4300 @section Options for Debugging Your Program or GCC
4301 @cindex options, debugging
4302 @cindex debugging information options
4304 GCC has various special options that are used for debugging
4305 either your program or GCC:
4307 @table @gcctabopt
4308 @item -g
4309 @opindex g
4310 Produce debugging information in the operating system's native format
4311 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4312 information.
4314 On most systems that use stabs format, @option{-g} enables use of extra
4315 debugging information that only GDB can use; this extra information
4316 makes debugging work better in GDB but will probably make other debuggers
4317 crash or
4318 refuse to read the program.  If you want to control for certain whether
4319 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4320 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4322 GCC allows you to use @option{-g} with
4323 @option{-O}.  The shortcuts taken by optimized code may occasionally
4324 produce surprising results: some variables you declared may not exist
4325 at all; flow of control may briefly move where you did not expect it;
4326 some statements may not be executed because they compute constant
4327 results or their values were already at hand; some statements may
4328 execute in different places because they were moved out of loops.
4330 Nevertheless it proves possible to debug optimized output.  This makes
4331 it reasonable to use the optimizer for programs that might have bugs.
4333 The following options are useful when GCC is generated with the
4334 capability for more than one debugging format.
4336 @item -ggdb
4337 @opindex ggdb
4338 Produce debugging information for use by GDB@.  This means to use the
4339 most expressive format available (DWARF 2, stabs, or the native format
4340 if neither of those are supported), including GDB extensions if at all
4341 possible.
4343 @item -gstabs
4344 @opindex gstabs
4345 Produce debugging information in stabs format (if that is supported),
4346 without GDB extensions.  This is the format used by DBX on most BSD
4347 systems.  On MIPS, Alpha and System V Release 4 systems this option
4348 produces stabs debugging output which is not understood by DBX or SDB@.
4349 On System V Release 4 systems this option requires the GNU assembler.
4351 @item -feliminate-unused-debug-symbols
4352 @opindex feliminate-unused-debug-symbols
4353 Produce debugging information in stabs format (if that is supported),
4354 for only symbols that are actually used.
4356 @item -femit-class-debug-always
4357 Instead of emitting debugging information for a C++ class in only one
4358 object file, emit it in all object files using the class.  This option
4359 should be used only with debuggers that are unable to handle the way GCC
4360 normally emits debugging information for classes because using this
4361 option will increase the size of debugging information by as much as a
4362 factor of two.
4364 @item -gstabs+
4365 @opindex gstabs+
4366 Produce debugging information in stabs format (if that is supported),
4367 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4368 use of these extensions is likely to make other debuggers crash or
4369 refuse to read the program.
4371 @item -gcoff
4372 @opindex gcoff
4373 Produce debugging information in COFF format (if that is supported).
4374 This is the format used by SDB on most System V systems prior to
4375 System V Release 4.
4377 @item -gxcoff
4378 @opindex gxcoff
4379 Produce debugging information in XCOFF format (if that is supported).
4380 This is the format used by the DBX debugger on IBM RS/6000 systems.
4382 @item -gxcoff+
4383 @opindex gxcoff+
4384 Produce debugging information in XCOFF format (if that is supported),
4385 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4386 use of these extensions is likely to make other debuggers crash or
4387 refuse to read the program, and may cause assemblers other than the GNU
4388 assembler (GAS) to fail with an error.
4390 @item -gdwarf-@var{version}
4391 @opindex gdwarf-@var{version}
4392 Produce debugging information in DWARF format (if that is
4393 supported).  This is the format used by DBX on IRIX 6.  The value
4394 of @var{version} may be either 2 or 3; the default version is 2.
4396 Note that with DWARF version 2 some ports require, and will always
4397 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4399 @item -gvms
4400 @opindex gvms
4401 Produce debugging information in VMS debug format (if that is
4402 supported).  This is the format used by DEBUG on VMS systems.
4404 @item -g@var{level}
4405 @itemx -ggdb@var{level}
4406 @itemx -gstabs@var{level}
4407 @itemx -gcoff@var{level}
4408 @itemx -gxcoff@var{level}
4409 @itemx -gvms@var{level}
4410 Request debugging information and also use @var{level} to specify how
4411 much information.  The default level is 2.
4413 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4414 @option{-g}.
4416 Level 1 produces minimal information, enough for making backtraces in
4417 parts of the program that you don't plan to debug.  This includes
4418 descriptions of functions and external variables, but no information
4419 about local variables and no line numbers.
4421 Level 3 includes extra information, such as all the macro definitions
4422 present in the program.  Some debuggers support macro expansion when
4423 you use @option{-g3}.
4425 @option{-gdwarf-2} does not accept a concatenated debug level, because
4426 GCC used to support an option @option{-gdwarf} that meant to generate
4427 debug information in version 1 of the DWARF format (which is very
4428 different from version 2), and it would have been too confusing.  That
4429 debug format is long obsolete, but the option cannot be changed now.
4430 Instead use an additional @option{-g@var{level}} option to change the
4431 debug level for DWARF.
4433 @item -gtoggle
4434 @opindex gtoggle
4435 Turn off generation of debug info, if leaving out this option would have
4436 generated it, or turn it on at level 2 otherwise.  The position of this
4437 argument in the command line does not matter, it takes effect after all
4438 other options are processed, and it does so only once, no matter how
4439 many times it is given.  This is mainly intended to be used with
4440 @option{-fcompare-debug}.
4442 @item -fdump-final-insns=@var{file}
4443 @opindex fdump-final-insns=
4444 Dump the final internal representation (RTL) to @var{file}.
4446 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4447 @opindex fcompare-debug
4448 @opindex fno-compare-debug
4449 If no error occurs during compilation, run the compiler a second time,
4450 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4451 passed to the second compilation.  Dump the final internal
4452 representation in both compilations, and print an error if they differ.
4454 If the equal sign is omitted, the default @option{-gtoggle} is used.
4456 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4457 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4458 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4459 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4460 is used.
4462 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4463 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4464 of the final representation and the second compilation, preventing even
4465 @env{GCC_COMPARE_DEBUG} from taking effect.
4467 To verify full coverage during @option{-fcompare-debug} testing, set
4468 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4469 which GCC will reject as an invalid option in any actual compilation
4470 (rather than preprocessing, assembly or linking).  To get just a
4471 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4472 not overridden} will do.
4474 @item -fcompare-debug-second
4475 @opindex fcompare-debug-second
4476 This option is implicitly passed to the compiler for the second
4477 compilation requested by @option{-fcompare-debug}, along with options to
4478 silence warnings, and omitting other options that would cause
4479 side-effect compiler outputs to files or to the standard output.  Dump
4480 files and preserved temporary files are renamed so as to contain the
4481 @code{.gk} additional extension during the second compilation, to avoid
4482 overwriting those generated by the first.
4484 When this option is passed to the compiler driver, it causes the
4485 @emph{first} compilation to be skipped, which makes it useful for little
4486 other than debugging the compiler proper.
4488 @item -feliminate-dwarf2-dups
4489 @opindex feliminate-dwarf2-dups
4490 Compress DWARF2 debugging information by eliminating duplicated
4491 information about each symbol.  This option only makes sense when
4492 generating DWARF2 debugging information with @option{-gdwarf-2}.
4494 @item -femit-struct-debug-baseonly
4495 Emit debug information for struct-like types
4496 only when the base name of the compilation source file
4497 matches the base name of file in which the struct was defined.
4499 This option substantially reduces the size of debugging information,
4500 but at significant potential loss in type information to the debugger.
4501 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4502 See @option{-femit-struct-debug-detailed} for more detailed control.
4504 This option works only with DWARF 2.
4506 @item -femit-struct-debug-reduced
4507 Emit debug information for struct-like types
4508 only when the base name of the compilation source file
4509 matches the base name of file in which the type was defined,
4510 unless the struct is a template or defined in a system header.
4512 This option significantly reduces the size of debugging information,
4513 with some potential loss in type information to the debugger.
4514 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4515 See @option{-femit-struct-debug-detailed} for more detailed control.
4517 This option works only with DWARF 2.
4519 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4520 Specify the struct-like types
4521 for which the compiler will generate debug information.
4522 The intent is to reduce duplicate struct debug information
4523 between different object files within the same program.
4525 This option is a detailed version of
4526 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4527 which will serve for most needs.
4529 A specification has the syntax
4530 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4532 The optional first word limits the specification to
4533 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4534 A struct type is used directly when it is the type of a variable, member.
4535 Indirect uses arise through pointers to structs.
4536 That is, when use of an incomplete struct would be legal, the use is indirect.
4537 An example is
4538 @samp{struct one direct; struct two * indirect;}.
4540 The optional second word limits the specification to
4541 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4542 Generic structs are a bit complicated to explain.
4543 For C++, these are non-explicit specializations of template classes,
4544 or non-template classes within the above.
4545 Other programming languages have generics,
4546 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4548 The third word specifies the source files for those
4549 structs for which the compiler will emit debug information.
4550 The values @samp{none} and @samp{any} have the normal meaning.
4551 The value @samp{base} means that
4552 the base of name of the file in which the type declaration appears
4553 must match the base of the name of the main compilation file.
4554 In practice, this means that
4555 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4556 but types declared in other header will not.
4557 The value @samp{sys} means those types satisfying @samp{base}
4558 or declared in system or compiler headers.
4560 You may need to experiment to determine the best settings for your application.
4562 The default is @samp{-femit-struct-debug-detailed=all}.
4564 This option works only with DWARF 2.
4566 @item -fno-merge-debug-strings
4567 @opindex fmerge-debug-strings
4568 @opindex fno-merge-debug-strings
4569 Direct the linker to not merge together strings in the debugging
4570 information which are identical in different object files.  Merging is
4571 not supported by all assemblers or linkers.  Merging decreases the size
4572 of the debug information in the output file at the cost of increasing
4573 link processing time.  Merging is enabled by default.
4575 @item -fdebug-prefix-map=@var{old}=@var{new}
4576 @opindex fdebug-prefix-map
4577 When compiling files in directory @file{@var{old}}, record debugging
4578 information describing them as in @file{@var{new}} instead.
4580 @item -fno-dwarf2-cfi-asm
4581 @opindex fdwarf2-cfi-asm
4582 @opindex fno-dwarf2-cfi-asm
4583 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4584 instead of using GAS @code{.cfi_*} directives.
4586 @cindex @command{prof}
4587 @item -p
4588 @opindex p
4589 Generate extra code to write profile information suitable for the
4590 analysis program @command{prof}.  You must use this option when compiling
4591 the source files you want data about, and you must also use it when
4592 linking.
4594 @cindex @command{gprof}
4595 @item -pg
4596 @opindex pg
4597 Generate extra code to write profile information suitable for the
4598 analysis program @command{gprof}.  You must use this option when compiling
4599 the source files you want data about, and you must also use it when
4600 linking.
4602 @item -Q
4603 @opindex Q
4604 Makes the compiler print out each function name as it is compiled, and
4605 print some statistics about each pass when it finishes.
4607 @item -ftime-report
4608 @opindex ftime-report
4609 Makes the compiler print some statistics about the time consumed by each
4610 pass when it finishes.
4612 @item -fmem-report
4613 @opindex fmem-report
4614 Makes the compiler print some statistics about permanent memory
4615 allocation when it finishes.
4617 @item -fpre-ipa-mem-report
4618 @opindex fpre-ipa-mem-report
4619 @item -fpost-ipa-mem-report
4620 @opindex fpost-ipa-mem-report
4621 Makes the compiler print some statistics about permanent memory
4622 allocation before or after interprocedural optimization.
4624 @item -fprofile-arcs
4625 @opindex fprofile-arcs
4626 Add code so that program flow @dfn{arcs} are instrumented.  During
4627 execution the program records how many times each branch and call is
4628 executed and how many times it is taken or returns.  When the compiled
4629 program exits it saves this data to a file called
4630 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4631 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4632 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4633 @var{auxname} is generated from the name of the output file, if
4634 explicitly specified and it is not the final executable, otherwise it is
4635 the basename of the source file.  In both cases any suffix is removed
4636 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4637 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4638 @xref{Cross-profiling}.
4640 @cindex @command{gcov}
4641 @item --coverage
4642 @opindex coverage
4644 This option is used to compile and link code instrumented for coverage
4645 analysis.  The option is a synonym for @option{-fprofile-arcs}
4646 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4647 linking).  See the documentation for those options for more details.
4649 @itemize
4651 @item
4652 Compile the source files with @option{-fprofile-arcs} plus optimization
4653 and code generation options.  For test coverage analysis, use the
4654 additional @option{-ftest-coverage} option.  You do not need to profile
4655 every source file in a program.
4657 @item
4658 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4659 (the latter implies the former).
4661 @item
4662 Run the program on a representative workload to generate the arc profile
4663 information.  This may be repeated any number of times.  You can run
4664 concurrent instances of your program, and provided that the file system
4665 supports locking, the data files will be correctly updated.  Also
4666 @code{fork} calls are detected and correctly handled (double counting
4667 will not happen).
4669 @item
4670 For profile-directed optimizations, compile the source files again with
4671 the same optimization and code generation options plus
4672 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4673 Control Optimization}).
4675 @item
4676 For test coverage analysis, use @command{gcov} to produce human readable
4677 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4678 @command{gcov} documentation for further information.
4680 @end itemize
4682 With @option{-fprofile-arcs}, for each function of your program GCC
4683 creates a program flow graph, then finds a spanning tree for the graph.
4684 Only arcs that are not on the spanning tree have to be instrumented: the
4685 compiler adds code to count the number of times that these arcs are
4686 executed.  When an arc is the only exit or only entrance to a block, the
4687 instrumentation code can be added to the block; otherwise, a new basic
4688 block must be created to hold the instrumentation code.
4690 @need 2000
4691 @item -ftest-coverage
4692 @opindex ftest-coverage
4693 Produce a notes file that the @command{gcov} code-coverage utility
4694 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4695 show program coverage.  Each source file's note file is called
4696 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4697 above for a description of @var{auxname} and instructions on how to
4698 generate test coverage data.  Coverage data will match the source files
4699 more closely, if you do not optimize.
4701 @item -fdbg-cnt-list
4702 @opindex fdbg-cnt-list
4703 Print the name and the counter upperbound for all debug counters.
4705 @item -fdbg-cnt=@var{counter-value-list}
4706 @opindex fdbg-cnt
4707 Set the internal debug counter upperbound. @var{counter-value-list}
4708 is a comma-separated list of @var{name}:@var{value} pairs
4709 which sets the upperbound of each debug counter @var{name} to @var{value}.
4710 All debug counters have the initial upperbound of @var{UINT_MAX},
4711 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4712 e.g. With -fdbg-cnt=dce:10,tail_call:0
4713 dbg_cnt(dce) will return true only for first 10 invocations
4714 and dbg_cnt(tail_call) will return false always.
4716 @item -d@var{letters}
4717 @itemx -fdump-rtl-@var{pass}
4718 @opindex d
4719 Says to make debugging dumps during compilation at times specified by
4720 @var{letters}.  This is used for debugging the RTL-based passes of the
4721 compiler.  The file names for most of the dumps are made by appending
4722 a pass number and a word to the @var{dumpname}, and the files are
4723 created in the directory of the output file.  @var{dumpname} is
4724 generated from the name of the output file, if explicitly specified
4725 and it is not an executable, otherwise it is the basename of the
4726 source file. These switches may have different effects when
4727 @option{-E} is used for preprocessing.
4729 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4730 @option{-d} option @var{letters}.  Here are the possible
4731 letters for use in @var{pass} and @var{letters}, and their meanings:
4733 @table @gcctabopt
4735 @item -fdump-rtl-alignments
4736 @opindex fdump-rtl-alignments
4737 Dump after branch alignments have been computed.
4739 @item -fdump-rtl-asmcons
4740 @opindex fdump-rtl-asmcons
4741 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4743 @item -fdump-rtl-auto_inc_dec
4744 @opindex fdump-rtl-auto_inc_dec
4745 Dump after auto-inc-dec discovery.  This pass is only run on
4746 architectures that have auto inc or auto dec instructions.
4748 @item -fdump-rtl-barriers
4749 @opindex fdump-rtl-barriers
4750 Dump after cleaning up the barrier instructions.
4752 @item -fdump-rtl-bbpart
4753 @opindex fdump-rtl-bbpart
4754 Dump after partitioning hot and cold basic blocks.
4756 @item -fdump-rtl-bbro
4757 @opindex fdump-rtl-bbro
4758 Dump after block reordering.
4760 @item -fdump-rtl-btl1
4761 @itemx -fdump-rtl-btl2
4762 @opindex fdump-rtl-btl2
4763 @opindex fdump-rtl-btl2
4764 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4765 after the two branch
4766 target load optimization passes.
4768 @item -fdump-rtl-bypass
4769 @opindex fdump-rtl-bypass
4770 Dump after jump bypassing and control flow optimizations.
4772 @item -fdump-rtl-combine
4773 @opindex fdump-rtl-combine
4774 Dump after the RTL instruction combination pass.
4776 @item -fdump-rtl-compgotos
4777 @opindex fdump-rtl-compgotos
4778 Dump after duplicating the computed gotos.
4780 @item -fdump-rtl-ce1
4781 @itemx -fdump-rtl-ce2
4782 @itemx -fdump-rtl-ce3
4783 @opindex fdump-rtl-ce1
4784 @opindex fdump-rtl-ce2
4785 @opindex fdump-rtl-ce3
4786 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4787 @option{-fdump-rtl-ce3} enable dumping after the three
4788 if conversion passes.
4790 @itemx -fdump-rtl-cprop_hardreg
4791 @opindex fdump-rtl-cprop_hardreg
4792 Dump after hard register copy propagation.
4794 @itemx -fdump-rtl-csa
4795 @opindex fdump-rtl-csa
4796 Dump after combining stack adjustments.
4798 @item -fdump-rtl-cse1
4799 @itemx -fdump-rtl-cse2
4800 @opindex fdump-rtl-cse1
4801 @opindex fdump-rtl-cse2
4802 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4803 the two common sub-expression elimination passes.
4805 @itemx -fdump-rtl-dce
4806 @opindex fdump-rtl-dce
4807 Dump after the standalone dead code elimination passes.
4809 @itemx -fdump-rtl-dbr
4810 @opindex fdump-rtl-dbr
4811 Dump after delayed branch scheduling.
4813 @item -fdump-rtl-dce1
4814 @itemx -fdump-rtl-dce2
4815 @opindex fdump-rtl-dce1
4816 @opindex fdump-rtl-dce2
4817 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4818 the two dead store elimination passes.
4820 @item -fdump-rtl-eh
4821 @opindex fdump-rtl-eh
4822 Dump after finalization of EH handling code.
4824 @item -fdump-rtl-eh_ranges
4825 @opindex fdump-rtl-eh_ranges
4826 Dump after conversion of EH handling range regions.
4828 @item -fdump-rtl-expand
4829 @opindex fdump-rtl-expand
4830 Dump after RTL generation.
4832 @item -fdump-rtl-fwprop1
4833 @itemx -fdump-rtl-fwprop2
4834 @opindex fdump-rtl-fwprop1
4835 @opindex fdump-rtl-fwprop2
4836 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4837 dumping after the two forward propagation passes.
4839 @item -fdump-rtl-gcse1
4840 @itemx -fdump-rtl-gcse2
4841 @opindex fdump-rtl-gcse1
4842 @opindex fdump-rtl-gcse2
4843 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4844 after global common subexpression elimination.
4846 @item -fdump-rtl-init-regs
4847 @opindex fdump-rtl-init-regs
4848 Dump after the initialization of the registers.
4850 @item -fdump-rtl-initvals
4851 @opindex fdump-rtl-initvals
4852 Dump after the computation of the initial value sets.
4854 @itemx -fdump-rtl-into_cfglayout
4855 @opindex fdump-rtl-into_cfglayout
4856 Dump after converting to cfglayout mode.
4858 @item -fdump-rtl-ira
4859 @opindex fdump-rtl-ira
4860 Dump after iterated register allocation.
4862 @item -fdump-rtl-jump
4863 @opindex fdump-rtl-jump
4864 Dump after the second jump optimization.
4866 @item -fdump-rtl-loop2
4867 @opindex fdump-rtl-loop2
4868 @option{-fdump-rtl-loop2} enables dumping after the rtl
4869 loop optimization passes.
4871 @item -fdump-rtl-mach
4872 @opindex fdump-rtl-mach
4873 Dump after performing the machine dependent reorganization pass, if that
4874 pass exists.
4876 @item -fdump-rtl-mode_sw
4877 @opindex fdump-rtl-mode_sw
4878 Dump after removing redundant mode switches.
4880 @item -fdump-rtl-rnreg
4881 @opindex fdump-rtl-rnreg
4882 Dump after register renumbering.
4884 @itemx -fdump-rtl-outof_cfglayout
4885 @opindex fdump-rtl-outof_cfglayout
4886 Dump after converting from cfglayout mode.
4888 @item -fdump-rtl-peephole2
4889 @opindex fdump-rtl-peephole2
4890 Dump after the peephole pass.
4892 @item -fdump-rtl-postreload
4893 @opindex fdump-rtl-postreload
4894 Dump after post-reload optimizations.
4896 @itemx -fdump-rtl-pro_and_epilogue
4897 @opindex fdump-rtl-pro_and_epilogue
4898 Dump after generating the function pro and epilogues.
4900 @item -fdump-rtl-regmove
4901 @opindex fdump-rtl-regmove
4902 Dump after the register move pass.
4904 @item -fdump-rtl-sched1
4905 @itemx -fdump-rtl-sched2
4906 @opindex fdump-rtl-sched1
4907 @opindex fdump-rtl-sched2
4908 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4909 after the basic block scheduling passes.
4911 @item -fdump-rtl-see
4912 @opindex fdump-rtl-see
4913 Dump after sign extension elimination.
4915 @item -fdump-rtl-seqabstr
4916 @opindex fdump-rtl-seqabstr
4917 Dump after common sequence discovery.
4919 @item -fdump-rtl-shorten
4920 @opindex fdump-rtl-shorten
4921 Dump after shortening branches.
4923 @item -fdump-rtl-sibling
4924 @opindex fdump-rtl-sibling
4925 Dump after sibling call optimizations.
4927 @item -fdump-rtl-split1
4928 @itemx -fdump-rtl-split2
4929 @itemx -fdump-rtl-split3
4930 @itemx -fdump-rtl-split4
4931 @itemx -fdump-rtl-split5
4932 @opindex fdump-rtl-split1
4933 @opindex fdump-rtl-split2
4934 @opindex fdump-rtl-split3
4935 @opindex fdump-rtl-split4
4936 @opindex fdump-rtl-split5
4937 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
4938 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
4939 @option{-fdump-rtl-split5} enable dumping after five rounds of
4940 instruction splitting.
4942 @item -fdump-rtl-sms
4943 @opindex fdump-rtl-sms
4944 Dump after modulo scheduling.  This pass is only run on some
4945 architectures.
4947 @item -fdump-rtl-stack
4948 @opindex fdump-rtl-stack
4949 Dump after conversion from GCC's "flat register file" registers to the
4950 x87's stack-like registers.  This pass is only run on x86 variants.
4952 @item -fdump-rtl-subreg1
4953 @itemx -fdump-rtl-subreg2
4954 @opindex fdump-rtl-subreg1
4955 @opindex fdump-rtl-subreg2
4956 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
4957 the two subreg expansion passes.
4959 @item -fdump-rtl-unshare
4960 @opindex fdump-rtl-unshare
4961 Dump after all rtl has been unshared.
4963 @item -fdump-rtl-vartrack
4964 @opindex fdump-rtl-vartrack
4965 Dump after variable tracking.
4967 @item -fdump-rtl-vregs
4968 @opindex fdump-rtl-vregs
4969 Dump after converting virtual registers to hard registers.
4971 @item -fdump-rtl-web
4972 @opindex fdump-rtl-web
4973 Dump after live range splitting.
4975 @item -fdump-rtl-regclass
4976 @itemx -fdump-rtl-subregs_of_mode_init
4977 @itemx -fdump-rtl-subregs_of_mode_finish
4978 @itemx -fdump-rtl-dfinit
4979 @itemx -fdump-rtl-dfinish
4980 @opindex fdump-rtl-regclass
4981 @opindex fdump-rtl-subregs_of_mode_init
4982 @opindex fdump-rtl-subregs_of_mode_finish
4983 @opindex fdump-rtl-dfinit
4984 @opindex fdump-rtl-dfinish
4985 These dumps are defined but always produce empty files.
4987 @item -fdump-rtl-all
4988 @opindex fdump-rtl-all
4989 Produce all the dumps listed above.
4991 @item -dA
4992 @opindex dA
4993 Annotate the assembler output with miscellaneous debugging information.
4995 @item -dD
4996 @opindex dD
4997 Dump all macro definitions, at the end of preprocessing, in addition to
4998 normal output.
5000 @item -dH
5001 @opindex dH
5002 Produce a core dump whenever an error occurs.
5004 @item -dm
5005 @opindex dm
5006 Print statistics on memory usage, at the end of the run, to
5007 standard error.
5009 @item -dp
5010 @opindex dp
5011 Annotate the assembler output with a comment indicating which
5012 pattern and alternative was used.  The length of each instruction is
5013 also printed.
5015 @item -dP
5016 @opindex dP
5017 Dump the RTL in the assembler output as a comment before each instruction.
5018 Also turns on @option{-dp} annotation.
5020 @item -dv
5021 @opindex dv
5022 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5023 dump a representation of the control flow graph suitable for viewing with VCG
5024 to @file{@var{file}.@var{pass}.vcg}.
5026 @item -dx
5027 @opindex dx
5028 Just generate RTL for a function instead of compiling it.  Usually used
5029 with @option{-fdump-rtl-expand}.
5031 @item -dy
5032 @opindex dy
5033 Dump debugging information during parsing, to standard error.
5034 @end table
5036 @item -fdump-noaddr
5037 @opindex fdump-noaddr
5038 When doing debugging dumps, suppress address output.  This makes it more
5039 feasible to use diff on debugging dumps for compiler invocations with
5040 different compiler binaries and/or different
5041 text / bss / data / heap / stack / dso start locations.
5043 @item -fdump-unnumbered
5044 @opindex fdump-unnumbered
5045 When doing debugging dumps, suppress instruction numbers and address output.
5046 This makes it more feasible to use diff on debugging dumps for compiler
5047 invocations with different options, in particular with and without
5048 @option{-g}.
5050 @item -fdump-unnumbered-links
5051 @opindex fdump-unnumbered-links
5052 When doing debugging dumps (see @option{-d} option above), suppress
5053 instruction numbers for the links to the previous and next instructions
5054 in a sequence.
5056 @item -fdump-translation-unit @r{(C++ only)}
5057 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5058 @opindex fdump-translation-unit
5059 Dump a representation of the tree structure for the entire translation
5060 unit to a file.  The file name is made by appending @file{.tu} to the
5061 source file name, and the file is created in the same directory as the
5062 output file.  If the @samp{-@var{options}} form is used, @var{options}
5063 controls the details of the dump as described for the
5064 @option{-fdump-tree} options.
5066 @item -fdump-class-hierarchy @r{(C++ only)}
5067 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5068 @opindex fdump-class-hierarchy
5069 Dump a representation of each class's hierarchy and virtual function
5070 table layout to a file.  The file name is made by appending
5071 @file{.class} to the source file name, and the file is created in the
5072 same directory as the output file.  If the @samp{-@var{options}} form
5073 is used, @var{options} controls the details of the dump as described
5074 for the @option{-fdump-tree} options.
5076 @item -fdump-ipa-@var{switch}
5077 @opindex fdump-ipa
5078 Control the dumping at various stages of inter-procedural analysis
5079 language tree to a file.  The file name is generated by appending a
5080 switch specific suffix to the source file name, and the file is created
5081 in the same directory as the output file.  The following dumps are
5082 possible:
5084 @table @samp
5085 @item all
5086 Enables all inter-procedural analysis dumps.
5088 @item cgraph
5089 Dumps information about call-graph optimization, unused function removal,
5090 and inlining decisions.
5092 @item inline
5093 Dump after function inlining.
5095 @end table
5097 @item -fdump-statistics-@var{option}
5098 @opindex fdump-statistics
5099 Enable and control dumping of pass statistics in a separate file.  The
5100 file name is generated by appending a suffix ending in
5101 @samp{.statistics} to the source file name, and the file is created in
5102 the same directory as the output file.  If the @samp{-@var{option}}
5103 form is used, @samp{-stats} will cause counters to be summed over the
5104 whole compilation unit while @samp{-details} will dump every event as
5105 the passes generate them.  The default with no option is to sum
5106 counters for each function compiled.
5108 @item -fdump-tree-@var{switch}
5109 @itemx -fdump-tree-@var{switch}-@var{options}
5110 @opindex fdump-tree
5111 Control the dumping at various stages of processing the intermediate
5112 language tree to a file.  The file name is generated by appending a
5113 switch specific suffix to the source file name, and the file is
5114 created in the same directory as the output file.  If the
5115 @samp{-@var{options}} form is used, @var{options} is a list of
5116 @samp{-} separated options that control the details of the dump.  Not
5117 all options are applicable to all dumps, those which are not
5118 meaningful will be ignored.  The following options are available
5120 @table @samp
5121 @item address
5122 Print the address of each node.  Usually this is not meaningful as it
5123 changes according to the environment and source file.  Its primary use
5124 is for tying up a dump file with a debug environment.
5125 @item asmname
5126 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5127 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5128 use working backward from mangled names in the assembly file.
5129 @item slim
5130 Inhibit dumping of members of a scope or body of a function merely
5131 because that scope has been reached.  Only dump such items when they
5132 are directly reachable by some other path.  When dumping pretty-printed
5133 trees, this option inhibits dumping the bodies of control structures.
5134 @item raw
5135 Print a raw representation of the tree.  By default, trees are
5136 pretty-printed into a C-like representation.
5137 @item details
5138 Enable more detailed dumps (not honored by every dump option).
5139 @item stats
5140 Enable dumping various statistics about the pass (not honored by every dump
5141 option).
5142 @item blocks
5143 Enable showing basic block boundaries (disabled in raw dumps).
5144 @item vops
5145 Enable showing virtual operands for every statement.
5146 @item lineno
5147 Enable showing line numbers for statements.
5148 @item uid
5149 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5150 @item verbose
5151 Enable showing the tree dump for each statement.
5152 @item eh
5153 Enable showing the EH region number holding each statement.
5154 @item all
5155 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5156 and @option{lineno}.
5157 @end table
5159 The following tree dumps are possible:
5160 @table @samp
5162 @item original
5163 @opindex fdump-tree-original
5164 Dump before any tree based optimization, to @file{@var{file}.original}.
5166 @item optimized
5167 @opindex fdump-tree-optimized
5168 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5170 @item gimple
5171 @opindex fdump-tree-gimple
5172 Dump each function before and after the gimplification pass to a file.  The
5173 file name is made by appending @file{.gimple} to the source file name.
5175 @item cfg
5176 @opindex fdump-tree-cfg
5177 Dump the control flow graph of each function to a file.  The file name is
5178 made by appending @file{.cfg} to the source file name.
5180 @item vcg
5181 @opindex fdump-tree-vcg
5182 Dump the control flow graph of each function to a file in VCG format.  The
5183 file name is made by appending @file{.vcg} to the source file name.  Note
5184 that if the file contains more than one function, the generated file cannot
5185 be used directly by VCG@.  You will need to cut and paste each function's
5186 graph into its own separate file first.
5188 @item ch
5189 @opindex fdump-tree-ch
5190 Dump each function after copying loop headers.  The file name is made by
5191 appending @file{.ch} to the source file name.
5193 @item ssa
5194 @opindex fdump-tree-ssa
5195 Dump SSA related information to a file.  The file name is made by appending
5196 @file{.ssa} to the source file name.
5198 @item alias
5199 @opindex fdump-tree-alias
5200 Dump aliasing information for each function.  The file name is made by
5201 appending @file{.alias} to the source file name.
5203 @item ccp
5204 @opindex fdump-tree-ccp
5205 Dump each function after CCP@.  The file name is made by appending
5206 @file{.ccp} to the source file name.
5208 @item storeccp
5209 @opindex fdump-tree-storeccp
5210 Dump each function after STORE-CCP@.  The file name is made by appending
5211 @file{.storeccp} to the source file name.
5213 @item pre
5214 @opindex fdump-tree-pre
5215 Dump trees after partial redundancy elimination.  The file name is made
5216 by appending @file{.pre} to the source file name.
5218 @item fre
5219 @opindex fdump-tree-fre
5220 Dump trees after full redundancy elimination.  The file name is made
5221 by appending @file{.fre} to the source file name.
5223 @item copyprop
5224 @opindex fdump-tree-copyprop
5225 Dump trees after copy propagation.  The file name is made
5226 by appending @file{.copyprop} to the source file name.
5228 @item store_copyprop
5229 @opindex fdump-tree-store_copyprop
5230 Dump trees after store copy-propagation.  The file name is made
5231 by appending @file{.store_copyprop} to the source file name.
5233 @item dce
5234 @opindex fdump-tree-dce
5235 Dump each function after dead code elimination.  The file name is made by
5236 appending @file{.dce} to the source file name.
5238 @item mudflap
5239 @opindex fdump-tree-mudflap
5240 Dump each function after adding mudflap instrumentation.  The file name is
5241 made by appending @file{.mudflap} to the source file name.
5243 @item sra
5244 @opindex fdump-tree-sra
5245 Dump each function after performing scalar replacement of aggregates.  The
5246 file name is made by appending @file{.sra} to the source file name.
5248 @item sink
5249 @opindex fdump-tree-sink
5250 Dump each function after performing code sinking.  The file name is made
5251 by appending @file{.sink} to the source file name.
5253 @item dom
5254 @opindex fdump-tree-dom
5255 Dump each function after applying dominator tree optimizations.  The file
5256 name is made by appending @file{.dom} to the source file name.
5258 @item dse
5259 @opindex fdump-tree-dse
5260 Dump each function after applying dead store elimination.  The file
5261 name is made by appending @file{.dse} to the source file name.
5263 @item phiopt
5264 @opindex fdump-tree-phiopt
5265 Dump each function after optimizing PHI nodes into straightline code.  The file
5266 name is made by appending @file{.phiopt} to the source file name.
5268 @item forwprop
5269 @opindex fdump-tree-forwprop
5270 Dump each function after forward propagating single use variables.  The file
5271 name is made by appending @file{.forwprop} to the source file name.
5273 @item copyrename
5274 @opindex fdump-tree-copyrename
5275 Dump each function after applying the copy rename optimization.  The file
5276 name is made by appending @file{.copyrename} to the source file name.
5278 @item nrv
5279 @opindex fdump-tree-nrv
5280 Dump each function after applying the named return value optimization on
5281 generic trees.  The file name is made by appending @file{.nrv} to the source
5282 file name.
5284 @item vect
5285 @opindex fdump-tree-vect
5286 Dump each function after applying vectorization of loops.  The file name is
5287 made by appending @file{.vect} to the source file name.
5289 @item vrp
5290 @opindex fdump-tree-vrp
5291 Dump each function after Value Range Propagation (VRP).  The file name
5292 is made by appending @file{.vrp} to the source file name.
5294 @item all
5295 @opindex fdump-tree-all
5296 Enable all the available tree dumps with the flags provided in this option.
5297 @end table
5299 @item -ftree-vectorizer-verbose=@var{n}
5300 @opindex ftree-vectorizer-verbose
5301 This option controls the amount of debugging output the vectorizer prints.
5302 This information is written to standard error, unless
5303 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5304 in which case it is output to the usual dump listing file, @file{.vect}.
5305 For @var{n}=0 no diagnostic information is reported.
5306 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5307 and the total number of loops that got vectorized.
5308 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5309 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5310 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5311 level that @option{-fdump-tree-vect-stats} uses.
5312 Higher verbosity levels mean either more information dumped for each
5313 reported loop, or same amount of information reported for more loops:
5314 If @var{n}=3, alignment related information is added to the reports.
5315 If @var{n}=4, data-references related information (e.g.@: memory dependences,
5316 memory access-patterns) is added to the reports.
5317 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
5318 that did not pass the first analysis phase (i.e., may not be countable, or
5319 may have complicated control-flow).
5320 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
5321 For @var{n}=7, all the information the vectorizer generates during its
5322 analysis and transformation is reported.  This is the same verbosity level
5323 that @option{-fdump-tree-vect-details} uses.
5325 @item -frandom-seed=@var{string}
5326 @opindex frandom-seed
5327 This option provides a seed that GCC uses when it would otherwise use
5328 random numbers.  It is used to generate certain symbol names
5329 that have to be different in every compiled file.  It is also used to
5330 place unique stamps in coverage data files and the object files that
5331 produce them.  You can use the @option{-frandom-seed} option to produce
5332 reproducibly identical object files.
5334 The @var{string} should be different for every file you compile.
5336 @item -fsched-verbose=@var{n}
5337 @opindex fsched-verbose
5338 On targets that use instruction scheduling, this option controls the
5339 amount of debugging output the scheduler prints.  This information is
5340 written to standard error, unless @option{-fdump-rtl-sched1} or
5341 @option{-fdump-rtl-sched2} is specified, in which case it is output
5342 to the usual dump listing file, @file{.sched} or @file{.sched2}
5343 respectively.  However for @var{n} greater than nine, the output is
5344 always printed to standard error.
5346 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5347 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5348 For @var{n} greater than one, it also output basic block probabilities,
5349 detailed ready list information and unit/insn info.  For @var{n} greater
5350 than two, it includes RTL at abort point, control-flow and regions info.
5351 And for @var{n} over four, @option{-fsched-verbose} also includes
5352 dependence info.
5354 @item -save-temps
5355 @itemx -save-temps=cwd
5356 @opindex save-temps
5357 Store the usual ``temporary'' intermediate files permanently; place them
5358 in the current directory and name them based on the source file.  Thus,
5359 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5360 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5361 preprocessed @file{foo.i} output file even though the compiler now
5362 normally uses an integrated preprocessor.
5364 When used in combination with the @option{-x} command line option,
5365 @option{-save-temps} is sensible enough to avoid over writing an
5366 input source file with the same extension as an intermediate file.
5367 The corresponding intermediate file may be obtained by renaming the
5368 source file before using @option{-save-temps}.
5370 If you invoke GCC in parallel, compiling several different source
5371 files that share a common base name in different subdirectories or the
5372 same source file compiled for multiple output destinations, it is
5373 likely that the different parallel compilers will interfere with each
5374 other, and overwrite the temporary files.  For instance:
5376 @smallexample
5377 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5378 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5379 @end smallexample
5381 may result in @file{foo.i} and @file{foo.o} being written to
5382 simultaneously by both compilers.
5384 @item -save-temps=obj
5385 @opindex save-temps=obj
5386 Store the usual ``temporary'' intermediate files permanently.  If the
5387 @option{-o} option is used, the temporary files are based on the
5388 object file.  If the @option{-o} option is not used, the
5389 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5391 For example:
5393 @smallexample
5394 gcc -save-temps=obj -c foo.c
5395 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5396 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5397 @end smallexample
5399 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5400 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5401 @file{dir2/yfoobar.o}.
5403 @item -time@r{[}=@var{file}@r{]}
5404 @opindex time
5405 Report the CPU time taken by each subprocess in the compilation
5406 sequence.  For C source files, this is the compiler proper and assembler
5407 (plus the linker if linking is done).
5409 Without the specification of an output file, the output looks like this:
5411 @smallexample
5412 # cc1 0.12 0.01
5413 # as 0.00 0.01
5414 @end smallexample
5416 The first number on each line is the ``user time'', that is time spent
5417 executing the program itself.  The second number is ``system time'',
5418 time spent executing operating system routines on behalf of the program.
5419 Both numbers are in seconds.
5421 With the specification of an output file, the output is appended to the
5422 named file, and it looks like this:
5424 @smallexample
5425 0.12 0.01 cc1 @var{options}
5426 0.00 0.01 as @var{options}
5427 @end smallexample
5429 The ``user time'' and the ``system time'' are moved before the program
5430 name, and the options passed to the program are displayed, so that one
5431 can later tell what file was being compiled, and with which options.
5433 @item -fvar-tracking
5434 @opindex fvar-tracking
5435 Run variable tracking pass.  It computes where variables are stored at each
5436 position in code.  Better debugging information is then generated
5437 (if the debugging information format supports this information).
5439 It is enabled by default when compiling with optimization (@option{-Os},
5440 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5441 the debug info format supports it.
5443 @item -print-file-name=@var{library}
5444 @opindex print-file-name
5445 Print the full absolute name of the library file @var{library} that
5446 would be used when linking---and don't do anything else.  With this
5447 option, GCC does not compile or link anything; it just prints the
5448 file name.
5450 @item -print-multi-directory
5451 @opindex print-multi-directory
5452 Print the directory name corresponding to the multilib selected by any
5453 other switches present in the command line.  This directory is supposed
5454 to exist in @env{GCC_EXEC_PREFIX}.
5456 @item -print-multi-lib
5457 @opindex print-multi-lib
5458 Print the mapping from multilib directory names to compiler switches
5459 that enable them.  The directory name is separated from the switches by
5460 @samp{;}, and each switch starts with an @samp{@@} instead of the
5461 @samp{-}, without spaces between multiple switches.  This is supposed to
5462 ease shell-processing.
5464 @item -print-prog-name=@var{program}
5465 @opindex print-prog-name
5466 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5468 @item -print-libgcc-file-name
5469 @opindex print-libgcc-file-name
5470 Same as @option{-print-file-name=libgcc.a}.
5472 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5473 but you do want to link with @file{libgcc.a}.  You can do
5475 @smallexample
5476 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5477 @end smallexample
5479 @item -print-search-dirs
5480 @opindex print-search-dirs
5481 Print the name of the configured installation directory and a list of
5482 program and library directories @command{gcc} will search---and don't do anything else.
5484 This is useful when @command{gcc} prints the error message
5485 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5486 To resolve this you either need to put @file{cpp0} and the other compiler
5487 components where @command{gcc} expects to find them, or you can set the environment
5488 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5489 Don't forget the trailing @samp{/}.
5490 @xref{Environment Variables}.
5492 @item -print-sysroot
5493 @opindex print-sysroot
5494 Print the target sysroot directory that will be used during
5495 compilation.  This is the target sysroot specified either at configure
5496 time or using the @option{--sysroot} option, possibly with an extra
5497 suffix that depends on compilation options.  If no target sysroot is
5498 specified, the option prints nothing.
5500 @item -print-sysroot-headers-suffix
5501 @opindex print-sysroot-headers-suffix
5502 Print the suffix added to the target sysroot when searching for
5503 headers, or give an error if the compiler is not configured with such
5504 a suffix---and don't do anything else.
5506 @item -dumpmachine
5507 @opindex dumpmachine
5508 Print the compiler's target machine (for example,
5509 @samp{i686-pc-linux-gnu})---and don't do anything else.
5511 @item -dumpversion
5512 @opindex dumpversion
5513 Print the compiler version (for example, @samp{3.0})---and don't do
5514 anything else.
5516 @item -dumpspecs
5517 @opindex dumpspecs
5518 Print the compiler's built-in specs---and don't do anything else.  (This
5519 is used when GCC itself is being built.)  @xref{Spec Files}.
5521 @item -feliminate-unused-debug-types
5522 @opindex feliminate-unused-debug-types
5523 Normally, when producing DWARF2 output, GCC will emit debugging
5524 information for all types declared in a compilation
5525 unit, regardless of whether or not they are actually used
5526 in that compilation unit.  Sometimes this is useful, such as
5527 if, in the debugger, you want to cast a value to a type that is
5528 not actually used in your program (but is declared).  More often,
5529 however, this results in a significant amount of wasted space.
5530 With this option, GCC will avoid producing debug symbol output
5531 for types that are nowhere used in the source file being compiled.
5532 @end table
5534 @node Optimize Options
5535 @section Options That Control Optimization
5536 @cindex optimize options
5537 @cindex options, optimization
5539 These options control various sorts of optimizations.
5541 Without any optimization option, the compiler's goal is to reduce the
5542 cost of compilation and to make debugging produce the expected
5543 results.  Statements are independent: if you stop the program with a
5544 breakpoint between statements, you can then assign a new value to any
5545 variable or change the program counter to any other statement in the
5546 function and get exactly the results you would expect from the source
5547 code.
5549 Turning on optimization flags makes the compiler attempt to improve
5550 the performance and/or code size at the expense of compilation time
5551 and possibly the ability to debug the program.
5553 The compiler performs optimization based on the knowledge it has of the
5554 program.  Compiling multiple files at once to a single output file mode allows
5555 the compiler to use information gained from all of the files when compiling
5556 each of them.
5558 Not all optimizations are controlled directly by a flag.  Only
5559 optimizations that have a flag are listed in this section.
5561 Depending on the target and how GCC was configured, a slightly different
5562 set of optimizations may be enabled at each @option{-O} level than
5563 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5564 to find out the exact set of optimizations that are enabled at each level.
5565 @xref{Overall Options}, for examples.
5567 @table @gcctabopt
5568 @item -O
5569 @itemx -O1
5570 @opindex O
5571 @opindex O1
5572 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5573 more memory for a large function.
5575 With @option{-O}, the compiler tries to reduce code size and execution
5576 time, without performing any optimizations that take a great deal of
5577 compilation time.
5579 @option{-O} turns on the following optimization flags:
5580 @gccoptlist{
5581 -fauto-inc-dec @gol
5582 -fcprop-registers @gol
5583 -fdce @gol
5584 -fdefer-pop @gol
5585 -fdelayed-branch @gol
5586 -fdse @gol
5587 -fguess-branch-probability @gol
5588 -fif-conversion2 @gol
5589 -fif-conversion @gol
5590 -finline-small-functions @gol
5591 -fipa-pure-const @gol
5592 -fipa-reference @gol
5593 -fmerge-constants
5594 -fsplit-wide-types @gol
5595 -ftree-builtin-call-dce @gol
5596 -ftree-ccp @gol
5597 -ftree-ch @gol
5598 -ftree-copyrename @gol
5599 -ftree-dce @gol
5600 -ftree-dominator-opts @gol
5601 -ftree-dse @gol
5602 -ftree-forwprop @gol
5603 -ftree-fre @gol
5604 -ftree-phiprop @gol
5605 -ftree-sra @gol
5606 -ftree-pta @gol
5607 -ftree-ter @gol
5608 -funit-at-a-time}
5610 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5611 where doing so does not interfere with debugging.
5613 @item -O2
5614 @opindex O2
5615 Optimize even more.  GCC performs nearly all supported optimizations
5616 that do not involve a space-speed tradeoff.
5617 As compared to @option{-O}, this option increases both compilation time
5618 and the performance of the generated code.
5620 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5621 also turns on the following optimization flags:
5622 @gccoptlist{-fthread-jumps @gol
5623 -falign-functions  -falign-jumps @gol
5624 -falign-loops  -falign-labels @gol
5625 -fcaller-saves @gol
5626 -fcrossjumping @gol
5627 -fcse-follow-jumps  -fcse-skip-blocks @gol
5628 -fdelete-null-pointer-checks @gol
5629 -fexpensive-optimizations @gol
5630 -fgcse  -fgcse-lm  @gol
5631 -findirect-inlining @gol
5632 -foptimize-sibling-calls @gol
5633 -fpeephole2 @gol
5634 -fregmove @gol
5635 -freorder-blocks  -freorder-functions @gol
5636 -frerun-cse-after-loop  @gol
5637 -fsched-interblock  -fsched-spec @gol
5638 -fschedule-insns  -fschedule-insns2 @gol
5639 -fstrict-aliasing -fstrict-overflow @gol
5640 -ftree-switch-conversion @gol
5641 -ftree-pre @gol
5642 -ftree-vrp}
5644 Please note the warning under @option{-fgcse} about
5645 invoking @option{-O2} on programs that use computed gotos.
5647 @item -O3
5648 @opindex O3
5649 Optimize yet more.  @option{-O3} turns on all optimizations specified
5650 by @option{-O2} and also turns on the @option{-finline-functions},
5651 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5652 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5654 @item -O0
5655 @opindex O0
5656 Reduce compilation time and make debugging produce the expected
5657 results.  This is the default.
5659 @item -Os
5660 @opindex Os
5661 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5662 do not typically increase code size.  It also performs further
5663 optimizations designed to reduce code size.
5665 @option{-Os} disables the following optimization flags:
5666 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5667 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5668 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5670 If you use multiple @option{-O} options, with or without level numbers,
5671 the last such option is the one that is effective.
5672 @end table
5674 Options of the form @option{-f@var{flag}} specify machine-independent
5675 flags.  Most flags have both positive and negative forms; the negative
5676 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5677 below, only one of the forms is listed---the one you typically will
5678 use.  You can figure out the other form by either removing @samp{no-}
5679 or adding it.
5681 The following options control specific optimizations.  They are either
5682 activated by @option{-O} options or are related to ones that are.  You
5683 can use the following flags in the rare cases when ``fine-tuning'' of
5684 optimizations to be performed is desired.
5686 @table @gcctabopt
5687 @item -fno-default-inline
5688 @opindex fno-default-inline
5689 Do not make member functions inline by default merely because they are
5690 defined inside the class scope (C++ only).  Otherwise, when you specify
5691 @w{@option{-O}}, member functions defined inside class scope are compiled
5692 inline by default; i.e., you don't need to add @samp{inline} in front of
5693 the member function name.
5695 @item -fno-defer-pop
5696 @opindex fno-defer-pop
5697 Always pop the arguments to each function call as soon as that function
5698 returns.  For machines which must pop arguments after a function call,
5699 the compiler normally lets arguments accumulate on the stack for several
5700 function calls and pops them all at once.
5702 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5704 @item -fforward-propagate
5705 @opindex fforward-propagate
5706 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5707 instructions and checks if the result can be simplified.  If loop unrolling
5708 is active, two passes are performed and the second is scheduled after
5709 loop unrolling.
5711 This option is enabled by default at optimization levels @option{-O},
5712 @option{-O2}, @option{-O3}, @option{-Os}.
5714 @item -fomit-frame-pointer
5715 @opindex fomit-frame-pointer
5716 Don't keep the frame pointer in a register for functions that
5717 don't need one.  This avoids the instructions to save, set up and
5718 restore frame pointers; it also makes an extra register available
5719 in many functions.  @strong{It also makes debugging impossible on
5720 some machines.}
5722 On some machines, such as the VAX, this flag has no effect, because
5723 the standard calling sequence automatically handles the frame pointer
5724 and nothing is saved by pretending it doesn't exist.  The
5725 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5726 whether a target machine supports this flag.  @xref{Registers,,Register
5727 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5729 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5731 @item -foptimize-sibling-calls
5732 @opindex foptimize-sibling-calls
5733 Optimize sibling and tail recursive calls.
5735 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5737 @item -fno-inline
5738 @opindex fno-inline
5739 Don't pay attention to the @code{inline} keyword.  Normally this option
5740 is used to keep the compiler from expanding any functions inline.
5741 Note that if you are not optimizing, no functions can be expanded inline.
5743 @item -finline-small-functions
5744 @opindex finline-small-functions
5745 Integrate functions into their callers when their body is smaller than expected
5746 function call code (so overall size of program gets smaller).  The compiler
5747 heuristically decides which functions are simple enough to be worth integrating
5748 in this way.
5750 Enabled at level @option{-O2}.
5752 @item -findirect-inlining
5753 @opindex findirect-inlining
5754 Inline also indirect calls that are discovered to be known at compile
5755 time thanks to previous inlining.  This option has any effect only
5756 when inlining itself is turned on by the @option{-finline-functions}
5757 or @option{-finline-small-functions} options.
5759 Enabled at level @option{-O2}.
5761 @item -finline-functions
5762 @opindex finline-functions
5763 Integrate all simple functions into their callers.  The compiler
5764 heuristically decides which functions are simple enough to be worth
5765 integrating in this way.
5767 If all calls to a given function are integrated, and the function is
5768 declared @code{static}, then the function is normally not output as
5769 assembler code in its own right.
5771 Enabled at level @option{-O3}.
5773 @item -finline-functions-called-once
5774 @opindex finline-functions-called-once
5775 Consider all @code{static} functions called once for inlining into their
5776 caller even if they are not marked @code{inline}.  If a call to a given
5777 function is integrated, then the function is not output as assembler code
5778 in its own right.
5780 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5782 @item -fearly-inlining
5783 @opindex fearly-inlining
5784 Inline functions marked by @code{always_inline} and functions whose body seems
5785 smaller than the function call overhead early before doing
5786 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5787 makes profiling significantly cheaper and usually inlining faster on programs
5788 having large chains of nested wrapper functions.
5790 Enabled by default.
5792 @item -finline-limit=@var{n}
5793 @opindex finline-limit
5794 By default, GCC limits the size of functions that can be inlined.  This flag
5795 allows coarse control of this limit.  @var{n} is the size of functions that
5796 can be inlined in number of pseudo instructions.
5798 Inlining is actually controlled by a number of parameters, which may be
5799 specified individually by using @option{--param @var{name}=@var{value}}.
5800 The @option{-finline-limit=@var{n}} option sets some of these parameters
5801 as follows:
5803 @table @gcctabopt
5804 @item max-inline-insns-single
5805 is set to @var{n}/2.
5806 @item max-inline-insns-auto
5807 is set to @var{n}/2.
5808 @end table
5810 See below for a documentation of the individual
5811 parameters controlling inlining and for the defaults of these parameters.
5813 @emph{Note:} there may be no value to @option{-finline-limit} that results
5814 in default behavior.
5816 @emph{Note:} pseudo instruction represents, in this particular context, an
5817 abstract measurement of function's size.  In no way does it represent a count
5818 of assembly instructions and as such its exact meaning might change from one
5819 release to an another.
5821 @item -fkeep-inline-functions
5822 @opindex fkeep-inline-functions
5823 In C, emit @code{static} functions that are declared @code{inline}
5824 into the object file, even if the function has been inlined into all
5825 of its callers.  This switch does not affect functions using the
5826 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5827 inline functions into the object file.
5829 @item -fkeep-static-consts
5830 @opindex fkeep-static-consts
5831 Emit variables declared @code{static const} when optimization isn't turned
5832 on, even if the variables aren't referenced.
5834 GCC enables this option by default.  If you want to force the compiler to
5835 check if the variable was referenced, regardless of whether or not
5836 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5838 @item -fmerge-constants
5839 @opindex fmerge-constants
5840 Attempt to merge identical constants (string constants and floating point
5841 constants) across compilation units.
5843 This option is the default for optimized compilation if the assembler and
5844 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5845 behavior.
5847 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5849 @item -fmerge-all-constants
5850 @opindex fmerge-all-constants
5851 Attempt to merge identical constants and identical variables.
5853 This option implies @option{-fmerge-constants}.  In addition to
5854 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5855 arrays or initialized constant variables with integral or floating point
5856 types.  Languages like C or C++ require each variable, including multiple
5857 instances of the same variable in recursive calls, to have distinct locations,
5858 so using this option will result in non-conforming
5859 behavior.
5861 @item -fmodulo-sched
5862 @opindex fmodulo-sched
5863 Perform swing modulo scheduling immediately before the first scheduling
5864 pass.  This pass looks at innermost loops and reorders their
5865 instructions by overlapping different iterations.
5867 @item -fmodulo-sched-allow-regmoves
5868 @opindex fmodulo-sched-allow-regmoves
5869 Perform more aggressive SMS based modulo scheduling with register moves
5870 allowed.  By setting this flag certain anti-dependences edges will be
5871 deleted which will trigger the generation of reg-moves based on the
5872 life-range analysis.  This option is effective only with
5873 @option{-fmodulo-sched} enabled.
5875 @item -fno-branch-count-reg
5876 @opindex fno-branch-count-reg
5877 Do not use ``decrement and branch'' instructions on a count register,
5878 but instead generate a sequence of instructions that decrement a
5879 register, compare it against zero, then branch based upon the result.
5880 This option is only meaningful on architectures that support such
5881 instructions, which include x86, PowerPC, IA-64 and S/390.
5883 The default is @option{-fbranch-count-reg}.
5885 @item -fno-function-cse
5886 @opindex fno-function-cse
5887 Do not put function addresses in registers; make each instruction that
5888 calls a constant function contain the function's address explicitly.
5890 This option results in less efficient code, but some strange hacks
5891 that alter the assembler output may be confused by the optimizations
5892 performed when this option is not used.
5894 The default is @option{-ffunction-cse}
5896 @item -fno-zero-initialized-in-bss
5897 @opindex fno-zero-initialized-in-bss
5898 If the target supports a BSS section, GCC by default puts variables that
5899 are initialized to zero into BSS@.  This can save space in the resulting
5900 code.
5902 This option turns off this behavior because some programs explicitly
5903 rely on variables going to the data section.  E.g., so that the
5904 resulting executable can find the beginning of that section and/or make
5905 assumptions based on that.
5907 The default is @option{-fzero-initialized-in-bss}.
5909 @item -fmudflap -fmudflapth -fmudflapir
5910 @opindex fmudflap
5911 @opindex fmudflapth
5912 @opindex fmudflapir
5913 @cindex bounds checking
5914 @cindex mudflap
5915 For front-ends that support it (C and C++), instrument all risky
5916 pointer/array dereferencing operations, some standard library
5917 string/heap functions, and some other associated constructs with
5918 range/validity tests.  Modules so instrumented should be immune to
5919 buffer overflows, invalid heap use, and some other classes of C/C++
5920 programming errors.  The instrumentation relies on a separate runtime
5921 library (@file{libmudflap}), which will be linked into a program if
5922 @option{-fmudflap} is given at link time.  Run-time behavior of the
5923 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5924 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5925 for its options.
5927 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5928 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5929 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5930 instrumentation should ignore pointer reads.  This produces less
5931 instrumentation (and therefore faster execution) and still provides
5932 some protection against outright memory corrupting writes, but allows
5933 erroneously read data to propagate within a program.
5935 @item -fthread-jumps
5936 @opindex fthread-jumps
5937 Perform optimizations where we check to see if a jump branches to a
5938 location where another comparison subsumed by the first is found.  If
5939 so, the first branch is redirected to either the destination of the
5940 second branch or a point immediately following it, depending on whether
5941 the condition is known to be true or false.
5943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5945 @item -fsplit-wide-types
5946 @opindex fsplit-wide-types
5947 When using a type that occupies multiple registers, such as @code{long
5948 long} on a 32-bit system, split the registers apart and allocate them
5949 independently.  This normally generates better code for those types,
5950 but may make debugging more difficult.
5952 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5953 @option{-Os}.
5955 @item -fcse-follow-jumps
5956 @opindex fcse-follow-jumps
5957 In common subexpression elimination (CSE), scan through jump instructions
5958 when the target of the jump is not reached by any other path.  For
5959 example, when CSE encounters an @code{if} statement with an
5960 @code{else} clause, CSE will follow the jump when the condition
5961 tested is false.
5963 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5965 @item -fcse-skip-blocks
5966 @opindex fcse-skip-blocks
5967 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5968 follow jumps which conditionally skip over blocks.  When CSE
5969 encounters a simple @code{if} statement with no else clause,
5970 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5971 body of the @code{if}.
5973 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5975 @item -frerun-cse-after-loop
5976 @opindex frerun-cse-after-loop
5977 Re-run common subexpression elimination after loop optimizations has been
5978 performed.
5980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5982 @item -fgcse
5983 @opindex fgcse
5984 Perform a global common subexpression elimination pass.
5985 This pass also performs global constant and copy propagation.
5987 @emph{Note:} When compiling a program using computed gotos, a GCC
5988 extension, you may get better runtime performance if you disable
5989 the global common subexpression elimination pass by adding
5990 @option{-fno-gcse} to the command line.
5992 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5994 @item -fgcse-lm
5995 @opindex fgcse-lm
5996 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5997 attempt to move loads which are only killed by stores into themselves.  This
5998 allows a loop containing a load/store sequence to be changed to a load outside
5999 the loop, and a copy/store within the loop.
6001 Enabled by default when gcse is enabled.
6003 @item -fgcse-sm
6004 @opindex fgcse-sm
6005 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6006 global common subexpression elimination.  This pass will attempt to move
6007 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6008 loops containing a load/store sequence can be changed to a load before
6009 the loop and a store after the loop.
6011 Not enabled at any optimization level.
6013 @item -fgcse-las
6014 @opindex fgcse-las
6015 When @option{-fgcse-las} is enabled, the global common subexpression
6016 elimination pass eliminates redundant loads that come after stores to the
6017 same memory location (both partial and full redundancies).
6019 Not enabled at any optimization level.
6021 @item -fgcse-after-reload
6022 @opindex fgcse-after-reload
6023 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6024 pass is performed after reload.  The purpose of this pass is to cleanup
6025 redundant spilling.
6027 @item -funsafe-loop-optimizations
6028 @opindex funsafe-loop-optimizations
6029 If given, the loop optimizer will assume that loop indices do not
6030 overflow, and that the loops with nontrivial exit condition are not
6031 infinite.  This enables a wider range of loop optimizations even if
6032 the loop optimizer itself cannot prove that these assumptions are valid.
6033 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6034 if it finds this kind of loop.
6036 @item -fcrossjumping
6037 @opindex fcrossjumping
6038 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6039 resulting code may or may not perform better than without cross-jumping.
6041 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6043 @item -fauto-inc-dec
6044 @opindex fauto-inc-dec
6045 Combine increments or decrements of addresses with memory accesses.
6046 This pass is always skipped on architectures that do not have
6047 instructions to support this.  Enabled by default at @option{-O} and
6048 higher on architectures that support this.
6050 @item -fdce
6051 @opindex fdce
6052 Perform dead code elimination (DCE) on RTL@.
6053 Enabled by default at @option{-O} and higher.
6055 @item -fdse
6056 @opindex fdse
6057 Perform dead store elimination (DSE) on RTL@.
6058 Enabled by default at @option{-O} and higher.
6060 @item -fif-conversion
6061 @opindex fif-conversion
6062 Attempt to transform conditional jumps into branch-less equivalents.  This
6063 include use of conditional moves, min, max, set flags and abs instructions, and
6064 some tricks doable by standard arithmetics.  The use of conditional execution
6065 on chips where it is available is controlled by @code{if-conversion2}.
6067 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6069 @item -fif-conversion2
6070 @opindex fif-conversion2
6071 Use conditional execution (where available) to transform conditional jumps into
6072 branch-less equivalents.
6074 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6076 @item -fdelete-null-pointer-checks
6077 @opindex fdelete-null-pointer-checks
6078 Assume that programs cannot safely dereference null pointers, and that
6079 no code or data element resides there.  This enables simple constant
6080 folding optimizations at all optimization levels.  In addition, other
6081 optimization passes in GCC use this flag to control global dataflow
6082 analyses that eliminate useless checks for null pointers; these assume
6083 that if a pointer is checked after it has already been dereferenced,
6084 it cannot be null.
6086 Note however that in some environments this assumption is not true.
6087 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6088 for programs which depend on that behavior.
6090 Some targets, especially embedded ones, disable this option at all levels.
6091 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6092 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6093 are enabled independently at different optimization levels.
6095 @item -fexpensive-optimizations
6096 @opindex fexpensive-optimizations
6097 Perform a number of minor optimizations that are relatively expensive.
6099 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6101 @item -foptimize-register-move
6102 @itemx -fregmove
6103 @opindex foptimize-register-move
6104 @opindex fregmove
6105 Attempt to reassign register numbers in move instructions and as
6106 operands of other simple instructions in order to maximize the amount of
6107 register tying.  This is especially helpful on machines with two-operand
6108 instructions.
6110 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6111 optimization.
6113 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6115 @item -fira-algorithm=@var{algorithm}
6116 Use specified coloring algorithm for the integrated register
6117 allocator.  The @var{algorithm} argument should be @code{priority} or
6118 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6119 the second one specifies Chaitin-Briggs coloring.  The second
6120 algorithm can be unimplemented for some architectures.  If it is
6121 implemented, it is the default because Chaitin-Briggs coloring as a
6122 rule generates a better code.
6124 @item -fira-region=@var{region}
6125 Use specified regions for the integrated register allocator.  The
6126 @var{region} argument should be one of @code{all}, @code{mixed}, or
6127 @code{one}.  The first value means using all loops as register
6128 allocation regions, the second value which is the default means using
6129 all loops except for loops with small register pressure as the
6130 regions, and third one means using all function as a single region.
6131 The first value can give best result for machines with small size and
6132 irregular register set, the third one results in faster and generates
6133 decent code and the smallest size code, and the default value usually
6134 give the best results in most cases and for most architectures.
6136 @item -fira-coalesce
6137 @opindex fira-coalesce
6138 Do optimistic register coalescing.  This option might be profitable for
6139 architectures with big regular register files.
6141 @item -fno-ira-share-save-slots
6142 @opindex fno-ira-share-save-slots
6143 Switch off sharing stack slots used for saving call used hard
6144 registers living through a call.  Each hard register will get a
6145 separate stack slot and as a result function stack frame will be
6146 bigger.
6148 @item -fno-ira-share-spill-slots
6149 @opindex fno-ira-share-spill-slots
6150 Switch off sharing stack slots allocated for pseudo-registers.  Each
6151 pseudo-register which did not get a hard register will get a separate
6152 stack slot and as a result function stack frame will be bigger.
6154 @item -fira-verbose=@var{n}
6155 @opindex fira-verbose
6156 Set up how verbose dump file for the integrated register allocator
6157 will be.  Default value is 5.  If the value is greater or equal to 10,
6158 the dump file will be stderr as if the value were @var{n} minus 10.
6160 @item -fdelayed-branch
6161 @opindex fdelayed-branch
6162 If supported for the target machine, attempt to reorder instructions
6163 to exploit instruction slots available after delayed branch
6164 instructions.
6166 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6168 @item -fschedule-insns
6169 @opindex fschedule-insns
6170 If supported for the target machine, attempt to reorder instructions to
6171 eliminate execution stalls due to required data being unavailable.  This
6172 helps machines that have slow floating point or memory load instructions
6173 by allowing other instructions to be issued until the result of the load
6174 or floating point instruction is required.
6176 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6178 @item -fschedule-insns2
6179 @opindex fschedule-insns2
6180 Similar to @option{-fschedule-insns}, but requests an additional pass of
6181 instruction scheduling after register allocation has been done.  This is
6182 especially useful on machines with a relatively small number of
6183 registers and where memory load instructions take more than one cycle.
6185 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6187 @item -fno-sched-interblock
6188 @opindex fno-sched-interblock
6189 Don't schedule instructions across basic blocks.  This is normally
6190 enabled by default when scheduling before register allocation, i.e.@:
6191 with @option{-fschedule-insns} or at @option{-O2} or higher.
6193 @item -fno-sched-spec
6194 @opindex fno-sched-spec
6195 Don't allow speculative motion of non-load instructions.  This is normally
6196 enabled by default when scheduling before register allocation, i.e.@:
6197 with @option{-fschedule-insns} or at @option{-O2} or higher.
6199 @item -fsched-spec-load
6200 @opindex fsched-spec-load
6201 Allow speculative motion of some load instructions.  This only makes
6202 sense when scheduling before register allocation, i.e.@: with
6203 @option{-fschedule-insns} or at @option{-O2} or higher.
6205 @item -fsched-spec-load-dangerous
6206 @opindex fsched-spec-load-dangerous
6207 Allow speculative motion of more load instructions.  This only makes
6208 sense when scheduling before register allocation, i.e.@: with
6209 @option{-fschedule-insns} or at @option{-O2} or higher.
6211 @item -fsched-stalled-insns
6212 @itemx -fsched-stalled-insns=@var{n}
6213 @opindex fsched-stalled-insns
6214 Define how many insns (if any) can be moved prematurely from the queue
6215 of stalled insns into the ready list, during the second scheduling pass.
6216 @option{-fno-sched-stalled-insns} means that no insns will be moved
6217 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6218 on how many queued insns can be moved prematurely.
6219 @option{-fsched-stalled-insns} without a value is equivalent to
6220 @option{-fsched-stalled-insns=1}.
6222 @item -fsched-stalled-insns-dep
6223 @itemx -fsched-stalled-insns-dep=@var{n}
6224 @opindex fsched-stalled-insns-dep
6225 Define how many insn groups (cycles) will be examined for a dependency
6226 on a stalled insn that is candidate for premature removal from the queue
6227 of stalled insns.  This has an effect only during the second scheduling pass,
6228 and only if @option{-fsched-stalled-insns} is used.
6229 @option{-fno-sched-stalled-insns-dep} is equivalent to
6230 @option{-fsched-stalled-insns-dep=0}.
6231 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6232 @option{-fsched-stalled-insns-dep=1}.
6234 @item -fsched2-use-superblocks
6235 @opindex fsched2-use-superblocks
6236 When scheduling after register allocation, do use superblock scheduling
6237 algorithm.  Superblock scheduling allows motion across basic block boundaries
6238 resulting on faster schedules.  This option is experimental, as not all machine
6239 descriptions used by GCC model the CPU closely enough to avoid unreliable
6240 results from the algorithm.
6242 This only makes sense when scheduling after register allocation, i.e.@: with
6243 @option{-fschedule-insns2} or at @option{-O2} or higher.
6245 @item -fsched-group-heuristic
6246 @opindex fsched-group-heuristic
6247 Enable the group heuristic in the scheduler.  This heuristic favors 
6248 the instruction that belongs to a schedule group.  This is enabled 
6249 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6250 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6252 @item -fsched-critical-path-heuristic
6253 @opindex fsched-critical-path-heuristic
6254 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6255 instructions on the critical path.  This is enabled by default when 
6256 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6257 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6259 @item -fsched-spec-insn-heuristic
6260 @opindex fsched-spec-insn-heuristic
6261 Enable the speculative instruction heuristic in the scheduler.  This 
6262 heuristic favors speculative instructions with greater dependency weakness.  
6263 This is enabled by default when scheduling is enabled, i.e.@: 
6264 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6265 or at @option{-O2} or higher.
6267 @item -fsched-reg-pressure-heuristic
6268 @opindex fsched-reg-pressure-heuristic
6269 Enable the register pressure heuristic in the scheduler.  This heuristic
6270 favors the instruction with smaller contribution to register pressure.  
6271 This only makes sense when scheduling before register allocation, i.e.@: 
6272 with @option{-fschedule-insns} or at @option{-O2} or higher.
6274 @item -fsched-rank-heuristic
6275 @opindex fsched-rank-heuristic
6276 Enable the rank heuristic in the scheduler.  This heuristic favors 
6277 the instruction belonging to a basic block with greater size or frequency.  
6278 This is enabled by default when scheduling is enabled, i.e.@: 
6279 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6280 at @option{-O2} or higher.
6282 @item -fsched-last-insn-heuristic
6283 @opindex fsched-last-insn-heuristic
6284 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6285 favors the instruction that is less dependent on the last instruction
6286 scheduled.  This is enabled by default when scheduling is enabled, 
6287 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6288 at @option{-O2} or higher.
6290 @item -fsched-dep-count-heuristic
6291 @opindex fsched-dep-count-heuristic
6292 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6293 favors the instruction that has more instructions depending on it.  
6294 This is enabled by default when scheduling is enabled, i.e.@: 
6295 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6296 at @option{-O2} or higher.
6298 @item -fsched2-use-traces
6299 @opindex fsched2-use-traces
6300 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
6301 allocation and additionally perform code duplication in order to increase the
6302 size of superblocks using tracer pass.  See @option{-ftracer} for details on
6303 trace formation.
6305 This mode should produce faster but significantly longer programs.  Also
6306 without @option{-fbranch-probabilities} the traces constructed may not
6307 match the reality and hurt the performance.  This only makes
6308 sense when scheduling after register allocation, i.e.@: with
6309 @option{-fschedule-insns2} or at @option{-O2} or higher.
6311 @item -freschedule-modulo-scheduled-loops
6312 @opindex freschedule-modulo-scheduled-loops
6313 The modulo scheduling comes before the traditional scheduling, if a loop
6314 was modulo scheduled we may want to prevent the later scheduling passes
6315 from changing its schedule, we use this option to control that.
6317 @item -fselective-scheduling
6318 @opindex fselective-scheduling
6319 Schedule instructions using selective scheduling algorithm.  Selective
6320 scheduling runs instead of the first scheduler pass.
6322 @item -fselective-scheduling2
6323 @opindex fselective-scheduling2
6324 Schedule instructions using selective scheduling algorithm.  Selective
6325 scheduling runs instead of the second scheduler pass.
6327 @item -fsel-sched-pipelining
6328 @opindex fsel-sched-pipelining
6329 Enable software pipelining of innermost loops during selective scheduling.
6330 This option has no effect until one of @option{-fselective-scheduling} or
6331 @option{-fselective-scheduling2} is turned on.
6333 @item -fsel-sched-pipelining-outer-loops
6334 @opindex fsel-sched-pipelining-outer-loops
6335 When pipelining loops during selective scheduling, also pipeline outer loops.
6336 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6338 @item -fcaller-saves
6339 @opindex fcaller-saves
6340 Enable values to be allocated in registers that will be clobbered by
6341 function calls, by emitting extra instructions to save and restore the
6342 registers around such calls.  Such allocation is done only when it
6343 seems to result in better code than would otherwise be produced.
6345 This option is always enabled by default on certain machines, usually
6346 those which have no call-preserved registers to use instead.
6348 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6350 @item -fconserve-stack
6351 @opindex fconserve-stack
6352 Attempt to minimize stack usage.  The compiler will attempt to use less
6353 stack space, even if that makes the program slower.  This option
6354 implies setting the @option{large-stack-frame} parameter to 100
6355 and the @option{large-stack-frame-growth} parameter to 400.
6357 @item -ftree-reassoc
6358 @opindex ftree-reassoc
6359 Perform reassociation on trees.  This flag is enabled by default
6360 at @option{-O} and higher.
6362 @item -ftree-pre
6363 @opindex ftree-pre
6364 Perform partial redundancy elimination (PRE) on trees.  This flag is
6365 enabled by default at @option{-O2} and @option{-O3}.
6367 @item -ftree-forwprop
6368 @opindex ftree-forwprop
6369 Perform forward propagation on trees.  This flag is enabled by default
6370 at @option{-O} and higher.
6372 @item -ftree-fre
6373 @opindex ftree-fre
6374 Perform full redundancy elimination (FRE) on trees.  The difference
6375 between FRE and PRE is that FRE only considers expressions
6376 that are computed on all paths leading to the redundant computation.
6377 This analysis is faster than PRE, though it exposes fewer redundancies.
6378 This flag is enabled by default at @option{-O} and higher.
6380 @item -ftree-phiprop
6381 @opindex ftree-phiprop
6382 Perform hoisting of loads from conditional pointers on trees.  This
6383 pass is enabled by default at @option{-O} and higher.
6385 @item -ftree-copy-prop
6386 @opindex ftree-copy-prop
6387 Perform copy propagation on trees.  This pass eliminates unnecessary
6388 copy operations.  This flag is enabled by default at @option{-O} and
6389 higher.
6391 @item -fipa-pure-const
6392 @opindex fipa-pure-const
6393 Discover which functions are pure or constant.
6394 Enabled by default at @option{-O} and higher.
6396 @item -fipa-reference
6397 @opindex fipa-reference
6398 Discover which static variables do not escape cannot escape the
6399 compilation unit.
6400 Enabled by default at @option{-O} and higher.
6402 @item -fipa-struct-reorg
6403 @opindex fipa-struct-reorg
6404 Perform structure reorganization optimization, that change C-like structures
6405 layout in order to better utilize spatial locality.  This transformation is
6406 affective for programs containing arrays of structures.  Available in two
6407 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6408 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6409 to provide the safety of this transformation.  It works only in whole program
6410 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6411 enabled.  Structures considered @samp{cold} by this transformation are not
6412 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6414 With this flag, the program debug info reflects a new structure layout.
6416 @item -fipa-pta
6417 @opindex fipa-pta
6418 Perform interprocedural pointer analysis.  This option is experimental
6419 and does not affect generated code.
6421 @item -fipa-cp
6422 @opindex fipa-cp
6423 Perform interprocedural constant propagation.
6424 This optimization analyzes the program to determine when values passed
6425 to functions are constants and then optimizes accordingly.
6426 This optimization can substantially increase performance
6427 if the application has constants passed to functions.
6428 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6430 @item -fipa-cp-clone
6431 @opindex fipa-cp-clone
6432 Perform function cloning to make interprocedural constant propagation stronger.
6433 When enabled, interprocedural constant propagation will perform function cloning
6434 when externally visible function can be called with constant arguments.
6435 Because this optimization can create multiple copies of functions,
6436 it may significantly increase code size
6437 (see @option{--param ipcp-unit-growth=@var{value}}).
6438 This flag is enabled by default at @option{-O3}.
6440 @item -fipa-matrix-reorg
6441 @opindex fipa-matrix-reorg
6442 Perform matrix flattening and transposing.
6443 Matrix flattening tries to replace an @math{m}-dimensional matrix
6444 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6445 This reduces the level of indirection needed for accessing the elements
6446 of the matrix. The second optimization is matrix transposing that
6447 attempts to change the order of the matrix's dimensions in order to
6448 improve cache locality.
6449 Both optimizations need the @option{-fwhole-program} flag.
6450 Transposing is enabled only if profiling information is available.
6452 @item -ftree-sink
6453 @opindex ftree-sink
6454 Perform forward store motion  on trees.  This flag is
6455 enabled by default at @option{-O} and higher.
6457 @item -ftree-ccp
6458 @opindex ftree-ccp
6459 Perform sparse conditional constant propagation (CCP) on trees.  This
6460 pass only operates on local scalar variables and is enabled by default
6461 at @option{-O} and higher.
6463 @item -ftree-switch-conversion
6464 Perform conversion of simple initializations in a switch to
6465 initializations from a scalar array.  This flag is enabled by default
6466 at @option{-O2} and higher.
6468 @item -ftree-dce
6469 @opindex ftree-dce
6470 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6471 default at @option{-O} and higher.
6473 @item -ftree-builtin-call-dce
6474 @opindex ftree-builtin-call-dce
6475 Perform conditional dead code elimination (DCE) for calls to builtin functions
6476 that may set @code{errno} but are otherwise side-effect free.  This flag is
6477 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6478 specified.
6480 @item -ftree-dominator-opts
6481 @opindex ftree-dominator-opts
6482 Perform a variety of simple scalar cleanups (constant/copy
6483 propagation, redundancy elimination, range propagation and expression
6484 simplification) based on a dominator tree traversal.  This also
6485 performs jump threading (to reduce jumps to jumps). This flag is
6486 enabled by default at @option{-O} and higher.
6488 @item -ftree-dse
6489 @opindex ftree-dse
6490 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6491 a memory location which will later be overwritten by another store without
6492 any intervening loads.  In this case the earlier store can be deleted.  This
6493 flag is enabled by default at @option{-O} and higher.
6495 @item -ftree-ch
6496 @opindex ftree-ch
6497 Perform loop header copying on trees.  This is beneficial since it increases
6498 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6499 is enabled by default at @option{-O} and higher.  It is not enabled
6500 for @option{-Os}, since it usually increases code size.
6502 @item -ftree-loop-optimize
6503 @opindex ftree-loop-optimize
6504 Perform loop optimizations on trees.  This flag is enabled by default
6505 at @option{-O} and higher.
6507 @item -ftree-loop-linear
6508 @opindex ftree-loop-linear
6509 Perform linear loop transformations on tree.  This flag can improve cache
6510 performance and allow further loop optimizations to take place.
6512 @item -floop-interchange
6513 Perform loop interchange transformations on loops.  Interchanging two
6514 nested loops switches the inner and outer loops.  For example, given a
6515 loop like:
6516 @smallexample
6517 DO J = 1, M
6518   DO I = 1, N
6519     A(J, I) = A(J, I) * C
6520   ENDDO
6521 ENDDO
6522 @end smallexample
6523 loop interchange will transform the loop as if the user had written:
6524 @smallexample
6525 DO I = 1, N
6526   DO J = 1, M
6527     A(J, I) = A(J, I) * C
6528   ENDDO
6529 ENDDO
6530 @end smallexample
6531 which can be beneficial when @code{N} is larger than the caches,
6532 because in Fortran, the elements of an array are stored in memory
6533 contiguously by column, and the original loop iterates over rows,
6534 potentially creating at each access a cache miss.  This optimization
6535 applies to all the languages supported by GCC and is not limited to
6536 Fortran.  To use this code transformation, GCC has to be configured
6537 with @option{--with-ppl} and @option{--with-cloog} to enable the
6538 Graphite loop transformation infrastructure.
6540 @item -floop-strip-mine
6541 Perform loop strip mining transformations on loops.  Strip mining
6542 splits a loop into two nested loops.  The outer loop has strides
6543 equal to the strip size and the inner loop has strides of the
6544 original loop within a strip.  For example, given a loop like:
6545 @smallexample
6546 DO I = 1, N
6547   A(I) = A(I) + C
6548 ENDDO
6549 @end smallexample
6550 loop strip mining will transform the loop as if the user had written:
6551 @smallexample
6552 DO II = 1, N, 4
6553   DO I = II, min (II + 3, N)
6554     A(I) = A(I) + C
6555   ENDDO
6556 ENDDO
6557 @end smallexample
6558 This optimization applies to all the languages supported by GCC and is
6559 not limited to Fortran.  To use this code transformation, GCC has to
6560 be configured with @option{--with-ppl} and @option{--with-cloog} to
6561 enable the Graphite loop transformation infrastructure.
6563 @item -floop-block
6564 Perform loop blocking transformations on loops.  Blocking strip mines
6565 each loop in the loop nest such that the memory accesses of the
6566 element loops fit inside caches.  For example, given a loop like:
6567 @smallexample
6568 DO I = 1, N
6569   DO J = 1, M
6570     A(J, I) = B(I) + C(J)
6571   ENDDO
6572 ENDDO
6573 @end smallexample
6574 loop blocking will transform the loop as if the user had written:
6575 @smallexample
6576 DO II = 1, N, 64
6577   DO JJ = 1, M, 64
6578     DO I = II, min (II + 63, N)
6579       DO J = JJ, min (JJ + 63, M)
6580         A(J, I) = B(I) + C(J)
6581       ENDDO
6582     ENDDO
6583   ENDDO
6584 ENDDO
6585 @end smallexample
6586 which can be beneficial when @code{M} is larger than the caches,
6587 because the innermost loop will iterate over a smaller amount of data
6588 that can be kept in the caches.  This optimization applies to all the
6589 languages supported by GCC and is not limited to Fortran.  To use this
6590 code transformation, GCC has to be configured with @option{--with-ppl}
6591 and @option{--with-cloog} to enable the Graphite loop transformation
6592 infrastructure.
6594 @item -fcheck-data-deps
6595 @opindex fcheck-data-deps
6596 Compare the results of several data dependence analyzers.  This option
6597 is used for debugging the data dependence analyzers.
6599 @item -ftree-loop-distribution
6600 Perform loop distribution.  This flag can improve cache performance on
6601 big loop bodies and allow further loop optimizations, like
6602 parallelization or vectorization, to take place.  For example, the loop
6603 @smallexample
6604 DO I = 1, N
6605   A(I) = B(I) + C
6606   D(I) = E(I) * F
6607 ENDDO
6608 @end smallexample
6609 is transformed to
6610 @smallexample
6611 DO I = 1, N
6612    A(I) = B(I) + C
6613 ENDDO
6614 DO I = 1, N
6615    D(I) = E(I) * F
6616 ENDDO
6617 @end smallexample
6619 @item -ftree-loop-im
6620 @opindex ftree-loop-im
6621 Perform loop invariant motion on trees.  This pass moves only invariants that
6622 would be hard to handle at RTL level (function calls, operations that expand to
6623 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6624 operands of conditions that are invariant out of the loop, so that we can use
6625 just trivial invariantness analysis in loop unswitching.  The pass also includes
6626 store motion.
6628 @item -ftree-loop-ivcanon
6629 @opindex ftree-loop-ivcanon
6630 Create a canonical counter for number of iterations in the loop for that
6631 determining number of iterations requires complicated analysis.  Later
6632 optimizations then may determine the number easily.  Useful especially
6633 in connection with unrolling.
6635 @item -fivopts
6636 @opindex fivopts
6637 Perform induction variable optimizations (strength reduction, induction
6638 variable merging and induction variable elimination) on trees.
6640 @item -ftree-parallelize-loops=n
6641 @opindex ftree-parallelize-loops
6642 Parallelize loops, i.e., split their iteration space to run in n threads.
6643 This is only possible for loops whose iterations are independent
6644 and can be arbitrarily reordered.  The optimization is only
6645 profitable on multiprocessor machines, for loops that are CPU-intensive,
6646 rather than constrained e.g.@: by memory bandwidth.  This option
6647 implies @option{-pthread}, and thus is only supported on targets
6648 that have support for @option{-pthread}.
6650 @item -ftree-pta
6651 @opindex ftree-pta
6652 Perform function-local points-to analysis on trees.  This flag is
6653 enabled by default at @option{-O} and higher.
6655 @item -ftree-sra
6656 @opindex ftree-sra
6657 Perform scalar replacement of aggregates.  This pass replaces structure
6658 references with scalars to prevent committing structures to memory too
6659 early.  This flag is enabled by default at @option{-O} and higher.
6661 @item -ftree-copyrename
6662 @opindex ftree-copyrename
6663 Perform copy renaming on trees.  This pass attempts to rename compiler
6664 temporaries to other variables at copy locations, usually resulting in
6665 variable names which more closely resemble the original variables.  This flag
6666 is enabled by default at @option{-O} and higher.
6668 @item -ftree-ter
6669 @opindex ftree-ter
6670 Perform temporary expression replacement during the SSA->normal phase.  Single
6671 use/single def temporaries are replaced at their use location with their
6672 defining expression.  This results in non-GIMPLE code, but gives the expanders
6673 much more complex trees to work on resulting in better RTL generation.  This is
6674 enabled by default at @option{-O} and higher.
6676 @item -ftree-vectorize
6677 @opindex ftree-vectorize
6678 Perform loop vectorization on trees. This flag is enabled by default at
6679 @option{-O3}.
6681 @item -ftree-vect-loop-version
6682 @opindex ftree-vect-loop-version
6683 Perform loop versioning when doing loop vectorization on trees.  When a loop
6684 appears to be vectorizable except that data alignment or data dependence cannot
6685 be determined at compile time then vectorized and non-vectorized versions of
6686 the loop are generated along with runtime checks for alignment or dependence
6687 to control which version is executed.  This option is enabled by default
6688 except at level @option{-Os} where it is disabled.
6690 @item -fvect-cost-model
6691 @opindex fvect-cost-model
6692 Enable cost model for vectorization.
6694 @item -ftree-vrp
6695 @opindex ftree-vrp
6696 Perform Value Range Propagation on trees.  This is similar to the
6697 constant propagation pass, but instead of values, ranges of values are
6698 propagated.  This allows the optimizers to remove unnecessary range
6699 checks like array bound checks and null pointer checks.  This is
6700 enabled by default at @option{-O2} and higher.  Null pointer check
6701 elimination is only done if @option{-fdelete-null-pointer-checks} is
6702 enabled.
6704 @item -ftracer
6705 @opindex ftracer
6706 Perform tail duplication to enlarge superblock size.  This transformation
6707 simplifies the control flow of the function allowing other optimizations to do
6708 better job.
6710 @item -funroll-loops
6711 @opindex funroll-loops
6712 Unroll loops whose number of iterations can be determined at compile
6713 time or upon entry to the loop.  @option{-funroll-loops} implies
6714 @option{-frerun-cse-after-loop}.  This option makes code larger,
6715 and may or may not make it run faster.
6717 @item -funroll-all-loops
6718 @opindex funroll-all-loops
6719 Unroll all loops, even if their number of iterations is uncertain when
6720 the loop is entered.  This usually makes programs run more slowly.
6721 @option{-funroll-all-loops} implies the same options as
6722 @option{-funroll-loops},
6724 @item -fsplit-ivs-in-unroller
6725 @opindex fsplit-ivs-in-unroller
6726 Enables expressing of values of induction variables in later iterations
6727 of the unrolled loop using the value in the first iteration.  This breaks
6728 long dependency chains, thus improving efficiency of the scheduling passes.
6730 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6731 same effect.  However in cases the loop body is more complicated than
6732 a single basic block, this is not reliable.  It also does not work at all
6733 on some of the architectures due to restrictions in the CSE pass.
6735 This optimization is enabled by default.
6737 @item -fvariable-expansion-in-unroller
6738 @opindex fvariable-expansion-in-unroller
6739 With this option, the compiler will create multiple copies of some
6740 local variables when unrolling a loop which can result in superior code.
6742 @item -fpredictive-commoning
6743 @opindex fpredictive-commoning
6744 Perform predictive commoning optimization, i.e., reusing computations
6745 (especially memory loads and stores) performed in previous
6746 iterations of loops.
6748 This option is enabled at level @option{-O3}.
6750 @item -fprefetch-loop-arrays
6751 @opindex fprefetch-loop-arrays
6752 If supported by the target machine, generate instructions to prefetch
6753 memory to improve the performance of loops that access large arrays.
6755 This option may generate better or worse code; results are highly
6756 dependent on the structure of loops within the source code.
6758 Disabled at level @option{-Os}.
6760 @item -fno-peephole
6761 @itemx -fno-peephole2
6762 @opindex fno-peephole
6763 @opindex fno-peephole2
6764 Disable any machine-specific peephole optimizations.  The difference
6765 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6766 are implemented in the compiler; some targets use one, some use the
6767 other, a few use both.
6769 @option{-fpeephole} is enabled by default.
6770 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6772 @item -fno-guess-branch-probability
6773 @opindex fno-guess-branch-probability
6774 Do not guess branch probabilities using heuristics.
6776 GCC will use heuristics to guess branch probabilities if they are
6777 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6778 heuristics are based on the control flow graph.  If some branch probabilities
6779 are specified by @samp{__builtin_expect}, then the heuristics will be
6780 used to guess branch probabilities for the rest of the control flow graph,
6781 taking the @samp{__builtin_expect} info into account.  The interactions
6782 between the heuristics and @samp{__builtin_expect} can be complex, and in
6783 some cases, it may be useful to disable the heuristics so that the effects
6784 of @samp{__builtin_expect} are easier to understand.
6786 The default is @option{-fguess-branch-probability} at levels
6787 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6789 @item -freorder-blocks
6790 @opindex freorder-blocks
6791 Reorder basic blocks in the compiled function in order to reduce number of
6792 taken branches and improve code locality.
6794 Enabled at levels @option{-O2}, @option{-O3}.
6796 @item -freorder-blocks-and-partition
6797 @opindex freorder-blocks-and-partition
6798 In addition to reordering basic blocks in the compiled function, in order
6799 to reduce number of taken branches, partitions hot and cold basic blocks
6800 into separate sections of the assembly and .o files, to improve
6801 paging and cache locality performance.
6803 This optimization is automatically turned off in the presence of
6804 exception handling, for linkonce sections, for functions with a user-defined
6805 section attribute and on any architecture that does not support named
6806 sections.
6808 @item -freorder-functions
6809 @opindex freorder-functions
6810 Reorder functions in the object file in order to
6811 improve code locality.  This is implemented by using special
6812 subsections @code{.text.hot} for most frequently executed functions and
6813 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6814 the linker so object file format must support named sections and linker must
6815 place them in a reasonable way.
6817 Also profile feedback must be available in to make this option effective.  See
6818 @option{-fprofile-arcs} for details.
6820 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6822 @item -fstrict-aliasing
6823 @opindex fstrict-aliasing
6824 Allows the compiler to assume the strictest aliasing rules applicable to
6825 the language being compiled.  For C (and C++), this activates
6826 optimizations based on the type of expressions.  In particular, an
6827 object of one type is assumed never to reside at the same address as an
6828 object of a different type, unless the types are almost the same.  For
6829 example, an @code{unsigned int} can alias an @code{int}, but not a
6830 @code{void*} or a @code{double}.  A character type may alias any other
6831 type.
6833 @anchor{Type-punning}Pay special attention to code like this:
6834 @smallexample
6835 union a_union @{
6836   int i;
6837   double d;
6840 int f() @{
6841   a_union t;
6842   t.d = 3.0;
6843   return t.i;
6845 @end smallexample
6846 The practice of reading from a different union member than the one most
6847 recently written to (called ``type-punning'') is common.  Even with
6848 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6849 is accessed through the union type.  So, the code above will work as
6850 expected.  @xref{Structures unions enumerations and bit-fields
6851 implementation}.  However, this code might not:
6852 @smallexample
6853 int f() @{
6854   a_union t;
6855   int* ip;
6856   t.d = 3.0;
6857   ip = &t.i;
6858   return *ip;
6860 @end smallexample
6862 Similarly, access by taking the address, casting the resulting pointer
6863 and dereferencing the result has undefined behavior, even if the cast
6864 uses a union type, e.g.:
6865 @smallexample
6866 int f() @{
6867   double d = 3.0;
6868   return ((union a_union *) &d)->i;
6870 @end smallexample
6872 The @option{-fstrict-aliasing} option is enabled at levels
6873 @option{-O2}, @option{-O3}, @option{-Os}.
6875 @item -fstrict-overflow
6876 @opindex fstrict-overflow
6877 Allow the compiler to assume strict signed overflow rules, depending
6878 on the language being compiled.  For C (and C++) this means that
6879 overflow when doing arithmetic with signed numbers is undefined, which
6880 means that the compiler may assume that it will not happen.  This
6881 permits various optimizations.  For example, the compiler will assume
6882 that an expression like @code{i + 10 > i} will always be true for
6883 signed @code{i}.  This assumption is only valid if signed overflow is
6884 undefined, as the expression is false if @code{i + 10} overflows when
6885 using twos complement arithmetic.  When this option is in effect any
6886 attempt to determine whether an operation on signed numbers will
6887 overflow must be written carefully to not actually involve overflow.
6889 This option also allows the compiler to assume strict pointer
6890 semantics: given a pointer to an object, if adding an offset to that
6891 pointer does not produce a pointer to the same object, the addition is
6892 undefined.  This permits the compiler to conclude that @code{p + u >
6893 p} is always true for a pointer @code{p} and unsigned integer
6894 @code{u}.  This assumption is only valid because pointer wraparound is
6895 undefined, as the expression is false if @code{p + u} overflows using
6896 twos complement arithmetic.
6898 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6899 that integer signed overflow is fully defined: it wraps.  When
6900 @option{-fwrapv} is used, there is no difference between
6901 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6902 integers.  With @option{-fwrapv} certain types of overflow are
6903 permitted.  For example, if the compiler gets an overflow when doing
6904 arithmetic on constants, the overflowed value can still be used with
6905 @option{-fwrapv}, but not otherwise.
6907 The @option{-fstrict-overflow} option is enabled at levels
6908 @option{-O2}, @option{-O3}, @option{-Os}.
6910 @item -falign-functions
6911 @itemx -falign-functions=@var{n}
6912 @opindex falign-functions
6913 Align the start of functions to the next power-of-two greater than
6914 @var{n}, skipping up to @var{n} bytes.  For instance,
6915 @option{-falign-functions=32} aligns functions to the next 32-byte
6916 boundary, but @option{-falign-functions=24} would align to the next
6917 32-byte boundary only if this can be done by skipping 23 bytes or less.
6919 @option{-fno-align-functions} and @option{-falign-functions=1} are
6920 equivalent and mean that functions will not be aligned.
6922 Some assemblers only support this flag when @var{n} is a power of two;
6923 in that case, it is rounded up.
6925 If @var{n} is not specified or is zero, use a machine-dependent default.
6927 Enabled at levels @option{-O2}, @option{-O3}.
6929 @item -falign-labels
6930 @itemx -falign-labels=@var{n}
6931 @opindex falign-labels
6932 Align all branch targets to a power-of-two boundary, skipping up to
6933 @var{n} bytes like @option{-falign-functions}.  This option can easily
6934 make code slower, because it must insert dummy operations for when the
6935 branch target is reached in the usual flow of the code.
6937 @option{-fno-align-labels} and @option{-falign-labels=1} are
6938 equivalent and mean that labels will not be aligned.
6940 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6941 are greater than this value, then their values are used instead.
6943 If @var{n} is not specified or is zero, use a machine-dependent default
6944 which is very likely to be @samp{1}, meaning no alignment.
6946 Enabled at levels @option{-O2}, @option{-O3}.
6948 @item -falign-loops
6949 @itemx -falign-loops=@var{n}
6950 @opindex falign-loops
6951 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6952 like @option{-falign-functions}.  The hope is that the loop will be
6953 executed many times, which will make up for any execution of the dummy
6954 operations.
6956 @option{-fno-align-loops} and @option{-falign-loops=1} are
6957 equivalent and mean that loops will not be aligned.
6959 If @var{n} is not specified or is zero, use a machine-dependent default.
6961 Enabled at levels @option{-O2}, @option{-O3}.
6963 @item -falign-jumps
6964 @itemx -falign-jumps=@var{n}
6965 @opindex falign-jumps
6966 Align branch targets to a power-of-two boundary, for branch targets
6967 where the targets can only be reached by jumping, skipping up to @var{n}
6968 bytes like @option{-falign-functions}.  In this case, no dummy operations
6969 need be executed.
6971 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6972 equivalent and mean that loops will not be aligned.
6974 If @var{n} is not specified or is zero, use a machine-dependent default.
6976 Enabled at levels @option{-O2}, @option{-O3}.
6978 @item -funit-at-a-time
6979 @opindex funit-at-a-time
6980 This option is left for compatibility reasons. @option{-funit-at-a-time}
6981 has no effect, while @option{-fno-unit-at-a-time} implies
6982 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
6984 Enabled by default.
6986 @item -fno-toplevel-reorder
6987 @opindex fno-toplevel-reorder
6988 Do not reorder top-level functions, variables, and @code{asm}
6989 statements.  Output them in the same order that they appear in the
6990 input file.  When this option is used, unreferenced static variables
6991 will not be removed.  This option is intended to support existing code
6992 which relies on a particular ordering.  For new code, it is better to
6993 use attributes.
6995 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
6996 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
6997 targets.
6999 @item -fweb
7000 @opindex fweb
7001 Constructs webs as commonly used for register allocation purposes and assign
7002 each web individual pseudo register.  This allows the register allocation pass
7003 to operate on pseudos directly, but also strengthens several other optimization
7004 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7005 however, make debugging impossible, since variables will no longer stay in a
7006 ``home register''.
7008 Enabled by default with @option{-funroll-loops}.
7010 @item -fwhole-program
7011 @opindex fwhole-program
7012 Assume that the current compilation unit represents the whole program being
7013 compiled.  All public functions and variables with the exception of @code{main}
7014 and those merged by attribute @code{externally_visible} become static functions
7015 and in effect are optimized more aggressively by interprocedural optimizers.
7016 While this option is equivalent to proper use of the @code{static} keyword for
7017 programs consisting of a single file, in combination with option
7018 @option{--combine} this flag can be used to compile many smaller scale C
7019 programs since the functions and variables become local for the whole combined
7020 compilation unit, not for the single source file itself.
7022 This option implies @option{-fwhole-file} for Fortran programs.
7024 @item -fcprop-registers
7025 @opindex fcprop-registers
7026 After register allocation and post-register allocation instruction splitting,
7027 we perform a copy-propagation pass to try to reduce scheduling dependencies
7028 and occasionally eliminate the copy.
7030 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7032 @item -fprofile-correction
7033 @opindex fprofile-correction
7034 Profiles collected using an instrumented binary for multi-threaded programs may
7035 be inconsistent due to missed counter updates. When this option is specified,
7036 GCC will use heuristics to correct or smooth out such inconsistencies. By
7037 default, GCC will emit an error message when an inconsistent profile is detected.
7039 @item -fprofile-dir=@var{path}
7040 @opindex fprofile-dir
7042 Set the directory to search the profile data files in to @var{path}.
7043 This option affects only the profile data generated by
7044 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7045 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7046 and its related options.
7047 By default, GCC will use the current directory as @var{path}
7048 thus the profile data file will appear in the same directory as the object file.
7050 @item -fprofile-generate
7051 @itemx -fprofile-generate=@var{path}
7052 @opindex fprofile-generate
7054 Enable options usually used for instrumenting application to produce
7055 profile useful for later recompilation with profile feedback based
7056 optimization.  You must use @option{-fprofile-generate} both when
7057 compiling and when linking your program.
7059 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7061 If @var{path} is specified, GCC will look at the @var{path} to find
7062 the profile feedback data files. See @option{-fprofile-dir}.
7064 @item -fprofile-use
7065 @itemx -fprofile-use=@var{path}
7066 @opindex fprofile-use
7067 Enable profile feedback directed optimizations, and optimizations
7068 generally profitable only with profile feedback available.
7070 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7071 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7073 By default, GCC emits an error message if the feedback profiles do not
7074 match the source code.  This error can be turned into a warning by using
7075 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7076 code.
7078 If @var{path} is specified, GCC will look at the @var{path} to find
7079 the profile feedback data files. See @option{-fprofile-dir}.
7080 @end table
7082 The following options control compiler behavior regarding floating
7083 point arithmetic.  These options trade off between speed and
7084 correctness.  All must be specifically enabled.
7086 @table @gcctabopt
7087 @item -ffloat-store
7088 @opindex ffloat-store
7089 Do not store floating point variables in registers, and inhibit other
7090 options that might change whether a floating point value is taken from a
7091 register or memory.
7093 @cindex floating point precision
7094 This option prevents undesirable excess precision on machines such as
7095 the 68000 where the floating registers (of the 68881) keep more
7096 precision than a @code{double} is supposed to have.  Similarly for the
7097 x86 architecture.  For most programs, the excess precision does only
7098 good, but a few programs rely on the precise definition of IEEE floating
7099 point.  Use @option{-ffloat-store} for such programs, after modifying
7100 them to store all pertinent intermediate computations into variables.
7102 @item -fexcess-precision=@var{style}
7103 @opindex fexcess-precision
7104 This option allows further control over excess precision on machines
7105 where floating-point registers have more precision than the IEEE
7106 @code{float} and @code{double} types and the processor does not
7107 support operations rounding to those types.  By default,
7108 @option{-fexcess-precision=fast} is in effect; this means that
7109 operations are carried out in the precision of the registers and that
7110 it is unpredictable when rounding to the types specified in the source
7111 code takes place.  When compiling C, if
7112 @option{-fexcess-precision=standard} is specified then excess
7113 precision will follow the rules specified in ISO C99; in particular,
7114 both casts and assignments cause values to be rounded to their
7115 semantic types (whereas @option{-ffloat-store} only affects
7116 assignments).  This option is enabled by default for C if a strict
7117 conformance option such as @option{-std=c99} is used.
7119 @opindex mfpmath
7120 @option{-fexcess-precision=standard} is not implemented for languages
7121 other than C, and has no effect if
7122 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7123 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7124 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7125 semantics apply without excess precision, and in the latter, rounding
7126 is unpredictable.
7128 @item -ffast-math
7129 @opindex ffast-math
7130 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7131 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7132 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7134 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7136 This option is not turned on by any @option{-O} option since
7137 it can result in incorrect output for programs which depend on
7138 an exact implementation of IEEE or ISO rules/specifications for
7139 math functions. It may, however, yield faster code for programs
7140 that do not require the guarantees of these specifications.
7142 @item -fno-math-errno
7143 @opindex fno-math-errno
7144 Do not set ERRNO after calling math functions that are executed
7145 with a single instruction, e.g., sqrt.  A program that relies on
7146 IEEE exceptions for math error handling may want to use this flag
7147 for speed while maintaining IEEE arithmetic compatibility.
7149 This option is not turned on by any @option{-O} option since
7150 it can result in incorrect output for programs which depend on
7151 an exact implementation of IEEE or ISO rules/specifications for
7152 math functions. It may, however, yield faster code for programs
7153 that do not require the guarantees of these specifications.
7155 The default is @option{-fmath-errno}.
7157 On Darwin systems, the math library never sets @code{errno}.  There is
7158 therefore no reason for the compiler to consider the possibility that
7159 it might, and @option{-fno-math-errno} is the default.
7161 @item -funsafe-math-optimizations
7162 @opindex funsafe-math-optimizations
7164 Allow optimizations for floating-point arithmetic that (a) assume
7165 that arguments and results are valid and (b) may violate IEEE or
7166 ANSI standards.  When used at link-time, it may include libraries
7167 or startup files that change the default FPU control word or other
7168 similar optimizations.
7170 This option is not turned on by any @option{-O} option since
7171 it can result in incorrect output for programs which depend on
7172 an exact implementation of IEEE or ISO rules/specifications for
7173 math functions. It may, however, yield faster code for programs
7174 that do not require the guarantees of these specifications.
7175 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7176 @option{-fassociative-math} and @option{-freciprocal-math}.
7178 The default is @option{-fno-unsafe-math-optimizations}.
7180 @item -fassociative-math
7181 @opindex fassociative-math
7183 Allow re-association of operands in series of floating-point operations.
7184 This violates the ISO C and C++ language standard by possibly changing
7185 computation result.  NOTE: re-ordering may change the sign of zero as
7186 well as ignore NaNs and inhibit or create underflow or overflow (and
7187 thus cannot be used on a code which relies on rounding behavior like
7188 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7189 and thus may not be used when ordered comparisons are required.
7190 This option requires that both @option{-fno-signed-zeros} and
7191 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7192 much sense with @option{-frounding-math}.
7194 The default is @option{-fno-associative-math}.
7196 @item -freciprocal-math
7197 @opindex freciprocal-math
7199 Allow the reciprocal of a value to be used instead of dividing by
7200 the value if this enables optimizations.  For example @code{x / y}
7201 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7202 is subject to common subexpression elimination.  Note that this loses
7203 precision and increases the number of flops operating on the value.
7205 The default is @option{-fno-reciprocal-math}.
7207 @item -ffinite-math-only
7208 @opindex ffinite-math-only
7209 Allow optimizations for floating-point arithmetic that assume
7210 that arguments and results are not NaNs or +-Infs.
7212 This option is not turned on by any @option{-O} option since
7213 it can result in incorrect output for programs which depend on
7214 an exact implementation of IEEE or ISO rules/specifications for
7215 math functions. It may, however, yield faster code for programs
7216 that do not require the guarantees of these specifications.
7218 The default is @option{-fno-finite-math-only}.
7220 @item -fno-signed-zeros
7221 @opindex fno-signed-zeros
7222 Allow optimizations for floating point arithmetic that ignore the
7223 signedness of zero.  IEEE arithmetic specifies the behavior of
7224 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7225 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7226 This option implies that the sign of a zero result isn't significant.
7228 The default is @option{-fsigned-zeros}.
7230 @item -fno-trapping-math
7231 @opindex fno-trapping-math
7232 Compile code assuming that floating-point operations cannot generate
7233 user-visible traps.  These traps include division by zero, overflow,
7234 underflow, inexact result and invalid operation.  This option requires
7235 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7236 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7238 This option should never be turned on by any @option{-O} option since
7239 it can result in incorrect output for programs which depend on
7240 an exact implementation of IEEE or ISO rules/specifications for
7241 math functions.
7243 The default is @option{-ftrapping-math}.
7245 @item -frounding-math
7246 @opindex frounding-math
7247 Disable transformations and optimizations that assume default floating
7248 point rounding behavior.  This is round-to-zero for all floating point
7249 to integer conversions, and round-to-nearest for all other arithmetic
7250 truncations.  This option should be specified for programs that change
7251 the FP rounding mode dynamically, or that may be executed with a
7252 non-default rounding mode.  This option disables constant folding of
7253 floating point expressions at compile-time (which may be affected by
7254 rounding mode) and arithmetic transformations that are unsafe in the
7255 presence of sign-dependent rounding modes.
7257 The default is @option{-fno-rounding-math}.
7259 This option is experimental and does not currently guarantee to
7260 disable all GCC optimizations that are affected by rounding mode.
7261 Future versions of GCC may provide finer control of this setting
7262 using C99's @code{FENV_ACCESS} pragma.  This command line option
7263 will be used to specify the default state for @code{FENV_ACCESS}.
7265 @item -fsignaling-nans
7266 @opindex fsignaling-nans
7267 Compile code assuming that IEEE signaling NaNs may generate user-visible
7268 traps during floating-point operations.  Setting this option disables
7269 optimizations that may change the number of exceptions visible with
7270 signaling NaNs.  This option implies @option{-ftrapping-math}.
7272 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7273 be defined.
7275 The default is @option{-fno-signaling-nans}.
7277 This option is experimental and does not currently guarantee to
7278 disable all GCC optimizations that affect signaling NaN behavior.
7280 @item -fsingle-precision-constant
7281 @opindex fsingle-precision-constant
7282 Treat floating point constant as single precision constant instead of
7283 implicitly converting it to double precision constant.
7285 @item -fcx-limited-range
7286 @opindex fcx-limited-range
7287 When enabled, this option states that a range reduction step is not
7288 needed when performing complex division.  Also, there is no checking
7289 whether the result of a complex multiplication or division is @code{NaN
7290 + I*NaN}, with an attempt to rescue the situation in that case.  The
7291 default is @option{-fno-cx-limited-range}, but is enabled by
7292 @option{-ffast-math}.
7294 This option controls the default setting of the ISO C99
7295 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7296 all languages.
7298 @item -fcx-fortran-rules
7299 @opindex fcx-fortran-rules
7300 Complex multiplication and division follow Fortran rules.  Range
7301 reduction is done as part of complex division, but there is no checking
7302 whether the result of a complex multiplication or division is @code{NaN
7303 + I*NaN}, with an attempt to rescue the situation in that case.
7305 The default is @option{-fno-cx-fortran-rules}.
7307 @end table
7309 The following options control optimizations that may improve
7310 performance, but are not enabled by any @option{-O} options.  This
7311 section includes experimental options that may produce broken code.
7313 @table @gcctabopt
7314 @item -fbranch-probabilities
7315 @opindex fbranch-probabilities
7316 After running a program compiled with @option{-fprofile-arcs}
7317 (@pxref{Debugging Options,, Options for Debugging Your Program or
7318 @command{gcc}}), you can compile it a second time using
7319 @option{-fbranch-probabilities}, to improve optimizations based on
7320 the number of times each branch was taken.  When the program
7321 compiled with @option{-fprofile-arcs} exits it saves arc execution
7322 counts to a file called @file{@var{sourcename}.gcda} for each source
7323 file.  The information in this data file is very dependent on the
7324 structure of the generated code, so you must use the same source code
7325 and the same optimization options for both compilations.
7327 With @option{-fbranch-probabilities}, GCC puts a
7328 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7329 These can be used to improve optimization.  Currently, they are only
7330 used in one place: in @file{reorg.c}, instead of guessing which path a
7331 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7332 exactly determine which path is taken more often.
7334 @item -fprofile-values
7335 @opindex fprofile-values
7336 If combined with @option{-fprofile-arcs}, it adds code so that some
7337 data about values of expressions in the program is gathered.
7339 With @option{-fbranch-probabilities}, it reads back the data gathered
7340 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7341 notes to instructions for their later usage in optimizations.
7343 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7345 @item -fvpt
7346 @opindex fvpt
7347 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7348 a code to gather information about values of expressions.
7350 With @option{-fbranch-probabilities}, it reads back the data gathered
7351 and actually performs the optimizations based on them.
7352 Currently the optimizations include specialization of division operation
7353 using the knowledge about the value of the denominator.
7355 @item -frename-registers
7356 @opindex frename-registers
7357 Attempt to avoid false dependencies in scheduled code by making use
7358 of registers left over after register allocation.  This optimization
7359 will most benefit processors with lots of registers.  Depending on the
7360 debug information format adopted by the target, however, it can
7361 make debugging impossible, since variables will no longer stay in
7362 a ``home register''.
7364 Enabled by default with @option{-funroll-loops}.
7366 @item -ftracer
7367 @opindex ftracer
7368 Perform tail duplication to enlarge superblock size.  This transformation
7369 simplifies the control flow of the function allowing other optimizations to do
7370 better job.
7372 Enabled with @option{-fprofile-use}.
7374 @item -funroll-loops
7375 @opindex funroll-loops
7376 Unroll loops whose number of iterations can be determined at compile time or
7377 upon entry to the loop.  @option{-funroll-loops} implies
7378 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7379 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7380 small constant number of iterations).  This option makes code larger, and may
7381 or may not make it run faster.
7383 Enabled with @option{-fprofile-use}.
7385 @item -funroll-all-loops
7386 @opindex funroll-all-loops
7387 Unroll all loops, even if their number of iterations is uncertain when
7388 the loop is entered.  This usually makes programs run more slowly.
7389 @option{-funroll-all-loops} implies the same options as
7390 @option{-funroll-loops}.
7392 @item -fpeel-loops
7393 @opindex fpeel-loops
7394 Peels the loops for that there is enough information that they do not
7395 roll much (from profile feedback).  It also turns on complete loop peeling
7396 (i.e.@: complete removal of loops with small constant number of iterations).
7398 Enabled with @option{-fprofile-use}.
7400 @item -fmove-loop-invariants
7401 @opindex fmove-loop-invariants
7402 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7403 at level @option{-O1}
7405 @item -funswitch-loops
7406 @opindex funswitch-loops
7407 Move branches with loop invariant conditions out of the loop, with duplicates
7408 of the loop on both branches (modified according to result of the condition).
7410 @item -ffunction-sections
7411 @itemx -fdata-sections
7412 @opindex ffunction-sections
7413 @opindex fdata-sections
7414 Place each function or data item into its own section in the output
7415 file if the target supports arbitrary sections.  The name of the
7416 function or the name of the data item determines the section's name
7417 in the output file.
7419 Use these options on systems where the linker can perform optimizations
7420 to improve locality of reference in the instruction space.  Most systems
7421 using the ELF object format and SPARC processors running Solaris 2 have
7422 linkers with such optimizations.  AIX may have these optimizations in
7423 the future.
7425 Only use these options when there are significant benefits from doing
7426 so.  When you specify these options, the assembler and linker will
7427 create larger object and executable files and will also be slower.
7428 You will not be able to use @code{gprof} on all systems if you
7429 specify this option and you may have problems with debugging if
7430 you specify both this option and @option{-g}.
7432 @item -fbranch-target-load-optimize
7433 @opindex fbranch-target-load-optimize
7434 Perform branch target register load optimization before prologue / epilogue
7435 threading.
7436 The use of target registers can typically be exposed only during reload,
7437 thus hoisting loads out of loops and doing inter-block scheduling needs
7438 a separate optimization pass.
7440 @item -fbranch-target-load-optimize2
7441 @opindex fbranch-target-load-optimize2
7442 Perform branch target register load optimization after prologue / epilogue
7443 threading.
7445 @item -fbtr-bb-exclusive
7446 @opindex fbtr-bb-exclusive
7447 When performing branch target register load optimization, don't reuse
7448 branch target registers in within any basic block.
7450 @item -fstack-protector
7451 @opindex fstack-protector
7452 Emit extra code to check for buffer overflows, such as stack smashing
7453 attacks.  This is done by adding a guard variable to functions with
7454 vulnerable objects.  This includes functions that call alloca, and
7455 functions with buffers larger than 8 bytes.  The guards are initialized
7456 when a function is entered and then checked when the function exits.
7457 If a guard check fails, an error message is printed and the program exits.
7459 @item -fstack-protector-all
7460 @opindex fstack-protector-all
7461 Like @option{-fstack-protector} except that all functions are protected.
7463 @item -fsection-anchors
7464 @opindex fsection-anchors
7465 Try to reduce the number of symbolic address calculations by using
7466 shared ``anchor'' symbols to address nearby objects.  This transformation
7467 can help to reduce the number of GOT entries and GOT accesses on some
7468 targets.
7470 For example, the implementation of the following function @code{foo}:
7472 @smallexample
7473 static int a, b, c;
7474 int foo (void) @{ return a + b + c; @}
7475 @end smallexample
7477 would usually calculate the addresses of all three variables, but if you
7478 compile it with @option{-fsection-anchors}, it will access the variables
7479 from a common anchor point instead.  The effect is similar to the
7480 following pseudocode (which isn't valid C):
7482 @smallexample
7483 int foo (void)
7485   register int *xr = &x;
7486   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7488 @end smallexample
7490 Not all targets support this option.
7492 @item --param @var{name}=@var{value}
7493 @opindex param
7494 In some places, GCC uses various constants to control the amount of
7495 optimization that is done.  For example, GCC will not inline functions
7496 that contain more that a certain number of instructions.  You can
7497 control some of these constants on the command-line using the
7498 @option{--param} option.
7500 The names of specific parameters, and the meaning of the values, are
7501 tied to the internals of the compiler, and are subject to change
7502 without notice in future releases.
7504 In each case, the @var{value} is an integer.  The allowable choices for
7505 @var{name} are given in the following table:
7507 @table @gcctabopt
7508 @item struct-reorg-cold-struct-ratio
7509 The threshold ratio (as a percentage) between a structure frequency
7510 and the frequency of the hottest structure in the program.  This parameter
7511 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7512 We say that if the ratio of a structure frequency, calculated by profiling,
7513 to the hottest structure frequency in the program is less than this
7514 parameter, then structure reorganization is not applied to this structure.
7515 The default is 10.
7517 @item predictable-branch-cost-outcome
7518 When branch is predicted to be taken with probability lower than this threshold
7519 (in percent), then it is considered well predictable. The default is 10.
7521 @item max-crossjump-edges
7522 The maximum number of incoming edges to consider for crossjumping.
7523 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7524 the number of edges incoming to each block.  Increasing values mean
7525 more aggressive optimization, making the compile time increase with
7526 probably small improvement in executable size.
7528 @item min-crossjump-insns
7529 The minimum number of instructions which must be matched at the end
7530 of two blocks before crossjumping will be performed on them.  This
7531 value is ignored in the case where all instructions in the block being
7532 crossjumped from are matched.  The default value is 5.
7534 @item max-grow-copy-bb-insns
7535 The maximum code size expansion factor when copying basic blocks
7536 instead of jumping.  The expansion is relative to a jump instruction.
7537 The default value is 8.
7539 @item max-goto-duplication-insns
7540 The maximum number of instructions to duplicate to a block that jumps
7541 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7542 passes, GCC factors computed gotos early in the compilation process,
7543 and unfactors them as late as possible.  Only computed jumps at the
7544 end of a basic blocks with no more than max-goto-duplication-insns are
7545 unfactored.  The default value is 8.
7547 @item max-delay-slot-insn-search
7548 The maximum number of instructions to consider when looking for an
7549 instruction to fill a delay slot.  If more than this arbitrary number of
7550 instructions is searched, the time savings from filling the delay slot
7551 will be minimal so stop searching.  Increasing values mean more
7552 aggressive optimization, making the compile time increase with probably
7553 small improvement in executable run time.
7555 @item max-delay-slot-live-search
7556 When trying to fill delay slots, the maximum number of instructions to
7557 consider when searching for a block with valid live register
7558 information.  Increasing this arbitrarily chosen value means more
7559 aggressive optimization, increasing the compile time.  This parameter
7560 should be removed when the delay slot code is rewritten to maintain the
7561 control-flow graph.
7563 @item max-gcse-memory
7564 The approximate maximum amount of memory that will be allocated in
7565 order to perform the global common subexpression elimination
7566 optimization.  If more memory than specified is required, the
7567 optimization will not be done.
7569 @item max-pending-list-length
7570 The maximum number of pending dependencies scheduling will allow
7571 before flushing the current state and starting over.  Large functions
7572 with few branches or calls can create excessively large lists which
7573 needlessly consume memory and resources.
7575 @item max-inline-insns-single
7576 Several parameters control the tree inliner used in gcc.
7577 This number sets the maximum number of instructions (counted in GCC's
7578 internal representation) in a single function that the tree inliner
7579 will consider for inlining.  This only affects functions declared
7580 inline and methods implemented in a class declaration (C++).
7581 The default value is 300.
7583 @item max-inline-insns-auto
7584 When you use @option{-finline-functions} (included in @option{-O3}),
7585 a lot of functions that would otherwise not be considered for inlining
7586 by the compiler will be investigated.  To those functions, a different
7587 (more restrictive) limit compared to functions declared inline can
7588 be applied.
7589 The default value is 60.
7591 @item large-function-insns
7592 The limit specifying really large functions.  For functions larger than this
7593 limit after inlining, inlining is constrained by
7594 @option{--param large-function-growth}.  This parameter is useful primarily
7595 to avoid extreme compilation time caused by non-linear algorithms used by the
7596 backend.
7597 The default value is 2700.
7599 @item large-function-growth
7600 Specifies maximal growth of large function caused by inlining in percents.
7601 The default value is 100 which limits large function growth to 2.0 times
7602 the original size.
7604 @item large-unit-insns
7605 The limit specifying large translation unit.  Growth caused by inlining of
7606 units larger than this limit is limited by @option{--param inline-unit-growth}.
7607 For small units this might be too tight (consider unit consisting of function A
7608 that is inline and B that just calls A three time.  If B is small relative to
7609 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7610 large units consisting of small inlineable functions however the overall unit
7611 growth limit is needed to avoid exponential explosion of code size.  Thus for
7612 smaller units, the size is increased to @option{--param large-unit-insns}
7613 before applying @option{--param inline-unit-growth}.  The default is 10000
7615 @item inline-unit-growth
7616 Specifies maximal overall growth of the compilation unit caused by inlining.
7617 The default value is 30 which limits unit growth to 1.3 times the original
7618 size.
7620 @item ipcp-unit-growth
7621 Specifies maximal overall growth of the compilation unit caused by
7622 interprocedural constant propagation.  The default value is 10 which limits
7623 unit growth to 1.1 times the original size.
7625 @item large-stack-frame
7626 The limit specifying large stack frames.  While inlining the algorithm is trying
7627 to not grow past this limit too much.  Default value is 256 bytes.
7629 @item large-stack-frame-growth
7630 Specifies maximal growth of large stack frames caused by inlining in percents.
7631 The default value is 1000 which limits large stack frame growth to 11 times
7632 the original size.
7634 @item max-inline-insns-recursive
7635 @itemx max-inline-insns-recursive-auto
7636 Specifies maximum number of instructions out-of-line copy of self recursive inline
7637 function can grow into by performing recursive inlining.
7639 For functions declared inline @option{--param max-inline-insns-recursive} is
7640 taken into account.  For function not declared inline, recursive inlining
7641 happens only when @option{-finline-functions} (included in @option{-O3}) is
7642 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
7643 default value is 450.
7645 @item max-inline-recursive-depth
7646 @itemx max-inline-recursive-depth-auto
7647 Specifies maximum recursion depth used by the recursive inlining.
7649 For functions declared inline @option{--param max-inline-recursive-depth} is
7650 taken into account.  For function not declared inline, recursive inlining
7651 happens only when @option{-finline-functions} (included in @option{-O3}) is
7652 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
7653 default value is 8.
7655 @item min-inline-recursive-probability
7656 Recursive inlining is profitable only for function having deep recursion
7657 in average and can hurt for function having little recursion depth by
7658 increasing the prologue size or complexity of function body to other
7659 optimizers.
7661 When profile feedback is available (see @option{-fprofile-generate}) the actual
7662 recursion depth can be guessed from probability that function will recurse via
7663 given call expression.  This parameter limits inlining only to call expression
7664 whose probability exceeds given threshold (in percents).  The default value is
7667 @item early-inlining-insns
7668 Specify growth that early inliner can make.  In effect it increases amount of
7669 inlining for code having large abstraction penalty.  The default value is 12.
7671 @item max-early-inliner-iterations
7672 @itemx max-early-inliner-iterations
7673 Limit of iterations of early inliner.  This basically bounds number of nested
7674 indirect calls early inliner can resolve.  Deeper chains are still handled by
7675 late inlining.
7677 @item min-vect-loop-bound
7678 The minimum number of iterations under which a loop will not get vectorized
7679 when @option{-ftree-vectorize} is used.  The number of iterations after
7680 vectorization needs to be greater than the value specified by this option
7681 to allow vectorization.  The default value is 0.
7683 @item max-unrolled-insns
7684 The maximum number of instructions that a loop should have if that loop
7685 is unrolled, and if the loop is unrolled, it determines how many times
7686 the loop code is unrolled.
7688 @item max-average-unrolled-insns
7689 The maximum number of instructions biased by probabilities of their execution
7690 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7691 it determines how many times the loop code is unrolled.
7693 @item max-unroll-times
7694 The maximum number of unrollings of a single loop.
7696 @item max-peeled-insns
7697 The maximum number of instructions that a loop should have if that loop
7698 is peeled, and if the loop is peeled, it determines how many times
7699 the loop code is peeled.
7701 @item max-peel-times
7702 The maximum number of peelings of a single loop.
7704 @item max-completely-peeled-insns
7705 The maximum number of insns of a completely peeled loop.
7707 @item max-completely-peel-times
7708 The maximum number of iterations of a loop to be suitable for complete peeling.
7710 @item max-unswitch-insns
7711 The maximum number of insns of an unswitched loop.
7713 @item max-unswitch-level
7714 The maximum number of branches unswitched in a single loop.
7716 @item lim-expensive
7717 The minimum cost of an expensive expression in the loop invariant motion.
7719 @item iv-consider-all-candidates-bound
7720 Bound on number of candidates for induction variables below that
7721 all candidates are considered for each use in induction variable
7722 optimizations.  Only the most relevant candidates are considered
7723 if there are more candidates, to avoid quadratic time complexity.
7725 @item iv-max-considered-uses
7726 The induction variable optimizations give up on loops that contain more
7727 induction variable uses.
7729 @item iv-always-prune-cand-set-bound
7730 If number of candidates in the set is smaller than this value,
7731 we always try to remove unnecessary ivs from the set during its
7732 optimization when a new iv is added to the set.
7734 @item scev-max-expr-size
7735 Bound on size of expressions used in the scalar evolutions analyzer.
7736 Large expressions slow the analyzer.
7738 @item omega-max-vars
7739 The maximum number of variables in an Omega constraint system.
7740 The default value is 128.
7742 @item omega-max-geqs
7743 The maximum number of inequalities in an Omega constraint system.
7744 The default value is 256.
7746 @item omega-max-eqs
7747 The maximum number of equalities in an Omega constraint system.
7748 The default value is 128.
7750 @item omega-max-wild-cards
7751 The maximum number of wildcard variables that the Omega solver will
7752 be able to insert.  The default value is 18.
7754 @item omega-hash-table-size
7755 The size of the hash table in the Omega solver.  The default value is
7756 550.
7758 @item omega-max-keys
7759 The maximal number of keys used by the Omega solver.  The default
7760 value is 500.
7762 @item omega-eliminate-redundant-constraints
7763 When set to 1, use expensive methods to eliminate all redundant
7764 constraints.  The default value is 0.
7766 @item vect-max-version-for-alignment-checks
7767 The maximum number of runtime checks that can be performed when
7768 doing loop versioning for alignment in the vectorizer.  See option
7769 ftree-vect-loop-version for more information.
7771 @item vect-max-version-for-alias-checks
7772 The maximum number of runtime checks that can be performed when
7773 doing loop versioning for alias in the vectorizer.  See option
7774 ftree-vect-loop-version for more information.
7776 @item max-iterations-to-track
7778 The maximum number of iterations of a loop the brute force algorithm
7779 for analysis of # of iterations of the loop tries to evaluate.
7781 @item hot-bb-count-fraction
7782 Select fraction of the maximal count of repetitions of basic block in program
7783 given basic block needs to have to be considered hot.
7785 @item hot-bb-frequency-fraction
7786 Select fraction of the maximal frequency of executions of basic block in
7787 function given basic block needs to have to be considered hot
7789 @item max-predicted-iterations
7790 The maximum number of loop iterations we predict statically.  This is useful
7791 in cases where function contain single loop with known bound and other loop
7792 with unknown.  We predict the known number of iterations correctly, while
7793 the unknown number of iterations average to roughly 10.  This means that the
7794 loop without bounds would appear artificially cold relative to the other one.
7796 @item align-threshold
7798 Select fraction of the maximal frequency of executions of basic block in
7799 function given basic block will get aligned.
7801 @item align-loop-iterations
7803 A loop expected to iterate at lest the selected number of iterations will get
7804 aligned.
7806 @item tracer-dynamic-coverage
7807 @itemx tracer-dynamic-coverage-feedback
7809 This value is used to limit superblock formation once the given percentage of
7810 executed instructions is covered.  This limits unnecessary code size
7811 expansion.
7813 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7814 feedback is available.  The real profiles (as opposed to statically estimated
7815 ones) are much less balanced allowing the threshold to be larger value.
7817 @item tracer-max-code-growth
7818 Stop tail duplication once code growth has reached given percentage.  This is
7819 rather hokey argument, as most of the duplicates will be eliminated later in
7820 cross jumping, so it may be set to much higher values than is the desired code
7821 growth.
7823 @item tracer-min-branch-ratio
7825 Stop reverse growth when the reverse probability of best edge is less than this
7826 threshold (in percent).
7828 @item tracer-min-branch-ratio
7829 @itemx tracer-min-branch-ratio-feedback
7831 Stop forward growth if the best edge do have probability lower than this
7832 threshold.
7834 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7835 compilation for profile feedback and one for compilation without.  The value
7836 for compilation with profile feedback needs to be more conservative (higher) in
7837 order to make tracer effective.
7839 @item max-cse-path-length
7841 Maximum number of basic blocks on path that cse considers.  The default is 10.
7843 @item max-cse-insns
7844 The maximum instructions CSE process before flushing. The default is 1000.
7846 @item ggc-min-expand
7848 GCC uses a garbage collector to manage its own memory allocation.  This
7849 parameter specifies the minimum percentage by which the garbage
7850 collector's heap should be allowed to expand between collections.
7851 Tuning this may improve compilation speed; it has no effect on code
7852 generation.
7854 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7855 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7856 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7857 GCC is not able to calculate RAM on a particular platform, the lower
7858 bound of 30% is used.  Setting this parameter and
7859 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7860 every opportunity.  This is extremely slow, but can be useful for
7861 debugging.
7863 @item ggc-min-heapsize
7865 Minimum size of the garbage collector's heap before it begins bothering
7866 to collect garbage.  The first collection occurs after the heap expands
7867 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7868 tuning this may improve compilation speed, and has no effect on code
7869 generation.
7871 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7872 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7873 with a lower bound of 4096 (four megabytes) and an upper bound of
7874 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7875 particular platform, the lower bound is used.  Setting this parameter
7876 very large effectively disables garbage collection.  Setting this
7877 parameter and @option{ggc-min-expand} to zero causes a full collection
7878 to occur at every opportunity.
7880 @item max-reload-search-insns
7881 The maximum number of instruction reload should look backward for equivalent
7882 register.  Increasing values mean more aggressive optimization, making the
7883 compile time increase with probably slightly better performance.  The default
7884 value is 100.
7886 @item max-cselib-memory-locations
7887 The maximum number of memory locations cselib should take into account.
7888 Increasing values mean more aggressive optimization, making the compile time
7889 increase with probably slightly better performance.  The default value is 500.
7891 @item reorder-blocks-duplicate
7892 @itemx reorder-blocks-duplicate-feedback
7894 Used by basic block reordering pass to decide whether to use unconditional
7895 branch or duplicate the code on its destination.  Code is duplicated when its
7896 estimated size is smaller than this value multiplied by the estimated size of
7897 unconditional jump in the hot spots of the program.
7899 The @option{reorder-block-duplicate-feedback} is used only when profile
7900 feedback is available and may be set to higher values than
7901 @option{reorder-block-duplicate} since information about the hot spots is more
7902 accurate.
7904 @item max-sched-ready-insns
7905 The maximum number of instructions ready to be issued the scheduler should
7906 consider at any given time during the first scheduling pass.  Increasing
7907 values mean more thorough searches, making the compilation time increase
7908 with probably little benefit.  The default value is 100.
7910 @item max-sched-region-blocks
7911 The maximum number of blocks in a region to be considered for
7912 interblock scheduling.  The default value is 10.
7914 @item max-pipeline-region-blocks
7915 The maximum number of blocks in a region to be considered for
7916 pipelining in the selective scheduler.  The default value is 15.
7918 @item max-sched-region-insns
7919 The maximum number of insns in a region to be considered for
7920 interblock scheduling.  The default value is 100.
7922 @item max-pipeline-region-insns
7923 The maximum number of insns in a region to be considered for
7924 pipelining in the selective scheduler.  The default value is 200.
7926 @item min-spec-prob
7927 The minimum probability (in percents) of reaching a source block
7928 for interblock speculative scheduling.  The default value is 40.
7930 @item max-sched-extend-regions-iters
7931 The maximum number of iterations through CFG to extend regions.
7932 0 - disable region extension,
7933 N - do at most N iterations.
7934 The default value is 0.
7936 @item max-sched-insn-conflict-delay
7937 The maximum conflict delay for an insn to be considered for speculative motion.
7938 The default value is 3.
7940 @item sched-spec-prob-cutoff
7941 The minimal probability of speculation success (in percents), so that
7942 speculative insn will be scheduled.
7943 The default value is 40.
7945 @item sched-mem-true-dep-cost
7946 Minimal distance (in CPU cycles) between store and load targeting same
7947 memory locations.  The default value is 1.
7949 @item selsched-max-lookahead
7950 The maximum size of the lookahead window of selective scheduling.  It is a
7951 depth of search for available instructions.
7952 The default value is 50.
7954 @item selsched-max-sched-times
7955 The maximum number of times that an instruction will be scheduled during
7956 selective scheduling.  This is the limit on the number of iterations
7957 through which the instruction may be pipelined.  The default value is 2.
7959 @item selsched-max-insns-to-rename
7960 The maximum number of best instructions in the ready list that are considered
7961 for renaming in the selective scheduler.  The default value is 2.
7963 @item max-last-value-rtl
7964 The maximum size measured as number of RTLs that can be recorded in an expression
7965 in combiner for a pseudo register as last known value of that register.  The default
7966 is 10000.
7968 @item integer-share-limit
7969 Small integer constants can use a shared data structure, reducing the
7970 compiler's memory usage and increasing its speed.  This sets the maximum
7971 value of a shared integer constant.  The default value is 256.
7973 @item min-virtual-mappings
7974 Specifies the minimum number of virtual mappings in the incremental
7975 SSA updater that should be registered to trigger the virtual mappings
7976 heuristic defined by virtual-mappings-ratio.  The default value is
7977 100.
7979 @item virtual-mappings-ratio
7980 If the number of virtual mappings is virtual-mappings-ratio bigger
7981 than the number of virtual symbols to be updated, then the incremental
7982 SSA updater switches to a full update for those symbols.  The default
7983 ratio is 3.
7985 @item ssp-buffer-size
7986 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7987 protection when @option{-fstack-protection} is used.
7989 @item max-jump-thread-duplication-stmts
7990 Maximum number of statements allowed in a block that needs to be
7991 duplicated when threading jumps.
7993 @item max-fields-for-field-sensitive
7994 Maximum number of fields in a structure we will treat in
7995 a field sensitive manner during pointer analysis.  The default is zero
7996 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
7998 @item prefetch-latency
7999 Estimate on average number of instructions that are executed before
8000 prefetch finishes.  The distance we prefetch ahead is proportional
8001 to this constant.  Increasing this number may also lead to less
8002 streams being prefetched (see @option{simultaneous-prefetches}).
8004 @item simultaneous-prefetches
8005 Maximum number of prefetches that can run at the same time.
8007 @item l1-cache-line-size
8008 The size of cache line in L1 cache, in bytes.
8010 @item l1-cache-size
8011 The size of L1 cache, in kilobytes.
8013 @item l2-cache-size
8014 The size of L2 cache, in kilobytes.
8016 @item min-insn-to-prefetch-ratio
8017 The minimum ratio between the number of instructions and the
8018 number of prefetches to enable prefetching in a loop with an
8019 unknown trip count.
8021 @item prefetch-min-insn-to-mem-ratio
8022 The minimum ratio between the number of instructions and the
8023 number of memory references to enable prefetching in a loop.
8025 @item use-canonical-types
8026 Whether the compiler should use the ``canonical'' type system.  By
8027 default, this should always be 1, which uses a more efficient internal
8028 mechanism for comparing types in C++ and Objective-C++.  However, if
8029 bugs in the canonical type system are causing compilation failures,
8030 set this value to 0 to disable canonical types.
8032 @item switch-conversion-max-branch-ratio
8033 Switch initialization conversion will refuse to create arrays that are
8034 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8035 branches in the switch.
8037 @item max-partial-antic-length
8038 Maximum length of the partial antic set computed during the tree
8039 partial redundancy elimination optimization (@option{-ftree-pre}) when
8040 optimizing at @option{-O3} and above.  For some sorts of source code
8041 the enhanced partial redundancy elimination optimization can run away,
8042 consuming all of the memory available on the host machine.  This
8043 parameter sets a limit on the length of the sets that are computed,
8044 which prevents the runaway behavior.  Setting a value of 0 for
8045 this parameter will allow an unlimited set length.
8047 @item sccvn-max-scc-size
8048 Maximum size of a strongly connected component (SCC) during SCCVN
8049 processing.  If this limit is hit, SCCVN processing for the whole
8050 function will not be done and optimizations depending on it will
8051 be disabled.  The default maximum SCC size is 10000.
8053 @item ira-max-loops-num
8054 IRA uses a regional register allocation by default.  If a function
8055 contains loops more than number given by the parameter, only at most
8056 given number of the most frequently executed loops will form regions
8057 for the regional register allocation.  The default value of the
8058 parameter is 100.
8060 @item ira-max-conflict-table-size
8061 Although IRA uses a sophisticated algorithm of compression conflict
8062 table, the table can be still big for huge functions.  If the conflict
8063 table for a function could be more than size in MB given by the
8064 parameter, the conflict table is not built and faster, simpler, and
8065 lower quality register allocation algorithm will be used.  The
8066 algorithm do not use pseudo-register conflicts.  The default value of
8067 the parameter is 2000.
8069 @item loop-invariant-max-bbs-in-loop
8070 Loop invariant motion can be very expensive, both in compile time and
8071 in amount of needed compile time memory, with very large loops.  Loops
8072 with more basic blocks than this parameter won't have loop invariant
8073 motion optimization performed on them.  The default value of the
8074 parameter is 1000 for -O1 and 10000 for -O2 and above.
8076 @end table
8077 @end table
8079 @node Preprocessor Options
8080 @section Options Controlling the Preprocessor
8081 @cindex preprocessor options
8082 @cindex options, preprocessor
8084 These options control the C preprocessor, which is run on each C source
8085 file before actual compilation.
8087 If you use the @option{-E} option, nothing is done except preprocessing.
8088 Some of these options make sense only together with @option{-E} because
8089 they cause the preprocessor output to be unsuitable for actual
8090 compilation.
8092 @table @gcctabopt
8093 @item -Wp,@var{option}
8094 @opindex Wp
8095 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8096 and pass @var{option} directly through to the preprocessor.  If
8097 @var{option} contains commas, it is split into multiple options at the
8098 commas.  However, many options are modified, translated or interpreted
8099 by the compiler driver before being passed to the preprocessor, and
8100 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8101 interface is undocumented and subject to change, so whenever possible
8102 you should avoid using @option{-Wp} and let the driver handle the
8103 options instead.
8105 @item -Xpreprocessor @var{option}
8106 @opindex Xpreprocessor
8107 Pass @var{option} as an option to the preprocessor.  You can use this to
8108 supply system-specific preprocessor options which GCC does not know how to
8109 recognize.
8111 If you want to pass an option that takes an argument, you must use
8112 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8113 @end table
8115 @include cppopts.texi
8117 @node Assembler Options
8118 @section Passing Options to the Assembler
8120 @c prevent bad page break with this line
8121 You can pass options to the assembler.
8123 @table @gcctabopt
8124 @item -Wa,@var{option}
8125 @opindex Wa
8126 Pass @var{option} as an option to the assembler.  If @var{option}
8127 contains commas, it is split into multiple options at the commas.
8129 @item -Xassembler @var{option}
8130 @opindex Xassembler
8131 Pass @var{option} as an option to the assembler.  You can use this to
8132 supply system-specific assembler options which GCC does not know how to
8133 recognize.
8135 If you want to pass an option that takes an argument, you must use
8136 @option{-Xassembler} twice, once for the option and once for the argument.
8138 @end table
8140 @node Link Options
8141 @section Options for Linking
8142 @cindex link options
8143 @cindex options, linking
8145 These options come into play when the compiler links object files into
8146 an executable output file.  They are meaningless if the compiler is
8147 not doing a link step.
8149 @table @gcctabopt
8150 @cindex file names
8151 @item @var{object-file-name}
8152 A file name that does not end in a special recognized suffix is
8153 considered to name an object file or library.  (Object files are
8154 distinguished from libraries by the linker according to the file
8155 contents.)  If linking is done, these object files are used as input
8156 to the linker.
8158 @item -c
8159 @itemx -S
8160 @itemx -E
8161 @opindex c
8162 @opindex S
8163 @opindex E
8164 If any of these options is used, then the linker is not run, and
8165 object file names should not be used as arguments.  @xref{Overall
8166 Options}.
8168 @cindex Libraries
8169 @item -l@var{library}
8170 @itemx -l @var{library}
8171 @opindex l
8172 Search the library named @var{library} when linking.  (The second
8173 alternative with the library as a separate argument is only for
8174 POSIX compliance and is not recommended.)
8176 It makes a difference where in the command you write this option; the
8177 linker searches and processes libraries and object files in the order they
8178 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8179 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8180 to functions in @samp{z}, those functions may not be loaded.
8182 The linker searches a standard list of directories for the library,
8183 which is actually a file named @file{lib@var{library}.a}.  The linker
8184 then uses this file as if it had been specified precisely by name.
8186 The directories searched include several standard system directories
8187 plus any that you specify with @option{-L}.
8189 Normally the files found this way are library files---archive files
8190 whose members are object files.  The linker handles an archive file by
8191 scanning through it for members which define symbols that have so far
8192 been referenced but not defined.  But if the file that is found is an
8193 ordinary object file, it is linked in the usual fashion.  The only
8194 difference between using an @option{-l} option and specifying a file name
8195 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8196 and searches several directories.
8198 @item -lobjc
8199 @opindex lobjc
8200 You need this special case of the @option{-l} option in order to
8201 link an Objective-C or Objective-C++ program.
8203 @item -nostartfiles
8204 @opindex nostartfiles
8205 Do not use the standard system startup files when linking.
8206 The standard system libraries are used normally, unless @option{-nostdlib}
8207 or @option{-nodefaultlibs} is used.
8209 @item -nodefaultlibs
8210 @opindex nodefaultlibs
8211 Do not use the standard system libraries when linking.
8212 Only the libraries you specify will be passed to the linker, options
8213 specifying linkage of the system libraries, such as @code{-static-libgcc}
8214 or @code{-shared-libgcc}, will be ignored.
8215 The standard startup files are used normally, unless @option{-nostartfiles}
8216 is used.  The compiler may generate calls to @code{memcmp},
8217 @code{memset}, @code{memcpy} and @code{memmove}.
8218 These entries are usually resolved by entries in
8219 libc.  These entry points should be supplied through some other
8220 mechanism when this option is specified.
8222 @item -nostdlib
8223 @opindex nostdlib
8224 Do not use the standard system startup files or libraries when linking.
8225 No startup files and only the libraries you specify will be passed to
8226 the linker, options specifying linkage of the system libraries, such as
8227 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8228 The compiler may generate calls to @code{memcmp}, @code{memset},
8229 @code{memcpy} and @code{memmove}.
8230 These entries are usually resolved by entries in
8231 libc.  These entry points should be supplied through some other
8232 mechanism when this option is specified.
8234 @cindex @option{-lgcc}, use with @option{-nostdlib}
8235 @cindex @option{-nostdlib} and unresolved references
8236 @cindex unresolved references and @option{-nostdlib}
8237 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8238 @cindex @option{-nodefaultlibs} and unresolved references
8239 @cindex unresolved references and @option{-nodefaultlibs}
8240 One of the standard libraries bypassed by @option{-nostdlib} and
8241 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8242 that GCC uses to overcome shortcomings of particular machines, or special
8243 needs for some languages.
8244 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8245 Collection (GCC) Internals},
8246 for more discussion of @file{libgcc.a}.)
8247 In most cases, you need @file{libgcc.a} even when you want to avoid
8248 other standard libraries.  In other words, when you specify @option{-nostdlib}
8249 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8250 This ensures that you have no unresolved references to internal GCC
8251 library subroutines.  (For example, @samp{__main}, used to ensure C++
8252 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8253 GNU Compiler Collection (GCC) Internals}.)
8255 @item -pie
8256 @opindex pie
8257 Produce a position independent executable on targets which support it.
8258 For predictable results, you must also specify the same set of options
8259 that were used to generate code (@option{-fpie}, @option{-fPIE},
8260 or model suboptions) when you specify this option.
8262 @item -rdynamic
8263 @opindex rdynamic
8264 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8265 that support it. This instructs the linker to add all symbols, not
8266 only used ones, to the dynamic symbol table. This option is needed
8267 for some uses of @code{dlopen} or to allow obtaining backtraces
8268 from within a program.
8270 @item -s
8271 @opindex s
8272 Remove all symbol table and relocation information from the executable.
8274 @item -static
8275 @opindex static
8276 On systems that support dynamic linking, this prevents linking with the shared
8277 libraries.  On other systems, this option has no effect.
8279 @item -shared
8280 @opindex shared
8281 Produce a shared object which can then be linked with other objects to
8282 form an executable.  Not all systems support this option.  For predictable
8283 results, you must also specify the same set of options that were used to
8284 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8285 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8286 needs to build supplementary stub code for constructors to work.  On
8287 multi-libbed systems, @samp{gcc -shared} must select the correct support
8288 libraries to link against.  Failing to supply the correct flags may lead
8289 to subtle defects.  Supplying them in cases where they are not necessary
8290 is innocuous.}
8292 @item -shared-libgcc
8293 @itemx -static-libgcc
8294 @opindex shared-libgcc
8295 @opindex static-libgcc
8296 On systems that provide @file{libgcc} as a shared library, these options
8297 force the use of either the shared or static version respectively.
8298 If no shared version of @file{libgcc} was built when the compiler was
8299 configured, these options have no effect.
8301 There are several situations in which an application should use the
8302 shared @file{libgcc} instead of the static version.  The most common
8303 of these is when the application wishes to throw and catch exceptions
8304 across different shared libraries.  In that case, each of the libraries
8305 as well as the application itself should use the shared @file{libgcc}.
8307 Therefore, the G++ and GCJ drivers automatically add
8308 @option{-shared-libgcc} whenever you build a shared library or a main
8309 executable, because C++ and Java programs typically use exceptions, so
8310 this is the right thing to do.
8312 If, instead, you use the GCC driver to create shared libraries, you may
8313 find that they will not always be linked with the shared @file{libgcc}.
8314 If GCC finds, at its configuration time, that you have a non-GNU linker
8315 or a GNU linker that does not support option @option{--eh-frame-hdr},
8316 it will link the shared version of @file{libgcc} into shared libraries
8317 by default.  Otherwise, it will take advantage of the linker and optimize
8318 away the linking with the shared version of @file{libgcc}, linking with
8319 the static version of libgcc by default.  This allows exceptions to
8320 propagate through such shared libraries, without incurring relocation
8321 costs at library load time.
8323 However, if a library or main executable is supposed to throw or catch
8324 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8325 for the languages used in the program, or using the option
8326 @option{-shared-libgcc}, such that it is linked with the shared
8327 @file{libgcc}.
8329 @item -static-libstdc++
8330 When the @command{g++} program is used to link a C++ program, it will
8331 normally automatically link against @option{libstdc++}.  If
8332 @file{libstdc++} is available as a shared library, and the
8333 @option{-static} option is not used, then this will link against the
8334 shared version of @file{libstdc++}.  That is normally fine.  However, it
8335 is sometimes useful to freeze the version of @file{libstdc++} used by
8336 the program without going all the way to a fully static link.  The
8337 @option{-static-libstdc++} option directs the @command{g++} driver to
8338 link @file{libstdc++} statically, without necessarily linking other
8339 libraries statically.
8341 @item -symbolic
8342 @opindex symbolic
8343 Bind references to global symbols when building a shared object.  Warn
8344 about any unresolved references (unless overridden by the link editor
8345 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8346 this option.
8348 @item -T @var{script}
8349 @opindex T
8350 @cindex linker script
8351 Use @var{script} as the linker script.  This option is supported by most
8352 systems using the GNU linker.  On some targets, such as bare-board
8353 targets without an operating system, the @option{-T} option may be required
8354 when linking to avoid references to undefined symbols.
8356 @item -Xlinker @var{option}
8357 @opindex Xlinker
8358 Pass @var{option} as an option to the linker.  You can use this to
8359 supply system-specific linker options which GCC does not know how to
8360 recognize.
8362 If you want to pass an option that takes a separate argument, you must use
8363 @option{-Xlinker} twice, once for the option and once for the argument.
8364 For example, to pass @option{-assert definitions}, you must write
8365 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8366 @option{-Xlinker "-assert definitions"}, because this passes the entire
8367 string as a single argument, which is not what the linker expects.
8369 When using the GNU linker, it is usually more convenient to pass
8370 arguments to linker options using the @option{@var{option}=@var{value}}
8371 syntax than as separate arguments.  For example, you can specify
8372 @samp{-Xlinker -Map=output.map} rather than
8373 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8374 this syntax for command-line options.
8376 @item -Wl,@var{option}
8377 @opindex Wl
8378 Pass @var{option} as an option to the linker.  If @var{option} contains
8379 commas, it is split into multiple options at the commas.  You can use this
8380 syntax to pass an argument to the option.
8381 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8382 linker.  When using the GNU linker, you can also get the same effect with
8383 @samp{-Wl,-Map=output.map}.
8385 @item -u @var{symbol}
8386 @opindex u
8387 Pretend the symbol @var{symbol} is undefined, to force linking of
8388 library modules to define it.  You can use @option{-u} multiple times with
8389 different symbols to force loading of additional library modules.
8390 @end table
8392 @node Directory Options
8393 @section Options for Directory Search
8394 @cindex directory options
8395 @cindex options, directory search
8396 @cindex search path
8398 These options specify directories to search for header files, for
8399 libraries and for parts of the compiler:
8401 @table @gcctabopt
8402 @item -I@var{dir}
8403 @opindex I
8404 Add the directory @var{dir} to the head of the list of directories to be
8405 searched for header files.  This can be used to override a system header
8406 file, substituting your own version, since these directories are
8407 searched before the system header file directories.  However, you should
8408 not use this option to add directories that contain vendor-supplied
8409 system header files (use @option{-isystem} for that).  If you use more than
8410 one @option{-I} option, the directories are scanned in left-to-right
8411 order; the standard system directories come after.
8413 If a standard system include directory, or a directory specified with
8414 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8415 option will be ignored.  The directory will still be searched but as a
8416 system directory at its normal position in the system include chain.
8417 This is to ensure that GCC's procedure to fix buggy system headers and
8418 the ordering for the include_next directive are not inadvertently changed.
8419 If you really need to change the search order for system directories,
8420 use the @option{-nostdinc} and/or @option{-isystem} options.
8422 @item -iquote@var{dir}
8423 @opindex iquote
8424 Add the directory @var{dir} to the head of the list of directories to
8425 be searched for header files only for the case of @samp{#include
8426 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8427 otherwise just like @option{-I}.
8429 @item -L@var{dir}
8430 @opindex L
8431 Add directory @var{dir} to the list of directories to be searched
8432 for @option{-l}.
8434 @item -B@var{prefix}
8435 @opindex B
8436 This option specifies where to find the executables, libraries,
8437 include files, and data files of the compiler itself.
8439 The compiler driver program runs one or more of the subprograms
8440 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8441 @var{prefix} as a prefix for each program it tries to run, both with and
8442 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8444 For each subprogram to be run, the compiler driver first tries the
8445 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8446 was not specified, the driver tries two standard prefixes, which are
8447 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8448 those results in a file name that is found, the unmodified program
8449 name is searched for using the directories specified in your
8450 @env{PATH} environment variable.
8452 The compiler will check to see if the path provided by the @option{-B}
8453 refers to a directory, and if necessary it will add a directory
8454 separator character at the end of the path.
8456 @option{-B} prefixes that effectively specify directory names also apply
8457 to libraries in the linker, because the compiler translates these
8458 options into @option{-L} options for the linker.  They also apply to
8459 includes files in the preprocessor, because the compiler translates these
8460 options into @option{-isystem} options for the preprocessor.  In this case,
8461 the compiler appends @samp{include} to the prefix.
8463 The run-time support file @file{libgcc.a} can also be searched for using
8464 the @option{-B} prefix, if needed.  If it is not found there, the two
8465 standard prefixes above are tried, and that is all.  The file is left
8466 out of the link if it is not found by those means.
8468 Another way to specify a prefix much like the @option{-B} prefix is to use
8469 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8470 Variables}.
8472 As a special kludge, if the path provided by @option{-B} is
8473 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8474 9, then it will be replaced by @file{[dir/]include}.  This is to help
8475 with boot-strapping the compiler.
8477 @item -specs=@var{file}
8478 @opindex specs
8479 Process @var{file} after the compiler reads in the standard @file{specs}
8480 file, in order to override the defaults that the @file{gcc} driver
8481 program uses when determining what switches to pass to @file{cc1},
8482 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8483 @option{-specs=@var{file}} can be specified on the command line, and they
8484 are processed in order, from left to right.
8486 @item --sysroot=@var{dir}
8487 @opindex sysroot
8488 Use @var{dir} as the logical root directory for headers and libraries.
8489 For example, if the compiler would normally search for headers in
8490 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8491 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8493 If you use both this option and the @option{-isysroot} option, then
8494 the @option{--sysroot} option will apply to libraries, but the
8495 @option{-isysroot} option will apply to header files.
8497 The GNU linker (beginning with version 2.16) has the necessary support
8498 for this option.  If your linker does not support this option, the
8499 header file aspect of @option{--sysroot} will still work, but the
8500 library aspect will not.
8502 @item -I-
8503 @opindex I-
8504 This option has been deprecated.  Please use @option{-iquote} instead for
8505 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8506 Any directories you specify with @option{-I} options before the @option{-I-}
8507 option are searched only for the case of @samp{#include "@var{file}"};
8508 they are not searched for @samp{#include <@var{file}>}.
8510 If additional directories are specified with @option{-I} options after
8511 the @option{-I-}, these directories are searched for all @samp{#include}
8512 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8513 this way.)
8515 In addition, the @option{-I-} option inhibits the use of the current
8516 directory (where the current input file came from) as the first search
8517 directory for @samp{#include "@var{file}"}.  There is no way to
8518 override this effect of @option{-I-}.  With @option{-I.} you can specify
8519 searching the directory which was current when the compiler was
8520 invoked.  That is not exactly the same as what the preprocessor does
8521 by default, but it is often satisfactory.
8523 @option{-I-} does not inhibit the use of the standard system directories
8524 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8525 independent.
8526 @end table
8528 @c man end
8530 @node Spec Files
8531 @section Specifying subprocesses and the switches to pass to them
8532 @cindex Spec Files
8534 @command{gcc} is a driver program.  It performs its job by invoking a
8535 sequence of other programs to do the work of compiling, assembling and
8536 linking.  GCC interprets its command-line parameters and uses these to
8537 deduce which programs it should invoke, and which command-line options
8538 it ought to place on their command lines.  This behavior is controlled
8539 by @dfn{spec strings}.  In most cases there is one spec string for each
8540 program that GCC can invoke, but a few programs have multiple spec
8541 strings to control their behavior.  The spec strings built into GCC can
8542 be overridden by using the @option{-specs=} command-line switch to specify
8543 a spec file.
8545 @dfn{Spec files} are plaintext files that are used to construct spec
8546 strings.  They consist of a sequence of directives separated by blank
8547 lines.  The type of directive is determined by the first non-whitespace
8548 character on the line and it can be one of the following:
8550 @table @code
8551 @item %@var{command}
8552 Issues a @var{command} to the spec file processor.  The commands that can
8553 appear here are:
8555 @table @code
8556 @item %include <@var{file}>
8557 @cindex %include
8558 Search for @var{file} and insert its text at the current point in the
8559 specs file.
8561 @item %include_noerr <@var{file}>
8562 @cindex %include_noerr
8563 Just like @samp{%include}, but do not generate an error message if the include
8564 file cannot be found.
8566 @item %rename @var{old_name} @var{new_name}
8567 @cindex %rename
8568 Rename the spec string @var{old_name} to @var{new_name}.
8570 @end table
8572 @item *[@var{spec_name}]:
8573 This tells the compiler to create, override or delete the named spec
8574 string.  All lines after this directive up to the next directive or
8575 blank line are considered to be the text for the spec string.  If this
8576 results in an empty string then the spec will be deleted.  (Or, if the
8577 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8578 does not currently exist a new spec will be created.  If the spec does
8579 exist then its contents will be overridden by the text of this
8580 directive, unless the first character of that text is the @samp{+}
8581 character, in which case the text will be appended to the spec.
8583 @item [@var{suffix}]:
8584 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8585 and up to the next directive or blank line are considered to make up the
8586 spec string for the indicated suffix.  When the compiler encounters an
8587 input file with the named suffix, it will processes the spec string in
8588 order to work out how to compile that file.  For example:
8590 @smallexample
8591 .ZZ:
8592 z-compile -input %i
8593 @end smallexample
8595 This says that any input file whose name ends in @samp{.ZZ} should be
8596 passed to the program @samp{z-compile}, which should be invoked with the
8597 command-line switch @option{-input} and with the result of performing the
8598 @samp{%i} substitution.  (See below.)
8600 As an alternative to providing a spec string, the text that follows a
8601 suffix directive can be one of the following:
8603 @table @code
8604 @item @@@var{language}
8605 This says that the suffix is an alias for a known @var{language}.  This is
8606 similar to using the @option{-x} command-line switch to GCC to specify a
8607 language explicitly.  For example:
8609 @smallexample
8610 .ZZ:
8611 @@c++
8612 @end smallexample
8614 Says that .ZZ files are, in fact, C++ source files.
8616 @item #@var{name}
8617 This causes an error messages saying:
8619 @smallexample
8620 @var{name} compiler not installed on this system.
8621 @end smallexample
8622 @end table
8624 GCC already has an extensive list of suffixes built into it.
8625 This directive will add an entry to the end of the list of suffixes, but
8626 since the list is searched from the end backwards, it is effectively
8627 possible to override earlier entries using this technique.
8629 @end table
8631 GCC has the following spec strings built into it.  Spec files can
8632 override these strings or create their own.  Note that individual
8633 targets can also add their own spec strings to this list.
8635 @smallexample
8636 asm          Options to pass to the assembler
8637 asm_final    Options to pass to the assembler post-processor
8638 cpp          Options to pass to the C preprocessor
8639 cc1          Options to pass to the C compiler
8640 cc1plus      Options to pass to the C++ compiler
8641 endfile      Object files to include at the end of the link
8642 link         Options to pass to the linker
8643 lib          Libraries to include on the command line to the linker
8644 libgcc       Decides which GCC support library to pass to the linker
8645 linker       Sets the name of the linker
8646 predefines   Defines to be passed to the C preprocessor
8647 signed_char  Defines to pass to CPP to say whether @code{char} is signed
8648              by default
8649 startfile    Object files to include at the start of the link
8650 @end smallexample
8652 Here is a small example of a spec file:
8654 @smallexample
8655 %rename lib                 old_lib
8657 *lib:
8658 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
8659 @end smallexample
8661 This example renames the spec called @samp{lib} to @samp{old_lib} and
8662 then overrides the previous definition of @samp{lib} with a new one.
8663 The new definition adds in some extra command-line options before
8664 including the text of the old definition.
8666 @dfn{Spec strings} are a list of command-line options to be passed to their
8667 corresponding program.  In addition, the spec strings can contain
8668 @samp{%}-prefixed sequences to substitute variable text or to
8669 conditionally insert text into the command line.  Using these constructs
8670 it is possible to generate quite complex command lines.
8672 Here is a table of all defined @samp{%}-sequences for spec
8673 strings.  Note that spaces are not generated automatically around the
8674 results of expanding these sequences.  Therefore you can concatenate them
8675 together or combine them with constant text in a single argument.
8677 @table @code
8678 @item %%
8679 Substitute one @samp{%} into the program name or argument.
8681 @item %i
8682 Substitute the name of the input file being processed.
8684 @item %b
8685 Substitute the basename of the input file being processed.
8686 This is the substring up to (and not including) the last period
8687 and not including the directory.
8689 @item %B
8690 This is the same as @samp{%b}, but include the file suffix (text after
8691 the last period).
8693 @item %d
8694 Marks the argument containing or following the @samp{%d} as a
8695 temporary file name, so that that file will be deleted if GCC exits
8696 successfully.  Unlike @samp{%g}, this contributes no text to the
8697 argument.
8699 @item %g@var{suffix}
8700 Substitute a file name that has suffix @var{suffix} and is chosen
8701 once per compilation, and mark the argument in the same way as
8702 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
8703 name is now chosen in a way that is hard to predict even when previously
8704 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
8705 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
8706 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
8707 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
8708 was simply substituted with a file name chosen once per compilation,
8709 without regard to any appended suffix (which was therefore treated
8710 just like ordinary text), making such attacks more likely to succeed.
8712 @item %u@var{suffix}
8713 Like @samp{%g}, but generates a new temporary file name even if
8714 @samp{%u@var{suffix}} was already seen.
8716 @item %U@var{suffix}
8717 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
8718 new one if there is no such last file name.  In the absence of any
8719 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
8720 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
8721 would involve the generation of two distinct file names, one
8722 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
8723 simply substituted with a file name chosen for the previous @samp{%u},
8724 without regard to any appended suffix.
8726 @item %j@var{suffix}
8727 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8728 writable, and if save-temps is off; otherwise, substitute the name
8729 of a temporary file, just like @samp{%u}.  This temporary file is not
8730 meant for communication between processes, but rather as a junk
8731 disposal mechanism.
8733 @item %|@var{suffix}
8734 @itemx %m@var{suffix}
8735 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8736 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8737 all.  These are the two most common ways to instruct a program that it
8738 should read from standard input or write to standard output.  If you
8739 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8740 construct: see for example @file{f/lang-specs.h}.
8742 @item %.@var{SUFFIX}
8743 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8744 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8745 terminated by the next space or %.
8747 @item %w
8748 Marks the argument containing or following the @samp{%w} as the
8749 designated output file of this compilation.  This puts the argument
8750 into the sequence of arguments that @samp{%o} will substitute later.
8752 @item %o
8753 Substitutes the names of all the output files, with spaces
8754 automatically placed around them.  You should write spaces
8755 around the @samp{%o} as well or the results are undefined.
8756 @samp{%o} is for use in the specs for running the linker.
8757 Input files whose names have no recognized suffix are not compiled
8758 at all, but they are included among the output files, so they will
8759 be linked.
8761 @item %O
8762 Substitutes the suffix for object files.  Note that this is
8763 handled specially when it immediately follows @samp{%g, %u, or %U},
8764 because of the need for those to form complete file names.  The
8765 handling is such that @samp{%O} is treated exactly as if it had already
8766 been substituted, except that @samp{%g, %u, and %U} do not currently
8767 support additional @var{suffix} characters following @samp{%O} as they would
8768 following, for example, @samp{.o}.
8770 @item %p
8771 Substitutes the standard macro predefinitions for the
8772 current target machine.  Use this when running @code{cpp}.
8774 @item %P
8775 Like @samp{%p}, but puts @samp{__} before and after the name of each
8776 predefined macro, except for macros that start with @samp{__} or with
8777 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8780 @item %I
8781 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8782 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8783 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8784 and @option{-imultilib} as necessary.
8786 @item %s
8787 Current argument is the name of a library or startup file of some sort.
8788 Search for that file in a standard list of directories and substitute
8789 the full name found.
8791 @item %e@var{str}
8792 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8793 Use this when inconsistent options are detected.
8795 @item %(@var{name})
8796 Substitute the contents of spec string @var{name} at this point.
8798 @item %[@var{name}]
8799 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8801 @item %x@{@var{option}@}
8802 Accumulate an option for @samp{%X}.
8804 @item %X
8805 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8806 spec string.
8808 @item %Y
8809 Output the accumulated assembler options specified by @option{-Wa}.
8811 @item %Z
8812 Output the accumulated preprocessor options specified by @option{-Wp}.
8814 @item %a
8815 Process the @code{asm} spec.  This is used to compute the
8816 switches to be passed to the assembler.
8818 @item %A
8819 Process the @code{asm_final} spec.  This is a spec string for
8820 passing switches to an assembler post-processor, if such a program is
8821 needed.
8823 @item %l
8824 Process the @code{link} spec.  This is the spec for computing the
8825 command line passed to the linker.  Typically it will make use of the
8826 @samp{%L %G %S %D and %E} sequences.
8828 @item %D
8829 Dump out a @option{-L} option for each directory that GCC believes might
8830 contain startup files.  If the target supports multilibs then the
8831 current multilib directory will be prepended to each of these paths.
8833 @item %L
8834 Process the @code{lib} spec.  This is a spec string for deciding which
8835 libraries should be included on the command line to the linker.
8837 @item %G
8838 Process the @code{libgcc} spec.  This is a spec string for deciding
8839 which GCC support library should be included on the command line to the linker.
8841 @item %S
8842 Process the @code{startfile} spec.  This is a spec for deciding which
8843 object files should be the first ones passed to the linker.  Typically
8844 this might be a file named @file{crt0.o}.
8846 @item %E
8847 Process the @code{endfile} spec.  This is a spec string that specifies
8848 the last object files that will be passed to the linker.
8850 @item %C
8851 Process the @code{cpp} spec.  This is used to construct the arguments
8852 to be passed to the C preprocessor.
8854 @item %1
8855 Process the @code{cc1} spec.  This is used to construct the options to be
8856 passed to the actual C compiler (@samp{cc1}).
8858 @item %2
8859 Process the @code{cc1plus} spec.  This is used to construct the options to be
8860 passed to the actual C++ compiler (@samp{cc1plus}).
8862 @item %*
8863 Substitute the variable part of a matched option.  See below.
8864 Note that each comma in the substituted string is replaced by
8865 a single space.
8867 @item %<@code{S}
8868 Remove all occurrences of @code{-S} from the command line.  Note---this
8869 command is position dependent.  @samp{%} commands in the spec string
8870 before this one will see @code{-S}, @samp{%} commands in the spec string
8871 after this one will not.
8873 @item %:@var{function}(@var{args})
8874 Call the named function @var{function}, passing it @var{args}.
8875 @var{args} is first processed as a nested spec string, then split
8876 into an argument vector in the usual fashion.  The function returns
8877 a string which is processed as if it had appeared literally as part
8878 of the current spec.
8880 The following built-in spec functions are provided:
8882 @table @code
8883 @item @code{getenv}
8884 The @code{getenv} spec function takes two arguments: an environment
8885 variable name and a string.  If the environment variable is not
8886 defined, a fatal error is issued.  Otherwise, the return value is the
8887 value of the environment variable concatenated with the string.  For
8888 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8890 @smallexample
8891 %:getenv(TOPDIR /include)
8892 @end smallexample
8894 expands to @file{/path/to/top/include}.
8896 @item @code{if-exists}
8897 The @code{if-exists} spec function takes one argument, an absolute
8898 pathname to a file.  If the file exists, @code{if-exists} returns the
8899 pathname.  Here is a small example of its usage:
8901 @smallexample
8902 *startfile:
8903 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8904 @end smallexample
8906 @item @code{if-exists-else}
8907 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8908 spec function, except that it takes two arguments.  The first argument is
8909 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8910 returns the pathname.  If it does not exist, it returns the second argument.
8911 This way, @code{if-exists-else} can be used to select one file or another,
8912 based on the existence of the first.  Here is a small example of its usage:
8914 @smallexample
8915 *startfile:
8916 crt0%O%s %:if-exists(crti%O%s) \
8917 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8918 @end smallexample
8920 @item @code{replace-outfile}
8921 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8922 first argument in the outfiles array and replaces it with the second argument.  Here
8923 is a small example of its usage:
8925 @smallexample
8926 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8927 @end smallexample
8929 @item @code{print-asm-header}
8930 The @code{print-asm-header} function takes no arguments and simply
8931 prints a banner like:
8933 @smallexample
8934 Assembler options
8935 =================
8937 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8938 @end smallexample
8940 It is used to separate compiler options from assembler options
8941 in the @option{--target-help} output.
8942 @end table
8944 @item %@{@code{S}@}
8945 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8946 If that switch was not specified, this substitutes nothing.  Note that
8947 the leading dash is omitted when specifying this option, and it is
8948 automatically inserted if the substitution is performed.  Thus the spec
8949 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8950 and would output the command line option @option{-foo}.
8952 @item %W@{@code{S}@}
8953 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8954 deleted on failure.
8956 @item %@{@code{S}*@}
8957 Substitutes all the switches specified to GCC whose names start
8958 with @code{-S}, but which also take an argument.  This is used for
8959 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8960 GCC considers @option{-o foo} as being
8961 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8962 text, including the space.  Thus two arguments would be generated.
8964 @item %@{@code{S}*&@code{T}*@}
8965 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8966 (the order of @code{S} and @code{T} in the spec is not significant).
8967 There can be any number of ampersand-separated variables; for each the
8968 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8970 @item %@{@code{S}:@code{X}@}
8971 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8973 @item %@{!@code{S}:@code{X}@}
8974 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8976 @item %@{@code{S}*:@code{X}@}
8977 Substitutes @code{X} if one or more switches whose names start with
8978 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8979 once, no matter how many such switches appeared.  However, if @code{%*}
8980 appears somewhere in @code{X}, then @code{X} will be substituted once
8981 for each matching switch, with the @code{%*} replaced by the part of
8982 that switch that matched the @code{*}.
8984 @item %@{.@code{S}:@code{X}@}
8985 Substitutes @code{X}, if processing a file with suffix @code{S}.
8987 @item %@{!.@code{S}:@code{X}@}
8988 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8990 @item %@{,@code{S}:@code{X}@}
8991 Substitutes @code{X}, if processing a file for language @code{S}.
8993 @item %@{!,@code{S}:@code{X}@}
8994 Substitutes @code{X}, if not processing a file for language @code{S}.
8996 @item %@{@code{S}|@code{P}:@code{X}@}
8997 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8998 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8999 @code{*} sequences as well, although they have a stronger binding than
9000 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9001 alternatives must be starred, and only the first matching alternative
9002 is substituted.
9004 For example, a spec string like this:
9006 @smallexample
9007 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9008 @end smallexample
9010 will output the following command-line options from the following input
9011 command-line options:
9013 @smallexample
9014 fred.c        -foo -baz
9015 jim.d         -bar -boggle
9016 -d fred.c     -foo -baz -boggle
9017 -d jim.d      -bar -baz -boggle
9018 @end smallexample
9020 @item %@{S:X; T:Y; :D@}
9022 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9023 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9024 be as many clauses as you need.  This may be combined with @code{.},
9025 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9028 @end table
9030 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9031 construct may contain other nested @samp{%} constructs or spaces, or
9032 even newlines.  They are processed as usual, as described above.
9033 Trailing white space in @code{X} is ignored.  White space may also
9034 appear anywhere on the left side of the colon in these constructs,
9035 except between @code{.} or @code{*} and the corresponding word.
9037 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9038 handled specifically in these constructs.  If another value of
9039 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9040 @option{-W} switch is found later in the command line, the earlier
9041 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9042 just one letter, which passes all matching options.
9044 The character @samp{|} at the beginning of the predicate text is used to
9045 indicate that a command should be piped to the following command, but
9046 only if @option{-pipe} is specified.
9048 It is built into GCC which switches take arguments and which do not.
9049 (You might think it would be useful to generalize this to allow each
9050 compiler's spec to say which switches take arguments.  But this cannot
9051 be done in a consistent fashion.  GCC cannot even decide which input
9052 files have been specified without knowing which switches take arguments,
9053 and it must know which input files to compile in order to tell which
9054 compilers to run).
9056 GCC also knows implicitly that arguments starting in @option{-l} are to be
9057 treated as compiler output files, and passed to the linker in their
9058 proper position among the other output files.
9060 @c man begin OPTIONS
9062 @node Target Options
9063 @section Specifying Target Machine and Compiler Version
9064 @cindex target options
9065 @cindex cross compiling
9066 @cindex specifying machine version
9067 @cindex specifying compiler version and target machine
9068 @cindex compiler version, specifying
9069 @cindex target machine, specifying
9071 The usual way to run GCC is to run the executable called @file{gcc}, or
9072 @file{<machine>-gcc} when cross-compiling, or
9073 @file{<machine>-gcc-<version>} to run a version other than the one that
9074 was installed last.  Sometimes this is inconvenient, so GCC provides
9075 options that will switch to another cross-compiler or version.
9077 @table @gcctabopt
9078 @item -b @var{machine}
9079 @opindex b
9080 The argument @var{machine} specifies the target machine for compilation.
9082 The value to use for @var{machine} is the same as was specified as the
9083 machine type when configuring GCC as a cross-compiler.  For
9084 example, if a cross-compiler was configured with @samp{configure
9085 arm-elf}, meaning to compile for an arm processor with elf binaries,
9086 then you would specify @option{-b arm-elf} to run that cross compiler.
9087 Because there are other options beginning with @option{-b}, the
9088 configuration must contain a hyphen, or @option{-b} alone should be one
9089 argument followed by the configuration in the next argument.
9091 @item -V @var{version}
9092 @opindex V
9093 The argument @var{version} specifies which version of GCC to run.
9094 This is useful when multiple versions are installed.  For example,
9095 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9096 @end table
9098 The @option{-V} and @option{-b} options work by running the
9099 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9100 use them if you can just run that directly.
9102 @node Submodel Options
9103 @section Hardware Models and Configurations
9104 @cindex submodel options
9105 @cindex specifying hardware config
9106 @cindex hardware models and configurations, specifying
9107 @cindex machine dependent options
9109 Earlier we discussed the standard option @option{-b} which chooses among
9110 different installed compilers for completely different target
9111 machines, such as VAX vs.@: 68000 vs.@: 80386.
9113 In addition, each of these target machine types can have its own
9114 special options, starting with @samp{-m}, to choose among various
9115 hardware models or configurations---for example, 68010 vs 68020,
9116 floating coprocessor or none.  A single installed version of the
9117 compiler can compile for any model or configuration, according to the
9118 options specified.
9120 Some configurations of the compiler also support additional special
9121 options, usually for compatibility with other compilers on the same
9122 platform.
9124 @c This list is ordered alphanumerically by subsection name.
9125 @c It should be the same order and spelling as these options are listed
9126 @c in Machine Dependent Options
9128 @menu
9129 * ARC Options::
9130 * ARM Options::
9131 * AVR Options::
9132 * Blackfin Options::
9133 * CRIS Options::
9134 * CRX Options::
9135 * Darwin Options::
9136 * DEC Alpha Options::
9137 * DEC Alpha/VMS Options::
9138 * FR30 Options::
9139 * FRV Options::
9140 * GNU/Linux Options::
9141 * H8/300 Options::
9142 * HPPA Options::
9143 * i386 and x86-64 Options::
9144 * i386 and x86-64 Windows Options::
9145 * IA-64 Options::
9146 * M32C Options::
9147 * M32R/D Options::
9148 * M680x0 Options::
9149 * M68hc1x Options::
9150 * MCore Options::
9151 * MeP Options::
9152 * MIPS Options::
9153 * MMIX Options::
9154 * MN10300 Options::
9155 * PDP-11 Options::
9156 * picoChip Options::
9157 * PowerPC Options::
9158 * RS/6000 and PowerPC Options::
9159 * S/390 and zSeries Options::
9160 * Score Options::
9161 * SH Options::
9162 * SPARC Options::
9163 * SPU Options::
9164 * System V Options::
9165 * V850 Options::
9166 * VAX Options::
9167 * VxWorks Options::
9168 * x86-64 Options::
9169 * Xstormy16 Options::
9170 * Xtensa Options::
9171 * zSeries Options::
9172 @end menu
9174 @node ARC Options
9175 @subsection ARC Options
9176 @cindex ARC Options
9178 These options are defined for ARC implementations:
9180 @table @gcctabopt
9181 @item -EL
9182 @opindex EL
9183 Compile code for little endian mode.  This is the default.
9185 @item -EB
9186 @opindex EB
9187 Compile code for big endian mode.
9189 @item -mmangle-cpu
9190 @opindex mmangle-cpu
9191 Prepend the name of the cpu to all public symbol names.
9192 In multiple-processor systems, there are many ARC variants with different
9193 instruction and register set characteristics.  This flag prevents code
9194 compiled for one cpu to be linked with code compiled for another.
9195 No facility exists for handling variants that are ``almost identical''.
9196 This is an all or nothing option.
9198 @item -mcpu=@var{cpu}
9199 @opindex mcpu
9200 Compile code for ARC variant @var{cpu}.
9201 Which variants are supported depend on the configuration.
9202 All variants support @option{-mcpu=base}, this is the default.
9204 @item -mtext=@var{text-section}
9205 @itemx -mdata=@var{data-section}
9206 @itemx -mrodata=@var{readonly-data-section}
9207 @opindex mtext
9208 @opindex mdata
9209 @opindex mrodata
9210 Put functions, data, and readonly data in @var{text-section},
9211 @var{data-section}, and @var{readonly-data-section} respectively
9212 by default.  This can be overridden with the @code{section} attribute.
9213 @xref{Variable Attributes}.
9215 @item -mfix-cortex-m3-ldrd
9216 @opindex mfix-cortex-m3-ldrd
9217 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9218 with overlapping destination and base registers are used.  This option avoids
9219 generating these instructions.  This option is enabled by default when
9220 @option{-mcpu=cortex-m3} is specified.
9222 @end table
9224 @node ARM Options
9225 @subsection ARM Options
9226 @cindex ARM options
9228 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9229 architectures:
9231 @table @gcctabopt
9232 @item -mabi=@var{name}
9233 @opindex mabi
9234 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9235 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9237 @item -mapcs-frame
9238 @opindex mapcs-frame
9239 Generate a stack frame that is compliant with the ARM Procedure Call
9240 Standard for all functions, even if this is not strictly necessary for
9241 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9242 with this option will cause the stack frames not to be generated for
9243 leaf functions.  The default is @option{-mno-apcs-frame}.
9245 @item -mapcs
9246 @opindex mapcs
9247 This is a synonym for @option{-mapcs-frame}.
9249 @ignore
9250 @c not currently implemented
9251 @item -mapcs-stack-check
9252 @opindex mapcs-stack-check
9253 Generate code to check the amount of stack space available upon entry to
9254 every function (that actually uses some stack space).  If there is
9255 insufficient space available then either the function
9256 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9257 called, depending upon the amount of stack space required.  The run time
9258 system is required to provide these functions.  The default is
9259 @option{-mno-apcs-stack-check}, since this produces smaller code.
9261 @c not currently implemented
9262 @item -mapcs-float
9263 @opindex mapcs-float
9264 Pass floating point arguments using the float point registers.  This is
9265 one of the variants of the APCS@.  This option is recommended if the
9266 target hardware has a floating point unit or if a lot of floating point
9267 arithmetic is going to be performed by the code.  The default is
9268 @option{-mno-apcs-float}, since integer only code is slightly increased in
9269 size if @option{-mapcs-float} is used.
9271 @c not currently implemented
9272 @item -mapcs-reentrant
9273 @opindex mapcs-reentrant
9274 Generate reentrant, position independent code.  The default is
9275 @option{-mno-apcs-reentrant}.
9276 @end ignore
9278 @item -mthumb-interwork
9279 @opindex mthumb-interwork
9280 Generate code which supports calling between the ARM and Thumb
9281 instruction sets.  Without this option the two instruction sets cannot
9282 be reliably used inside one program.  The default is
9283 @option{-mno-thumb-interwork}, since slightly larger code is generated
9284 when @option{-mthumb-interwork} is specified.
9286 @item -mno-sched-prolog
9287 @opindex mno-sched-prolog
9288 Prevent the reordering of instructions in the function prolog, or the
9289 merging of those instruction with the instructions in the function's
9290 body.  This means that all functions will start with a recognizable set
9291 of instructions (or in fact one of a choice from a small set of
9292 different function prologues), and this information can be used to
9293 locate the start if functions inside an executable piece of code.  The
9294 default is @option{-msched-prolog}.
9296 @item -mfloat-abi=@var{name}
9297 @opindex mfloat-abi
9298 Specifies which floating-point ABI to use.  Permissible values
9299 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9301 Specifying @samp{soft} causes GCC to generate output containing
9302 library calls for floating-point operations.
9303 @samp{softfp} allows the generation of code using hardware floating-point
9304 instructions, but still uses the soft-float calling conventions.
9305 @samp{hard} allows generation of floating-point instructions
9306 and uses FPU-specific calling conventions.
9308 Using @option{-mfloat-abi=hard} with VFP coprocessors is not supported.
9309 Use @option{-mfloat-abi=softfp} with the appropriate @option{-mfpu} option
9310 to allow the compiler to generate code that makes use of the hardware
9311 floating-point capabilities for these CPUs.
9313 The default depends on the specific target configuration.  Note that
9314 the hard-float and soft-float ABIs are not link-compatible; you must
9315 compile your entire program with the same ABI, and link with a
9316 compatible set of libraries.
9318 @item -mhard-float
9319 @opindex mhard-float
9320 Equivalent to @option{-mfloat-abi=hard}.
9322 @item -msoft-float
9323 @opindex msoft-float
9324 Equivalent to @option{-mfloat-abi=soft}.
9326 @item -mlittle-endian
9327 @opindex mlittle-endian
9328 Generate code for a processor running in little-endian mode.  This is
9329 the default for all standard configurations.
9331 @item -mbig-endian
9332 @opindex mbig-endian
9333 Generate code for a processor running in big-endian mode; the default is
9334 to compile code for a little-endian processor.
9336 @item -mwords-little-endian
9337 @opindex mwords-little-endian
9338 This option only applies when generating code for big-endian processors.
9339 Generate code for a little-endian word order but a big-endian byte
9340 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9341 option should only be used if you require compatibility with code for
9342 big-endian ARM processors generated by versions of the compiler prior to
9343 2.8.
9345 @item -mcpu=@var{name}
9346 @opindex mcpu
9347 This specifies the name of the target ARM processor.  GCC uses this name
9348 to determine what kind of instructions it can emit when generating
9349 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9350 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9351 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9352 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9353 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9354 @samp{arm720},
9355 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9356 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9357 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9358 @samp{strongarm1110},
9359 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9360 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9361 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9362 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9363 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9364 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9365 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9366 @samp{cortex-a8}, @samp{cortex-a9},
9367 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9368 @samp{cortex-m1},
9369 @samp{cortex-m0},
9370 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9372 @item -mtune=@var{name}
9373 @opindex mtune
9374 This option is very similar to the @option{-mcpu=} option, except that
9375 instead of specifying the actual target processor type, and hence
9376 restricting which instructions can be used, it specifies that GCC should
9377 tune the performance of the code as if the target were of the type
9378 specified in this option, but still choosing the instructions that it
9379 will generate based on the cpu specified by a @option{-mcpu=} option.
9380 For some ARM implementations better performance can be obtained by using
9381 this option.
9383 @item -march=@var{name}
9384 @opindex march
9385 This specifies the name of the target ARM architecture.  GCC uses this
9386 name to determine what kind of instructions it can emit when generating
9387 assembly code.  This option can be used in conjunction with or instead
9388 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9389 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9390 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9391 @samp{armv6}, @samp{armv6j},
9392 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9393 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9394 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9396 @item -mfpu=@var{name}
9397 @itemx -mfpe=@var{number}
9398 @itemx -mfp=@var{number}
9399 @opindex mfpu
9400 @opindex mfpe
9401 @opindex mfp
9402 This specifies what floating point hardware (or hardware emulation) is
9403 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9404 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-d16},
9405 @samp{neon}, and @samp{neon-fp16}.  @option{-mfp} and @option{-mfpe}
9406 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
9407 with older versions of GCC@.
9409 If @option{-msoft-float} is specified this specifies the format of
9410 floating point values.
9412 @item -mfp16-format=@var{name}
9413 @opindex mfp16-format
9414 Specify the format of the @code{__fp16} half-precision floating-point type.
9415 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9416 the default is @samp{none}, in which case the @code{__fp16} type is not
9417 defined.  @xref{Half-Precision}, for more information.
9419 @item -mstructure-size-boundary=@var{n}
9420 @opindex mstructure-size-boundary
9421 The size of all structures and unions will be rounded up to a multiple
9422 of the number of bits set by this option.  Permissible values are 8, 32
9423 and 64.  The default value varies for different toolchains.  For the COFF
9424 targeted toolchain the default value is 8.  A value of 64 is only allowed
9425 if the underlying ABI supports it.
9427 Specifying the larger number can produce faster, more efficient code, but
9428 can also increase the size of the program.  Different values are potentially
9429 incompatible.  Code compiled with one value cannot necessarily expect to
9430 work with code or libraries compiled with another value, if they exchange
9431 information using structures or unions.
9433 @item -mabort-on-noreturn
9434 @opindex mabort-on-noreturn
9435 Generate a call to the function @code{abort} at the end of a
9436 @code{noreturn} function.  It will be executed if the function tries to
9437 return.
9439 @item -mlong-calls
9440 @itemx -mno-long-calls
9441 @opindex mlong-calls
9442 @opindex mno-long-calls
9443 Tells the compiler to perform function calls by first loading the
9444 address of the function into a register and then performing a subroutine
9445 call on this register.  This switch is needed if the target function
9446 will lie outside of the 64 megabyte addressing range of the offset based
9447 version of subroutine call instruction.
9449 Even if this switch is enabled, not all function calls will be turned
9450 into long calls.  The heuristic is that static functions, functions
9451 which have the @samp{short-call} attribute, functions that are inside
9452 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9453 definitions have already been compiled within the current compilation
9454 unit, will not be turned into long calls.  The exception to this rule is
9455 that weak function definitions, functions with the @samp{long-call}
9456 attribute or the @samp{section} attribute, and functions that are within
9457 the scope of a @samp{#pragma long_calls} directive, will always be
9458 turned into long calls.
9460 This feature is not enabled by default.  Specifying
9461 @option{-mno-long-calls} will restore the default behavior, as will
9462 placing the function calls within the scope of a @samp{#pragma
9463 long_calls_off} directive.  Note these switches have no effect on how
9464 the compiler generates code to handle function calls via function
9465 pointers.
9467 @item -msingle-pic-base
9468 @opindex msingle-pic-base
9469 Treat the register used for PIC addressing as read-only, rather than
9470 loading it in the prologue for each function.  The run-time system is
9471 responsible for initializing this register with an appropriate value
9472 before execution begins.
9474 @item -mpic-register=@var{reg}
9475 @opindex mpic-register
9476 Specify the register to be used for PIC addressing.  The default is R10
9477 unless stack-checking is enabled, when R9 is used.
9479 @item -mcirrus-fix-invalid-insns
9480 @opindex mcirrus-fix-invalid-insns
9481 @opindex mno-cirrus-fix-invalid-insns
9482 Insert NOPs into the instruction stream to in order to work around
9483 problems with invalid Maverick instruction combinations.  This option
9484 is only valid if the @option{-mcpu=ep9312} option has been used to
9485 enable generation of instructions for the Cirrus Maverick floating
9486 point co-processor.  This option is not enabled by default, since the
9487 problem is only present in older Maverick implementations.  The default
9488 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9489 switch.
9491 @item -mpoke-function-name
9492 @opindex mpoke-function-name
9493 Write the name of each function into the text section, directly
9494 preceding the function prologue.  The generated code is similar to this:
9496 @smallexample
9497      t0
9498          .ascii "arm_poke_function_name", 0
9499          .align
9500      t1
9501          .word 0xff000000 + (t1 - t0)
9502      arm_poke_function_name
9503          mov     ip, sp
9504          stmfd   sp!, @{fp, ip, lr, pc@}
9505          sub     fp, ip, #4
9506 @end smallexample
9508 When performing a stack backtrace, code can inspect the value of
9509 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9510 location @code{pc - 12} and the top 8 bits are set, then we know that
9511 there is a function name embedded immediately preceding this location
9512 and has length @code{((pc[-3]) & 0xff000000)}.
9514 @item -mthumb
9515 @opindex mthumb
9516 Generate code for the Thumb instruction set.  The default is to
9517 use the 32-bit ARM instruction set.
9518 This option automatically enables either 16-bit Thumb-1 or
9519 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9520 and @option{-march=@var{name}} options.  This option is not passed to the
9521 assembler. If you want to force assembler files to be interpreted as Thumb code,
9522 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9523 option directly to the assembler by prefixing it with @option{-Wa}.
9525 @item -mtpcs-frame
9526 @opindex mtpcs-frame
9527 Generate a stack frame that is compliant with the Thumb Procedure Call
9528 Standard for all non-leaf functions.  (A leaf function is one that does
9529 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9531 @item -mtpcs-leaf-frame
9532 @opindex mtpcs-leaf-frame
9533 Generate a stack frame that is compliant with the Thumb Procedure Call
9534 Standard for all leaf functions.  (A leaf function is one that does
9535 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9537 @item -mcallee-super-interworking
9538 @opindex mcallee-super-interworking
9539 Gives all externally visible functions in the file being compiled an ARM
9540 instruction set header which switches to Thumb mode before executing the
9541 rest of the function.  This allows these functions to be called from
9542 non-interworking code.  This option is not valid in AAPCS configurations
9543 because interworking is enabled by default.
9545 @item -mcaller-super-interworking
9546 @opindex mcaller-super-interworking
9547 Allows calls via function pointers (including virtual functions) to
9548 execute correctly regardless of whether the target code has been
9549 compiled for interworking or not.  There is a small overhead in the cost
9550 of executing a function pointer if this option is enabled.  This option
9551 is not valid in AAPCS configurations because interworking is enabled
9552 by default.
9554 @item -mtp=@var{name}
9555 @opindex mtp
9556 Specify the access model for the thread local storage pointer.  The valid
9557 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9558 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9559 (supported in the arm6k architecture), and @option{auto}, which uses the
9560 best available method for the selected processor.  The default setting is
9561 @option{auto}.
9563 @item -mword-relocations
9564 @opindex mword-relocations
9565 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9566 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9567 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9568 is specified.
9570 @end table
9572 @node AVR Options
9573 @subsection AVR Options
9574 @cindex AVR Options
9576 These options are defined for AVR implementations:
9578 @table @gcctabopt
9579 @item -mmcu=@var{mcu}
9580 @opindex mmcu
9581 Specify ATMEL AVR instruction set or MCU type.
9583 Instruction set avr1 is for the minimal AVR core, not supported by the C
9584 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9585 attiny11, attiny12, attiny15, attiny28).
9587 Instruction set avr2 (default) is for the classic AVR core with up to
9588 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9589 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9590 at90c8534, at90s8535).
9592 Instruction set avr3 is for the classic AVR core with up to 128K program
9593 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9595 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9596 memory space (MCU types: atmega8, atmega83, atmega85).
9598 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9599 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9600 atmega64, atmega128, at43usb355, at94k).
9602 @item -msize
9603 @opindex msize
9604 Output instruction sizes to the asm file.
9606 @item -minit-stack=@var{N}
9607 @opindex minit-stack
9608 Specify the initial stack address, which may be a symbol or numeric value,
9609 @samp{__stack} is the default.
9611 @item -mno-interrupts
9612 @opindex mno-interrupts
9613 Generated code is not compatible with hardware interrupts.
9614 Code size will be smaller.
9616 @item -mcall-prologues
9617 @opindex mcall-prologues
9618 Functions prologues/epilogues expanded as call to appropriate
9619 subroutines.  Code size will be smaller.
9621 @item -mtiny-stack
9622 @opindex mtiny-stack
9623 Change only the low 8 bits of the stack pointer.
9625 @item -mint8
9626 @opindex mint8
9627 Assume int to be 8 bit integer.  This affects the sizes of all types: A
9628 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
9629 and long long will be 4 bytes.  Please note that this option does not
9630 comply to the C standards, but it will provide you with smaller code
9631 size.
9632 @end table
9634 @node Blackfin Options
9635 @subsection Blackfin Options
9636 @cindex Blackfin Options
9638 @table @gcctabopt
9639 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
9640 @opindex mcpu=
9641 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
9642 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
9643 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
9644 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
9645 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
9646 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
9647 @samp{bf561}.
9648 The optional @var{sirevision} specifies the silicon revision of the target
9649 Blackfin processor.  Any workarounds available for the targeted silicon revision
9650 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
9651 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
9652 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
9653 hexadecimal digits representing the major and minor numbers in the silicon
9654 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
9655 is not defined.  If @var{sirevision} is @samp{any}, the
9656 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
9657 If this optional @var{sirevision} is not used, GCC assumes the latest known
9658 silicon revision of the targeted Blackfin processor.
9660 Support for @samp{bf561} is incomplete.  For @samp{bf561},
9661 Only the processor macro is defined.
9662 Without this option, @samp{bf532} is used as the processor by default.
9663 The corresponding predefined processor macros for @var{cpu} is to
9664 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
9665 provided by libgloss to be linked in if @option{-msim} is not given.
9667 @item -msim
9668 @opindex msim
9669 Specifies that the program will be run on the simulator.  This causes
9670 the simulator BSP provided by libgloss to be linked in.  This option
9671 has effect only for @samp{bfin-elf} toolchain.
9672 Certain other options, such as @option{-mid-shared-library} and
9673 @option{-mfdpic}, imply @option{-msim}.
9675 @item -momit-leaf-frame-pointer
9676 @opindex momit-leaf-frame-pointer
9677 Don't keep the frame pointer in a register for leaf functions.  This
9678 avoids the instructions to save, set up and restore frame pointers and
9679 makes an extra register available in leaf functions.  The option
9680 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9681 which might make debugging harder.
9683 @item -mspecld-anomaly
9684 @opindex mspecld-anomaly
9685 When enabled, the compiler will ensure that the generated code does not
9686 contain speculative loads after jump instructions. If this option is used,
9687 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
9689 @item -mno-specld-anomaly
9690 @opindex mno-specld-anomaly
9691 Don't generate extra code to prevent speculative loads from occurring.
9693 @item -mcsync-anomaly
9694 @opindex mcsync-anomaly
9695 When enabled, the compiler will ensure that the generated code does not
9696 contain CSYNC or SSYNC instructions too soon after conditional branches.
9697 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
9699 @item -mno-csync-anomaly
9700 @opindex mno-csync-anomaly
9701 Don't generate extra code to prevent CSYNC or SSYNC instructions from
9702 occurring too soon after a conditional branch.
9704 @item -mlow-64k
9705 @opindex mlow-64k
9706 When enabled, the compiler is free to take advantage of the knowledge that
9707 the entire program fits into the low 64k of memory.
9709 @item -mno-low-64k
9710 @opindex mno-low-64k
9711 Assume that the program is arbitrarily large.  This is the default.
9713 @item -mstack-check-l1
9714 @opindex mstack-check-l1
9715 Do stack checking using information placed into L1 scratchpad memory by the
9716 uClinux kernel.
9718 @item -mid-shared-library
9719 @opindex mid-shared-library
9720 Generate code that supports shared libraries via the library ID method.
9721 This allows for execute in place and shared libraries in an environment
9722 without virtual memory management.  This option implies @option{-fPIC}.
9723 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9725 @item -mno-id-shared-library
9726 @opindex mno-id-shared-library
9727 Generate code that doesn't assume ID based shared libraries are being used.
9728 This is the default.
9730 @item -mleaf-id-shared-library
9731 @opindex mleaf-id-shared-library
9732 Generate code that supports shared libraries via the library ID method,
9733 but assumes that this library or executable won't link against any other
9734 ID shared libraries.  That allows the compiler to use faster code for jumps
9735 and calls.
9737 @item -mno-leaf-id-shared-library
9738 @opindex mno-leaf-id-shared-library
9739 Do not assume that the code being compiled won't link against any ID shared
9740 libraries.  Slower code will be generated for jump and call insns.
9742 @item -mshared-library-id=n
9743 @opindex mshared-library-id
9744 Specified the identification number of the ID based shared library being
9745 compiled.  Specifying a value of 0 will generate more compact code, specifying
9746 other values will force the allocation of that number to the current
9747 library but is no more space or time efficient than omitting this option.
9749 @item -msep-data
9750 @opindex msep-data
9751 Generate code that allows the data segment to be located in a different
9752 area of memory from the text segment.  This allows for execute in place in
9753 an environment without virtual memory management by eliminating relocations
9754 against the text section.
9756 @item -mno-sep-data
9757 @opindex mno-sep-data
9758 Generate code that assumes that the data segment follows the text segment.
9759 This is the default.
9761 @item -mlong-calls
9762 @itemx -mno-long-calls
9763 @opindex mlong-calls
9764 @opindex mno-long-calls
9765 Tells the compiler to perform function calls by first loading the
9766 address of the function into a register and then performing a subroutine
9767 call on this register.  This switch is needed if the target function
9768 will lie outside of the 24 bit addressing range of the offset based
9769 version of subroutine call instruction.
9771 This feature is not enabled by default.  Specifying
9772 @option{-mno-long-calls} will restore the default behavior.  Note these
9773 switches have no effect on how the compiler generates code to handle
9774 function calls via function pointers.
9776 @item -mfast-fp
9777 @opindex mfast-fp
9778 Link with the fast floating-point library. This library relaxes some of
9779 the IEEE floating-point standard's rules for checking inputs against
9780 Not-a-Number (NAN), in the interest of performance.
9782 @item -minline-plt
9783 @opindex minline-plt
9784 Enable inlining of PLT entries in function calls to functions that are
9785 not known to bind locally.  It has no effect without @option{-mfdpic}.
9787 @item -mmulticore
9788 @opindex mmulticore
9789 Build standalone application for multicore Blackfin processor. Proper
9790 start files and link scripts will be used to support multicore.
9791 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9792 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9793 @option{-mcorea} or @option{-mcoreb}. If it's used without
9794 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9795 programming model is used. In this model, the main function of Core B
9796 should be named as coreb_main. If it's used with @option{-mcorea} or
9797 @option{-mcoreb}, one application per core programming model is used.
9798 If this option is not used, single core application programming
9799 model is used.
9801 @item -mcorea
9802 @opindex mcorea
9803 Build standalone application for Core A of BF561 when using
9804 one application per core programming model. Proper start files
9805 and link scripts will be used to support Core A. This option
9806 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9808 @item -mcoreb
9809 @opindex mcoreb
9810 Build standalone application for Core B of BF561 when using
9811 one application per core programming model. Proper start files
9812 and link scripts will be used to support Core B. This option
9813 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9814 should be used instead of main. It must be used with
9815 @option{-mmulticore}.
9817 @item -msdram
9818 @opindex msdram
9819 Build standalone application for SDRAM. Proper start files and
9820 link scripts will be used to put the application into SDRAM.
9821 Loader should initialize SDRAM before loading the application
9822 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9824 @item -micplb
9825 @opindex micplb
9826 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
9827 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
9828 are enabled; for standalone applications the default is off.
9829 @end table
9831 @node CRIS Options
9832 @subsection CRIS Options
9833 @cindex CRIS Options
9835 These options are defined specifically for the CRIS ports.
9837 @table @gcctabopt
9838 @item -march=@var{architecture-type}
9839 @itemx -mcpu=@var{architecture-type}
9840 @opindex march
9841 @opindex mcpu
9842 Generate code for the specified architecture.  The choices for
9843 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9844 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9845 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9846 @samp{v10}.
9848 @item -mtune=@var{architecture-type}
9849 @opindex mtune
9850 Tune to @var{architecture-type} everything applicable about the generated
9851 code, except for the ABI and the set of available instructions.  The
9852 choices for @var{architecture-type} are the same as for
9853 @option{-march=@var{architecture-type}}.
9855 @item -mmax-stack-frame=@var{n}
9856 @opindex mmax-stack-frame
9857 Warn when the stack frame of a function exceeds @var{n} bytes.
9859 @item -metrax4
9860 @itemx -metrax100
9861 @opindex metrax4
9862 @opindex metrax100
9863 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9864 @option{-march=v3} and @option{-march=v8} respectively.
9866 @item -mmul-bug-workaround
9867 @itemx -mno-mul-bug-workaround
9868 @opindex mmul-bug-workaround
9869 @opindex mno-mul-bug-workaround
9870 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9871 models where it applies.  This option is active by default.
9873 @item -mpdebug
9874 @opindex mpdebug
9875 Enable CRIS-specific verbose debug-related information in the assembly
9876 code.  This option also has the effect to turn off the @samp{#NO_APP}
9877 formatted-code indicator to the assembler at the beginning of the
9878 assembly file.
9880 @item -mcc-init
9881 @opindex mcc-init
9882 Do not use condition-code results from previous instruction; always emit
9883 compare and test instructions before use of condition codes.
9885 @item -mno-side-effects
9886 @opindex mno-side-effects
9887 Do not emit instructions with side-effects in addressing modes other than
9888 post-increment.
9890 @item -mstack-align
9891 @itemx -mno-stack-align
9892 @itemx -mdata-align
9893 @itemx -mno-data-align
9894 @itemx -mconst-align
9895 @itemx -mno-const-align
9896 @opindex mstack-align
9897 @opindex mno-stack-align
9898 @opindex mdata-align
9899 @opindex mno-data-align
9900 @opindex mconst-align
9901 @opindex mno-const-align
9902 These options (no-options) arranges (eliminate arrangements) for the
9903 stack-frame, individual data and constants to be aligned for the maximum
9904 single data access size for the chosen CPU model.  The default is to
9905 arrange for 32-bit alignment.  ABI details such as structure layout are
9906 not affected by these options.
9908 @item -m32-bit
9909 @itemx -m16-bit
9910 @itemx -m8-bit
9911 @opindex m32-bit
9912 @opindex m16-bit
9913 @opindex m8-bit
9914 Similar to the stack- data- and const-align options above, these options
9915 arrange for stack-frame, writable data and constants to all be 32-bit,
9916 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9918 @item -mno-prologue-epilogue
9919 @itemx -mprologue-epilogue
9920 @opindex mno-prologue-epilogue
9921 @opindex mprologue-epilogue
9922 With @option{-mno-prologue-epilogue}, the normal function prologue and
9923 epilogue that sets up the stack-frame are omitted and no return
9924 instructions or return sequences are generated in the code.  Use this
9925 option only together with visual inspection of the compiled code: no
9926 warnings or errors are generated when call-saved registers must be saved,
9927 or storage for local variable needs to be allocated.
9929 @item -mno-gotplt
9930 @itemx -mgotplt
9931 @opindex mno-gotplt
9932 @opindex mgotplt
9933 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9934 instruction sequences that load addresses for functions from the PLT part
9935 of the GOT rather than (traditional on other architectures) calls to the
9936 PLT@.  The default is @option{-mgotplt}.
9938 @item -melf
9939 @opindex melf
9940 Legacy no-op option only recognized with the cris-axis-elf and
9941 cris-axis-linux-gnu targets.
9943 @item -mlinux
9944 @opindex mlinux
9945 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9947 @item -sim
9948 @opindex sim
9949 This option, recognized for the cris-axis-elf arranges
9950 to link with input-output functions from a simulator library.  Code,
9951 initialized data and zero-initialized data are allocated consecutively.
9953 @item -sim2
9954 @opindex sim2
9955 Like @option{-sim}, but pass linker options to locate initialized data at
9956 0x40000000 and zero-initialized data at 0x80000000.
9957 @end table
9959 @node CRX Options
9960 @subsection CRX Options
9961 @cindex CRX Options
9963 These options are defined specifically for the CRX ports.
9965 @table @gcctabopt
9967 @item -mmac
9968 @opindex mmac
9969 Enable the use of multiply-accumulate instructions. Disabled by default.
9971 @item -mpush-args
9972 @opindex mpush-args
9973 Push instructions will be used to pass outgoing arguments when functions
9974 are called. Enabled by default.
9975 @end table
9977 @node Darwin Options
9978 @subsection Darwin Options
9979 @cindex Darwin options
9981 These options are defined for all architectures running the Darwin operating
9982 system.
9984 FSF GCC on Darwin does not create ``fat'' object files; it will create
9985 an object file for the single architecture that it was built to
9986 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9987 @option{-arch} options are used; it does so by running the compiler or
9988 linker multiple times and joining the results together with
9989 @file{lipo}.
9991 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9992 @samp{i686}) is determined by the flags that specify the ISA
9993 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9994 @option{-force_cpusubtype_ALL} option can be used to override this.
9996 The Darwin tools vary in their behavior when presented with an ISA
9997 mismatch.  The assembler, @file{as}, will only permit instructions to
9998 be used that are valid for the subtype of the file it is generating,
9999 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10000 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10001 and print an error if asked to create a shared library with a less
10002 restrictive subtype than its input files (for instance, trying to put
10003 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10004 for executables, @file{ld}, will quietly give the executable the most
10005 restrictive subtype of any of its input files.
10007 @table @gcctabopt
10008 @item -F@var{dir}
10009 @opindex F
10010 Add the framework directory @var{dir} to the head of the list of
10011 directories to be searched for header files.  These directories are
10012 interleaved with those specified by @option{-I} options and are
10013 scanned in a left-to-right order.
10015 A framework directory is a directory with frameworks in it.  A
10016 framework is a directory with a @samp{"Headers"} and/or
10017 @samp{"PrivateHeaders"} directory contained directly in it that ends
10018 in @samp{".framework"}.  The name of a framework is the name of this
10019 directory excluding the @samp{".framework"}.  Headers associated with
10020 the framework are found in one of those two directories, with
10021 @samp{"Headers"} being searched first.  A subframework is a framework
10022 directory that is in a framework's @samp{"Frameworks"} directory.
10023 Includes of subframework headers can only appear in a header of a
10024 framework that contains the subframework, or in a sibling subframework
10025 header.  Two subframeworks are siblings if they occur in the same
10026 framework.  A subframework should not have the same name as a
10027 framework, a warning will be issued if this is violated.  Currently a
10028 subframework cannot have subframeworks, in the future, the mechanism
10029 may be extended to support this.  The standard frameworks can be found
10030 in @samp{"/System/Library/Frameworks"} and
10031 @samp{"/Library/Frameworks"}.  An example include looks like
10032 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10033 the name of the framework and header.h is found in the
10034 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10036 @item -iframework@var{dir}
10037 @opindex iframework
10038 Like @option{-F} except the directory is a treated as a system
10039 directory.  The main difference between this @option{-iframework} and
10040 @option{-F} is that with @option{-iframework} the compiler does not
10041 warn about constructs contained within header files found via
10042 @var{dir}.  This option is valid only for the C family of languages.
10044 @item -gused
10045 @opindex gused
10046 Emit debugging information for symbols that are used.  For STABS
10047 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10048 This is by default ON@.
10050 @item -gfull
10051 @opindex gfull
10052 Emit debugging information for all symbols and types.
10054 @item -mmacosx-version-min=@var{version}
10055 The earliest version of MacOS X that this executable will run on
10056 is @var{version}.  Typical values of @var{version} include @code{10.1},
10057 @code{10.2}, and @code{10.3.9}.
10059 If the compiler was built to use the system's headers by default,
10060 then the default for this option is the system version on which the
10061 compiler is running, otherwise the default is to make choices which
10062 are compatible with as many systems and code bases as possible.
10064 @item -mkernel
10065 @opindex mkernel
10066 Enable kernel development mode.  The @option{-mkernel} option sets
10067 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10068 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10069 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10070 applicable.  This mode also sets @option{-mno-altivec},
10071 @option{-msoft-float}, @option{-fno-builtin} and
10072 @option{-mlong-branch} for PowerPC targets.
10074 @item -mone-byte-bool
10075 @opindex mone-byte-bool
10076 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10077 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10078 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10079 option has no effect on x86.
10081 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10082 to generate code that is not binary compatible with code generated
10083 without that switch.  Using this switch may require recompiling all
10084 other modules in a program, including system libraries.  Use this
10085 switch to conform to a non-default data model.
10087 @item -mfix-and-continue
10088 @itemx -ffix-and-continue
10089 @itemx -findirect-data
10090 @opindex mfix-and-continue
10091 @opindex ffix-and-continue
10092 @opindex findirect-data
10093 Generate code suitable for fast turn around development.  Needed to
10094 enable gdb to dynamically load @code{.o} files into already running
10095 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10096 are provided for backwards compatibility.
10098 @item -all_load
10099 @opindex all_load
10100 Loads all members of static archive libraries.
10101 See man ld(1) for more information.
10103 @item -arch_errors_fatal
10104 @opindex arch_errors_fatal
10105 Cause the errors having to do with files that have the wrong architecture
10106 to be fatal.
10108 @item -bind_at_load
10109 @opindex bind_at_load
10110 Causes the output file to be marked such that the dynamic linker will
10111 bind all undefined references when the file is loaded or launched.
10113 @item -bundle
10114 @opindex bundle
10115 Produce a Mach-o bundle format file.
10116 See man ld(1) for more information.
10118 @item -bundle_loader @var{executable}
10119 @opindex bundle_loader
10120 This option specifies the @var{executable} that will be loading the build
10121 output file being linked.  See man ld(1) for more information.
10123 @item -dynamiclib
10124 @opindex dynamiclib
10125 When passed this option, GCC will produce a dynamic library instead of
10126 an executable when linking, using the Darwin @file{libtool} command.
10128 @item -force_cpusubtype_ALL
10129 @opindex force_cpusubtype_ALL
10130 This causes GCC's output file to have the @var{ALL} subtype, instead of
10131 one controlled by the @option{-mcpu} or @option{-march} option.
10133 @item -allowable_client  @var{client_name}
10134 @itemx -client_name
10135 @itemx -compatibility_version
10136 @itemx -current_version
10137 @itemx -dead_strip
10138 @itemx -dependency-file
10139 @itemx -dylib_file
10140 @itemx -dylinker_install_name
10141 @itemx -dynamic
10142 @itemx -exported_symbols_list
10143 @itemx -filelist
10144 @itemx -flat_namespace
10145 @itemx -force_flat_namespace
10146 @itemx -headerpad_max_install_names
10147 @itemx -image_base
10148 @itemx -init
10149 @itemx -install_name
10150 @itemx -keep_private_externs
10151 @itemx -multi_module
10152 @itemx -multiply_defined
10153 @itemx -multiply_defined_unused
10154 @itemx -noall_load
10155 @itemx -no_dead_strip_inits_and_terms
10156 @itemx -nofixprebinding
10157 @itemx -nomultidefs
10158 @itemx -noprebind
10159 @itemx -noseglinkedit
10160 @itemx -pagezero_size
10161 @itemx -prebind
10162 @itemx -prebind_all_twolevel_modules
10163 @itemx -private_bundle
10164 @itemx -read_only_relocs
10165 @itemx -sectalign
10166 @itemx -sectobjectsymbols
10167 @itemx -whyload
10168 @itemx -seg1addr
10169 @itemx -sectcreate
10170 @itemx -sectobjectsymbols
10171 @itemx -sectorder
10172 @itemx -segaddr
10173 @itemx -segs_read_only_addr
10174 @itemx -segs_read_write_addr
10175 @itemx -seg_addr_table
10176 @itemx -seg_addr_table_filename
10177 @itemx -seglinkedit
10178 @itemx -segprot
10179 @itemx -segs_read_only_addr
10180 @itemx -segs_read_write_addr
10181 @itemx -single_module
10182 @itemx -static
10183 @itemx -sub_library
10184 @itemx -sub_umbrella
10185 @itemx -twolevel_namespace
10186 @itemx -umbrella
10187 @itemx -undefined
10188 @itemx -unexported_symbols_list
10189 @itemx -weak_reference_mismatches
10190 @itemx -whatsloaded
10191 @opindex allowable_client
10192 @opindex client_name
10193 @opindex compatibility_version
10194 @opindex current_version
10195 @opindex dead_strip
10196 @opindex dependency-file
10197 @opindex dylib_file
10198 @opindex dylinker_install_name
10199 @opindex dynamic
10200 @opindex exported_symbols_list
10201 @opindex filelist
10202 @opindex flat_namespace
10203 @opindex force_flat_namespace
10204 @opindex headerpad_max_install_names
10205 @opindex image_base
10206 @opindex init
10207 @opindex install_name
10208 @opindex keep_private_externs
10209 @opindex multi_module
10210 @opindex multiply_defined
10211 @opindex multiply_defined_unused
10212 @opindex noall_load
10213 @opindex no_dead_strip_inits_and_terms
10214 @opindex nofixprebinding
10215 @opindex nomultidefs
10216 @opindex noprebind
10217 @opindex noseglinkedit
10218 @opindex pagezero_size
10219 @opindex prebind
10220 @opindex prebind_all_twolevel_modules
10221 @opindex private_bundle
10222 @opindex read_only_relocs
10223 @opindex sectalign
10224 @opindex sectobjectsymbols
10225 @opindex whyload
10226 @opindex seg1addr
10227 @opindex sectcreate
10228 @opindex sectobjectsymbols
10229 @opindex sectorder
10230 @opindex segaddr
10231 @opindex segs_read_only_addr
10232 @opindex segs_read_write_addr
10233 @opindex seg_addr_table
10234 @opindex seg_addr_table_filename
10235 @opindex seglinkedit
10236 @opindex segprot
10237 @opindex segs_read_only_addr
10238 @opindex segs_read_write_addr
10239 @opindex single_module
10240 @opindex static
10241 @opindex sub_library
10242 @opindex sub_umbrella
10243 @opindex twolevel_namespace
10244 @opindex umbrella
10245 @opindex undefined
10246 @opindex unexported_symbols_list
10247 @opindex weak_reference_mismatches
10248 @opindex whatsloaded
10249 These options are passed to the Darwin linker.  The Darwin linker man page
10250 describes them in detail.
10251 @end table
10253 @node DEC Alpha Options
10254 @subsection DEC Alpha Options
10256 These @samp{-m} options are defined for the DEC Alpha implementations:
10258 @table @gcctabopt
10259 @item -mno-soft-float
10260 @itemx -msoft-float
10261 @opindex mno-soft-float
10262 @opindex msoft-float
10263 Use (do not use) the hardware floating-point instructions for
10264 floating-point operations.  When @option{-msoft-float} is specified,
10265 functions in @file{libgcc.a} will be used to perform floating-point
10266 operations.  Unless they are replaced by routines that emulate the
10267 floating-point operations, or compiled in such a way as to call such
10268 emulations routines, these routines will issue floating-point
10269 operations.   If you are compiling for an Alpha without floating-point
10270 operations, you must ensure that the library is built so as not to call
10271 them.
10273 Note that Alpha implementations without floating-point operations are
10274 required to have floating-point registers.
10276 @item -mfp-reg
10277 @itemx -mno-fp-regs
10278 @opindex mfp-reg
10279 @opindex mno-fp-regs
10280 Generate code that uses (does not use) the floating-point register set.
10281 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10282 register set is not used, floating point operands are passed in integer
10283 registers as if they were integers and floating-point results are passed
10284 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10285 so any function with a floating-point argument or return value called by code
10286 compiled with @option{-mno-fp-regs} must also be compiled with that
10287 option.
10289 A typical use of this option is building a kernel that does not use,
10290 and hence need not save and restore, any floating-point registers.
10292 @item -mieee
10293 @opindex mieee
10294 The Alpha architecture implements floating-point hardware optimized for
10295 maximum performance.  It is mostly compliant with the IEEE floating
10296 point standard.  However, for full compliance, software assistance is
10297 required.  This option generates code fully IEEE compliant code
10298 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10299 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10300 defined during compilation.  The resulting code is less efficient but is
10301 able to correctly support denormalized numbers and exceptional IEEE
10302 values such as not-a-number and plus/minus infinity.  Other Alpha
10303 compilers call this option @option{-ieee_with_no_inexact}.
10305 @item -mieee-with-inexact
10306 @opindex mieee-with-inexact
10307 This is like @option{-mieee} except the generated code also maintains
10308 the IEEE @var{inexact-flag}.  Turning on this option causes the
10309 generated code to implement fully-compliant IEEE math.  In addition to
10310 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10311 macro.  On some Alpha implementations the resulting code may execute
10312 significantly slower than the code generated by default.  Since there is
10313 very little code that depends on the @var{inexact-flag}, you should
10314 normally not specify this option.  Other Alpha compilers call this
10315 option @option{-ieee_with_inexact}.
10317 @item -mfp-trap-mode=@var{trap-mode}
10318 @opindex mfp-trap-mode
10319 This option controls what floating-point related traps are enabled.
10320 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10321 The trap mode can be set to one of four values:
10323 @table @samp
10324 @item n
10325 This is the default (normal) setting.  The only traps that are enabled
10326 are the ones that cannot be disabled in software (e.g., division by zero
10327 trap).
10329 @item u
10330 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10331 as well.
10333 @item su
10334 Like @samp{u}, but the instructions are marked to be safe for software
10335 completion (see Alpha architecture manual for details).
10337 @item sui
10338 Like @samp{su}, but inexact traps are enabled as well.
10339 @end table
10341 @item -mfp-rounding-mode=@var{rounding-mode}
10342 @opindex mfp-rounding-mode
10343 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10344 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10347 @table @samp
10348 @item n
10349 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10350 the nearest machine number or towards the even machine number in case
10351 of a tie.
10353 @item m
10354 Round towards minus infinity.
10356 @item c
10357 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10359 @item d
10360 Dynamic rounding mode.  A field in the floating point control register
10361 (@var{fpcr}, see Alpha architecture reference manual) controls the
10362 rounding mode in effect.  The C library initializes this register for
10363 rounding towards plus infinity.  Thus, unless your program modifies the
10364 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10365 @end table
10367 @item -mtrap-precision=@var{trap-precision}
10368 @opindex mtrap-precision
10369 In the Alpha architecture, floating point traps are imprecise.  This
10370 means without software assistance it is impossible to recover from a
10371 floating trap and program execution normally needs to be terminated.
10372 GCC can generate code that can assist operating system trap handlers
10373 in determining the exact location that caused a floating point trap.
10374 Depending on the requirements of an application, different levels of
10375 precisions can be selected:
10377 @table @samp
10378 @item p
10379 Program precision.  This option is the default and means a trap handler
10380 can only identify which program caused a floating point exception.
10382 @item f
10383 Function precision.  The trap handler can determine the function that
10384 caused a floating point exception.
10386 @item i
10387 Instruction precision.  The trap handler can determine the exact
10388 instruction that caused a floating point exception.
10389 @end table
10391 Other Alpha compilers provide the equivalent options called
10392 @option{-scope_safe} and @option{-resumption_safe}.
10394 @item -mieee-conformant
10395 @opindex mieee-conformant
10396 This option marks the generated code as IEEE conformant.  You must not
10397 use this option unless you also specify @option{-mtrap-precision=i} and either
10398 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10399 is to emit the line @samp{.eflag 48} in the function prologue of the
10400 generated assembly file.  Under DEC Unix, this has the effect that
10401 IEEE-conformant math library routines will be linked in.
10403 @item -mbuild-constants
10404 @opindex mbuild-constants
10405 Normally GCC examines a 32- or 64-bit integer constant to
10406 see if it can construct it from smaller constants in two or three
10407 instructions.  If it cannot, it will output the constant as a literal and
10408 generate code to load it from the data segment at runtime.
10410 Use this option to require GCC to construct @emph{all} integer constants
10411 using code, even if it takes more instructions (the maximum is six).
10413 You would typically use this option to build a shared library dynamic
10414 loader.  Itself a shared library, it must relocate itself in memory
10415 before it can find the variables and constants in its own data segment.
10417 @item -malpha-as
10418 @itemx -mgas
10419 @opindex malpha-as
10420 @opindex mgas
10421 Select whether to generate code to be assembled by the vendor-supplied
10422 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10424 @item -mbwx
10425 @itemx -mno-bwx
10426 @itemx -mcix
10427 @itemx -mno-cix
10428 @itemx -mfix
10429 @itemx -mno-fix
10430 @itemx -mmax
10431 @itemx -mno-max
10432 @opindex mbwx
10433 @opindex mno-bwx
10434 @opindex mcix
10435 @opindex mno-cix
10436 @opindex mfix
10437 @opindex mno-fix
10438 @opindex mmax
10439 @opindex mno-max
10440 Indicate whether GCC should generate code to use the optional BWX,
10441 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10442 sets supported by the CPU type specified via @option{-mcpu=} option or that
10443 of the CPU on which GCC was built if none was specified.
10445 @item -mfloat-vax
10446 @itemx -mfloat-ieee
10447 @opindex mfloat-vax
10448 @opindex mfloat-ieee
10449 Generate code that uses (does not use) VAX F and G floating point
10450 arithmetic instead of IEEE single and double precision.
10452 @item -mexplicit-relocs
10453 @itemx -mno-explicit-relocs
10454 @opindex mexplicit-relocs
10455 @opindex mno-explicit-relocs
10456 Older Alpha assemblers provided no way to generate symbol relocations
10457 except via assembler macros.  Use of these macros does not allow
10458 optimal instruction scheduling.  GNU binutils as of version 2.12
10459 supports a new syntax that allows the compiler to explicitly mark
10460 which relocations should apply to which instructions.  This option
10461 is mostly useful for debugging, as GCC detects the capabilities of
10462 the assembler when it is built and sets the default accordingly.
10464 @item -msmall-data
10465 @itemx -mlarge-data
10466 @opindex msmall-data
10467 @opindex mlarge-data
10468 When @option{-mexplicit-relocs} is in effect, static data is
10469 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10470 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10471 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10472 16-bit relocations off of the @code{$gp} register.  This limits the
10473 size of the small data area to 64KB, but allows the variables to be
10474 directly accessed via a single instruction.
10476 The default is @option{-mlarge-data}.  With this option the data area
10477 is limited to just below 2GB@.  Programs that require more than 2GB of
10478 data must use @code{malloc} or @code{mmap} to allocate the data in the
10479 heap instead of in the program's data segment.
10481 When generating code for shared libraries, @option{-fpic} implies
10482 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10484 @item -msmall-text
10485 @itemx -mlarge-text
10486 @opindex msmall-text
10487 @opindex mlarge-text
10488 When @option{-msmall-text} is used, the compiler assumes that the
10489 code of the entire program (or shared library) fits in 4MB, and is
10490 thus reachable with a branch instruction.  When @option{-msmall-data}
10491 is used, the compiler can assume that all local symbols share the
10492 same @code{$gp} value, and thus reduce the number of instructions
10493 required for a function call from 4 to 1.
10495 The default is @option{-mlarge-text}.
10497 @item -mcpu=@var{cpu_type}
10498 @opindex mcpu
10499 Set the instruction set and instruction scheduling parameters for
10500 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10501 style name or the corresponding chip number.  GCC supports scheduling
10502 parameters for the EV4, EV5 and EV6 family of processors and will
10503 choose the default values for the instruction set from the processor
10504 you specify.  If you do not specify a processor type, GCC will default
10505 to the processor on which the compiler was built.
10507 Supported values for @var{cpu_type} are
10509 @table @samp
10510 @item ev4
10511 @itemx ev45
10512 @itemx 21064
10513 Schedules as an EV4 and has no instruction set extensions.
10515 @item ev5
10516 @itemx 21164
10517 Schedules as an EV5 and has no instruction set extensions.
10519 @item ev56
10520 @itemx 21164a
10521 Schedules as an EV5 and supports the BWX extension.
10523 @item pca56
10524 @itemx 21164pc
10525 @itemx 21164PC
10526 Schedules as an EV5 and supports the BWX and MAX extensions.
10528 @item ev6
10529 @itemx 21264
10530 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10532 @item ev67
10533 @itemx 21264a
10534 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10535 @end table
10537 Native Linux/GNU toolchains also support the value @samp{native},
10538 which selects the best architecture option for the host processor.
10539 @option{-mcpu=native} has no effect if GCC does not recognize
10540 the processor.
10542 @item -mtune=@var{cpu_type}
10543 @opindex mtune
10544 Set only the instruction scheduling parameters for machine type
10545 @var{cpu_type}.  The instruction set is not changed.
10547 Native Linux/GNU toolchains also support the value @samp{native},
10548 which selects the best architecture option for the host processor.
10549 @option{-mtune=native} has no effect if GCC does not recognize
10550 the processor.
10552 @item -mmemory-latency=@var{time}
10553 @opindex mmemory-latency
10554 Sets the latency the scheduler should assume for typical memory
10555 references as seen by the application.  This number is highly
10556 dependent on the memory access patterns used by the application
10557 and the size of the external cache on the machine.
10559 Valid options for @var{time} are
10561 @table @samp
10562 @item @var{number}
10563 A decimal number representing clock cycles.
10565 @item L1
10566 @itemx L2
10567 @itemx L3
10568 @itemx main
10569 The compiler contains estimates of the number of clock cycles for
10570 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10571 (also called Dcache, Scache, and Bcache), as well as to main memory.
10572 Note that L3 is only valid for EV5.
10574 @end table
10575 @end table
10577 @node DEC Alpha/VMS Options
10578 @subsection DEC Alpha/VMS Options
10580 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10582 @table @gcctabopt
10583 @item -mvms-return-codes
10584 @opindex mvms-return-codes
10585 Return VMS condition codes from main.  The default is to return POSIX
10586 style condition (e.g.@: error) codes.
10587 @end table
10589 @node FR30 Options
10590 @subsection FR30 Options
10591 @cindex FR30 Options
10593 These options are defined specifically for the FR30 port.
10595 @table @gcctabopt
10597 @item -msmall-model
10598 @opindex msmall-model
10599 Use the small address space model.  This can produce smaller code, but
10600 it does assume that all symbolic values and addresses will fit into a
10601 20-bit range.
10603 @item -mno-lsim
10604 @opindex mno-lsim
10605 Assume that run-time support has been provided and so there is no need
10606 to include the simulator library (@file{libsim.a}) on the linker
10607 command line.
10609 @end table
10611 @node FRV Options
10612 @subsection FRV Options
10613 @cindex FRV Options
10615 @table @gcctabopt
10616 @item -mgpr-32
10617 @opindex mgpr-32
10619 Only use the first 32 general purpose registers.
10621 @item -mgpr-64
10622 @opindex mgpr-64
10624 Use all 64 general purpose registers.
10626 @item -mfpr-32
10627 @opindex mfpr-32
10629 Use only the first 32 floating point registers.
10631 @item -mfpr-64
10632 @opindex mfpr-64
10634 Use all 64 floating point registers
10636 @item -mhard-float
10637 @opindex mhard-float
10639 Use hardware instructions for floating point operations.
10641 @item -msoft-float
10642 @opindex msoft-float
10644 Use library routines for floating point operations.
10646 @item -malloc-cc
10647 @opindex malloc-cc
10649 Dynamically allocate condition code registers.
10651 @item -mfixed-cc
10652 @opindex mfixed-cc
10654 Do not try to dynamically allocate condition code registers, only
10655 use @code{icc0} and @code{fcc0}.
10657 @item -mdword
10658 @opindex mdword
10660 Change ABI to use double word insns.
10662 @item -mno-dword
10663 @opindex mno-dword
10665 Do not use double word instructions.
10667 @item -mdouble
10668 @opindex mdouble
10670 Use floating point double instructions.
10672 @item -mno-double
10673 @opindex mno-double
10675 Do not use floating point double instructions.
10677 @item -mmedia
10678 @opindex mmedia
10680 Use media instructions.
10682 @item -mno-media
10683 @opindex mno-media
10685 Do not use media instructions.
10687 @item -mmuladd
10688 @opindex mmuladd
10690 Use multiply and add/subtract instructions.
10692 @item -mno-muladd
10693 @opindex mno-muladd
10695 Do not use multiply and add/subtract instructions.
10697 @item -mfdpic
10698 @opindex mfdpic
10700 Select the FDPIC ABI, that uses function descriptors to represent
10701 pointers to functions.  Without any PIC/PIE-related options, it
10702 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
10703 assumes GOT entries and small data are within a 12-bit range from the
10704 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
10705 are computed with 32 bits.
10706 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10708 @item -minline-plt
10709 @opindex minline-plt
10711 Enable inlining of PLT entries in function calls to functions that are
10712 not known to bind locally.  It has no effect without @option{-mfdpic}.
10713 It's enabled by default if optimizing for speed and compiling for
10714 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
10715 optimization option such as @option{-O3} or above is present in the
10716 command line.
10718 @item -mTLS
10719 @opindex mTLS
10721 Assume a large TLS segment when generating thread-local code.
10723 @item -mtls
10724 @opindex mtls
10726 Do not assume a large TLS segment when generating thread-local code.
10728 @item -mgprel-ro
10729 @opindex mgprel-ro
10731 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
10732 that is known to be in read-only sections.  It's enabled by default,
10733 except for @option{-fpic} or @option{-fpie}: even though it may help
10734 make the global offset table smaller, it trades 1 instruction for 4.
10735 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
10736 one of which may be shared by multiple symbols, and it avoids the need
10737 for a GOT entry for the referenced symbol, so it's more likely to be a
10738 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
10740 @item -multilib-library-pic
10741 @opindex multilib-library-pic
10743 Link with the (library, not FD) pic libraries.  It's implied by
10744 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
10745 @option{-fpic} without @option{-mfdpic}.  You should never have to use
10746 it explicitly.
10748 @item -mlinked-fp
10749 @opindex mlinked-fp
10751 Follow the EABI requirement of always creating a frame pointer whenever
10752 a stack frame is allocated.  This option is enabled by default and can
10753 be disabled with @option{-mno-linked-fp}.
10755 @item -mlong-calls
10756 @opindex mlong-calls
10758 Use indirect addressing to call functions outside the current
10759 compilation unit.  This allows the functions to be placed anywhere
10760 within the 32-bit address space.
10762 @item -malign-labels
10763 @opindex malign-labels
10765 Try to align labels to an 8-byte boundary by inserting nops into the
10766 previous packet.  This option only has an effect when VLIW packing
10767 is enabled.  It doesn't create new packets; it merely adds nops to
10768 existing ones.
10770 @item -mlibrary-pic
10771 @opindex mlibrary-pic
10773 Generate position-independent EABI code.
10775 @item -macc-4
10776 @opindex macc-4
10778 Use only the first four media accumulator registers.
10780 @item -macc-8
10781 @opindex macc-8
10783 Use all eight media accumulator registers.
10785 @item -mpack
10786 @opindex mpack
10788 Pack VLIW instructions.
10790 @item -mno-pack
10791 @opindex mno-pack
10793 Do not pack VLIW instructions.
10795 @item -mno-eflags
10796 @opindex mno-eflags
10798 Do not mark ABI switches in e_flags.
10800 @item -mcond-move
10801 @opindex mcond-move
10803 Enable the use of conditional-move instructions (default).
10805 This switch is mainly for debugging the compiler and will likely be removed
10806 in a future version.
10808 @item -mno-cond-move
10809 @opindex mno-cond-move
10811 Disable the use of conditional-move instructions.
10813 This switch is mainly for debugging the compiler and will likely be removed
10814 in a future version.
10816 @item -mscc
10817 @opindex mscc
10819 Enable the use of conditional set instructions (default).
10821 This switch is mainly for debugging the compiler and will likely be removed
10822 in a future version.
10824 @item -mno-scc
10825 @opindex mno-scc
10827 Disable the use of conditional set instructions.
10829 This switch is mainly for debugging the compiler and will likely be removed
10830 in a future version.
10832 @item -mcond-exec
10833 @opindex mcond-exec
10835 Enable the use of conditional execution (default).
10837 This switch is mainly for debugging the compiler and will likely be removed
10838 in a future version.
10840 @item -mno-cond-exec
10841 @opindex mno-cond-exec
10843 Disable the use of conditional execution.
10845 This switch is mainly for debugging the compiler and will likely be removed
10846 in a future version.
10848 @item -mvliw-branch
10849 @opindex mvliw-branch
10851 Run a pass to pack branches into VLIW instructions (default).
10853 This switch is mainly for debugging the compiler and will likely be removed
10854 in a future version.
10856 @item -mno-vliw-branch
10857 @opindex mno-vliw-branch
10859 Do not run a pass to pack branches into VLIW instructions.
10861 This switch is mainly for debugging the compiler and will likely be removed
10862 in a future version.
10864 @item -mmulti-cond-exec
10865 @opindex mmulti-cond-exec
10867 Enable optimization of @code{&&} and @code{||} in conditional execution
10868 (default).
10870 This switch is mainly for debugging the compiler and will likely be removed
10871 in a future version.
10873 @item -mno-multi-cond-exec
10874 @opindex mno-multi-cond-exec
10876 Disable optimization of @code{&&} and @code{||} in conditional execution.
10878 This switch is mainly for debugging the compiler and will likely be removed
10879 in a future version.
10881 @item -mnested-cond-exec
10882 @opindex mnested-cond-exec
10884 Enable nested conditional execution optimizations (default).
10886 This switch is mainly for debugging the compiler and will likely be removed
10887 in a future version.
10889 @item -mno-nested-cond-exec
10890 @opindex mno-nested-cond-exec
10892 Disable nested conditional execution optimizations.
10894 This switch is mainly for debugging the compiler and will likely be removed
10895 in a future version.
10897 @item -moptimize-membar
10898 @opindex moptimize-membar
10900 This switch removes redundant @code{membar} instructions from the
10901 compiler generated code.  It is enabled by default.
10903 @item -mno-optimize-membar
10904 @opindex mno-optimize-membar
10906 This switch disables the automatic removal of redundant @code{membar}
10907 instructions from the generated code.
10909 @item -mtomcat-stats
10910 @opindex mtomcat-stats
10912 Cause gas to print out tomcat statistics.
10914 @item -mcpu=@var{cpu}
10915 @opindex mcpu
10917 Select the processor type for which to generate code.  Possible values are
10918 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10919 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10921 @end table
10923 @node GNU/Linux Options
10924 @subsection GNU/Linux Options
10926 These @samp{-m} options are defined for GNU/Linux targets:
10928 @table @gcctabopt
10929 @item -mglibc
10930 @opindex mglibc
10931 Use the GNU C library instead of uClibc.  This is the default except
10932 on @samp{*-*-linux-*uclibc*} targets.
10934 @item -muclibc
10935 @opindex muclibc
10936 Use uClibc instead of the GNU C library.  This is the default on
10937 @samp{*-*-linux-*uclibc*} targets.
10938 @end table
10940 @node H8/300 Options
10941 @subsection H8/300 Options
10943 These @samp{-m} options are defined for the H8/300 implementations:
10945 @table @gcctabopt
10946 @item -mrelax
10947 @opindex mrelax
10948 Shorten some address references at link time, when possible; uses the
10949 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10950 ld, Using ld}, for a fuller description.
10952 @item -mh
10953 @opindex mh
10954 Generate code for the H8/300H@.
10956 @item -ms
10957 @opindex ms
10958 Generate code for the H8S@.
10960 @item -mn
10961 @opindex mn
10962 Generate code for the H8S and H8/300H in the normal mode.  This switch
10963 must be used either with @option{-mh} or @option{-ms}.
10965 @item -ms2600
10966 @opindex ms2600
10967 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10969 @item -mint32
10970 @opindex mint32
10971 Make @code{int} data 32 bits by default.
10973 @item -malign-300
10974 @opindex malign-300
10975 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10976 The default for the H8/300H and H8S is to align longs and floats on 4
10977 byte boundaries.
10978 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10979 This option has no effect on the H8/300.
10980 @end table
10982 @node HPPA Options
10983 @subsection HPPA Options
10984 @cindex HPPA Options
10986 These @samp{-m} options are defined for the HPPA family of computers:
10988 @table @gcctabopt
10989 @item -march=@var{architecture-type}
10990 @opindex march
10991 Generate code for the specified architecture.  The choices for
10992 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10993 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10994 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10995 architecture option for your machine.  Code compiled for lower numbered
10996 architectures will run on higher numbered architectures, but not the
10997 other way around.
10999 @item -mpa-risc-1-0
11000 @itemx -mpa-risc-1-1
11001 @itemx -mpa-risc-2-0
11002 @opindex mpa-risc-1-0
11003 @opindex mpa-risc-1-1
11004 @opindex mpa-risc-2-0
11005 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11007 @item -mbig-switch
11008 @opindex mbig-switch
11009 Generate code suitable for big switch tables.  Use this option only if
11010 the assembler/linker complain about out of range branches within a switch
11011 table.
11013 @item -mjump-in-delay
11014 @opindex mjump-in-delay
11015 Fill delay slots of function calls with unconditional jump instructions
11016 by modifying the return pointer for the function call to be the target
11017 of the conditional jump.
11019 @item -mdisable-fpregs
11020 @opindex mdisable-fpregs
11021 Prevent floating point registers from being used in any manner.  This is
11022 necessary for compiling kernels which perform lazy context switching of
11023 floating point registers.  If you use this option and attempt to perform
11024 floating point operations, the compiler will abort.
11026 @item -mdisable-indexing
11027 @opindex mdisable-indexing
11028 Prevent the compiler from using indexing address modes.  This avoids some
11029 rather obscure problems when compiling MIG generated code under MACH@.
11031 @item -mno-space-regs
11032 @opindex mno-space-regs
11033 Generate code that assumes the target has no space registers.  This allows
11034 GCC to generate faster indirect calls and use unscaled index address modes.
11036 Such code is suitable for level 0 PA systems and kernels.
11038 @item -mfast-indirect-calls
11039 @opindex mfast-indirect-calls
11040 Generate code that assumes calls never cross space boundaries.  This
11041 allows GCC to emit code which performs faster indirect calls.
11043 This option will not work in the presence of shared libraries or nested
11044 functions.
11046 @item -mfixed-range=@var{register-range}
11047 @opindex mfixed-range
11048 Generate code treating the given register range as fixed registers.
11049 A fixed register is one that the register allocator can not use.  This is
11050 useful when compiling kernel code.  A register range is specified as
11051 two registers separated by a dash.  Multiple register ranges can be
11052 specified separated by a comma.
11054 @item -mlong-load-store
11055 @opindex mlong-load-store
11056 Generate 3-instruction load and store sequences as sometimes required by
11057 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11058 the HP compilers.
11060 @item -mportable-runtime
11061 @opindex mportable-runtime
11062 Use the portable calling conventions proposed by HP for ELF systems.
11064 @item -mgas
11065 @opindex mgas
11066 Enable the use of assembler directives only GAS understands.
11068 @item -mschedule=@var{cpu-type}
11069 @opindex mschedule
11070 Schedule code according to the constraints for the machine type
11071 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11072 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11073 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11074 proper scheduling option for your machine.  The default scheduling is
11075 @samp{8000}.
11077 @item -mlinker-opt
11078 @opindex mlinker-opt
11079 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11080 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11081 linkers in which they give bogus error messages when linking some programs.
11083 @item -msoft-float
11084 @opindex msoft-float
11085 Generate output containing library calls for floating point.
11086 @strong{Warning:} the requisite libraries are not available for all HPPA
11087 targets.  Normally the facilities of the machine's usual C compiler are
11088 used, but this cannot be done directly in cross-compilation.  You must make
11089 your own arrangements to provide suitable library functions for
11090 cross-compilation.
11092 @option{-msoft-float} changes the calling convention in the output file;
11093 therefore, it is only useful if you compile @emph{all} of a program with
11094 this option.  In particular, you need to compile @file{libgcc.a}, the
11095 library that comes with GCC, with @option{-msoft-float} in order for
11096 this to work.
11098 @item -msio
11099 @opindex msio
11100 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11101 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11102 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11103 options are available under HP-UX and HI-UX@.
11105 @item -mgnu-ld
11106 @opindex mgnu-ld
11107 Use GNU ld specific options.  This passes @option{-shared} to ld when
11108 building a shared library.  It is the default when GCC is configured,
11109 explicitly or implicitly, with the GNU linker.  This option does not
11110 have any affect on which ld is called, it only changes what parameters
11111 are passed to that ld.  The ld that is called is determined by the
11112 @option{--with-ld} configure option, GCC's program search path, and
11113 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11114 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11115 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11117 @item -mhp-ld
11118 @opindex mhp-ld
11119 Use HP ld specific options.  This passes @option{-b} to ld when building
11120 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11121 links.  It is the default when GCC is configured, explicitly or
11122 implicitly, with the HP linker.  This option does not have any affect on
11123 which ld is called, it only changes what parameters are passed to that
11124 ld.  The ld that is called is determined by the @option{--with-ld}
11125 configure option, GCC's program search path, and finally by the user's
11126 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11127 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11128 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11130 @item -mlong-calls
11131 @opindex mno-long-calls
11132 Generate code that uses long call sequences.  This ensures that a call
11133 is always able to reach linker generated stubs.  The default is to generate
11134 long calls only when the distance from the call site to the beginning
11135 of the function or translation unit, as the case may be, exceeds a
11136 predefined limit set by the branch type being used.  The limits for
11137 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11138 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11139 240,000 bytes.
11141 Distances are measured from the beginning of functions when using the
11142 @option{-ffunction-sections} option, or when using the @option{-mgas}
11143 and @option{-mno-portable-runtime} options together under HP-UX with
11144 the SOM linker.
11146 It is normally not desirable to use this option as it will degrade
11147 performance.  However, it may be useful in large applications,
11148 particularly when partial linking is used to build the application.
11150 The types of long calls used depends on the capabilities of the
11151 assembler and linker, and the type of code being generated.  The
11152 impact on systems that support long absolute calls, and long pic
11153 symbol-difference or pc-relative calls should be relatively small.
11154 However, an indirect call is used on 32-bit ELF systems in pic code
11155 and it is quite long.
11157 @item -munix=@var{unix-std}
11158 @opindex march
11159 Generate compiler predefines and select a startfile for the specified
11160 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11161 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11162 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11163 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11164 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11165 and later.
11167 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11168 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11169 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11170 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11171 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11172 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11174 It is @emph{important} to note that this option changes the interfaces
11175 for various library routines.  It also affects the operational behavior
11176 of the C library.  Thus, @emph{extreme} care is needed in using this
11177 option.
11179 Library code that is intended to operate with more than one UNIX
11180 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11181 as appropriate.  Most GNU software doesn't provide this capability.
11183 @item -nolibdld
11184 @opindex nolibdld
11185 Suppress the generation of link options to search libdld.sl when the
11186 @option{-static} option is specified on HP-UX 10 and later.
11188 @item -static
11189 @opindex static
11190 The HP-UX implementation of setlocale in libc has a dependency on
11191 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11192 when the @option{-static} option is specified, special link options
11193 are needed to resolve this dependency.
11195 On HP-UX 10 and later, the GCC driver adds the necessary options to
11196 link with libdld.sl when the @option{-static} option is specified.
11197 This causes the resulting binary to be dynamic.  On the 64-bit port,
11198 the linkers generate dynamic binaries by default in any case.  The
11199 @option{-nolibdld} option can be used to prevent the GCC driver from
11200 adding these link options.
11202 @item -threads
11203 @opindex threads
11204 Add support for multithreading with the @dfn{dce thread} library
11205 under HP-UX@.  This option sets flags for both the preprocessor and
11206 linker.
11207 @end table
11209 @node i386 and x86-64 Options
11210 @subsection Intel 386 and AMD x86-64 Options
11211 @cindex i386 Options
11212 @cindex x86-64 Options
11213 @cindex Intel 386 Options
11214 @cindex AMD x86-64 Options
11216 These @samp{-m} options are defined for the i386 and x86-64 family of
11217 computers:
11219 @table @gcctabopt
11220 @item -mtune=@var{cpu-type}
11221 @opindex mtune
11222 Tune to @var{cpu-type} everything applicable about the generated code, except
11223 for the ABI and the set of available instructions.  The choices for
11224 @var{cpu-type} are:
11225 @table @emph
11226 @item generic
11227 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11228 If you know the CPU on which your code will run, then you should use
11229 the corresponding @option{-mtune} option instead of
11230 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11231 of your application will have, then you should use this option.
11233 As new processors are deployed in the marketplace, the behavior of this
11234 option will change.  Therefore, if you upgrade to a newer version of
11235 GCC, the code generated option will change to reflect the processors
11236 that were most common when that version of GCC was released.
11238 There is no @option{-march=generic} option because @option{-march}
11239 indicates the instruction set the compiler can use, and there is no
11240 generic instruction set applicable to all processors.  In contrast,
11241 @option{-mtune} indicates the processor (or, in this case, collection of
11242 processors) for which the code is optimized.
11243 @item native
11244 This selects the CPU to tune for at compilation time by determining
11245 the processor type of the compiling machine.  Using @option{-mtune=native}
11246 will produce code optimized for the local machine under the constraints
11247 of the selected instruction set.  Using @option{-march=native} will
11248 enable all instruction subsets supported by the local machine (hence
11249 the result might not run on different machines).
11250 @item i386
11251 Original Intel's i386 CPU@.
11252 @item i486
11253 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11254 @item i586, pentium
11255 Intel Pentium CPU with no MMX support.
11256 @item pentium-mmx
11257 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11258 @item pentiumpro
11259 Intel PentiumPro CPU@.
11260 @item i686
11261 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11262 instruction set will be used, so the code will run on all i686 family chips.
11263 @item pentium2
11264 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11265 @item pentium3, pentium3m
11266 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11267 support.
11268 @item pentium-m
11269 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11270 support.  Used by Centrino notebooks.
11271 @item pentium4, pentium4m
11272 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11273 @item prescott
11274 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11275 set support.
11276 @item nocona
11277 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11278 SSE2 and SSE3 instruction set support.
11279 @item core2
11280 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11281 instruction set support.
11282 @item atom
11283 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11284 instruction set support.
11285 @item k6
11286 AMD K6 CPU with MMX instruction set support.
11287 @item k6-2, k6-3
11288 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
11289 @item athlon, athlon-tbird
11290 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
11291 support.
11292 @item athlon-4, athlon-xp, athlon-mp
11293 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
11294 instruction set support.
11295 @item k8, opteron, athlon64, athlon-fx
11296 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11297 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
11298 @item k8-sse3, opteron-sse3, athlon64-sse3
11299 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11300 @item amdfam10, barcelona
11301 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11302 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
11303 instruction set extensions.)
11304 @item winchip-c6
11305 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11306 set support.
11307 @item winchip2
11308 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
11309 instruction set support.
11310 @item c3
11311 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
11312 implemented for this chip.)
11313 @item c3-2
11314 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11315 implemented for this chip.)
11316 @item geode
11317 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
11318 @end table
11320 While picking a specific @var{cpu-type} will schedule things appropriately
11321 for that particular chip, the compiler will not generate any code that
11322 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11323 being used.
11325 @item -march=@var{cpu-type}
11326 @opindex march
11327 Generate instructions for the machine type @var{cpu-type}.  The choices
11328 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11329 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11331 @item -mcpu=@var{cpu-type}
11332 @opindex mcpu
11333 A deprecated synonym for @option{-mtune}.
11335 @item -mfpmath=@var{unit}
11336 @opindex mfpmath
11337 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11338 for @var{unit} are:
11340 @table @samp
11341 @item 387
11342 Use the standard 387 floating point coprocessor present majority of chips and
11343 emulated otherwise.  Code compiled with this option will run almost everywhere.
11344 The temporary results are computed in 80bit precision instead of precision
11345 specified by the type resulting in slightly different results compared to most
11346 of other chips.  See @option{-ffloat-store} for more detailed description.
11348 This is the default choice for i386 compiler.
11350 @item sse
11351 Use scalar floating point instructions present in the SSE instruction set.
11352 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11353 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11354 instruction set supports only single precision arithmetics, thus the double and
11355 extended precision arithmetics is still done using 387.  Later version, present
11356 only in Pentium4 and the future AMD x86-64 chips supports double precision
11357 arithmetics too.
11359 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11360 or @option{-msse2} switches to enable SSE extensions and make this option
11361 effective.  For the x86-64 compiler, these extensions are enabled by default.
11363 The resulting code should be considerably faster in the majority of cases and avoid
11364 the numerical instability problems of 387 code, but may break some existing
11365 code that expects temporaries to be 80bit.
11367 This is the default choice for the x86-64 compiler.
11369 @item sse,387
11370 @itemx sse+387
11371 @itemx both
11372 Attempt to utilize both instruction sets at once.  This effectively double the
11373 amount of available registers and on chips with separate execution units for
11374 387 and SSE the execution resources too.  Use this option with care, as it is
11375 still experimental, because the GCC register allocator does not model separate
11376 functional units well resulting in instable performance.
11377 @end table
11379 @item -masm=@var{dialect}
11380 @opindex masm=@var{dialect}
11381 Output asm instructions using selected @var{dialect}.  Supported
11382 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11383 not support @samp{intel}.
11385 @item -mieee-fp
11386 @itemx -mno-ieee-fp
11387 @opindex mieee-fp
11388 @opindex mno-ieee-fp
11389 Control whether or not the compiler uses IEEE floating point
11390 comparisons.  These handle correctly the case where the result of a
11391 comparison is unordered.
11393 @item -msoft-float
11394 @opindex msoft-float
11395 Generate output containing library calls for floating point.
11396 @strong{Warning:} the requisite libraries are not part of GCC@.
11397 Normally the facilities of the machine's usual C compiler are used, but
11398 this can't be done directly in cross-compilation.  You must make your
11399 own arrangements to provide suitable library functions for
11400 cross-compilation.
11402 On machines where a function returns floating point results in the 80387
11403 register stack, some floating point opcodes may be emitted even if
11404 @option{-msoft-float} is used.
11406 @item -mno-fp-ret-in-387
11407 @opindex mno-fp-ret-in-387
11408 Do not use the FPU registers for return values of functions.
11410 The usual calling convention has functions return values of types
11411 @code{float} and @code{double} in an FPU register, even if there
11412 is no FPU@.  The idea is that the operating system should emulate
11413 an FPU@.
11415 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11416 in ordinary CPU registers instead.
11418 @item -mno-fancy-math-387
11419 @opindex mno-fancy-math-387
11420 Some 387 emulators do not support the @code{sin}, @code{cos} and
11421 @code{sqrt} instructions for the 387.  Specify this option to avoid
11422 generating those instructions.  This option is the default on FreeBSD,
11423 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11424 indicates that the target cpu will always have an FPU and so the
11425 instruction will not need emulation.  As of revision 2.6.1, these
11426 instructions are not generated unless you also use the
11427 @option{-funsafe-math-optimizations} switch.
11429 @item -malign-double
11430 @itemx -mno-align-double
11431 @opindex malign-double
11432 @opindex mno-align-double
11433 Control whether GCC aligns @code{double}, @code{long double}, and
11434 @code{long long} variables on a two word boundary or a one word
11435 boundary.  Aligning @code{double} variables on a two word boundary will
11436 produce code that runs somewhat faster on a @samp{Pentium} at the
11437 expense of more memory.
11439 On x86-64, @option{-malign-double} is enabled by default.
11441 @strong{Warning:} if you use the @option{-malign-double} switch,
11442 structures containing the above types will be aligned differently than
11443 the published application binary interface specifications for the 386
11444 and will not be binary compatible with structures in code compiled
11445 without that switch.
11447 @item -m96bit-long-double
11448 @itemx -m128bit-long-double
11449 @opindex m96bit-long-double
11450 @opindex m128bit-long-double
11451 These switches control the size of @code{long double} type.  The i386
11452 application binary interface specifies the size to be 96 bits,
11453 so @option{-m96bit-long-double} is the default in 32 bit mode.
11455 Modern architectures (Pentium and newer) would prefer @code{long double}
11456 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11457 conforming to the ABI, this would not be possible.  So specifying a
11458 @option{-m128bit-long-double} will align @code{long double}
11459 to a 16 byte boundary by padding the @code{long double} with an additional
11460 32 bit zero.
11462 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11463 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11465 Notice that neither of these options enable any extra precision over the x87
11466 standard of 80 bits for a @code{long double}.
11468 @strong{Warning:} if you override the default value for your target ABI, the
11469 structures and arrays containing @code{long double} variables will change
11470 their size as well as function calling convention for function taking
11471 @code{long double} will be modified.  Hence they will not be binary
11472 compatible with arrays or structures in code compiled without that switch.
11474 @item -mlarge-data-threshold=@var{number}
11475 @opindex mlarge-data-threshold=@var{number}
11476 When @option{-mcmodel=medium} is specified, the data greater than
11477 @var{threshold} are placed in large data section.  This value must be the
11478 same across all object linked into the binary and defaults to 65535.
11480 @item -mrtd
11481 @opindex mrtd
11482 Use a different function-calling convention, in which functions that
11483 take a fixed number of arguments return with the @code{ret} @var{num}
11484 instruction, which pops their arguments while returning.  This saves one
11485 instruction in the caller since there is no need to pop the arguments
11486 there.
11488 You can specify that an individual function is called with this calling
11489 sequence with the function attribute @samp{stdcall}.  You can also
11490 override the @option{-mrtd} option by using the function attribute
11491 @samp{cdecl}.  @xref{Function Attributes}.
11493 @strong{Warning:} this calling convention is incompatible with the one
11494 normally used on Unix, so you cannot use it if you need to call
11495 libraries compiled with the Unix compiler.
11497 Also, you must provide function prototypes for all functions that
11498 take variable numbers of arguments (including @code{printf});
11499 otherwise incorrect code will be generated for calls to those
11500 functions.
11502 In addition, seriously incorrect code will result if you call a
11503 function with too many arguments.  (Normally, extra arguments are
11504 harmlessly ignored.)
11506 @item -mregparm=@var{num}
11507 @opindex mregparm
11508 Control how many registers are used to pass integer arguments.  By
11509 default, no registers are used to pass arguments, and at most 3
11510 registers can be used.  You can control this behavior for a specific
11511 function by using the function attribute @samp{regparm}.
11512 @xref{Function Attributes}.
11514 @strong{Warning:} if you use this switch, and
11515 @var{num} is nonzero, then you must build all modules with the same
11516 value, including any libraries.  This includes the system libraries and
11517 startup modules.
11519 @item -msseregparm
11520 @opindex msseregparm
11521 Use SSE register passing conventions for float and double arguments
11522 and return values.  You can control this behavior for a specific
11523 function by using the function attribute @samp{sseregparm}.
11524 @xref{Function Attributes}.
11526 @strong{Warning:} if you use this switch then you must build all
11527 modules with the same value, including any libraries.  This includes
11528 the system libraries and startup modules.
11530 @item -mpc32
11531 @itemx -mpc64
11532 @itemx -mpc80
11533 @opindex mpc32
11534 @opindex mpc64
11535 @opindex mpc80
11537 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11538 is specified, the significands of results of floating-point operations are
11539 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11540 significands of results of floating-point operations to 53 bits (double
11541 precision) and @option{-mpc80} rounds the significands of results of
11542 floating-point operations to 64 bits (extended double precision), which is
11543 the default.  When this option is used, floating-point operations in higher
11544 precisions are not available to the programmer without setting the FPU
11545 control word explicitly.
11547 Setting the rounding of floating-point operations to less than the default
11548 80 bits can speed some programs by 2% or more.  Note that some mathematical
11549 libraries assume that extended precision (80 bit) floating-point operations
11550 are enabled by default; routines in such libraries could suffer significant
11551 loss of accuracy, typically through so-called "catastrophic cancellation",
11552 when this option is used to set the precision to less than extended precision.
11554 @item -mstackrealign
11555 @opindex mstackrealign
11556 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11557 option will generate an alternate prologue and epilogue that realigns the
11558 runtime stack if necessary.  This supports mixing legacy codes that keep
11559 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11560 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11561 applicable to individual functions.
11563 @item -mpreferred-stack-boundary=@var{num}
11564 @opindex mpreferred-stack-boundary
11565 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11566 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11567 the default is 4 (16 bytes or 128 bits).
11569 @item -mincoming-stack-boundary=@var{num}
11570 @opindex mincoming-stack-boundary
11571 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11572 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11573 the one specified by @option{-mpreferred-stack-boundary} will be used.
11575 On Pentium and PentiumPro, @code{double} and @code{long double} values
11576 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11577 suffer significant run time performance penalties.  On Pentium III, the
11578 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11579 properly if it is not 16 byte aligned.
11581 To ensure proper alignment of this values on the stack, the stack boundary
11582 must be as aligned as that required by any value stored on the stack.
11583 Further, every function must be generated such that it keeps the stack
11584 aligned.  Thus calling a function compiled with a higher preferred
11585 stack boundary from a function compiled with a lower preferred stack
11586 boundary will most likely misalign the stack.  It is recommended that
11587 libraries that use callbacks always use the default setting.
11589 This extra alignment does consume extra stack space, and generally
11590 increases code size.  Code that is sensitive to stack space usage, such
11591 as embedded systems and operating system kernels, may want to reduce the
11592 preferred alignment to @option{-mpreferred-stack-boundary=2}.
11594 @item -mmmx
11595 @itemx -mno-mmx
11596 @itemx -msse
11597 @itemx -mno-sse
11598 @itemx -msse2
11599 @itemx -mno-sse2
11600 @itemx -msse3
11601 @itemx -mno-sse3
11602 @itemx -mssse3
11603 @itemx -mno-ssse3
11604 @itemx -msse4.1
11605 @itemx -mno-sse4.1
11606 @itemx -msse4.2
11607 @itemx -mno-sse4.2
11608 @itemx -msse4
11609 @itemx -mno-sse4
11610 @itemx -mavx
11611 @itemx -mno-avx
11612 @itemx -maes
11613 @itemx -mno-aes
11614 @itemx -mpclmul
11615 @itemx -mno-pclmul
11616 @itemx -msse4a
11617 @itemx -mno-sse4a
11618 @itemx -msse5
11619 @itemx -mno-sse5
11620 @itemx -m3dnow
11621 @itemx -mno-3dnow
11622 @itemx -mpopcnt
11623 @itemx -mno-popcnt
11624 @itemx -mabm
11625 @itemx -mno-abm
11626 @opindex mmmx
11627 @opindex mno-mmx
11628 @opindex msse
11629 @opindex mno-sse
11630 @opindex m3dnow
11631 @opindex mno-3dnow
11632 These switches enable or disable the use of instructions in the MMX,
11633 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, SSE5, ABM or
11634 3DNow!@: extended instruction sets.
11635 These extensions are also available as built-in functions: see
11636 @ref{X86 Built-in Functions}, for details of the functions enabled and
11637 disabled by these switches.
11639 To have SSE/SSE2 instructions generated automatically from floating-point
11640 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
11642 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
11643 generates new AVX instructions or AVX equivalence for all SSEx instructions
11644 when needed.
11646 These options will enable GCC to use these extended instructions in
11647 generated code, even without @option{-mfpmath=sse}.  Applications which
11648 perform runtime CPU detection must compile separate files for each
11649 supported architecture, using the appropriate flags.  In particular,
11650 the file containing the CPU detection code should be compiled without
11651 these options.
11653 @item -mcld
11654 @opindex mcld
11655 This option instructs GCC to emit a @code{cld} instruction in the prologue
11656 of functions that use string instructions.  String instructions depend on
11657 the DF flag to select between autoincrement or autodecrement mode.  While the
11658 ABI specifies the DF flag to be cleared on function entry, some operating
11659 systems violate this specification by not clearing the DF flag in their
11660 exception dispatchers.  The exception handler can be invoked with the DF flag
11661 set which leads to wrong direction mode, when string instructions are used.
11662 This option can be enabled by default on 32-bit x86 targets by configuring
11663 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
11664 instructions can be suppressed with the @option{-mno-cld} compiler option
11665 in this case.
11667 @item -mcx16
11668 @opindex mcx16
11669 This option will enable GCC to use CMPXCHG16B instruction in generated code.
11670 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
11671 data types.  This is useful for high resolution counters that could be updated
11672 by multiple processors (or cores).  This instruction is generated as part of
11673 atomic built-in functions: see @ref{Atomic Builtins} for details.
11675 @item -msahf
11676 @opindex msahf
11677 This option will enable GCC to use SAHF instruction in generated 64-bit code.
11678 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
11679 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
11680 SAHF are load and store instructions, respectively, for certain status flags.
11681 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
11682 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
11684 @item -mmovbe
11685 @opindex mmovbe
11686 This option will enable GCC to use movbe instruction to implement
11687 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
11689 @item -mcrc32
11690 @opindex mcrc32
11691 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
11692 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
11693 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
11695 @item -mrecip
11696 @opindex mrecip
11697 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
11698 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
11699 to increase precision instead of DIVSS and SQRTSS (and their vectorized
11700 variants) for single precision floating point arguments.  These instructions
11701 are generated only when @option{-funsafe-math-optimizations} is enabled
11702 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
11703 Note that while the throughput of the sequence is higher than the throughput
11704 of the non-reciprocal instruction, the precision of the sequence can be
11705 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
11707 @item -mveclibabi=@var{type}
11708 @opindex mveclibabi
11709 Specifies the ABI type to use for vectorizing intrinsics using an
11710 external library.  Supported types are @code{svml} for the Intel short
11711 vector math library and @code{acml} for the AMD math core library style
11712 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
11713 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
11714 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
11715 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
11716 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
11717 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
11718 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
11719 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
11720 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
11721 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
11722 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
11723 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
11724 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
11725 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
11726 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
11727 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
11728 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
11729 compatible library will have to be specified at link time.
11731 @item -mabi=@var{name}
11732 @opindex mabi
11733 Generate code for the specified calling convention.  Permissible values
11734 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
11735 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
11736 ABI when targeting Windows.  On all other systems, the default is the
11737 SYSV ABI.  You can control this behavior for a specific function by
11738 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
11739 @xref{Function Attributes}.
11741 @item -mpush-args
11742 @itemx -mno-push-args
11743 @opindex mpush-args
11744 @opindex mno-push-args
11745 Use PUSH operations to store outgoing parameters.  This method is shorter
11746 and usually equally fast as method using SUB/MOV operations and is enabled
11747 by default.  In some cases disabling it may improve performance because of
11748 improved scheduling and reduced dependencies.
11750 @item -maccumulate-outgoing-args
11751 @opindex maccumulate-outgoing-args
11752 If enabled, the maximum amount of space required for outgoing arguments will be
11753 computed in the function prologue.  This is faster on most modern CPUs
11754 because of reduced dependencies, improved scheduling and reduced stack usage
11755 when preferred stack boundary is not equal to 2.  The drawback is a notable
11756 increase in code size.  This switch implies @option{-mno-push-args}.
11758 @item -mthreads
11759 @opindex mthreads
11760 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
11761 on thread-safe exception handling must compile and link all code with the
11762 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
11763 @option{-D_MT}; when linking, it links in a special thread helper library
11764 @option{-lmingwthrd} which cleans up per thread exception handling data.
11766 @item -mno-align-stringops
11767 @opindex mno-align-stringops
11768 Do not align destination of inlined string operations.  This switch reduces
11769 code size and improves performance in case the destination is already aligned,
11770 but GCC doesn't know about it.
11772 @item -minline-all-stringops
11773 @opindex minline-all-stringops
11774 By default GCC inlines string operations only when destination is known to be
11775 aligned at least to 4 byte boundary.  This enables more inlining, increase code
11776 size, but may improve performance of code that depends on fast memcpy, strlen
11777 and memset for short lengths.
11779 @item -minline-stringops-dynamically
11780 @opindex minline-stringops-dynamically
11781 For string operation of unknown size, inline runtime checks so for small
11782 blocks inline code is used, while for large blocks library call is used.
11784 @item -mstringop-strategy=@var{alg}
11785 @opindex mstringop-strategy=@var{alg}
11786 Overwrite internal decision heuristic about particular algorithm to inline
11787 string operation with.  The allowed values are @code{rep_byte},
11788 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
11789 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
11790 expanding inline loop, @code{libcall} for always expanding library call.
11792 @item -momit-leaf-frame-pointer
11793 @opindex momit-leaf-frame-pointer
11794 Don't keep the frame pointer in a register for leaf functions.  This
11795 avoids the instructions to save, set up and restore frame pointers and
11796 makes an extra register available in leaf functions.  The option
11797 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11798 which might make debugging harder.
11800 @item -mtls-direct-seg-refs
11801 @itemx -mno-tls-direct-seg-refs
11802 @opindex mtls-direct-seg-refs
11803 Controls whether TLS variables may be accessed with offsets from the
11804 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
11805 or whether the thread base pointer must be added.  Whether or not this
11806 is legal depends on the operating system, and whether it maps the
11807 segment to cover the entire TLS area.
11809 For systems that use GNU libc, the default is on.
11811 @item -mfused-madd
11812 @itemx -mno-fused-madd
11813 @opindex mfused-madd
11814 Enable automatic generation of fused floating point multiply-add instructions
11815 if the ISA supports such instructions.  The -mfused-madd option is on by
11816 default.  The fused multiply-add instructions have a different
11817 rounding behavior compared to executing a multiply followed by an add.
11819 @item -msse2avx
11820 @itemx -mno-sse2avx
11821 @opindex msse2avx
11822 Specify that the assembler should encode SSE instructions with VEX
11823 prefix.  The option @option{-mavx} turns this on by default.
11824 @end table
11826 These @samp{-m} switches are supported in addition to the above
11827 on AMD x86-64 processors in 64-bit environments.
11829 @table @gcctabopt
11830 @item -m32
11831 @itemx -m64
11832 @opindex m32
11833 @opindex m64
11834 Generate code for a 32-bit or 64-bit environment.
11835 The 32-bit environment sets int, long and pointer to 32 bits and
11836 generates code that runs on any i386 system.
11837 The 64-bit environment sets int to 32 bits and long and pointer
11838 to 64 bits and generates code for AMD's x86-64 architecture. For
11839 darwin only the -m64 option turns off the @option{-fno-pic} and
11840 @option{-mdynamic-no-pic} options.
11842 @item -mno-red-zone
11843 @opindex mno-red-zone
11844 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11845 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11846 stack pointer that will not be modified by signal or interrupt handlers
11847 and therefore can be used for temporary data without adjusting the stack
11848 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11850 @item -mcmodel=small
11851 @opindex mcmodel=small
11852 Generate code for the small code model: the program and its symbols must
11853 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11854 Programs can be statically or dynamically linked.  This is the default
11855 code model.
11857 @item -mcmodel=kernel
11858 @opindex mcmodel=kernel
11859 Generate code for the kernel code model.  The kernel runs in the
11860 negative 2 GB of the address space.
11861 This model has to be used for Linux kernel code.
11863 @item -mcmodel=medium
11864 @opindex mcmodel=medium
11865 Generate code for the medium model: The program is linked in the lower 2
11866 GB of the address space.  Small symbols are also placed there.  Symbols
11867 with sizes larger than @option{-mlarge-data-threshold} are put into
11868 large data or bss sections and can be located above 2GB.  Programs can
11869 be statically or dynamically linked.
11871 @item -mcmodel=large
11872 @opindex mcmodel=large
11873 Generate code for the large model: This model makes no assumptions
11874 about addresses and sizes of sections.
11875 @end table
11877 @node IA-64 Options
11878 @subsection IA-64 Options
11879 @cindex IA-64 Options
11881 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11883 @table @gcctabopt
11884 @item -mbig-endian
11885 @opindex mbig-endian
11886 Generate code for a big endian target.  This is the default for HP-UX@.
11888 @item -mlittle-endian
11889 @opindex mlittle-endian
11890 Generate code for a little endian target.  This is the default for AIX5
11891 and GNU/Linux.
11893 @item -mgnu-as
11894 @itemx -mno-gnu-as
11895 @opindex mgnu-as
11896 @opindex mno-gnu-as
11897 Generate (or don't) code for the GNU assembler.  This is the default.
11898 @c Also, this is the default if the configure option @option{--with-gnu-as}
11899 @c is used.
11901 @item -mgnu-ld
11902 @itemx -mno-gnu-ld
11903 @opindex mgnu-ld
11904 @opindex mno-gnu-ld
11905 Generate (or don't) code for the GNU linker.  This is the default.
11906 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11907 @c is used.
11909 @item -mno-pic
11910 @opindex mno-pic
11911 Generate code that does not use a global pointer register.  The result
11912 is not position independent code, and violates the IA-64 ABI@.
11914 @item -mvolatile-asm-stop
11915 @itemx -mno-volatile-asm-stop
11916 @opindex mvolatile-asm-stop
11917 @opindex mno-volatile-asm-stop
11918 Generate (or don't) a stop bit immediately before and after volatile asm
11919 statements.
11921 @item -mregister-names
11922 @itemx -mno-register-names
11923 @opindex mregister-names
11924 @opindex mno-register-names
11925 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11926 the stacked registers.  This may make assembler output more readable.
11928 @item -mno-sdata
11929 @itemx -msdata
11930 @opindex mno-sdata
11931 @opindex msdata
11932 Disable (or enable) optimizations that use the small data section.  This may
11933 be useful for working around optimizer bugs.
11935 @item -mconstant-gp
11936 @opindex mconstant-gp
11937 Generate code that uses a single constant global pointer value.  This is
11938 useful when compiling kernel code.
11940 @item -mauto-pic
11941 @opindex mauto-pic
11942 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11943 This is useful when compiling firmware code.
11945 @item -minline-float-divide-min-latency
11946 @opindex minline-float-divide-min-latency
11947 Generate code for inline divides of floating point values
11948 using the minimum latency algorithm.
11950 @item -minline-float-divide-max-throughput
11951 @opindex minline-float-divide-max-throughput
11952 Generate code for inline divides of floating point values
11953 using the maximum throughput algorithm.
11955 @item -mno-inline-float-divide
11956 @opindex mno-inline-float-divide
11957 Do not generate inline code for divides of floating point values.
11959 @item -minline-int-divide-min-latency
11960 @opindex minline-int-divide-min-latency
11961 Generate code for inline divides of integer values
11962 using the minimum latency algorithm.
11964 @item -minline-int-divide-max-throughput
11965 @opindex minline-int-divide-max-throughput
11966 Generate code for inline divides of integer values
11967 using the maximum throughput algorithm.
11969 @item -mno-inline-int-divide
11970 @opindex mno-inline-int-divide
11971 Do not generate inline code for divides of integer values.
11973 @item -minline-sqrt-min-latency
11974 @opindex minline-sqrt-min-latency
11975 Generate code for inline square roots
11976 using the minimum latency algorithm.
11978 @item -minline-sqrt-max-throughput
11979 @opindex minline-sqrt-max-throughput
11980 Generate code for inline square roots
11981 using the maximum throughput algorithm.
11983 @item -mno-inline-sqrt
11984 @opindex mno-inline-sqrt
11985 Do not generate inline code for sqrt.
11987 @item -mfused-madd
11988 @itemx -mno-fused-madd
11989 @opindex mfused-madd
11990 @opindex mno-fused-madd
11991 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
11992 instructions.    The default is to use these instructions.
11994 @item -mno-dwarf2-asm
11995 @itemx -mdwarf2-asm
11996 @opindex mno-dwarf2-asm
11997 @opindex mdwarf2-asm
11998 Don't (or do) generate assembler code for the DWARF2 line number debugging
11999 info.  This may be useful when not using the GNU assembler.
12001 @item -mearly-stop-bits
12002 @itemx -mno-early-stop-bits
12003 @opindex mearly-stop-bits
12004 @opindex mno-early-stop-bits
12005 Allow stop bits to be placed earlier than immediately preceding the
12006 instruction that triggered the stop bit.  This can improve instruction
12007 scheduling, but does not always do so.
12009 @item -mfixed-range=@var{register-range}
12010 @opindex mfixed-range
12011 Generate code treating the given register range as fixed registers.
12012 A fixed register is one that the register allocator can not use.  This is
12013 useful when compiling kernel code.  A register range is specified as
12014 two registers separated by a dash.  Multiple register ranges can be
12015 specified separated by a comma.
12017 @item -mtls-size=@var{tls-size}
12018 @opindex mtls-size
12019 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12022 @item -mtune=@var{cpu-type}
12023 @opindex mtune
12024 Tune the instruction scheduling for a particular CPU, Valid values are
12025 itanium, itanium1, merced, itanium2, and mckinley.
12027 @item -milp32
12028 @itemx -mlp64
12029 @opindex milp32
12030 @opindex mlp64
12031 Generate code for a 32-bit or 64-bit environment.
12032 The 32-bit environment sets int, long and pointer to 32 bits.
12033 The 64-bit environment sets int to 32 bits and long and pointer
12034 to 64 bits.  These are HP-UX specific flags.
12036 @item -mno-sched-br-data-spec
12037 @itemx -msched-br-data-spec
12038 @opindex mno-sched-br-data-spec
12039 @opindex msched-br-data-spec
12040 (Dis/En)able data speculative scheduling before reload.
12041 This will result in generation of the ld.a instructions and
12042 the corresponding check instructions (ld.c / chk.a).
12043 The default is 'disable'.
12045 @item -msched-ar-data-spec
12046 @itemx -mno-sched-ar-data-spec
12047 @opindex msched-ar-data-spec
12048 @opindex mno-sched-ar-data-spec
12049 (En/Dis)able data speculative scheduling after reload.
12050 This will result in generation of the ld.a instructions and
12051 the corresponding check instructions (ld.c / chk.a).
12052 The default is 'enable'.
12054 @item -mno-sched-control-spec
12055 @itemx -msched-control-spec
12056 @opindex mno-sched-control-spec
12057 @opindex msched-control-spec
12058 (Dis/En)able control speculative scheduling.  This feature is
12059 available only during region scheduling (i.e.@: before reload).
12060 This will result in generation of the ld.s instructions and
12061 the corresponding check instructions chk.s .
12062 The default is 'disable'.
12064 @item -msched-br-in-data-spec
12065 @itemx -mno-sched-br-in-data-spec
12066 @opindex msched-br-in-data-spec
12067 @opindex mno-sched-br-in-data-spec
12068 (En/Dis)able speculative scheduling of the instructions that
12069 are dependent on the data speculative loads before reload.
12070 This is effective only with @option{-msched-br-data-spec} enabled.
12071 The default is 'enable'.
12073 @item -msched-ar-in-data-spec
12074 @itemx -mno-sched-ar-in-data-spec
12075 @opindex msched-ar-in-data-spec
12076 @opindex mno-sched-ar-in-data-spec
12077 (En/Dis)able speculative scheduling of the instructions that
12078 are dependent on the data speculative loads after reload.
12079 This is effective only with @option{-msched-ar-data-spec} enabled.
12080 The default is 'enable'.
12082 @item -msched-in-control-spec
12083 @itemx -mno-sched-in-control-spec
12084 @opindex msched-in-control-spec
12085 @opindex mno-sched-in-control-spec
12086 (En/Dis)able speculative scheduling of the instructions that
12087 are dependent on the control speculative loads.
12088 This is effective only with @option{-msched-control-spec} enabled.
12089 The default is 'enable'.
12091 @item -mno-sched-prefer-non-data-spec-insns
12092 @itemx -msched-prefer-non-data-spec-insns
12093 @opindex mno-sched-prefer-non-data-spec-insns
12094 @opindex msched-prefer-non-data-spec-insns
12095 If enabled, data speculative instructions will be chosen for schedule
12096 only if there are no other choices at the moment.  This will make
12097 the use of the data speculation much more conservative.
12098 The default is 'disable'.
12100 @item -mno-sched-prefer-non-control-spec-insns
12101 @itemx -msched-prefer-non-control-spec-insns
12102 @opindex mno-sched-prefer-non-control-spec-insns
12103 @opindex msched-prefer-non-control-spec-insns
12104 If enabled, control speculative instructions will be chosen for schedule
12105 only if there are no other choices at the moment.  This will make
12106 the use of the control speculation much more conservative.
12107 The default is 'disable'.
12109 @item -mno-sched-count-spec-in-critical-path
12110 @itemx -msched-count-spec-in-critical-path
12111 @opindex mno-sched-count-spec-in-critical-path
12112 @opindex msched-count-spec-in-critical-path
12113 If enabled, speculative dependencies will be considered during
12114 computation of the instructions priorities.  This will make the use of the
12115 speculation a bit more conservative.
12116 The default is 'disable'.
12118 @item -msched-spec-ldc
12119 @opindex msched-spec-ldc
12120 Use a simple data speculation check.  This option is on by default.
12122 @item -msched-control-spec-ldc
12123 @opindex msched-spec-ldc
12124 Use a simple check for control speculation.  This option is on by default.
12126 @item -msched-stop-bits-after-every-cycle
12127 @opindex msched-stop-bits-after-every-cycle
12128 Place a stop bit after every cycle when scheduling.  This option is on
12129 by default.
12131 @item -msched-fp-mem-deps-zero-cost
12132 @opindex msched-fp-mem-deps-zero-cost
12133 Assume that floating-point stores and loads are not likely to cause a conflict
12134 when placed into the same instruction group.  This option is disabled by
12135 default.
12137 @item -msel-sched-dont-check-control-spec
12138 @opindex msel-sched-dont-check-control-spec
12139 Generate checks for control speculation in selective scheduling.
12140 This flag is disabled by default.
12142 @item -msched-max-memory-insns=@var{max-insns}
12143 @opindex msched-max-memory-insns
12144 Limit on the number of memory insns per instruction group, giving lower
12145 priority to subsequent memory insns attempting to schedule in the same
12146 instruction group. Frequently useful to prevent cache bank conflicts.
12147 The default value is 1.
12149 @item -msched-max-memory-insns-hard-limit
12150 @opindex msched-max-memory-insns-hard-limit
12151 Disallow more than `msched-max-memory-insns' in instruction group.
12152 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12153 when limit is reached but may still schedule memory operations.
12155 @end table
12157 @node M32C Options
12158 @subsection M32C Options
12159 @cindex M32C options
12161 @table @gcctabopt
12162 @item -mcpu=@var{name}
12163 @opindex mcpu=
12164 Select the CPU for which code is generated.  @var{name} may be one of
12165 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12166 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12167 the M32C/80 series.
12169 @item -msim
12170 @opindex msim
12171 Specifies that the program will be run on the simulator.  This causes
12172 an alternate runtime library to be linked in which supports, for
12173 example, file I/O@.  You must not use this option when generating
12174 programs that will run on real hardware; you must provide your own
12175 runtime library for whatever I/O functions are needed.
12177 @item -memregs=@var{number}
12178 @opindex memregs=
12179 Specifies the number of memory-based pseudo-registers GCC will use
12180 during code generation.  These pseudo-registers will be used like real
12181 registers, so there is a tradeoff between GCC's ability to fit the
12182 code into available registers, and the performance penalty of using
12183 memory instead of registers.  Note that all modules in a program must
12184 be compiled with the same value for this option.  Because of that, you
12185 must not use this option with the default runtime libraries gcc
12186 builds.
12188 @end table
12190 @node M32R/D Options
12191 @subsection M32R/D Options
12192 @cindex M32R/D options
12194 These @option{-m} options are defined for Renesas M32R/D architectures:
12196 @table @gcctabopt
12197 @item -m32r2
12198 @opindex m32r2
12199 Generate code for the M32R/2@.
12201 @item -m32rx
12202 @opindex m32rx
12203 Generate code for the M32R/X@.
12205 @item -m32r
12206 @opindex m32r
12207 Generate code for the M32R@.  This is the default.
12209 @item -mmodel=small
12210 @opindex mmodel=small
12211 Assume all objects live in the lower 16MB of memory (so that their addresses
12212 can be loaded with the @code{ld24} instruction), and assume all subroutines
12213 are reachable with the @code{bl} instruction.
12214 This is the default.
12216 The addressability of a particular object can be set with the
12217 @code{model} attribute.
12219 @item -mmodel=medium
12220 @opindex mmodel=medium
12221 Assume objects may be anywhere in the 32-bit address space (the compiler
12222 will generate @code{seth/add3} instructions to load their addresses), and
12223 assume all subroutines are reachable with the @code{bl} instruction.
12225 @item -mmodel=large
12226 @opindex mmodel=large
12227 Assume objects may be anywhere in the 32-bit address space (the compiler
12228 will generate @code{seth/add3} instructions to load their addresses), and
12229 assume subroutines may not be reachable with the @code{bl} instruction
12230 (the compiler will generate the much slower @code{seth/add3/jl}
12231 instruction sequence).
12233 @item -msdata=none
12234 @opindex msdata=none
12235 Disable use of the small data area.  Variables will be put into
12236 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12237 @code{section} attribute has been specified).
12238 This is the default.
12240 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12241 Objects may be explicitly put in the small data area with the
12242 @code{section} attribute using one of these sections.
12244 @item -msdata=sdata
12245 @opindex msdata=sdata
12246 Put small global and static data in the small data area, but do not
12247 generate special code to reference them.
12249 @item -msdata=use
12250 @opindex msdata=use
12251 Put small global and static data in the small data area, and generate
12252 special instructions to reference them.
12254 @item -G @var{num}
12255 @opindex G
12256 @cindex smaller data references
12257 Put global and static objects less than or equal to @var{num} bytes
12258 into the small data or bss sections instead of the normal data or bss
12259 sections.  The default value of @var{num} is 8.
12260 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12261 for this option to have any effect.
12263 All modules should be compiled with the same @option{-G @var{num}} value.
12264 Compiling with different values of @var{num} may or may not work; if it
12265 doesn't the linker will give an error message---incorrect code will not be
12266 generated.
12268 @item -mdebug
12269 @opindex mdebug
12270 Makes the M32R specific code in the compiler display some statistics
12271 that might help in debugging programs.
12273 @item -malign-loops
12274 @opindex malign-loops
12275 Align all loops to a 32-byte boundary.
12277 @item -mno-align-loops
12278 @opindex mno-align-loops
12279 Do not enforce a 32-byte alignment for loops.  This is the default.
12281 @item -missue-rate=@var{number}
12282 @opindex missue-rate=@var{number}
12283 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12284 or 2.
12286 @item -mbranch-cost=@var{number}
12287 @opindex mbranch-cost=@var{number}
12288 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12289 preferred over conditional code, if it is 2, then the opposite will
12290 apply.
12292 @item -mflush-trap=@var{number}
12293 @opindex mflush-trap=@var{number}
12294 Specifies the trap number to use to flush the cache.  The default is
12295 12.  Valid numbers are between 0 and 15 inclusive.
12297 @item -mno-flush-trap
12298 @opindex mno-flush-trap
12299 Specifies that the cache cannot be flushed by using a trap.
12301 @item -mflush-func=@var{name}
12302 @opindex mflush-func=@var{name}
12303 Specifies the name of the operating system function to call to flush
12304 the cache.  The default is @emph{_flush_cache}, but a function call
12305 will only be used if a trap is not available.
12307 @item -mno-flush-func
12308 @opindex mno-flush-func
12309 Indicates that there is no OS function for flushing the cache.
12311 @end table
12313 @node M680x0 Options
12314 @subsection M680x0 Options
12315 @cindex M680x0 options
12317 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12318 The default settings depend on which architecture was selected when
12319 the compiler was configured; the defaults for the most common choices
12320 are given below.
12322 @table @gcctabopt
12323 @item -march=@var{arch}
12324 @opindex march
12325 Generate code for a specific M680x0 or ColdFire instruction set
12326 architecture.  Permissible values of @var{arch} for M680x0
12327 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12328 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12329 architectures are selected according to Freescale's ISA classification
12330 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12331 @samp{isab} and @samp{isac}.
12333 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12334 code for a ColdFire target.  The @var{arch} in this macro is one of the
12335 @option{-march} arguments given above.
12337 When used together, @option{-march} and @option{-mtune} select code
12338 that runs on a family of similar processors but that is optimized
12339 for a particular microarchitecture.
12341 @item -mcpu=@var{cpu}
12342 @opindex mcpu
12343 Generate code for a specific M680x0 or ColdFire processor.
12344 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12345 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12346 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12347 below, which also classifies the CPUs into families:
12349 @multitable @columnfractions 0.20 0.80
12350 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12351 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12352 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12353 @item @samp{5206e} @tab @samp{5206e}
12354 @item @samp{5208} @tab @samp{5207} @samp{5208}
12355 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12356 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12357 @item @samp{5216} @tab @samp{5214} @samp{5216}
12358 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12359 @item @samp{5225} @tab @samp{5224} @samp{5225}
12360 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12361 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12362 @item @samp{5249} @tab @samp{5249}
12363 @item @samp{5250} @tab @samp{5250}
12364 @item @samp{5271} @tab @samp{5270} @samp{5271}
12365 @item @samp{5272} @tab @samp{5272}
12366 @item @samp{5275} @tab @samp{5274} @samp{5275}
12367 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12368 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12369 @item @samp{5307} @tab @samp{5307}
12370 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12371 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12372 @item @samp{5407} @tab @samp{5407}
12373 @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}
12374 @end multitable
12376 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12377 @var{arch} is compatible with @var{cpu}.  Other combinations of
12378 @option{-mcpu} and @option{-march} are rejected.
12380 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12381 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12382 where the value of @var{family} is given by the table above.
12384 @item -mtune=@var{tune}
12385 @opindex mtune
12386 Tune the code for a particular microarchitecture, within the
12387 constraints set by @option{-march} and @option{-mcpu}.
12388 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12389 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12390 and @samp{cpu32}.  The ColdFire microarchitectures
12391 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12393 You can also use @option{-mtune=68020-40} for code that needs
12394 to run relatively well on 68020, 68030 and 68040 targets.
12395 @option{-mtune=68020-60} is similar but includes 68060 targets
12396 as well.  These two options select the same tuning decisions as
12397 @option{-m68020-40} and @option{-m68020-60} respectively.
12399 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12400 when tuning for 680x0 architecture @var{arch}.  It also defines
12401 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12402 option is used.  If gcc is tuning for a range of architectures,
12403 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12404 it defines the macros for every architecture in the range.
12406 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12407 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12408 of the arguments given above.
12410 @item -m68000
12411 @itemx -mc68000
12412 @opindex m68000
12413 @opindex mc68000
12414 Generate output for a 68000.  This is the default
12415 when the compiler is configured for 68000-based systems.
12416 It is equivalent to @option{-march=68000}.
12418 Use this option for microcontrollers with a 68000 or EC000 core,
12419 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12421 @item -m68010
12422 @opindex m68010
12423 Generate output for a 68010.  This is the default
12424 when the compiler is configured for 68010-based systems.
12425 It is equivalent to @option{-march=68010}.
12427 @item -m68020
12428 @itemx -mc68020
12429 @opindex m68020
12430 @opindex mc68020
12431 Generate output for a 68020.  This is the default
12432 when the compiler is configured for 68020-based systems.
12433 It is equivalent to @option{-march=68020}.
12435 @item -m68030
12436 @opindex m68030
12437 Generate output for a 68030.  This is the default when the compiler is
12438 configured for 68030-based systems.  It is equivalent to
12439 @option{-march=68030}.
12441 @item -m68040
12442 @opindex m68040
12443 Generate output for a 68040.  This is the default when the compiler is
12444 configured for 68040-based systems.  It is equivalent to
12445 @option{-march=68040}.
12447 This option inhibits the use of 68881/68882 instructions that have to be
12448 emulated by software on the 68040.  Use this option if your 68040 does not
12449 have code to emulate those instructions.
12451 @item -m68060
12452 @opindex m68060
12453 Generate output for a 68060.  This is the default when the compiler is
12454 configured for 68060-based systems.  It is equivalent to
12455 @option{-march=68060}.
12457 This option inhibits the use of 68020 and 68881/68882 instructions that
12458 have to be emulated by software on the 68060.  Use this option if your 68060
12459 does not have code to emulate those instructions.
12461 @item -mcpu32
12462 @opindex mcpu32
12463 Generate output for a CPU32.  This is the default
12464 when the compiler is configured for CPU32-based systems.
12465 It is equivalent to @option{-march=cpu32}.
12467 Use this option for microcontrollers with a
12468 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12469 68336, 68340, 68341, 68349 and 68360.
12471 @item -m5200
12472 @opindex m5200
12473 Generate output for a 520X ColdFire CPU@.  This is the default
12474 when the compiler is configured for 520X-based systems.
12475 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12476 in favor of that option.
12478 Use this option for microcontroller with a 5200 core, including
12479 the MCF5202, MCF5203, MCF5204 and MCF5206.
12481 @item -m5206e
12482 @opindex m5206e
12483 Generate output for a 5206e ColdFire CPU@.  The option is now
12484 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12486 @item -m528x
12487 @opindex m528x
12488 Generate output for a member of the ColdFire 528X family.
12489 The option is now deprecated in favor of the equivalent
12490 @option{-mcpu=528x}.
12492 @item -m5307
12493 @opindex m5307
12494 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12495 in favor of the equivalent @option{-mcpu=5307}.
12497 @item -m5407
12498 @opindex m5407
12499 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12500 in favor of the equivalent @option{-mcpu=5407}.
12502 @item -mcfv4e
12503 @opindex mcfv4e
12504 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12505 This includes use of hardware floating point instructions.
12506 The option is equivalent to @option{-mcpu=547x}, and is now
12507 deprecated in favor of that option.
12509 @item -m68020-40
12510 @opindex m68020-40
12511 Generate output for a 68040, without using any of the new instructions.
12512 This results in code which can run relatively efficiently on either a
12513 68020/68881 or a 68030 or a 68040.  The generated code does use the
12514 68881 instructions that are emulated on the 68040.
12516 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12518 @item -m68020-60
12519 @opindex m68020-60
12520 Generate output for a 68060, without using any of the new instructions.
12521 This results in code which can run relatively efficiently on either a
12522 68020/68881 or a 68030 or a 68040.  The generated code does use the
12523 68881 instructions that are emulated on the 68060.
12525 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
12527 @item -mhard-float
12528 @itemx -m68881
12529 @opindex mhard-float
12530 @opindex m68881
12531 Generate floating-point instructions.  This is the default for 68020
12532 and above, and for ColdFire devices that have an FPU@.  It defines the
12533 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
12534 on ColdFire targets.
12536 @item -msoft-float
12537 @opindex msoft-float
12538 Do not generate floating-point instructions; use library calls instead.
12539 This is the default for 68000, 68010, and 68832 targets.  It is also
12540 the default for ColdFire devices that have no FPU.
12542 @item -mdiv
12543 @itemx -mno-div
12544 @opindex mdiv
12545 @opindex mno-div
12546 Generate (do not generate) ColdFire hardware divide and remainder
12547 instructions.  If @option{-march} is used without @option{-mcpu},
12548 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
12549 architectures.  Otherwise, the default is taken from the target CPU
12550 (either the default CPU, or the one specified by @option{-mcpu}).  For
12551 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
12552 @option{-mcpu=5206e}.
12554 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
12556 @item -mshort
12557 @opindex mshort
12558 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12559 Additionally, parameters passed on the stack are also aligned to a
12560 16-bit boundary even on targets whose API mandates promotion to 32-bit.
12562 @item -mno-short
12563 @opindex mno-short
12564 Do not consider type @code{int} to be 16 bits wide.  This is the default.
12566 @item -mnobitfield
12567 @itemx -mno-bitfield
12568 @opindex mnobitfield
12569 @opindex mno-bitfield
12570 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
12571 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
12573 @item -mbitfield
12574 @opindex mbitfield
12575 Do use the bit-field instructions.  The @option{-m68020} option implies
12576 @option{-mbitfield}.  This is the default if you use a configuration
12577 designed for a 68020.
12579 @item -mrtd
12580 @opindex mrtd
12581 Use a different function-calling convention, in which functions
12582 that take a fixed number of arguments return with the @code{rtd}
12583 instruction, which pops their arguments while returning.  This
12584 saves one instruction in the caller since there is no need to pop
12585 the arguments there.
12587 This calling convention is incompatible with the one normally
12588 used on Unix, so you cannot use it if you need to call libraries
12589 compiled with the Unix compiler.
12591 Also, you must provide function prototypes for all functions that
12592 take variable numbers of arguments (including @code{printf});
12593 otherwise incorrect code will be generated for calls to those
12594 functions.
12596 In addition, seriously incorrect code will result if you call a
12597 function with too many arguments.  (Normally, extra arguments are
12598 harmlessly ignored.)
12600 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
12601 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
12603 @item -mno-rtd
12604 @opindex mno-rtd
12605 Do not use the calling conventions selected by @option{-mrtd}.
12606 This is the default.
12608 @item -malign-int
12609 @itemx -mno-align-int
12610 @opindex malign-int
12611 @opindex mno-align-int
12612 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
12613 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
12614 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
12615 Aligning variables on 32-bit boundaries produces code that runs somewhat
12616 faster on processors with 32-bit busses at the expense of more memory.
12618 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
12619 align structures containing the above types  differently than
12620 most published application binary interface specifications for the m68k.
12622 @item -mpcrel
12623 @opindex mpcrel
12624 Use the pc-relative addressing mode of the 68000 directly, instead of
12625 using a global offset table.  At present, this option implies @option{-fpic},
12626 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
12627 not presently supported with @option{-mpcrel}, though this could be supported for
12628 68020 and higher processors.
12630 @item -mno-strict-align
12631 @itemx -mstrict-align
12632 @opindex mno-strict-align
12633 @opindex mstrict-align
12634 Do not (do) assume that unaligned memory references will be handled by
12635 the system.
12637 @item -msep-data
12638 Generate code that allows the data segment to be located in a different
12639 area of memory from the text segment.  This allows for execute in place in
12640 an environment without virtual memory management.  This option implies
12641 @option{-fPIC}.
12643 @item -mno-sep-data
12644 Generate code that assumes that the data segment follows the text segment.
12645 This is the default.
12647 @item -mid-shared-library
12648 Generate code that supports shared libraries via the library ID method.
12649 This allows for execute in place and shared libraries in an environment
12650 without virtual memory management.  This option implies @option{-fPIC}.
12652 @item -mno-id-shared-library
12653 Generate code that doesn't assume ID based shared libraries are being used.
12654 This is the default.
12656 @item -mshared-library-id=n
12657 Specified the identification number of the ID based shared library being
12658 compiled.  Specifying a value of 0 will generate more compact code, specifying
12659 other values will force the allocation of that number to the current
12660 library but is no more space or time efficient than omitting this option.
12662 @item -mxgot
12663 @itemx -mno-xgot
12664 @opindex mxgot
12665 @opindex mno-xgot
12666 When generating position-independent code for ColdFire, generate code
12667 that works if the GOT has more than 8192 entries.  This code is
12668 larger and slower than code generated without this option.  On M680x0
12669 processors, this option is not needed; @option{-fPIC} suffices.
12671 GCC normally uses a single instruction to load values from the GOT@.
12672 While this is relatively efficient, it only works if the GOT
12673 is smaller than about 64k.  Anything larger causes the linker
12674 to report an error such as:
12676 @cindex relocation truncated to fit (ColdFire)
12677 @smallexample
12678 relocation truncated to fit: R_68K_GOT16O foobar
12679 @end smallexample
12681 If this happens, you should recompile your code with @option{-mxgot}.
12682 It should then work with very large GOTs.  However, code generated with
12683 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
12684 the value of a global symbol.
12686 Note that some linkers, including newer versions of the GNU linker,
12687 can create multiple GOTs and sort GOT entries.  If you have such a linker,
12688 you should only need to use @option{-mxgot} when compiling a single
12689 object file that accesses more than 8192 GOT entries.  Very few do.
12691 These options have no effect unless GCC is generating
12692 position-independent code.
12694 @end table
12696 @node M68hc1x Options
12697 @subsection M68hc1x Options
12698 @cindex M68hc1x options
12700 These are the @samp{-m} options defined for the 68hc11 and 68hc12
12701 microcontrollers.  The default values for these options depends on
12702 which style of microcontroller was selected when the compiler was configured;
12703 the defaults for the most common choices are given below.
12705 @table @gcctabopt
12706 @item -m6811
12707 @itemx -m68hc11
12708 @opindex m6811
12709 @opindex m68hc11
12710 Generate output for a 68HC11.  This is the default
12711 when the compiler is configured for 68HC11-based systems.
12713 @item -m6812
12714 @itemx -m68hc12
12715 @opindex m6812
12716 @opindex m68hc12
12717 Generate output for a 68HC12.  This is the default
12718 when the compiler is configured for 68HC12-based systems.
12720 @item -m68S12
12721 @itemx -m68hcs12
12722 @opindex m68S12
12723 @opindex m68hcs12
12724 Generate output for a 68HCS12.
12726 @item -mauto-incdec
12727 @opindex mauto-incdec
12728 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
12729 addressing modes.
12731 @item -minmax
12732 @itemx -mnominmax
12733 @opindex minmax
12734 @opindex mnominmax
12735 Enable the use of 68HC12 min and max instructions.
12737 @item -mlong-calls
12738 @itemx -mno-long-calls
12739 @opindex mlong-calls
12740 @opindex mno-long-calls
12741 Treat all calls as being far away (near).  If calls are assumed to be
12742 far away, the compiler will use the @code{call} instruction to
12743 call a function and the @code{rtc} instruction for returning.
12745 @item -mshort
12746 @opindex mshort
12747 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12749 @item -msoft-reg-count=@var{count}
12750 @opindex msoft-reg-count
12751 Specify the number of pseudo-soft registers which are used for the
12752 code generation.  The maximum number is 32.  Using more pseudo-soft
12753 register may or may not result in better code depending on the program.
12754 The default is 4 for 68HC11 and 2 for 68HC12.
12756 @end table
12758 @node MCore Options
12759 @subsection MCore Options
12760 @cindex MCore options
12762 These are the @samp{-m} options defined for the Motorola M*Core
12763 processors.
12765 @table @gcctabopt
12767 @item -mhardlit
12768 @itemx -mno-hardlit
12769 @opindex mhardlit
12770 @opindex mno-hardlit
12771 Inline constants into the code stream if it can be done in two
12772 instructions or less.
12774 @item -mdiv
12775 @itemx -mno-div
12776 @opindex mdiv
12777 @opindex mno-div
12778 Use the divide instruction.  (Enabled by default).
12780 @item -mrelax-immediate
12781 @itemx -mno-relax-immediate
12782 @opindex mrelax-immediate
12783 @opindex mno-relax-immediate
12784 Allow arbitrary sized immediates in bit operations.
12786 @item -mwide-bitfields
12787 @itemx -mno-wide-bitfields
12788 @opindex mwide-bitfields
12789 @opindex mno-wide-bitfields
12790 Always treat bit-fields as int-sized.
12792 @item -m4byte-functions
12793 @itemx -mno-4byte-functions
12794 @opindex m4byte-functions
12795 @opindex mno-4byte-functions
12796 Force all functions to be aligned to a four byte boundary.
12798 @item -mcallgraph-data
12799 @itemx -mno-callgraph-data
12800 @opindex mcallgraph-data
12801 @opindex mno-callgraph-data
12802 Emit callgraph information.
12804 @item -mslow-bytes
12805 @itemx -mno-slow-bytes
12806 @opindex mslow-bytes
12807 @opindex mno-slow-bytes
12808 Prefer word access when reading byte quantities.
12810 @item -mlittle-endian
12811 @itemx -mbig-endian
12812 @opindex mlittle-endian
12813 @opindex mbig-endian
12814 Generate code for a little endian target.
12816 @item -m210
12817 @itemx -m340
12818 @opindex m210
12819 @opindex m340
12820 Generate code for the 210 processor.
12822 @item -mno-lsim
12823 @opindex mno-lsim
12824 Assume that run-time support has been provided and so omit the
12825 simulator library (@file{libsim.a)} from the linker command line.
12827 @item -mstack-increment=@var{size}
12828 @opindex mstack-increment
12829 Set the maximum amount for a single stack increment operation.  Large
12830 values can increase the speed of programs which contain functions
12831 that need a large amount of stack space, but they can also trigger a
12832 segmentation fault if the stack is extended too much.  The default
12833 value is 0x1000.
12835 @end table
12837 @node MeP Options
12838 @subsection MeP Options
12839 @cindex MeP options
12841 @table @gcctabopt
12843 @item -mabsdiff
12844 @opindex mabsdiff
12845 Enables the @code{abs} instruction, which is the absolute difference
12846 between two registers.
12848 @item -mall-opts
12849 @opindex mall-opts
12850 Enables all the optional instructions - average, multiply, divide, bit
12851 operations, leading zero, absolute difference, min/max, clip, and
12852 saturation.
12855 @item -maverage
12856 @opindex maverage
12857 Enables the @code{ave} instruction, which computes the average of two
12858 registers.
12860 @item -mbased=@var{n}
12861 @opindex mbased=
12862 Variables of size @var{n} bytes or smaller will be placed in the
12863 @code{.based} section by default.  Based variables use the @code{$tp}
12864 register as a base register, and there is a 128 byte limit to the
12865 @code{.based} section.
12867 @item -mbitops
12868 @opindex mbitops
12869 Enables the bit operation instructions - bit test (@code{btstm}), set
12870 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
12871 test-and-set (@code{tas}).
12873 @item -mc=@var{name}
12874 @opindex mc=
12875 Selects which section constant data will be placed in.  @var{name} may
12876 be @code{tiny}, @code{near}, or @code{far}.
12878 @item -mclip
12879 @opindex mclip
12880 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
12881 useful unless you also provide @code{-mminmax}.
12883 @item -mconfig=@var{name}
12884 @opindex mconfig=
12885 Selects one of the build-in core configurations.  Each MeP chip has
12886 one or more modules in it; each module has a core CPU and a variety of
12887 coprocessors, optional instructions, and peripherals.  The
12888 @code{MeP-Integrator} tool, not part of GCC, provides these
12889 configurations through this option; using this option is the same as
12890 using all the corresponding command line options.  The default
12891 configuration is @code{default}.
12893 @item -mcop
12894 @opindex mcop
12895 Enables the coprocessor instructions.  By default, this is a 32-bit
12896 coprocessor.  Note that the coprocessor is normally enabled via the
12897 @code{-mconfig=} option.
12899 @item -mcop32
12900 @opindex mcop32
12901 Enables the 32-bit coprocessor's instructions.
12903 @item -mcop64
12904 @opindex mcop64
12905 Enables the 64-bit coprocessor's instructions.
12907 @item -mivc2
12908 @opindex mivc2
12909 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
12911 @item -mdc
12912 @opindex mdc
12913 Causes constant variables to be placed in the @code{.near} section.
12915 @item -mdiv
12916 @opindex mdiv
12917 Enables the @code{div} and @code{divu} instructions.
12919 @item -meb
12920 @opindex meb
12921 Generate big-endian code.
12923 @item -mel
12924 @opindex mel
12925 Generate little-endian code.
12927 @item -mio-volatile
12928 @opindex mio-volatile
12929 Tells the compiler that any variable marked with the @code{io}
12930 attribute is to be considered volatile.
12932 @item -ml
12933 @opindex ml
12934 Causes variables to be assigned to the @code{.far} section by default.
12936 @item -mleadz
12937 @opindex mleadz
12938 Enables the @code{leadz} (leading zero) instruction.
12940 @item -mm
12941 @opindex mm
12942 Causes variables to be assigned to the @code{.near} section by default.
12944 @item -mminmax
12945 @opindex mminmax
12946 Enables the @code{min} and @code{max} instructions.
12948 @item -mmult
12949 @opindex mmult
12950 Enables the multiplication and multiply-accumulate instructions.
12952 @item -mno-opts
12953 @opindex mno-opts
12954 Disables all the optional instructions enabled by @code{-mall-opts}.
12956 @item -mrepeat
12957 @opindex mrepeat
12958 Enables the @code{repeat} and @code{erepeat} instructions, used for
12959 low-overhead looping.
12961 @item -ms
12962 @opindex ms
12963 Causes all variables to default to the @code{.tiny} section.  Note
12964 that there is a 65536 byte limit to this section.  Accesses to these
12965 variables use the @code{%gp} base register.
12967 @item -msatur
12968 @opindex msatur
12969 Enables the saturation instructions.  Note that the compiler does not
12970 currently generate these itself, but this option is included for
12971 compatibility with other tools, like @code{as}.
12973 @item -msdram
12974 @opindex msdram
12975 Link the SDRAM-based runtime instead of the default ROM-based runtime.
12977 @item -msim
12978 @opindex msim
12979 Link the simulator runtime libraries.
12981 @item -msimnovec
12982 @opindex msimnovec
12983 Link the simulator runtime libraries, excluding built-in support
12984 for reset and exception vectors and tables.
12986 @item -mtf
12987 @opindex mtf
12988 Causes all functions to default to the @code{.far} section.  Without
12989 this option, functions default to the @code{.near} section.
12991 @item -mtiny=@var{n}
12992 @opindex mtiny=
12993 Variables that are @var{n} bytes or smaller will be allocated to the
12994 @code{.tiny} section.  These variables use the @code{$gp} base
12995 register.  The default for this option is 4, but note that there's a
12996 65536 byte limit to the @code{.tiny} section.
12998 @end table
13000 @node MIPS Options
13001 @subsection MIPS Options
13002 @cindex MIPS options
13004 @table @gcctabopt
13006 @item -EB
13007 @opindex EB
13008 Generate big-endian code.
13010 @item -EL
13011 @opindex EL
13012 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13013 configurations.
13015 @item -march=@var{arch}
13016 @opindex march
13017 Generate code that will run on @var{arch}, which can be the name of a
13018 generic MIPS ISA, or the name of a particular processor.
13019 The ISA names are:
13020 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13021 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13022 The processor names are:
13023 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13024 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13025 @samp{5kc}, @samp{5kf},
13026 @samp{20kc},
13027 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13028 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13029 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13030 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13031 @samp{loongson2e}, @samp{loongson2f},
13032 @samp{m4k},
13033 @samp{octeon},
13034 @samp{orion},
13035 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13036 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13037 @samp{rm7000}, @samp{rm9000},
13038 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13039 @samp{sb1},
13040 @samp{sr71000},
13041 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13042 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13043 and @samp{xlr}.
13044 The special value @samp{from-abi} selects the
13045 most compatible architecture for the selected ABI (that is,
13046 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13048 Native Linux/GNU toolchains also support the value @samp{native},
13049 which selects the best architecture option for the host processor.
13050 @option{-march=native} has no effect if GCC does not recognize
13051 the processor.
13053 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13054 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13055 @samp{vr} may be written @samp{r}.
13057 Names of the form @samp{@var{n}f2_1} refer to processors with
13058 FPUs clocked at half the rate of the core, names of the form
13059 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13060 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13061 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13062 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13063 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13064 accepted as synonyms for @samp{@var{n}f1_1}.
13066 GCC defines two macros based on the value of this option.  The first
13067 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13068 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13069 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13070 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13071 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13073 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13074 above.  In other words, it will have the full prefix and will not
13075 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13076 the macro names the resolved architecture (either @samp{"mips1"} or
13077 @samp{"mips3"}).  It names the default architecture when no
13078 @option{-march} option is given.
13080 @item -mtune=@var{arch}
13081 @opindex mtune
13082 Optimize for @var{arch}.  Among other things, this option controls
13083 the way instructions are scheduled, and the perceived cost of arithmetic
13084 operations.  The list of @var{arch} values is the same as for
13085 @option{-march}.
13087 When this option is not used, GCC will optimize for the processor
13088 specified by @option{-march}.  By using @option{-march} and
13089 @option{-mtune} together, it is possible to generate code that will
13090 run on a family of processors, but optimize the code for one
13091 particular member of that family.
13093 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13094 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13095 @samp{-march} ones described above.
13097 @item -mips1
13098 @opindex mips1
13099 Equivalent to @samp{-march=mips1}.
13101 @item -mips2
13102 @opindex mips2
13103 Equivalent to @samp{-march=mips2}.
13105 @item -mips3
13106 @opindex mips3
13107 Equivalent to @samp{-march=mips3}.
13109 @item -mips4
13110 @opindex mips4
13111 Equivalent to @samp{-march=mips4}.
13113 @item -mips32
13114 @opindex mips32
13115 Equivalent to @samp{-march=mips32}.
13117 @item -mips32r2
13118 @opindex mips32r2
13119 Equivalent to @samp{-march=mips32r2}.
13121 @item -mips64
13122 @opindex mips64
13123 Equivalent to @samp{-march=mips64}.
13125 @item -mips64r2
13126 @opindex mips64r2
13127 Equivalent to @samp{-march=mips64r2}.
13129 @item -mips16
13130 @itemx -mno-mips16
13131 @opindex mips16
13132 @opindex mno-mips16
13133 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13134 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13136 MIPS16 code generation can also be controlled on a per-function basis
13137 by means of @code{mips16} and @code{nomips16} attributes.
13138 @xref{Function Attributes}, for more information.
13140 @item -mflip-mips16
13141 @opindex mflip-mips16
13142 Generate MIPS16 code on alternating functions.  This option is provided
13143 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13144 not intended for ordinary use in compiling user code.
13146 @item -minterlink-mips16
13147 @itemx -mno-interlink-mips16
13148 @opindex minterlink-mips16
13149 @opindex mno-interlink-mips16
13150 Require (do not require) that non-MIPS16 code be link-compatible with
13151 MIPS16 code.
13153 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13154 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13155 therefore disables direct jumps unless GCC knows that the target of the
13156 jump is not MIPS16.
13158 @item -mabi=32
13159 @itemx -mabi=o64
13160 @itemx -mabi=n32
13161 @itemx -mabi=64
13162 @itemx -mabi=eabi
13163 @opindex mabi=32
13164 @opindex mabi=o64
13165 @opindex mabi=n32
13166 @opindex mabi=64
13167 @opindex mabi=eabi
13168 Generate code for the given ABI@.
13170 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13171 generates 64-bit code when you select a 64-bit architecture, but you
13172 can use @option{-mgp32} to get 32-bit code instead.
13174 For information about the O64 ABI, see
13175 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13177 GCC supports a variant of the o32 ABI in which floating-point registers
13178 are 64 rather than 32 bits wide.  You can select this combination with
13179 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13180 and @samp{mfhc1} instructions and is therefore only supported for
13181 MIPS32R2 processors.
13183 The register assignments for arguments and return values remain the
13184 same, but each scalar value is passed in a single 64-bit register
13185 rather than a pair of 32-bit registers.  For example, scalar
13186 floating-point values are returned in @samp{$f0} only, not a
13187 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13188 remains the same, but all 64 bits are saved.
13190 @item -mabicalls
13191 @itemx -mno-abicalls
13192 @opindex mabicalls
13193 @opindex mno-abicalls
13194 Generate (do not generate) code that is suitable for SVR4-style
13195 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13196 systems.
13198 @item -mshared
13199 @itemx -mno-shared
13200 Generate (do not generate) code that is fully position-independent,
13201 and that can therefore be linked into shared libraries.  This option
13202 only affects @option{-mabicalls}.
13204 All @option{-mabicalls} code has traditionally been position-independent,
13205 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13206 as an extension, the GNU toolchain allows executables to use absolute
13207 accesses for locally-binding symbols.  It can also use shorter GP
13208 initialization sequences and generate direct calls to locally-defined
13209 functions.  This mode is selected by @option{-mno-shared}.
13211 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13212 objects that can only be linked by the GNU linker.  However, the option
13213 does not affect the ABI of the final executable; it only affects the ABI
13214 of relocatable objects.  Using @option{-mno-shared} will generally make
13215 executables both smaller and quicker.
13217 @option{-mshared} is the default.
13219 @item -mplt
13220 @itemx -mno-plt
13221 @opindex mplt
13222 @opindex mno-plt
13223 Assume (do not assume) that the static and dynamic linkers
13224 support PLTs and copy relocations.  This option only affects
13225 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13226 has no effect without @samp{-msym32}.
13228 You can make @option{-mplt} the default by configuring
13229 GCC with @option{--with-mips-plt}.  The default is
13230 @option{-mno-plt} otherwise.
13232 @item -mxgot
13233 @itemx -mno-xgot
13234 @opindex mxgot
13235 @opindex mno-xgot
13236 Lift (do not lift) the usual restrictions on the size of the global
13237 offset table.
13239 GCC normally uses a single instruction to load values from the GOT@.
13240 While this is relatively efficient, it will only work if the GOT
13241 is smaller than about 64k.  Anything larger will cause the linker
13242 to report an error such as:
13244 @cindex relocation truncated to fit (MIPS)
13245 @smallexample
13246 relocation truncated to fit: R_MIPS_GOT16 foobar
13247 @end smallexample
13249 If this happens, you should recompile your code with @option{-mxgot}.
13250 It should then work with very large GOTs, although it will also be
13251 less efficient, since it will take three instructions to fetch the
13252 value of a global symbol.
13254 Note that some linkers can create multiple GOTs.  If you have such a
13255 linker, you should only need to use @option{-mxgot} when a single object
13256 file accesses more than 64k's worth of GOT entries.  Very few do.
13258 These options have no effect unless GCC is generating position
13259 independent code.
13261 @item -mgp32
13262 @opindex mgp32
13263 Assume that general-purpose registers are 32 bits wide.
13265 @item -mgp64
13266 @opindex mgp64
13267 Assume that general-purpose registers are 64 bits wide.
13269 @item -mfp32
13270 @opindex mfp32
13271 Assume that floating-point registers are 32 bits wide.
13273 @item -mfp64
13274 @opindex mfp64
13275 Assume that floating-point registers are 64 bits wide.
13277 @item -mhard-float
13278 @opindex mhard-float
13279 Use floating-point coprocessor instructions.
13281 @item -msoft-float
13282 @opindex msoft-float
13283 Do not use floating-point coprocessor instructions.  Implement
13284 floating-point calculations using library calls instead.
13286 @item -msingle-float
13287 @opindex msingle-float
13288 Assume that the floating-point coprocessor only supports single-precision
13289 operations.
13291 @item -mdouble-float
13292 @opindex mdouble-float
13293 Assume that the floating-point coprocessor supports double-precision
13294 operations.  This is the default.
13296 @item -mllsc
13297 @itemx -mno-llsc
13298 @opindex mllsc
13299 @opindex mno-llsc
13300 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13301 implement atomic memory built-in functions.  When neither option is
13302 specified, GCC will use the instructions if the target architecture
13303 supports them.
13305 @option{-mllsc} is useful if the runtime environment can emulate the
13306 instructions and @option{-mno-llsc} can be useful when compiling for
13307 nonstandard ISAs.  You can make either option the default by
13308 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13309 respectively.  @option{--with-llsc} is the default for some
13310 configurations; see the installation documentation for details.
13312 @item -mdsp
13313 @itemx -mno-dsp
13314 @opindex mdsp
13315 @opindex mno-dsp
13316 Use (do not use) revision 1 of the MIPS DSP ASE@.
13317 @xref{MIPS DSP Built-in Functions}.  This option defines the
13318 preprocessor macro @samp{__mips_dsp}.  It also defines
13319 @samp{__mips_dsp_rev} to 1.
13321 @item -mdspr2
13322 @itemx -mno-dspr2
13323 @opindex mdspr2
13324 @opindex mno-dspr2
13325 Use (do not use) revision 2 of the MIPS DSP ASE@.
13326 @xref{MIPS DSP Built-in Functions}.  This option defines the
13327 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13328 It also defines @samp{__mips_dsp_rev} to 2.
13330 @item -msmartmips
13331 @itemx -mno-smartmips
13332 @opindex msmartmips
13333 @opindex mno-smartmips
13334 Use (do not use) the MIPS SmartMIPS ASE.
13336 @item -mpaired-single
13337 @itemx -mno-paired-single
13338 @opindex mpaired-single
13339 @opindex mno-paired-single
13340 Use (do not use) paired-single floating-point instructions.
13341 @xref{MIPS Paired-Single Support}.  This option requires
13342 hardware floating-point support to be enabled.
13344 @item -mdmx
13345 @itemx -mno-mdmx
13346 @opindex mdmx
13347 @opindex mno-mdmx
13348 Use (do not use) MIPS Digital Media Extension instructions.
13349 This option can only be used when generating 64-bit code and requires
13350 hardware floating-point support to be enabled.
13352 @item -mips3d
13353 @itemx -mno-mips3d
13354 @opindex mips3d
13355 @opindex mno-mips3d
13356 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13357 The option @option{-mips3d} implies @option{-mpaired-single}.
13359 @item -mmt
13360 @itemx -mno-mt
13361 @opindex mmt
13362 @opindex mno-mt
13363 Use (do not use) MT Multithreading instructions.
13365 @item -mlong64
13366 @opindex mlong64
13367 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13368 an explanation of the default and the way that the pointer size is
13369 determined.
13371 @item -mlong32
13372 @opindex mlong32
13373 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13375 The default size of @code{int}s, @code{long}s and pointers depends on
13376 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13377 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13378 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13379 or the same size as integer registers, whichever is smaller.
13381 @item -msym32
13382 @itemx -mno-sym32
13383 @opindex msym32
13384 @opindex mno-sym32
13385 Assume (do not assume) that all symbols have 32-bit values, regardless
13386 of the selected ABI@.  This option is useful in combination with
13387 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13388 to generate shorter and faster references to symbolic addresses.
13390 @item -G @var{num}
13391 @opindex G
13392 Put definitions of externally-visible data in a small data section
13393 if that data is no bigger than @var{num} bytes.  GCC can then access
13394 the data more efficiently; see @option{-mgpopt} for details.
13396 The default @option{-G} option depends on the configuration.
13398 @item -mlocal-sdata
13399 @itemx -mno-local-sdata
13400 @opindex mlocal-sdata
13401 @opindex mno-local-sdata
13402 Extend (do not extend) the @option{-G} behavior to local data too,
13403 such as to static variables in C@.  @option{-mlocal-sdata} is the
13404 default for all configurations.
13406 If the linker complains that an application is using too much small data,
13407 you might want to try rebuilding the less performance-critical parts with
13408 @option{-mno-local-sdata}.  You might also want to build large
13409 libraries with @option{-mno-local-sdata}, so that the libraries leave
13410 more room for the main program.
13412 @item -mextern-sdata
13413 @itemx -mno-extern-sdata
13414 @opindex mextern-sdata
13415 @opindex mno-extern-sdata
13416 Assume (do not assume) that externally-defined data will be in
13417 a small data section if that data is within the @option{-G} limit.
13418 @option{-mextern-sdata} is the default for all configurations.
13420 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13421 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13422 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13423 is placed in a small data section.  If @var{Var} is defined by another
13424 module, you must either compile that module with a high-enough
13425 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13426 definition.  If @var{Var} is common, you must link the application
13427 with a high-enough @option{-G} setting.
13429 The easiest way of satisfying these restrictions is to compile
13430 and link every module with the same @option{-G} option.  However,
13431 you may wish to build a library that supports several different
13432 small data limits.  You can do this by compiling the library with
13433 the highest supported @option{-G} setting and additionally using
13434 @option{-mno-extern-sdata} to stop the library from making assumptions
13435 about externally-defined data.
13437 @item -mgpopt
13438 @itemx -mno-gpopt
13439 @opindex mgpopt
13440 @opindex mno-gpopt
13441 Use (do not use) GP-relative accesses for symbols that are known to be
13442 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13443 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13444 configurations.
13446 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13447 might not hold the value of @code{_gp}.  For example, if the code is
13448 part of a library that might be used in a boot monitor, programs that
13449 call boot monitor routines will pass an unknown value in @code{$gp}.
13450 (In such situations, the boot monitor itself would usually be compiled
13451 with @option{-G0}.)
13453 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13454 @option{-mno-extern-sdata}.
13456 @item -membedded-data
13457 @itemx -mno-embedded-data
13458 @opindex membedded-data
13459 @opindex mno-embedded-data
13460 Allocate variables to the read-only data section first if possible, then
13461 next in the small data section if possible, otherwise in data.  This gives
13462 slightly slower code than the default, but reduces the amount of RAM required
13463 when executing, and thus may be preferred for some embedded systems.
13465 @item -muninit-const-in-rodata
13466 @itemx -mno-uninit-const-in-rodata
13467 @opindex muninit-const-in-rodata
13468 @opindex mno-uninit-const-in-rodata
13469 Put uninitialized @code{const} variables in the read-only data section.
13470 This option is only meaningful in conjunction with @option{-membedded-data}.
13472 @item -mcode-readable=@var{setting}
13473 @opindex mcode-readable
13474 Specify whether GCC may generate code that reads from executable sections.
13475 There are three possible settings:
13477 @table @gcctabopt
13478 @item -mcode-readable=yes
13479 Instructions may freely access executable sections.  This is the
13480 default setting.
13482 @item -mcode-readable=pcrel
13483 MIPS16 PC-relative load instructions can access executable sections,
13484 but other instructions must not do so.  This option is useful on 4KSc
13485 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13486 It is also useful on processors that can be configured to have a dual
13487 instruction/data SRAM interface and that, like the M4K, automatically
13488 redirect PC-relative loads to the instruction RAM.
13490 @item -mcode-readable=no
13491 Instructions must not access executable sections.  This option can be
13492 useful on targets that are configured to have a dual instruction/data
13493 SRAM interface but that (unlike the M4K) do not automatically redirect
13494 PC-relative loads to the instruction RAM.
13495 @end table
13497 @item -msplit-addresses
13498 @itemx -mno-split-addresses
13499 @opindex msplit-addresses
13500 @opindex mno-split-addresses
13501 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13502 relocation operators.  This option has been superseded by
13503 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13505 @item -mexplicit-relocs
13506 @itemx -mno-explicit-relocs
13507 @opindex mexplicit-relocs
13508 @opindex mno-explicit-relocs
13509 Use (do not use) assembler relocation operators when dealing with symbolic
13510 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13511 is to use assembler macros instead.
13513 @option{-mexplicit-relocs} is the default if GCC was configured
13514 to use an assembler that supports relocation operators.
13516 @item -mcheck-zero-division
13517 @itemx -mno-check-zero-division
13518 @opindex mcheck-zero-division
13519 @opindex mno-check-zero-division
13520 Trap (do not trap) on integer division by zero.
13522 The default is @option{-mcheck-zero-division}.
13524 @item -mdivide-traps
13525 @itemx -mdivide-breaks
13526 @opindex mdivide-traps
13527 @opindex mdivide-breaks
13528 MIPS systems check for division by zero by generating either a
13529 conditional trap or a break instruction.  Using traps results in
13530 smaller code, but is only supported on MIPS II and later.  Also, some
13531 versions of the Linux kernel have a bug that prevents trap from
13532 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
13533 allow conditional traps on architectures that support them and
13534 @option{-mdivide-breaks} to force the use of breaks.
13536 The default is usually @option{-mdivide-traps}, but this can be
13537 overridden at configure time using @option{--with-divide=breaks}.
13538 Divide-by-zero checks can be completely disabled using
13539 @option{-mno-check-zero-division}.
13541 @item -mmemcpy
13542 @itemx -mno-memcpy
13543 @opindex mmemcpy
13544 @opindex mno-memcpy
13545 Force (do not force) the use of @code{memcpy()} for non-trivial block
13546 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
13547 most constant-sized copies.
13549 @item -mlong-calls
13550 @itemx -mno-long-calls
13551 @opindex mlong-calls
13552 @opindex mno-long-calls
13553 Disable (do not disable) use of the @code{jal} instruction.  Calling
13554 functions using @code{jal} is more efficient but requires the caller
13555 and callee to be in the same 256 megabyte segment.
13557 This option has no effect on abicalls code.  The default is
13558 @option{-mno-long-calls}.
13560 @item -mmad
13561 @itemx -mno-mad
13562 @opindex mmad
13563 @opindex mno-mad
13564 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
13565 instructions, as provided by the R4650 ISA@.
13567 @item -mfused-madd
13568 @itemx -mno-fused-madd
13569 @opindex mfused-madd
13570 @opindex mno-fused-madd
13571 Enable (disable) use of the floating point multiply-accumulate
13572 instructions, when they are available.  The default is
13573 @option{-mfused-madd}.
13575 When multiply-accumulate instructions are used, the intermediate
13576 product is calculated to infinite precision and is not subject to
13577 the FCSR Flush to Zero bit.  This may be undesirable in some
13578 circumstances.
13580 @item -nocpp
13581 @opindex nocpp
13582 Tell the MIPS assembler to not run its preprocessor over user
13583 assembler files (with a @samp{.s} suffix) when assembling them.
13585 @item -mfix-r4000
13586 @itemx -mno-fix-r4000
13587 @opindex mfix-r4000
13588 @opindex mno-fix-r4000
13589 Work around certain R4000 CPU errata:
13590 @itemize @minus
13591 @item
13592 A double-word or a variable shift may give an incorrect result if executed
13593 immediately after starting an integer division.
13594 @item
13595 A double-word or a variable shift may give an incorrect result if executed
13596 while an integer multiplication is in progress.
13597 @item
13598 An integer division may give an incorrect result if started in a delay slot
13599 of a taken branch or a jump.
13600 @end itemize
13602 @item -mfix-r4400
13603 @itemx -mno-fix-r4400
13604 @opindex mfix-r4400
13605 @opindex mno-fix-r4400
13606 Work around certain R4400 CPU errata:
13607 @itemize @minus
13608 @item
13609 A double-word or a variable shift may give an incorrect result if executed
13610 immediately after starting an integer division.
13611 @end itemize
13613 @item -mfix-r10000
13614 @itemx -mno-fix-r10000
13615 @opindex mfix-r10000
13616 @opindex mno-fix-r10000
13617 Work around certain R10000 errata:
13618 @itemize @minus
13619 @item
13620 @code{ll}/@code{sc} sequences may not behave atomically on revisions
13621 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
13622 @end itemize
13624 This option can only be used if the target architecture supports
13625 branch-likely instructions.  @option{-mfix-r10000} is the default when
13626 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
13627 otherwise.
13629 @item -mfix-vr4120
13630 @itemx -mno-fix-vr4120
13631 @opindex mfix-vr4120
13632 Work around certain VR4120 errata:
13633 @itemize @minus
13634 @item
13635 @code{dmultu} does not always produce the correct result.
13636 @item
13637 @code{div} and @code{ddiv} do not always produce the correct result if one
13638 of the operands is negative.
13639 @end itemize
13640 The workarounds for the division errata rely on special functions in
13641 @file{libgcc.a}.  At present, these functions are only provided by
13642 the @code{mips64vr*-elf} configurations.
13644 Other VR4120 errata require a nop to be inserted between certain pairs of
13645 instructions.  These errata are handled by the assembler, not by GCC itself.
13647 @item -mfix-vr4130
13648 @opindex mfix-vr4130
13649 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
13650 workarounds are implemented by the assembler rather than by GCC,
13651 although GCC will avoid using @code{mflo} and @code{mfhi} if the
13652 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
13653 instructions are available instead.
13655 @item -mfix-sb1
13656 @itemx -mno-fix-sb1
13657 @opindex mfix-sb1
13658 Work around certain SB-1 CPU core errata.
13659 (This flag currently works around the SB-1 revision 2
13660 ``F1'' and ``F2'' floating point errata.)
13662 @item -mr10k-cache-barrier=@var{setting}
13663 @opindex mr10k-cache-barrier
13664 Specify whether GCC should insert cache barriers to avoid the
13665 side-effects of speculation on R10K processors.
13667 In common with many processors, the R10K tries to predict the outcome
13668 of a conditional branch and speculatively executes instructions from
13669 the ``taken'' branch.  It later aborts these instructions if the
13670 predicted outcome was wrong.  However, on the R10K, even aborted
13671 instructions can have side effects.
13673 This problem only affects kernel stores and, depending on the system,
13674 kernel loads.  As an example, a speculatively-executed store may load
13675 the target memory into cache and mark the cache line as dirty, even if
13676 the store itself is later aborted.  If a DMA operation writes to the
13677 same area of memory before the ``dirty'' line is flushed, the cached
13678 data will overwrite the DMA-ed data.  See the R10K processor manual
13679 for a full description, including other potential problems.
13681 One workaround is to insert cache barrier instructions before every memory
13682 access that might be speculatively executed and that might have side
13683 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
13684 controls GCC's implementation of this workaround.  It assumes that
13685 aborted accesses to any byte in the following regions will not have
13686 side effects:
13688 @enumerate
13689 @item
13690 the memory occupied by the current function's stack frame;
13692 @item
13693 the memory occupied by an incoming stack argument;
13695 @item
13696 the memory occupied by an object with a link-time-constant address.
13697 @end enumerate
13699 It is the kernel's responsibility to ensure that speculative
13700 accesses to these regions are indeed safe.
13702 If the input program contains a function declaration such as:
13704 @smallexample
13705 void foo (void);
13706 @end smallexample
13708 then the implementation of @code{foo} must allow @code{j foo} and
13709 @code{jal foo} to be executed speculatively.  GCC honors this
13710 restriction for functions it compiles itself.  It expects non-GCC
13711 functions (such as hand-written assembly code) to do the same.
13713 The option has three forms:
13715 @table @gcctabopt
13716 @item -mr10k-cache-barrier=load-store
13717 Insert a cache barrier before a load or store that might be
13718 speculatively executed and that might have side effects even
13719 if aborted.
13721 @item -mr10k-cache-barrier=store
13722 Insert a cache barrier before a store that might be speculatively
13723 executed and that might have side effects even if aborted.
13725 @item -mr10k-cache-barrier=none
13726 Disable the insertion of cache barriers.  This is the default setting.
13727 @end table
13729 @item -mflush-func=@var{func}
13730 @itemx -mno-flush-func
13731 @opindex mflush-func
13732 Specifies the function to call to flush the I and D caches, or to not
13733 call any such function.  If called, the function must take the same
13734 arguments as the common @code{_flush_func()}, that is, the address of the
13735 memory range for which the cache is being flushed, the size of the
13736 memory range, and the number 3 (to flush both caches).  The default
13737 depends on the target GCC was configured for, but commonly is either
13738 @samp{_flush_func} or @samp{__cpu_flush}.
13740 @item mbranch-cost=@var{num}
13741 @opindex mbranch-cost
13742 Set the cost of branches to roughly @var{num} ``simple'' instructions.
13743 This cost is only a heuristic and is not guaranteed to produce
13744 consistent results across releases.  A zero cost redundantly selects
13745 the default, which is based on the @option{-mtune} setting.
13747 @item -mbranch-likely
13748 @itemx -mno-branch-likely
13749 @opindex mbranch-likely
13750 @opindex mno-branch-likely
13751 Enable or disable use of Branch Likely instructions, regardless of the
13752 default for the selected architecture.  By default, Branch Likely
13753 instructions may be generated if they are supported by the selected
13754 architecture.  An exception is for the MIPS32 and MIPS64 architectures
13755 and processors which implement those architectures; for those, Branch
13756 Likely instructions will not be generated by default because the MIPS32
13757 and MIPS64 architectures specifically deprecate their use.
13759 @item -mfp-exceptions
13760 @itemx -mno-fp-exceptions
13761 @opindex mfp-exceptions
13762 Specifies whether FP exceptions are enabled.  This affects how we schedule
13763 FP instructions for some processors.  The default is that FP exceptions are
13764 enabled.
13766 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
13767 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
13768 FP pipe.
13770 @item -mvr4130-align
13771 @itemx -mno-vr4130-align
13772 @opindex mvr4130-align
13773 The VR4130 pipeline is two-way superscalar, but can only issue two
13774 instructions together if the first one is 8-byte aligned.  When this
13775 option is enabled, GCC will align pairs of instructions that it
13776 thinks should execute in parallel.
13778 This option only has an effect when optimizing for the VR4130.
13779 It normally makes code faster, but at the expense of making it bigger.
13780 It is enabled by default at optimization level @option{-O3}.
13782 @item -msynci
13783 @itemx -mno-synci
13784 @opindex msynci
13785 Enable (disable) generation of @code{synci} instructions on
13786 architectures that support it.  The @code{synci} instructions (if
13787 enabled) will be generated when @code{__builtin___clear_cache()} is
13788 compiled.
13790 This option defaults to @code{-mno-synci}, but the default can be
13791 overridden by configuring with @code{--with-synci}.
13793 When compiling code for single processor systems, it is generally safe
13794 to use @code{synci}.  However, on many multi-core (SMP) systems, it
13795 will not invalidate the instruction caches on all cores and may lead
13796 to undefined behavior.
13797 @end table
13799 @node MMIX Options
13800 @subsection MMIX Options
13801 @cindex MMIX Options
13803 These options are defined for the MMIX:
13805 @table @gcctabopt
13806 @item -mlibfuncs
13807 @itemx -mno-libfuncs
13808 @opindex mlibfuncs
13809 @opindex mno-libfuncs
13810 Specify that intrinsic library functions are being compiled, passing all
13811 values in registers, no matter the size.
13813 @item -mepsilon
13814 @itemx -mno-epsilon
13815 @opindex mepsilon
13816 @opindex mno-epsilon
13817 Generate floating-point comparison instructions that compare with respect
13818 to the @code{rE} epsilon register.
13820 @item -mabi=mmixware
13821 @itemx -mabi=gnu
13822 @opindex mabi=mmixware
13823 @opindex mabi=gnu
13824 Generate code that passes function parameters and return values that (in
13825 the called function) are seen as registers @code{$0} and up, as opposed to
13826 the GNU ABI which uses global registers @code{$231} and up.
13828 @item -mzero-extend
13829 @itemx -mno-zero-extend
13830 @opindex mzero-extend
13831 @opindex mno-zero-extend
13832 When reading data from memory in sizes shorter than 64 bits, use (do not
13833 use) zero-extending load instructions by default, rather than
13834 sign-extending ones.
13836 @item -mknuthdiv
13837 @itemx -mno-knuthdiv
13838 @opindex mknuthdiv
13839 @opindex mno-knuthdiv
13840 Make the result of a division yielding a remainder have the same sign as
13841 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
13842 remainder follows the sign of the dividend.  Both methods are
13843 arithmetically valid, the latter being almost exclusively used.
13845 @item -mtoplevel-symbols
13846 @itemx -mno-toplevel-symbols
13847 @opindex mtoplevel-symbols
13848 @opindex mno-toplevel-symbols
13849 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
13850 code can be used with the @code{PREFIX} assembly directive.
13852 @item -melf
13853 @opindex melf
13854 Generate an executable in the ELF format, rather than the default
13855 @samp{mmo} format used by the @command{mmix} simulator.
13857 @item -mbranch-predict
13858 @itemx -mno-branch-predict
13859 @opindex mbranch-predict
13860 @opindex mno-branch-predict
13861 Use (do not use) the probable-branch instructions, when static branch
13862 prediction indicates a probable branch.
13864 @item -mbase-addresses
13865 @itemx -mno-base-addresses
13866 @opindex mbase-addresses
13867 @opindex mno-base-addresses
13868 Generate (do not generate) code that uses @emph{base addresses}.  Using a
13869 base address automatically generates a request (handled by the assembler
13870 and the linker) for a constant to be set up in a global register.  The
13871 register is used for one or more base address requests within the range 0
13872 to 255 from the value held in the register.  The generally leads to short
13873 and fast code, but the number of different data items that can be
13874 addressed is limited.  This means that a program that uses lots of static
13875 data may require @option{-mno-base-addresses}.
13877 @item -msingle-exit
13878 @itemx -mno-single-exit
13879 @opindex msingle-exit
13880 @opindex mno-single-exit
13881 Force (do not force) generated code to have a single exit point in each
13882 function.
13883 @end table
13885 @node MN10300 Options
13886 @subsection MN10300 Options
13887 @cindex MN10300 options
13889 These @option{-m} options are defined for Matsushita MN10300 architectures:
13891 @table @gcctabopt
13892 @item -mmult-bug
13893 @opindex mmult-bug
13894 Generate code to avoid bugs in the multiply instructions for the MN10300
13895 processors.  This is the default.
13897 @item -mno-mult-bug
13898 @opindex mno-mult-bug
13899 Do not generate code to avoid bugs in the multiply instructions for the
13900 MN10300 processors.
13902 @item -mam33
13903 @opindex mam33
13904 Generate code which uses features specific to the AM33 processor.
13906 @item -mno-am33
13907 @opindex mno-am33
13908 Do not generate code which uses features specific to the AM33 processor.  This
13909 is the default.
13911 @item -mreturn-pointer-on-d0
13912 @opindex mreturn-pointer-on-d0
13913 When generating a function which returns a pointer, return the pointer
13914 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
13915 only in a0, and attempts to call such functions without a prototype
13916 would result in errors.  Note that this option is on by default; use
13917 @option{-mno-return-pointer-on-d0} to disable it.
13919 @item -mno-crt0
13920 @opindex mno-crt0
13921 Do not link in the C run-time initialization object file.
13923 @item -mrelax
13924 @opindex mrelax
13925 Indicate to the linker that it should perform a relaxation optimization pass
13926 to shorten branches, calls and absolute memory addresses.  This option only
13927 has an effect when used on the command line for the final link step.
13929 This option makes symbolic debugging impossible.
13930 @end table
13932 @node PDP-11 Options
13933 @subsection PDP-11 Options
13934 @cindex PDP-11 Options
13936 These options are defined for the PDP-11:
13938 @table @gcctabopt
13939 @item -mfpu
13940 @opindex mfpu
13941 Use hardware FPP floating point.  This is the default.  (FIS floating
13942 point on the PDP-11/40 is not supported.)
13944 @item -msoft-float
13945 @opindex msoft-float
13946 Do not use hardware floating point.
13948 @item -mac0
13949 @opindex mac0
13950 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
13952 @item -mno-ac0
13953 @opindex mno-ac0
13954 Return floating-point results in memory.  This is the default.
13956 @item -m40
13957 @opindex m40
13958 Generate code for a PDP-11/40.
13960 @item -m45
13961 @opindex m45
13962 Generate code for a PDP-11/45.  This is the default.
13964 @item -m10
13965 @opindex m10
13966 Generate code for a PDP-11/10.
13968 @item -mbcopy-builtin
13969 @opindex mbcopy-builtin
13970 Use inline @code{movmemhi} patterns for copying memory.  This is the
13971 default.
13973 @item -mbcopy
13974 @opindex mbcopy
13975 Do not use inline @code{movmemhi} patterns for copying memory.
13977 @item -mint16
13978 @itemx -mno-int32
13979 @opindex mint16
13980 @opindex mno-int32
13981 Use 16-bit @code{int}.  This is the default.
13983 @item -mint32
13984 @itemx -mno-int16
13985 @opindex mint32
13986 @opindex mno-int16
13987 Use 32-bit @code{int}.
13989 @item -mfloat64
13990 @itemx -mno-float32
13991 @opindex mfloat64
13992 @opindex mno-float32
13993 Use 64-bit @code{float}.  This is the default.
13995 @item -mfloat32
13996 @itemx -mno-float64
13997 @opindex mfloat32
13998 @opindex mno-float64
13999 Use 32-bit @code{float}.
14001 @item -mabshi
14002 @opindex mabshi
14003 Use @code{abshi2} pattern.  This is the default.
14005 @item -mno-abshi
14006 @opindex mno-abshi
14007 Do not use @code{abshi2} pattern.
14009 @item -mbranch-expensive
14010 @opindex mbranch-expensive
14011 Pretend that branches are expensive.  This is for experimenting with
14012 code generation only.
14014 @item -mbranch-cheap
14015 @opindex mbranch-cheap
14016 Do not pretend that branches are expensive.  This is the default.
14018 @item -msplit
14019 @opindex msplit
14020 Generate code for a system with split I&D@.
14022 @item -mno-split
14023 @opindex mno-split
14024 Generate code for a system without split I&D@.  This is the default.
14026 @item -munix-asm
14027 @opindex munix-asm
14028 Use Unix assembler syntax.  This is the default when configured for
14029 @samp{pdp11-*-bsd}.
14031 @item -mdec-asm
14032 @opindex mdec-asm
14033 Use DEC assembler syntax.  This is the default when configured for any
14034 PDP-11 target other than @samp{pdp11-*-bsd}.
14035 @end table
14037 @node picoChip Options
14038 @subsection picoChip Options
14039 @cindex picoChip options
14041 These @samp{-m} options are defined for picoChip implementations:
14043 @table @gcctabopt
14045 @item -mae=@var{ae_type}
14046 @opindex mcpu
14047 Set the instruction set, register set, and instruction scheduling
14048 parameters for array element type @var{ae_type}.  Supported values
14049 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14051 @option{-mae=ANY} selects a completely generic AE type.  Code
14052 generated with this option will run on any of the other AE types.  The
14053 code will not be as efficient as it would be if compiled for a specific
14054 AE type, and some types of operation (e.g., multiplication) will not
14055 work properly on all types of AE.
14057 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14058 for compiled code, and is the default.
14060 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14061 option may suffer from poor performance of byte (char) manipulation,
14062 since the DSP AE does not provide hardware support for byte load/stores.
14064 @item -msymbol-as-address
14065 Enable the compiler to directly use a symbol name as an address in a
14066 load/store instruction, without first loading it into a
14067 register.  Typically, the use of this option will generate larger
14068 programs, which run faster than when the option isn't used.  However, the
14069 results vary from program to program, so it is left as a user option,
14070 rather than being permanently enabled.
14072 @item -mno-inefficient-warnings
14073 Disables warnings about the generation of inefficient code.  These
14074 warnings can be generated, for example, when compiling code which
14075 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14076 no hardware support for byte-level memory operations, so all byte
14077 load/stores must be synthesized from word load/store operations.  This is
14078 inefficient and a warning will be generated indicating to the programmer
14079 that they should rewrite the code to avoid byte operations, or to target
14080 an AE type which has the necessary hardware support.  This option enables
14081 the warning to be turned off.
14083 @end table
14085 @node PowerPC Options
14086 @subsection PowerPC Options
14087 @cindex PowerPC options
14089 These are listed under @xref{RS/6000 and PowerPC Options}.
14091 @node RS/6000 and PowerPC Options
14092 @subsection IBM RS/6000 and PowerPC Options
14093 @cindex RS/6000 and PowerPC Options
14094 @cindex IBM RS/6000 and PowerPC Options
14096 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14097 @table @gcctabopt
14098 @item -mpower
14099 @itemx -mno-power
14100 @itemx -mpower2
14101 @itemx -mno-power2
14102 @itemx -mpowerpc
14103 @itemx -mno-powerpc
14104 @itemx -mpowerpc-gpopt
14105 @itemx -mno-powerpc-gpopt
14106 @itemx -mpowerpc-gfxopt
14107 @itemx -mno-powerpc-gfxopt
14108 @itemx -mpowerpc64
14109 @itemx -mno-powerpc64
14110 @itemx -mmfcrf
14111 @itemx -mno-mfcrf
14112 @itemx -mpopcntb
14113 @itemx -mno-popcntb
14114 @itemx -mfprnd
14115 @itemx -mno-fprnd
14116 @itemx -mcmpb
14117 @itemx -mno-cmpb
14118 @itemx -mmfpgpr
14119 @itemx -mno-mfpgpr
14120 @itemx -mhard-dfp
14121 @itemx -mno-hard-dfp
14122 @opindex mpower
14123 @opindex mno-power
14124 @opindex mpower2
14125 @opindex mno-power2
14126 @opindex mpowerpc
14127 @opindex mno-powerpc
14128 @opindex mpowerpc-gpopt
14129 @opindex mno-powerpc-gpopt
14130 @opindex mpowerpc-gfxopt
14131 @opindex mno-powerpc-gfxopt
14132 @opindex mpowerpc64
14133 @opindex mno-powerpc64
14134 @opindex mmfcrf
14135 @opindex mno-mfcrf
14136 @opindex mpopcntb
14137 @opindex mno-popcntb
14138 @opindex mfprnd
14139 @opindex mno-fprnd
14140 @opindex mcmpb
14141 @opindex mno-cmpb
14142 @opindex mmfpgpr
14143 @opindex mno-mfpgpr
14144 @opindex mhard-dfp
14145 @opindex mno-hard-dfp
14146 GCC supports two related instruction set architectures for the
14147 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14148 instructions supported by the @samp{rios} chip set used in the original
14149 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14150 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14151 the IBM 4xx, 6xx, and follow-on microprocessors.
14153 Neither architecture is a subset of the other.  However there is a
14154 large common subset of instructions supported by both.  An MQ
14155 register is included in processors supporting the POWER architecture.
14157 You use these options to specify which instructions are available on the
14158 processor you are using.  The default value of these options is
14159 determined when configuring GCC@.  Specifying the
14160 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14161 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14162 rather than the options listed above.
14164 The @option{-mpower} option allows GCC to generate instructions that
14165 are found only in the POWER architecture and to use the MQ register.
14166 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14167 to generate instructions that are present in the POWER2 architecture but
14168 not the original POWER architecture.
14170 The @option{-mpowerpc} option allows GCC to generate instructions that
14171 are found only in the 32-bit subset of the PowerPC architecture.
14172 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14173 GCC to use the optional PowerPC architecture instructions in the
14174 General Purpose group, including floating-point square root.  Specifying
14175 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14176 use the optional PowerPC architecture instructions in the Graphics
14177 group, including floating-point select.
14179 The @option{-mmfcrf} option allows GCC to generate the move from
14180 condition register field instruction implemented on the POWER4
14181 processor and other processors that support the PowerPC V2.01
14182 architecture.
14183 The @option{-mpopcntb} option allows GCC to generate the popcount and
14184 double precision FP reciprocal estimate instruction implemented on the
14185 POWER5 processor and other processors that support the PowerPC V2.02
14186 architecture.
14187 The @option{-mfprnd} option allows GCC to generate the FP round to
14188 integer instructions implemented on the POWER5+ processor and other
14189 processors that support the PowerPC V2.03 architecture.
14190 The @option{-mcmpb} option allows GCC to generate the compare bytes
14191 instruction implemented on the POWER6 processor and other processors
14192 that support the PowerPC V2.05 architecture.
14193 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14194 general purpose register instructions implemented on the POWER6X
14195 processor and other processors that support the extended PowerPC V2.05
14196 architecture.
14197 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14198 point instructions implemented on some POWER processors.
14200 The @option{-mpowerpc64} option allows GCC to generate the additional
14201 64-bit instructions that are found in the full PowerPC64 architecture
14202 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14203 @option{-mno-powerpc64}.
14205 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14206 will use only the instructions in the common subset of both
14207 architectures plus some special AIX common-mode calls, and will not use
14208 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14209 permits GCC to use any instruction from either architecture and to
14210 allow use of the MQ register; specify this for the Motorola MPC601.
14212 @item -mnew-mnemonics
14213 @itemx -mold-mnemonics
14214 @opindex mnew-mnemonics
14215 @opindex mold-mnemonics
14216 Select which mnemonics to use in the generated assembler code.  With
14217 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14218 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14219 assembler mnemonics defined for the POWER architecture.  Instructions
14220 defined in only one architecture have only one mnemonic; GCC uses that
14221 mnemonic irrespective of which of these options is specified.
14223 GCC defaults to the mnemonics appropriate for the architecture in
14224 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14225 value of these option.  Unless you are building a cross-compiler, you
14226 should normally not specify either @option{-mnew-mnemonics} or
14227 @option{-mold-mnemonics}, but should instead accept the default.
14229 @item -mcpu=@var{cpu_type}
14230 @opindex mcpu
14231 Set architecture type, register usage, choice of mnemonics, and
14232 instruction scheduling parameters for machine type @var{cpu_type}.
14233 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14234 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14235 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
14236 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
14237 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14238 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
14239 @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
14240 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
14241 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{power7}
14242 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14243 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14245 @option{-mcpu=common} selects a completely generic processor.  Code
14246 generated under this option will run on any POWER or PowerPC processor.
14247 GCC will use only the instructions in the common subset of both
14248 architectures, and will not use the MQ register.  GCC assumes a generic
14249 processor model for scheduling purposes.
14251 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14252 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14253 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14254 types, with an appropriate, generic processor model assumed for
14255 scheduling purposes.
14257 The other options specify a specific processor.  Code generated under
14258 those options will run best on that processor, and may not run at all on
14259 others.
14261 The @option{-mcpu} options automatically enable or disable the
14262 following options:
14264 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14265 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
14266 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14267 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
14269 The particular options set for any particular CPU will vary between
14270 compiler versions, depending on what setting seems to produce optimal
14271 code for that CPU; it doesn't necessarily reflect the actual hardware's
14272 capabilities.  If you wish to set an individual option to a particular
14273 value, you may specify it after the @option{-mcpu} option, like
14274 @samp{-mcpu=970 -mno-altivec}.
14276 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14277 not enabled or disabled by the @option{-mcpu} option at present because
14278 AIX does not have full support for these options.  You may still
14279 enable or disable them individually if you're sure it'll work in your
14280 environment.
14282 @item -mtune=@var{cpu_type}
14283 @opindex mtune
14284 Set the instruction scheduling parameters for machine type
14285 @var{cpu_type}, but do not set the architecture type, register usage, or
14286 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14287 values for @var{cpu_type} are used for @option{-mtune} as for
14288 @option{-mcpu}.  If both are specified, the code generated will use the
14289 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14290 scheduling parameters set by @option{-mtune}.
14292 @item -mswdiv
14293 @itemx -mno-swdiv
14294 @opindex mswdiv
14295 @opindex mno-swdiv
14296 Generate code to compute division as reciprocal estimate and iterative
14297 refinement, creating opportunities for increased throughput.  This
14298 feature requires: optional PowerPC Graphics instruction set for single
14299 precision and FRE instruction for double precision, assuming divides
14300 cannot generate user-visible traps, and the domain values not include
14301 Infinities, denormals or zero denominator.
14303 @item -maltivec
14304 @itemx -mno-altivec
14305 @opindex maltivec
14306 @opindex mno-altivec
14307 Generate code that uses (does not use) AltiVec instructions, and also
14308 enable the use of built-in functions that allow more direct access to
14309 the AltiVec instruction set.  You may also need to set
14310 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14311 enhancements.
14313 @item -mvrsave
14314 @itemx -mno-vrsave
14315 @opindex mvrsave
14316 @opindex mno-vrsave
14317 Generate VRSAVE instructions when generating AltiVec code.
14319 @item -mgen-cell-microcode
14320 @opindex mgen-cell-microcode
14321 Generate Cell microcode instructions
14323 @item -mwarn-cell-microcode
14324 @opindex mwarn-cell-microcode
14325 Warning when a Cell microcode instruction is going to emitted.  An example
14326 of a Cell microcode instruction is a variable shift.
14328 @item -msecure-plt
14329 @opindex msecure-plt
14330 Generate code that allows ld and ld.so to build executables and shared
14331 libraries with non-exec .plt and .got sections.  This is a PowerPC
14332 32-bit SYSV ABI option.
14334 @item -mbss-plt
14335 @opindex mbss-plt
14336 Generate code that uses a BSS .plt section that ld.so fills in, and
14337 requires .plt and .got sections that are both writable and executable.
14338 This is a PowerPC 32-bit SYSV ABI option.
14340 @item -misel
14341 @itemx -mno-isel
14342 @opindex misel
14343 @opindex mno-isel
14344 This switch enables or disables the generation of ISEL instructions.
14346 @item -misel=@var{yes/no}
14347 This switch has been deprecated.  Use @option{-misel} and
14348 @option{-mno-isel} instead.
14350 @item -mspe
14351 @itemx -mno-spe
14352 @opindex mspe
14353 @opindex mno-spe
14354 This switch enables or disables the generation of SPE simd
14355 instructions.
14357 @item -mpaired
14358 @itemx -mno-paired
14359 @opindex mpaired
14360 @opindex mno-paired
14361 This switch enables or disables the generation of PAIRED simd
14362 instructions.
14364 @item -mspe=@var{yes/no}
14365 This option has been deprecated.  Use @option{-mspe} and
14366 @option{-mno-spe} instead.
14368 @item -mfloat-gprs=@var{yes/single/double/no}
14369 @itemx -mfloat-gprs
14370 @opindex mfloat-gprs
14371 This switch enables or disables the generation of floating point
14372 operations on the general purpose registers for architectures that
14373 support it.
14375 The argument @var{yes} or @var{single} enables the use of
14376 single-precision floating point operations.
14378 The argument @var{double} enables the use of single and
14379 double-precision floating point operations.
14381 The argument @var{no} disables floating point operations on the
14382 general purpose registers.
14384 This option is currently only available on the MPC854x.
14386 @item -m32
14387 @itemx -m64
14388 @opindex m32
14389 @opindex m64
14390 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14391 targets (including GNU/Linux).  The 32-bit environment sets int, long
14392 and pointer to 32 bits and generates code that runs on any PowerPC
14393 variant.  The 64-bit environment sets int to 32 bits and long and
14394 pointer to 64 bits, and generates code for PowerPC64, as for
14395 @option{-mpowerpc64}.
14397 @item -mfull-toc
14398 @itemx -mno-fp-in-toc
14399 @itemx -mno-sum-in-toc
14400 @itemx -mminimal-toc
14401 @opindex mfull-toc
14402 @opindex mno-fp-in-toc
14403 @opindex mno-sum-in-toc
14404 @opindex mminimal-toc
14405 Modify generation of the TOC (Table Of Contents), which is created for
14406 every executable file.  The @option{-mfull-toc} option is selected by
14407 default.  In that case, GCC will allocate at least one TOC entry for
14408 each unique non-automatic variable reference in your program.  GCC
14409 will also place floating-point constants in the TOC@.  However, only
14410 16,384 entries are available in the TOC@.
14412 If you receive a linker error message that saying you have overflowed
14413 the available TOC space, you can reduce the amount of TOC space used
14414 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14415 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14416 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14417 generate code to calculate the sum of an address and a constant at
14418 run-time instead of putting that sum into the TOC@.  You may specify one
14419 or both of these options.  Each causes GCC to produce very slightly
14420 slower and larger code at the expense of conserving TOC space.
14422 If you still run out of space in the TOC even when you specify both of
14423 these options, specify @option{-mminimal-toc} instead.  This option causes
14424 GCC to make only one TOC entry for every file.  When you specify this
14425 option, GCC will produce code that is slower and larger but which
14426 uses extremely little TOC space.  You may wish to use this option
14427 only on files that contain less frequently executed code.
14429 @item -maix64
14430 @itemx -maix32
14431 @opindex maix64
14432 @opindex maix32
14433 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14434 @code{long} type, and the infrastructure needed to support them.
14435 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14436 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14437 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14439 @item -mxl-compat
14440 @itemx -mno-xl-compat
14441 @opindex mxl-compat
14442 @opindex mno-xl-compat
14443 Produce code that conforms more closely to IBM XL compiler semantics
14444 when using AIX-compatible ABI@.  Pass floating-point arguments to
14445 prototyped functions beyond the register save area (RSA) on the stack
14446 in addition to argument FPRs.  Do not assume that most significant
14447 double in 128-bit long double value is properly rounded when comparing
14448 values and converting to double.  Use XL symbol names for long double
14449 support routines.
14451 The AIX calling convention was extended but not initially documented to
14452 handle an obscure K&R C case of calling a function that takes the
14453 address of its arguments with fewer arguments than declared.  IBM XL
14454 compilers access floating point arguments which do not fit in the
14455 RSA from the stack when a subroutine is compiled without
14456 optimization.  Because always storing floating-point arguments on the
14457 stack is inefficient and rarely needed, this option is not enabled by
14458 default and only is necessary when calling subroutines compiled by IBM
14459 XL compilers without optimization.
14461 @item -mpe
14462 @opindex mpe
14463 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
14464 application written to use message passing with special startup code to
14465 enable the application to run.  The system must have PE installed in the
14466 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
14467 must be overridden with the @option{-specs=} option to specify the
14468 appropriate directory location.  The Parallel Environment does not
14469 support threads, so the @option{-mpe} option and the @option{-pthread}
14470 option are incompatible.
14472 @item -malign-natural
14473 @itemx -malign-power
14474 @opindex malign-natural
14475 @opindex malign-power
14476 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
14477 @option{-malign-natural} overrides the ABI-defined alignment of larger
14478 types, such as floating-point doubles, on their natural size-based boundary.
14479 The option @option{-malign-power} instructs GCC to follow the ABI-specified
14480 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
14482 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
14483 is not supported.
14485 @item -msoft-float
14486 @itemx -mhard-float
14487 @opindex msoft-float
14488 @opindex mhard-float
14489 Generate code that does not use (uses) the floating-point register set.
14490 Software floating point emulation is provided if you use the
14491 @option{-msoft-float} option, and pass the option to GCC when linking.
14493 @item -msingle-float
14494 @itemx -mdouble-float
14495 @opindex msingle-float
14496 @opindex mdouble-float
14497 Generate code for single or double-precision floating point operations.
14498 @option{-mdouble-float} implies @option{-msingle-float}.
14500 @item -msimple-fpu
14501 @opindex msimple-fpu
14502 Do not generate sqrt and div instructions for hardware floating point unit.
14504 @item -mfpu
14505 @opindex mfpu
14506 Specify type of floating point unit.  Valid values are @var{sp_lite}
14507 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
14508 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
14509 and @var{dp_full} (equivalent to -mdouble-float).
14511 @item -mxilinx-fpu
14512 @opindex mxilinx-fpu
14513 Perform optimizations for floating point unit on Xilinx PPC 405/440.
14515 @item -mmultiple
14516 @itemx -mno-multiple
14517 @opindex mmultiple
14518 @opindex mno-multiple
14519 Generate code that uses (does not use) the load multiple word
14520 instructions and the store multiple word instructions.  These
14521 instructions are generated by default on POWER systems, and not
14522 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
14523 endian PowerPC systems, since those instructions do not work when the
14524 processor is in little endian mode.  The exceptions are PPC740 and
14525 PPC750 which permit the instructions usage in little endian mode.
14527 @item -mstring
14528 @itemx -mno-string
14529 @opindex mstring
14530 @opindex mno-string
14531 Generate code that uses (does not use) the load string instructions
14532 and the store string word instructions to save multiple registers and
14533 do small block moves.  These instructions are generated by default on
14534 POWER systems, and not generated on PowerPC systems.  Do not use
14535 @option{-mstring} on little endian PowerPC systems, since those
14536 instructions do not work when the processor is in little endian mode.
14537 The exceptions are PPC740 and PPC750 which permit the instructions
14538 usage in little endian mode.
14540 @item -mupdate
14541 @itemx -mno-update
14542 @opindex mupdate
14543 @opindex mno-update
14544 Generate code that uses (does not use) the load or store instructions
14545 that update the base register to the address of the calculated memory
14546 location.  These instructions are generated by default.  If you use
14547 @option{-mno-update}, there is a small window between the time that the
14548 stack pointer is updated and the address of the previous frame is
14549 stored, which means code that walks the stack frame across interrupts or
14550 signals may get corrupted data.
14552 @item -mavoid-indexed-addresses
14553 @item -mno-avoid-indexed-addresses
14554 @opindex mavoid-indexed-addresses
14555 @opindex mno-avoid-indexed-addresses
14556 Generate code that tries to avoid (not avoid) the use of indexed load
14557 or store instructions. These instructions can incur a performance
14558 penalty on Power6 processors in certain situations, such as when
14559 stepping through large arrays that cross a 16M boundary.  This option
14560 is enabled by default when targetting Power6 and disabled otherwise.
14562 @item -mfused-madd
14563 @itemx -mno-fused-madd
14564 @opindex mfused-madd
14565 @opindex mno-fused-madd
14566 Generate code that uses (does not use) the floating point multiply and
14567 accumulate instructions.  These instructions are generated by default if
14568 hardware floating is used.
14570 @item -mmulhw
14571 @itemx -mno-mulhw
14572 @opindex mmulhw
14573 @opindex mno-mulhw
14574 Generate code that uses (does not use) the half-word multiply and
14575 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
14576 These instructions are generated by default when targetting those
14577 processors.
14579 @item -mdlmzb
14580 @itemx -mno-dlmzb
14581 @opindex mdlmzb
14582 @opindex mno-dlmzb
14583 Generate code that uses (does not use) the string-search @samp{dlmzb}
14584 instruction on the IBM 405, 440 and 464 processors.  This instruction is
14585 generated by default when targetting those processors.
14587 @item -mno-bit-align
14588 @itemx -mbit-align
14589 @opindex mno-bit-align
14590 @opindex mbit-align
14591 On System V.4 and embedded PowerPC systems do not (do) force structures
14592 and unions that contain bit-fields to be aligned to the base type of the
14593 bit-field.
14595 For example, by default a structure containing nothing but 8
14596 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
14597 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
14598 the structure would be aligned to a 1 byte boundary and be one byte in
14599 size.
14601 @item -mno-strict-align
14602 @itemx -mstrict-align
14603 @opindex mno-strict-align
14604 @opindex mstrict-align
14605 On System V.4 and embedded PowerPC systems do not (do) assume that
14606 unaligned memory references will be handled by the system.
14608 @item -mrelocatable
14609 @itemx -mno-relocatable
14610 @opindex mrelocatable
14611 @opindex mno-relocatable
14612 On embedded PowerPC systems generate code that allows (does not allow)
14613 the program to be relocated to a different address at runtime.  If you
14614 use @option{-mrelocatable} on any module, all objects linked together must
14615 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
14617 @item -mrelocatable-lib
14618 @itemx -mno-relocatable-lib
14619 @opindex mrelocatable-lib
14620 @opindex mno-relocatable-lib
14621 On embedded PowerPC systems generate code that allows (does not allow)
14622 the program to be relocated to a different address at runtime.  Modules
14623 compiled with @option{-mrelocatable-lib} can be linked with either modules
14624 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
14625 with modules compiled with the @option{-mrelocatable} options.
14627 @item -mno-toc
14628 @itemx -mtoc
14629 @opindex mno-toc
14630 @opindex mtoc
14631 On System V.4 and embedded PowerPC systems do not (do) assume that
14632 register 2 contains a pointer to a global area pointing to the addresses
14633 used in the program.
14635 @item -mlittle
14636 @itemx -mlittle-endian
14637 @opindex mlittle
14638 @opindex mlittle-endian
14639 On System V.4 and embedded PowerPC systems compile code for the
14640 processor in little endian mode.  The @option{-mlittle-endian} option is
14641 the same as @option{-mlittle}.
14643 @item -mbig
14644 @itemx -mbig-endian
14645 @opindex mbig
14646 @opindex mbig-endian
14647 On System V.4 and embedded PowerPC systems compile code for the
14648 processor in big endian mode.  The @option{-mbig-endian} option is
14649 the same as @option{-mbig}.
14651 @item -mdynamic-no-pic
14652 @opindex mdynamic-no-pic
14653 On Darwin and Mac OS X systems, compile code so that it is not
14654 relocatable, but that its external references are relocatable.  The
14655 resulting code is suitable for applications, but not shared
14656 libraries.
14658 @item -mprioritize-restricted-insns=@var{priority}
14659 @opindex mprioritize-restricted-insns
14660 This option controls the priority that is assigned to
14661 dispatch-slot restricted instructions during the second scheduling
14662 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
14663 @var{no/highest/second-highest} priority to dispatch slot restricted
14664 instructions.
14666 @item -msched-costly-dep=@var{dependence_type}
14667 @opindex msched-costly-dep
14668 This option controls which dependences are considered costly
14669 by the target during instruction scheduling.  The argument
14670 @var{dependence_type} takes one of the following values:
14671 @var{no}: no dependence is costly,
14672 @var{all}: all dependences are costly,
14673 @var{true_store_to_load}: a true dependence from store to load is costly,
14674 @var{store_to_load}: any dependence from store to load is costly,
14675 @var{number}: any dependence which latency >= @var{number} is costly.
14677 @item -minsert-sched-nops=@var{scheme}
14678 @opindex minsert-sched-nops
14679 This option controls which nop insertion scheme will be used during
14680 the second scheduling pass.  The argument @var{scheme} takes one of the
14681 following values:
14682 @var{no}: Don't insert nops.
14683 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
14684 according to the scheduler's grouping.
14685 @var{regroup_exact}: Insert nops to force costly dependent insns into
14686 separate groups.  Insert exactly as many nops as needed to force an insn
14687 to a new group, according to the estimated processor grouping.
14688 @var{number}: Insert nops to force costly dependent insns into
14689 separate groups.  Insert @var{number} nops to force an insn to a new group.
14691 @item -mcall-sysv
14692 @opindex mcall-sysv
14693 On System V.4 and embedded PowerPC systems compile code using calling
14694 conventions that adheres to the March 1995 draft of the System V
14695 Application Binary Interface, PowerPC processor supplement.  This is the
14696 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
14698 @item -mcall-sysv-eabi
14699 @itemx -mcall-eabi
14700 @opindex mcall-sysv-eabi
14701 @opindex mcall-eabi
14702 Specify both @option{-mcall-sysv} and @option{-meabi} options.
14704 @item -mcall-sysv-noeabi
14705 @opindex mcall-sysv-noeabi
14706 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
14708 @item -mcall-aixdesc
14709 @opindex m
14710 On System V.4 and embedded PowerPC systems compile code for the AIX
14711 operating system.
14713 @item -mcall-linux
14714 @opindex mcall-linux
14715 On System V.4 and embedded PowerPC systems compile code for the
14716 Linux-based GNU system.
14718 @item -mcall-gnu
14719 @opindex mcall-gnu
14720 On System V.4 and embedded PowerPC systems compile code for the
14721 Hurd-based GNU system.
14723 @item -mcall-freebsd
14724 @opindex mcall-freebsd
14725 On System V.4 and embedded PowerPC systems compile code for the
14726 FreeBSD operating system.
14728 @item -mcall-netbsd
14729 @opindex mcall-netbsd
14730 On System V.4 and embedded PowerPC systems compile code for the
14731 NetBSD operating system.
14733 @item -mcall-openbsd
14734 @opindex mcall-netbsd
14735 On System V.4 and embedded PowerPC systems compile code for the
14736 OpenBSD operating system.
14738 @item -maix-struct-return
14739 @opindex maix-struct-return
14740 Return all structures in memory (as specified by the AIX ABI)@.
14742 @item -msvr4-struct-return
14743 @opindex msvr4-struct-return
14744 Return structures smaller than 8 bytes in registers (as specified by the
14745 SVR4 ABI)@.
14747 @item -mabi=@var{abi-type}
14748 @opindex mabi
14749 Extend the current ABI with a particular extension, or remove such extension.
14750 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
14751 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
14753 @item -mabi=spe
14754 @opindex mabi=spe
14755 Extend the current ABI with SPE ABI extensions.  This does not change
14756 the default ABI, instead it adds the SPE ABI extensions to the current
14757 ABI@.
14759 @item -mabi=no-spe
14760 @opindex mabi=no-spe
14761 Disable Booke SPE ABI extensions for the current ABI@.
14763 @item -mabi=ibmlongdouble
14764 @opindex mabi=ibmlongdouble
14765 Change the current ABI to use IBM extended precision long double.
14766 This is a PowerPC 32-bit SYSV ABI option.
14768 @item -mabi=ieeelongdouble
14769 @opindex mabi=ieeelongdouble
14770 Change the current ABI to use IEEE extended precision long double.
14771 This is a PowerPC 32-bit Linux ABI option.
14773 @item -mprototype
14774 @itemx -mno-prototype
14775 @opindex mprototype
14776 @opindex mno-prototype
14777 On System V.4 and embedded PowerPC systems assume that all calls to
14778 variable argument functions are properly prototyped.  Otherwise, the
14779 compiler must insert an instruction before every non prototyped call to
14780 set or clear bit 6 of the condition code register (@var{CR}) to
14781 indicate whether floating point values were passed in the floating point
14782 registers in case the function takes a variable arguments.  With
14783 @option{-mprototype}, only calls to prototyped variable argument functions
14784 will set or clear the bit.
14786 @item -msim
14787 @opindex msim
14788 On embedded PowerPC systems, assume that the startup module is called
14789 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
14790 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
14791 configurations.
14793 @item -mmvme
14794 @opindex mmvme
14795 On embedded PowerPC systems, assume that the startup module is called
14796 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
14797 @file{libc.a}.
14799 @item -mads
14800 @opindex mads
14801 On embedded PowerPC systems, assume that the startup module is called
14802 @file{crt0.o} and the standard C libraries are @file{libads.a} and
14803 @file{libc.a}.
14805 @item -myellowknife
14806 @opindex myellowknife
14807 On embedded PowerPC systems, assume that the startup module is called
14808 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
14809 @file{libc.a}.
14811 @item -mvxworks
14812 @opindex mvxworks
14813 On System V.4 and embedded PowerPC systems, specify that you are
14814 compiling for a VxWorks system.
14816 @item -memb
14817 @opindex memb
14818 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
14819 header to indicate that @samp{eabi} extended relocations are used.
14821 @item -meabi
14822 @itemx -mno-eabi
14823 @opindex meabi
14824 @opindex mno-eabi
14825 On System V.4 and embedded PowerPC systems do (do not) adhere to the
14826 Embedded Applications Binary Interface (eabi) which is a set of
14827 modifications to the System V.4 specifications.  Selecting @option{-meabi}
14828 means that the stack is aligned to an 8 byte boundary, a function
14829 @code{__eabi} is called to from @code{main} to set up the eabi
14830 environment, and the @option{-msdata} option can use both @code{r2} and
14831 @code{r13} to point to two separate small data areas.  Selecting
14832 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
14833 do not call an initialization function from @code{main}, and the
14834 @option{-msdata} option will only use @code{r13} to point to a single
14835 small data area.  The @option{-meabi} option is on by default if you
14836 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
14838 @item -msdata=eabi
14839 @opindex msdata=eabi
14840 On System V.4 and embedded PowerPC systems, put small initialized
14841 @code{const} global and static data in the @samp{.sdata2} section, which
14842 is pointed to by register @code{r2}.  Put small initialized
14843 non-@code{const} global and static data in the @samp{.sdata} section,
14844 which is pointed to by register @code{r13}.  Put small uninitialized
14845 global and static data in the @samp{.sbss} section, which is adjacent to
14846 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
14847 incompatible with the @option{-mrelocatable} option.  The
14848 @option{-msdata=eabi} option also sets the @option{-memb} option.
14850 @item -msdata=sysv
14851 @opindex msdata=sysv
14852 On System V.4 and embedded PowerPC systems, put small global and static
14853 data in the @samp{.sdata} section, which is pointed to by register
14854 @code{r13}.  Put small uninitialized global and static data in the
14855 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
14856 The @option{-msdata=sysv} option is incompatible with the
14857 @option{-mrelocatable} option.
14859 @item -msdata=default
14860 @itemx -msdata
14861 @opindex msdata=default
14862 @opindex msdata
14863 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
14864 compile code the same as @option{-msdata=eabi}, otherwise compile code the
14865 same as @option{-msdata=sysv}.
14867 @item -msdata=data
14868 @opindex msdata=data
14869 On System V.4 and embedded PowerPC systems, put small global
14870 data in the @samp{.sdata} section.  Put small uninitialized global
14871 data in the @samp{.sbss} section.  Do not use register @code{r13}
14872 to address small data however.  This is the default behavior unless
14873 other @option{-msdata} options are used.
14875 @item -msdata=none
14876 @itemx -mno-sdata
14877 @opindex msdata=none
14878 @opindex mno-sdata
14879 On embedded PowerPC systems, put all initialized global and static data
14880 in the @samp{.data} section, and all uninitialized data in the
14881 @samp{.bss} section.
14883 @item -G @var{num}
14884 @opindex G
14885 @cindex smaller data references (PowerPC)
14886 @cindex .sdata/.sdata2 references (PowerPC)
14887 On embedded PowerPC systems, put global and static items less than or
14888 equal to @var{num} bytes into the small data or bss sections instead of
14889 the normal data or bss section.  By default, @var{num} is 8.  The
14890 @option{-G @var{num}} switch is also passed to the linker.
14891 All modules should be compiled with the same @option{-G @var{num}} value.
14893 @item -mregnames
14894 @itemx -mno-regnames
14895 @opindex mregnames
14896 @opindex mno-regnames
14897 On System V.4 and embedded PowerPC systems do (do not) emit register
14898 names in the assembly language output using symbolic forms.
14900 @item -mlongcall
14901 @itemx -mno-longcall
14902 @opindex mlongcall
14903 @opindex mno-longcall
14904 By default assume that all calls are far away so that a longer more
14905 expensive calling sequence is required.  This is required for calls
14906 further than 32 megabytes (33,554,432 bytes) from the current location.
14907 A short call will be generated if the compiler knows
14908 the call cannot be that far away.  This setting can be overridden by
14909 the @code{shortcall} function attribute, or by @code{#pragma
14910 longcall(0)}.
14912 Some linkers are capable of detecting out-of-range calls and generating
14913 glue code on the fly.  On these systems, long calls are unnecessary and
14914 generate slower code.  As of this writing, the AIX linker can do this,
14915 as can the GNU linker for PowerPC/64.  It is planned to add this feature
14916 to the GNU linker for 32-bit PowerPC systems as well.
14918 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
14919 callee, L42'', plus a ``branch island'' (glue code).  The two target
14920 addresses represent the callee and the ``branch island''.  The
14921 Darwin/PPC linker will prefer the first address and generate a ``bl
14922 callee'' if the PPC ``bl'' instruction will reach the callee directly;
14923 otherwise, the linker will generate ``bl L42'' to call the ``branch
14924 island''.  The ``branch island'' is appended to the body of the
14925 calling function; it computes the full 32-bit address of the callee
14926 and jumps to it.
14928 On Mach-O (Darwin) systems, this option directs the compiler emit to
14929 the glue for every direct call, and the Darwin linker decides whether
14930 to use or discard it.
14932 In the future, we may cause GCC to ignore all longcall specifications
14933 when the linker is known to generate glue.
14935 @item -mtls-markers
14936 @itemx -mno-tls-markers
14937 @opindex mtls-markers
14938 @opindex mno-tls-markers
14939 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
14940 specifying the function argument.  The relocation allows ld to
14941 reliably associate function call with argument setup instructions for
14942 TLS optimization, which in turn allows gcc to better schedule the
14943 sequence.
14945 @item -pthread
14946 @opindex pthread
14947 Adds support for multithreading with the @dfn{pthreads} library.
14948 This option sets flags for both the preprocessor and linker.
14950 @end table
14952 @node S/390 and zSeries Options
14953 @subsection S/390 and zSeries Options
14954 @cindex S/390 and zSeries Options
14956 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
14958 @table @gcctabopt
14959 @item -mhard-float
14960 @itemx -msoft-float
14961 @opindex mhard-float
14962 @opindex msoft-float
14963 Use (do not use) the hardware floating-point instructions and registers
14964 for floating-point operations.  When @option{-msoft-float} is specified,
14965 functions in @file{libgcc.a} will be used to perform floating-point
14966 operations.  When @option{-mhard-float} is specified, the compiler
14967 generates IEEE floating-point instructions.  This is the default.
14969 @item -mhard-dfp
14970 @itemx -mno-hard-dfp
14971 @opindex mhard-dfp
14972 @opindex mno-hard-dfp
14973 Use (do not use) the hardware decimal-floating-point instructions for
14974 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
14975 specified, functions in @file{libgcc.a} will be used to perform
14976 decimal-floating-point operations.  When @option{-mhard-dfp} is
14977 specified, the compiler generates decimal-floating-point hardware
14978 instructions.  This is the default for @option{-march=z9-ec} or higher.
14980 @item -mlong-double-64
14981 @itemx -mlong-double-128
14982 @opindex mlong-double-64
14983 @opindex mlong-double-128
14984 These switches control the size of @code{long double} type. A size
14985 of 64bit makes the @code{long double} type equivalent to the @code{double}
14986 type. This is the default.
14988 @item -mbackchain
14989 @itemx -mno-backchain
14990 @opindex mbackchain
14991 @opindex mno-backchain
14992 Store (do not store) the address of the caller's frame as backchain pointer
14993 into the callee's stack frame.
14994 A backchain may be needed to allow debugging using tools that do not understand
14995 DWARF-2 call frame information.
14996 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
14997 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
14998 the backchain is placed into the topmost word of the 96/160 byte register
14999 save area.
15001 In general, code compiled with @option{-mbackchain} is call-compatible with
15002 code compiled with @option{-mmo-backchain}; however, use of the backchain
15003 for debugging purposes usually requires that the whole binary is built with
15004 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15005 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15006 to build a linux kernel use @option{-msoft-float}.
15008 The default is to not maintain the backchain.
15010 @item -mpacked-stack
15011 @itemx -mno-packed-stack
15012 @opindex mpacked-stack
15013 @opindex mno-packed-stack
15014 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15015 specified, the compiler uses the all fields of the 96/160 byte register save
15016 area only for their default purpose; unused fields still take up stack space.
15017 When @option{-mpacked-stack} is specified, register save slots are densely
15018 packed at the top of the register save area; unused space is reused for other
15019 purposes, allowing for more efficient use of the available stack space.
15020 However, when @option{-mbackchain} is also in effect, the topmost word of
15021 the save area is always used to store the backchain, and the return address
15022 register is always saved two words below the backchain.
15024 As long as the stack frame backchain is not used, code generated with
15025 @option{-mpacked-stack} is call-compatible with code generated with
15026 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15027 S/390 or zSeries generated code that uses the stack frame backchain at run
15028 time, not just for debugging purposes.  Such code is not call-compatible
15029 with code compiled with @option{-mpacked-stack}.  Also, note that the
15030 combination of @option{-mbackchain},
15031 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15032 to build a linux kernel use @option{-msoft-float}.
15034 The default is to not use the packed stack layout.
15036 @item -msmall-exec
15037 @itemx -mno-small-exec
15038 @opindex msmall-exec
15039 @opindex mno-small-exec
15040 Generate (or do not generate) code using the @code{bras} instruction
15041 to do subroutine calls.
15042 This only works reliably if the total executable size does not
15043 exceed 64k.  The default is to use the @code{basr} instruction instead,
15044 which does not have this limitation.
15046 @item -m64
15047 @itemx -m31
15048 @opindex m64
15049 @opindex m31
15050 When @option{-m31} is specified, generate code compliant to the
15051 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15052 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15053 particular to generate 64-bit instructions.  For the @samp{s390}
15054 targets, the default is @option{-m31}, while the @samp{s390x}
15055 targets default to @option{-m64}.
15057 @item -mzarch
15058 @itemx -mesa
15059 @opindex mzarch
15060 @opindex mesa
15061 When @option{-mzarch} is specified, generate code using the
15062 instructions available on z/Architecture.
15063 When @option{-mesa} is specified, generate code using the
15064 instructions available on ESA/390.  Note that @option{-mesa} is
15065 not possible with @option{-m64}.
15066 When generating code compliant to the GNU/Linux for S/390 ABI,
15067 the default is @option{-mesa}.  When generating code compliant
15068 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15070 @item -mmvcle
15071 @itemx -mno-mvcle
15072 @opindex mmvcle
15073 @opindex mno-mvcle
15074 Generate (or do not generate) code using the @code{mvcle} instruction
15075 to perform block moves.  When @option{-mno-mvcle} is specified,
15076 use a @code{mvc} loop instead.  This is the default unless optimizing for
15077 size.
15079 @item -mdebug
15080 @itemx -mno-debug
15081 @opindex mdebug
15082 @opindex mno-debug
15083 Print (or do not print) additional debug information when compiling.
15084 The default is to not print debug information.
15086 @item -march=@var{cpu-type}
15087 @opindex march
15088 Generate code that will run on @var{cpu-type}, which is the name of a system
15089 representing a certain processor type.  Possible values for
15090 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15091 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15092 When generating code using the instructions available on z/Architecture,
15093 the default is @option{-march=z900}.  Otherwise, the default is
15094 @option{-march=g5}.
15096 @item -mtune=@var{cpu-type}
15097 @opindex mtune
15098 Tune to @var{cpu-type} everything applicable about the generated code,
15099 except for the ABI and the set of available instructions.
15100 The list of @var{cpu-type} values is the same as for @option{-march}.
15101 The default is the value used for @option{-march}.
15103 @item -mtpf-trace
15104 @itemx -mno-tpf-trace
15105 @opindex mtpf-trace
15106 @opindex mno-tpf-trace
15107 Generate code that adds (does not add) in TPF OS specific branches to trace
15108 routines in the operating system.  This option is off by default, even
15109 when compiling for the TPF OS@.
15111 @item -mfused-madd
15112 @itemx -mno-fused-madd
15113 @opindex mfused-madd
15114 @opindex mno-fused-madd
15115 Generate code that uses (does not use) the floating point multiply and
15116 accumulate instructions.  These instructions are generated by default if
15117 hardware floating point is used.
15119 @item -mwarn-framesize=@var{framesize}
15120 @opindex mwarn-framesize
15121 Emit a warning if the current function exceeds the given frame size.  Because
15122 this is a compile time check it doesn't need to be a real problem when the program
15123 runs.  It is intended to identify functions which most probably cause
15124 a stack overflow.  It is useful to be used in an environment with limited stack
15125 size e.g.@: the linux kernel.
15127 @item -mwarn-dynamicstack
15128 @opindex mwarn-dynamicstack
15129 Emit a warning if the function calls alloca or uses dynamically
15130 sized arrays.  This is generally a bad idea with a limited stack size.
15132 @item -mstack-guard=@var{stack-guard}
15133 @itemx -mstack-size=@var{stack-size}
15134 @opindex mstack-guard
15135 @opindex mstack-size
15136 If these options are provided the s390 back end emits additional instructions in
15137 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15138 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15139 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15140 the frame size of the compiled function is chosen.
15141 These options are intended to be used to help debugging stack overflow problems.
15142 The additionally emitted code causes only little overhead and hence can also be
15143 used in production like systems without greater performance degradation.  The given
15144 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15145 @var{stack-guard} without exceeding 64k.
15146 In order to be efficient the extra code makes the assumption that the stack starts
15147 at an address aligned to the value given by @var{stack-size}.
15148 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15149 @end table
15151 @node Score Options
15152 @subsection Score Options
15153 @cindex Score Options
15155 These options are defined for Score implementations:
15157 @table @gcctabopt
15158 @item -meb
15159 @opindex meb
15160 Compile code for big endian mode.  This is the default.
15162 @item -mel
15163 @opindex mel
15164 Compile code for little endian mode.
15166 @item -mnhwloop
15167 @opindex mnhwloop
15168 Disable generate bcnz instruction.
15170 @item -muls
15171 @opindex muls
15172 Enable generate unaligned load and store instruction.
15174 @item -mmac
15175 @opindex mmac
15176 Enable the use of multiply-accumulate instructions. Disabled by default.
15178 @item -mscore5
15179 @opindex mscore5
15180 Specify the SCORE5 as the target architecture.
15182 @item -mscore5u
15183 @opindex mscore5u
15184 Specify the SCORE5U of the target architecture.
15186 @item -mscore7
15187 @opindex mscore7
15188 Specify the SCORE7 as the target architecture. This is the default.
15190 @item -mscore7d
15191 @opindex mscore7d
15192 Specify the SCORE7D as the target architecture.
15193 @end table
15195 @node SH Options
15196 @subsection SH Options
15198 These @samp{-m} options are defined for the SH implementations:
15200 @table @gcctabopt
15201 @item -m1
15202 @opindex m1
15203 Generate code for the SH1.
15205 @item -m2
15206 @opindex m2
15207 Generate code for the SH2.
15209 @item -m2e
15210 Generate code for the SH2e.
15212 @item -m2a-nofpu
15213 @opindex m2a-nofpu
15214 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15215 that the floating-point unit is not used.
15217 @item -m2a-single-only
15218 @opindex m2a-single-only
15219 Generate code for the SH2a-FPU, in such a way that no double-precision
15220 floating point operations are used.
15222 @item -m2a-single
15223 @opindex m2a-single
15224 Generate code for the SH2a-FPU assuming the floating-point unit is in
15225 single-precision mode by default.
15227 @item -m2a
15228 @opindex m2a
15229 Generate code for the SH2a-FPU assuming the floating-point unit is in
15230 double-precision mode by default.
15232 @item -m3
15233 @opindex m3
15234 Generate code for the SH3.
15236 @item -m3e
15237 @opindex m3e
15238 Generate code for the SH3e.
15240 @item -m4-nofpu
15241 @opindex m4-nofpu
15242 Generate code for the SH4 without a floating-point unit.
15244 @item -m4-single-only
15245 @opindex m4-single-only
15246 Generate code for the SH4 with a floating-point unit that only
15247 supports single-precision arithmetic.
15249 @item -m4-single
15250 @opindex m4-single
15251 Generate code for the SH4 assuming the floating-point unit is in
15252 single-precision mode by default.
15254 @item -m4
15255 @opindex m4
15256 Generate code for the SH4.
15258 @item -m4a-nofpu
15259 @opindex m4a-nofpu
15260 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15261 floating-point unit is not used.
15263 @item -m4a-single-only
15264 @opindex m4a-single-only
15265 Generate code for the SH4a, in such a way that no double-precision
15266 floating point operations are used.
15268 @item -m4a-single
15269 @opindex m4a-single
15270 Generate code for the SH4a assuming the floating-point unit is in
15271 single-precision mode by default.
15273 @item -m4a
15274 @opindex m4a
15275 Generate code for the SH4a.
15277 @item -m4al
15278 @opindex m4al
15279 Same as @option{-m4a-nofpu}, except that it implicitly passes
15280 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15281 instructions at the moment.
15283 @item -mb
15284 @opindex mb
15285 Compile code for the processor in big endian mode.
15287 @item -ml
15288 @opindex ml
15289 Compile code for the processor in little endian mode.
15291 @item -mdalign
15292 @opindex mdalign
15293 Align doubles at 64-bit boundaries.  Note that this changes the calling
15294 conventions, and thus some functions from the standard C library will
15295 not work unless you recompile it first with @option{-mdalign}.
15297 @item -mrelax
15298 @opindex mrelax
15299 Shorten some address references at link time, when possible; uses the
15300 linker option @option{-relax}.
15302 @item -mbigtable
15303 @opindex mbigtable
15304 Use 32-bit offsets in @code{switch} tables.  The default is to use
15305 16-bit offsets.
15307 @item -mbitops
15308 @opindex mbitops
15309 Enable the use of bit manipulation instructions on SH2A.
15311 @item -mfmovd
15312 @opindex mfmovd
15313 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15314 alignment constraints.
15316 @item -mhitachi
15317 @opindex mhitachi
15318 Comply with the calling conventions defined by Renesas.
15320 @item -mrenesas
15321 @opindex mhitachi
15322 Comply with the calling conventions defined by Renesas.
15324 @item -mno-renesas
15325 @opindex mhitachi
15326 Comply with the calling conventions defined for GCC before the Renesas
15327 conventions were available.  This option is the default for all
15328 targets of the SH toolchain except for @samp{sh-symbianelf}.
15330 @item -mnomacsave
15331 @opindex mnomacsave
15332 Mark the @code{MAC} register as call-clobbered, even if
15333 @option{-mhitachi} is given.
15335 @item -mieee
15336 @opindex mieee
15337 Increase IEEE-compliance of floating-point code.
15338 At the moment, this is equivalent to @option{-fno-finite-math-only}.
15339 When generating 16 bit SH opcodes, getting IEEE-conforming results for
15340 comparisons of NANs / infinities incurs extra overhead in every
15341 floating point comparison, therefore the default is set to
15342 @option{-ffinite-math-only}.
15344 @item -minline-ic_invalidate
15345 @opindex minline-ic_invalidate
15346 Inline code to invalidate instruction cache entries after setting up
15347 nested function trampolines.
15348 This option has no effect if -musermode is in effect and the selected
15349 code generation option (e.g. -m4) does not allow the use of the icbi
15350 instruction.
15351 If the selected code generation option does not allow the use of the icbi
15352 instruction, and -musermode is not in effect, the inlined code will
15353 manipulate the instruction cache address array directly with an associative
15354 write.  This not only requires privileged mode, but it will also
15355 fail if the cache line had been mapped via the TLB and has become unmapped.
15357 @item -misize
15358 @opindex misize
15359 Dump instruction size and location in the assembly code.
15361 @item -mpadstruct
15362 @opindex mpadstruct
15363 This option is deprecated.  It pads structures to multiple of 4 bytes,
15364 which is incompatible with the SH ABI@.
15366 @item -mspace
15367 @opindex mspace
15368 Optimize for space instead of speed.  Implied by @option{-Os}.
15370 @item -mprefergot
15371 @opindex mprefergot
15372 When generating position-independent code, emit function calls using
15373 the Global Offset Table instead of the Procedure Linkage Table.
15375 @item -musermode
15376 @opindex musermode
15377 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
15378 if the inlined code would not work in user mode.
15379 This is the default when the target is @code{sh-*-linux*}.
15381 @item -multcost=@var{number}
15382 @opindex multcost=@var{number}
15383 Set the cost to assume for a multiply insn.
15385 @item -mdiv=@var{strategy}
15386 @opindex mdiv=@var{strategy}
15387 Set the division strategy to use for SHmedia code.  @var{strategy} must be
15388 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
15389 inv:call2, inv:fp .
15390 "fp" performs the operation in floating point.  This has a very high latency,
15391 but needs only a few instructions, so it might be a good choice if
15392 your code has enough easily exploitable ILP to allow the compiler to
15393 schedule the floating point instructions together with other instructions.
15394 Division by zero causes a floating point exception.
15395 "inv" uses integer operations to calculate the inverse of the divisor,
15396 and then multiplies the dividend with the inverse.  This strategy allows
15397 cse and hoisting of the inverse calculation.  Division by zero calculates
15398 an unspecified result, but does not trap.
15399 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
15400 have been found, or if the entire operation has been hoisted to the same
15401 place, the last stages of the inverse calculation are intertwined with the
15402 final multiply to reduce the overall latency, at the expense of using a few
15403 more instructions, and thus offering fewer scheduling opportunities with
15404 other code.
15405 "call" calls a library function that usually implements the inv:minlat
15406 strategy.
15407 This gives high code density for m5-*media-nofpu compilations.
15408 "call2" uses a different entry point of the same library function, where it
15409 assumes that a pointer to a lookup table has already been set up, which
15410 exposes the pointer load to cse / code hoisting optimizations.
15411 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
15412 code generation, but if the code stays unoptimized, revert to the "call",
15413 "call2", or "fp" strategies, respectively.  Note that the
15414 potentially-trapping side effect of division by zero is carried by a
15415 separate instruction, so it is possible that all the integer instructions
15416 are hoisted out, but the marker for the side effect stays where it is.
15417 A recombination to fp operations or a call is not possible in that case.
15418 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
15419 that the inverse calculation was nor separated from the multiply, they speed
15420 up division where the dividend fits into 20 bits (plus sign where applicable),
15421 by inserting a test to skip a number of operations in this case; this test
15422 slows down the case of larger dividends.  inv20u assumes the case of a such
15423 a small dividend to be unlikely, and inv20l assumes it to be likely.
15425 @item -mdivsi3_libfunc=@var{name}
15426 @opindex mdivsi3_libfunc=@var{name}
15427 Set the name of the library function used for 32 bit signed division to
15428 @var{name}.  This only affect the name used in the call and inv:call
15429 division strategies, and the compiler will still expect the same
15430 sets of input/output/clobbered registers as if this option was not present.
15432 @item -mfixed-range=@var{register-range}
15433 @opindex mfixed-range
15434 Generate code treating the given register range as fixed registers.
15435 A fixed register is one that the register allocator can not use.  This is
15436 useful when compiling kernel code.  A register range is specified as
15437 two registers separated by a dash.  Multiple register ranges can be
15438 specified separated by a comma.
15440 @item -madjust-unroll
15441 @opindex madjust-unroll
15442 Throttle unrolling to avoid thrashing target registers.
15443 This option only has an effect if the gcc code base supports the
15444 TARGET_ADJUST_UNROLL_MAX target hook.
15446 @item -mindexed-addressing
15447 @opindex mindexed-addressing
15448 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
15449 This is only safe if the hardware and/or OS implement 32 bit wrap-around
15450 semantics for the indexed addressing mode.  The architecture allows the
15451 implementation of processors with 64 bit MMU, which the OS could use to
15452 get 32 bit addressing, but since no current hardware implementation supports
15453 this or any other way to make the indexed addressing mode safe to use in
15454 the 32 bit ABI, the default is -mno-indexed-addressing.
15456 @item -mgettrcost=@var{number}
15457 @opindex mgettrcost=@var{number}
15458 Set the cost assumed for the gettr instruction to @var{number}.
15459 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
15461 @item -mpt-fixed
15462 @opindex mpt-fixed
15463 Assume pt* instructions won't trap.  This will generally generate better
15464 scheduled code, but is unsafe on current hardware.  The current architecture
15465 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
15466 This has the unintentional effect of making it unsafe to schedule ptabs /
15467 ptrel before a branch, or hoist it out of a loop.  For example,
15468 __do_global_ctors, a part of libgcc that runs constructors at program
15469 startup, calls functions in a list which is delimited by @minus{}1.  With the
15470 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
15471 That means that all the constructors will be run a bit quicker, but when
15472 the loop comes to the end of the list, the program crashes because ptabs
15473 loads @minus{}1 into a target register.  Since this option is unsafe for any
15474 hardware implementing the current architecture specification, the default
15475 is -mno-pt-fixed.  Unless the user specifies a specific cost with
15476 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
15477 this deters register allocation using target registers for storing
15478 ordinary integers.
15480 @item -minvalid-symbols
15481 @opindex minvalid-symbols
15482 Assume symbols might be invalid.  Ordinary function symbols generated by
15483 the compiler will always be valid to load with movi/shori/ptabs or
15484 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
15485 to generate symbols that will cause ptabs / ptrel to trap.
15486 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
15487 It will then prevent cross-basic-block cse, hoisting and most scheduling
15488 of symbol loads.  The default is @option{-mno-invalid-symbols}.
15489 @end table
15491 @node SPARC Options
15492 @subsection SPARC Options
15493 @cindex SPARC options
15495 These @samp{-m} options are supported on the SPARC:
15497 @table @gcctabopt
15498 @item -mno-app-regs
15499 @itemx -mapp-regs
15500 @opindex mno-app-regs
15501 @opindex mapp-regs
15502 Specify @option{-mapp-regs} to generate output using the global registers
15503 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
15504 is the default.
15506 To be fully SVR4 ABI compliant at the cost of some performance loss,
15507 specify @option{-mno-app-regs}.  You should compile libraries and system
15508 software with this option.
15510 @item -mfpu
15511 @itemx -mhard-float
15512 @opindex mfpu
15513 @opindex mhard-float
15514 Generate output containing floating point instructions.  This is the
15515 default.
15517 @item -mno-fpu
15518 @itemx -msoft-float
15519 @opindex mno-fpu
15520 @opindex msoft-float
15521 Generate output containing library calls for floating point.
15522 @strong{Warning:} the requisite libraries are not available for all SPARC
15523 targets.  Normally the facilities of the machine's usual C compiler are
15524 used, but this cannot be done directly in cross-compilation.  You must make
15525 your own arrangements to provide suitable library functions for
15526 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
15527 @samp{sparclite-*-*} do provide software floating point support.
15529 @option{-msoft-float} changes the calling convention in the output file;
15530 therefore, it is only useful if you compile @emph{all} of a program with
15531 this option.  In particular, you need to compile @file{libgcc.a}, the
15532 library that comes with GCC, with @option{-msoft-float} in order for
15533 this to work.
15535 @item -mhard-quad-float
15536 @opindex mhard-quad-float
15537 Generate output containing quad-word (long double) floating point
15538 instructions.
15540 @item -msoft-quad-float
15541 @opindex msoft-quad-float
15542 Generate output containing library calls for quad-word (long double)
15543 floating point instructions.  The functions called are those specified
15544 in the SPARC ABI@.  This is the default.
15546 As of this writing, there are no SPARC implementations that have hardware
15547 support for the quad-word floating point instructions.  They all invoke
15548 a trap handler for one of these instructions, and then the trap handler
15549 emulates the effect of the instruction.  Because of the trap handler overhead,
15550 this is much slower than calling the ABI library routines.  Thus the
15551 @option{-msoft-quad-float} option is the default.
15553 @item -mno-unaligned-doubles
15554 @itemx -munaligned-doubles
15555 @opindex mno-unaligned-doubles
15556 @opindex munaligned-doubles
15557 Assume that doubles have 8 byte alignment.  This is the default.
15559 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
15560 alignment only if they are contained in another type, or if they have an
15561 absolute address.  Otherwise, it assumes they have 4 byte alignment.
15562 Specifying this option avoids some rare compatibility problems with code
15563 generated by other compilers.  It is not the default because it results
15564 in a performance loss, especially for floating point code.
15566 @item -mno-faster-structs
15567 @itemx -mfaster-structs
15568 @opindex mno-faster-structs
15569 @opindex mfaster-structs
15570 With @option{-mfaster-structs}, the compiler assumes that structures
15571 should have 8 byte alignment.  This enables the use of pairs of
15572 @code{ldd} and @code{std} instructions for copies in structure
15573 assignment, in place of twice as many @code{ld} and @code{st} pairs.
15574 However, the use of this changed alignment directly violates the SPARC
15575 ABI@.  Thus, it's intended only for use on targets where the developer
15576 acknowledges that their resulting code will not be directly in line with
15577 the rules of the ABI@.
15579 @item -mimpure-text
15580 @opindex mimpure-text
15581 @option{-mimpure-text}, used in addition to @option{-shared}, tells
15582 the compiler to not pass @option{-z text} to the linker when linking a
15583 shared object.  Using this option, you can link position-dependent
15584 code into a shared object.
15586 @option{-mimpure-text} suppresses the ``relocations remain against
15587 allocatable but non-writable sections'' linker error message.
15588 However, the necessary relocations will trigger copy-on-write, and the
15589 shared object is not actually shared across processes.  Instead of
15590 using @option{-mimpure-text}, you should compile all source code with
15591 @option{-fpic} or @option{-fPIC}.
15593 This option is only available on SunOS and Solaris.
15595 @item -mcpu=@var{cpu_type}
15596 @opindex mcpu
15597 Set the instruction set, register set, and instruction scheduling parameters
15598 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
15599 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
15600 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
15601 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
15602 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
15604 Default instruction scheduling parameters are used for values that select
15605 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
15606 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
15608 Here is a list of each supported architecture and their supported
15609 implementations.
15611 @smallexample
15612     v7:             cypress
15613     v8:             supersparc, hypersparc
15614     sparclite:      f930, f934, sparclite86x
15615     sparclet:       tsc701
15616     v9:             ultrasparc, ultrasparc3, niagara, niagara2
15617 @end smallexample
15619 By default (unless configured otherwise), GCC generates code for the V7
15620 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
15621 additionally optimizes it for the Cypress CY7C602 chip, as used in the
15622 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
15623 SPARCStation 1, 2, IPX etc.
15625 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
15626 architecture.  The only difference from V7 code is that the compiler emits
15627 the integer multiply and integer divide instructions which exist in SPARC-V8
15628 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
15629 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
15630 2000 series.
15632 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
15633 the SPARC architecture.  This adds the integer multiply, integer divide step
15634 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
15635 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
15636 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
15637 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
15638 MB86934 chip, which is the more recent SPARClite with FPU@.
15640 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
15641 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
15642 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
15643 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
15644 optimizes it for the TEMIC SPARClet chip.
15646 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
15647 architecture.  This adds 64-bit integer and floating-point move instructions,
15648 3 additional floating-point condition code registers and conditional move
15649 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
15650 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
15651 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
15652 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
15653 @option{-mcpu=niagara}, the compiler additionally optimizes it for
15654 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
15655 additionally optimizes it for Sun UltraSPARC T2 chips.
15657 @item -mtune=@var{cpu_type}
15658 @opindex mtune
15659 Set the instruction scheduling parameters for machine type
15660 @var{cpu_type}, but do not set the instruction set or register set that the
15661 option @option{-mcpu=@var{cpu_type}} would.
15663 The same values for @option{-mcpu=@var{cpu_type}} can be used for
15664 @option{-mtune=@var{cpu_type}}, but the only useful values are those
15665 that select a particular cpu implementation.  Those are @samp{cypress},
15666 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
15667 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
15668 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
15670 @item -mv8plus
15671 @itemx -mno-v8plus
15672 @opindex mv8plus
15673 @opindex mno-v8plus
15674 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
15675 difference from the V8 ABI is that the global and out registers are
15676 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
15677 mode for all SPARC-V9 processors.
15679 @item -mvis
15680 @itemx -mno-vis
15681 @opindex mvis
15682 @opindex mno-vis
15683 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
15684 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
15685 @end table
15687 These @samp{-m} options are supported in addition to the above
15688 on SPARC-V9 processors in 64-bit environments:
15690 @table @gcctabopt
15691 @item -mlittle-endian
15692 @opindex mlittle-endian
15693 Generate code for a processor running in little-endian mode.  It is only
15694 available for a few configurations and most notably not on Solaris and Linux.
15696 @item -m32
15697 @itemx -m64
15698 @opindex m32
15699 @opindex m64
15700 Generate code for a 32-bit or 64-bit environment.
15701 The 32-bit environment sets int, long and pointer to 32 bits.
15702 The 64-bit environment sets int to 32 bits and long and pointer
15703 to 64 bits.
15705 @item -mcmodel=medlow
15706 @opindex mcmodel=medlow
15707 Generate code for the Medium/Low code model: 64-bit addresses, programs
15708 must be linked in the low 32 bits of memory.  Programs can be statically
15709 or dynamically linked.
15711 @item -mcmodel=medmid
15712 @opindex mcmodel=medmid
15713 Generate code for the Medium/Middle code model: 64-bit addresses, programs
15714 must be linked in the low 44 bits of memory, the text and data segments must
15715 be less than 2GB in size and the data segment must be located within 2GB of
15716 the text segment.
15718 @item -mcmodel=medany
15719 @opindex mcmodel=medany
15720 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
15721 may be linked anywhere in memory, the text and data segments must be less
15722 than 2GB in size and the data segment must be located within 2GB of the
15723 text segment.
15725 @item -mcmodel=embmedany
15726 @opindex mcmodel=embmedany
15727 Generate code for the Medium/Anywhere code model for embedded systems:
15728 64-bit addresses, the text and data segments must be less than 2GB in
15729 size, both starting anywhere in memory (determined at link time).  The
15730 global register %g4 points to the base of the data segment.  Programs
15731 are statically linked and PIC is not supported.
15733 @item -mstack-bias
15734 @itemx -mno-stack-bias
15735 @opindex mstack-bias
15736 @opindex mno-stack-bias
15737 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
15738 frame pointer if present, are offset by @minus{}2047 which must be added back
15739 when making stack frame references.  This is the default in 64-bit mode.
15740 Otherwise, assume no such offset is present.
15741 @end table
15743 These switches are supported in addition to the above on Solaris:
15745 @table @gcctabopt
15746 @item -threads
15747 @opindex threads
15748 Add support for multithreading using the Solaris threads library.  This
15749 option sets flags for both the preprocessor and linker.  This option does
15750 not affect the thread safety of object code produced by the compiler or
15751 that of libraries supplied with it.
15753 @item -pthreads
15754 @opindex pthreads
15755 Add support for multithreading using the POSIX threads library.  This
15756 option sets flags for both the preprocessor and linker.  This option does
15757 not affect the thread safety of object code produced  by the compiler or
15758 that of libraries supplied with it.
15760 @item -pthread
15761 @opindex pthread
15762 This is a synonym for @option{-pthreads}.
15763 @end table
15765 @node SPU Options
15766 @subsection SPU Options
15767 @cindex SPU options
15769 These @samp{-m} options are supported on the SPU:
15771 @table @gcctabopt
15772 @item -mwarn-reloc
15773 @itemx -merror-reloc
15774 @opindex mwarn-reloc
15775 @opindex merror-reloc
15777 The loader for SPU does not handle dynamic relocations.  By default, GCC
15778 will give an error when it generates code that requires a dynamic
15779 relocation.  @option{-mno-error-reloc} disables the error,
15780 @option{-mwarn-reloc} will generate a warning instead.
15782 @item -msafe-dma
15783 @itemx -munsafe-dma
15784 @opindex msafe-dma
15785 @opindex munsafe-dma
15787 Instructions which initiate or test completion of DMA must not be
15788 reordered with respect to loads and stores of the memory which is being
15789 accessed.  Users typically address this problem using the volatile
15790 keyword, but that can lead to inefficient code in places where the
15791 memory is known to not change.  Rather than mark the memory as volatile
15792 we treat the DMA instructions as potentially effecting all memory.  With
15793 @option{-munsafe-dma} users must use the volatile keyword to protect
15794 memory accesses.
15796 @item -mbranch-hints
15797 @opindex mbranch-hints
15799 By default, GCC will generate a branch hint instruction to avoid
15800 pipeline stalls for always taken or probably taken branches.  A hint
15801 will not be generated closer than 8 instructions away from its branch.
15802 There is little reason to disable them, except for debugging purposes,
15803 or to make an object a little bit smaller.
15805 @item -msmall-mem
15806 @itemx -mlarge-mem
15807 @opindex msmall-mem
15808 @opindex mlarge-mem
15810 By default, GCC generates code assuming that addresses are never larger
15811 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
15812 a full 32 bit address.
15814 @item -mstdmain
15815 @opindex mstdmain
15817 By default, GCC links against startup code that assumes the SPU-style
15818 main function interface (which has an unconventional parameter list).
15819 With @option{-mstdmain}, GCC will link your program against startup
15820 code that assumes a C99-style interface to @code{main}, including a
15821 local copy of @code{argv} strings.
15823 @item -mfixed-range=@var{register-range}
15824 @opindex mfixed-range
15825 Generate code treating the given register range as fixed registers.
15826 A fixed register is one that the register allocator can not use.  This is
15827 useful when compiling kernel code.  A register range is specified as
15828 two registers separated by a dash.  Multiple register ranges can be
15829 specified separated by a comma.
15831 @item -mdual-nops
15832 @itemx -mdual-nops=@var{n}
15833 @opindex mdual-nops
15834 By default, GCC will insert nops to increase dual issue when it expects
15835 it to increase performance.  @var{n} can be a value from 0 to 10.  A
15836 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
15837 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
15839 @item -mhint-max-nops=@var{n}
15840 @opindex mhint-max-nops
15841 Maximum number of nops to insert for a branch hint.  A branch hint must
15842 be at least 8 instructions away from the branch it is effecting.  GCC
15843 will insert up to @var{n} nops to enforce this, otherwise it will not
15844 generate the branch hint.
15846 @item -mhint-max-distance=@var{n}
15847 @opindex mhint-max-distance
15848 The encoding of the branch hint instruction limits the hint to be within
15849 256 instructions of the branch it is effecting.  By default, GCC makes
15850 sure it is within 125.
15852 @item -msafe-hints
15853 @opindex msafe-hints
15854 Work around a hardware bug which causes the SPU to stall indefinitely.
15855 By default, GCC will insert the @code{hbrp} instruction to make sure
15856 this stall won't happen.
15858 @end table
15860 @node System V Options
15861 @subsection Options for System V
15863 These additional options are available on System V Release 4 for
15864 compatibility with other compilers on those systems:
15866 @table @gcctabopt
15867 @item -G
15868 @opindex G
15869 Create a shared object.
15870 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
15872 @item -Qy
15873 @opindex Qy
15874 Identify the versions of each tool used by the compiler, in a
15875 @code{.ident} assembler directive in the output.
15877 @item -Qn
15878 @opindex Qn
15879 Refrain from adding @code{.ident} directives to the output file (this is
15880 the default).
15882 @item -YP,@var{dirs}
15883 @opindex YP
15884 Search the directories @var{dirs}, and no others, for libraries
15885 specified with @option{-l}.
15887 @item -Ym,@var{dir}
15888 @opindex Ym
15889 Look in the directory @var{dir} to find the M4 preprocessor.
15890 The assembler uses this option.
15891 @c This is supposed to go with a -Yd for predefined M4 macro files, but
15892 @c the generic assembler that comes with Solaris takes just -Ym.
15893 @end table
15895 @node V850 Options
15896 @subsection V850 Options
15897 @cindex V850 Options
15899 These @samp{-m} options are defined for V850 implementations:
15901 @table @gcctabopt
15902 @item -mlong-calls
15903 @itemx -mno-long-calls
15904 @opindex mlong-calls
15905 @opindex mno-long-calls
15906 Treat all calls as being far away (near).  If calls are assumed to be
15907 far away, the compiler will always load the functions address up into a
15908 register, and call indirect through the pointer.
15910 @item -mno-ep
15911 @itemx -mep
15912 @opindex mno-ep
15913 @opindex mep
15914 Do not optimize (do optimize) basic blocks that use the same index
15915 pointer 4 or more times to copy pointer into the @code{ep} register, and
15916 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
15917 option is on by default if you optimize.
15919 @item -mno-prolog-function
15920 @itemx -mprolog-function
15921 @opindex mno-prolog-function
15922 @opindex mprolog-function
15923 Do not use (do use) external functions to save and restore registers
15924 at the prologue and epilogue of a function.  The external functions
15925 are slower, but use less code space if more than one function saves
15926 the same number of registers.  The @option{-mprolog-function} option
15927 is on by default if you optimize.
15929 @item -mspace
15930 @opindex mspace
15931 Try to make the code as small as possible.  At present, this just turns
15932 on the @option{-mep} and @option{-mprolog-function} options.
15934 @item -mtda=@var{n}
15935 @opindex mtda
15936 Put static or global variables whose size is @var{n} bytes or less into
15937 the tiny data area that register @code{ep} points to.  The tiny data
15938 area can hold up to 256 bytes in total (128 bytes for byte references).
15940 @item -msda=@var{n}
15941 @opindex msda
15942 Put static or global variables whose size is @var{n} bytes or less into
15943 the small data area that register @code{gp} points to.  The small data
15944 area can hold up to 64 kilobytes.
15946 @item -mzda=@var{n}
15947 @opindex mzda
15948 Put static or global variables whose size is @var{n} bytes or less into
15949 the first 32 kilobytes of memory.
15951 @item -mv850
15952 @opindex mv850
15953 Specify that the target processor is the V850.
15955 @item -mbig-switch
15956 @opindex mbig-switch
15957 Generate code suitable for big switch tables.  Use this option only if
15958 the assembler/linker complain about out of range branches within a switch
15959 table.
15961 @item -mapp-regs
15962 @opindex mapp-regs
15963 This option will cause r2 and r5 to be used in the code generated by
15964 the compiler.  This setting is the default.
15966 @item -mno-app-regs
15967 @opindex mno-app-regs
15968 This option will cause r2 and r5 to be treated as fixed registers.
15970 @item -mv850e1
15971 @opindex mv850e1
15972 Specify that the target processor is the V850E1.  The preprocessor
15973 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
15974 this option is used.
15976 @item -mv850e
15977 @opindex mv850e
15978 Specify that the target processor is the V850E@.  The preprocessor
15979 constant @samp{__v850e__} will be defined if this option is used.
15981 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
15982 are defined then a default target processor will be chosen and the
15983 relevant @samp{__v850*__} preprocessor constant will be defined.
15985 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
15986 defined, regardless of which processor variant is the target.
15988 @item -mdisable-callt
15989 @opindex mdisable-callt
15990 This option will suppress generation of the CALLT instruction for the
15991 v850e and v850e1 flavors of the v850 architecture.  The default is
15992 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
15994 @end table
15996 @node VAX Options
15997 @subsection VAX Options
15998 @cindex VAX options
16000 These @samp{-m} options are defined for the VAX:
16002 @table @gcctabopt
16003 @item -munix
16004 @opindex munix
16005 Do not output certain jump instructions (@code{aobleq} and so on)
16006 that the Unix assembler for the VAX cannot handle across long
16007 ranges.
16009 @item -mgnu
16010 @opindex mgnu
16011 Do output those jump instructions, on the assumption that you
16012 will assemble with the GNU assembler.
16014 @item -mg
16015 @opindex mg
16016 Output code for g-format floating point numbers instead of d-format.
16017 @end table
16019 @node VxWorks Options
16020 @subsection VxWorks Options
16021 @cindex VxWorks Options
16023 The options in this section are defined for all VxWorks targets.
16024 Options specific to the target hardware are listed with the other
16025 options for that target.
16027 @table @gcctabopt
16028 @item -mrtp
16029 @opindex mrtp
16030 GCC can generate code for both VxWorks kernels and real time processes
16031 (RTPs).  This option switches from the former to the latter.  It also
16032 defines the preprocessor macro @code{__RTP__}.
16034 @item -non-static
16035 @opindex non-static
16036 Link an RTP executable against shared libraries rather than static
16037 libraries.  The options @option{-static} and @option{-shared} can
16038 also be used for RTPs (@pxref{Link Options}); @option{-static}
16039 is the default.
16041 @item -Bstatic
16042 @itemx -Bdynamic
16043 @opindex Bstatic
16044 @opindex Bdynamic
16045 These options are passed down to the linker.  They are defined for
16046 compatibility with Diab.
16048 @item -Xbind-lazy
16049 @opindex Xbind-lazy
16050 Enable lazy binding of function calls.  This option is equivalent to
16051 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16053 @item -Xbind-now
16054 @opindex Xbind-now
16055 Disable lazy binding of function calls.  This option is the default and
16056 is defined for compatibility with Diab.
16057 @end table
16059 @node x86-64 Options
16060 @subsection x86-64 Options
16061 @cindex x86-64 options
16063 These are listed under @xref{i386 and x86-64 Options}.
16065 @node i386 and x86-64 Windows Options
16066 @subsection i386 and x86-64 Windows Options
16067 @cindex i386 and x86-64 Windows Options
16069 These additional options are available for Windows targets:
16071 @table @gcctabopt
16072 @item -mconsole
16073 @opindex mconsole
16074 This option is available for Cygwin and MinGW targets.  It
16075 specifies that a console application is to be generated, by
16076 instructing the linker to set the PE header subsystem type
16077 required for console applications.
16078 This is the default behavior for Cygwin and MinGW targets.
16080 @item -mcygwin
16081 @opindex mcygwin
16082 This option is available for Cygwin targets.  It specifies that
16083 the Cygwin internal interface is to be used for predefined
16084 preprocessor macros, C runtime libraries and related linker
16085 paths and options.  For Cygwin targets this is the default behavior.
16086 This option is deprecated and will be removed in a future release.
16088 @item -mno-cygwin
16089 @opindex mno-cygwin
16090 This option is available for Cygwin targets.  It specifies that
16091 the MinGW internal interface is to be used instead of Cygwin's, by
16092 setting MinGW-related predefined macros and linker paths and default
16093 library options.
16094 This option is deprecated and will be removed in a future release.
16096 @item -mdll
16097 @opindex mdll
16098 This option is available for Cygwin and MinGW targets.  It
16099 specifies that a DLL - a dynamic link library - is to be
16100 generated, enabling the selection of the required runtime
16101 startup object and entry point.
16103 @item -mnop-fun-dllimport
16104 @opindex mnop-fun-dllimport
16105 This option is available for Cygwin and MinGW targets.  It
16106 specifies that the dllimport attribute should be ignored.
16108 @item -mthread
16109 @opindex mthread
16110 This option is available for MinGW targets. It specifies
16111 that MinGW-specific thread support is to be used.
16113 @item -municode
16114 @opindex municode
16115 This option is available for mingw-w64 targets.  It specifies
16116 that the UNICODE macro is getting pre-defined and that the
16117 unicode capable runtime startup code is choosen.
16119 @item -mwin32
16120 @opindex mwin32
16121 This option is available for Cygwin and MinGW targets.  It
16122 specifies that the typical Windows pre-defined macros are to
16123 be set in the pre-processor, but does not influence the choice
16124 of runtime library/startup code.
16126 @item -mwindows
16127 @opindex mwindows
16128 This option is available for Cygwin and MinGW targets.  It
16129 specifies that a GUI application is to be generated by
16130 instructing the linker to set the PE header subsystem type
16131 appropriately.
16133 @item -mpe-aligned-commons
16134 @opindex mpe-aligned-commons
16135 This option is available for Cygwin and MinGW targets.  It
16136 specifies that the GNU extension to the PE file format that
16137 permits the correct alignment of COMMON variables should be
16138 used when generating code.  It will be enabled by default if
16139 GCC detects that the target assembler found during configuration
16140 supports the feature.
16141 @end table
16143 See also under @ref{i386 and x86-64 Options} for standard options.
16145 @node Xstormy16 Options
16146 @subsection Xstormy16 Options
16147 @cindex Xstormy16 Options
16149 These options are defined for Xstormy16:
16151 @table @gcctabopt
16152 @item -msim
16153 @opindex msim
16154 Choose startup files and linker script suitable for the simulator.
16155 @end table
16157 @node Xtensa Options
16158 @subsection Xtensa Options
16159 @cindex Xtensa Options
16161 These options are supported for Xtensa targets:
16163 @table @gcctabopt
16164 @item -mconst16
16165 @itemx -mno-const16
16166 @opindex mconst16
16167 @opindex mno-const16
16168 Enable or disable use of @code{CONST16} instructions for loading
16169 constant values.  The @code{CONST16} instruction is currently not a
16170 standard option from Tensilica.  When enabled, @code{CONST16}
16171 instructions are always used in place of the standard @code{L32R}
16172 instructions.  The use of @code{CONST16} is enabled by default only if
16173 the @code{L32R} instruction is not available.
16175 @item -mfused-madd
16176 @itemx -mno-fused-madd
16177 @opindex mfused-madd
16178 @opindex mno-fused-madd
16179 Enable or disable use of fused multiply/add and multiply/subtract
16180 instructions in the floating-point option.  This has no effect if the
16181 floating-point option is not also enabled.  Disabling fused multiply/add
16182 and multiply/subtract instructions forces the compiler to use separate
16183 instructions for the multiply and add/subtract operations.  This may be
16184 desirable in some cases where strict IEEE 754-compliant results are
16185 required: the fused multiply add/subtract instructions do not round the
16186 intermediate result, thereby producing results with @emph{more} bits of
16187 precision than specified by the IEEE standard.  Disabling fused multiply
16188 add/subtract instructions also ensures that the program output is not
16189 sensitive to the compiler's ability to combine multiply and add/subtract
16190 operations.
16192 @item -mserialize-volatile
16193 @itemx -mno-serialize-volatile
16194 @opindex mserialize-volatile
16195 @opindex mno-serialize-volatile
16196 When this option is enabled, GCC inserts @code{MEMW} instructions before
16197 @code{volatile} memory references to guarantee sequential consistency.
16198 The default is @option{-mserialize-volatile}.  Use
16199 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16201 @item -mtext-section-literals
16202 @itemx -mno-text-section-literals
16203 @opindex mtext-section-literals
16204 @opindex mno-text-section-literals
16205 Control the treatment of literal pools.  The default is
16206 @option{-mno-text-section-literals}, which places literals in a separate
16207 section in the output file.  This allows the literal pool to be placed
16208 in a data RAM/ROM, and it also allows the linker to combine literal
16209 pools from separate object files to remove redundant literals and
16210 improve code size.  With @option{-mtext-section-literals}, the literals
16211 are interspersed in the text section in order to keep them as close as
16212 possible to their references.  This may be necessary for large assembly
16213 files.
16215 @item -mtarget-align
16216 @itemx -mno-target-align
16217 @opindex mtarget-align
16218 @opindex mno-target-align
16219 When this option is enabled, GCC instructs the assembler to
16220 automatically align instructions to reduce branch penalties at the
16221 expense of some code density.  The assembler attempts to widen density
16222 instructions to align branch targets and the instructions following call
16223 instructions.  If there are not enough preceding safe density
16224 instructions to align a target, no widening will be performed.  The
16225 default is @option{-mtarget-align}.  These options do not affect the
16226 treatment of auto-aligned instructions like @code{LOOP}, which the
16227 assembler will always align, either by widening density instructions or
16228 by inserting no-op instructions.
16230 @item -mlongcalls
16231 @itemx -mno-longcalls
16232 @opindex mlongcalls
16233 @opindex mno-longcalls
16234 When this option is enabled, GCC instructs the assembler to translate
16235 direct calls to indirect calls unless it can determine that the target
16236 of a direct call is in the range allowed by the call instruction.  This
16237 translation typically occurs for calls to functions in other source
16238 files.  Specifically, the assembler translates a direct @code{CALL}
16239 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16240 The default is @option{-mno-longcalls}.  This option should be used in
16241 programs where the call target can potentially be out of range.  This
16242 option is implemented in the assembler, not the compiler, so the
16243 assembly code generated by GCC will still show direct call
16244 instructions---look at the disassembled object code to see the actual
16245 instructions.  Note that the assembler will use an indirect call for
16246 every cross-file call, not just those that really will be out of range.
16247 @end table
16249 @node zSeries Options
16250 @subsection zSeries Options
16251 @cindex zSeries options
16253 These are listed under @xref{S/390 and zSeries Options}.
16255 @node Code Gen Options
16256 @section Options for Code Generation Conventions
16257 @cindex code generation conventions
16258 @cindex options, code generation
16259 @cindex run-time options
16261 These machine-independent options control the interface conventions
16262 used in code generation.
16264 Most of them have both positive and negative forms; the negative form
16265 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16266 one of the forms is listed---the one which is not the default.  You
16267 can figure out the other form by either removing @samp{no-} or adding
16270 @table @gcctabopt
16271 @item -fbounds-check
16272 @opindex fbounds-check
16273 For front-ends that support it, generate additional code to check that
16274 indices used to access arrays are within the declared range.  This is
16275 currently only supported by the Java and Fortran front-ends, where
16276 this option defaults to true and false respectively.
16278 @item -ftrapv
16279 @opindex ftrapv
16280 This option generates traps for signed overflow on addition, subtraction,
16281 multiplication operations.
16283 @item -fwrapv
16284 @opindex fwrapv
16285 This option instructs the compiler to assume that signed arithmetic
16286 overflow of addition, subtraction and multiplication wraps around
16287 using twos-complement representation.  This flag enables some optimizations
16288 and disables others.  This option is enabled by default for the Java
16289 front-end, as required by the Java language specification.
16291 @item -fexceptions
16292 @opindex fexceptions
16293 Enable exception handling.  Generates extra code needed to propagate
16294 exceptions.  For some targets, this implies GCC will generate frame
16295 unwind information for all functions, which can produce significant data
16296 size overhead, although it does not affect execution.  If you do not
16297 specify this option, GCC will enable it by default for languages like
16298 C++ which normally require exception handling, and disable it for
16299 languages like C that do not normally require it.  However, you may need
16300 to enable this option when compiling C code that needs to interoperate
16301 properly with exception handlers written in C++.  You may also wish to
16302 disable this option if you are compiling older C++ programs that don't
16303 use exception handling.
16305 @item -fnon-call-exceptions
16306 @opindex fnon-call-exceptions
16307 Generate code that allows trapping instructions to throw exceptions.
16308 Note that this requires platform-specific runtime support that does
16309 not exist everywhere.  Moreover, it only allows @emph{trapping}
16310 instructions to throw exceptions, i.e.@: memory references or floating
16311 point instructions.  It does not allow exceptions to be thrown from
16312 arbitrary signal handlers such as @code{SIGALRM}.
16314 @item -funwind-tables
16315 @opindex funwind-tables
16316 Similar to @option{-fexceptions}, except that it will just generate any needed
16317 static data, but will not affect the generated code in any other way.
16318 You will normally not enable this option; instead, a language processor
16319 that needs this handling would enable it on your behalf.
16321 @item -fasynchronous-unwind-tables
16322 @opindex fasynchronous-unwind-tables
16323 Generate unwind table in dwarf2 format, if supported by target machine.  The
16324 table is exact at each instruction boundary, so it can be used for stack
16325 unwinding from asynchronous events (such as debugger or garbage collector).
16327 @item -fpcc-struct-return
16328 @opindex fpcc-struct-return
16329 Return ``short'' @code{struct} and @code{union} values in memory like
16330 longer ones, rather than in registers.  This convention is less
16331 efficient, but it has the advantage of allowing intercallability between
16332 GCC-compiled files and files compiled with other compilers, particularly
16333 the Portable C Compiler (pcc).
16335 The precise convention for returning structures in memory depends
16336 on the target configuration macros.
16338 Short structures and unions are those whose size and alignment match
16339 that of some integer type.
16341 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
16342 switch is not binary compatible with code compiled with the
16343 @option{-freg-struct-return} switch.
16344 Use it to conform to a non-default application binary interface.
16346 @item -freg-struct-return
16347 @opindex freg-struct-return
16348 Return @code{struct} and @code{union} values in registers when possible.
16349 This is more efficient for small structures than
16350 @option{-fpcc-struct-return}.
16352 If you specify neither @option{-fpcc-struct-return} nor
16353 @option{-freg-struct-return}, GCC defaults to whichever convention is
16354 standard for the target.  If there is no standard convention, GCC
16355 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
16356 the principal compiler.  In those cases, we can choose the standard, and
16357 we chose the more efficient register return alternative.
16359 @strong{Warning:} code compiled with the @option{-freg-struct-return}
16360 switch is not binary compatible with code compiled with the
16361 @option{-fpcc-struct-return} switch.
16362 Use it to conform to a non-default application binary interface.
16364 @item -fshort-enums
16365 @opindex fshort-enums
16366 Allocate to an @code{enum} type only as many bytes as it needs for the
16367 declared range of possible values.  Specifically, the @code{enum} type
16368 will be equivalent to the smallest integer type which has enough room.
16370 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
16371 code that is not binary compatible with code generated without that switch.
16372 Use it to conform to a non-default application binary interface.
16374 @item -fshort-double
16375 @opindex fshort-double
16376 Use the same size for @code{double} as for @code{float}.
16378 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
16379 code that is not binary compatible with code generated without that switch.
16380 Use it to conform to a non-default application binary interface.
16382 @item -fshort-wchar
16383 @opindex fshort-wchar
16384 Override the underlying type for @samp{wchar_t} to be @samp{short
16385 unsigned int} instead of the default for the target.  This option is
16386 useful for building programs to run under WINE@.
16388 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
16389 code that is not binary compatible with code generated without that switch.
16390 Use it to conform to a non-default application binary interface.
16392 @item -fno-common
16393 @opindex fno-common
16394 In C code, controls the placement of uninitialized global variables.
16395 Unix C compilers have traditionally permitted multiple definitions of
16396 such variables in different compilation units by placing the variables
16397 in a common block.
16398 This is the behavior specified by @option{-fcommon}, and is the default
16399 for GCC on most targets.
16400 On the other hand, this behavior is not required by ISO C, and on some
16401 targets may carry a speed or code size penalty on variable references.
16402 The @option{-fno-common} option specifies that the compiler should place
16403 uninitialized global variables in the data section of the object file,
16404 rather than generating them as common blocks.
16405 This has the effect that if the same variable is declared
16406 (without @code{extern}) in two different compilations,
16407 you will get a multiple-definition error when you link them.
16408 In this case, you must compile with @option{-fcommon} instead.
16409 Compiling with @option{-fno-common} is useful on targets for which
16410 it provides better performance, or if you wish to verify that the
16411 program will work on other systems which always treat uninitialized
16412 variable declarations this way.
16414 @item -fno-ident
16415 @opindex fno-ident
16416 Ignore the @samp{#ident} directive.
16418 @item -finhibit-size-directive
16419 @opindex finhibit-size-directive
16420 Don't output a @code{.size} assembler directive, or anything else that
16421 would cause trouble if the function is split in the middle, and the
16422 two halves are placed at locations far apart in memory.  This option is
16423 used when compiling @file{crtstuff.c}; you should not need to use it
16424 for anything else.
16426 @item -fverbose-asm
16427 @opindex fverbose-asm
16428 Put extra commentary information in the generated assembly code to
16429 make it more readable.  This option is generally only of use to those
16430 who actually need to read the generated assembly code (perhaps while
16431 debugging the compiler itself).
16433 @option{-fno-verbose-asm}, the default, causes the
16434 extra information to be omitted and is useful when comparing two assembler
16435 files.
16437 @item -frecord-gcc-switches
16438 @opindex frecord-gcc-switches
16439 This switch causes the command line that was used to invoke the
16440 compiler to be recorded into the object file that is being created.
16441 This switch is only implemented on some targets and the exact format
16442 of the recording is target and binary file format dependent, but it
16443 usually takes the form of a section containing ASCII text.  This
16444 switch is related to the @option{-fverbose-asm} switch, but that
16445 switch only records information in the assembler output file as
16446 comments, so it never reaches the object file.
16448 @item -fpic
16449 @opindex fpic
16450 @cindex global offset table
16451 @cindex PIC
16452 Generate position-independent code (PIC) suitable for use in a shared
16453 library, if supported for the target machine.  Such code accesses all
16454 constant addresses through a global offset table (GOT)@.  The dynamic
16455 loader resolves the GOT entries when the program starts (the dynamic
16456 loader is not part of GCC; it is part of the operating system).  If
16457 the GOT size for the linked executable exceeds a machine-specific
16458 maximum size, you get an error message from the linker indicating that
16459 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
16460 instead.  (These maximums are 8k on the SPARC and 32k
16461 on the m68k and RS/6000.  The 386 has no such limit.)
16463 Position-independent code requires special support, and therefore works
16464 only on certain machines.  For the 386, GCC supports PIC for System V
16465 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
16466 position-independent.
16468 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
16469 are defined to 1.
16471 @item -fPIC
16472 @opindex fPIC
16473 If supported for the target machine, emit position-independent code,
16474 suitable for dynamic linking and avoiding any limit on the size of the
16475 global offset table.  This option makes a difference on the m68k,
16476 PowerPC and SPARC@.
16478 Position-independent code requires special support, and therefore works
16479 only on certain machines.
16481 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
16482 are defined to 2.
16484 @item -fpie
16485 @itemx -fPIE
16486 @opindex fpie
16487 @opindex fPIE
16488 These options are similar to @option{-fpic} and @option{-fPIC}, but
16489 generated position independent code can be only linked into executables.
16490 Usually these options are used when @option{-pie} GCC option will be
16491 used during linking.
16493 @option{-fpie} and @option{-fPIE} both define the macros
16494 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
16495 for @option{-fpie} and 2 for @option{-fPIE}.
16497 @item -fno-jump-tables
16498 @opindex fno-jump-tables
16499 Do not use jump tables for switch statements even where it would be
16500 more efficient than other code generation strategies.  This option is
16501 of use in conjunction with @option{-fpic} or @option{-fPIC} for
16502 building code which forms part of a dynamic linker and cannot
16503 reference the address of a jump table.  On some targets, jump tables
16504 do not require a GOT and this option is not needed.
16506 @item -ffixed-@var{reg}
16507 @opindex ffixed
16508 Treat the register named @var{reg} as a fixed register; generated code
16509 should never refer to it (except perhaps as a stack pointer, frame
16510 pointer or in some other fixed role).
16512 @var{reg} must be the name of a register.  The register names accepted
16513 are machine-specific and are defined in the @code{REGISTER_NAMES}
16514 macro in the machine description macro file.
16516 This flag does not have a negative form, because it specifies a
16517 three-way choice.
16519 @item -fcall-used-@var{reg}
16520 @opindex fcall-used
16521 Treat the register named @var{reg} as an allocable register that is
16522 clobbered by function calls.  It may be allocated for temporaries or
16523 variables that do not live across a call.  Functions compiled this way
16524 will not save and restore the register @var{reg}.
16526 It is an error to used this flag with the frame pointer or stack pointer.
16527 Use of this flag for other registers that have fixed pervasive roles in
16528 the machine's execution model will produce disastrous results.
16530 This flag does not have a negative form, because it specifies a
16531 three-way choice.
16533 @item -fcall-saved-@var{reg}
16534 @opindex fcall-saved
16535 Treat the register named @var{reg} as an allocable register saved by
16536 functions.  It may be allocated even for temporaries or variables that
16537 live across a call.  Functions compiled this way will save and restore
16538 the register @var{reg} if they use it.
16540 It is an error to used this flag with the frame pointer or stack pointer.
16541 Use of this flag for other registers that have fixed pervasive roles in
16542 the machine's execution model will produce disastrous results.
16544 A different sort of disaster will result from the use of this flag for
16545 a register in which function values may be returned.
16547 This flag does not have a negative form, because it specifies a
16548 three-way choice.
16550 @item -fpack-struct[=@var{n}]
16551 @opindex fpack-struct
16552 Without a value specified, pack all structure members together without
16553 holes.  When a value is specified (which must be a small power of two), pack
16554 structure members according to this value, representing the maximum
16555 alignment (that is, objects with default alignment requirements larger than
16556 this will be output potentially unaligned at the next fitting location.
16558 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
16559 code that is not binary compatible with code generated without that switch.
16560 Additionally, it makes the code suboptimal.
16561 Use it to conform to a non-default application binary interface.
16563 @item -finstrument-functions
16564 @opindex finstrument-functions
16565 Generate instrumentation calls for entry and exit to functions.  Just
16566 after function entry and just before function exit, the following
16567 profiling functions will be called with the address of the current
16568 function and its call site.  (On some platforms,
16569 @code{__builtin_return_address} does not work beyond the current
16570 function, so the call site information may not be available to the
16571 profiling functions otherwise.)
16573 @smallexample
16574 void __cyg_profile_func_enter (void *this_fn,
16575                                void *call_site);
16576 void __cyg_profile_func_exit  (void *this_fn,
16577                                void *call_site);
16578 @end smallexample
16580 The first argument is the address of the start of the current function,
16581 which may be looked up exactly in the symbol table.
16583 This instrumentation is also done for functions expanded inline in other
16584 functions.  The profiling calls will indicate where, conceptually, the
16585 inline function is entered and exited.  This means that addressable
16586 versions of such functions must be available.  If all your uses of a
16587 function are expanded inline, this may mean an additional expansion of
16588 code size.  If you use @samp{extern inline} in your C code, an
16589 addressable version of such functions must be provided.  (This is
16590 normally the case anyways, but if you get lucky and the optimizer always
16591 expands the functions inline, you might have gotten away without
16592 providing static copies.)
16594 A function may be given the attribute @code{no_instrument_function}, in
16595 which case this instrumentation will not be done.  This can be used, for
16596 example, for the profiling functions listed above, high-priority
16597 interrupt routines, and any functions from which the profiling functions
16598 cannot safely be called (perhaps signal handlers, if the profiling
16599 routines generate output or allocate memory).
16601 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
16602 @opindex finstrument-functions-exclude-file-list
16604 Set the list of functions that are excluded from instrumentation (see
16605 the description of @code{-finstrument-functions}).  If the file that
16606 contains a function definition matches with one of @var{file}, then
16607 that function is not instrumented.  The match is done on substrings:
16608 if the @var{file} parameter is a substring of the file name, it is
16609 considered to be a match.
16611 For example,
16612 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
16613 will exclude any inline function defined in files whose pathnames
16614 contain @code{/bits/stl} or @code{include/sys}.
16616 If, for some reason, you want to include letter @code{','} in one of
16617 @var{sym}, write @code{'\,'}. For example,
16618 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
16619 (note the single quote surrounding the option).
16621 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
16622 @opindex finstrument-functions-exclude-function-list
16624 This is similar to @code{-finstrument-functions-exclude-file-list},
16625 but this option sets the list of function names to be excluded from
16626 instrumentation.  The function name to be matched is its user-visible
16627 name, such as @code{vector<int> blah(const vector<int> &)}, not the
16628 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
16629 match is done on substrings: if the @var{sym} parameter is a substring
16630 of the function name, it is considered to be a match.  For C99 and C++
16631 extended identifiers, the function name must be given in UTF-8, not
16632 using universal character names.
16634 @item -fstack-check
16635 @opindex fstack-check
16636 Generate code to verify that you do not go beyond the boundary of the
16637 stack.  You should specify this flag if you are running in an
16638 environment with multiple threads, but only rarely need to specify it in
16639 a single-threaded environment since stack overflow is automatically
16640 detected on nearly all systems if there is only one stack.
16642 Note that this switch does not actually cause checking to be done; the
16643 operating system or the language runtime must do that.  The switch causes
16644 generation of code to ensure that they see the stack being extended.
16646 You can additionally specify a string parameter: @code{no} means no
16647 checking, @code{generic} means force the use of old-style checking,
16648 @code{specific} means use the best checking method and is equivalent
16649 to bare @option{-fstack-check}.
16651 Old-style checking is a generic mechanism that requires no specific
16652 target support in the compiler but comes with the following drawbacks:
16654 @enumerate
16655 @item
16656 Modified allocation strategy for large objects: they will always be
16657 allocated dynamically if their size exceeds a fixed threshold.
16659 @item
16660 Fixed limit on the size of the static frame of functions: when it is
16661 topped by a particular function, stack checking is not reliable and
16662 a warning is issued by the compiler.
16664 @item
16665 Inefficiency: because of both the modified allocation strategy and the
16666 generic implementation, the performances of the code are hampered.
16667 @end enumerate
16669 Note that old-style stack checking is also the fallback method for
16670 @code{specific} if no target support has been added in the compiler.
16672 @item -fstack-limit-register=@var{reg}
16673 @itemx -fstack-limit-symbol=@var{sym}
16674 @itemx -fno-stack-limit
16675 @opindex fstack-limit-register
16676 @opindex fstack-limit-symbol
16677 @opindex fno-stack-limit
16678 Generate code to ensure that the stack does not grow beyond a certain value,
16679 either the value of a register or the address of a symbol.  If the stack
16680 would grow beyond the value, a signal is raised.  For most targets,
16681 the signal is raised before the stack overruns the boundary, so
16682 it is possible to catch the signal without taking special precautions.
16684 For instance, if the stack starts at absolute address @samp{0x80000000}
16685 and grows downwards, you can use the flags
16686 @option{-fstack-limit-symbol=__stack_limit} and
16687 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
16688 of 128KB@.  Note that this may only work with the GNU linker.
16690 @cindex aliasing of parameters
16691 @cindex parameters, aliased
16692 @item -fargument-alias
16693 @itemx -fargument-noalias
16694 @itemx -fargument-noalias-global
16695 @itemx -fargument-noalias-anything
16696 @opindex fargument-alias
16697 @opindex fargument-noalias
16698 @opindex fargument-noalias-global
16699 @opindex fargument-noalias-anything
16700 Specify the possible relationships among parameters and between
16701 parameters and global data.
16703 @option{-fargument-alias} specifies that arguments (parameters) may
16704 alias each other and may alias global storage.@*
16705 @option{-fargument-noalias} specifies that arguments do not alias
16706 each other, but may alias global storage.@*
16707 @option{-fargument-noalias-global} specifies that arguments do not
16708 alias each other and do not alias global storage.
16709 @option{-fargument-noalias-anything} specifies that arguments do not
16710 alias any other storage.
16712 Each language will automatically use whatever option is required by
16713 the language standard.  You should not need to use these options yourself.
16715 @item -fleading-underscore
16716 @opindex fleading-underscore
16717 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
16718 change the way C symbols are represented in the object file.  One use
16719 is to help link with legacy assembly code.
16721 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
16722 generate code that is not binary compatible with code generated without that
16723 switch.  Use it to conform to a non-default application binary interface.
16724 Not all targets provide complete support for this switch.
16726 @item -ftls-model=@var{model}
16727 @opindex ftls-model
16728 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
16729 The @var{model} argument should be one of @code{global-dynamic},
16730 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
16732 The default without @option{-fpic} is @code{initial-exec}; with
16733 @option{-fpic} the default is @code{global-dynamic}.
16735 @item -fvisibility=@var{default|internal|hidden|protected}
16736 @opindex fvisibility
16737 Set the default ELF image symbol visibility to the specified option---all
16738 symbols will be marked with this unless overridden within the code.
16739 Using this feature can very substantially improve linking and
16740 load times of shared object libraries, produce more optimized
16741 code, provide near-perfect API export and prevent symbol clashes.
16742 It is @strong{strongly} recommended that you use this in any shared objects
16743 you distribute.
16745 Despite the nomenclature, @code{default} always means public ie;
16746 available to be linked against from outside the shared object.
16747 @code{protected} and @code{internal} are pretty useless in real-world
16748 usage so the only other commonly used option will be @code{hidden}.
16749 The default if @option{-fvisibility} isn't specified is
16750 @code{default}, i.e., make every
16751 symbol public---this causes the same behavior as previous versions of
16752 GCC@.
16754 A good explanation of the benefits offered by ensuring ELF
16755 symbols have the correct visibility is given by ``How To Write
16756 Shared Libraries'' by Ulrich Drepper (which can be found at
16757 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
16758 solution made possible by this option to marking things hidden when
16759 the default is public is to make the default hidden and mark things
16760 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
16761 and @code{__attribute__ ((visibility("default")))} instead of
16762 @code{__declspec(dllexport)} you get almost identical semantics with
16763 identical syntax.  This is a great boon to those working with
16764 cross-platform projects.
16766 For those adding visibility support to existing code, you may find
16767 @samp{#pragma GCC visibility} of use.  This works by you enclosing
16768 the declarations you wish to set visibility for with (for example)
16769 @samp{#pragma GCC visibility push(hidden)} and
16770 @samp{#pragma GCC visibility pop}.
16771 Bear in mind that symbol visibility should be viewed @strong{as
16772 part of the API interface contract} and thus all new code should
16773 always specify visibility when it is not the default ie; declarations
16774 only for use within the local DSO should @strong{always} be marked explicitly
16775 as hidden as so to avoid PLT indirection overheads---making this
16776 abundantly clear also aids readability and self-documentation of the code.
16777 Note that due to ISO C++ specification requirements, operator new and
16778 operator delete must always be of default visibility.
16780 Be aware that headers from outside your project, in particular system
16781 headers and headers from any other library you use, may not be
16782 expecting to be compiled with visibility other than the default.  You
16783 may need to explicitly say @samp{#pragma GCC visibility push(default)}
16784 before including any such headers.
16786 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
16787 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
16788 no modifications.  However, this means that calls to @samp{extern}
16789 functions with no explicit visibility will use the PLT, so it is more
16790 effective to use @samp{__attribute ((visibility))} and/or
16791 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
16792 declarations should be treated as hidden.
16794 Note that @samp{-fvisibility} does affect C++ vague linkage
16795 entities. This means that, for instance, an exception class that will
16796 be thrown between DSOs must be explicitly marked with default
16797 visibility so that the @samp{type_info} nodes will be unified between
16798 the DSOs.
16800 An overview of these techniques, their benefits and how to use them
16801 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
16803 @end table
16805 @c man end
16807 @node Environment Variables
16808 @section Environment Variables Affecting GCC
16809 @cindex environment variables
16811 @c man begin ENVIRONMENT
16812 This section describes several environment variables that affect how GCC
16813 operates.  Some of them work by specifying directories or prefixes to use
16814 when searching for various kinds of files.  Some are used to specify other
16815 aspects of the compilation environment.
16817 Note that you can also specify places to search using options such as
16818 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
16819 take precedence over places specified using environment variables, which
16820 in turn take precedence over those specified by the configuration of GCC@.
16821 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
16822 GNU Compiler Collection (GCC) Internals}.
16824 @table @env
16825 @item LANG
16826 @itemx LC_CTYPE
16827 @c @itemx LC_COLLATE
16828 @itemx LC_MESSAGES
16829 @c @itemx LC_MONETARY
16830 @c @itemx LC_NUMERIC
16831 @c @itemx LC_TIME
16832 @itemx LC_ALL
16833 @findex LANG
16834 @findex LC_CTYPE
16835 @c @findex LC_COLLATE
16836 @findex LC_MESSAGES
16837 @c @findex LC_MONETARY
16838 @c @findex LC_NUMERIC
16839 @c @findex LC_TIME
16840 @findex LC_ALL
16841 @cindex locale
16842 These environment variables control the way that GCC uses
16843 localization information that allow GCC to work with different
16844 national conventions.  GCC inspects the locale categories
16845 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
16846 so.  These locale categories can be set to any value supported by your
16847 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
16848 Kingdom encoded in UTF-8.
16850 The @env{LC_CTYPE} environment variable specifies character
16851 classification.  GCC uses it to determine the character boundaries in
16852 a string; this is needed for some multibyte encodings that contain quote
16853 and escape characters that would otherwise be interpreted as a string
16854 end or escape.
16856 The @env{LC_MESSAGES} environment variable specifies the language to
16857 use in diagnostic messages.
16859 If the @env{LC_ALL} environment variable is set, it overrides the value
16860 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
16861 and @env{LC_MESSAGES} default to the value of the @env{LANG}
16862 environment variable.  If none of these variables are set, GCC
16863 defaults to traditional C English behavior.
16865 @item TMPDIR
16866 @findex TMPDIR
16867 If @env{TMPDIR} is set, it specifies the directory to use for temporary
16868 files.  GCC uses temporary files to hold the output of one stage of
16869 compilation which is to be used as input to the next stage: for example,
16870 the output of the preprocessor, which is the input to the compiler
16871 proper.
16873 @item GCC_EXEC_PREFIX
16874 @findex GCC_EXEC_PREFIX
16875 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
16876 names of the subprograms executed by the compiler.  No slash is added
16877 when this prefix is combined with the name of a subprogram, but you can
16878 specify a prefix that ends with a slash if you wish.
16880 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
16881 an appropriate prefix to use based on the pathname it was invoked with.
16883 If GCC cannot find the subprogram using the specified prefix, it
16884 tries looking in the usual places for the subprogram.
16886 The default value of @env{GCC_EXEC_PREFIX} is
16887 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
16888 the installed compiler. In many cases @var{prefix} is the value
16889 of @code{prefix} when you ran the @file{configure} script.
16891 Other prefixes specified with @option{-B} take precedence over this prefix.
16893 This prefix is also used for finding files such as @file{crt0.o} that are
16894 used for linking.
16896 In addition, the prefix is used in an unusual way in finding the
16897 directories to search for header files.  For each of the standard
16898 directories whose name normally begins with @samp{/usr/local/lib/gcc}
16899 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
16900 replacing that beginning with the specified prefix to produce an
16901 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
16902 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
16903 These alternate directories are searched first; the standard directories
16904 come next. If a standard directory begins with the configured
16905 @var{prefix} then the value of @var{prefix} is replaced by
16906 @env{GCC_EXEC_PREFIX} when looking for header files.
16908 @item COMPILER_PATH
16909 @findex COMPILER_PATH
16910 The value of @env{COMPILER_PATH} is a colon-separated list of
16911 directories, much like @env{PATH}.  GCC tries the directories thus
16912 specified when searching for subprograms, if it can't find the
16913 subprograms using @env{GCC_EXEC_PREFIX}.
16915 @item LIBRARY_PATH
16916 @findex LIBRARY_PATH
16917 The value of @env{LIBRARY_PATH} is a colon-separated list of
16918 directories, much like @env{PATH}.  When configured as a native compiler,
16919 GCC tries the directories thus specified when searching for special
16920 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
16921 using GCC also uses these directories when searching for ordinary
16922 libraries for the @option{-l} option (but directories specified with
16923 @option{-L} come first).
16925 @item LANG
16926 @findex LANG
16927 @cindex locale definition
16928 This variable is used to pass locale information to the compiler.  One way in
16929 which this information is used is to determine the character set to be used
16930 when character literals, string literals and comments are parsed in C and C++.
16931 When the compiler is configured to allow multibyte characters,
16932 the following values for @env{LANG} are recognized:
16934 @table @samp
16935 @item C-JIS
16936 Recognize JIS characters.
16937 @item C-SJIS
16938 Recognize SJIS characters.
16939 @item C-EUCJP
16940 Recognize EUCJP characters.
16941 @end table
16943 If @env{LANG} is not defined, or if it has some other value, then the
16944 compiler will use mblen and mbtowc as defined by the default locale to
16945 recognize and translate multibyte characters.
16946 @end table
16948 @noindent
16949 Some additional environments variables affect the behavior of the
16950 preprocessor.
16952 @include cppenv.texi
16954 @c man end
16956 @node Precompiled Headers
16957 @section Using Precompiled Headers
16958 @cindex precompiled headers
16959 @cindex speed of compilation
16961 Often large projects have many header files that are included in every
16962 source file.  The time the compiler takes to process these header files
16963 over and over again can account for nearly all of the time required to
16964 build the project.  To make builds faster, GCC allows users to
16965 `precompile' a header file; then, if builds can use the precompiled
16966 header file they will be much faster.
16968 To create a precompiled header file, simply compile it as you would any
16969 other file, if necessary using the @option{-x} option to make the driver
16970 treat it as a C or C++ header file.  You will probably want to use a
16971 tool like @command{make} to keep the precompiled header up-to-date when
16972 the headers it contains change.
16974 A precompiled header file will be searched for when @code{#include} is
16975 seen in the compilation.  As it searches for the included file
16976 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
16977 compiler looks for a precompiled header in each directory just before it
16978 looks for the include file in that directory.  The name searched for is
16979 the name specified in the @code{#include} with @samp{.gch} appended.  If
16980 the precompiled header file can't be used, it is ignored.
16982 For instance, if you have @code{#include "all.h"}, and you have
16983 @file{all.h.gch} in the same directory as @file{all.h}, then the
16984 precompiled header file will be used if possible, and the original
16985 header will be used otherwise.
16987 Alternatively, you might decide to put the precompiled header file in a
16988 directory and use @option{-I} to ensure that directory is searched
16989 before (or instead of) the directory containing the original header.
16990 Then, if you want to check that the precompiled header file is always
16991 used, you can put a file of the same name as the original header in this
16992 directory containing an @code{#error} command.
16994 This also works with @option{-include}.  So yet another way to use
16995 precompiled headers, good for projects not designed with precompiled
16996 header files in mind, is to simply take most of the header files used by
16997 a project, include them from another header file, precompile that header
16998 file, and @option{-include} the precompiled header.  If the header files
16999 have guards against multiple inclusion, they will be skipped because
17000 they've already been included (in the precompiled header).
17002 If you need to precompile the same header file for different
17003 languages, targets, or compiler options, you can instead make a
17004 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17005 header in the directory, perhaps using @option{-o}.  It doesn't matter
17006 what you call the files in the directory, every precompiled header in
17007 the directory will be considered.  The first precompiled header
17008 encountered in the directory that is valid for this compilation will
17009 be used; they're searched in no particular order.
17011 There are many other possibilities, limited only by your imagination,
17012 good sense, and the constraints of your build system.
17014 A precompiled header file can be used only when these conditions apply:
17016 @itemize
17017 @item
17018 Only one precompiled header can be used in a particular compilation.
17020 @item
17021 A precompiled header can't be used once the first C token is seen.  You
17022 can have preprocessor directives before a precompiled header; you can
17023 even include a precompiled header from inside another header, so long as
17024 there are no C tokens before the @code{#include}.
17026 @item
17027 The precompiled header file must be produced for the same language as
17028 the current compilation.  You can't use a C precompiled header for a C++
17029 compilation.
17031 @item
17032 The precompiled header file must have been produced by the same compiler
17033 binary as the current compilation is using.
17035 @item
17036 Any macros defined before the precompiled header is included must
17037 either be defined in the same way as when the precompiled header was
17038 generated, or must not affect the precompiled header, which usually
17039 means that they don't appear in the precompiled header at all.
17041 The @option{-D} option is one way to define a macro before a
17042 precompiled header is included; using a @code{#define} can also do it.
17043 There are also some options that define macros implicitly, like
17044 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17045 defined this way.
17047 @item If debugging information is output when using the precompiled
17048 header, using @option{-g} or similar, the same kind of debugging information
17049 must have been output when building the precompiled header.  However,
17050 a precompiled header built using @option{-g} can be used in a compilation
17051 when no debugging information is being output.
17053 @item The same @option{-m} options must generally be used when building
17054 and using the precompiled header.  @xref{Submodel Options},
17055 for any cases where this rule is relaxed.
17057 @item Each of the following options must be the same when building and using
17058 the precompiled header:
17060 @gccoptlist{-fexceptions}
17062 @item
17063 Some other command-line options starting with @option{-f},
17064 @option{-p}, or @option{-O} must be defined in the same way as when
17065 the precompiled header was generated.  At present, it's not clear
17066 which options are safe to change and which are not; the safest choice
17067 is to use exactly the same options when generating and using the
17068 precompiled header.  The following are known to be safe:
17070 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17071 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17072 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17073 -pedantic-errors}
17075 @end itemize
17077 For all of these except the last, the compiler will automatically
17078 ignore the precompiled header if the conditions aren't met.  If you
17079 find an option combination that doesn't work and doesn't cause the
17080 precompiled header to be ignored, please consider filing a bug report,
17081 see @ref{Bugs}.
17083 If you do use differing options when generating and using the
17084 precompiled header, the actual behavior will be a mixture of the
17085 behavior for the options.  For instance, if you use @option{-g} to
17086 generate the precompiled header but not when using it, you may or may
17087 not get debugging information for routines in the precompiled header.