* doc/invoke.texi (Optimize Options): Stop claiming inlining and
[official-gcc.git] / gcc / doc / invoke.texi
blob46801ea3504c35e152bf3b3782672e9ab4883f31
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
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
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 * Running Protoize::    Automatically adding or removing function prototypes.
152 @end menu
154 @c man begin OPTIONS
156 @node Option Summary
157 @section Option Summary
159 Here is a summary of all the options, grouped by type.  Explanations are
160 in the following sections.
162 @table @emph
163 @item Overall Options
164 @xref{Overall Options,,Options Controlling the Kind of Output}.
165 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{]}  --target-help  @gol
167 --version -wrapper@@@var{file}}
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 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
193 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
194 -fno-default-inline  -fvisibility-inlines-hidden @gol
195 -fvisibility-ms-compat @gol
196 -Wabi  -Wctor-dtor-privacy @gol
197 -Wnon-virtual-dtor  -Wreorder @gol
198 -Weffc++  -Wstrict-null-sentinel @gol
199 -Wno-non-template-friend  -Wold-style-cast @gol
200 -Woverloaded-virtual  -Wno-pmf-conversions @gol
201 -Wsign-promo}
203 @item Objective-C and Objective-C++ Language Options
204 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
205 Objective-C and Objective-C++ Dialects}.
206 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
207 -fgnu-runtime  -fnext-runtime @gol
208 -fno-nil-receivers @gol
209 -fobjc-call-cxx-cdtors @gol
210 -fobjc-direct-dispatch @gol
211 -fobjc-exceptions @gol
212 -fobjc-gc @gol
213 -freplace-objc-classes @gol
214 -fzero-link @gol
215 -gen-decls @gol
216 -Wassign-intercept @gol
217 -Wno-protocol  -Wselector @gol
218 -Wstrict-selector-match @gol
219 -Wundeclared-selector}
221 @item Language Independent Options
222 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
223 @gccoptlist{-fmessage-length=@var{n}  @gol
224 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
225 -fdiagnostics-show-option}
227 @item Warning Options
228 @xref{Warning Options,,Options to Request or Suppress Warnings}.
229 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
230 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
231 -Wno-attributes -Wno-builtin-macro-redefined @gol
232 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
233 -Wchar-subscripts -Wclobbered  -Wcomment @gol
234 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
235 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
236 -Wdisallowed-function-list=@var{sym},@var{sym},@dots{} @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} -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 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
264 -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 @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-phiopt@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-nrv -fdump-tree-vect @gol
298 -fdump-tree-sink @gol
299 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
300 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
302 -ftree-vectorizer-verbose=@var{n} @gol
303 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
304 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
305 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
306 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
307 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
308 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
309 -ftest-coverage  -ftime-report -fvar-tracking @gol
310 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
311 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
312 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
313 -fdebug-prefix-map=@var{old}=@var{new} @gol
314 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
315 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
316 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
317 -print-multi-directory  -print-multi-lib @gol
318 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
319 -print-sysroot -print-sysroot-headers-suffix @gol
320 -save-temps  -time}
322 @item Optimization Options
323 @xref{Optimize Options,,Options that Control Optimization}.
324 @gccoptlist{
325 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
326 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
327 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
328 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
329 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
330 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
331 -fdata-sections -fdce -fdce @gol
332 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
333 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
334 -ffinite-math-only -ffloat-store -fforward-propagate @gol
335 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
336 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
337 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
338 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol 
339 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
340 -fipa-type-escape -fira -fira-algorithm=@var{algorithm} @gol
341 -fira-region=@var{region} -fira-coalesce -fno-ira-share-save-slots @gol
342 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
343 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
344 -floop-block -floop-interchange -floop-strip-mine @gol
345 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
346 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
347 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
348 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
349 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
350 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
351 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
352 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
353 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
354 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
355 -fprofile-generate=@var{path} @gol
356 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
357 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
358 -freorder-blocks-and-partition -freorder-functions @gol
359 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
360 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
361 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
362 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
363 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
364 -fselective-scheduling -fselective-scheduling2 @gol
365 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
366 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
367 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
368 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
369 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
370 -ftree-copyrename -ftree-dce @gol
371 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
372 -ftree-loop-distribution @gol
373 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
374 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
375 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
376 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
377 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
378 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
379 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
380 -fwhole-program @gol
381 --param @var{name}=@var{value}
382 -O  -O0  -O1  -O2  -O3  -Os}
384 @item Preprocessor Options
385 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
386 @gccoptlist{-A@var{question}=@var{answer} @gol
387 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
388 -C  -dD  -dI  -dM  -dN @gol
389 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
390 -idirafter @var{dir} @gol
391 -include @var{file}  -imacros @var{file} @gol
392 -iprefix @var{file}  -iwithprefix @var{dir} @gol
393 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
394 -imultilib @var{dir} -isysroot @var{dir} @gol
395 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
396 -P  -fworking-directory  -remap @gol
397 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
398 -Xpreprocessor @var{option}}
400 @item Assembler Option
401 @xref{Assembler Options,,Passing Options to the Assembler}.
402 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
404 @item Linker Options
405 @xref{Link Options,,Options for Linking}.
406 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
407 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
408 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
409 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
410 -u @var{symbol}}
412 @item Directory Options
413 @xref{Directory Options,,Options for Directory Search}.
414 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
415 -specs=@var{file}  -I- --sysroot=@var{dir}}
417 @item Target Options
418 @c I wrote this xref this way to avoid overfull hbox. -- rms
419 @xref{Target Options}.
420 @gccoptlist{-V @var{version}  -b @var{machine}}
422 @item Machine Dependent Options
423 @xref{Submodel Options,,Hardware Models and Configurations}.
424 @c This list is ordered alphanumerically by subsection name.
425 @c Try and put the significant identifier (CPU or system) first,
426 @c so users have a clue at guessing where the ones they want will be.
428 @emph{ARC Options}
429 @gccoptlist{-EB  -EL @gol
430 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
431 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
433 @emph{ARM Options}
434 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
435 -mabi=@var{name} @gol
436 -mapcs-stack-check  -mno-apcs-stack-check @gol
437 -mapcs-float  -mno-apcs-float @gol
438 -mapcs-reentrant  -mno-apcs-reentrant @gol
439 -msched-prolog  -mno-sched-prolog @gol
440 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
441 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
442 -mthumb-interwork  -mno-thumb-interwork @gol
443 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
444 -mstructure-size-boundary=@var{n} @gol
445 -mabort-on-noreturn @gol
446 -mlong-calls  -mno-long-calls @gol
447 -msingle-pic-base  -mno-single-pic-base @gol
448 -mpic-register=@var{reg} @gol
449 -mnop-fun-dllimport @gol
450 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
451 -mpoke-function-name @gol
452 -mthumb  -marm @gol
453 -mtpcs-frame  -mtpcs-leaf-frame @gol
454 -mcaller-super-interworking  -mcallee-super-interworking @gol
455 -mtp=@var{name} @gol
456 -mword-relocations @gol
457 -mfix-cortex-m3-ldrd}
459 @emph{AVR Options}
460 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
461 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
463 @emph{Blackfin Options}
464 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
465 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
466 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
467 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
468 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
469 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
470 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
471 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
472 -micplb}
474 @emph{CRIS Options}
475 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
476 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
477 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
478 -mstack-align  -mdata-align  -mconst-align @gol
479 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
480 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
481 -mmul-bug-workaround  -mno-mul-bug-workaround}
483 @emph{CRX Options}
484 @gccoptlist{-mmac -mpush-args}
486 @emph{Darwin Options}
487 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
488 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
489 -client_name  -compatibility_version  -current_version @gol
490 -dead_strip @gol
491 -dependency-file  -dylib_file  -dylinker_install_name @gol
492 -dynamic  -dynamiclib  -exported_symbols_list @gol
493 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
494 -force_flat_namespace  -headerpad_max_install_names @gol
495 -iframework @gol
496 -image_base  -init  -install_name  -keep_private_externs @gol
497 -multi_module  -multiply_defined  -multiply_defined_unused @gol
498 -noall_load   -no_dead_strip_inits_and_terms @gol
499 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
500 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
501 -private_bundle  -read_only_relocs  -sectalign @gol
502 -sectobjectsymbols  -whyload  -seg1addr @gol
503 -sectcreate  -sectobjectsymbols  -sectorder @gol
504 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
505 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
506 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
507 -single_module  -static  -sub_library  -sub_umbrella @gol
508 -twolevel_namespace  -umbrella  -undefined @gol
509 -unexported_symbols_list  -weak_reference_mismatches @gol
510 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
511 -mkernel -mone-byte-bool}
513 @emph{DEC Alpha Options}
514 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
515 -mieee  -mieee-with-inexact  -mieee-conformant @gol
516 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
517 -mtrap-precision=@var{mode}  -mbuild-constants @gol
518 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
519 -mbwx  -mmax  -mfix  -mcix @gol
520 -mfloat-vax  -mfloat-ieee @gol
521 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
522 -msmall-text  -mlarge-text @gol
523 -mmemory-latency=@var{time}}
525 @emph{DEC Alpha/VMS Options}
526 @gccoptlist{-mvms-return-codes}
528 @emph{FRV Options}
529 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
530 -mhard-float  -msoft-float @gol
531 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
532 -mdouble  -mno-double @gol
533 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
534 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
535 -mlinked-fp  -mlong-calls  -malign-labels @gol
536 -mlibrary-pic  -macc-4  -macc-8 @gol
537 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
538 -moptimize-membar -mno-optimize-membar @gol
539 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
540 -mvliw-branch  -mno-vliw-branch @gol
541 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
542 -mno-nested-cond-exec  -mtomcat-stats @gol
543 -mTLS -mtls @gol
544 -mcpu=@var{cpu}}
546 @emph{GNU/Linux Options}
547 @gccoptlist{-muclibc}
549 @emph{H8/300 Options}
550 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
552 @emph{HPPA Options}
553 @gccoptlist{-march=@var{architecture-type} @gol
554 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
555 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
556 -mfixed-range=@var{register-range} @gol
557 -mjump-in-delay -mlinker-opt -mlong-calls @gol
558 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
559 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
560 -mno-jump-in-delay  -mno-long-load-store @gol
561 -mno-portable-runtime  -mno-soft-float @gol
562 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
563 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
564 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
565 -munix=@var{unix-std}  -nolibdld  -static  -threads}
567 @emph{i386 and x86-64 Options}
568 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
569 -mfpmath=@var{unit} @gol
570 -masm=@var{dialect}  -mno-fancy-math-387 @gol
571 -mno-fp-ret-in-387  -msoft-float @gol
572 -mno-wide-multiply  -mrtd  -malign-double @gol
573 -mpreferred-stack-boundary=@var{num}
574 -mincoming-stack-boundary=@var{num}
575 -mcld -mcx16 -msahf -mrecip @gol
576 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
577 -maes -mpclmul @gol
578 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
579 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
580 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
581 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
582 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
583 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
584 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
585 -mcmodel=@var{code-model} @gol
586 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
587 -mfused-madd -mno-fused-madd -msse2avx}
589 @emph{IA-64 Options}
590 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
591 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
592 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
593 -minline-float-divide-max-throughput @gol
594 -minline-int-divide-min-latency @gol
595 -minline-int-divide-max-throughput  @gol
596 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
597 -mno-dwarf2-asm -mearly-stop-bits @gol
598 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
599 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
600 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
601 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
602 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
603 -mno-sched-prefer-non-data-spec-insns @gol
604 -mno-sched-prefer-non-control-spec-insns @gol
605 -mno-sched-count-spec-in-critical-path}
607 @emph{M32R/D Options}
608 @gccoptlist{-m32r2 -m32rx -m32r @gol
609 -mdebug @gol
610 -malign-loops -mno-align-loops @gol
611 -missue-rate=@var{number} @gol
612 -mbranch-cost=@var{number} @gol
613 -mmodel=@var{code-size-model-type} @gol
614 -msdata=@var{sdata-type} @gol
615 -mno-flush-func -mflush-func=@var{name} @gol
616 -mno-flush-trap -mflush-trap=@var{number} @gol
617 -G @var{num}}
619 @emph{M32C Options}
620 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
622 @emph{M680x0 Options}
623 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
624 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
625 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
626 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
627 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
628 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
629 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
630 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
631 -mxgot -mno-xgot}
633 @emph{M68hc1x Options}
634 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
635 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
636 -msoft-reg-count=@var{count}}
638 @emph{MCore Options}
639 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
640 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
641 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
642 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
643 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
645 @emph{MIPS Options}
646 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
647 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
648 -mips64  -mips64r2 @gol
649 -mips16  -mno-mips16  -mflip-mips16 @gol
650 -minterlink-mips16  -mno-interlink-mips16 @gol
651 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
652 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
653 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
654 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
655 -mfpu=@var{fpu-type} @gol
656 -msmartmips  -mno-smartmips @gol
657 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
658 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
659 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
660 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
661 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
662 -membedded-data  -mno-embedded-data @gol
663 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
664 -mcode-readable=@var{setting} @gol
665 -msplit-addresses  -mno-split-addresses @gol
666 -mexplicit-relocs  -mno-explicit-relocs @gol
667 -mcheck-zero-division  -mno-check-zero-division @gol
668 -mdivide-traps  -mdivide-breaks @gol
669 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
670 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
671 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
672 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
673 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
674 -mflush-func=@var{func}  -mno-flush-func @gol
675 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
676 -mfp-exceptions -mno-fp-exceptions @gol
677 -mvr4130-align -mno-vr4130-align}
679 @emph{MMIX Options}
680 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
681 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
682 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
683 -mno-base-addresses  -msingle-exit  -mno-single-exit}
685 @emph{MN10300 Options}
686 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
687 -mam33  -mno-am33 @gol
688 -mam33-2  -mno-am33-2 @gol
689 -mreturn-pointer-on-d0 @gol
690 -mno-crt0  -mrelax}
692 @emph{PDP-11 Options}
693 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
694 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
695 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
696 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
697 -mbranch-expensive  -mbranch-cheap @gol
698 -msplit  -mno-split  -munix-asm  -mdec-asm}
700 @emph{picoChip Options}
701 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
702 -msymbol-as-address -mno-inefficient-warnings}
704 @emph{PowerPC Options}
705 See RS/6000 and PowerPC Options.
707 @emph{RS/6000 and PowerPC Options}
708 @gccoptlist{-mcpu=@var{cpu-type} @gol
709 -mtune=@var{cpu-type} @gol
710 -mpower  -mno-power  -mpower2  -mno-power2 @gol
711 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
712 -maltivec  -mno-altivec @gol
713 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
714 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
715 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
716 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
717 -mnew-mnemonics  -mold-mnemonics @gol
718 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
719 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
720 -malign-power  -malign-natural @gol
721 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
722 -msingle-float -mdouble-float -msimple-fpu @gol
723 -mstring  -mno-string  -mupdate  -mno-update @gol
724 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
725 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
726 -mstrict-align  -mno-strict-align  -mrelocatable @gol
727 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
728 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
729 -mdynamic-no-pic  -maltivec  -mswdiv @gol
730 -mprioritize-restricted-insns=@var{priority} @gol
731 -msched-costly-dep=@var{dependence_type} @gol
732 -minsert-sched-nops=@var{scheme} @gol
733 -mcall-sysv  -mcall-netbsd @gol
734 -maix-struct-return  -msvr4-struct-return @gol
735 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
736 -misel -mno-isel @gol
737 -misel=yes  -misel=no @gol
738 -mspe -mno-spe @gol
739 -mspe=yes  -mspe=no @gol
740 -mpaired @gol
741 -mgen-cell-microcode -mwarn-cell-microcode @gol
742 -mvrsave -mno-vrsave @gol
743 -mmulhw -mno-mulhw @gol
744 -mdlmzb -mno-dlmzb @gol
745 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
746 -mprototype  -mno-prototype @gol
747 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
748 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
750 @emph{S/390 and zSeries Options}
751 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
752 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
753 -mlong-double-64 -mlong-double-128 @gol
754 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
755 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
756 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
757 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
758 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
760 @emph{Score Options}
761 @gccoptlist{-meb -mel @gol
762 -mnhwloop @gol
763 -muls @gol
764 -mmac @gol
765 -mscore5 -mscore5u -mscore7 -mscore7d}
767 @emph{SH Options}
768 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
769 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
770 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
771 -m5-64media  -m5-64media-nofpu @gol
772 -m5-32media  -m5-32media-nofpu @gol
773 -m5-compact  -m5-compact-nofpu @gol
774 -mb  -ml  -mdalign  -mrelax @gol
775 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
776 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
777 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
778 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
779 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
780 -minvalid-symbols}
782 @emph{SPARC Options}
783 @gccoptlist{-mcpu=@var{cpu-type} @gol
784 -mtune=@var{cpu-type} @gol
785 -mcmodel=@var{code-model} @gol
786 -m32  -m64  -mapp-regs  -mno-app-regs @gol
787 -mfaster-structs  -mno-faster-structs @gol
788 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
789 -mhard-quad-float  -msoft-quad-float @gol
790 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
791 -mstack-bias  -mno-stack-bias @gol
792 -munaligned-doubles  -mno-unaligned-doubles @gol
793 -mv8plus  -mno-v8plus  -mvis  -mno-vis
794 -threads -pthreads -pthread}
796 @emph{SPU Options}
797 @gccoptlist{-mwarn-reloc -merror-reloc @gol
798 -msafe-dma -munsafe-dma @gol
799 -mbranch-hints @gol
800 -msmall-mem -mlarge-mem -mstdmain @gol
801 -mfixed-range=@var{register-range}}
803 @emph{System V Options}
804 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
806 @emph{V850 Options}
807 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
808 -mprolog-function  -mno-prolog-function  -mspace @gol
809 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
810 -mapp-regs  -mno-app-regs @gol
811 -mdisable-callt  -mno-disable-callt @gol
812 -mv850e1 @gol
813 -mv850e @gol
814 -mv850  -mbig-switch}
816 @emph{VAX Options}
817 @gccoptlist{-mg  -mgnu  -munix}
819 @emph{VxWorks Options}
820 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
821 -Xbind-lazy  -Xbind-now}
823 @emph{x86-64 Options}
824 See i386 and x86-64 Options.
826 @emph{Xstormy16 Options}
827 @gccoptlist{-msim}
829 @emph{Xtensa Options}
830 @gccoptlist{-mconst16 -mno-const16 @gol
831 -mfused-madd  -mno-fused-madd @gol
832 -mserialize-volatile  -mno-serialize-volatile @gol
833 -mtext-section-literals  -mno-text-section-literals @gol
834 -mtarget-align  -mno-target-align @gol
835 -mlongcalls  -mno-longcalls}
837 @emph{zSeries Options}
838 See S/390 and zSeries Options.
840 @item Code Generation Options
841 @xref{Code Gen Options,,Options for Code Generation Conventions}.
842 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
843 -ffixed-@var{reg}  -fexceptions @gol
844 -fnon-call-exceptions  -funwind-tables @gol
845 -fasynchronous-unwind-tables @gol
846 -finhibit-size-directive  -finstrument-functions @gol
847 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
848 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
849 -fno-common  -fno-ident @gol
850 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
851 -fno-jump-tables @gol
852 -frecord-gcc-switches @gol
853 -freg-struct-return  -fshort-enums @gol
854 -fshort-double  -fshort-wchar @gol
855 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
856 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
857 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
858 -fargument-noalias-global  -fargument-noalias-anything @gol
859 -fleading-underscore  -ftls-model=@var{model} @gol
860 -ftrapv  -fwrapv  -fbounds-check @gol
861 -fvisibility}
862 @end table
864 @menu
865 * Overall Options::     Controlling the kind of output:
866                         an executable, object files, assembler files,
867                         or preprocessed source.
868 * C Dialect Options::   Controlling the variant of C language compiled.
869 * C++ Dialect Options:: Variations on C++.
870 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
871                         and Objective-C++.
872 * Language Independent Options:: Controlling how diagnostics should be
873                         formatted.
874 * Warning Options::     How picky should the compiler be?
875 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
876 * Optimize Options::    How much optimization?
877 * Preprocessor Options:: Controlling header files and macro definitions.
878                          Also, getting dependency information for Make.
879 * Assembler Options::   Passing options to the assembler.
880 * Link Options::        Specifying libraries and so on.
881 * Directory Options::   Where to find header files and libraries.
882                         Where to find the compiler executable files.
883 * Spec Files::          How to pass switches to sub-processes.
884 * Target Options::      Running a cross-compiler, or an old version of GCC.
885 @end menu
887 @node Overall Options
888 @section Options Controlling the Kind of Output
890 Compilation can involve up to four stages: preprocessing, compilation
891 proper, assembly and linking, always in that order.  GCC is capable of
892 preprocessing and compiling several files either into several
893 assembler input files, or into one assembler input file; then each
894 assembler input file produces an object file, and linking combines all
895 the object files (those newly compiled, and those specified as input)
896 into an executable file.
898 @cindex file name suffix
899 For any given input file, the file name suffix determines what kind of
900 compilation is done:
902 @table @gcctabopt
903 @item @var{file}.c
904 C source code which must be preprocessed.
906 @item @var{file}.i
907 C source code which should not be preprocessed.
909 @item @var{file}.ii
910 C++ source code which should not be preprocessed.
912 @item @var{file}.m
913 Objective-C source code.  Note that you must link with the @file{libobjc}
914 library to make an Objective-C program work.
916 @item @var{file}.mi
917 Objective-C source code which should not be preprocessed.
919 @item @var{file}.mm
920 @itemx @var{file}.M
921 Objective-C++ source code.  Note that you must link with the @file{libobjc}
922 library to make an Objective-C++ program work.  Note that @samp{.M} refers
923 to a literal capital M@.
925 @item @var{file}.mii
926 Objective-C++ source code which should not be preprocessed.
928 @item @var{file}.h
929 C, C++, Objective-C or Objective-C++ header file to be turned into a
930 precompiled header.
932 @item @var{file}.cc
933 @itemx @var{file}.cp
934 @itemx @var{file}.cxx
935 @itemx @var{file}.cpp
936 @itemx @var{file}.CPP
937 @itemx @var{file}.c++
938 @itemx @var{file}.C
939 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
940 the last two letters must both be literally @samp{x}.  Likewise,
941 @samp{.C} refers to a literal capital C@.
943 @item @var{file}.mm
944 @itemx @var{file}.M
945 Objective-C++ source code which must be preprocessed.
947 @item @var{file}.mii
948 Objective-C++ source code which should not be preprocessed.
950 @item @var{file}.hh
951 @itemx @var{file}.H
952 @itemx @var{file}.hp
953 @itemx @var{file}.hxx
954 @itemx @var{file}.hpp
955 @itemx @var{file}.HPP
956 @itemx @var{file}.h++
957 @itemx @var{file}.tcc
958 C++ header file to be turned into a precompiled header.
960 @item @var{file}.f
961 @itemx @var{file}.for
962 @itemx @var{file}.ftn
963 Fixed form Fortran source code which should not be preprocessed.
965 @item @var{file}.F
966 @itemx @var{file}.FOR
967 @itemx @var{file}.fpp
968 @itemx @var{file}.FPP
969 @itemx @var{file}.FTN
970 Fixed form Fortran source code which must be preprocessed (with the traditional
971 preprocessor).
973 @item @var{file}.f90
974 @itemx @var{file}.f95
975 @itemx @var{file}.f03
976 @itemx @var{file}.f08
977 Free form Fortran source code which should not be preprocessed.
979 @item @var{file}.F90
980 @itemx @var{file}.F95
981 @itemx @var{file}.F03
982 @itemx @var{file}.F08
983 Free form Fortran source code which must be preprocessed (with the
984 traditional preprocessor).
986 @c FIXME: Descriptions of Java file types.
987 @c @var{file}.java
988 @c @var{file}.class
989 @c @var{file}.zip
990 @c @var{file}.jar
992 @item @var{file}.ads
993 Ada source code file which contains a library unit declaration (a
994 declaration of a package, subprogram, or generic, or a generic
995 instantiation), or a library unit renaming declaration (a package,
996 generic, or subprogram renaming declaration).  Such files are also
997 called @dfn{specs}.
999 @item @var{file}.adb
1000 Ada source code file containing a library unit body (a subprogram or
1001 package body).  Such files are also called @dfn{bodies}.
1003 @c GCC also knows about some suffixes for languages not yet included:
1004 @c Pascal:
1005 @c @var{file}.p
1006 @c @var{file}.pas
1007 @c Ratfor:
1008 @c @var{file}.r
1010 @item @var{file}.s
1011 Assembler code.
1013 @item @var{file}.S
1014 @itemx @var{file}.sx
1015 Assembler code which must be preprocessed.
1017 @item @var{other}
1018 An object file to be fed straight into linking.
1019 Any file name with no recognized suffix is treated this way.
1020 @end table
1022 @opindex x
1023 You can specify the input language explicitly with the @option{-x} option:
1025 @table @gcctabopt
1026 @item -x @var{language}
1027 Specify explicitly the @var{language} for the following input files
1028 (rather than letting the compiler choose a default based on the file
1029 name suffix).  This option applies to all following input files until
1030 the next @option{-x} option.  Possible values for @var{language} are:
1031 @smallexample
1032 c  c-header  c-cpp-output
1033 c++  c++-header  c++-cpp-output
1034 objective-c  objective-c-header  objective-c-cpp-output
1035 objective-c++ objective-c++-header objective-c++-cpp-output
1036 assembler  assembler-with-cpp
1038 f77  f77-cpp-input f95  f95-cpp-input
1039 java
1040 @end smallexample
1042 @item -x none
1043 Turn off any specification of a language, so that subsequent files are
1044 handled according to their file name suffixes (as they are if @option{-x}
1045 has not been used at all).
1047 @item -pass-exit-codes
1048 @opindex pass-exit-codes
1049 Normally the @command{gcc} program will exit with the code of 1 if any
1050 phase of the compiler returns a non-success return code.  If you specify
1051 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1052 numerically highest error produced by any phase that returned an error
1053 indication.  The C, C++, and Fortran frontends return 4, if an internal
1054 compiler error is encountered.
1055 @end table
1057 If you only want some of the stages of compilation, you can use
1058 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1059 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1060 @command{gcc} is to stop.  Note that some combinations (for example,
1061 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1063 @table @gcctabopt
1064 @item -c
1065 @opindex c
1066 Compile or assemble the source files, but do not link.  The linking
1067 stage simply is not done.  The ultimate output is in the form of an
1068 object file for each source file.
1070 By default, the object file name for a source file is made by replacing
1071 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1073 Unrecognized input files, not requiring compilation or assembly, are
1074 ignored.
1076 @item -S
1077 @opindex S
1078 Stop after the stage of compilation proper; do not assemble.  The output
1079 is in the form of an assembler code file for each non-assembler input
1080 file specified.
1082 By default, the assembler file name for a source file is made by
1083 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1085 Input files that don't require compilation are ignored.
1087 @item -E
1088 @opindex E
1089 Stop after the preprocessing stage; do not run the compiler proper.  The
1090 output is in the form of preprocessed source code, which is sent to the
1091 standard output.
1093 Input files which don't require preprocessing are ignored.
1095 @cindex output file option
1096 @item -o @var{file}
1097 @opindex o
1098 Place output in file @var{file}.  This applies regardless to whatever
1099 sort of output is being produced, whether it be an executable file,
1100 an object file, an assembler file or preprocessed C code.
1102 If @option{-o} is not specified, the default is to put an executable
1103 file in @file{a.out}, the object file for
1104 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1105 assembler file in @file{@var{source}.s}, a precompiled header file in
1106 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1107 standard output.
1109 @item -v
1110 @opindex v
1111 Print (on standard error output) the commands executed to run the stages
1112 of compilation.  Also print the version number of the compiler driver
1113 program and of the preprocessor and the compiler proper.
1115 @item -###
1116 @opindex ###
1117 Like @option{-v} except the commands are not executed and all command
1118 arguments are quoted.  This is useful for shell scripts to capture the
1119 driver-generated command lines.
1121 @item -pipe
1122 @opindex pipe
1123 Use pipes rather than temporary files for communication between the
1124 various stages of compilation.  This fails to work on some systems where
1125 the assembler is unable to read from a pipe; but the GNU assembler has
1126 no trouble.
1128 @item -combine
1129 @opindex combine
1130 If you are compiling multiple source files, this option tells the driver
1131 to pass all the source files to the compiler at once (for those
1132 languages for which the compiler can handle this).  This will allow
1133 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1134 language for which this is supported is C@.  If you pass source files for
1135 multiple languages to the driver, using this option, the driver will invoke
1136 the compiler(s) that support IMA once each, passing each compiler all the
1137 source files appropriate for it.  For those languages that do not support
1138 IMA this option will be ignored, and the compiler will be invoked once for
1139 each source file in that language.  If you use this option in conjunction
1140 with @option{-save-temps}, the compiler will generate multiple
1141 pre-processed files
1142 (one for each source file), but only one (combined) @file{.o} or
1143 @file{.s} file.
1145 @item --help
1146 @opindex help
1147 Print (on the standard output) a description of the command line options
1148 understood by @command{gcc}.  If the @option{-v} option is also specified
1149 then @option{--help} will also be passed on to the various processes
1150 invoked by @command{gcc}, so that they can display the command line options
1151 they accept.  If the @option{-Wextra} option has also been specified
1152 (prior to the @option{--help} option), then command line options which
1153 have no documentation associated with them will also be displayed.
1155 @item --target-help
1156 @opindex target-help
1157 Print (on the standard output) a description of target-specific command
1158 line options for each tool.  For some targets extra target-specific
1159 information may also be printed.
1161 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1162 Print (on the standard output) a description of the command line
1163 options understood by the compiler that fit into a specific class.
1164 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1165 @samp{params}, or @var{language}:
1167 @table @asis
1168 @item @samp{optimizers}
1169 This will display all of the optimization options supported by the
1170 compiler.
1172 @item @samp{warnings}
1173 This will display all of the options controlling warning messages
1174 produced by the compiler.
1176 @item @samp{target}
1177 This will display target-specific options.  Unlike the
1178 @option{--target-help} option however, target-specific options of the
1179 linker and assembler will not be displayed.  This is because those
1180 tools do not currently support the extended @option{--help=} syntax.
1182 @item @samp{params}
1183 This will display the values recognized by the @option{--param}
1184 option.
1186 @item @var{language}
1187 This will display the options supported for @var{language}, where 
1188 @var{language} is the name of one of the languages supported in this 
1189 version of GCC.
1191 @item @samp{common}
1192 This will display the options that are common to all languages.
1193 @end table
1195 It is possible to further refine the output of the @option{--help=}
1196 option by adding a comma separated list of qualifiers after the
1197 class.  These can be any from the following list:
1199 @table @asis
1200 @item @samp{undocumented}
1201 Display only those options which are undocumented.
1203 @item @samp{joined}
1204 Display options which take an argument that appears after an equal
1205 sign in the same continuous piece of text, such as:
1206 @samp{--help=target}.
1208 @item @samp{separate}
1209 Display options which take an argument that appears as a separate word
1210 following the original option, such as: @samp{-o output-file}.
1211 @end table
1213 Thus for example to display all the undocumented target-specific
1214 switches supported by the compiler the following can be used:
1216 @smallexample
1217 --help=target,undocumented
1218 @end smallexample
1220 The sense of a qualifier can be inverted by prefixing it with the
1221 @var{^} character, so for example to display all binary warning
1222 options (i.e., ones that are either on or off and that do not take an
1223 argument), which have a description the following can be used:
1225 @smallexample
1226 --help=warnings,^joined,^undocumented
1227 @end smallexample
1229 A class can also be used as a qualifier, although this usually
1230 restricts the output by so much that there is nothing to display.  One
1231 case where it does work however is when one of the classes is
1232 @var{target}.  So for example to display all the target-specific
1233 optimization options the following can be used:
1235 @smallexample
1236 --help=target,optimizers
1237 @end smallexample
1239 The @option{--help=} option can be repeated on the command line.  Each
1240 successive use will display its requested class of options, skipping
1241 those that have already been displayed.
1243 If the @option{-Q} option appears on the command line before the
1244 @option{--help=} option, then the descriptive text displayed by
1245 @option{--help=} is changed.  Instead of describing the displayed
1246 options, an indication is given as to whether the option is enabled,
1247 disabled or set to a specific value (assuming that the compiler
1248 knows this at the point where the @option{--help=} option is used).
1250 Here is a truncated example from the ARM port of @command{gcc}:
1252 @smallexample
1253   % gcc -Q -mabi=2 --help=target -c
1254   The following options are target specific:
1255   -mabi=                                2
1256   -mabort-on-noreturn                   [disabled]
1257   -mapcs                                [disabled]
1258 @end smallexample
1260 The output is sensitive to the effects of previous command line
1261 options, so for example it is possible to find out which optimizations
1262 are enabled at @option{-O2} by using:
1264 @smallexample
1265 -O2 --help=optimizers
1266 @end smallexample
1268 Alternatively you can discover which binary optimizations are enabled
1269 by @option{-O3} by using:
1271 @smallexample
1272 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1273 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1274 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1275 @end smallexample
1277 @item --version
1278 @opindex version
1279 Display the version number and copyrights of the invoked GCC@.
1281 @item -wrapper
1282 @opindex wrapper
1283 Invoke all subcommands under a wrapper program. It takes a single
1284 comma separated list as an argument, which will be used to invoke
1285 the wrapper:
1287 @smallexample
1288 gcc -c t.c -wrapper gdb,--args
1289 @end smallexample
1291 This will invoke all subprograms of gcc under "gdb --args",
1292 thus cc1 invocation will be "gdb --args cc1 ...".
1294 @include @value{srcdir}/../libiberty/at-file.texi
1295 @end table
1297 @node Invoking G++
1298 @section Compiling C++ Programs
1300 @cindex suffixes for C++ source
1301 @cindex C++ source file suffixes
1302 C++ source files conventionally use one of the suffixes @samp{.C},
1303 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1304 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1305 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1306 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1307 files with these names and compiles them as C++ programs even if you
1308 call the compiler the same way as for compiling C programs (usually
1309 with the name @command{gcc}).
1311 @findex g++
1312 @findex c++
1313 However, the use of @command{gcc} does not add the C++ library.
1314 @command{g++} is a program that calls GCC and treats @samp{.c},
1315 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1316 files unless @option{-x} is used, and automatically specifies linking
1317 against the C++ library.  This program is also useful when
1318 precompiling a C header file with a @samp{.h} extension for use in C++
1319 compilations.  On many systems, @command{g++} is also installed with
1320 the name @command{c++}.
1322 @cindex invoking @command{g++}
1323 When you compile C++ programs, you may specify many of the same
1324 command-line options that you use for compiling programs in any
1325 language; or command-line options meaningful for C and related
1326 languages; or options that are meaningful only for C++ programs.
1327 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1328 explanations of options for languages related to C@.
1329 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1330 explanations of options that are meaningful only for C++ programs.
1332 @node C Dialect Options
1333 @section Options Controlling C Dialect
1334 @cindex dialect options
1335 @cindex language dialect options
1336 @cindex options, dialect
1338 The following options control the dialect of C (or languages derived
1339 from C, such as C++, Objective-C and Objective-C++) that the compiler
1340 accepts:
1342 @table @gcctabopt
1343 @cindex ANSI support
1344 @cindex ISO support
1345 @item -ansi
1346 @opindex ansi
1347 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1348 equivalent to @samp{-std=c++98}.
1350 This turns off certain features of GCC that are incompatible with ISO
1351 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1352 such as the @code{asm} and @code{typeof} keywords, and
1353 predefined macros such as @code{unix} and @code{vax} that identify the
1354 type of system you are using.  It also enables the undesirable and
1355 rarely used ISO trigraph feature.  For the C compiler,
1356 it disables recognition of C++ style @samp{//} comments as well as
1357 the @code{inline} keyword.
1359 The alternate keywords @code{__asm__}, @code{__extension__},
1360 @code{__inline__} and @code{__typeof__} continue to work despite
1361 @option{-ansi}.  You would not want to use them in an ISO C program, of
1362 course, but it is useful to put them in header files that might be included
1363 in compilations done with @option{-ansi}.  Alternate predefined macros
1364 such as @code{__unix__} and @code{__vax__} are also available, with or
1365 without @option{-ansi}.
1367 The @option{-ansi} option does not cause non-ISO programs to be
1368 rejected gratuitously.  For that, @option{-pedantic} is required in
1369 addition to @option{-ansi}.  @xref{Warning Options}.
1371 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1372 option is used.  Some header files may notice this macro and refrain
1373 from declaring certain functions or defining certain macros that the
1374 ISO standard doesn't call for; this is to avoid interfering with any
1375 programs that might use these names for other things.
1377 Functions that would normally be built in but do not have semantics
1378 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1379 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1380 built-in functions provided by GCC}, for details of the functions
1381 affected.
1383 @item -std=
1384 @opindex std
1385 Determine the language standard. @xref{Standards,,Language Standards
1386 Supported by GCC}, for details of these standard versions.  This option
1387 is currently only supported when compiling C or C++. 
1389 The compiler can accept several base standards, such as @samp{c89} or
1390 @samp{c++98}, and GNU dialects of those standards, such as
1391 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1392 compiler will accept all programs following that standard and those
1393 using GNU extensions that do not contradict it.  For example,
1394 @samp{-std=c89} turns off certain features of GCC that are
1395 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1396 keywords, but not other GNU extensions that do not have a meaning in
1397 ISO C90, such as omitting the middle term of a @code{?:}
1398 expression. On the other hand, by specifying a GNU dialect of a
1399 standard, all features the compiler support are enabled, even when
1400 those features change the meaning of the base standard and some
1401 strict-conforming programs may be rejected.  The particular standard
1402 is used by @option{-pedantic} to identify which features are GNU
1403 extensions given that version of the standard. For example
1404 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1405 comments, while @samp{-std=gnu99 -pedantic} would not.
1407 A value for this option must be provided; possible values are
1409 @table @samp
1410 @item c89
1411 @itemx iso9899:1990
1412 Support all ISO C90 programs (certain GNU extensions that conflict
1413 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1415 @item iso9899:199409
1416 ISO C90 as modified in amendment 1.
1418 @item c99
1419 @itemx c9x
1420 @itemx iso9899:1999
1421 @itemx iso9899:199x
1422 ISO C99.  Note that this standard is not yet fully supported; see
1423 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1424 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1426 @item gnu89
1427 GNU dialect of ISO C90 (including some C99 features). This
1428 is the default for C code.
1430 @item gnu99
1431 @itemx gnu9x
1432 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1433 this will become the default.  The name @samp{gnu9x} is deprecated.
1435 @item c++98
1436 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1437 C++ code.
1439 @item gnu++98
1440 GNU dialect of @option{-std=c++98}.  This is the default for
1441 C++ code.
1443 @item c++0x
1444 The working draft of the upcoming ISO C++0x standard. This option
1445 enables experimental features that are likely to be included in
1446 C++0x. The working draft is constantly changing, and any feature that is
1447 enabled by this flag may be removed from future versions of GCC if it is
1448 not part of the C++0x standard.
1450 @item gnu++0x
1451 GNU dialect of @option{-std=c++0x}. This option enables
1452 experimental features that may be removed in future versions of GCC.
1453 @end table
1455 @item -fgnu89-inline
1456 @opindex fgnu89-inline
1457 The option @option{-fgnu89-inline} tells GCC to use the traditional
1458 GNU semantics for @code{inline} functions when in C99 mode.
1459 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1460 is accepted and ignored by GCC versions 4.1.3 up to but not including
1461 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1462 C99 mode.  Using this option is roughly equivalent to adding the
1463 @code{gnu_inline} function attribute to all inline functions
1464 (@pxref{Function Attributes}).
1466 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1467 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1468 specifies the default behavior).  This option was first supported in
1469 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1471 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1472 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1473 in effect for @code{inline} functions.  @xref{Common Predefined
1474 Macros,,,cpp,The C Preprocessor}.
1476 @item -aux-info @var{filename}
1477 @opindex aux-info
1478 Output to the given filename prototyped declarations for all functions
1479 declared and/or defined in a translation unit, including those in header
1480 files.  This option is silently ignored in any language other than C@.
1482 Besides declarations, the file indicates, in comments, the origin of
1483 each declaration (source file and line), whether the declaration was
1484 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1485 @samp{O} for old, respectively, in the first character after the line
1486 number and the colon), and whether it came from a declaration or a
1487 definition (@samp{C} or @samp{F}, respectively, in the following
1488 character).  In the case of function definitions, a K&R-style list of
1489 arguments followed by their declarations is also provided, inside
1490 comments, after the declaration.
1492 @item -fno-asm
1493 @opindex fno-asm
1494 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1495 keyword, so that code can use these words as identifiers.  You can use
1496 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1497 instead.  @option{-ansi} implies @option{-fno-asm}.
1499 In C++, this switch only affects the @code{typeof} keyword, since
1500 @code{asm} and @code{inline} are standard keywords.  You may want to
1501 use the @option{-fno-gnu-keywords} flag instead, which has the same
1502 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1503 switch only affects the @code{asm} and @code{typeof} keywords, since
1504 @code{inline} is a standard keyword in ISO C99.
1506 @item -fno-builtin
1507 @itemx -fno-builtin-@var{function}
1508 @opindex fno-builtin
1509 @cindex built-in functions
1510 Don't recognize built-in functions that do not begin with
1511 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1512 functions provided by GCC}, for details of the functions affected,
1513 including those which are not built-in functions when @option{-ansi} or
1514 @option{-std} options for strict ISO C conformance are used because they
1515 do not have an ISO standard meaning.
1517 GCC normally generates special code to handle certain built-in functions
1518 more efficiently; for instance, calls to @code{alloca} may become single
1519 instructions that adjust the stack directly, and calls to @code{memcpy}
1520 may become inline copy loops.  The resulting code is often both smaller
1521 and faster, but since the function calls no longer appear as such, you
1522 cannot set a breakpoint on those calls, nor can you change the behavior
1523 of the functions by linking with a different library.  In addition,
1524 when a function is recognized as a built-in function, GCC may use
1525 information about that function to warn about problems with calls to
1526 that function, or to generate more efficient code, even if the
1527 resulting code still contains calls to that function.  For example,
1528 warnings are given with @option{-Wformat} for bad calls to
1529 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1530 known not to modify global memory.
1532 With the @option{-fno-builtin-@var{function}} option
1533 only the built-in function @var{function} is
1534 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1535 function is named that is not built-in in this version of GCC, this
1536 option is ignored.  There is no corresponding
1537 @option{-fbuiltin-@var{function}} option; if you wish to enable
1538 built-in functions selectively when using @option{-fno-builtin} or
1539 @option{-ffreestanding}, you may define macros such as:
1541 @smallexample
1542 #define abs(n)          __builtin_abs ((n))
1543 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1544 @end smallexample
1546 @item -fhosted
1547 @opindex fhosted
1548 @cindex hosted environment
1550 Assert that compilation takes place in a hosted environment.  This implies
1551 @option{-fbuiltin}.  A hosted environment is one in which the
1552 entire standard library is available, and in which @code{main} has a return
1553 type of @code{int}.  Examples are nearly everything except a kernel.
1554 This is equivalent to @option{-fno-freestanding}.
1556 @item -ffreestanding
1557 @opindex ffreestanding
1558 @cindex hosted environment
1560 Assert that compilation takes place in a freestanding environment.  This
1561 implies @option{-fno-builtin}.  A freestanding environment
1562 is one in which the standard library may not exist, and program startup may
1563 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1564 This is equivalent to @option{-fno-hosted}.
1566 @xref{Standards,,Language Standards Supported by GCC}, for details of
1567 freestanding and hosted environments.
1569 @item -fopenmp
1570 @opindex fopenmp
1571 @cindex openmp parallel
1572 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1573 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1574 compiler generates parallel code according to the OpenMP Application
1575 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1576 implies @option{-pthread}, and thus is only supported on targets that
1577 have support for @option{-pthread}.
1579 @item -fms-extensions
1580 @opindex fms-extensions
1581 Accept some non-standard constructs used in Microsoft header files.
1583 Some cases of unnamed fields in structures and unions are only
1584 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1585 fields within structs/unions}, for details.
1587 @item -trigraphs
1588 @opindex trigraphs
1589 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1590 options for strict ISO C conformance) implies @option{-trigraphs}.
1592 @item -no-integrated-cpp
1593 @opindex no-integrated-cpp
1594 Performs a compilation in two passes: preprocessing and compiling.  This
1595 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1596 @option{-B} option.  The user supplied compilation step can then add in
1597 an additional preprocessing step after normal preprocessing but before
1598 compiling.  The default is to use the integrated cpp (internal cpp)
1600 The semantics of this option will change if "cc1", "cc1plus", and
1601 "cc1obj" are merged.
1603 @cindex traditional C language
1604 @cindex C language, traditional
1605 @item -traditional
1606 @itemx -traditional-cpp
1607 @opindex traditional-cpp
1608 @opindex traditional
1609 Formerly, these options caused GCC to attempt to emulate a pre-standard
1610 C compiler.  They are now only supported with the @option{-E} switch.
1611 The preprocessor continues to support a pre-standard mode.  See the GNU
1612 CPP manual for details.
1614 @item -fcond-mismatch
1615 @opindex fcond-mismatch
1616 Allow conditional expressions with mismatched types in the second and
1617 third arguments.  The value of such an expression is void.  This option
1618 is not supported for C++.
1620 @item -flax-vector-conversions
1621 @opindex flax-vector-conversions
1622 Allow implicit conversions between vectors with differing numbers of
1623 elements and/or incompatible element types.  This option should not be
1624 used for new code.
1626 @item -funsigned-char
1627 @opindex funsigned-char
1628 Let the type @code{char} be unsigned, like @code{unsigned char}.
1630 Each kind of machine has a default for what @code{char} should
1631 be.  It is either like @code{unsigned char} by default or like
1632 @code{signed char} by default.
1634 Ideally, a portable program should always use @code{signed char} or
1635 @code{unsigned char} when it depends on the signedness of an object.
1636 But many programs have been written to use plain @code{char} and
1637 expect it to be signed, or expect it to be unsigned, depending on the
1638 machines they were written for.  This option, and its inverse, let you
1639 make such a program work with the opposite default.
1641 The type @code{char} is always a distinct type from each of
1642 @code{signed char} or @code{unsigned char}, even though its behavior
1643 is always just like one of those two.
1645 @item -fsigned-char
1646 @opindex fsigned-char
1647 Let the type @code{char} be signed, like @code{signed char}.
1649 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1650 the negative form of @option{-funsigned-char}.  Likewise, the option
1651 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1653 @item -fsigned-bitfields
1654 @itemx -funsigned-bitfields
1655 @itemx -fno-signed-bitfields
1656 @itemx -fno-unsigned-bitfields
1657 @opindex fsigned-bitfields
1658 @opindex funsigned-bitfields
1659 @opindex fno-signed-bitfields
1660 @opindex fno-unsigned-bitfields
1661 These options control whether a bit-field is signed or unsigned, when the
1662 declaration does not use either @code{signed} or @code{unsigned}.  By
1663 default, such a bit-field is signed, because this is consistent: the
1664 basic integer types such as @code{int} are signed types.
1665 @end table
1667 @node C++ Dialect Options
1668 @section Options Controlling C++ Dialect
1670 @cindex compiler options, C++
1671 @cindex C++ options, command line
1672 @cindex options, C++
1673 This section describes the command-line options that are only meaningful
1674 for C++ programs; but you can also use most of the GNU compiler options
1675 regardless of what language your program is in.  For example, you
1676 might compile a file @code{firstClass.C} like this:
1678 @smallexample
1679 g++ -g -frepo -O -c firstClass.C
1680 @end smallexample
1682 @noindent
1683 In this example, only @option{-frepo} is an option meant
1684 only for C++ programs; you can use the other options with any
1685 language supported by GCC@.
1687 Here is a list of options that are @emph{only} for compiling C++ programs:
1689 @table @gcctabopt
1691 @item -fabi-version=@var{n}
1692 @opindex fabi-version
1693 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1694 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1695 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1696 the version that conforms most closely to the C++ ABI specification.
1697 Therefore, the ABI obtained using version 0 will change as ABI bugs
1698 are fixed.
1700 The default is version 2.
1702 @item -fno-access-control
1703 @opindex fno-access-control
1704 Turn off all access checking.  This switch is mainly useful for working
1705 around bugs in the access control code.
1707 @item -fcheck-new
1708 @opindex fcheck-new
1709 Check that the pointer returned by @code{operator new} is non-null
1710 before attempting to modify the storage allocated.  This check is
1711 normally unnecessary because the C++ standard specifies that
1712 @code{operator new} will only return @code{0} if it is declared
1713 @samp{throw()}, in which case the compiler will always check the
1714 return value even without this option.  In all other cases, when
1715 @code{operator new} has a non-empty exception specification, memory
1716 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1717 @samp{new (nothrow)}.
1719 @item -fconserve-space
1720 @opindex fconserve-space
1721 Put uninitialized or runtime-initialized global variables into the
1722 common segment, as C does.  This saves space in the executable at the
1723 cost of not diagnosing duplicate definitions.  If you compile with this
1724 flag and your program mysteriously crashes after @code{main()} has
1725 completed, you may have an object that is being destroyed twice because
1726 two definitions were merged.
1728 This option is no longer useful on most targets, now that support has
1729 been added for putting variables into BSS without making them common.
1731 @item -ffriend-injection
1732 @opindex ffriend-injection
1733 Inject friend functions into the enclosing namespace, so that they are
1734 visible outside the scope of the class in which they are declared.
1735 Friend functions were documented to work this way in the old Annotated
1736 C++ Reference Manual, and versions of G++ before 4.1 always worked
1737 that way.  However, in ISO C++ a friend function which is not declared
1738 in an enclosing scope can only be found using argument dependent
1739 lookup.  This option causes friends to be injected as they were in
1740 earlier releases.
1742 This option is for compatibility, and may be removed in a future
1743 release of G++.
1745 @item -fno-elide-constructors
1746 @opindex fno-elide-constructors
1747 The C++ standard allows an implementation to omit creating a temporary
1748 which is only used to initialize another object of the same type.
1749 Specifying this option disables that optimization, and forces G++ to
1750 call the copy constructor in all cases.
1752 @item -fno-enforce-eh-specs
1753 @opindex fno-enforce-eh-specs
1754 Don't generate code to check for violation of exception specifications
1755 at runtime.  This option violates the C++ standard, but may be useful
1756 for reducing code size in production builds, much like defining
1757 @samp{NDEBUG}.  This does not give user code permission to throw
1758 exceptions in violation of the exception specifications; the compiler
1759 will still optimize based on the specifications, so throwing an
1760 unexpected exception will result in undefined behavior.
1762 @item -ffor-scope
1763 @itemx -fno-for-scope
1764 @opindex ffor-scope
1765 @opindex fno-for-scope
1766 If @option{-ffor-scope} is specified, the scope of variables declared in
1767 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1768 as specified by the C++ standard.
1769 If @option{-fno-for-scope} is specified, the scope of variables declared in
1770 a @i{for-init-statement} extends to the end of the enclosing scope,
1771 as was the case in old versions of G++, and other (traditional)
1772 implementations of C++.
1774 The default if neither flag is given to follow the standard,
1775 but to allow and give a warning for old-style code that would
1776 otherwise be invalid, or have different behavior.
1778 @item -fno-gnu-keywords
1779 @opindex fno-gnu-keywords
1780 Do not recognize @code{typeof} as a keyword, so that code can use this
1781 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1782 @option{-ansi} implies @option{-fno-gnu-keywords}.
1784 @item -fno-implicit-templates
1785 @opindex fno-implicit-templates
1786 Never emit code for non-inline templates which are instantiated
1787 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1788 @xref{Template Instantiation}, for more information.
1790 @item -fno-implicit-inline-templates
1791 @opindex fno-implicit-inline-templates
1792 Don't emit code for implicit instantiations of inline templates, either.
1793 The default is to handle inlines differently so that compiles with and
1794 without optimization will need the same set of explicit instantiations.
1796 @item -fno-implement-inlines
1797 @opindex fno-implement-inlines
1798 To save space, do not emit out-of-line copies of inline functions
1799 controlled by @samp{#pragma implementation}.  This will cause linker
1800 errors if these functions are not inlined everywhere they are called.
1802 @item -fms-extensions
1803 @opindex fms-extensions
1804 Disable pedantic warnings about constructs used in MFC, such as implicit
1805 int and getting a pointer to member function via non-standard syntax.
1807 @item -fno-nonansi-builtins
1808 @opindex fno-nonansi-builtins
1809 Disable built-in declarations of functions that are not mandated by
1810 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1811 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1813 @item -fno-operator-names
1814 @opindex fno-operator-names
1815 Do not treat the operator name keywords @code{and}, @code{bitand},
1816 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1817 synonyms as keywords.
1819 @item -fno-optional-diags
1820 @opindex fno-optional-diags
1821 Disable diagnostics that the standard says a compiler does not need to
1822 issue.  Currently, the only such diagnostic issued by G++ is the one for
1823 a name having multiple meanings within a class.
1825 @item -fpermissive
1826 @opindex fpermissive
1827 Downgrade some diagnostics about nonconformant code from errors to
1828 warnings.  Thus, using @option{-fpermissive} will allow some
1829 nonconforming code to compile.
1831 @item -frepo
1832 @opindex frepo
1833 Enable automatic template instantiation at link time.  This option also
1834 implies @option{-fno-implicit-templates}.  @xref{Template
1835 Instantiation}, for more information.
1837 @item -fno-rtti
1838 @opindex fno-rtti
1839 Disable generation of information about every class with virtual
1840 functions for use by the C++ runtime type identification features
1841 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1842 of the language, you can save some space by using this flag.  Note that
1843 exception handling uses the same information, but it will generate it as
1844 needed. The @samp{dynamic_cast} operator can still be used for casts that
1845 do not require runtime type information, i.e.@: casts to @code{void *} or to
1846 unambiguous base classes.
1848 @item -fstats
1849 @opindex fstats
1850 Emit statistics about front-end processing at the end of the compilation.
1851 This information is generally only useful to the G++ development team.
1853 @item -ftemplate-depth-@var{n}
1854 @opindex ftemplate-depth
1855 Set the maximum instantiation depth for template classes to @var{n}.
1856 A limit on the template instantiation depth is needed to detect
1857 endless recursions during template class instantiation.  ANSI/ISO C++
1858 conforming programs must not rely on a maximum depth greater than 17.
1860 @item -fno-threadsafe-statics
1861 @opindex fno-threadsafe-statics
1862 Do not emit the extra code to use the routines specified in the C++
1863 ABI for thread-safe initialization of local statics.  You can use this
1864 option to reduce code size slightly in code that doesn't need to be
1865 thread-safe.
1867 @item -fuse-cxa-atexit
1868 @opindex fuse-cxa-atexit
1869 Register destructors for objects with static storage duration with the
1870 @code{__cxa_atexit} function rather than the @code{atexit} function.
1871 This option is required for fully standards-compliant handling of static
1872 destructors, but will only work if your C library supports
1873 @code{__cxa_atexit}.
1875 @item -fno-use-cxa-get-exception-ptr
1876 @opindex fno-use-cxa-get-exception-ptr
1877 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1878 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1879 if the runtime routine is not available.
1881 @item -fvisibility-inlines-hidden
1882 @opindex fvisibility-inlines-hidden
1883 This switch declares that the user does not attempt to compare
1884 pointers to inline methods where the addresses of the two functions
1885 were taken in different shared objects.
1887 The effect of this is that GCC may, effectively, mark inline methods with
1888 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1889 appear in the export table of a DSO and do not require a PLT indirection
1890 when used within the DSO@.  Enabling this option can have a dramatic effect
1891 on load and link times of a DSO as it massively reduces the size of the
1892 dynamic export table when the library makes heavy use of templates.
1894 The behavior of this switch is not quite the same as marking the
1895 methods as hidden directly, because it does not affect static variables
1896 local to the function or cause the compiler to deduce that
1897 the function is defined in only one shared object.
1899 You may mark a method as having a visibility explicitly to negate the
1900 effect of the switch for that method.  For example, if you do want to
1901 compare pointers to a particular inline method, you might mark it as
1902 having default visibility.  Marking the enclosing class with explicit
1903 visibility will have no effect.
1905 Explicitly instantiated inline methods are unaffected by this option
1906 as their linkage might otherwise cross a shared library boundary.
1907 @xref{Template Instantiation}.
1909 @item -fvisibility-ms-compat
1910 @opindex fvisibility-ms-compat
1911 This flag attempts to use visibility settings to make GCC's C++
1912 linkage model compatible with that of Microsoft Visual Studio.
1914 The flag makes these changes to GCC's linkage model:
1916 @enumerate
1917 @item
1918 It sets the default visibility to @code{hidden}, like
1919 @option{-fvisibility=hidden}.
1921 @item
1922 Types, but not their members, are not hidden by default.
1924 @item
1925 The One Definition Rule is relaxed for types without explicit
1926 visibility specifications which are defined in more than one different
1927 shared object: those declarations are permitted if they would have
1928 been permitted when this option was not used.
1929 @end enumerate
1931 In new code it is better to use @option{-fvisibility=hidden} and
1932 export those classes which are intended to be externally visible.
1933 Unfortunately it is possible for code to rely, perhaps accidentally,
1934 on the Visual Studio behavior.
1936 Among the consequences of these changes are that static data members
1937 of the same type with the same name but defined in different shared
1938 objects will be different, so changing one will not change the other;
1939 and that pointers to function members defined in different shared
1940 objects may not compare equal.  When this flag is given, it is a
1941 violation of the ODR to define types with the same name differently.
1943 @item -fno-weak
1944 @opindex fno-weak
1945 Do not use weak symbol support, even if it is provided by the linker.
1946 By default, G++ will use weak symbols if they are available.  This
1947 option exists only for testing, and should not be used by end-users;
1948 it will result in inferior code and has no benefits.  This option may
1949 be removed in a future release of G++.
1951 @item -nostdinc++
1952 @opindex nostdinc++
1953 Do not search for header files in the standard directories specific to
1954 C++, but do still search the other standard directories.  (This option
1955 is used when building the C++ library.)
1956 @end table
1958 In addition, these optimization, warning, and code generation options
1959 have meanings only for C++ programs:
1961 @table @gcctabopt
1962 @item -fno-default-inline
1963 @opindex fno-default-inline
1964 Do not assume @samp{inline} for functions defined inside a class scope.
1965 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1966 functions will have linkage like inline functions; they just won't be
1967 inlined by default.
1969 @item -Wabi @r{(C++ and Objective-C++ only)}
1970 @opindex Wabi
1971 @opindex Wno-abi
1972 Warn when G++ generates code that is probably not compatible with the
1973 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1974 all such cases, there are probably some cases that are not warned about,
1975 even though G++ is generating incompatible code.  There may also be
1976 cases where warnings are emitted even though the code that is generated
1977 will be compatible.
1979 You should rewrite your code to avoid these warnings if you are
1980 concerned about the fact that code generated by G++ may not be binary
1981 compatible with code generated by other compilers.
1983 The known incompatibilities at this point include:
1985 @itemize @bullet
1987 @item
1988 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1989 pack data into the same byte as a base class.  For example:
1991 @smallexample
1992 struct A @{ virtual void f(); int f1 : 1; @};
1993 struct B : public A @{ int f2 : 1; @};
1994 @end smallexample
1996 @noindent
1997 In this case, G++ will place @code{B::f2} into the same byte
1998 as@code{A::f1}; other compilers will not.  You can avoid this problem
1999 by explicitly padding @code{A} so that its size is a multiple of the
2000 byte size on your platform; that will cause G++ and other compilers to
2001 layout @code{B} identically.
2003 @item
2004 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2005 tail padding when laying out virtual bases.  For example:
2007 @smallexample
2008 struct A @{ virtual void f(); char c1; @};
2009 struct B @{ B(); char c2; @};
2010 struct C : public A, public virtual B @{@};
2011 @end smallexample
2013 @noindent
2014 In this case, G++ will not place @code{B} into the tail-padding for
2015 @code{A}; other compilers will.  You can avoid this problem by
2016 explicitly padding @code{A} so that its size is a multiple of its
2017 alignment (ignoring virtual base classes); that will cause G++ and other
2018 compilers to layout @code{C} identically.
2020 @item
2021 Incorrect handling of bit-fields with declared widths greater than that
2022 of their underlying types, when the bit-fields appear in a union.  For
2023 example:
2025 @smallexample
2026 union U @{ int i : 4096; @};
2027 @end smallexample
2029 @noindent
2030 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2031 union too small by the number of bits in an @code{int}.
2033 @item
2034 Empty classes can be placed at incorrect offsets.  For example:
2036 @smallexample
2037 struct A @{@};
2039 struct B @{
2040   A a;
2041   virtual void f ();
2044 struct C : public B, public A @{@};
2045 @end smallexample
2047 @noindent
2048 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2049 it should be placed at offset zero.  G++ mistakenly believes that the
2050 @code{A} data member of @code{B} is already at offset zero.
2052 @item
2053 Names of template functions whose types involve @code{typename} or
2054 template template parameters can be mangled incorrectly.
2056 @smallexample
2057 template <typename Q>
2058 void f(typename Q::X) @{@}
2060 template <template <typename> class Q>
2061 void f(typename Q<int>::X) @{@}
2062 @end smallexample
2064 @noindent
2065 Instantiations of these templates may be mangled incorrectly.
2067 @end itemize
2069 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2070 @opindex Wctor-dtor-privacy
2071 @opindex Wno-ctor-dtor-privacy
2072 Warn when a class seems unusable because all the constructors or
2073 destructors in that class are private, and it has neither friends nor
2074 public static member functions.
2076 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2077 @opindex Wnon-virtual-dtor
2078 @opindex Wno-non-virtual-dtor
2079 Warn when a class has virtual functions and accessible non-virtual
2080 destructor, in which case it would be possible but unsafe to delete
2081 an instance of a derived class through a pointer to the base class.
2082 This warning is also enabled if -Weffc++ is specified.
2084 @item -Wreorder @r{(C++ and Objective-C++ only)}
2085 @opindex Wreorder
2086 @opindex Wno-reorder
2087 @cindex reordering, warning
2088 @cindex warning for reordering of member initializers
2089 Warn when the order of member initializers given in the code does not
2090 match the order in which they must be executed.  For instance:
2092 @smallexample
2093 struct A @{
2094   int i;
2095   int j;
2096   A(): j (0), i (1) @{ @}
2098 @end smallexample
2100 The compiler will rearrange the member initializers for @samp{i}
2101 and @samp{j} to match the declaration order of the members, emitting
2102 a warning to that effect.  This warning is enabled by @option{-Wall}.
2103 @end table
2105 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2107 @table @gcctabopt
2108 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2109 @opindex Weffc++
2110 @opindex Wno-effc++
2111 Warn about violations of the following style guidelines from Scott Meyers'
2112 @cite{Effective C++} book:
2114 @itemize @bullet
2115 @item
2116 Item 11:  Define a copy constructor and an assignment operator for classes
2117 with dynamically allocated memory.
2119 @item
2120 Item 12:  Prefer initialization to assignment in constructors.
2122 @item
2123 Item 14:  Make destructors virtual in base classes.
2125 @item
2126 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2128 @item
2129 Item 23:  Don't try to return a reference when you must return an object.
2131 @end itemize
2133 Also warn about violations of the following style guidelines from
2134 Scott Meyers' @cite{More Effective C++} book:
2136 @itemize @bullet
2137 @item
2138 Item 6:  Distinguish between prefix and postfix forms of increment and
2139 decrement operators.
2141 @item
2142 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2144 @end itemize
2146 When selecting this option, be aware that the standard library
2147 headers do not obey all of these guidelines; use @samp{grep -v}
2148 to filter out those warnings.
2150 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2151 @opindex Wstrict-null-sentinel
2152 @opindex Wno-strict-null-sentinel
2153 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2154 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2155 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2156 it is guaranteed to be of the same size as a pointer.  But this use is
2157 not portable across different compilers.
2159 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2160 @opindex Wno-non-template-friend
2161 @opindex Wnon-template-friend
2162 Disable warnings when non-templatized friend functions are declared
2163 within a template.  Since the advent of explicit template specification
2164 support in G++, if the name of the friend is an unqualified-id (i.e.,
2165 @samp{friend foo(int)}), the C++ language specification demands that the
2166 friend declare or define an ordinary, nontemplate function.  (Section
2167 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2168 could be interpreted as a particular specialization of a templatized
2169 function.  Because this non-conforming behavior is no longer the default
2170 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2171 check existing code for potential trouble spots and is on by default.
2172 This new compiler behavior can be turned off with
2173 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2174 but disables the helpful warning.
2176 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2177 @opindex Wold-style-cast
2178 @opindex Wno-old-style-cast
2179 Warn if an old-style (C-style) cast to a non-void type is used within
2180 a C++ program.  The new-style casts (@samp{dynamic_cast},
2181 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2182 less vulnerable to unintended effects and much easier to search for.
2184 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2185 @opindex Woverloaded-virtual
2186 @opindex Wno-overloaded-virtual
2187 @cindex overloaded virtual fn, warning
2188 @cindex warning for overloaded virtual fn
2189 Warn when a function declaration hides virtual functions from a
2190 base class.  For example, in:
2192 @smallexample
2193 struct A @{
2194   virtual void f();
2197 struct B: public A @{
2198   void f(int);
2200 @end smallexample
2202 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2203 like:
2205 @smallexample
2206 B* b;
2207 b->f();
2208 @end smallexample
2210 will fail to compile.
2212 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2213 @opindex Wno-pmf-conversions
2214 @opindex Wpmf-conversions
2215 Disable the diagnostic for converting a bound pointer to member function
2216 to a plain pointer.
2218 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2219 @opindex Wsign-promo
2220 @opindex Wno-sign-promo
2221 Warn when overload resolution chooses a promotion from unsigned or
2222 enumerated type to a signed type, over a conversion to an unsigned type of
2223 the same size.  Previous versions of G++ would try to preserve
2224 unsignedness, but the standard mandates the current behavior.
2226 @smallexample
2227 struct A @{
2228   operator int ();
2229   A& operator = (int);
2232 main ()
2234   A a,b;
2235   a = b;
2237 @end smallexample
2239 In this example, G++ will synthesize a default @samp{A& operator =
2240 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2241 @end table
2243 @node Objective-C and Objective-C++ Dialect Options
2244 @section Options Controlling Objective-C and Objective-C++ Dialects
2246 @cindex compiler options, Objective-C and Objective-C++
2247 @cindex Objective-C and Objective-C++ options, command line
2248 @cindex options, Objective-C and Objective-C++
2249 (NOTE: This manual does not describe the Objective-C and Objective-C++
2250 languages themselves.  See @xref{Standards,,Language Standards
2251 Supported by GCC}, for references.)
2253 This section describes the command-line options that are only meaningful
2254 for Objective-C and Objective-C++ programs, but you can also use most of
2255 the language-independent GNU compiler options.
2256 For example, you might compile a file @code{some_class.m} like this:
2258 @smallexample
2259 gcc -g -fgnu-runtime -O -c some_class.m
2260 @end smallexample
2262 @noindent
2263 In this example, @option{-fgnu-runtime} is an option meant only for
2264 Objective-C and Objective-C++ programs; you can use the other options with
2265 any language supported by GCC@.
2267 Note that since Objective-C is an extension of the C language, Objective-C
2268 compilations may also use options specific to the C front-end (e.g.,
2269 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2270 C++-specific options (e.g., @option{-Wabi}).
2272 Here is a list of options that are @emph{only} for compiling Objective-C
2273 and Objective-C++ programs:
2275 @table @gcctabopt
2276 @item -fconstant-string-class=@var{class-name}
2277 @opindex fconstant-string-class
2278 Use @var{class-name} as the name of the class to instantiate for each
2279 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2280 class name is @code{NXConstantString} if the GNU runtime is being used, and
2281 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2282 @option{-fconstant-cfstrings} option, if also present, will override the
2283 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2284 to be laid out as constant CoreFoundation strings.
2286 @item -fgnu-runtime
2287 @opindex fgnu-runtime
2288 Generate object code compatible with the standard GNU Objective-C
2289 runtime.  This is the default for most types of systems.
2291 @item -fnext-runtime
2292 @opindex fnext-runtime
2293 Generate output compatible with the NeXT runtime.  This is the default
2294 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2295 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2296 used.
2298 @item -fno-nil-receivers
2299 @opindex fno-nil-receivers
2300 Assume that all Objective-C message dispatches (e.g.,
2301 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2302 is not @code{nil}.  This allows for more efficient entry points in the runtime
2303 to be used.  Currently, this option is only available in conjunction with
2304 the NeXT runtime on Mac OS X 10.3 and later.
2306 @item -fobjc-call-cxx-cdtors
2307 @opindex fobjc-call-cxx-cdtors
2308 For each Objective-C class, check if any of its instance variables is a
2309 C++ object with a non-trivial default constructor.  If so, synthesize a
2310 special @code{- (id) .cxx_construct} instance method that will run
2311 non-trivial default constructors on any such instance variables, in order,
2312 and then return @code{self}.  Similarly, check if any instance variable
2313 is a C++ object with a non-trivial destructor, and if so, synthesize a
2314 special @code{- (void) .cxx_destruct} method that will run
2315 all such default destructors, in reverse order.
2317 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2318 thusly generated will only operate on instance variables declared in the
2319 current Objective-C class, and not those inherited from superclasses.  It
2320 is the responsibility of the Objective-C runtime to invoke all such methods
2321 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2322 will be invoked by the runtime immediately after a new object
2323 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2324 be invoked immediately before the runtime deallocates an object instance.
2326 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2327 support for invoking the @code{- (id) .cxx_construct} and
2328 @code{- (void) .cxx_destruct} methods.
2330 @item -fobjc-direct-dispatch
2331 @opindex fobjc-direct-dispatch
2332 Allow fast jumps to the message dispatcher.  On Darwin this is
2333 accomplished via the comm page.
2335 @item -fobjc-exceptions
2336 @opindex fobjc-exceptions
2337 Enable syntactic support for structured exception handling in Objective-C,
2338 similar to what is offered by C++ and Java.  This option is
2339 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2340 earlier.
2342 @smallexample
2343   @@try @{
2344     @dots{}
2345        @@throw expr;
2346     @dots{}
2347   @}
2348   @@catch (AnObjCClass *exc) @{
2349     @dots{}
2350       @@throw expr;
2351     @dots{}
2352       @@throw;
2353     @dots{}
2354   @}
2355   @@catch (AnotherClass *exc) @{
2356     @dots{}
2357   @}
2358   @@catch (id allOthers) @{
2359     @dots{}
2360   @}
2361   @@finally @{
2362     @dots{}
2363       @@throw expr;
2364     @dots{}
2365   @}
2366 @end smallexample
2368 The @code{@@throw} statement may appear anywhere in an Objective-C or
2369 Objective-C++ program; when used inside of a @code{@@catch} block, the
2370 @code{@@throw} may appear without an argument (as shown above), in which case
2371 the object caught by the @code{@@catch} will be rethrown.
2373 Note that only (pointers to) Objective-C objects may be thrown and
2374 caught using this scheme.  When an object is thrown, it will be caught
2375 by the nearest @code{@@catch} clause capable of handling objects of that type,
2376 analogously to how @code{catch} blocks work in C++ and Java.  A
2377 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2378 any and all Objective-C exceptions not caught by previous @code{@@catch}
2379 clauses (if any).
2381 The @code{@@finally} clause, if present, will be executed upon exit from the
2382 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2383 regardless of whether any exceptions are thrown, caught or rethrown
2384 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2385 of the @code{finally} clause in Java.
2387 There are several caveats to using the new exception mechanism:
2389 @itemize @bullet
2390 @item
2391 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2392 idioms provided by the @code{NSException} class, the new
2393 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2394 systems, due to additional functionality needed in the (NeXT) Objective-C
2395 runtime.
2397 @item
2398 As mentioned above, the new exceptions do not support handling
2399 types other than Objective-C objects.   Furthermore, when used from
2400 Objective-C++, the Objective-C exception model does not interoperate with C++
2401 exceptions at this time.  This means you cannot @code{@@throw} an exception
2402 from Objective-C and @code{catch} it in C++, or vice versa
2403 (i.e., @code{throw @dots{} @@catch}).
2404 @end itemize
2406 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2407 blocks for thread-safe execution:
2409 @smallexample
2410   @@synchronized (ObjCClass *guard) @{
2411     @dots{}
2412   @}
2413 @end smallexample
2415 Upon entering the @code{@@synchronized} block, a thread of execution shall
2416 first check whether a lock has been placed on the corresponding @code{guard}
2417 object by another thread.  If it has, the current thread shall wait until
2418 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2419 the current thread will place its own lock on it, execute the code contained in
2420 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2421 making @code{guard} available to other threads).
2423 Unlike Java, Objective-C does not allow for entire methods to be marked
2424 @code{@@synchronized}.  Note that throwing exceptions out of
2425 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2426 to be unlocked properly.
2428 @item -fobjc-gc
2429 @opindex fobjc-gc
2430 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2432 @item -freplace-objc-classes
2433 @opindex freplace-objc-classes
2434 Emit a special marker instructing @command{ld(1)} not to statically link in
2435 the resulting object file, and allow @command{dyld(1)} to load it in at
2436 run time instead.  This is used in conjunction with the Fix-and-Continue
2437 debugging mode, where the object file in question may be recompiled and
2438 dynamically reloaded in the course of program execution, without the need
2439 to restart the program itself.  Currently, Fix-and-Continue functionality
2440 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2441 and later.
2443 @item -fzero-link
2444 @opindex fzero-link
2445 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2446 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2447 compile time) with static class references that get initialized at load time,
2448 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2449 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2450 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2451 for individual class implementations to be modified during program execution.
2453 @item -gen-decls
2454 @opindex gen-decls
2455 Dump interface declarations for all classes seen in the source file to a
2456 file named @file{@var{sourcename}.decl}.
2458 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2459 @opindex Wassign-intercept
2460 @opindex Wno-assign-intercept
2461 Warn whenever an Objective-C assignment is being intercepted by the
2462 garbage collector.
2464 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2465 @opindex Wno-protocol
2466 @opindex Wprotocol
2467 If a class is declared to implement a protocol, a warning is issued for
2468 every method in the protocol that is not implemented by the class.  The
2469 default behavior is to issue a warning for every method not explicitly
2470 implemented in the class, even if a method implementation is inherited
2471 from the superclass.  If you use the @option{-Wno-protocol} option, then
2472 methods inherited from the superclass are considered to be implemented,
2473 and no warning is issued for them.
2475 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2476 @opindex Wselector
2477 @opindex Wno-selector
2478 Warn if multiple methods of different types for the same selector are
2479 found during compilation.  The check is performed on the list of methods
2480 in the final stage of compilation.  Additionally, a check is performed
2481 for each selector appearing in a @code{@@selector(@dots{})}
2482 expression, and a corresponding method for that selector has been found
2483 during compilation.  Because these checks scan the method table only at
2484 the end of compilation, these warnings are not produced if the final
2485 stage of compilation is not reached, for example because an error is
2486 found during compilation, or because the @option{-fsyntax-only} option is
2487 being used.
2489 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2490 @opindex Wstrict-selector-match
2491 @opindex Wno-strict-selector-match
2492 Warn if multiple methods with differing argument and/or return types are
2493 found for a given selector when attempting to send a message using this
2494 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2495 is off (which is the default behavior), the compiler will omit such warnings
2496 if any differences found are confined to types which share the same size
2497 and alignment.
2499 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2500 @opindex Wundeclared-selector
2501 @opindex Wno-undeclared-selector
2502 Warn if a @code{@@selector(@dots{})} expression referring to an
2503 undeclared selector is found.  A selector is considered undeclared if no
2504 method with that name has been declared before the
2505 @code{@@selector(@dots{})} expression, either explicitly in an
2506 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2507 an @code{@@implementation} section.  This option always performs its
2508 checks as soon as a @code{@@selector(@dots{})} expression is found,
2509 while @option{-Wselector} only performs its checks in the final stage of
2510 compilation.  This also enforces the coding style convention
2511 that methods and selectors must be declared before being used.
2513 @item -print-objc-runtime-info
2514 @opindex print-objc-runtime-info
2515 Generate C header describing the largest structure that is passed by
2516 value, if any.
2518 @end table
2520 @node Language Independent Options
2521 @section Options to Control Diagnostic Messages Formatting
2522 @cindex options to control diagnostics formatting
2523 @cindex diagnostic messages
2524 @cindex message formatting
2526 Traditionally, diagnostic messages have been formatted irrespective of
2527 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2528 below can be used to control the diagnostic messages formatting
2529 algorithm, e.g.@: how many characters per line, how often source location
2530 information should be reported.  Right now, only the C++ front end can
2531 honor these options.  However it is expected, in the near future, that
2532 the remaining front ends would be able to digest them correctly.
2534 @table @gcctabopt
2535 @item -fmessage-length=@var{n}
2536 @opindex fmessage-length
2537 Try to format error messages so that they fit on lines of about @var{n}
2538 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2539 the front ends supported by GCC@.  If @var{n} is zero, then no
2540 line-wrapping will be done; each error message will appear on a single
2541 line.
2543 @opindex fdiagnostics-show-location
2544 @item -fdiagnostics-show-location=once
2545 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2546 reporter to emit @emph{once} source location information; that is, in
2547 case the message is too long to fit on a single physical line and has to
2548 be wrapped, the source location won't be emitted (as prefix) again,
2549 over and over, in subsequent continuation lines.  This is the default
2550 behavior.
2552 @item -fdiagnostics-show-location=every-line
2553 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2554 messages reporter to emit the same source location information (as
2555 prefix) for physical lines that result from the process of breaking
2556 a message which is too long to fit on a single line.
2558 @item -fdiagnostics-show-option
2559 @opindex fdiagnostics-show-option
2560 This option instructs the diagnostic machinery to add text to each
2561 diagnostic emitted, which indicates which command line option directly
2562 controls that diagnostic, when such an option is known to the
2563 diagnostic machinery.
2565 @item -Wcoverage-mismatch
2566 @opindex Wcoverage-mismatch
2567 Warn if feedback profiles do not match when using the
2568 @option{-fprofile-use} option.
2569 If a source file was changed between @option{-fprofile-gen} and
2570 @option{-fprofile-use}, the files with the profile feedback can fail
2571 to match the source file and GCC can not use the profile feedback
2572 information.  By default, GCC emits an error message in this case.
2573 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2574 error.  GCC does not use appropriate feedback profiles, so using this
2575 option can result in poorly optimized code.  This option is useful
2576 only in the case of very minor changes such as bug fixes to an
2577 existing code-base.
2579 @end table
2581 @node Warning Options
2582 @section Options to Request or Suppress Warnings
2583 @cindex options to control warnings
2584 @cindex warning messages
2585 @cindex messages, warning
2586 @cindex suppressing warnings
2588 Warnings are diagnostic messages that report constructions which
2589 are not inherently erroneous but which are risky or suggest there
2590 may have been an error.
2592 The following language-independent options do not enable specific
2593 warnings but control the kinds of diagnostics produced by GCC.
2595 @table @gcctabopt
2596 @cindex syntax checking
2597 @item -fsyntax-only
2598 @opindex fsyntax-only
2599 Check the code for syntax errors, but don't do anything beyond that.
2601 @item -w
2602 @opindex w
2603 Inhibit all warning messages.
2605 @item -Werror
2606 @opindex Werror
2607 @opindex Wno-error
2608 Make all warnings into errors.
2610 @item -Werror=
2611 @opindex Werror=
2612 @opindex Wno-error=
2613 Make the specified warning into an error.  The specifier for a warning
2614 is appended, for example @option{-Werror=switch} turns the warnings
2615 controlled by @option{-Wswitch} into errors.  This switch takes a
2616 negative form, to be used to negate @option{-Werror} for specific
2617 warnings, for example @option{-Wno-error=switch} makes
2618 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2619 is in effect.  You can use the @option{-fdiagnostics-show-option}
2620 option to have each controllable warning amended with the option which
2621 controls it, to determine what to use with this option.
2623 Note that specifying @option{-Werror=}@var{foo} automatically implies
2624 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2625 imply anything.
2627 @item -Wfatal-errors
2628 @opindex Wfatal-errors
2629 @opindex Wno-fatal-errors
2630 This option causes the compiler to abort compilation on the first error
2631 occurred rather than trying to keep going and printing further error
2632 messages.
2634 @end table
2636 You can request many specific warnings with options beginning
2637 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2638 implicit declarations.  Each of these specific warning options also
2639 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2640 example, @option{-Wno-implicit}.  This manual lists only one of the
2641 two forms, whichever is not the default.  For further,
2642 language-specific options also refer to @ref{C++ Dialect Options} and
2643 @ref{Objective-C and Objective-C++ Dialect Options}.
2645 @table @gcctabopt
2646 @item -pedantic
2647 @opindex pedantic
2648 Issue all the warnings demanded by strict ISO C and ISO C++;
2649 reject all programs that use forbidden extensions, and some other
2650 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2651 version of the ISO C standard specified by any @option{-std} option used.
2653 Valid ISO C and ISO C++ programs should compile properly with or without
2654 this option (though a rare few will require @option{-ansi} or a
2655 @option{-std} option specifying the required version of ISO C)@.  However,
2656 without this option, certain GNU extensions and traditional C and C++
2657 features are supported as well.  With this option, they are rejected.
2659 @option{-pedantic} does not cause warning messages for use of the
2660 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2661 warnings are also disabled in the expression that follows
2662 @code{__extension__}.  However, only system header files should use
2663 these escape routes; application programs should avoid them.
2664 @xref{Alternate Keywords}.
2666 Some users try to use @option{-pedantic} to check programs for strict ISO
2667 C conformance.  They soon find that it does not do quite what they want:
2668 it finds some non-ISO practices, but not all---only those for which
2669 ISO C @emph{requires} a diagnostic, and some others for which
2670 diagnostics have been added.
2672 A feature to report any failure to conform to ISO C might be useful in
2673 some instances, but would require considerable additional work and would
2674 be quite different from @option{-pedantic}.  We don't have plans to
2675 support such a feature in the near future.
2677 Where the standard specified with @option{-std} represents a GNU
2678 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2679 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2680 extended dialect is based.  Warnings from @option{-pedantic} are given
2681 where they are required by the base standard.  (It would not make sense
2682 for such warnings to be given only for features not in the specified GNU
2683 C dialect, since by definition the GNU dialects of C include all
2684 features the compiler supports with the given option, and there would be
2685 nothing to warn about.)
2687 @item -pedantic-errors
2688 @opindex pedantic-errors
2689 Like @option{-pedantic}, except that errors are produced rather than
2690 warnings.
2692 @item -Wall
2693 @opindex Wall
2694 @opindex Wno-all
2695 This enables all the warnings about constructions that some users
2696 consider questionable, and that are easy to avoid (or modify to
2697 prevent the warning), even in conjunction with macros.  This also
2698 enables some language-specific warnings described in @ref{C++ Dialect
2699 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2701 @option{-Wall} turns on the following warning flags:
2703 @gccoptlist{-Waddress   @gol
2704 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2705 -Wc++0x-compat  @gol
2706 -Wchar-subscripts  @gol
2707 -Wimplicit-int  @gol
2708 -Wimplicit-function-declaration  @gol
2709 -Wcomment  @gol
2710 -Wformat   @gol
2711 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2712 -Wmissing-braces  @gol
2713 -Wnonnull  @gol
2714 -Wparentheses  @gol
2715 -Wpointer-sign  @gol
2716 -Wreorder   @gol
2717 -Wreturn-type  @gol
2718 -Wsequence-point  @gol
2719 -Wsign-compare @r{(only in C++)}  @gol
2720 -Wstrict-aliasing  @gol
2721 -Wstrict-overflow=1  @gol
2722 -Wswitch  @gol
2723 -Wtrigraphs  @gol
2724 -Wuninitialized  @gol
2725 -Wunknown-pragmas  @gol
2726 -Wunused-function  @gol
2727 -Wunused-label     @gol
2728 -Wunused-value     @gol
2729 -Wunused-variable  @gol
2730 -Wvolatile-register-var @gol
2733 Note that some warning flags are not implied by @option{-Wall}.  Some of
2734 them warn about constructions that users generally do not consider
2735 questionable, but which occasionally you might wish to check for;
2736 others warn about constructions that are necessary or hard to avoid in
2737 some cases, and there is no simple way to modify the code to suppress
2738 the warning. Some of them are enabled by @option{-Wextra} but many of
2739 them must be enabled individually.
2741 @item -Wextra
2742 @opindex W
2743 @opindex Wextra
2744 @opindex Wno-extra
2745 This enables some extra warning flags that are not enabled by
2746 @option{-Wall}. (This option used to be called @option{-W}.  The older
2747 name is still supported, but the newer name is more descriptive.)
2749 @gccoptlist{-Wclobbered  @gol
2750 -Wempty-body  @gol
2751 -Wignored-qualifiers @gol
2752 -Wmissing-field-initializers  @gol
2753 -Wmissing-parameter-type @r{(C only)}  @gol
2754 -Wold-style-declaration @r{(C only)}  @gol
2755 -Woverride-init  @gol
2756 -Wsign-compare  @gol
2757 -Wtype-limits  @gol
2758 -Wuninitialized  @gol
2759 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2762 The option @option{-Wextra} also prints warning messages for the
2763 following cases:
2765 @itemize @bullet
2767 @item
2768 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2769 @samp{>}, or @samp{>=}.
2771 @item 
2772 (C++ only) An enumerator and a non-enumerator both appear in a
2773 conditional expression.
2775 @item 
2776 (C++ only) Ambiguous virtual bases.
2778 @item 
2779 (C++ only) Subscripting an array which has been declared @samp{register}.
2781 @item 
2782 (C++ only) Taking the address of a variable which has been declared
2783 @samp{register}.
2785 @item 
2786 (C++ only) A base class is not initialized in a derived class' copy
2787 constructor.
2789 @end itemize
2791 @item -Wchar-subscripts
2792 @opindex Wchar-subscripts
2793 @opindex Wno-char-subscripts
2794 Warn if an array subscript has type @code{char}.  This is a common cause
2795 of error, as programmers often forget that this type is signed on some
2796 machines.
2797 This warning is enabled by @option{-Wall}.
2799 @item -Wcomment
2800 @opindex Wcomment
2801 @opindex Wno-comment
2802 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2803 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2804 This warning is enabled by @option{-Wall}.
2806 @item -Wformat
2807 @opindex Wformat
2808 @opindex Wno-format
2809 @opindex ffreestanding
2810 @opindex fno-builtin
2811 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2812 the arguments supplied have types appropriate to the format string
2813 specified, and that the conversions specified in the format string make
2814 sense.  This includes standard functions, and others specified by format
2815 attributes (@pxref{Function Attributes}), in the @code{printf},
2816 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2817 not in the C standard) families (or other target-specific families).
2818 Which functions are checked without format attributes having been
2819 specified depends on the standard version selected, and such checks of
2820 functions without the attribute specified are disabled by
2821 @option{-ffreestanding} or @option{-fno-builtin}.
2823 The formats are checked against the format features supported by GNU
2824 libc version 2.2.  These include all ISO C90 and C99 features, as well
2825 as features from the Single Unix Specification and some BSD and GNU
2826 extensions.  Other library implementations may not support all these
2827 features; GCC does not support warning about features that go beyond a
2828 particular library's limitations.  However, if @option{-pedantic} is used
2829 with @option{-Wformat}, warnings will be given about format features not
2830 in the selected standard version (but not for @code{strfmon} formats,
2831 since those are not in any version of the C standard).  @xref{C Dialect
2832 Options,,Options Controlling C Dialect}.
2834 Since @option{-Wformat} also checks for null format arguments for
2835 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2837 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2838 aspects of format checking, the options @option{-Wformat-y2k},
2839 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2840 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2841 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2843 @item -Wformat-y2k
2844 @opindex Wformat-y2k
2845 @opindex Wno-format-y2k
2846 If @option{-Wformat} is specified, also warn about @code{strftime}
2847 formats which may yield only a two-digit year.
2849 @item -Wno-format-contains-nul
2850 @opindex Wno-format-contains-nul
2851 @opindex Wformat-contains-nul
2852 If @option{-Wformat} is specified, do not warn about format strings that
2853 contain NUL bytes.
2855 @item -Wno-format-extra-args
2856 @opindex Wno-format-extra-args
2857 @opindex Wformat-extra-args
2858 If @option{-Wformat} is specified, do not warn about excess arguments to a
2859 @code{printf} or @code{scanf} format function.  The C standard specifies
2860 that such arguments are ignored.
2862 Where the unused arguments lie between used arguments that are
2863 specified with @samp{$} operand number specifications, normally
2864 warnings are still given, since the implementation could not know what
2865 type to pass to @code{va_arg} to skip the unused arguments.  However,
2866 in the case of @code{scanf} formats, this option will suppress the
2867 warning if the unused arguments are all pointers, since the Single
2868 Unix Specification says that such unused arguments are allowed.
2870 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2871 @opindex Wno-format-zero-length
2872 @opindex Wformat-zero-length
2873 If @option{-Wformat} is specified, do not warn about zero-length formats.
2874 The C standard specifies that zero-length formats are allowed.
2876 @item -Wformat-nonliteral
2877 @opindex Wformat-nonliteral
2878 @opindex Wno-format-nonliteral
2879 If @option{-Wformat} is specified, also warn if the format string is not a
2880 string literal and so cannot be checked, unless the format function
2881 takes its format arguments as a @code{va_list}.
2883 @item -Wformat-security
2884 @opindex Wformat-security
2885 @opindex Wno-format-security
2886 If @option{-Wformat} is specified, also warn about uses of format
2887 functions that represent possible security problems.  At present, this
2888 warns about calls to @code{printf} and @code{scanf} functions where the
2889 format string is not a string literal and there are no format arguments,
2890 as in @code{printf (foo);}.  This may be a security hole if the format
2891 string came from untrusted input and contains @samp{%n}.  (This is
2892 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2893 in future warnings may be added to @option{-Wformat-security} that are not
2894 included in @option{-Wformat-nonliteral}.)
2896 @item -Wformat=2
2897 @opindex Wformat=2
2898 @opindex Wno-format=2
2899 Enable @option{-Wformat} plus format checks not included in
2900 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2901 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2903 @item -Wnonnull @r{(C and Objective-C only)}
2904 @opindex Wnonnull
2905 @opindex Wno-nonnull
2906 Warn about passing a null pointer for arguments marked as
2907 requiring a non-null value by the @code{nonnull} function attribute.
2909 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2910 can be disabled with the @option{-Wno-nonnull} option.
2912 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2913 @opindex Winit-self
2914 @opindex Wno-init-self
2915 Warn about uninitialized variables which are initialized with themselves.
2916 Note this option can only be used with the @option{-Wuninitialized} option.
2918 For example, GCC will warn about @code{i} being uninitialized in the
2919 following snippet only when @option{-Winit-self} has been specified:
2920 @smallexample
2921 @group
2922 int f()
2924   int i = i;
2925   return i;
2927 @end group
2928 @end smallexample
2930 @item -Wimplicit-int @r{(C and Objective-C only)}
2931 @opindex Wimplicit-int
2932 @opindex Wno-implicit-int
2933 Warn when a declaration does not specify a type.
2934 This warning is enabled by @option{-Wall}.
2936 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2937 @opindex Wimplicit-function-declaration
2938 @opindex Wno-implicit-function-declaration
2939 Give a warning whenever a function is used before being declared. In
2940 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2941 enabled by default and it is made into an error by
2942 @option{-pedantic-errors}. This warning is also enabled by
2943 @option{-Wall}.
2945 @item -Wimplicit
2946 @opindex Wimplicit
2947 @opindex Wno-implicit
2948 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2949 This warning is enabled by @option{-Wall}.
2951 @item -Wignored-qualifiers @r{(C and C++ only)}
2952 @opindex Wignored-qualifiers
2953 @opindex Wno-ignored-qualifiers
2954 Warn if the return type of a function has a type qualifier
2955 such as @code{const}.  For ISO C such a type qualifier has no effect,
2956 since the value returned by a function is not an lvalue.
2957 For C++, the warning is only emitted for scalar types or @code{void}.
2958 ISO C prohibits qualified @code{void} return types on function
2959 definitions, so such return types always receive a warning
2960 even without this option.
2962 This warning is also enabled by @option{-Wextra}.
2964 @item -Wmain
2965 @opindex Wmain
2966 @opindex Wno-main
2967 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
2968 a function with external linkage, returning int, taking either zero
2969 arguments, two, or three arguments of appropriate types.  This warning
2970 is enabled by default in C++ and is enabled by either @option{-Wall}
2971 or @option{-pedantic}.
2973 @item -Wmissing-braces
2974 @opindex Wmissing-braces
2975 @opindex Wno-missing-braces
2976 Warn if an aggregate or union initializer is not fully bracketed.  In
2977 the following example, the initializer for @samp{a} is not fully
2978 bracketed, but that for @samp{b} is fully bracketed.
2980 @smallexample
2981 int a[2][2] = @{ 0, 1, 2, 3 @};
2982 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2983 @end smallexample
2985 This warning is enabled by @option{-Wall}.
2987 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2988 @opindex Wmissing-include-dirs
2989 @opindex Wno-missing-include-dirs
2990 Warn if a user-supplied include directory does not exist.
2992 @item -Wparentheses
2993 @opindex Wparentheses
2994 @opindex Wno-parentheses
2995 Warn if parentheses are omitted in certain contexts, such
2996 as when there is an assignment in a context where a truth value
2997 is expected, or when operators are nested whose precedence people
2998 often get confused about.
3000 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3001 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3002 interpretation from that of ordinary mathematical notation.
3004 Also warn about constructions where there may be confusion to which
3005 @code{if} statement an @code{else} branch belongs.  Here is an example of
3006 such a case:
3008 @smallexample
3009 @group
3011   if (a)
3012     if (b)
3013       foo ();
3014   else
3015     bar ();
3017 @end group
3018 @end smallexample
3020 In C/C++, every @code{else} branch belongs to the innermost possible
3021 @code{if} statement, which in this example is @code{if (b)}.  This is
3022 often not what the programmer expected, as illustrated in the above
3023 example by indentation the programmer chose.  When there is the
3024 potential for this confusion, GCC will issue a warning when this flag
3025 is specified.  To eliminate the warning, add explicit braces around
3026 the innermost @code{if} statement so there is no way the @code{else}
3027 could belong to the enclosing @code{if}.  The resulting code would
3028 look like this:
3030 @smallexample
3031 @group
3033   if (a)
3034     @{
3035       if (b)
3036         foo ();
3037       else
3038         bar ();
3039     @}
3041 @end group
3042 @end smallexample
3044 This warning is enabled by @option{-Wall}.
3046 @item -Wsequence-point
3047 @opindex Wsequence-point
3048 @opindex Wno-sequence-point
3049 Warn about code that may have undefined semantics because of violations
3050 of sequence point rules in the C and C++ standards.
3052 The C and C++ standards defines the order in which expressions in a C/C++
3053 program are evaluated in terms of @dfn{sequence points}, which represent
3054 a partial ordering between the execution of parts of the program: those
3055 executed before the sequence point, and those executed after it.  These
3056 occur after the evaluation of a full expression (one which is not part
3057 of a larger expression), after the evaluation of the first operand of a
3058 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3059 function is called (but after the evaluation of its arguments and the
3060 expression denoting the called function), and in certain other places.
3061 Other than as expressed by the sequence point rules, the order of
3062 evaluation of subexpressions of an expression is not specified.  All
3063 these rules describe only a partial order rather than a total order,
3064 since, for example, if two functions are called within one expression
3065 with no sequence point between them, the order in which the functions
3066 are called is not specified.  However, the standards committee have
3067 ruled that function calls do not overlap.
3069 It is not specified when between sequence points modifications to the
3070 values of objects take effect.  Programs whose behavior depends on this
3071 have undefined behavior; the C and C++ standards specify that ``Between
3072 the previous and next sequence point an object shall have its stored
3073 value modified at most once by the evaluation of an expression.
3074 Furthermore, the prior value shall be read only to determine the value
3075 to be stored.''.  If a program breaks these rules, the results on any
3076 particular implementation are entirely unpredictable.
3078 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3079 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3080 diagnosed by this option, and it may give an occasional false positive
3081 result, but in general it has been found fairly effective at detecting
3082 this sort of problem in programs.
3084 The standard is worded confusingly, therefore there is some debate
3085 over the precise meaning of the sequence point rules in subtle cases.
3086 Links to discussions of the problem, including proposed formal
3087 definitions, may be found on the GCC readings page, at
3088 @w{@uref{http://gcc.gnu.org/readings.html}}.
3090 This warning is enabled by @option{-Wall} for C and C++.
3092 @item -Wreturn-type
3093 @opindex Wreturn-type
3094 @opindex Wno-return-type
3095 Warn whenever a function is defined with a return-type that defaults
3096 to @code{int}.  Also warn about any @code{return} statement with no
3097 return-value in a function whose return-type is not @code{void}
3098 (falling off the end of the function body is considered returning
3099 without a value), and about a @code{return} statement with a
3100 expression in a function whose return-type is @code{void}.
3102 For C++, a function without return type always produces a diagnostic
3103 message, even when @option{-Wno-return-type} is specified.  The only
3104 exceptions are @samp{main} and functions defined in system headers.
3106 This warning is enabled by @option{-Wall}.
3108 @item -Wswitch
3109 @opindex Wswitch
3110 @opindex Wno-switch
3111 Warn whenever a @code{switch} statement has an index of enumerated type
3112 and lacks a @code{case} for one or more of the named codes of that
3113 enumeration.  (The presence of a @code{default} label prevents this
3114 warning.)  @code{case} labels outside the enumeration range also
3115 provoke warnings when this option is used.
3116 This warning is enabled by @option{-Wall}.
3118 @item -Wswitch-default
3119 @opindex Wswitch-default
3120 @opindex Wno-switch-default
3121 Warn whenever a @code{switch} statement does not have a @code{default}
3122 case.
3124 @item -Wswitch-enum
3125 @opindex Wswitch-enum
3126 @opindex Wno-switch-enum
3127 Warn whenever a @code{switch} statement has an index of enumerated type
3128 and lacks a @code{case} for one or more of the named codes of that
3129 enumeration.  @code{case} labels outside the enumeration range also
3130 provoke warnings when this option is used.
3132 @item -Wsync-nand
3133 @opindex Wsync-nand
3134 @opindex Wno-sync-nand
3135 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3136 built-in functions are used.  These functions changed semantics in GCC 4.4.
3138 @item -Wtrigraphs
3139 @opindex Wtrigraphs
3140 @opindex Wno-trigraphs
3141 Warn if any trigraphs are encountered that might change the meaning of
3142 the program (trigraphs within comments are not warned about).
3143 This warning is enabled by @option{-Wall}.
3145 @item -Wunused-function
3146 @opindex Wunused-function
3147 @opindex Wno-unused-function
3148 Warn whenever a static function is declared but not defined or a
3149 non-inline static function is unused.
3150 This warning is enabled by @option{-Wall}.
3152 @item -Wunused-label
3153 @opindex Wunused-label
3154 @opindex Wno-unused-label
3155 Warn whenever a label is declared but not used.
3156 This warning is enabled by @option{-Wall}.
3158 To suppress this warning use the @samp{unused} attribute
3159 (@pxref{Variable Attributes}).
3161 @item -Wunused-parameter
3162 @opindex Wunused-parameter
3163 @opindex Wno-unused-parameter
3164 Warn whenever a function parameter is unused aside from its declaration.
3166 To suppress this warning use the @samp{unused} attribute
3167 (@pxref{Variable Attributes}).
3169 @item -Wunused-variable
3170 @opindex Wunused-variable
3171 @opindex Wno-unused-variable
3172 Warn whenever a local variable or non-constant static variable is unused
3173 aside from its declaration.
3174 This warning is enabled by @option{-Wall}.
3176 To suppress this warning use the @samp{unused} attribute
3177 (@pxref{Variable Attributes}).
3179 @item -Wunused-value
3180 @opindex Wunused-value
3181 @opindex Wno-unused-value
3182 Warn whenever a statement computes a result that is explicitly not
3183 used. To suppress this warning cast the unused expression to
3184 @samp{void}. This includes an expression-statement or the left-hand
3185 side of a comma expression that contains no side effects. For example,
3186 an expression such as @samp{x[i,j]} will cause a warning, while
3187 @samp{x[(void)i,j]} will not.
3189 This warning is enabled by @option{-Wall}.
3191 @item -Wunused
3192 @opindex Wunused
3193 @opindex Wno-unused
3194 All the above @option{-Wunused} options combined.
3196 In order to get a warning about an unused function parameter, you must
3197 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3198 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3200 @item -Wuninitialized
3201 @opindex Wuninitialized
3202 @opindex Wno-uninitialized
3203 Warn if an automatic variable is used without first being initialized
3204 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3205 warn if a non-static reference or non-static @samp{const} member
3206 appears in a class without constructors.
3208 If you want to warn about code which uses the uninitialized value of the
3209 variable in its own initializer, use the @option{-Winit-self} option.
3211 These warnings occur for individual uninitialized or clobbered
3212 elements of structure, union or array variables as well as for
3213 variables which are uninitialized or clobbered as a whole.  They do
3214 not occur for variables or elements declared @code{volatile}.  Because
3215 these warnings depend on optimization, the exact variables or elements
3216 for which there are warnings will depend on the precise optimization
3217 options and version of GCC used.
3219 Note that there may be no warning about a variable that is used only
3220 to compute a value that itself is never used, because such
3221 computations may be deleted by data flow analysis before the warnings
3222 are printed.
3224 These warnings are made optional because GCC is not smart
3225 enough to see all the reasons why the code might be correct
3226 despite appearing to have an error.  Here is one example of how
3227 this can happen:
3229 @smallexample
3230 @group
3232   int x;
3233   switch (y)
3234     @{
3235     case 1: x = 1;
3236       break;
3237     case 2: x = 4;
3238       break;
3239     case 3: x = 5;
3240     @}
3241   foo (x);
3243 @end group
3244 @end smallexample
3246 @noindent
3247 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3248 always initialized, but GCC doesn't know this.  Here is
3249 another common case:
3251 @smallexample
3253   int save_y;
3254   if (change_y) save_y = y, y = new_y;
3255   @dots{}
3256   if (change_y) y = save_y;
3258 @end smallexample
3260 @noindent
3261 This has no bug because @code{save_y} is used only if it is set.
3263 @cindex @code{longjmp} warnings
3264 This option also warns when a non-volatile automatic variable might be
3265 changed by a call to @code{longjmp}.  These warnings as well are possible
3266 only in optimizing compilation.
3268 The compiler sees only the calls to @code{setjmp}.  It cannot know
3269 where @code{longjmp} will be called; in fact, a signal handler could
3270 call it at any point in the code.  As a result, you may get a warning
3271 even when there is in fact no problem because @code{longjmp} cannot
3272 in fact be called at the place which would cause a problem.
3274 Some spurious warnings can be avoided if you declare all the functions
3275 you use that never return as @code{noreturn}.  @xref{Function
3276 Attributes}.
3278 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3280 @item -Wunknown-pragmas
3281 @opindex Wunknown-pragmas
3282 @opindex Wno-unknown-pragmas
3283 @cindex warning for unknown pragmas
3284 @cindex unknown pragmas, warning
3285 @cindex pragmas, warning of unknown
3286 Warn when a #pragma directive is encountered which is not understood by
3287 GCC@.  If this command line option is used, warnings will even be issued
3288 for unknown pragmas in system header files.  This is not the case if
3289 the warnings were only enabled by the @option{-Wall} command line option.
3291 @item -Wno-pragmas
3292 @opindex Wno-pragmas
3293 @opindex Wpragmas
3294 Do not warn about misuses of pragmas, such as incorrect parameters,
3295 invalid syntax, or conflicts between pragmas.  See also
3296 @samp{-Wunknown-pragmas}.
3298 @item -Wstrict-aliasing
3299 @opindex Wstrict-aliasing
3300 @opindex Wno-strict-aliasing
3301 This option is only active when @option{-fstrict-aliasing} is active.
3302 It warns about code which might break the strict aliasing rules that the
3303 compiler is using for optimization.  The warning does not catch all
3304 cases, but does attempt to catch the more common pitfalls.  It is
3305 included in @option{-Wall}.
3306 It is equivalent to @option{-Wstrict-aliasing=3}
3308 @item -Wstrict-aliasing=n
3309 @opindex Wstrict-aliasing=n
3310 @opindex Wno-strict-aliasing=n
3311 This option is only active when @option{-fstrict-aliasing} is active.
3312 It warns about code which might break the strict aliasing rules that the
3313 compiler is using for optimization.
3314 Higher levels correspond to higher accuracy (fewer false positives).
3315 Higher levels also correspond to more effort, similar to the way -O works.
3316 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3317 with n=3.
3319 Level 1: Most aggressive, quick, least accurate.
3320 Possibly useful when higher levels
3321 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3322 false negatives.  However, it has many false positives.
3323 Warns for all pointer conversions between possibly incompatible types, 
3324 even if never dereferenced.  Runs in the frontend only.
3326 Level 2: Aggressive, quick, not too precise.
3327 May still have many false positives (not as many as level 1 though),
3328 and few false negatives (but possibly more than level 1).
3329 Unlike level 1, it only warns when an address is taken.  Warns about
3330 incomplete types.  Runs in the frontend only.
3332 Level 3 (default for @option{-Wstrict-aliasing}): 
3333 Should have very few false positives and few false 
3334 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3335 Takes care of the common punn+dereference pattern in the frontend:
3336 @code{*(int*)&some_float}.
3337 If optimization is enabled, it also runs in the backend, where it deals 
3338 with multiple statement cases using flow-sensitive points-to information.
3339 Only warns when the converted pointer is dereferenced.
3340 Does not warn about incomplete types.
3342 @item -Wstrict-overflow
3343 @itemx -Wstrict-overflow=@var{n}
3344 @opindex Wstrict-overflow
3345 @opindex Wno-strict-overflow
3346 This option is only active when @option{-fstrict-overflow} is active.
3347 It warns about cases where the compiler optimizes based on the
3348 assumption that signed overflow does not occur.  Note that it does not
3349 warn about all cases where the code might overflow: it only warns
3350 about cases where the compiler implements some optimization.  Thus
3351 this warning depends on the optimization level.
3353 An optimization which assumes that signed overflow does not occur is
3354 perfectly safe if the values of the variables involved are such that
3355 overflow never does, in fact, occur.  Therefore this warning can
3356 easily give a false positive: a warning about code which is not
3357 actually a problem.  To help focus on important issues, several
3358 warning levels are defined.  No warnings are issued for the use of
3359 undefined signed overflow when estimating how many iterations a loop
3360 will require, in particular when determining whether a loop will be
3361 executed at all.
3363 @table @gcctabopt
3364 @item -Wstrict-overflow=1
3365 Warn about cases which are both questionable and easy to avoid.  For
3366 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3367 compiler will simplify this to @code{1}.  This level of
3368 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3369 are not, and must be explicitly requested.
3371 @item -Wstrict-overflow=2
3372 Also warn about other cases where a comparison is simplified to a
3373 constant.  For example: @code{abs (x) >= 0}.  This can only be
3374 simplified when @option{-fstrict-overflow} is in effect, because
3375 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3376 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3377 @option{-Wstrict-overflow=2}.
3379 @item -Wstrict-overflow=3
3380 Also warn about other cases where a comparison is simplified.  For
3381 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3383 @item -Wstrict-overflow=4
3384 Also warn about other simplifications not covered by the above cases.
3385 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3387 @item -Wstrict-overflow=5
3388 Also warn about cases where the compiler reduces the magnitude of a
3389 constant involved in a comparison.  For example: @code{x + 2 > y} will
3390 be simplified to @code{x + 1 >= y}.  This is reported only at the
3391 highest warning level because this simplification applies to many
3392 comparisons, so this warning level will give a very large number of
3393 false positives.
3394 @end table
3396 @item -Warray-bounds
3397 @opindex Wno-array-bounds
3398 @opindex Warray-bounds
3399 This option is only active when @option{-ftree-vrp} is active
3400 (default for -O2 and above). It warns about subscripts to arrays
3401 that are always out of bounds. This warning is enabled by @option{-Wall}.
3403 @item -Wno-div-by-zero
3404 @opindex Wno-div-by-zero
3405 @opindex Wdiv-by-zero
3406 Do not warn about compile-time integer division by zero.  Floating point
3407 division by zero is not warned about, as it can be a legitimate way of
3408 obtaining infinities and NaNs.
3410 @item -Wsystem-headers
3411 @opindex Wsystem-headers
3412 @opindex Wno-system-headers
3413 @cindex warnings from system headers
3414 @cindex system headers, warnings from
3415 Print warning messages for constructs found in system header files.
3416 Warnings from system headers are normally suppressed, on the assumption
3417 that they usually do not indicate real problems and would only make the
3418 compiler output harder to read.  Using this command line option tells
3419 GCC to emit warnings from system headers as if they occurred in user
3420 code.  However, note that using @option{-Wall} in conjunction with this
3421 option will @emph{not} warn about unknown pragmas in system
3422 headers---for that, @option{-Wunknown-pragmas} must also be used.
3424 @item -Wfloat-equal
3425 @opindex Wfloat-equal
3426 @opindex Wno-float-equal
3427 Warn if floating point values are used in equality comparisons.
3429 The idea behind this is that sometimes it is convenient (for the
3430 programmer) to consider floating-point values as approximations to
3431 infinitely precise real numbers.  If you are doing this, then you need
3432 to compute (by analyzing the code, or in some other way) the maximum or
3433 likely maximum error that the computation introduces, and allow for it
3434 when performing comparisons (and when producing output, but that's a
3435 different problem).  In particular, instead of testing for equality, you
3436 would check to see whether the two values have ranges that overlap; and
3437 this is done with the relational operators, so equality comparisons are
3438 probably mistaken.
3440 @item -Wtraditional @r{(C and Objective-C only)}
3441 @opindex Wtraditional
3442 @opindex Wno-traditional
3443 Warn about certain constructs that behave differently in traditional and
3444 ISO C@.  Also warn about ISO C constructs that have no traditional C
3445 equivalent, and/or problematic constructs which should be avoided.
3447 @itemize @bullet
3448 @item
3449 Macro parameters that appear within string literals in the macro body.
3450 In traditional C macro replacement takes place within string literals,
3451 but does not in ISO C@.
3453 @item
3454 In traditional C, some preprocessor directives did not exist.
3455 Traditional preprocessors would only consider a line to be a directive
3456 if the @samp{#} appeared in column 1 on the line.  Therefore
3457 @option{-Wtraditional} warns about directives that traditional C
3458 understands but would ignore because the @samp{#} does not appear as the
3459 first character on the line.  It also suggests you hide directives like
3460 @samp{#pragma} not understood by traditional C by indenting them.  Some
3461 traditional implementations would not recognize @samp{#elif}, so it
3462 suggests avoiding it altogether.
3464 @item
3465 A function-like macro that appears without arguments.
3467 @item
3468 The unary plus operator.
3470 @item
3471 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3472 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3473 constants.)  Note, these suffixes appear in macros defined in the system
3474 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3475 Use of these macros in user code might normally lead to spurious
3476 warnings, however GCC's integrated preprocessor has enough context to
3477 avoid warning in these cases.
3479 @item
3480 A function declared external in one block and then used after the end of
3481 the block.
3483 @item
3484 A @code{switch} statement has an operand of type @code{long}.
3486 @item
3487 A non-@code{static} function declaration follows a @code{static} one.
3488 This construct is not accepted by some traditional C compilers.
3490 @item
3491 The ISO type of an integer constant has a different width or
3492 signedness from its traditional type.  This warning is only issued if
3493 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3494 typically represent bit patterns, are not warned about.
3496 @item
3497 Usage of ISO string concatenation is detected.
3499 @item
3500 Initialization of automatic aggregates.
3502 @item
3503 Identifier conflicts with labels.  Traditional C lacks a separate
3504 namespace for labels.
3506 @item
3507 Initialization of unions.  If the initializer is zero, the warning is
3508 omitted.  This is done under the assumption that the zero initializer in
3509 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3510 initializer warnings and relies on default initialization to zero in the
3511 traditional C case.
3513 @item
3514 Conversions by prototypes between fixed/floating point values and vice
3515 versa.  The absence of these prototypes when compiling with traditional
3516 C would cause serious problems.  This is a subset of the possible
3517 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3519 @item
3520 Use of ISO C style function definitions.  This warning intentionally is
3521 @emph{not} issued for prototype declarations or variadic functions
3522 because these ISO C features will appear in your code when using
3523 libiberty's traditional C compatibility macros, @code{PARAMS} and
3524 @code{VPARAMS}.  This warning is also bypassed for nested functions
3525 because that feature is already a GCC extension and thus not relevant to
3526 traditional C compatibility.
3527 @end itemize
3529 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3530 @opindex Wtraditional-conversion
3531 @opindex Wno-traditional-conversion
3532 Warn if a prototype causes a type conversion that is different from what
3533 would happen to the same argument in the absence of a prototype.  This
3534 includes conversions of fixed point to floating and vice versa, and
3535 conversions changing the width or signedness of a fixed point argument
3536 except when the same as the default promotion.
3538 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3539 @opindex Wdeclaration-after-statement
3540 @opindex Wno-declaration-after-statement
3541 Warn when a declaration is found after a statement in a block.  This
3542 construct, known from C++, was introduced with ISO C99 and is by default
3543 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3544 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3546 @item -Wundef
3547 @opindex Wundef
3548 @opindex Wno-undef
3549 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3551 @item -Wno-endif-labels
3552 @opindex Wno-endif-labels
3553 @opindex Wendif-labels
3554 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3556 @item -Wshadow
3557 @opindex Wshadow
3558 @opindex Wno-shadow
3559 Warn whenever a local variable shadows another local variable, parameter or
3560 global variable or whenever a built-in function is shadowed.
3562 @item -Wlarger-than=@var{len}
3563 @opindex Wlarger-than=@var{len}
3564 @opindex Wlarger-than-@var{len}
3565 Warn whenever an object of larger than @var{len} bytes is defined.
3567 @item -Wframe-larger-than=@var{len}
3568 @opindex Wframe-larger-than
3569 Warn if the size of a function frame is larger than @var{len} bytes.
3570 The computation done to determine the stack frame size is approximate
3571 and not conservative.
3572 The actual requirements may be somewhat greater than @var{len}
3573 even if you do not get a warning.  In addition, any space allocated
3574 via @code{alloca}, variable-length arrays, or related constructs
3575 is not included by the compiler when determining
3576 whether or not to issue a warning.
3578 @item -Wunsafe-loop-optimizations
3579 @opindex Wunsafe-loop-optimizations
3580 @opindex Wno-unsafe-loop-optimizations
3581 Warn if the loop cannot be optimized because the compiler could not
3582 assume anything on the bounds of the loop indices.  With
3583 @option{-funsafe-loop-optimizations} warn if the compiler made
3584 such assumptions.
3586 @item -Wno-pedantic-ms-format
3587 @opindex Wno-pedantic-ms-format
3588 @opindex Wpedantic-ms-format
3589 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3590 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3591 depending on the MS runtime, when you are using the options @option{-Wformat}
3592 and @option{-pedantic} without gnu-extensions.
3594 @item -Wpointer-arith
3595 @opindex Wpointer-arith
3596 @opindex Wno-pointer-arith
3597 Warn about anything that depends on the ``size of'' a function type or
3598 of @code{void}.  GNU C assigns these types a size of 1, for
3599 convenience in calculations with @code{void *} pointers and pointers
3600 to functions.  In C++, warn also when an arithmetic operation involves
3601 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3603 @item -Wtype-limits
3604 @opindex Wtype-limits
3605 @opindex Wno-type-limits
3606 Warn if a comparison is always true or always false due to the limited
3607 range of the data type, but do not warn for constant expressions.  For
3608 example, warn if an unsigned variable is compared against zero with
3609 @samp{<} or @samp{>=}.  This warning is also enabled by
3610 @option{-Wextra}.
3612 @item -Wbad-function-cast @r{(C and Objective-C only)}
3613 @opindex Wbad-function-cast
3614 @opindex Wno-bad-function-cast
3615 Warn whenever a function call is cast to a non-matching type.
3616 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3618 @item -Wc++-compat @r{(C and Objective-C only)}
3619 Warn about ISO C constructs that are outside of the common subset of
3620 ISO C and ISO C++, e.g.@: request for implicit conversion from
3621 @code{void *} to a pointer to non-@code{void} type.
3623 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3624 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3625 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3626 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3628 @item -Wcast-qual
3629 @opindex Wcast-qual
3630 @opindex Wno-cast-qual
3631 Warn whenever a pointer is cast so as to remove a type qualifier from
3632 the target type.  For example, warn if a @code{const char *} is cast
3633 to an ordinary @code{char *}.
3635 @item -Wcast-align
3636 @opindex Wcast-align
3637 @opindex Wno-cast-align
3638 Warn whenever a pointer is cast such that the required alignment of the
3639 target is increased.  For example, warn if a @code{char *} is cast to
3640 an @code{int *} on machines where integers can only be accessed at
3641 two- or four-byte boundaries.
3643 @item -Wwrite-strings
3644 @opindex Wwrite-strings
3645 @opindex Wno-write-strings
3646 When compiling C, give string constants the type @code{const
3647 char[@var{length}]} so that copying the address of one into a
3648 non-@code{const} @code{char *} pointer will get a warning.  These
3649 warnings will help you find at compile time code that can try to write
3650 into a string constant, but only if you have been very careful about
3651 using @code{const} in declarations and prototypes.  Otherwise, it will
3652 just be a nuisance. This is why we did not make @option{-Wall} request
3653 these warnings.
3655 When compiling C++, warn about the deprecated conversion from string
3656 literals to @code{char *}.  This warning is enabled by default for C++
3657 programs.
3659 @item -Wclobbered
3660 @opindex Wclobbered
3661 @opindex Wno-clobbered
3662 Warn for variables that might be changed by @samp{longjmp} or
3663 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3665 @item -Wconversion
3666 @opindex Wconversion
3667 @opindex Wno-conversion
3668 Warn for implicit conversions that may alter a value. This includes
3669 conversions between real and integer, like @code{abs (x)} when
3670 @code{x} is @code{double}; conversions between signed and unsigned,
3671 like @code{unsigned ui = -1}; and conversions to smaller types, like
3672 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3673 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3674 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3675 conversions between signed and unsigned integers can be disabled by
3676 using @option{-Wno-sign-conversion}.
3678 For C++, also warn for conversions between @code{NULL} and non-pointer
3679 types; confusing overload resolution for user-defined conversions; and
3680 conversions that will never use a type conversion operator:
3681 conversions to @code{void}, the same type, a base class or a reference
3682 to them. Warnings about conversions between signed and unsigned
3683 integers are disabled by default in C++ unless
3684 @option{-Wsign-conversion} is explicitly enabled.
3686 @item -Wempty-body
3687 @opindex Wempty-body
3688 @opindex Wno-empty-body
3689 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3690 while} statement.  This warning is also enabled by @option{-Wextra}.
3692 @item -Wenum-compare @r{(C++ and Objective-C++ only)}
3693 @opindex Wenum-compare
3694 @opindex Wno-enum-compare
3695 Warn about a comparison between values of different enum types. This
3696 warning is enabled by default.
3698 @item -Wsign-compare
3699 @opindex Wsign-compare
3700 @opindex Wno-sign-compare
3701 @cindex warning for comparison of signed and unsigned values
3702 @cindex comparison of signed and unsigned values, warning
3703 @cindex signed and unsigned values, comparison warning
3704 Warn when a comparison between signed and unsigned values could produce
3705 an incorrect result when the signed value is converted to unsigned.
3706 This warning is also enabled by @option{-Wextra}; to get the other warnings
3707 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3709 @item -Wsign-conversion
3710 @opindex Wsign-conversion
3711 @opindex Wno-sign-conversion
3712 Warn for implicit conversions that may change the sign of an integer
3713 value, like assigning a signed integer expression to an unsigned
3714 integer variable. An explicit cast silences the warning. In C, this
3715 option is enabled also by @option{-Wconversion}.
3717 @item -Waddress
3718 @opindex Waddress
3719 @opindex Wno-address
3720 Warn about suspicious uses of memory addresses. These include using
3721 the address of a function in a conditional expression, such as
3722 @code{void func(void); if (func)}, and comparisons against the memory
3723 address of a string literal, such as @code{if (x == "abc")}.  Such
3724 uses typically indicate a programmer error: the address of a function
3725 always evaluates to true, so their use in a conditional usually
3726 indicate that the programmer forgot the parentheses in a function
3727 call; and comparisons against string literals result in unspecified
3728 behavior and are not portable in C, so they usually indicate that the
3729 programmer intended to use @code{strcmp}.  This warning is enabled by
3730 @option{-Wall}.
3732 @item -Wlogical-op
3733 @opindex Wlogical-op
3734 @opindex Wno-logical-op
3735 Warn about suspicious uses of logical operators in expressions.
3736 This includes using logical operators in contexts where a
3737 bit-wise operator is likely to be expected.
3739 @item -Waggregate-return
3740 @opindex Waggregate-return
3741 @opindex Wno-aggregate-return
3742 Warn if any functions that return structures or unions are defined or
3743 called.  (In languages where you can return an array, this also elicits
3744 a warning.)
3746 @item -Wno-attributes
3747 @opindex Wno-attributes
3748 @opindex Wattributes
3749 Do not warn if an unexpected @code{__attribute__} is used, such as
3750 unrecognized attributes, function attributes applied to variables,
3751 etc.  This will not stop errors for incorrect use of supported
3752 attributes.
3754 @item -Wno-builtin-macro-redefined
3755 @opindex Wno-builtin-macro-redefined
3756 @opindex Wbuiltin-macro-redefined
3757 Do not warn if certain built-in macros are redefined.  This suppresses
3758 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3759 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3761 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3762 @opindex Wstrict-prototypes
3763 @opindex Wno-strict-prototypes
3764 Warn if a function is declared or defined without specifying the
3765 argument types.  (An old-style function definition is permitted without
3766 a warning if preceded by a declaration which specifies the argument
3767 types.)
3769 @item -Wold-style-declaration @r{(C and Objective-C only)}
3770 @opindex Wold-style-declaration
3771 @opindex Wno-old-style-declaration
3772 Warn for obsolescent usages, according to the C Standard, in a
3773 declaration. For example, warn if storage-class specifiers like
3774 @code{static} are not the first things in a declaration.  This warning
3775 is also enabled by @option{-Wextra}.
3777 @item -Wold-style-definition @r{(C and Objective-C only)}
3778 @opindex Wold-style-definition
3779 @opindex Wno-old-style-definition
3780 Warn if an old-style function definition is used.  A warning is given
3781 even if there is a previous prototype.
3783 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3784 @opindex Wmissing-parameter-type
3785 @opindex Wno-missing-parameter-type
3786 A function parameter is declared without a type specifier in K&R-style
3787 functions:
3789 @smallexample
3790 void foo(bar) @{ @}
3791 @end smallexample
3793 This warning is also enabled by @option{-Wextra}.
3795 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3796 @opindex Wmissing-prototypes
3797 @opindex Wno-missing-prototypes
3798 Warn if a global function is defined without a previous prototype
3799 declaration.  This warning is issued even if the definition itself
3800 provides a prototype.  The aim is to detect global functions that fail
3801 to be declared in header files.
3803 @item -Wmissing-declarations
3804 @opindex Wmissing-declarations
3805 @opindex Wno-missing-declarations
3806 Warn if a global function is defined without a previous declaration.
3807 Do so even if the definition itself provides a prototype.
3808 Use this option to detect global functions that are not declared in
3809 header files.  In C++, no warnings are issued for function templates,
3810 or for inline functions, or for functions in anonymous namespaces.
3812 @item -Wmissing-field-initializers
3813 @opindex Wmissing-field-initializers
3814 @opindex Wno-missing-field-initializers
3815 @opindex W
3816 @opindex Wextra
3817 @opindex Wno-extra
3818 Warn if a structure's initializer has some fields missing.  For
3819 example, the following code would cause such a warning, because
3820 @code{x.h} is implicitly zero:
3822 @smallexample
3823 struct s @{ int f, g, h; @};
3824 struct s x = @{ 3, 4 @};
3825 @end smallexample
3827 This option does not warn about designated initializers, so the following
3828 modification would not trigger a warning:
3830 @smallexample
3831 struct s @{ int f, g, h; @};
3832 struct s x = @{ .f = 3, .g = 4 @};
3833 @end smallexample
3835 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3836 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3838 @item -Wmissing-noreturn
3839 @opindex Wmissing-noreturn
3840 @opindex Wno-missing-noreturn
3841 Warn about functions which might be candidates for attribute @code{noreturn}.
3842 Note these are only possible candidates, not absolute ones.  Care should
3843 be taken to manually verify functions actually do not ever return before
3844 adding the @code{noreturn} attribute, otherwise subtle code generation
3845 bugs could be introduced.  You will not get a warning for @code{main} in
3846 hosted C environments.
3848 @item -Wmissing-format-attribute
3849 @opindex Wmissing-format-attribute
3850 @opindex Wno-missing-format-attribute
3851 @opindex Wformat
3852 @opindex Wno-format
3853 Warn about function pointers which might be candidates for @code{format}
3854 attributes.  Note these are only possible candidates, not absolute ones.
3855 GCC will guess that function pointers with @code{format} attributes that
3856 are used in assignment, initialization, parameter passing or return
3857 statements should have a corresponding @code{format} attribute in the
3858 resulting type.  I.e.@: the left-hand side of the assignment or
3859 initialization, the type of the parameter variable, or the return type
3860 of the containing function respectively should also have a @code{format}
3861 attribute to avoid the warning.
3863 GCC will also warn about function definitions which might be
3864 candidates for @code{format} attributes.  Again, these are only
3865 possible candidates.  GCC will guess that @code{format} attributes
3866 might be appropriate for any function that calls a function like
3867 @code{vprintf} or @code{vscanf}, but this might not always be the
3868 case, and some functions for which @code{format} attributes are
3869 appropriate may not be detected.
3871 @item -Wno-multichar
3872 @opindex Wno-multichar
3873 @opindex Wmultichar
3874 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3875 Usually they indicate a typo in the user's code, as they have
3876 implementation-defined values, and should not be used in portable code.
3878 @item -Wnormalized=<none|id|nfc|nfkc>
3879 @opindex Wnormalized=
3880 @cindex NFC
3881 @cindex NFKC
3882 @cindex character set, input normalization
3883 In ISO C and ISO C++, two identifiers are different if they are
3884 different sequences of characters.  However, sometimes when characters
3885 outside the basic ASCII character set are used, you can have two
3886 different character sequences that look the same.  To avoid confusion,
3887 the ISO 10646 standard sets out some @dfn{normalization rules} which
3888 when applied ensure that two sequences that look the same are turned into
3889 the same sequence.  GCC can warn you if you are using identifiers which
3890 have not been normalized; this option controls that warning.
3892 There are four levels of warning that GCC supports.  The default is
3893 @option{-Wnormalized=nfc}, which warns about any identifier which is
3894 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3895 recommended form for most uses.
3897 Unfortunately, there are some characters which ISO C and ISO C++ allow
3898 in identifiers that when turned into NFC aren't allowable as
3899 identifiers.  That is, there's no way to use these symbols in portable
3900 ISO C or C++ and have all your identifiers in NFC@.
3901 @option{-Wnormalized=id} suppresses the warning for these characters.
3902 It is hoped that future versions of the standards involved will correct
3903 this, which is why this option is not the default.
3905 You can switch the warning off for all characters by writing
3906 @option{-Wnormalized=none}.  You would only want to do this if you
3907 were using some other normalization scheme (like ``D''), because
3908 otherwise you can easily create bugs that are literally impossible to see.
3910 Some characters in ISO 10646 have distinct meanings but look identical
3911 in some fonts or display methodologies, especially once formatting has
3912 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3913 LETTER N'', will display just like a regular @code{n} which has been
3914 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3915 normalization scheme to convert all these into a standard form as
3916 well, and GCC will warn if your code is not in NFKC if you use
3917 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3918 about every identifier that contains the letter O because it might be
3919 confused with the digit 0, and so is not the default, but may be
3920 useful as a local coding convention if the programming environment is
3921 unable to be fixed to display these characters distinctly.
3923 @item -Wno-deprecated
3924 @opindex Wno-deprecated
3925 @opindex Wdeprecated
3926 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3928 @item -Wno-deprecated-declarations
3929 @opindex Wno-deprecated-declarations
3930 @opindex Wdeprecated-declarations
3931 Do not warn about uses of functions (@pxref{Function Attributes}),
3932 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3933 Attributes}) marked as deprecated by using the @code{deprecated}
3934 attribute.
3936 @item -Wno-overflow
3937 @opindex Wno-overflow
3938 @opindex Woverflow
3939 Do not warn about compile-time overflow in constant expressions.
3941 @item -Woverride-init @r{(C and Objective-C only)}
3942 @opindex Woverride-init
3943 @opindex Wno-override-init
3944 @opindex W
3945 @opindex Wextra
3946 @opindex Wno-extra
3947 Warn if an initialized field without side effects is overridden when
3948 using designated initializers (@pxref{Designated Inits, , Designated
3949 Initializers}).
3951 This warning is included in @option{-Wextra}.  To get other
3952 @option{-Wextra} warnings without this one, use @samp{-Wextra
3953 -Wno-override-init}.
3955 @item -Wpacked
3956 @opindex Wpacked
3957 @opindex Wno-packed
3958 Warn if a structure is given the packed attribute, but the packed
3959 attribute has no effect on the layout or size of the structure.
3960 Such structures may be mis-aligned for little benefit.  For
3961 instance, in this code, the variable @code{f.x} in @code{struct bar}
3962 will be misaligned even though @code{struct bar} does not itself
3963 have the packed attribute:
3965 @smallexample
3966 @group
3967 struct foo @{
3968   int x;
3969   char a, b, c, d;
3970 @} __attribute__((packed));
3971 struct bar @{
3972   char z;
3973   struct foo f;
3975 @end group
3976 @end smallexample
3978 @item -Wpacked-bitfield-compat
3979 @opindex Wpacked-bitfield-compat
3980 @opindex Wno-packed-bitfield-compat
3981 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
3982 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
3983 the change can lead to differences in the structure layout.  GCC
3984 informs you when the offset of such a field has changed in GCC 4.4.
3985 For example there is no longer a 4-bit padding between field @code{a}
3986 and @code{b} in this structure:
3988 @smallexample
3989 struct foo
3991   char a:4;
3992   char b:8;
3993 @} __attribute__ ((packed));
3994 @end smallexample
3996 This warning is enabled by default.  Use
3997 @option{-Wno-packed-bitfield-compat} to disable this warning.
3999 @item -Wpadded
4000 @opindex Wpadded
4001 @opindex Wno-padded
4002 Warn if padding is included in a structure, either to align an element
4003 of the structure or to align the whole structure.  Sometimes when this
4004 happens it is possible to rearrange the fields of the structure to
4005 reduce the padding and so make the structure smaller.
4007 @item -Wredundant-decls
4008 @opindex Wredundant-decls
4009 @opindex Wno-redundant-decls
4010 Warn if anything is declared more than once in the same scope, even in
4011 cases where multiple declaration is valid and changes nothing.
4013 @item -Wnested-externs @r{(C and Objective-C only)}
4014 @opindex Wnested-externs
4015 @opindex Wno-nested-externs
4016 Warn if an @code{extern} declaration is encountered within a function.
4018 @item -Wunreachable-code
4019 @opindex Wunreachable-code
4020 @opindex Wno-unreachable-code
4021 Warn if the compiler detects that code will never be executed.
4023 This option is intended to warn when the compiler detects that at
4024 least a whole line of source code will never be executed, because
4025 some condition is never satisfied or because it is after a
4026 procedure that never returns.
4028 It is possible for this option to produce a warning even though there
4029 are circumstances under which part of the affected line can be executed,
4030 so care should be taken when removing apparently-unreachable code.
4032 For instance, when a function is inlined, a warning may mean that the
4033 line is unreachable in only one inlined copy of the function.
4035 This option is not made part of @option{-Wall} because in a debugging
4036 version of a program there is often substantial code which checks
4037 correct functioning of the program and is, hopefully, unreachable
4038 because the program does work.  Another common use of unreachable
4039 code is to provide behavior which is selectable at compile-time.
4041 @item -Winline
4042 @opindex Winline
4043 @opindex Wno-inline
4044 Warn if a function can not be inlined and it was declared as inline.
4045 Even with this option, the compiler will not warn about failures to
4046 inline functions declared in system headers.
4048 The compiler uses a variety of heuristics to determine whether or not
4049 to inline a function.  For example, the compiler takes into account
4050 the size of the function being inlined and the amount of inlining
4051 that has already been done in the current function.  Therefore,
4052 seemingly insignificant changes in the source program can cause the
4053 warnings produced by @option{-Winline} to appear or disappear.
4055 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4056 @opindex Wno-invalid-offsetof
4057 @opindex Winvalid-offsetof
4058 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4059 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4060 to a non-POD type is undefined.  In existing C++ implementations,
4061 however, @samp{offsetof} typically gives meaningful results even when
4062 applied to certain kinds of non-POD types. (Such as a simple
4063 @samp{struct} that fails to be a POD type only by virtue of having a
4064 constructor.)  This flag is for users who are aware that they are
4065 writing nonportable code and who have deliberately chosen to ignore the
4066 warning about it.
4068 The restrictions on @samp{offsetof} may be relaxed in a future version
4069 of the C++ standard.
4071 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4072 @opindex Wno-int-to-pointer-cast
4073 @opindex Wint-to-pointer-cast
4074 Suppress warnings from casts to pointer type of an integer of a
4075 different size.
4077 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4078 @opindex Wno-pointer-to-int-cast
4079 @opindex Wpointer-to-int-cast
4080 Suppress warnings from casts from a pointer to an integer type of a
4081 different size.
4083 @item -Winvalid-pch
4084 @opindex Winvalid-pch
4085 @opindex Wno-invalid-pch
4086 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4087 the search path but can't be used.
4089 @item -Wlong-long
4090 @opindex Wlong-long
4091 @opindex Wno-long-long
4092 Warn if @samp{long long} type is used.  This is default.  To inhibit
4093 the warning messages, use @option{-Wno-long-long}.  Flags
4094 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4095 only when @option{-pedantic} flag is used.
4097 @item -Wvariadic-macros
4098 @opindex Wvariadic-macros
4099 @opindex Wno-variadic-macros
4100 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4101 alternate syntax when in pedantic ISO C99 mode.  This is default.
4102 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4104 @item -Wvla
4105 @opindex Wvla
4106 @opindex Wno-vla
4107 Warn if variable length array is used in the code.
4108 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4109 the variable length array.
4111 @item -Wvolatile-register-var
4112 @opindex Wvolatile-register-var
4113 @opindex Wno-volatile-register-var
4114 Warn if a register variable is declared volatile.  The volatile
4115 modifier does not inhibit all optimizations that may eliminate reads
4116 and/or writes to register variables.  This warning is enabled by
4117 @option{-Wall}.
4119 @item -Wdisabled-optimization
4120 @opindex Wdisabled-optimization
4121 @opindex Wno-disabled-optimization
4122 Warn if a requested optimization pass is disabled.  This warning does
4123 not generally indicate that there is anything wrong with your code; it
4124 merely indicates that GCC's optimizers were unable to handle the code
4125 effectively.  Often, the problem is that your code is too big or too
4126 complex; GCC will refuse to optimize programs when the optimization
4127 itself is likely to take inordinate amounts of time.
4129 @item -Wpointer-sign @r{(C and Objective-C only)}
4130 @opindex Wpointer-sign
4131 @opindex Wno-pointer-sign
4132 Warn for pointer argument passing or assignment with different signedness.
4133 This option is only supported for C and Objective-C@.  It is implied by
4134 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4135 @option{-Wno-pointer-sign}.
4137 @item -Wstack-protector
4138 @opindex Wstack-protector
4139 @opindex Wno-stack-protector
4140 This option is only active when @option{-fstack-protector} is active.  It
4141 warns about functions that will not be protected against stack smashing.
4143 @item -Wno-mudflap
4144 @opindex Wno-mudflap
4145 Suppress warnings about constructs that cannot be instrumented by
4146 @option{-fmudflap}.
4148 @item -Woverlength-strings
4149 @opindex Woverlength-strings
4150 @opindex Wno-overlength-strings
4151 Warn about string constants which are longer than the ``minimum
4152 maximum'' length specified in the C standard.  Modern compilers
4153 generally allow string constants which are much longer than the
4154 standard's minimum limit, but very portable programs should avoid
4155 using longer strings.
4157 The limit applies @emph{after} string constant concatenation, and does
4158 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4159 C99, it was raised to 4095.  C++98 does not specify a normative
4160 minimum maximum, so we do not diagnose overlength strings in C++@.
4162 This option is implied by @option{-pedantic}, and can be disabled with
4163 @option{-Wno-overlength-strings}.
4165 @item -Wdisallowed-function-list=@var{sym},@var{sym},@dots{}
4166 @opindex Wdisallowed-function-list
4168 If any of @var{sym} is called, GCC will issue a warning. This can be useful
4169 in enforcing coding conventions that ban calls to certain functions, for
4170 example, @code{alloca}, @code{malloc}, etc.
4171 @end table
4173 @node Debugging Options
4174 @section Options for Debugging Your Program or GCC
4175 @cindex options, debugging
4176 @cindex debugging information options
4178 GCC has various special options that are used for debugging
4179 either your program or GCC:
4181 @table @gcctabopt
4182 @item -g
4183 @opindex g
4184 Produce debugging information in the operating system's native format
4185 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4186 information.
4188 On most systems that use stabs format, @option{-g} enables use of extra
4189 debugging information that only GDB can use; this extra information
4190 makes debugging work better in GDB but will probably make other debuggers
4191 crash or
4192 refuse to read the program.  If you want to control for certain whether
4193 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4194 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4196 GCC allows you to use @option{-g} with
4197 @option{-O}.  The shortcuts taken by optimized code may occasionally
4198 produce surprising results: some variables you declared may not exist
4199 at all; flow of control may briefly move where you did not expect it;
4200 some statements may not be executed because they compute constant
4201 results or their values were already at hand; some statements may
4202 execute in different places because they were moved out of loops.
4204 Nevertheless it proves possible to debug optimized output.  This makes
4205 it reasonable to use the optimizer for programs that might have bugs.
4207 The following options are useful when GCC is generated with the
4208 capability for more than one debugging format.
4210 @item -ggdb
4211 @opindex ggdb
4212 Produce debugging information for use by GDB@.  This means to use the
4213 most expressive format available (DWARF 2, stabs, or the native format
4214 if neither of those are supported), including GDB extensions if at all
4215 possible.
4217 @item -gstabs
4218 @opindex gstabs
4219 Produce debugging information in stabs format (if that is supported),
4220 without GDB extensions.  This is the format used by DBX on most BSD
4221 systems.  On MIPS, Alpha and System V Release 4 systems this option
4222 produces stabs debugging output which is not understood by DBX or SDB@.
4223 On System V Release 4 systems this option requires the GNU assembler.
4225 @item -feliminate-unused-debug-symbols
4226 @opindex feliminate-unused-debug-symbols
4227 Produce debugging information in stabs format (if that is supported),
4228 for only symbols that are actually used.
4230 @item -femit-class-debug-always
4231 Instead of emitting debugging information for a C++ class in only one
4232 object file, emit it in all object files using the class.  This option
4233 should be used only with debuggers that are unable to handle the way GCC
4234 normally emits debugging information for classes because using this
4235 option will increase the size of debugging information by as much as a
4236 factor of two.
4238 @item -gstabs+
4239 @opindex gstabs+
4240 Produce debugging information in stabs format (if that is supported),
4241 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4242 use of these extensions is likely to make other debuggers crash or
4243 refuse to read the program.
4245 @item -gcoff
4246 @opindex gcoff
4247 Produce debugging information in COFF format (if that is supported).
4248 This is the format used by SDB on most System V systems prior to
4249 System V Release 4.
4251 @item -gxcoff
4252 @opindex gxcoff
4253 Produce debugging information in XCOFF format (if that is supported).
4254 This is the format used by the DBX debugger on IBM RS/6000 systems.
4256 @item -gxcoff+
4257 @opindex gxcoff+
4258 Produce debugging information in XCOFF format (if that is supported),
4259 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4260 use of these extensions is likely to make other debuggers crash or
4261 refuse to read the program, and may cause assemblers other than the GNU
4262 assembler (GAS) to fail with an error.
4264 @item -gdwarf-2
4265 @opindex gdwarf-2
4266 Produce debugging information in DWARF version 2 format (if that is
4267 supported).  This is the format used by DBX on IRIX 6.  With this
4268 option, GCC uses features of DWARF version 3 when they are useful;
4269 version 3 is upward compatible with version 2, but may still cause
4270 problems for older debuggers.
4272 @item -gvms
4273 @opindex gvms
4274 Produce debugging information in VMS debug format (if that is
4275 supported).  This is the format used by DEBUG on VMS systems.
4277 @item -g@var{level}
4278 @itemx -ggdb@var{level}
4279 @itemx -gstabs@var{level}
4280 @itemx -gcoff@var{level}
4281 @itemx -gxcoff@var{level}
4282 @itemx -gvms@var{level}
4283 Request debugging information and also use @var{level} to specify how
4284 much information.  The default level is 2.
4286 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4287 @option{-g}.
4289 Level 1 produces minimal information, enough for making backtraces in
4290 parts of the program that you don't plan to debug.  This includes
4291 descriptions of functions and external variables, but no information
4292 about local variables and no line numbers.
4294 Level 3 includes extra information, such as all the macro definitions
4295 present in the program.  Some debuggers support macro expansion when
4296 you use @option{-g3}.
4298 @option{-gdwarf-2} does not accept a concatenated debug level, because
4299 GCC used to support an option @option{-gdwarf} that meant to generate
4300 debug information in version 1 of the DWARF format (which is very
4301 different from version 2), and it would have been too confusing.  That
4302 debug format is long obsolete, but the option cannot be changed now.
4303 Instead use an additional @option{-g@var{level}} option to change the
4304 debug level for DWARF2.
4306 @item -feliminate-dwarf2-dups
4307 @opindex feliminate-dwarf2-dups
4308 Compress DWARF2 debugging information by eliminating duplicated
4309 information about each symbol.  This option only makes sense when
4310 generating DWARF2 debugging information with @option{-gdwarf-2}.
4312 @item -femit-struct-debug-baseonly
4313 Emit debug information for struct-like types
4314 only when the base name of the compilation source file
4315 matches the base name of file in which the struct was defined.
4317 This option substantially reduces the size of debugging information,
4318 but at significant potential loss in type information to the debugger.
4319 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4320 See @option{-femit-struct-debug-detailed} for more detailed control.
4322 This option works only with DWARF 2.
4324 @item -femit-struct-debug-reduced
4325 Emit debug information for struct-like types
4326 only when the base name of the compilation source file
4327 matches the base name of file in which the type was defined,
4328 unless the struct is a template or defined in a system header.
4330 This option significantly reduces the size of debugging information,
4331 with some potential loss in type information to the debugger.
4332 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4333 See @option{-femit-struct-debug-detailed} for more detailed control.
4335 This option works only with DWARF 2.
4337 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4338 Specify the struct-like types
4339 for which the compiler will generate debug information.
4340 The intent is to reduce duplicate struct debug information
4341 between different object files within the same program.
4343 This option is a detailed version of
4344 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4345 which will serve for most needs.
4347 A specification has the syntax
4348 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4350 The optional first word limits the specification to
4351 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4352 A struct type is used directly when it is the type of a variable, member.
4353 Indirect uses arise through pointers to structs.
4354 That is, when use of an incomplete struct would be legal, the use is indirect.
4355 An example is
4356 @samp{struct one direct; struct two * indirect;}.
4358 The optional second word limits the specification to
4359 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4360 Generic structs are a bit complicated to explain.
4361 For C++, these are non-explicit specializations of template classes,
4362 or non-template classes within the above.
4363 Other programming languages have generics,
4364 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4366 The third word specifies the source files for those
4367 structs for which the compiler will emit debug information.
4368 The values @samp{none} and @samp{any} have the normal meaning.
4369 The value @samp{base} means that
4370 the base of name of the file in which the type declaration appears
4371 must match the base of the name of the main compilation file.
4372 In practice, this means that
4373 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4374 but types declared in other header will not.
4375 The value @samp{sys} means those types satisfying @samp{base}
4376 or declared in system or compiler headers.
4378 You may need to experiment to determine the best settings for your application.
4380 The default is @samp{-femit-struct-debug-detailed=all}.
4382 This option works only with DWARF 2.
4384 @item -fno-merge-debug-strings
4385 @opindex fmerge-debug-strings
4386 @opindex fno-merge-debug-strings
4387 Direct the linker to merge together strings which are identical in
4388 different object files.  This is not supported by all assemblers or
4389 linker.  This decreases the size of the debug information in the
4390 output file at the cost of increasing link processing time.  This is
4391 on by default.
4393 @item -fdebug-prefix-map=@var{old}=@var{new}
4394 @opindex fdebug-prefix-map
4395 When compiling files in directory @file{@var{old}}, record debugging
4396 information describing them as in @file{@var{new}} instead.
4398 @item -fno-dwarf2-cfi-asm
4399 @opindex fdwarf2-cfi-asm
4400 @opindex fno-dwarf2-cfi-asm
4401 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4402 instead of using GAS @code{.cfi_*} directives.
4404 @cindex @command{prof}
4405 @item -p
4406 @opindex p
4407 Generate extra code to write profile information suitable for the
4408 analysis program @command{prof}.  You must use this option when compiling
4409 the source files you want data about, and you must also use it when
4410 linking.
4412 @cindex @command{gprof}
4413 @item -pg
4414 @opindex pg
4415 Generate extra code to write profile information suitable for the
4416 analysis program @command{gprof}.  You must use this option when compiling
4417 the source files you want data about, and you must also use it when
4418 linking.
4420 @item -Q
4421 @opindex Q
4422 Makes the compiler print out each function name as it is compiled, and
4423 print some statistics about each pass when it finishes.
4425 @item -ftime-report
4426 @opindex ftime-report
4427 Makes the compiler print some statistics about the time consumed by each
4428 pass when it finishes.
4430 @item -fmem-report
4431 @opindex fmem-report
4432 Makes the compiler print some statistics about permanent memory
4433 allocation when it finishes.
4435 @item -fpre-ipa-mem-report
4436 @opindex fpre-ipa-mem-report
4437 @item -fpost-ipa-mem-report
4438 @opindex fpost-ipa-mem-report
4439 Makes the compiler print some statistics about permanent memory
4440 allocation before or after interprocedural optimization.
4442 @item -fprofile-arcs
4443 @opindex fprofile-arcs
4444 Add code so that program flow @dfn{arcs} are instrumented.  During
4445 execution the program records how many times each branch and call is
4446 executed and how many times it is taken or returns.  When the compiled
4447 program exits it saves this data to a file called
4448 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4449 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4450 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4451 @var{auxname} is generated from the name of the output file, if
4452 explicitly specified and it is not the final executable, otherwise it is
4453 the basename of the source file.  In both cases any suffix is removed
4454 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4455 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4456 @xref{Cross-profiling}.
4458 @cindex @command{gcov}
4459 @item --coverage
4460 @opindex coverage
4462 This option is used to compile and link code instrumented for coverage
4463 analysis.  The option is a synonym for @option{-fprofile-arcs}
4464 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4465 linking).  See the documentation for those options for more details.
4467 @itemize
4469 @item
4470 Compile the source files with @option{-fprofile-arcs} plus optimization
4471 and code generation options.  For test coverage analysis, use the
4472 additional @option{-ftest-coverage} option.  You do not need to profile
4473 every source file in a program.
4475 @item
4476 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4477 (the latter implies the former).
4479 @item
4480 Run the program on a representative workload to generate the arc profile
4481 information.  This may be repeated any number of times.  You can run
4482 concurrent instances of your program, and provided that the file system
4483 supports locking, the data files will be correctly updated.  Also
4484 @code{fork} calls are detected and correctly handled (double counting
4485 will not happen).
4487 @item
4488 For profile-directed optimizations, compile the source files again with
4489 the same optimization and code generation options plus
4490 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4491 Control Optimization}).
4493 @item
4494 For test coverage analysis, use @command{gcov} to produce human readable
4495 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4496 @command{gcov} documentation for further information.
4498 @end itemize
4500 With @option{-fprofile-arcs}, for each function of your program GCC
4501 creates a program flow graph, then finds a spanning tree for the graph.
4502 Only arcs that are not on the spanning tree have to be instrumented: the
4503 compiler adds code to count the number of times that these arcs are
4504 executed.  When an arc is the only exit or only entrance to a block, the
4505 instrumentation code can be added to the block; otherwise, a new basic
4506 block must be created to hold the instrumentation code.
4508 @need 2000
4509 @item -ftest-coverage
4510 @opindex ftest-coverage
4511 Produce a notes file that the @command{gcov} code-coverage utility
4512 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4513 show program coverage.  Each source file's note file is called
4514 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4515 above for a description of @var{auxname} and instructions on how to
4516 generate test coverage data.  Coverage data will match the source files
4517 more closely, if you do not optimize.
4519 @item -fdbg-cnt-list
4520 @opindex fdbg-cnt-list
4521 Print the name and the counter upperbound for all debug counters.
4523 @item -fdbg-cnt=@var{counter-value-list}
4524 @opindex fdbg-cnt
4525 Set the internal debug counter upperbound. @var{counter-value-list} 
4526 is a comma-separated list of @var{name}:@var{value} pairs
4527 which sets the upperbound of each debug counter @var{name} to @var{value}.
4528 All debug counters have the initial upperbound of @var{UINT_MAX},
4529 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4530 e.g. With -fdbg-cnt=dce:10,tail_call:0
4531 dbg_cnt(dce) will return true only for first 10 invocations
4532 and dbg_cnt(tail_call) will return false always.
4534 @item -d@var{letters}
4535 @itemx -fdump-rtl-@var{pass}
4536 @opindex d
4537 Says to make debugging dumps during compilation at times specified by
4538 @var{letters}.    This is used for debugging the RTL-based passes of the
4539 compiler.  The file names for most of the dumps are made by appending a
4540 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4541 from the name of the output file, if explicitly specified and it is not
4542 an executable, otherwise it is the basename of the source file. These
4543 switches may have different effects when @option{-E} is used for
4544 preprocessing.
4546 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4547 @option{-d} option @var{letters}.  Here are the possible
4548 letters for use in @var{pass} and @var{letters}, and their meanings:
4550 @table @gcctabopt
4552 @item -fdump-rtl-alignments
4553 @opindex fdump-rtl-alignments
4554 Dump after branch alignments have been computed.
4556 @item -fdump-rtl-asmcons
4557 @opindex fdump-rtl-asmcons
4558 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4560 @item -fdump-rtl-auto_inc_dec
4561 @opindex fdump-rtl-auto_inc_dec
4562 Dump after auto-inc-dec discovery.  This pass is only run on
4563 architectures that have auto inc or auto dec instructions.
4565 @item -fdump-rtl-barriers
4566 @opindex fdump-rtl-barriers
4567 Dump after cleaning up the barrier instructions.
4569 @item -fdump-rtl-bbpart
4570 @opindex fdump-rtl-bbpart
4571 Dump after partitioning hot and cold basic blocks.
4573 @item -fdump-rtl-bbro
4574 @opindex fdump-rtl-bbro
4575 Dump after block reordering.
4577 @item -fdump-rtl-btl1
4578 @itemx -fdump-rtl-btl2
4579 @opindex fdump-rtl-btl2
4580 @opindex fdump-rtl-btl2
4581 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4582 after the two branch
4583 target load optimization passes.
4585 @item -fdump-rtl-bypass
4586 @opindex fdump-rtl-bypass
4587 Dump after jump bypassing and control flow optimizations.
4589 @item -fdump-rtl-combine
4590 @opindex fdump-rtl-combine
4591 Dump after the RTL instruction combination pass.
4593 @item -fdump-rtl-compgotos
4594 @opindex fdump-rtl-compgotos
4595 Dump after dumplicating the computed gotos.
4597 @item -fdump-rtl-ce1
4598 @itemx -fdump-rtl-ce2
4599 @itemx -fdump-rtl-ce3
4600 @opindex fdump-rtl-ce1
4601 @opindex fdump-rtl-ce2
4602 @opindex fdump-rtl-ce3
4603 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4604 @option{-fdump-rtl-ce3} enable dumping after the three
4605 if conversion passes. 
4607 @itemx -fdump-rtl-cprop_hardreg
4608 @opindex fdump-rtl-cprop_hardreg
4609 Dump after hard register copy propagation.
4611 @itemx -fdump-rtl-csa
4612 @opindex fdump-rtl-csa
4613 Dump after combining stack adjustments.
4615 @item -fdump-rtl-cse1
4616 @itemx -fdump-rtl-cse2
4617 @opindex fdump-rtl-cse1
4618 @opindex fdump-rtl-cse2
4619 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4620 the two common sub-expression elimination passes.
4622 @itemx -fdump-rtl-dce
4623 @opindex fdump-rtl-dce
4624 Dump after the standalone dead code elimination passes.
4626 @itemx -fdump-rtl-dbr
4627 @opindex fdump-rtl-dbr
4628 Dump after delayed branch scheduling.
4630 @item -fdump-rtl-dce1
4631 @itemx -fdump-rtl-dce2
4632 @opindex fdump-rtl-dce1
4633 @opindex fdump-rtl-dce2
4634 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4635 the two dead store elimination passes.
4637 @item -fdump-rtl-eh
4638 @opindex fdump-rtl-eh
4639 Dump after finalization of EH handling code.
4641 @item -fdump-rtl-eh_ranges
4642 @opindex fdump-rtl-eh_ranges
4643 Dump after conversion of EH handling range regions.
4645 @item -fdump-rtl-expand
4646 @opindex fdump-rtl-expand
4647 Dump after RTL generation.
4649 @item -fdump-rtl-fwprop1
4650 @itemx -fdump-rtl-fwprop2
4651 @opindex fdump-rtl-fwprop1
4652 @opindex fdump-rtl-fwprop2
4653 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4654 dumping after the two forward propagation passes.
4656 @item -fdump-rtl-gcse1
4657 @itemx -fdump-rtl-gcse2
4658 @opindex fdump-rtl-gcse1
4659 @opindex fdump-rtl-gcse2
4660 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4661 after global common subexpression elimination.
4663 @item -fdump-rtl-init-regs
4664 @opindex fdump-rtl-init-regs
4665 Dump after the initialization of the registers.
4667 @item -fdump-rtl-initvals
4668 @opindex fdump-rtl-initvals
4669 Dump after the computation of the initial value sets.
4671 @itemx -fdump-rtl-into_cfglayout
4672 @opindex fdump-rtl-into_cfglayout
4673 Dump after converting to cfglayout mode.
4675 @item -fdump-rtl-ira
4676 @opindex fdump-rtl-ira
4677 Dump after iterated register allocation.
4679 @item -fdump-rtl-jump
4680 @opindex fdump-rtl-jump
4681 Dump after the second jump optimization.
4683 @item -fdump-rtl-loop2
4684 @opindex fdump-rtl-loop2
4685 @option{-fdump-rtl-loop2} enables dumping after the rtl
4686 loop optimization passes.
4688 @item -fdump-rtl-mach
4689 @opindex fdump-rtl-mach
4690 Dump after performing the machine dependent reorganization pass, if that
4691 pass exists.
4693 @item -fdump-rtl-mode_sw
4694 @opindex fdump-rtl-mode_sw
4695 Dump after removing redundant mode switches.
4697 @item -fdump-rtl-rnreg
4698 @opindex fdump-rtl-rnreg
4699 Dump after register renumbering.
4701 @itemx -fdump-rtl-outof_cfglayout
4702 @opindex fdump-rtl-outof_cfglayout
4703 Dump after converting from cfglayout mode.
4705 @item -fdump-rtl-peephole2
4706 @opindex fdump-rtl-peephole2
4707 Dump after the peephole pass.
4709 @item -fdump-rtl-postreload
4710 @opindex fdump-rtl-postreload
4711 Dump after post-reload optimizations.
4713 @itemx -fdump-rtl-pro_and_epilogue
4714 @opindex fdump-rtl-pro_and_epilogue
4715 Dump after generating the function pro and epilogues.
4717 @item -fdump-rtl-regmove
4718 @opindex fdump-rtl-regmove
4719 Dump after the register move pass.
4721 @item -fdump-rtl-sched1
4722 @itemx -fdump-rtl-sched2
4723 @opindex fdump-rtl-sched1
4724 @opindex fdump-rtl-sched2
4725 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4726 after the basic block scheduling passes.
4728 @item -fdump-rtl-see
4729 @opindex fdump-rtl-see
4730 Dump after sign extension elimination.
4732 @item -fdump-rtl-seqabstr
4733 @opindex fdump-rtl-seqabstr
4734 Dump after common sequence discovery. 
4736 @item -fdump-rtl-shorten
4737 @opindex fdump-rtl-shorten
4738 Dump after shortening branches.
4740 @item -fdump-rtl-sibling
4741 @opindex fdump-rtl-sibling
4742 Dump after sibling call optimizations.
4744 @item -fdump-rtl-split1
4745 @itemx -fdump-rtl-split2
4746 @itemx -fdump-rtl-split3
4747 @itemx -fdump-rtl-split4
4748 @itemx -fdump-rtl-split5
4749 @opindex fdump-rtl-split1
4750 @opindex fdump-rtl-split2
4751 @opindex fdump-rtl-split3
4752 @opindex fdump-rtl-split4
4753 @opindex fdump-rtl-split5
4754 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
4755 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
4756 @option{-fdump-rtl-split5} enable dumping after five rounds of
4757 instruction splitting.
4759 @item -fdump-rtl-sms
4760 @opindex fdump-rtl-sms
4761 Dump after modulo scheduling.  This pass is only run on some
4762 architectures.
4764 @item -fdump-rtl-stack
4765 @opindex fdump-rtl-stack
4766 Dump after conversion from GCC's "flat register file" registers to the
4767 x87's stack-like registers.  This pass is only run on x86 variants.
4769 @item -fdump-rtl-subreg1
4770 @itemx -fdump-rtl-subreg2
4771 @opindex fdump-rtl-subreg1
4772 @opindex fdump-rtl-subreg2
4773 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
4774 the two subreg expansion passes.
4776 @item -fdump-rtl-unshare
4777 @opindex fdump-rtl-unshare
4778 Dump after all rtl has been unshared.
4780 @item -fdump-rtl-vartrack
4781 @opindex fdump-rtl-vartrack
4782 Dump after variable tracking.
4784 @item -fdump-rtl-vregs
4785 @opindex fdump-rtl-vregs
4786 Dump after converting virtual registers to hard registers.
4788 @item -fdump-rtl-web
4789 @opindex fdump-rtl-web
4790 Dump after live range splitting.
4792 @item -fdump-rtl-regclass
4793 @itemx -fdump-rtl-subregs_of_mode_init
4794 @itemx -fdump-rtl-subregs_of_mode_finish
4795 @itemx -fdump-rtl-dfinit
4796 @itemx -fdump-rtl-dfinish
4797 @opindex fdump-rtl-regclass
4798 @opindex fdump-rtl-subregs_of_mode_init
4799 @opindex fdump-rtl-subregs_of_mode_finish
4800 @opindex fdump-rtl-dfinit
4801 @opindex fdump-rtl-dfinish
4802 These dumps are defined but always produce empty files.
4804 @item -fdump-rtl-all
4805 @opindex fdump-rtl-all
4806 Produce all the dumps listed above.
4808 @item -dA
4809 @opindex dA
4810 Annotate the assembler output with miscellaneous debugging information.
4812 @item -dD
4813 @opindex dD
4814 Dump all macro definitions, at the end of preprocessing, in addition to
4815 normal output.
4817 @item -dH
4818 @opindex dH
4819 Produce a core dump whenever an error occurs.
4821 @item -dm
4822 @opindex dm
4823 Print statistics on memory usage, at the end of the run, to
4824 standard error.
4826 @item -dp
4827 @opindex dp
4828 Annotate the assembler output with a comment indicating which
4829 pattern and alternative was used.  The length of each instruction is
4830 also printed.
4832 @item -dP
4833 @opindex dP
4834 Dump the RTL in the assembler output as a comment before each instruction.
4835 Also turns on @option{-dp} annotation.
4837 @item -dv
4838 @opindex dv
4839 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
4840 dump a representation of the control flow graph suitable for viewing with VCG
4841 to @file{@var{file}.@var{pass}.vcg}.
4843 @item -dx
4844 @opindex dx
4845 Just generate RTL for a function instead of compiling it.  Usually used
4846 with @option{-fdump-rtl-expand}.
4848 @item -dy
4849 @opindex dy
4850 Dump debugging information during parsing, to standard error.
4851 @end table
4853 @item -fdump-noaddr
4854 @opindex fdump-noaddr
4855 When doing debugging dumps, suppress address output.  This makes it more
4856 feasible to use diff on debugging dumps for compiler invocations with
4857 different compiler binaries and/or different
4858 text / bss / data / heap / stack / dso start locations.
4860 @item -fdump-unnumbered
4861 @opindex fdump-unnumbered
4862 When doing debugging dumps, suppress instruction numbers and address output.
4863 This makes it more feasible to use diff on debugging dumps for compiler
4864 invocations with different options, in particular with and without
4865 @option{-g}.
4867 @item -fdump-translation-unit @r{(C++ only)}
4868 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4869 @opindex fdump-translation-unit
4870 Dump a representation of the tree structure for the entire translation
4871 unit to a file.  The file name is made by appending @file{.tu} to the
4872 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4873 controls the details of the dump as described for the
4874 @option{-fdump-tree} options.
4876 @item -fdump-class-hierarchy @r{(C++ only)}
4877 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4878 @opindex fdump-class-hierarchy
4879 Dump a representation of each class's hierarchy and virtual function
4880 table layout to a file.  The file name is made by appending @file{.class}
4881 to the source file name.  If the @samp{-@var{options}} form is used,
4882 @var{options} controls the details of the dump as described for the
4883 @option{-fdump-tree} options.
4885 @item -fdump-ipa-@var{switch}
4886 @opindex fdump-ipa
4887 Control the dumping at various stages of inter-procedural analysis
4888 language tree to a file.  The file name is generated by appending a switch
4889 specific suffix to the source file name.  The following dumps are possible:
4891 @table @samp
4892 @item all
4893 Enables all inter-procedural analysis dumps.
4895 @item cgraph
4896 Dumps information about call-graph optimization, unused function removal,
4897 and inlining decisions.
4899 @item inline
4900 Dump after function inlining.
4902 @end table
4904 @item -fdump-statistics-@var{option}
4905 @opindex -fdump-statistics
4906 Enable and control dumping of pass statistics in a separate file.  The
4907 file name is generated by appending a suffix ending in @samp{.statistics}
4908 to the source file name.  If the @samp{-@var{option}} form is used,
4909 @samp{-stats} will cause counters to be summed over the whole compilation unit
4910 while @samp{-details} will dump every event as the passes generate them.
4911 The default with no option is to sum counters for each function compiled.
4913 @item -fdump-tree-@var{switch}
4914 @itemx -fdump-tree-@var{switch}-@var{options}
4915 @opindex fdump-tree
4916 Control the dumping at various stages of processing the intermediate
4917 language tree to a file.  The file name is generated by appending a switch
4918 specific suffix to the source file name.  If the @samp{-@var{options}}
4919 form is used, @var{options} is a list of @samp{-} separated options that
4920 control the details of the dump.  Not all options are applicable to all
4921 dumps, those which are not meaningful will be ignored.  The following
4922 options are available
4924 @table @samp
4925 @item address
4926 Print the address of each node.  Usually this is not meaningful as it
4927 changes according to the environment and source file.  Its primary use
4928 is for tying up a dump file with a debug environment.
4929 @item slim
4930 Inhibit dumping of members of a scope or body of a function merely
4931 because that scope has been reached.  Only dump such items when they
4932 are directly reachable by some other path.  When dumping pretty-printed
4933 trees, this option inhibits dumping the bodies of control structures.
4934 @item raw
4935 Print a raw representation of the tree.  By default, trees are
4936 pretty-printed into a C-like representation.
4937 @item details
4938 Enable more detailed dumps (not honored by every dump option).
4939 @item stats
4940 Enable dumping various statistics about the pass (not honored by every dump
4941 option).
4942 @item blocks
4943 Enable showing basic block boundaries (disabled in raw dumps).
4944 @item vops
4945 Enable showing virtual operands for every statement.
4946 @item lineno
4947 Enable showing line numbers for statements.
4948 @item uid
4949 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4950 @item verbose
4951 Enable showing the tree dump for each statement.
4952 @item all
4953 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4954 and @option{lineno}.
4955 @end table
4957 The following tree dumps are possible:
4958 @table @samp
4960 @item original
4961 Dump before any tree based optimization, to @file{@var{file}.original}.
4963 @item optimized
4964 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4966 @item gimple
4967 @opindex fdump-tree-gimple
4968 Dump each function before and after the gimplification pass to a file.  The
4969 file name is made by appending @file{.gimple} to the source file name.
4971 @item cfg
4972 @opindex fdump-tree-cfg
4973 Dump the control flow graph of each function to a file.  The file name is
4974 made by appending @file{.cfg} to the source file name.
4976 @item vcg
4977 @opindex fdump-tree-vcg
4978 Dump the control flow graph of each function to a file in VCG format.  The
4979 file name is made by appending @file{.vcg} to the source file name.  Note
4980 that if the file contains more than one function, the generated file cannot
4981 be used directly by VCG@.  You will need to cut and paste each function's
4982 graph into its own separate file first.
4984 @item ch
4985 @opindex fdump-tree-ch
4986 Dump each function after copying loop headers.  The file name is made by
4987 appending @file{.ch} to the source file name.
4989 @item ssa
4990 @opindex fdump-tree-ssa
4991 Dump SSA related information to a file.  The file name is made by appending
4992 @file{.ssa} to the source file name.
4994 @item alias
4995 @opindex fdump-tree-alias
4996 Dump aliasing information for each function.  The file name is made by
4997 appending @file{.alias} to the source file name.
4999 @item ccp
5000 @opindex fdump-tree-ccp
5001 Dump each function after CCP@.  The file name is made by appending
5002 @file{.ccp} to the source file name.
5004 @item storeccp
5005 @opindex fdump-tree-storeccp
5006 Dump each function after STORE-CCP@.  The file name is made by appending
5007 @file{.storeccp} to the source file name.
5009 @item pre
5010 @opindex fdump-tree-pre
5011 Dump trees after partial redundancy elimination.  The file name is made
5012 by appending @file{.pre} to the source file name.
5014 @item fre
5015 @opindex fdump-tree-fre
5016 Dump trees after full redundancy elimination.  The file name is made
5017 by appending @file{.fre} to the source file name.
5019 @item copyprop
5020 @opindex fdump-tree-copyprop
5021 Dump trees after copy propagation.  The file name is made
5022 by appending @file{.copyprop} to the source file name.
5024 @item store_copyprop
5025 @opindex fdump-tree-store_copyprop
5026 Dump trees after store copy-propagation.  The file name is made
5027 by appending @file{.store_copyprop} to the source file name.
5029 @item dce
5030 @opindex fdump-tree-dce
5031 Dump each function after dead code elimination.  The file name is made by
5032 appending @file{.dce} to the source file name.
5034 @item mudflap
5035 @opindex fdump-tree-mudflap
5036 Dump each function after adding mudflap instrumentation.  The file name is
5037 made by appending @file{.mudflap} to the source file name.
5039 @item sra
5040 @opindex fdump-tree-sra
5041 Dump each function after performing scalar replacement of aggregates.  The
5042 file name is made by appending @file{.sra} to the source file name.
5044 @item sink
5045 @opindex fdump-tree-sink
5046 Dump each function after performing code sinking.  The file name is made
5047 by appending @file{.sink} to the source file name.
5049 @item dom
5050 @opindex fdump-tree-dom
5051 Dump each function after applying dominator tree optimizations.  The file
5052 name is made by appending @file{.dom} to the source file name.
5054 @item dse
5055 @opindex fdump-tree-dse
5056 Dump each function after applying dead store elimination.  The file
5057 name is made by appending @file{.dse} to the source file name.
5059 @item phiopt
5060 @opindex fdump-tree-phiopt
5061 Dump each function after optimizing PHI nodes into straightline code.  The file
5062 name is made by appending @file{.phiopt} to the source file name.
5064 @item forwprop
5065 @opindex fdump-tree-forwprop
5066 Dump each function after forward propagating single use variables.  The file
5067 name is made by appending @file{.forwprop} to the source file name.
5069 @item copyrename
5070 @opindex fdump-tree-copyrename
5071 Dump each function after applying the copy rename optimization.  The file
5072 name is made by appending @file{.copyrename} to the source file name.
5074 @item nrv
5075 @opindex fdump-tree-nrv
5076 Dump each function after applying the named return value optimization on
5077 generic trees.  The file name is made by appending @file{.nrv} to the source
5078 file name.
5080 @item vect
5081 @opindex fdump-tree-vect
5082 Dump each function after applying vectorization of loops.  The file name is
5083 made by appending @file{.vect} to the source file name.
5085 @item vrp
5086 @opindex fdump-tree-vrp
5087 Dump each function after Value Range Propagation (VRP).  The file name
5088 is made by appending @file{.vrp} to the source file name.
5090 @item all
5091 @opindex fdump-tree-all
5092 Enable all the available tree dumps with the flags provided in this option.
5093 @end table
5095 @item -ftree-vectorizer-verbose=@var{n}
5096 @opindex ftree-vectorizer-verbose
5097 This option controls the amount of debugging output the vectorizer prints.
5098 This information is written to standard error, unless
5099 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5100 in which case it is output to the usual dump listing file, @file{.vect}.
5101 For @var{n}=0 no diagnostic information is reported.
5102 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5103 and the total number of loops that got vectorized.
5104 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5105 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5106 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5107 level that @option{-fdump-tree-vect-stats} uses.
5108 Higher verbosity levels mean either more information dumped for each
5109 reported loop, or same amount of information reported for more loops:
5110 If @var{n}=3, alignment related information is added to the reports.
5111 If @var{n}=4, data-references related information (e.g.@: memory dependences,
5112 memory access-patterns) is added to the reports.
5113 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
5114 that did not pass the first analysis phase (i.e., may not be countable, or
5115 may have complicated control-flow).
5116 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
5117 For @var{n}=7, all the information the vectorizer generates during its
5118 analysis and transformation is reported.  This is the same verbosity level
5119 that @option{-fdump-tree-vect-details} uses.
5121 @item -frandom-seed=@var{string}
5122 @opindex frandom-string
5123 This option provides a seed that GCC uses when it would otherwise use
5124 random numbers.  It is used to generate certain symbol names
5125 that have to be different in every compiled file.  It is also used to
5126 place unique stamps in coverage data files and the object files that
5127 produce them.  You can use the @option{-frandom-seed} option to produce
5128 reproducibly identical object files.
5130 The @var{string} should be different for every file you compile.
5132 @item -fsched-verbose=@var{n}
5133 @opindex fsched-verbose
5134 On targets that use instruction scheduling, this option controls the
5135 amount of debugging output the scheduler prints.  This information is
5136 written to standard error, unless @option{-fdump-rtl-sched1} or
5137 @option{-fdump-rtl-sched2} is specified, in which case it is output
5138 to the usual dump listing file, @file{.sched} or @file{.sched2}
5139 respectively.  However for @var{n} greater than nine, the output is
5140 always printed to standard error.
5142 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5143 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5144 For @var{n} greater than one, it also output basic block probabilities,
5145 detailed ready list information and unit/insn info.  For @var{n} greater
5146 than two, it includes RTL at abort point, control-flow and regions info.
5147 And for @var{n} over four, @option{-fsched-verbose} also includes
5148 dependence info.
5150 @item -save-temps
5151 @opindex save-temps
5152 Store the usual ``temporary'' intermediate files permanently; place them
5153 in the current directory and name them based on the source file.  Thus,
5154 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5155 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5156 preprocessed @file{foo.i} output file even though the compiler now
5157 normally uses an integrated preprocessor.
5159 When used in combination with the @option{-x} command line option,
5160 @option{-save-temps} is sensible enough to avoid over writing an
5161 input source file with the same extension as an intermediate file.
5162 The corresponding intermediate file may be obtained by renaming the
5163 source file before using @option{-save-temps}.
5165 @item -time
5166 @opindex time
5167 Report the CPU time taken by each subprocess in the compilation
5168 sequence.  For C source files, this is the compiler proper and assembler
5169 (plus the linker if linking is done).  The output looks like this:
5171 @smallexample
5172 # cc1 0.12 0.01
5173 # as 0.00 0.01
5174 @end smallexample
5176 The first number on each line is the ``user time'', that is time spent
5177 executing the program itself.  The second number is ``system time'',
5178 time spent executing operating system routines on behalf of the program.
5179 Both numbers are in seconds.
5181 @item -fvar-tracking
5182 @opindex fvar-tracking
5183 Run variable tracking pass.  It computes where variables are stored at each
5184 position in code.  Better debugging information is then generated
5185 (if the debugging information format supports this information).
5187 It is enabled by default when compiling with optimization (@option{-Os},
5188 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5189 the debug info format supports it.
5191 @item -print-file-name=@var{library}
5192 @opindex print-file-name
5193 Print the full absolute name of the library file @var{library} that
5194 would be used when linking---and don't do anything else.  With this
5195 option, GCC does not compile or link anything; it just prints the
5196 file name.
5198 @item -print-multi-directory
5199 @opindex print-multi-directory
5200 Print the directory name corresponding to the multilib selected by any
5201 other switches present in the command line.  This directory is supposed
5202 to exist in @env{GCC_EXEC_PREFIX}.
5204 @item -print-multi-lib
5205 @opindex print-multi-lib
5206 Print the mapping from multilib directory names to compiler switches
5207 that enable them.  The directory name is separated from the switches by
5208 @samp{;}, and each switch starts with an @samp{@@} instead of the
5209 @samp{-}, without spaces between multiple switches.  This is supposed to
5210 ease shell-processing.
5212 @item -print-prog-name=@var{program}
5213 @opindex print-prog-name
5214 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5216 @item -print-libgcc-file-name
5217 @opindex print-libgcc-file-name
5218 Same as @option{-print-file-name=libgcc.a}.
5220 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5221 but you do want to link with @file{libgcc.a}.  You can do
5223 @smallexample
5224 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5225 @end smallexample
5227 @item -print-search-dirs
5228 @opindex print-search-dirs
5229 Print the name of the configured installation directory and a list of
5230 program and library directories @command{gcc} will search---and don't do anything else.
5232 This is useful when @command{gcc} prints the error message
5233 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5234 To resolve this you either need to put @file{cpp0} and the other compiler
5235 components where @command{gcc} expects to find them, or you can set the environment
5236 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5237 Don't forget the trailing @samp{/}.
5238 @xref{Environment Variables}.
5240 @item -print-sysroot
5241 @opindex print-sysroot
5242 Print the target sysroot directory that will be used during
5243 compilation.  This is the target sysroot specified either at configure
5244 time or using the @option{--sysroot} option, possibly with an extra
5245 suffix that depends on compilation options.  If no target sysroot is
5246 specified, the option prints nothing.
5248 @item -print-sysroot-headers-suffix
5249 @opindex print-sysroot-headers-suffix
5250 Print the suffix added to the target sysroot when searching for
5251 headers, or give an error if the compiler is not configured with such
5252 a suffix---and don't do anything else.
5254 @item -dumpmachine
5255 @opindex dumpmachine
5256 Print the compiler's target machine (for example,
5257 @samp{i686-pc-linux-gnu})---and don't do anything else.
5259 @item -dumpversion
5260 @opindex dumpversion
5261 Print the compiler version (for example, @samp{3.0})---and don't do
5262 anything else.
5264 @item -dumpspecs
5265 @opindex dumpspecs
5266 Print the compiler's built-in specs---and don't do anything else.  (This
5267 is used when GCC itself is being built.)  @xref{Spec Files}.
5269 @item -feliminate-unused-debug-types
5270 @opindex feliminate-unused-debug-types
5271 Normally, when producing DWARF2 output, GCC will emit debugging
5272 information for all types declared in a compilation
5273 unit, regardless of whether or not they are actually used
5274 in that compilation unit.  Sometimes this is useful, such as
5275 if, in the debugger, you want to cast a value to a type that is
5276 not actually used in your program (but is declared).  More often,
5277 however, this results in a significant amount of wasted space.
5278 With this option, GCC will avoid producing debug symbol output
5279 for types that are nowhere used in the source file being compiled.
5280 @end table
5282 @node Optimize Options
5283 @section Options That Control Optimization
5284 @cindex optimize options
5285 @cindex options, optimization
5287 These options control various sorts of optimizations.
5289 Without any optimization option, the compiler's goal is to reduce the
5290 cost of compilation and to make debugging produce the expected
5291 results.  Statements are independent: if you stop the program with a
5292 breakpoint between statements, you can then assign a new value to any
5293 variable or change the program counter to any other statement in the
5294 function and get exactly the results you would expect from the source
5295 code.
5297 Turning on optimization flags makes the compiler attempt to improve
5298 the performance and/or code size at the expense of compilation time
5299 and possibly the ability to debug the program.
5301 The compiler performs optimization based on the knowledge it has of the
5302 program.  Compiling multiple files at once to a single output file mode allows
5303 the compiler to use information gained from all of the files when compiling
5304 each of them.
5306 Not all optimizations are controlled directly by a flag.  Only
5307 optimizations that have a flag are listed.
5309 @table @gcctabopt
5310 @item -O
5311 @itemx -O1
5312 @opindex O
5313 @opindex O1
5314 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5315 more memory for a large function.
5317 With @option{-O}, the compiler tries to reduce code size and execution
5318 time, without performing any optimizations that take a great deal of
5319 compilation time.
5321 @option{-O} turns on the following optimization flags:
5322 @gccoptlist{
5323 -fauto-inc-dec @gol
5324 -fcprop-registers @gol
5325 -fdce @gol
5326 -fdefer-pop @gol
5327 -fdelayed-branch @gol
5328 -fdse @gol
5329 -fguess-branch-probability @gol
5330 -fif-conversion2 @gol
5331 -fif-conversion @gol
5332 -finline-small-functions @gol
5333 -fipa-pure-const @gol
5334 -fipa-reference @gol
5335 -fmerge-constants
5336 -fsplit-wide-types @gol
5337 -ftree-builtin-call-dce @gol
5338 -ftree-ccp @gol
5339 -ftree-ch @gol
5340 -ftree-copyrename @gol
5341 -ftree-dce @gol
5342 -ftree-dominator-opts @gol
5343 -ftree-dse @gol
5344 -ftree-fre @gol
5345 -ftree-sra @gol
5346 -ftree-ter @gol
5347 -funit-at-a-time}
5349 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5350 where doing so does not interfere with debugging.
5352 @item -O2
5353 @opindex O2
5354 Optimize even more.  GCC performs nearly all supported optimizations
5355 that do not involve a space-speed tradeoff.
5356 As compared to @option{-O}, this option increases both compilation time
5357 and the performance of the generated code.
5359 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5360 also turns on the following optimization flags:
5361 @gccoptlist{-fthread-jumps @gol
5362 -falign-functions  -falign-jumps @gol
5363 -falign-loops  -falign-labels @gol
5364 -fcaller-saves @gol
5365 -fcrossjumping @gol
5366 -fcse-follow-jumps  -fcse-skip-blocks @gol
5367 -fdelete-null-pointer-checks @gol
5368 -fexpensive-optimizations @gol
5369 -fgcse  -fgcse-lm  @gol
5370 -findirect-inlining @gol
5371 -foptimize-sibling-calls @gol
5372 -fpeephole2 @gol
5373 -fregmove @gol
5374 -freorder-blocks  -freorder-functions @gol
5375 -frerun-cse-after-loop  @gol
5376 -fsched-interblock  -fsched-spec @gol
5377 -fschedule-insns  -fschedule-insns2 @gol
5378 -fstrict-aliasing -fstrict-overflow @gol
5379 -ftree-switch-conversion @gol
5380 -ftree-pre @gol
5381 -ftree-vrp}
5383 Please note the warning under @option{-fgcse} about
5384 invoking @option{-O2} on programs that use computed gotos.
5386 @item -O3
5387 @opindex O3
5388 Optimize yet more.  @option{-O3} turns on all optimizations specified
5389 by @option{-O2} and also turns on the @option{-finline-functions},
5390 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5391 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5393 @item -O0
5394 @opindex O0
5395 Reduce compilation time and make debugging produce the expected
5396 results.  This is the default.
5398 @item -Os
5399 @opindex Os
5400 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5401 do not typically increase code size.  It also performs further
5402 optimizations designed to reduce code size.
5404 @option{-Os} disables the following optimization flags:
5405 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5406 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5407 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5409 If you use multiple @option{-O} options, with or without level numbers,
5410 the last such option is the one that is effective.
5411 @end table
5413 Options of the form @option{-f@var{flag}} specify machine-independent
5414 flags.  Most flags have both positive and negative forms; the negative
5415 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5416 below, only one of the forms is listed---the one you typically will
5417 use.  You can figure out the other form by either removing @samp{no-}
5418 or adding it.
5420 The following options control specific optimizations.  They are either
5421 activated by @option{-O} options or are related to ones that are.  You
5422 can use the following flags in the rare cases when ``fine-tuning'' of
5423 optimizations to be performed is desired.
5425 @table @gcctabopt
5426 @item -fno-default-inline
5427 @opindex fno-default-inline
5428 Do not make member functions inline by default merely because they are
5429 defined inside the class scope (C++ only).  Otherwise, when you specify
5430 @w{@option{-O}}, member functions defined inside class scope are compiled
5431 inline by default; i.e., you don't need to add @samp{inline} in front of
5432 the member function name.
5434 @item -fno-defer-pop
5435 @opindex fno-defer-pop
5436 Always pop the arguments to each function call as soon as that function
5437 returns.  For machines which must pop arguments after a function call,
5438 the compiler normally lets arguments accumulate on the stack for several
5439 function calls and pops them all at once.
5441 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5443 @item -fforward-propagate
5444 @opindex fforward-propagate
5445 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5446 instructions and checks if the result can be simplified.  If loop unrolling
5447 is active, two passes are performed and the second is scheduled after
5448 loop unrolling.
5450 This option is enabled by default at optimization levels @option{-O2},
5451 @option{-O3}, @option{-Os}.
5453 @item -fomit-frame-pointer
5454 @opindex fomit-frame-pointer
5455 Don't keep the frame pointer in a register for functions that
5456 don't need one.  This avoids the instructions to save, set up and
5457 restore frame pointers; it also makes an extra register available
5458 in many functions.  @strong{It also makes debugging impossible on
5459 some machines.}
5461 On some machines, such as the VAX, this flag has no effect, because
5462 the standard calling sequence automatically handles the frame pointer
5463 and nothing is saved by pretending it doesn't exist.  The
5464 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5465 whether a target machine supports this flag.  @xref{Registers,,Register
5466 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5468 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5470 @item -foptimize-sibling-calls
5471 @opindex foptimize-sibling-calls
5472 Optimize sibling and tail recursive calls.
5474 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5476 @item -fno-inline
5477 @opindex fno-inline
5478 Don't pay attention to the @code{inline} keyword.  Normally this option
5479 is used to keep the compiler from expanding any functions inline.
5480 Note that if you are not optimizing, no functions can be expanded inline.
5482 @item -finline-small-functions
5483 @opindex finline-small-functions
5484 Integrate functions into their callers when their body is smaller than expected
5485 function call code (so overall size of program gets smaller).  The compiler
5486 heuristically decides which functions are simple enough to be worth integrating
5487 in this way.
5489 Enabled at level @option{-O2}.
5491 @item -findirect-inlining
5492 @opindex findirect-inlining
5493 Inline also indirect calls that are discovered to be known at compile
5494 time thanks to previous inlining.  This option has any effect only
5495 when inlining itself is turned on by the @option{-finline-functions}
5496 or @option{-finline-small-functions} options.
5498 Enabled at level @option{-O2}.
5500 @item -finline-functions
5501 @opindex finline-functions
5502 Integrate all simple functions into their callers.  The compiler
5503 heuristically decides which functions are simple enough to be worth
5504 integrating in this way.
5506 If all calls to a given function are integrated, and the function is
5507 declared @code{static}, then the function is normally not output as
5508 assembler code in its own right.
5510 Enabled at level @option{-O3}.
5512 @item -finline-functions-called-once
5513 @opindex finline-functions-called-once
5514 Consider all @code{static} functions called once for inlining into their
5515 caller even if they are not marked @code{inline}.  If a call to a given
5516 function is integrated, then the function is not output as assembler code
5517 in its own right.
5519 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5521 @item -fearly-inlining
5522 @opindex fearly-inlining
5523 Inline functions marked by @code{always_inline} and functions whose body seems
5524 smaller than the function call overhead early before doing
5525 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5526 makes profiling significantly cheaper and usually inlining faster on programs
5527 having large chains of nested wrapper functions.
5529 Enabled by default.
5531 @item -finline-limit=@var{n}
5532 @opindex finline-limit
5533 By default, GCC limits the size of functions that can be inlined.  This flag
5534 allows coarse control of this limit.  @var{n} is the size of functions that
5535 can be inlined in number of pseudo instructions.
5537 Inlining is actually controlled by a number of parameters, which may be
5538 specified individually by using @option{--param @var{name}=@var{value}}.
5539 The @option{-finline-limit=@var{n}} option sets some of these parameters
5540 as follows:
5542 @table @gcctabopt
5543 @item max-inline-insns-single
5544 is set to @var{n}/2.
5545 @item max-inline-insns-auto
5546 is set to @var{n}/2.
5547 @end table
5549 See below for a documentation of the individual
5550 parameters controlling inlining and for the defaults of these parameters.
5552 @emph{Note:} there may be no value to @option{-finline-limit} that results
5553 in default behavior.
5555 @emph{Note:} pseudo instruction represents, in this particular context, an
5556 abstract measurement of function's size.  In no way does it represent a count
5557 of assembly instructions and as such its exact meaning might change from one
5558 release to an another.
5560 @item -fkeep-inline-functions
5561 @opindex fkeep-inline-functions
5562 In C, emit @code{static} functions that are declared @code{inline}
5563 into the object file, even if the function has been inlined into all
5564 of its callers.  This switch does not affect functions using the
5565 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5566 inline functions into the object file.
5568 @item -fkeep-static-consts
5569 @opindex fkeep-static-consts
5570 Emit variables declared @code{static const} when optimization isn't turned
5571 on, even if the variables aren't referenced.
5573 GCC enables this option by default.  If you want to force the compiler to
5574 check if the variable was referenced, regardless of whether or not
5575 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5577 @item -fmerge-constants
5578 @opindex fmerge-constants
5579 Attempt to merge identical constants (string constants and floating point
5580 constants) across compilation units.
5582 This option is the default for optimized compilation if the assembler and
5583 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5584 behavior.
5586 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5588 @item -fmerge-all-constants
5589 @opindex fmerge-all-constants
5590 Attempt to merge identical constants and identical variables.
5592 This option implies @option{-fmerge-constants}.  In addition to
5593 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5594 arrays or initialized constant variables with integral or floating point
5595 types.  Languages like C or C++ require each variable, including multiple
5596 instances of the same variable in recursive calls, to have distinct locations,
5597 so using this option will result in non-conforming
5598 behavior.
5600 @item -fmodulo-sched
5601 @opindex fmodulo-sched
5602 Perform swing modulo scheduling immediately before the first scheduling
5603 pass.  This pass looks at innermost loops and reorders their
5604 instructions by overlapping different iterations.
5606 @item -fmodulo-sched-allow-regmoves
5607 @opindex fmodulo-sched-allow-regmoves
5608 Perform more aggressive SMS based modulo scheduling with register moves
5609 allowed.  By setting this flag certain anti-dependences edges will be
5610 deleted which will trigger the generation of reg-moves based on the
5611 life-range analysis.  This option is effective only with
5612 @option{-fmodulo-sched} enabled.
5614 @item -fno-branch-count-reg
5615 @opindex fno-branch-count-reg
5616 Do not use ``decrement and branch'' instructions on a count register,
5617 but instead generate a sequence of instructions that decrement a
5618 register, compare it against zero, then branch based upon the result.
5619 This option is only meaningful on architectures that support such
5620 instructions, which include x86, PowerPC, IA-64 and S/390.
5622 The default is @option{-fbranch-count-reg}.
5624 @item -fno-function-cse
5625 @opindex fno-function-cse
5626 Do not put function addresses in registers; make each instruction that
5627 calls a constant function contain the function's address explicitly.
5629 This option results in less efficient code, but some strange hacks
5630 that alter the assembler output may be confused by the optimizations
5631 performed when this option is not used.
5633 The default is @option{-ffunction-cse}
5635 @item -fno-zero-initialized-in-bss
5636 @opindex fno-zero-initialized-in-bss
5637 If the target supports a BSS section, GCC by default puts variables that
5638 are initialized to zero into BSS@.  This can save space in the resulting
5639 code.
5641 This option turns off this behavior because some programs explicitly
5642 rely on variables going to the data section.  E.g., so that the
5643 resulting executable can find the beginning of that section and/or make
5644 assumptions based on that.
5646 The default is @option{-fzero-initialized-in-bss}.
5648 @item -fmudflap -fmudflapth -fmudflapir
5649 @opindex fmudflap
5650 @opindex fmudflapth
5651 @opindex fmudflapir
5652 @cindex bounds checking
5653 @cindex mudflap
5654 For front-ends that support it (C and C++), instrument all risky
5655 pointer/array dereferencing operations, some standard library
5656 string/heap functions, and some other associated constructs with
5657 range/validity tests.  Modules so instrumented should be immune to
5658 buffer overflows, invalid heap use, and some other classes of C/C++
5659 programming errors.  The instrumentation relies on a separate runtime
5660 library (@file{libmudflap}), which will be linked into a program if
5661 @option{-fmudflap} is given at link time.  Run-time behavior of the
5662 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5663 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5664 for its options.
5666 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5667 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5668 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5669 instrumentation should ignore pointer reads.  This produces less
5670 instrumentation (and therefore faster execution) and still provides
5671 some protection against outright memory corrupting writes, but allows
5672 erroneously read data to propagate within a program.
5674 @item -fthread-jumps
5675 @opindex fthread-jumps
5676 Perform optimizations where we check to see if a jump branches to a
5677 location where another comparison subsumed by the first is found.  If
5678 so, the first branch is redirected to either the destination of the
5679 second branch or a point immediately following it, depending on whether
5680 the condition is known to be true or false.
5682 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5684 @item -fsplit-wide-types
5685 @opindex fsplit-wide-types
5686 When using a type that occupies multiple registers, such as @code{long
5687 long} on a 32-bit system, split the registers apart and allocate them
5688 independently.  This normally generates better code for those types,
5689 but may make debugging more difficult.
5691 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5692 @option{-Os}.
5694 @item -fcse-follow-jumps
5695 @opindex fcse-follow-jumps
5696 In common subexpression elimination (CSE), scan through jump instructions
5697 when the target of the jump is not reached by any other path.  For
5698 example, when CSE encounters an @code{if} statement with an
5699 @code{else} clause, CSE will follow the jump when the condition
5700 tested is false.
5702 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5704 @item -fcse-skip-blocks
5705 @opindex fcse-skip-blocks
5706 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5707 follow jumps which conditionally skip over blocks.  When CSE
5708 encounters a simple @code{if} statement with no else clause,
5709 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5710 body of the @code{if}.
5712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5714 @item -frerun-cse-after-loop
5715 @opindex frerun-cse-after-loop
5716 Re-run common subexpression elimination after loop optimizations has been
5717 performed.
5719 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5721 @item -fgcse
5722 @opindex fgcse
5723 Perform a global common subexpression elimination pass.
5724 This pass also performs global constant and copy propagation.
5726 @emph{Note:} When compiling a program using computed gotos, a GCC
5727 extension, you may get better runtime performance if you disable
5728 the global common subexpression elimination pass by adding
5729 @option{-fno-gcse} to the command line.
5731 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5733 @item -fgcse-lm
5734 @opindex fgcse-lm
5735 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5736 attempt to move loads which are only killed by stores into themselves.  This
5737 allows a loop containing a load/store sequence to be changed to a load outside
5738 the loop, and a copy/store within the loop.
5740 Enabled by default when gcse is enabled.
5742 @item -fgcse-sm
5743 @opindex fgcse-sm
5744 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5745 global common subexpression elimination.  This pass will attempt to move
5746 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5747 loops containing a load/store sequence can be changed to a load before
5748 the loop and a store after the loop.
5750 Not enabled at any optimization level.
5752 @item -fgcse-las
5753 @opindex fgcse-las
5754 When @option{-fgcse-las} is enabled, the global common subexpression
5755 elimination pass eliminates redundant loads that come after stores to the
5756 same memory location (both partial and full redundancies).
5758 Not enabled at any optimization level.
5760 @item -fgcse-after-reload
5761 @opindex fgcse-after-reload
5762 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5763 pass is performed after reload.  The purpose of this pass is to cleanup
5764 redundant spilling.
5766 @item -funsafe-loop-optimizations
5767 @opindex funsafe-loop-optimizations
5768 If given, the loop optimizer will assume that loop indices do not
5769 overflow, and that the loops with nontrivial exit condition are not
5770 infinite.  This enables a wider range of loop optimizations even if
5771 the loop optimizer itself cannot prove that these assumptions are valid.
5772 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5773 if it finds this kind of loop.
5775 @item -fcrossjumping
5776 @opindex fcrossjumping
5777 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5778 resulting code may or may not perform better than without cross-jumping.
5780 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5782 @item -fauto-inc-dec
5783 @opindex fauto-inc-dec
5784 Combine increments or decrements of addresses with memory accesses.
5785 This pass is always skipped on architectures that do not have
5786 instructions to support this.  Enabled by default at @option{-O} and
5787 higher on architectures that support this.
5789 @item -fdce
5790 @opindex fdce
5791 Perform dead code elimination (DCE) on RTL@.
5792 Enabled by default at @option{-O} and higher.
5794 @item -fdse
5795 @opindex fdse
5796 Perform dead store elimination (DSE) on RTL@.
5797 Enabled by default at @option{-O} and higher.
5799 @item -fif-conversion
5800 @opindex fif-conversion
5801 Attempt to transform conditional jumps into branch-less equivalents.  This
5802 include use of conditional moves, min, max, set flags and abs instructions, and
5803 some tricks doable by standard arithmetics.  The use of conditional execution
5804 on chips where it is available is controlled by @code{if-conversion2}.
5806 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5808 @item -fif-conversion2
5809 @opindex fif-conversion2
5810 Use conditional execution (where available) to transform conditional jumps into
5811 branch-less equivalents.
5813 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5815 @item -fdelete-null-pointer-checks
5816 @opindex fdelete-null-pointer-checks
5817 Use global dataflow analysis to identify and eliminate useless checks
5818 for null pointers.  The compiler assumes that dereferencing a null
5819 pointer would have halted the program.  If a pointer is checked after
5820 it has already been dereferenced, it cannot be null.
5822 In some environments, this assumption is not true, and programs can
5823 safely dereference null pointers.  Use
5824 @option{-fno-delete-null-pointer-checks} to disable this optimization
5825 for programs which depend on that behavior.
5827 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5829 @item -fexpensive-optimizations
5830 @opindex fexpensive-optimizations
5831 Perform a number of minor optimizations that are relatively expensive.
5833 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5835 @item -foptimize-register-move
5836 @itemx -fregmove
5837 @opindex foptimize-register-move
5838 @opindex fregmove
5839 Attempt to reassign register numbers in move instructions and as
5840 operands of other simple instructions in order to maximize the amount of
5841 register tying.  This is especially helpful on machines with two-operand
5842 instructions.
5844 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5845 optimization.
5847 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5849 @item -fira
5850 @opindex fira
5851 Use the integrated register allocator (@acronym{IRA}) for register
5852 allocation.  It is a default if @acronym{IRA} has been ported for the
5853 target.
5855 @item -fira-algorithm=@var{algorithm}
5856 Use specified coloring algorithm for the integrated register
5857 allocator.  The @var{algorithm} argument should be @code{priority} or
5858 @code{CB}.  The first algorithm specifies Chow's priority coloring,
5859 the second one specifies Chaitin-Briggs coloring.  The second
5860 algorithm can be unimplemented for some architectures.  If it is
5861 implemented, it is the default because Chaitin-Briggs coloring as a
5862 rule generates a better code.
5864 @item -fira-region=@var{region}
5865 Use specified regions for the integrated register allocator.  The
5866 @var{region} argument should be one of @code{all}, @code{mixed}, or
5867 @code{one}.  The first value means using all loops as register
5868 allocation regions, the second value which is the default means using
5869 all loops except for loops with small register pressure as the
5870 regions, and third one means using all function as a single region.
5871 The first value can give best result for machines with small size and
5872 irregular register set, the third one results in faster and generates
5873 decent code and the smallest size code, and the default value usually
5874 give the best results in most cases and for most architectures.
5876 @item -fira-coalesce
5877 @opindex fira-coalesce
5878 Do optimistic register coalescing.  This option might be profitable for
5879 architectures with big regular register files.
5881 @item -fno-ira-share-save-slots
5882 @opindex fno-ira-share-save-slots
5883 Switch off sharing stack slots used for saving call used hard
5884 registers living through a call.  Each hard register will get a
5885 separate stack slot and as a result function stack frame will be
5886 bigger.
5888 @item -fno-ira-share-spill-slots
5889 @opindex fno-ira-share-spill-slots
5890 Switch off sharing stack slots allocated for pseudo-registers.  Each
5891 pseudo-register which did not get a hard register will get a separate
5892 stack slot and as a result function stack frame will be bigger.
5894 @item -fira-verbose=@var{n}
5895 @opindex fira-verbose
5896 Set up how verbose dump file for the integrated register allocator
5897 will be.  Default value is 5.  If the value is greater or equal to 10,
5898 the dump file will be stderr as if the value were @var{n} minus 10.
5900 @item -fdelayed-branch
5901 @opindex fdelayed-branch
5902 If supported for the target machine, attempt to reorder instructions
5903 to exploit instruction slots available after delayed branch
5904 instructions.
5906 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5908 @item -fschedule-insns
5909 @opindex fschedule-insns
5910 If supported for the target machine, attempt to reorder instructions to
5911 eliminate execution stalls due to required data being unavailable.  This
5912 helps machines that have slow floating point or memory load instructions
5913 by allowing other instructions to be issued until the result of the load
5914 or floating point instruction is required.
5916 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5918 @item -fschedule-insns2
5919 @opindex fschedule-insns2
5920 Similar to @option{-fschedule-insns}, but requests an additional pass of
5921 instruction scheduling after register allocation has been done.  This is
5922 especially useful on machines with a relatively small number of
5923 registers and where memory load instructions take more than one cycle.
5925 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5927 @item -fno-sched-interblock
5928 @opindex fno-sched-interblock
5929 Don't schedule instructions across basic blocks.  This is normally
5930 enabled by default when scheduling before register allocation, i.e.@:
5931 with @option{-fschedule-insns} or at @option{-O2} or higher.
5933 @item -fno-sched-spec
5934 @opindex fno-sched-spec
5935 Don't allow speculative motion of non-load instructions.  This is normally
5936 enabled by default when scheduling before register allocation, i.e.@:
5937 with @option{-fschedule-insns} or at @option{-O2} or higher.
5939 @item -fsched-spec-load
5940 @opindex fsched-spec-load
5941 Allow speculative motion of some load instructions.  This only makes
5942 sense when scheduling before register allocation, i.e.@: with
5943 @option{-fschedule-insns} or at @option{-O2} or higher.
5945 @item -fsched-spec-load-dangerous
5946 @opindex fsched-spec-load-dangerous
5947 Allow speculative motion of more load instructions.  This only makes
5948 sense when scheduling before register allocation, i.e.@: with
5949 @option{-fschedule-insns} or at @option{-O2} or higher.
5951 @item -fsched-stalled-insns
5952 @itemx -fsched-stalled-insns=@var{n}
5953 @opindex fsched-stalled-insns
5954 Define how many insns (if any) can be moved prematurely from the queue
5955 of stalled insns into the ready list, during the second scheduling pass.
5956 @option{-fno-sched-stalled-insns} means that no insns will be moved
5957 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5958 on how many queued insns can be moved prematurely.
5959 @option{-fsched-stalled-insns} without a value is equivalent to
5960 @option{-fsched-stalled-insns=1}.
5962 @item -fsched-stalled-insns-dep
5963 @itemx -fsched-stalled-insns-dep=@var{n}
5964 @opindex fsched-stalled-insns-dep
5965 Define how many insn groups (cycles) will be examined for a dependency
5966 on a stalled insn that is candidate for premature removal from the queue
5967 of stalled insns.  This has an effect only during the second scheduling pass,
5968 and only if @option{-fsched-stalled-insns} is used.
5969 @option{-fno-sched-stalled-insns-dep} is equivalent to
5970 @option{-fsched-stalled-insns-dep=0}.
5971 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5972 @option{-fsched-stalled-insns-dep=1}.
5974 @item -fsched2-use-superblocks
5975 @opindex fsched2-use-superblocks
5976 When scheduling after register allocation, do use superblock scheduling
5977 algorithm.  Superblock scheduling allows motion across basic block boundaries
5978 resulting on faster schedules.  This option is experimental, as not all machine
5979 descriptions used by GCC model the CPU closely enough to avoid unreliable
5980 results from the algorithm.
5982 This only makes sense when scheduling after register allocation, i.e.@: with
5983 @option{-fschedule-insns2} or at @option{-O2} or higher.
5985 @item -fsched2-use-traces
5986 @opindex fsched2-use-traces
5987 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5988 allocation and additionally perform code duplication in order to increase the
5989 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5990 trace formation.
5992 This mode should produce faster but significantly longer programs.  Also
5993 without @option{-fbranch-probabilities} the traces constructed may not
5994 match the reality and hurt the performance.  This only makes
5995 sense when scheduling after register allocation, i.e.@: with
5996 @option{-fschedule-insns2} or at @option{-O2} or higher.
5998 @item -fsee
5999 @opindex fsee
6000 Eliminate redundant sign extension instructions and move the non-redundant
6001 ones to optimal placement using lazy code motion (LCM).
6003 @item -freschedule-modulo-scheduled-loops
6004 @opindex freschedule-modulo-scheduled-loops
6005 The modulo scheduling comes before the traditional scheduling, if a loop
6006 was modulo scheduled we may want to prevent the later scheduling passes
6007 from changing its schedule, we use this option to control that.
6009 @item -fselective-scheduling
6010 @opindex fselective-scheduling
6011 Schedule instructions using selective scheduling algorithm.  Selective
6012 scheduling runs instead of the first scheduler pass.
6014 @item -fselective-scheduling2
6015 @opindex fselective-scheduling2
6016 Schedule instructions using selective scheduling algorithm.  Selective
6017 scheduling runs instead of the second scheduler pass.
6019 @item -fsel-sched-pipelining
6020 @opindex fsel-sched-pipelining
6021 Enable software pipelining of innermost loops during selective scheduling.  
6022 This option has no effect until one of @option{-fselective-scheduling} or 
6023 @option{-fselective-scheduling2} is turned on.
6025 @item -fsel-sched-pipelining-outer-loops
6026 @opindex fsel-sched-pipelining-outer-loops
6027 When pipelining loops during selective scheduling, also pipeline outer loops.
6028 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6030 @item -fcaller-saves
6031 @opindex fcaller-saves
6032 Enable values to be allocated in registers that will be clobbered by
6033 function calls, by emitting extra instructions to save and restore the
6034 registers around such calls.  Such allocation is done only when it
6035 seems to result in better code than would otherwise be produced.
6037 This option is always enabled by default on certain machines, usually
6038 those which have no call-preserved registers to use instead.
6040 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6042 @item -fconserve-stack
6043 @opindex fconserve-stack
6044 Attempt to minimize stack usage.  The compiler will attempt to use less
6045 stack space, even if that makes the program slower.  This option
6046 implies setting the @option{large-stack-frame} parameter to 100
6047 and the @option{large-stack-frame-growth} parameter to 400.
6049 @item -ftree-reassoc
6050 @opindex ftree-reassoc
6051 Perform reassociation on trees.  This flag is enabled by default
6052 at @option{-O} and higher.
6054 @item -ftree-pre
6055 @opindex ftree-pre
6056 Perform partial redundancy elimination (PRE) on trees.  This flag is
6057 enabled by default at @option{-O2} and @option{-O3}.
6059 @item -ftree-fre
6060 @opindex ftree-fre
6061 Perform full redundancy elimination (FRE) on trees.  The difference
6062 between FRE and PRE is that FRE only considers expressions
6063 that are computed on all paths leading to the redundant computation.
6064 This analysis is faster than PRE, though it exposes fewer redundancies.
6065 This flag is enabled by default at @option{-O} and higher.
6067 @item -ftree-copy-prop
6068 @opindex ftree-copy-prop
6069 Perform copy propagation on trees.  This pass eliminates unnecessary
6070 copy operations.  This flag is enabled by default at @option{-O} and
6071 higher.
6073 @item -fipa-pure-const
6074 @opindex fipa-pure-const
6075 Discover which functions are pure or constant.
6076 Enabled by default at @option{-O} and higher.
6078 @item -fipa-reference
6079 @opindex fipa-reference
6080 Discover which static variables do not escape cannot escape the
6081 compilation unit.
6082 Enabled by default at @option{-O} and higher.
6084 @item -fipa-struct-reorg
6085 @opindex fipa-struct-reorg
6086 Perform structure reorganization optimization, that change C-like structures 
6087 layout in order to better utilize spatial locality.  This transformation is 
6088 affective for programs containing arrays of structures.  Available in two 
6089 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6090 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6091 to provide the safety of this transformation.  It works only in whole program
6092 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6093 enabled.  Structures considered @samp{cold} by this transformation are not
6094 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6096 With this flag, the program debug info reflects a new structure layout.
6098 @item -fipa-pta
6099 @opindex fipa-pta
6100 Perform interprocedural pointer analysis.  This option is experimental
6101 and does not affect generated code.
6103 @item -fipa-cp
6104 @opindex fipa-cp
6105 Perform interprocedural constant propagation.
6106 This optimization analyzes the program to determine when values passed
6107 to functions are constants and then optimizes accordingly.  
6108 This optimization can substantially increase performance
6109 if the application has constants passed to functions.
6110 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6112 @item -fipa-cp-clone
6113 @opindex fipa-cp-clone
6114 Perform function cloning to make interprocedural constant propagation stronger.
6115 When enabled, interprocedural constant propagation will perform function cloning
6116 when externally visible function can be called with constant arguments.
6117 Because this optimization can create multiple copies of functions,
6118 it may significantly increase code size
6119 (see @option{--param ipcp-unit-growth=@var{value}}).
6120 This flag is enabled by default at @option{-O3}.
6122 @item -fipa-matrix-reorg
6123 @opindex fipa-matrix-reorg
6124 Perform matrix flattening and transposing.
6125 Matrix flattening tries to replace a m-dimensional matrix 
6126 with its equivalent n-dimensional matrix, where n < m.
6127 This reduces the level of indirection needed for accessing the elements
6128 of the matrix. The second optimization is matrix transposing that
6129 attemps to change the order of the matrix's dimensions in order to 
6130 improve cache locality.
6131 Both optimizations need the @option{-fwhole-program} flag. 
6132 Transposing is enabled only if profiling information is available.
6135 @item -ftree-sink
6136 @opindex ftree-sink
6137 Perform forward store motion  on trees.  This flag is
6138 enabled by default at @option{-O} and higher.
6140 @item -ftree-ccp
6141 @opindex ftree-ccp
6142 Perform sparse conditional constant propagation (CCP) on trees.  This
6143 pass only operates on local scalar variables and is enabled by default
6144 at @option{-O} and higher.
6146 @item -ftree-switch-conversion
6147 Perform conversion of simple initializations in a switch to
6148 initializations from a scalar array.  This flag is enabled by default
6149 at @option{-O2} and higher.
6151 @item -ftree-dce
6152 @opindex ftree-dce
6153 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6154 default at @option{-O} and higher.
6156 @item -ftree-builtin-call-dce
6157 @opindex ftree-builtin-call-dce
6158 Perform conditional dead code elimination (DCE) for calls to builtin functions 
6159 that may set @code{errno} but are otherwise side-effect free.  This flag is 
6160 enabled by default at @option{-O2} and higher if @option{-Os} is not also 
6161 specified.
6163 @item -ftree-dominator-opts
6164 @opindex ftree-dominator-opts
6165 Perform a variety of simple scalar cleanups (constant/copy
6166 propagation, redundancy elimination, range propagation and expression
6167 simplification) based on a dominator tree traversal.  This also
6168 performs jump threading (to reduce jumps to jumps). This flag is
6169 enabled by default at @option{-O} and higher.
6171 @item -ftree-dse
6172 @opindex ftree-dse
6173 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6174 a memory location which will later be overwritten by another store without
6175 any intervening loads.  In this case the earlier store can be deleted.  This
6176 flag is enabled by default at @option{-O} and higher.
6178 @item -ftree-ch
6179 @opindex ftree-ch
6180 Perform loop header copying on trees.  This is beneficial since it increases
6181 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6182 is enabled by default at @option{-O} and higher.  It is not enabled
6183 for @option{-Os}, since it usually increases code size.
6185 @item -ftree-loop-optimize
6186 @opindex ftree-loop-optimize
6187 Perform loop optimizations on trees.  This flag is enabled by default
6188 at @option{-O} and higher.
6190 @item -ftree-loop-linear
6191 @opindex ftree-loop-linear
6192 Perform linear loop transformations on tree.  This flag can improve cache
6193 performance and allow further loop optimizations to take place.
6195 @item -floop-interchange
6196 Perform loop interchange transformations on loops.  Interchanging two
6197 nested loops switches the inner and outer loops.  For example, given a
6198 loop like:
6199 @smallexample
6200 DO J = 1, M
6201   DO I = 1, N
6202     A(J, I) = A(J, I) * C
6203   ENDDO
6204 ENDDO
6205 @end smallexample
6206 loop interchange will transform the loop as if the user had written:
6207 @smallexample
6208 DO I = 1, N
6209   DO J = 1, M
6210     A(J, I) = A(J, I) * C
6211   ENDDO
6212 ENDDO
6213 @end smallexample
6214 which can be beneficial when @code{N} is larger than the caches,
6215 because in Fortran, the elements of an array are stored in memory
6216 contiguously by column, and the original loop iterates over rows,
6217 potentially creating at each access a cache miss.  This optimization
6218 applies to all the languages supported by GCC and is not limited to
6219 Fortran.
6221 @item -floop-strip-mine
6222 Perform loop strip mining transformations on loops.  Strip mining
6223 splits a loop into two nested loops.  The outer loop has strides 
6224 equal to the strip size and the inner loop has strides of the 
6225 original loop within a strip.  For example, given a loop like:
6226 @smallexample
6227 DO I = 1, N
6228   A(I) = A(I) + C
6229 ENDDO
6230 @end smallexample
6231 loop strip mining will transform the loop as if the user had written:
6232 @smallexample
6233 DO II = 1, N, 4
6234   DO I = II, min (II + 3, N)
6235     A(I) = A(I) + C
6236   ENDDO
6237 ENDDO
6238 @end smallexample
6239 This optimization applies to all the languages supported by GCC and is
6240 not limited to Fortran.
6242 @item -floop-block
6243 Perform loop blocking transformations on loops.  Blocking strip mines
6244 each loop in the loop nest such that the memory accesses of the
6245 element loops fit inside caches.  For example, given a loop like:
6246 @smallexample
6247 DO I = 1, N
6248   DO J = 1, M
6249     A(J, I) = B(I) + C(J)
6250   ENDDO
6251 ENDDO
6252 @end smallexample
6253 loop blocking will transform the loop as if the user had written:
6254 @smallexample
6255 DO II = 1, N, 64
6256   DO JJ = 1, M, 64
6257     DO I = II, min (II + 63, N)
6258       DO J = JJ, min (JJ + 63, M)
6259         A(J, I) = B(I) + C(J)
6260       ENDDO
6261     ENDDO
6262   ENDDO
6263 ENDDO
6264 @end smallexample
6265 which can be beneficial when @code{M} is larger than the caches,
6266 because the innermost loop will iterate over a smaller amount of data
6267 that can be kept in the caches.  This optimization applies to all the
6268 languages supported by GCC and is not limited to Fortran.
6270 @item -fcheck-data-deps
6271 @opindex fcheck-data-deps
6272 Compare the results of several data dependence analyzers.  This option
6273 is used for debugging the data dependence analyzers.
6275 @item -ftree-loop-distribution
6276 Perform loop distribution.  This flag can improve cache performance on
6277 big loop bodies and allow further loop optimizations, like
6278 parallelization or vectorization, to take place.  For example, the loop
6279 @smallexample
6280 DO I = 1, N
6281   A(I) = B(I) + C
6282   D(I) = E(I) * F
6283 ENDDO
6284 @end smallexample
6285 is transformed to
6286 @smallexample
6287 DO I = 1, N
6288    A(I) = B(I) + C
6289 ENDDO
6290 DO I = 1, N
6291    D(I) = E(I) * F
6292 ENDDO
6293 @end smallexample
6295 @item -ftree-loop-im
6296 @opindex ftree-loop-im
6297 Perform loop invariant motion on trees.  This pass moves only invariants that
6298 would be hard to handle at RTL level (function calls, operations that expand to
6299 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6300 operands of conditions that are invariant out of the loop, so that we can use
6301 just trivial invariantness analysis in loop unswitching.  The pass also includes
6302 store motion.
6304 @item -ftree-loop-ivcanon
6305 @opindex ftree-loop-ivcanon
6306 Create a canonical counter for number of iterations in the loop for that
6307 determining number of iterations requires complicated analysis.  Later
6308 optimizations then may determine the number easily.  Useful especially
6309 in connection with unrolling.
6311 @item -fivopts
6312 @opindex fivopts
6313 Perform induction variable optimizations (strength reduction, induction
6314 variable merging and induction variable elimination) on trees.
6316 @item -ftree-parallelize-loops=n
6317 @opindex ftree-parallelize-loops
6318 Parallelize loops, i.e., split their iteration space to run in n threads.
6319 This is only possible for loops whose iterations are independent
6320 and can be arbitrarily reordered.  The optimization is only
6321 profitable on multiprocessor machines, for loops that are CPU-intensive,
6322 rather than constrained e.g.@: by memory bandwidth.  This option
6323 implies @option{-pthread}, and thus is only supported on targets
6324 that have support for @option{-pthread}.
6326 @item -ftree-sra
6327 @opindex ftree-sra
6328 Perform scalar replacement of aggregates.  This pass replaces structure
6329 references with scalars to prevent committing structures to memory too
6330 early.  This flag is enabled by default at @option{-O} and higher.
6332 @item -ftree-copyrename
6333 @opindex ftree-copyrename
6334 Perform copy renaming on trees.  This pass attempts to rename compiler
6335 temporaries to other variables at copy locations, usually resulting in
6336 variable names which more closely resemble the original variables.  This flag
6337 is enabled by default at @option{-O} and higher.
6339 @item -ftree-ter
6340 @opindex ftree-ter
6341 Perform temporary expression replacement during the SSA->normal phase.  Single
6342 use/single def temporaries are replaced at their use location with their
6343 defining expression.  This results in non-GIMPLE code, but gives the expanders
6344 much more complex trees to work on resulting in better RTL generation.  This is
6345 enabled by default at @option{-O} and higher.
6347 @item -ftree-vectorize
6348 @opindex ftree-vectorize
6349 Perform loop vectorization on trees. This flag is enabled by default at
6350 @option{-O3}.
6352 @item -ftree-vect-loop-version
6353 @opindex ftree-vect-loop-version
6354 Perform loop versioning when doing loop vectorization on trees.  When a loop
6355 appears to be vectorizable except that data alignment or data dependence cannot
6356 be determined at compile time then vectorized and non-vectorized versions of
6357 the loop are generated along with runtime checks for alignment or dependence
6358 to control which version is executed.  This option is enabled by default
6359 except at level @option{-Os} where it is disabled.
6361 @item -fvect-cost-model
6362 @opindex fvect-cost-model
6363 Enable cost model for vectorization.
6365 @item -ftree-vrp
6366 @opindex ftree-vrp
6367 Perform Value Range Propagation on trees.  This is similar to the
6368 constant propagation pass, but instead of values, ranges of values are
6369 propagated.  This allows the optimizers to remove unnecessary range
6370 checks like array bound checks and null pointer checks.  This is
6371 enabled by default at @option{-O2} and higher.  Null pointer check
6372 elimination is only done if @option{-fdelete-null-pointer-checks} is
6373 enabled.
6375 @item -ftracer
6376 @opindex ftracer
6377 Perform tail duplication to enlarge superblock size.  This transformation
6378 simplifies the control flow of the function allowing other optimizations to do
6379 better job.
6381 @item -funroll-loops
6382 @opindex funroll-loops
6383 Unroll loops whose number of iterations can be determined at compile
6384 time or upon entry to the loop.  @option{-funroll-loops} implies
6385 @option{-frerun-cse-after-loop}.  This option makes code larger,
6386 and may or may not make it run faster.
6388 @item -funroll-all-loops
6389 @opindex funroll-all-loops
6390 Unroll all loops, even if their number of iterations is uncertain when
6391 the loop is entered.  This usually makes programs run more slowly.
6392 @option{-funroll-all-loops} implies the same options as
6393 @option{-funroll-loops},
6395 @item -fsplit-ivs-in-unroller
6396 @opindex fsplit-ivs-in-unroller
6397 Enables expressing of values of induction variables in later iterations
6398 of the unrolled loop using the value in the first iteration.  This breaks
6399 long dependency chains, thus improving efficiency of the scheduling passes.
6401 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6402 same effect.  However in cases the loop body is more complicated than
6403 a single basic block, this is not reliable.  It also does not work at all
6404 on some of the architectures due to restrictions in the CSE pass.
6406 This optimization is enabled by default.
6408 @item -fvariable-expansion-in-unroller
6409 @opindex fvariable-expansion-in-unroller
6410 With this option, the compiler will create multiple copies of some
6411 local variables when unrolling a loop which can result in superior code.
6413 @item -fpredictive-commoning
6414 @opindex fpredictive-commoning
6415 Perform predictive commoning optimization, i.e., reusing computations
6416 (especially memory loads and stores) performed in previous
6417 iterations of loops.
6419 This option is enabled at level @option{-O3}.
6421 @item -fprefetch-loop-arrays
6422 @opindex fprefetch-loop-arrays
6423 If supported by the target machine, generate instructions to prefetch
6424 memory to improve the performance of loops that access large arrays.
6426 This option may generate better or worse code; results are highly
6427 dependent on the structure of loops within the source code.
6429 Disabled at level @option{-Os}.
6431 @item -fno-peephole
6432 @itemx -fno-peephole2
6433 @opindex fno-peephole
6434 @opindex fno-peephole2
6435 Disable any machine-specific peephole optimizations.  The difference
6436 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6437 are implemented in the compiler; some targets use one, some use the
6438 other, a few use both.
6440 @option{-fpeephole} is enabled by default.
6441 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6443 @item -fno-guess-branch-probability
6444 @opindex fno-guess-branch-probability
6445 Do not guess branch probabilities using heuristics.
6447 GCC will use heuristics to guess branch probabilities if they are
6448 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6449 heuristics are based on the control flow graph.  If some branch probabilities
6450 are specified by @samp{__builtin_expect}, then the heuristics will be
6451 used to guess branch probabilities for the rest of the control flow graph,
6452 taking the @samp{__builtin_expect} info into account.  The interactions
6453 between the heuristics and @samp{__builtin_expect} can be complex, and in
6454 some cases, it may be useful to disable the heuristics so that the effects
6455 of @samp{__builtin_expect} are easier to understand.
6457 The default is @option{-fguess-branch-probability} at levels
6458 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6460 @item -freorder-blocks
6461 @opindex freorder-blocks
6462 Reorder basic blocks in the compiled function in order to reduce number of
6463 taken branches and improve code locality.
6465 Enabled at levels @option{-O2}, @option{-O3}.
6467 @item -freorder-blocks-and-partition
6468 @opindex freorder-blocks-and-partition
6469 In addition to reordering basic blocks in the compiled function, in order
6470 to reduce number of taken branches, partitions hot and cold basic blocks
6471 into separate sections of the assembly and .o files, to improve
6472 paging and cache locality performance.
6474 This optimization is automatically turned off in the presence of
6475 exception handling, for linkonce sections, for functions with a user-defined
6476 section attribute and on any architecture that does not support named
6477 sections.
6479 @item -freorder-functions
6480 @opindex freorder-functions
6481 Reorder functions in the object file in order to
6482 improve code locality.  This is implemented by using special
6483 subsections @code{.text.hot} for most frequently executed functions and
6484 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6485 the linker so object file format must support named sections and linker must
6486 place them in a reasonable way.
6488 Also profile feedback must be available in to make this option effective.  See
6489 @option{-fprofile-arcs} for details.
6491 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6493 @item -fstrict-aliasing
6494 @opindex fstrict-aliasing
6495 Allows the compiler to assume the strictest aliasing rules applicable to
6496 the language being compiled.  For C (and C++), this activates
6497 optimizations based on the type of expressions.  In particular, an
6498 object of one type is assumed never to reside at the same address as an
6499 object of a different type, unless the types are almost the same.  For
6500 example, an @code{unsigned int} can alias an @code{int}, but not a
6501 @code{void*} or a @code{double}.  A character type may alias any other
6502 type.
6504 @anchor{Type-punning}Pay special attention to code like this:
6505 @smallexample
6506 union a_union @{
6507   int i;
6508   double d;
6511 int f() @{
6512   a_union t;
6513   t.d = 3.0;
6514   return t.i;
6516 @end smallexample
6517 The practice of reading from a different union member than the one most
6518 recently written to (called ``type-punning'') is common.  Even with
6519 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6520 is accessed through the union type.  So, the code above will work as
6521 expected.  @xref{Structures unions enumerations and bit-fields
6522 implementation}.  However, this code might not:
6523 @smallexample
6524 int f() @{
6525   a_union t;
6526   int* ip;
6527   t.d = 3.0;
6528   ip = &t.i;
6529   return *ip;
6531 @end smallexample
6533 Similarly, access by taking the address, casting the resulting pointer
6534 and dereferencing the result has undefined behavior, even if the cast
6535 uses a union type, e.g.:
6536 @smallexample
6537 int f() @{
6538   double d = 3.0;
6539   return ((union a_union *) &d)->i;
6541 @end smallexample
6543 The @option{-fstrict-aliasing} option is enabled at levels
6544 @option{-O2}, @option{-O3}, @option{-Os}.
6546 @item -fstrict-overflow
6547 @opindex fstrict-overflow
6548 Allow the compiler to assume strict signed overflow rules, depending
6549 on the language being compiled.  For C (and C++) this means that
6550 overflow when doing arithmetic with signed numbers is undefined, which
6551 means that the compiler may assume that it will not happen.  This
6552 permits various optimizations.  For example, the compiler will assume
6553 that an expression like @code{i + 10 > i} will always be true for
6554 signed @code{i}.  This assumption is only valid if signed overflow is
6555 undefined, as the expression is false if @code{i + 10} overflows when
6556 using twos complement arithmetic.  When this option is in effect any
6557 attempt to determine whether an operation on signed numbers will
6558 overflow must be written carefully to not actually involve overflow.
6560 This option also allows the compiler to assume strict pointer
6561 semantics: given a pointer to an object, if adding an offset to that
6562 pointer does not produce a pointer to the same object, the addition is
6563 undefined.  This permits the compiler to conclude that @code{p + u >
6564 p} is always true for a pointer @code{p} and unsigned integer
6565 @code{u}.  This assumption is only valid because pointer wraparound is
6566 undefined, as the expression is false if @code{p + u} overflows using
6567 twos complement arithmetic.
6569 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6570 that integer signed overflow is fully defined: it wraps.  When
6571 @option{-fwrapv} is used, there is no difference between
6572 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6573 integers.  With @option{-fwrapv} certain types of overflow are
6574 permitted.  For example, if the compiler gets an overflow when doing
6575 arithmetic on constants, the overflowed value can still be used with
6576 @option{-fwrapv}, but not otherwise.
6578 The @option{-fstrict-overflow} option is enabled at levels
6579 @option{-O2}, @option{-O3}, @option{-Os}.
6581 @item -falign-functions
6582 @itemx -falign-functions=@var{n}
6583 @opindex falign-functions
6584 Align the start of functions to the next power-of-two greater than
6585 @var{n}, skipping up to @var{n} bytes.  For instance,
6586 @option{-falign-functions=32} aligns functions to the next 32-byte
6587 boundary, but @option{-falign-functions=24} would align to the next
6588 32-byte boundary only if this can be done by skipping 23 bytes or less.
6590 @option{-fno-align-functions} and @option{-falign-functions=1} are
6591 equivalent and mean that functions will not be aligned.
6593 Some assemblers only support this flag when @var{n} is a power of two;
6594 in that case, it is rounded up.
6596 If @var{n} is not specified or is zero, use a machine-dependent default.
6598 Enabled at levels @option{-O2}, @option{-O3}.
6600 @item -falign-labels
6601 @itemx -falign-labels=@var{n}
6602 @opindex falign-labels
6603 Align all branch targets to a power-of-two boundary, skipping up to
6604 @var{n} bytes like @option{-falign-functions}.  This option can easily
6605 make code slower, because it must insert dummy operations for when the
6606 branch target is reached in the usual flow of the code.
6608 @option{-fno-align-labels} and @option{-falign-labels=1} are
6609 equivalent and mean that labels will not be aligned.
6611 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6612 are greater than this value, then their values are used instead.
6614 If @var{n} is not specified or is zero, use a machine-dependent default
6615 which is very likely to be @samp{1}, meaning no alignment.
6617 Enabled at levels @option{-O2}, @option{-O3}.
6619 @item -falign-loops
6620 @itemx -falign-loops=@var{n}
6621 @opindex falign-loops
6622 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6623 like @option{-falign-functions}.  The hope is that the loop will be
6624 executed many times, which will make up for any execution of the dummy
6625 operations.
6627 @option{-fno-align-loops} and @option{-falign-loops=1} are
6628 equivalent and mean that loops will not be aligned.
6630 If @var{n} is not specified or is zero, use a machine-dependent default.
6632 Enabled at levels @option{-O2}, @option{-O3}.
6634 @item -falign-jumps
6635 @itemx -falign-jumps=@var{n}
6636 @opindex falign-jumps
6637 Align branch targets to a power-of-two boundary, for branch targets
6638 where the targets can only be reached by jumping, skipping up to @var{n}
6639 bytes like @option{-falign-functions}.  In this case, no dummy operations
6640 need be executed.
6642 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6643 equivalent and mean that loops will not be aligned.
6645 If @var{n} is not specified or is zero, use a machine-dependent default.
6647 Enabled at levels @option{-O2}, @option{-O3}.
6649 @item -funit-at-a-time
6650 @opindex funit-at-a-time
6651 This option is left for compatibility reasons. @option{-funit-at-a-time}
6652 has no effect, while @option{-fno-unit-at-a-time} implies
6653 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
6655 Enabled by default.
6657 @item -fno-toplevel-reorder
6658 @opindex fno-toplevel-reorder
6659 Do not reorder top-level functions, variables, and @code{asm}
6660 statements.  Output them in the same order that they appear in the
6661 input file.  When this option is used, unreferenced static variables
6662 will not be removed.  This option is intended to support existing code
6663 which relies on a particular ordering.  For new code, it is better to
6664 use attributes.
6666 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
6667 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
6668 targets.
6670 @item -fweb
6671 @opindex fweb
6672 Constructs webs as commonly used for register allocation purposes and assign
6673 each web individual pseudo register.  This allows the register allocation pass
6674 to operate on pseudos directly, but also strengthens several other optimization
6675 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6676 however, make debugging impossible, since variables will no longer stay in a
6677 ``home register''.
6679 Enabled by default with @option{-funroll-loops}.
6681 @item -fwhole-program
6682 @opindex fwhole-program
6683 Assume that the current compilation unit represents whole program being
6684 compiled.  All public functions and variables with the exception of @code{main}
6685 and those merged by attribute @code{externally_visible} become static functions
6686 and in a affect gets more aggressively optimized by interprocedural optimizers.
6687 While this option is equivalent to proper use of @code{static} keyword for
6688 programs consisting of single file, in combination with option
6689 @option{--combine} this flag can be used to compile most of smaller scale C
6690 programs since the functions and variables become local for the whole combined
6691 compilation unit, not for the single source file itself.
6693 This option is not supported for Fortran programs.
6695 @item -fcprop-registers
6696 @opindex fcprop-registers
6697 After register allocation and post-register allocation instruction splitting,
6698 we perform a copy-propagation pass to try to reduce scheduling dependencies
6699 and occasionally eliminate the copy.
6701 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6703 @item -fprofile-correction
6704 @opindex fprofile-correction
6705 Profiles collected using an instrumented binary for multi-threaded programs may
6706 be inconsistent due to missed counter updates. When this option is specified,
6707 GCC will use heuristics to correct or smooth out such inconsistencies. By
6708 default, GCC will emit an error message when an inconsistent profile is detected.
6710 @item -fprofile-dir=@var{path}
6711 @opindex fprofile-dir
6713 Set the directory to search the profile data files in to @var{path}.
6714 This option affects only the profile data generated by
6715 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6716 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6717 and its related options.
6718 By default, GCC will use the current directory as @var{path}
6719 thus the profile data file will appear in the same directory as the object file.
6721 @item -fprofile-generate
6722 @itemx -fprofile-generate=@var{path}
6723 @opindex fprofile-generate
6725 Enable options usually used for instrumenting application to produce
6726 profile useful for later recompilation with profile feedback based
6727 optimization.  You must use @option{-fprofile-generate} both when
6728 compiling and when linking your program.
6730 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6732 If @var{path} is specified, GCC will look at the @var{path} to find
6733 the profile feedback data files. See @option{-fprofile-dir}.
6735 @item -fprofile-use
6736 @itemx -fprofile-use=@var{path}
6737 @opindex fprofile-use
6738 Enable profile feedback directed optimizations, and optimizations
6739 generally profitable only with profile feedback available.
6741 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6742 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6744 By default, GCC emits an error message if the feedback profiles do not
6745 match the source code.  This error can be turned into a warning by using
6746 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6747 code.
6749 If @var{path} is specified, GCC will look at the @var{path} to find
6750 the profile feedback data files. See @option{-fprofile-dir}.
6751 @end table
6753 The following options control compiler behavior regarding floating
6754 point arithmetic.  These options trade off between speed and
6755 correctness.  All must be specifically enabled.
6757 @table @gcctabopt
6758 @item -ffloat-store
6759 @opindex ffloat-store
6760 Do not store floating point variables in registers, and inhibit other
6761 options that might change whether a floating point value is taken from a
6762 register or memory.
6764 @cindex floating point precision
6765 This option prevents undesirable excess precision on machines such as
6766 the 68000 where the floating registers (of the 68881) keep more
6767 precision than a @code{double} is supposed to have.  Similarly for the
6768 x86 architecture.  For most programs, the excess precision does only
6769 good, but a few programs rely on the precise definition of IEEE floating
6770 point.  Use @option{-ffloat-store} for such programs, after modifying
6771 them to store all pertinent intermediate computations into variables.
6773 @item -ffast-math
6774 @opindex ffast-math
6775 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6776 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6777 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6779 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6781 This option is not turned on by any @option{-O} option since
6782 it can result in incorrect output for programs which depend on
6783 an exact implementation of IEEE or ISO rules/specifications for
6784 math functions. It may, however, yield faster code for programs
6785 that do not require the guarantees of these specifications.
6787 @item -fno-math-errno
6788 @opindex fno-math-errno
6789 Do not set ERRNO after calling math functions that are executed
6790 with a single instruction, e.g., sqrt.  A program that relies on
6791 IEEE exceptions for math error handling may want to use this flag
6792 for speed while maintaining IEEE arithmetic compatibility.
6794 This option is not turned on by any @option{-O} option since
6795 it can result in incorrect output for programs which depend on
6796 an exact implementation of IEEE or ISO rules/specifications for
6797 math functions. It may, however, yield faster code for programs
6798 that do not require the guarantees of these specifications.
6800 The default is @option{-fmath-errno}.
6802 On Darwin systems, the math library never sets @code{errno}.  There is
6803 therefore no reason for the compiler to consider the possibility that
6804 it might, and @option{-fno-math-errno} is the default.
6806 @item -funsafe-math-optimizations
6807 @opindex funsafe-math-optimizations
6809 Allow optimizations for floating-point arithmetic that (a) assume
6810 that arguments and results are valid and (b) may violate IEEE or
6811 ANSI standards.  When used at link-time, it may include libraries
6812 or startup files that change the default FPU control word or other
6813 similar optimizations.
6815 This option is not turned on by any @option{-O} option since
6816 it can result in incorrect output for programs which depend on
6817 an exact implementation of IEEE or ISO rules/specifications for
6818 math functions. It may, however, yield faster code for programs
6819 that do not require the guarantees of these specifications.
6820 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6821 @option{-fassociative-math} and @option{-freciprocal-math}.
6823 The default is @option{-fno-unsafe-math-optimizations}.
6825 @item -fassociative-math
6826 @opindex fassociative-math
6828 Allow re-association of operands in series of floating-point operations.
6829 This violates the ISO C and C++ language standard by possibly changing
6830 computation result.  NOTE: re-ordering may change the sign of zero as
6831 well as ignore NaNs and inhibit or create underflow or overflow (and
6832 thus cannot be used on a code which relies on rounding behavior like
6833 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6834 and thus may not be used when ordered comparisons are required.
6835 This option requires that both @option{-fno-signed-zeros} and
6836 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6837 much sense with @option{-frounding-math}.
6839 The default is @option{-fno-associative-math}.
6841 @item -freciprocal-math
6842 @opindex freciprocal-math
6844 Allow the reciprocal of a value to be used instead of dividing by
6845 the value if this enables optimizations.  For example @code{x / y}
6846 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6847 is subject to common subexpression elimination.  Note that this loses
6848 precision and increases the number of flops operating on the value.
6850 The default is @option{-fno-reciprocal-math}.
6852 @item -ffinite-math-only
6853 @opindex ffinite-math-only
6854 Allow optimizations for floating-point arithmetic that assume
6855 that arguments and results are not NaNs or +-Infs.
6857 This option is not turned on by any @option{-O} option since
6858 it can result in incorrect output for programs which depend on
6859 an exact implementation of IEEE or ISO rules/specifications for
6860 math functions. It may, however, yield faster code for programs
6861 that do not require the guarantees of these specifications.
6863 The default is @option{-fno-finite-math-only}.
6865 @item -fno-signed-zeros
6866 @opindex fno-signed-zeros
6867 Allow optimizations for floating point arithmetic that ignore the
6868 signedness of zero.  IEEE arithmetic specifies the behavior of
6869 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6870 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6871 This option implies that the sign of a zero result isn't significant.
6873 The default is @option{-fsigned-zeros}.
6875 @item -fno-trapping-math
6876 @opindex fno-trapping-math
6877 Compile code assuming that floating-point operations cannot generate
6878 user-visible traps.  These traps include division by zero, overflow,
6879 underflow, inexact result and invalid operation.  This option requires
6880 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6881 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6883 This option should never be turned on by any @option{-O} option since
6884 it can result in incorrect output for programs which depend on
6885 an exact implementation of IEEE or ISO rules/specifications for
6886 math functions.
6888 The default is @option{-ftrapping-math}.
6890 @item -frounding-math
6891 @opindex frounding-math
6892 Disable transformations and optimizations that assume default floating
6893 point rounding behavior.  This is round-to-zero for all floating point
6894 to integer conversions, and round-to-nearest for all other arithmetic
6895 truncations.  This option should be specified for programs that change
6896 the FP rounding mode dynamically, or that may be executed with a
6897 non-default rounding mode.  This option disables constant folding of
6898 floating point expressions at compile-time (which may be affected by
6899 rounding mode) and arithmetic transformations that are unsafe in the
6900 presence of sign-dependent rounding modes.
6902 The default is @option{-fno-rounding-math}.
6904 This option is experimental and does not currently guarantee to
6905 disable all GCC optimizations that are affected by rounding mode.
6906 Future versions of GCC may provide finer control of this setting
6907 using C99's @code{FENV_ACCESS} pragma.  This command line option
6908 will be used to specify the default state for @code{FENV_ACCESS}.
6910 @item -frtl-abstract-sequences
6911 @opindex frtl-abstract-sequences
6912 It is a size optimization method. This option is to find identical
6913 sequences of code, which can be turned into pseudo-procedures  and
6914 then  replace  all  occurrences with  calls to  the  newly created
6915 subroutine. It is kind of an opposite of @option{-finline-functions}.
6916 This optimization runs at RTL level.
6918 @item -fsignaling-nans
6919 @opindex fsignaling-nans
6920 Compile code assuming that IEEE signaling NaNs may generate user-visible
6921 traps during floating-point operations.  Setting this option disables
6922 optimizations that may change the number of exceptions visible with
6923 signaling NaNs.  This option implies @option{-ftrapping-math}.
6925 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6926 be defined.
6928 The default is @option{-fno-signaling-nans}.
6930 This option is experimental and does not currently guarantee to
6931 disable all GCC optimizations that affect signaling NaN behavior.
6933 @item -fsingle-precision-constant
6934 @opindex fsingle-precision-constant
6935 Treat floating point constant as single precision constant instead of
6936 implicitly converting it to double precision constant.
6938 @item -fcx-limited-range
6939 @opindex fcx-limited-range
6940 When enabled, this option states that a range reduction step is not
6941 needed when performing complex division.  Also, there is no checking
6942 whether the result of a complex multiplication or division is @code{NaN
6943 + I*NaN}, with an attempt to rescue the situation in that case.  The
6944 default is @option{-fno-cx-limited-range}, but is enabled by
6945 @option{-ffast-math}.
6947 This option controls the default setting of the ISO C99
6948 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6949 all languages.
6951 @item -fcx-fortran-rules
6952 @opindex fcx-fortran-rules
6953 Complex multiplication and division follow Fortran rules.  Range
6954 reduction is done as part of complex division, but there is no checking
6955 whether the result of a complex multiplication or division is @code{NaN
6956 + I*NaN}, with an attempt to rescue the situation in that case.
6958 The default is @option{-fno-cx-fortran-rules}.
6960 @end table
6962 The following options control optimizations that may improve
6963 performance, but are not enabled by any @option{-O} options.  This
6964 section includes experimental options that may produce broken code.
6966 @table @gcctabopt
6967 @item -fbranch-probabilities
6968 @opindex fbranch-probabilities
6969 After running a program compiled with @option{-fprofile-arcs}
6970 (@pxref{Debugging Options,, Options for Debugging Your Program or
6971 @command{gcc}}), you can compile it a second time using
6972 @option{-fbranch-probabilities}, to improve optimizations based on
6973 the number of times each branch was taken.  When the program
6974 compiled with @option{-fprofile-arcs} exits it saves arc execution
6975 counts to a file called @file{@var{sourcename}.gcda} for each source
6976 file.  The information in this data file is very dependent on the
6977 structure of the generated code, so you must use the same source code
6978 and the same optimization options for both compilations.
6980 With @option{-fbranch-probabilities}, GCC puts a
6981 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6982 These can be used to improve optimization.  Currently, they are only
6983 used in one place: in @file{reorg.c}, instead of guessing which path a
6984 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6985 exactly determine which path is taken more often.
6987 @item -fprofile-values
6988 @opindex fprofile-values
6989 If combined with @option{-fprofile-arcs}, it adds code so that some
6990 data about values of expressions in the program is gathered.
6992 With @option{-fbranch-probabilities}, it reads back the data gathered
6993 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6994 notes to instructions for their later usage in optimizations.
6996 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6998 @item -fvpt
6999 @opindex fvpt
7000 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7001 a code to gather information about values of expressions.
7003 With @option{-fbranch-probabilities}, it reads back the data gathered
7004 and actually performs the optimizations based on them.
7005 Currently the optimizations include specialization of division operation
7006 using the knowledge about the value of the denominator.
7008 @item -frename-registers
7009 @opindex frename-registers
7010 Attempt to avoid false dependencies in scheduled code by making use
7011 of registers left over after register allocation.  This optimization
7012 will most benefit processors with lots of registers.  Depending on the
7013 debug information format adopted by the target, however, it can
7014 make debugging impossible, since variables will no longer stay in
7015 a ``home register''.
7017 Enabled by default with @option{-funroll-loops}.
7019 @item -ftracer
7020 @opindex ftracer
7021 Perform tail duplication to enlarge superblock size.  This transformation
7022 simplifies the control flow of the function allowing other optimizations to do
7023 better job.
7025 Enabled with @option{-fprofile-use}.
7027 @item -funroll-loops
7028 @opindex funroll-loops
7029 Unroll loops whose number of iterations can be determined at compile time or
7030 upon entry to the loop.  @option{-funroll-loops} implies
7031 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7032 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7033 small constant number of iterations).  This option makes code larger, and may
7034 or may not make it run faster.
7036 Enabled with @option{-fprofile-use}.
7038 @item -funroll-all-loops
7039 @opindex funroll-all-loops
7040 Unroll all loops, even if their number of iterations is uncertain when
7041 the loop is entered.  This usually makes programs run more slowly.
7042 @option{-funroll-all-loops} implies the same options as
7043 @option{-funroll-loops}.
7045 @item -fpeel-loops
7046 @opindex fpeel-loops
7047 Peels the loops for that there is enough information that they do not
7048 roll much (from profile feedback).  It also turns on complete loop peeling
7049 (i.e.@: complete removal of loops with small constant number of iterations).
7051 Enabled with @option{-fprofile-use}.
7053 @item -fmove-loop-invariants
7054 @opindex fmove-loop-invariants
7055 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7056 at level @option{-O1}
7058 @item -funswitch-loops
7059 @opindex funswitch-loops
7060 Move branches with loop invariant conditions out of the loop, with duplicates
7061 of the loop on both branches (modified according to result of the condition).
7063 @item -ffunction-sections
7064 @itemx -fdata-sections
7065 @opindex ffunction-sections
7066 @opindex fdata-sections
7067 Place each function or data item into its own section in the output
7068 file if the target supports arbitrary sections.  The name of the
7069 function or the name of the data item determines the section's name
7070 in the output file.
7072 Use these options on systems where the linker can perform optimizations
7073 to improve locality of reference in the instruction space.  Most systems
7074 using the ELF object format and SPARC processors running Solaris 2 have
7075 linkers with such optimizations.  AIX may have these optimizations in
7076 the future.
7078 Only use these options when there are significant benefits from doing
7079 so.  When you specify these options, the assembler and linker will
7080 create larger object and executable files and will also be slower.
7081 You will not be able to use @code{gprof} on all systems if you
7082 specify this option and you may have problems with debugging if
7083 you specify both this option and @option{-g}.
7085 @item -fbranch-target-load-optimize
7086 @opindex fbranch-target-load-optimize
7087 Perform branch target register load optimization before prologue / epilogue
7088 threading.
7089 The use of target registers can typically be exposed only during reload,
7090 thus hoisting loads out of loops and doing inter-block scheduling needs
7091 a separate optimization pass.
7093 @item -fbranch-target-load-optimize2
7094 @opindex fbranch-target-load-optimize2
7095 Perform branch target register load optimization after prologue / epilogue
7096 threading.
7098 @item -fbtr-bb-exclusive
7099 @opindex fbtr-bb-exclusive
7100 When performing branch target register load optimization, don't reuse
7101 branch target registers in within any basic block.
7103 @item -fstack-protector
7104 @opindex fstack-protector
7105 Emit extra code to check for buffer overflows, such as stack smashing
7106 attacks.  This is done by adding a guard variable to functions with
7107 vulnerable objects.  This includes functions that call alloca, and
7108 functions with buffers larger than 8 bytes.  The guards are initialized
7109 when a function is entered and then checked when the function exits.
7110 If a guard check fails, an error message is printed and the program exits.
7112 @item -fstack-protector-all
7113 @opindex fstack-protector-all
7114 Like @option{-fstack-protector} except that all functions are protected.
7116 @item -fsection-anchors
7117 @opindex fsection-anchors
7118 Try to reduce the number of symbolic address calculations by using
7119 shared ``anchor'' symbols to address nearby objects.  This transformation
7120 can help to reduce the number of GOT entries and GOT accesses on some
7121 targets.
7123 For example, the implementation of the following function @code{foo}:
7125 @smallexample
7126 static int a, b, c;
7127 int foo (void) @{ return a + b + c; @}
7128 @end smallexample
7130 would usually calculate the addresses of all three variables, but if you
7131 compile it with @option{-fsection-anchors}, it will access the variables
7132 from a common anchor point instead.  The effect is similar to the
7133 following pseudocode (which isn't valid C):
7135 @smallexample
7136 int foo (void)
7138   register int *xr = &x;
7139   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7141 @end smallexample
7143 Not all targets support this option.
7145 @item --param @var{name}=@var{value}
7146 @opindex param
7147 In some places, GCC uses various constants to control the amount of
7148 optimization that is done.  For example, GCC will not inline functions
7149 that contain more that a certain number of instructions.  You can
7150 control some of these constants on the command-line using the
7151 @option{--param} option.
7153 The names of specific parameters, and the meaning of the values, are
7154 tied to the internals of the compiler, and are subject to change
7155 without notice in future releases.
7157 In each case, the @var{value} is an integer.  The allowable choices for
7158 @var{name} are given in the following table:
7160 @table @gcctabopt
7161 @item sra-max-structure-size
7162 The maximum structure size, in bytes, at which the scalar replacement
7163 of aggregates (SRA) optimization will perform block copies.  The
7164 default value, 0, implies that GCC will select the most appropriate
7165 size itself.
7167 @item sra-field-structure-ratio
7168 The threshold ratio (as a percentage) between instantiated fields and
7169 the complete structure size.  We say that if the ratio of the number
7170 of bytes in instantiated fields to the number of bytes in the complete
7171 structure exceeds this parameter, then block copies are not used.  The
7172 default is 75.
7174 @item struct-reorg-cold-struct-ratio
7175 The threshold ratio (as a percentage) between a structure frequency
7176 and the frequency of the hottest structure in the program.  This parameter
7177 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7178 We say that if the ratio of a structure frequency, calculated by profiling, 
7179 to the hottest structure frequency in the program is less than this 
7180 parameter, then structure reorganization is not applied to this structure.
7181 The default is 10.
7183 @item predictable-branch-cost-outcome
7184 When branch is predicted to be taken with probability lower than this threshold
7185 (in percent), then it is considered well predictable. The default is 10.
7187 @item max-crossjump-edges
7188 The maximum number of incoming edges to consider for crossjumping.
7189 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7190 the number of edges incoming to each block.  Increasing values mean
7191 more aggressive optimization, making the compile time increase with
7192 probably small improvement in executable size.
7194 @item min-crossjump-insns
7195 The minimum number of instructions which must be matched at the end
7196 of two blocks before crossjumping will be performed on them.  This
7197 value is ignored in the case where all instructions in the block being
7198 crossjumped from are matched.  The default value is 5.
7200 @item max-grow-copy-bb-insns
7201 The maximum code size expansion factor when copying basic blocks
7202 instead of jumping.  The expansion is relative to a jump instruction.
7203 The default value is 8.
7205 @item max-goto-duplication-insns
7206 The maximum number of instructions to duplicate to a block that jumps
7207 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7208 passes, GCC factors computed gotos early in the compilation process,
7209 and unfactors them as late as possible.  Only computed jumps at the
7210 end of a basic blocks with no more than max-goto-duplication-insns are
7211 unfactored.  The default value is 8.
7213 @item max-delay-slot-insn-search
7214 The maximum number of instructions to consider when looking for an
7215 instruction to fill a delay slot.  If more than this arbitrary number of
7216 instructions is searched, the time savings from filling the delay slot
7217 will be minimal so stop searching.  Increasing values mean more
7218 aggressive optimization, making the compile time increase with probably
7219 small improvement in executable run time.
7221 @item max-delay-slot-live-search
7222 When trying to fill delay slots, the maximum number of instructions to
7223 consider when searching for a block with valid live register
7224 information.  Increasing this arbitrarily chosen value means more
7225 aggressive optimization, increasing the compile time.  This parameter
7226 should be removed when the delay slot code is rewritten to maintain the
7227 control-flow graph.
7229 @item max-gcse-memory
7230 The approximate maximum amount of memory that will be allocated in
7231 order to perform the global common subexpression elimination
7232 optimization.  If more memory than specified is required, the
7233 optimization will not be done.
7235 @item max-gcse-passes
7236 The maximum number of passes of GCSE to run.  The default is 1.
7238 @item max-pending-list-length
7239 The maximum number of pending dependencies scheduling will allow
7240 before flushing the current state and starting over.  Large functions
7241 with few branches or calls can create excessively large lists which
7242 needlessly consume memory and resources.
7244 @item max-inline-insns-single
7245 Several parameters control the tree inliner used in gcc.
7246 This number sets the maximum number of instructions (counted in GCC's
7247 internal representation) in a single function that the tree inliner
7248 will consider for inlining.  This only affects functions declared
7249 inline and methods implemented in a class declaration (C++).
7250 The default value is 450.
7252 @item max-inline-insns-auto
7253 When you use @option{-finline-functions} (included in @option{-O3}),
7254 a lot of functions that would otherwise not be considered for inlining
7255 by the compiler will be investigated.  To those functions, a different
7256 (more restrictive) limit compared to functions declared inline can
7257 be applied.
7258 The default value is 90.
7260 @item large-function-insns
7261 The limit specifying really large functions.  For functions larger than this
7262 limit after inlining, inlining is constrained by
7263 @option{--param large-function-growth}.  This parameter is useful primarily
7264 to avoid extreme compilation time caused by non-linear algorithms used by the
7265 backend.
7266 The default value is 2700.
7268 @item large-function-growth
7269 Specifies maximal growth of large function caused by inlining in percents.
7270 The default value is 100 which limits large function growth to 2.0 times
7271 the original size.
7273 @item large-unit-insns
7274 The limit specifying large translation unit.  Growth caused by inlining of
7275 units larger than this limit is limited by @option{--param inline-unit-growth}.
7276 For small units this might be too tight (consider unit consisting of function A
7277 that is inline and B that just calls A three time.  If B is small relative to
7278 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7279 large units consisting of small inlineable functions however the overall unit
7280 growth limit is needed to avoid exponential explosion of code size.  Thus for
7281 smaller units, the size is increased to @option{--param large-unit-insns}
7282 before applying @option{--param inline-unit-growth}.  The default is 10000
7284 @item inline-unit-growth
7285 Specifies maximal overall growth of the compilation unit caused by inlining.
7286 The default value is 30 which limits unit growth to 1.3 times the original
7287 size.
7289 @item ipcp-unit-growth
7290 Specifies maximal overall growth of the compilation unit caused by
7291 interprocedural constant propagation.  The default value is 10 which limits
7292 unit growth to 1.1 times the original size.
7294 @item large-stack-frame
7295 The limit specifying large stack frames.  While inlining the algorithm is trying
7296 to not grow past this limit too much.  Default value is 256 bytes.
7298 @item large-stack-frame-growth
7299 Specifies maximal growth of large stack frames caused by inlining in percents.
7300 The default value is 1000 which limits large stack frame growth to 11 times
7301 the original size.
7303 @item max-inline-insns-recursive
7304 @itemx max-inline-insns-recursive-auto
7305 Specifies maximum number of instructions out-of-line copy of self recursive inline
7306 function can grow into by performing recursive inlining.
7308 For functions declared inline @option{--param max-inline-insns-recursive} is
7309 taken into account.  For function not declared inline, recursive inlining
7310 happens only when @option{-finline-functions} (included in @option{-O3}) is
7311 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
7312 default value is 450.
7314 @item max-inline-recursive-depth
7315 @itemx max-inline-recursive-depth-auto
7316 Specifies maximum recursion depth used by the recursive inlining.
7318 For functions declared inline @option{--param max-inline-recursive-depth} is
7319 taken into account.  For function not declared inline, recursive inlining
7320 happens only when @option{-finline-functions} (included in @option{-O3}) is
7321 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
7322 default value is 8.
7324 @item min-inline-recursive-probability
7325 Recursive inlining is profitable only for function having deep recursion
7326 in average and can hurt for function having little recursion depth by
7327 increasing the prologue size or complexity of function body to other
7328 optimizers.
7330 When profile feedback is available (see @option{-fprofile-generate}) the actual
7331 recursion depth can be guessed from probability that function will recurse via
7332 given call expression.  This parameter limits inlining only to call expression
7333 whose probability exceeds given threshold (in percents).  The default value is
7336 @item inline-call-cost
7337 Specify cost of call instruction relative to simple arithmetics operations
7338 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
7339 functions and at the same time increases size of leaf function that is believed to
7340 reduce function size by being inlined.  In effect it increases amount of
7341 inlining for code having large abstraction penalty (many functions that just
7342 pass the arguments to other functions) and decrease inlining for code with low
7343 abstraction penalty.  The default value is 12.
7345 @item min-vect-loop-bound
7346 The minimum number of iterations under which a loop will not get vectorized
7347 when @option{-ftree-vectorize} is used.  The number of iterations after
7348 vectorization needs to be greater than the value specified by this option
7349 to allow vectorization.  The default value is 0.
7351 @item max-unrolled-insns
7352 The maximum number of instructions that a loop should have if that loop
7353 is unrolled, and if the loop is unrolled, it determines how many times
7354 the loop code is unrolled.
7356 @item max-average-unrolled-insns
7357 The maximum number of instructions biased by probabilities of their execution
7358 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7359 it determines how many times the loop code is unrolled.
7361 @item max-unroll-times
7362 The maximum number of unrollings of a single loop.
7364 @item max-peeled-insns
7365 The maximum number of instructions that a loop should have if that loop
7366 is peeled, and if the loop is peeled, it determines how many times
7367 the loop code is peeled.
7369 @item max-peel-times
7370 The maximum number of peelings of a single loop.
7372 @item max-completely-peeled-insns
7373 The maximum number of insns of a completely peeled loop.
7375 @item max-completely-peel-times
7376 The maximum number of iterations of a loop to be suitable for complete peeling.
7378 @item max-unswitch-insns
7379 The maximum number of insns of an unswitched loop.
7381 @item max-unswitch-level
7382 The maximum number of branches unswitched in a single loop.
7384 @item lim-expensive
7385 The minimum cost of an expensive expression in the loop invariant motion.
7387 @item iv-consider-all-candidates-bound
7388 Bound on number of candidates for induction variables below that
7389 all candidates are considered for each use in induction variable
7390 optimizations.  Only the most relevant candidates are considered
7391 if there are more candidates, to avoid quadratic time complexity.
7393 @item iv-max-considered-uses
7394 The induction variable optimizations give up on loops that contain more
7395 induction variable uses.
7397 @item iv-always-prune-cand-set-bound
7398 If number of candidates in the set is smaller than this value,
7399 we always try to remove unnecessary ivs from the set during its
7400 optimization when a new iv is added to the set.
7402 @item scev-max-expr-size
7403 Bound on size of expressions used in the scalar evolutions analyzer.
7404 Large expressions slow the analyzer.
7406 @item omega-max-vars
7407 The maximum number of variables in an Omega constraint system.
7408 The default value is 128.
7410 @item omega-max-geqs
7411 The maximum number of inequalities in an Omega constraint system.
7412 The default value is 256.
7414 @item omega-max-eqs
7415 The maximum number of equalities in an Omega constraint system.
7416 The default value is 128.
7418 @item omega-max-wild-cards
7419 The maximum number of wildcard variables that the Omega solver will
7420 be able to insert.  The default value is 18.
7422 @item omega-hash-table-size
7423 The size of the hash table in the Omega solver.  The default value is
7424 550.
7426 @item omega-max-keys
7427 The maximal number of keys used by the Omega solver.  The default
7428 value is 500.
7430 @item omega-eliminate-redundant-constraints
7431 When set to 1, use expensive methods to eliminate all redundant
7432 constraints.  The default value is 0.
7434 @item vect-max-version-for-alignment-checks
7435 The maximum number of runtime checks that can be performed when
7436 doing loop versioning for alignment in the vectorizer.  See option
7437 ftree-vect-loop-version for more information.
7439 @item vect-max-version-for-alias-checks
7440 The maximum number of runtime checks that can be performed when
7441 doing loop versioning for alias in the vectorizer.  See option
7442 ftree-vect-loop-version for more information.
7444 @item max-iterations-to-track
7446 The maximum number of iterations of a loop the brute force algorithm
7447 for analysis of # of iterations of the loop tries to evaluate.
7449 @item hot-bb-count-fraction
7450 Select fraction of the maximal count of repetitions of basic block in program
7451 given basic block needs to have to be considered hot.
7453 @item hot-bb-frequency-fraction
7454 Select fraction of the maximal frequency of executions of basic block in
7455 function given basic block needs to have to be considered hot
7457 @item max-predicted-iterations
7458 The maximum number of loop iterations we predict statically.  This is useful
7459 in cases where function contain single loop with known bound and other loop
7460 with unknown.  We predict the known number of iterations correctly, while
7461 the unknown number of iterations average to roughly 10.  This means that the
7462 loop without bounds would appear artificially cold relative to the other one.
7464 @item align-threshold
7466 Select fraction of the maximal frequency of executions of basic block in
7467 function given basic block will get aligned.
7469 @item align-loop-iterations
7471 A loop expected to iterate at lest the selected number of iterations will get
7472 aligned.
7474 @item tracer-dynamic-coverage
7475 @itemx tracer-dynamic-coverage-feedback
7477 This value is used to limit superblock formation once the given percentage of
7478 executed instructions is covered.  This limits unnecessary code size
7479 expansion.
7481 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7482 feedback is available.  The real profiles (as opposed to statically estimated
7483 ones) are much less balanced allowing the threshold to be larger value.
7485 @item tracer-max-code-growth
7486 Stop tail duplication once code growth has reached given percentage.  This is
7487 rather hokey argument, as most of the duplicates will be eliminated later in
7488 cross jumping, so it may be set to much higher values than is the desired code
7489 growth.
7491 @item tracer-min-branch-ratio
7493 Stop reverse growth when the reverse probability of best edge is less than this
7494 threshold (in percent).
7496 @item tracer-min-branch-ratio
7497 @itemx tracer-min-branch-ratio-feedback
7499 Stop forward growth if the best edge do have probability lower than this
7500 threshold.
7502 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7503 compilation for profile feedback and one for compilation without.  The value
7504 for compilation with profile feedback needs to be more conservative (higher) in
7505 order to make tracer effective.
7507 @item max-cse-path-length
7509 Maximum number of basic blocks on path that cse considers.  The default is 10.
7511 @item max-cse-insns
7512 The maximum instructions CSE process before flushing. The default is 1000.
7514 @item max-aliased-vops
7516 Maximum number of virtual operands per function allowed to represent
7517 aliases before triggering the alias partitioning heuristic.  Alias
7518 partitioning reduces compile times and memory consumption needed for
7519 aliasing at the expense of precision loss in alias information.  The
7520 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7521 for -O3.
7523 Notice that if a function contains more memory statements than the
7524 value of this parameter, it is not really possible to achieve this
7525 reduction.  In this case, the compiler will use the number of memory
7526 statements as the value for @option{max-aliased-vops}.
7528 @item avg-aliased-vops
7530 Average number of virtual operands per statement allowed to represent
7531 aliases before triggering the alias partitioning heuristic.  This
7532 works in conjunction with @option{max-aliased-vops}.  If a function
7533 contains more than @option{max-aliased-vops} virtual operators, then
7534 memory symbols will be grouped into memory partitions until either the
7535 total number of virtual operators is below @option{max-aliased-vops}
7536 or the average number of virtual operators per memory statement is
7537 below @option{avg-aliased-vops}.  The default value for this parameter
7538 is 1 for -O1 and -O2, and 3 for -O3.
7540 @item ggc-min-expand
7542 GCC uses a garbage collector to manage its own memory allocation.  This
7543 parameter specifies the minimum percentage by which the garbage
7544 collector's heap should be allowed to expand between collections.
7545 Tuning this may improve compilation speed; it has no effect on code
7546 generation.
7548 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7549 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7550 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7551 GCC is not able to calculate RAM on a particular platform, the lower
7552 bound of 30% is used.  Setting this parameter and
7553 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7554 every opportunity.  This is extremely slow, but can be useful for
7555 debugging.
7557 @item ggc-min-heapsize
7559 Minimum size of the garbage collector's heap before it begins bothering
7560 to collect garbage.  The first collection occurs after the heap expands
7561 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7562 tuning this may improve compilation speed, and has no effect on code
7563 generation.
7565 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7566 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7567 with a lower bound of 4096 (four megabytes) and an upper bound of
7568 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7569 particular platform, the lower bound is used.  Setting this parameter
7570 very large effectively disables garbage collection.  Setting this
7571 parameter and @option{ggc-min-expand} to zero causes a full collection
7572 to occur at every opportunity.
7574 @item max-reload-search-insns
7575 The maximum number of instruction reload should look backward for equivalent
7576 register.  Increasing values mean more aggressive optimization, making the
7577 compile time increase with probably slightly better performance.  The default
7578 value is 100.
7580 @item max-cselib-memory-locations
7581 The maximum number of memory locations cselib should take into account.
7582 Increasing values mean more aggressive optimization, making the compile time
7583 increase with probably slightly better performance.  The default value is 500.
7585 @item reorder-blocks-duplicate
7586 @itemx reorder-blocks-duplicate-feedback
7588 Used by basic block reordering pass to decide whether to use unconditional
7589 branch or duplicate the code on its destination.  Code is duplicated when its
7590 estimated size is smaller than this value multiplied by the estimated size of
7591 unconditional jump in the hot spots of the program.
7593 The @option{reorder-block-duplicate-feedback} is used only when profile
7594 feedback is available and may be set to higher values than
7595 @option{reorder-block-duplicate} since information about the hot spots is more
7596 accurate.
7598 @item max-sched-ready-insns
7599 The maximum number of instructions ready to be issued the scheduler should
7600 consider at any given time during the first scheduling pass.  Increasing
7601 values mean more thorough searches, making the compilation time increase
7602 with probably little benefit.  The default value is 100.
7604 @item max-sched-region-blocks
7605 The maximum number of blocks in a region to be considered for
7606 interblock scheduling.  The default value is 10.
7608 @item max-pipeline-region-blocks
7609 The maximum number of blocks in a region to be considered for
7610 pipelining in the selective scheduler.  The default value is 15.
7612 @item max-sched-region-insns
7613 The maximum number of insns in a region to be considered for
7614 interblock scheduling.  The default value is 100.
7616 @item max-pipeline-region-insns
7617 The maximum number of insns in a region to be considered for
7618 pipelining in the selective scheduler.  The default value is 200.
7620 @item min-spec-prob
7621 The minimum probability (in percents) of reaching a source block
7622 for interblock speculative scheduling.  The default value is 40.
7624 @item max-sched-extend-regions-iters
7625 The maximum number of iterations through CFG to extend regions.
7626 0 - disable region extension,
7627 N - do at most N iterations.
7628 The default value is 0.
7630 @item max-sched-insn-conflict-delay
7631 The maximum conflict delay for an insn to be considered for speculative motion.
7632 The default value is 3.
7634 @item sched-spec-prob-cutoff
7635 The minimal probability of speculation success (in percents), so that
7636 speculative insn will be scheduled.
7637 The default value is 40.
7639 @item sched-mem-true-dep-cost
7640 Minimal distance (in CPU cycles) between store and load targeting same
7641 memory locations.  The default value is 1.
7643 @item selsched-max-lookahead
7644 The maximum size of the lookahead window of selective scheduling.  It is a
7645 depth of search for available instructions.
7646 The default value is 50.
7648 @item selsched-max-sched-times
7649 The maximum number of times that an instruction will be scheduled during 
7650 selective scheduling.  This is the limit on the number of iterations 
7651 through which the instruction may be pipelined.  The default value is 2.
7653 @item selsched-max-insns-to-rename
7654 The maximum number of best instructions in the ready list that are considered
7655 for renaming in the selective scheduler.  The default value is 2.
7657 @item max-last-value-rtl
7658 The maximum size measured as number of RTLs that can be recorded in an expression
7659 in combiner for a pseudo register as last known value of that register.  The default
7660 is 10000.
7662 @item integer-share-limit
7663 Small integer constants can use a shared data structure, reducing the
7664 compiler's memory usage and increasing its speed.  This sets the maximum
7665 value of a shared integer constant.  The default value is 256.
7667 @item min-virtual-mappings
7668 Specifies the minimum number of virtual mappings in the incremental
7669 SSA updater that should be registered to trigger the virtual mappings
7670 heuristic defined by virtual-mappings-ratio.  The default value is
7671 100.
7673 @item virtual-mappings-ratio
7674 If the number of virtual mappings is virtual-mappings-ratio bigger
7675 than the number of virtual symbols to be updated, then the incremental
7676 SSA updater switches to a full update for those symbols.  The default
7677 ratio is 3.
7679 @item ssp-buffer-size
7680 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7681 protection when @option{-fstack-protection} is used.
7683 @item max-jump-thread-duplication-stmts
7684 Maximum number of statements allowed in a block that needs to be
7685 duplicated when threading jumps.
7687 @item max-fields-for-field-sensitive
7688 Maximum number of fields in a structure we will treat in
7689 a field sensitive manner during pointer analysis.  The default is zero
7690 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
7692 @item prefetch-latency
7693 Estimate on average number of instructions that are executed before
7694 prefetch finishes.  The distance we prefetch ahead is proportional
7695 to this constant.  Increasing this number may also lead to less
7696 streams being prefetched (see @option{simultaneous-prefetches}).
7698 @item simultaneous-prefetches
7699 Maximum number of prefetches that can run at the same time.
7701 @item l1-cache-line-size
7702 The size of cache line in L1 cache, in bytes.
7704 @item l1-cache-size
7705 The size of L1 cache, in kilobytes.
7707 @item l2-cache-size
7708 The size of L2 cache, in kilobytes.
7710 @item use-canonical-types
7711 Whether the compiler should use the ``canonical'' type system.  By
7712 default, this should always be 1, which uses a more efficient internal
7713 mechanism for comparing types in C++ and Objective-C++.  However, if
7714 bugs in the canonical type system are causing compilation failures,
7715 set this value to 0 to disable canonical types.
7717 @item switch-conversion-max-branch-ratio
7718 Switch initialization conversion will refuse to create arrays that are
7719 bigger than @option{switch-conversion-max-branch-ratio} times the number of
7720 branches in the switch.
7722 @item max-partial-antic-length
7723 Maximum length of the partial antic set computed during the tree
7724 partial redundancy elimination optimization (@option{-ftree-pre}) when
7725 optimizing at @option{-O3} and above.  For some sorts of source code
7726 the enhanced partial redundancy elimination optimization can run away,
7727 consuming all of the memory available on the host machine.  This
7728 parameter sets a limit on the length of the sets that are computed,
7729 which prevents the runaway behavior.  Setting a value of 0 for
7730 this parameter will allow an unlimited set length.
7732 @item sccvn-max-scc-size
7733 Maximum size of a strongly connected component (SCC) during SCCVN
7734 processing.  If this limit is hit, SCCVN processing for the whole
7735 function will not be done and optimizations depending on it will
7736 be disabled.  The default maximum SCC size is 10000.
7738 @item ira-max-loops-num
7739 IRA uses a regional register allocation by default.  If a function
7740 contains loops more than number given by the parameter, only at most
7741 given number of the most frequently executed loops will form regions
7742 for the regional register allocation.  The default value of the
7743 parameter is 100.
7745 @item ira-max-conflict-table-size
7746 Although IRA uses a sophisticated algorithm of compression conflict
7747 table, the table can be still big for huge functions.  If the conflict
7748 table for a function could be more than size in MB given by the
7749 parameter, the conflict table is not built and faster, simpler, and
7750 lower quality register allocation algorithm will be used.  The
7751 algorithm do not use pseudo-register conflicts.  The default value of
7752 the parameter is 2000.
7754 @end table
7755 @end table
7757 @node Preprocessor Options
7758 @section Options Controlling the Preprocessor
7759 @cindex preprocessor options
7760 @cindex options, preprocessor
7762 These options control the C preprocessor, which is run on each C source
7763 file before actual compilation.
7765 If you use the @option{-E} option, nothing is done except preprocessing.
7766 Some of these options make sense only together with @option{-E} because
7767 they cause the preprocessor output to be unsuitable for actual
7768 compilation.
7770 @table @gcctabopt
7771 @opindex Wp
7772 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7773 and pass @var{option} directly through to the preprocessor.  If
7774 @var{option} contains commas, it is split into multiple options at the
7775 commas.  However, many options are modified, translated or interpreted
7776 by the compiler driver before being passed to the preprocessor, and
7777 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7778 interface is undocumented and subject to change, so whenever possible
7779 you should avoid using @option{-Wp} and let the driver handle the
7780 options instead.
7782 @item -Xpreprocessor @var{option}
7783 @opindex preprocessor
7784 Pass @var{option} as an option to the preprocessor.  You can use this to
7785 supply system-specific preprocessor options which GCC does not know how to
7786 recognize.
7788 If you want to pass an option that takes an argument, you must use
7789 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7790 @end table
7792 @include cppopts.texi
7794 @node Assembler Options
7795 @section Passing Options to the Assembler
7797 @c prevent bad page break with this line
7798 You can pass options to the assembler.
7800 @table @gcctabopt
7801 @item -Wa,@var{option}
7802 @opindex Wa
7803 Pass @var{option} as an option to the assembler.  If @var{option}
7804 contains commas, it is split into multiple options at the commas.
7806 @item -Xassembler @var{option}
7807 @opindex Xassembler
7808 Pass @var{option} as an option to the assembler.  You can use this to
7809 supply system-specific assembler options which GCC does not know how to
7810 recognize.
7812 If you want to pass an option that takes an argument, you must use
7813 @option{-Xassembler} twice, once for the option and once for the argument.
7815 @end table
7817 @node Link Options
7818 @section Options for Linking
7819 @cindex link options
7820 @cindex options, linking
7822 These options come into play when the compiler links object files into
7823 an executable output file.  They are meaningless if the compiler is
7824 not doing a link step.
7826 @table @gcctabopt
7827 @cindex file names
7828 @item @var{object-file-name}
7829 A file name that does not end in a special recognized suffix is
7830 considered to name an object file or library.  (Object files are
7831 distinguished from libraries by the linker according to the file
7832 contents.)  If linking is done, these object files are used as input
7833 to the linker.
7835 @item -c
7836 @itemx -S
7837 @itemx -E
7838 @opindex c
7839 @opindex S
7840 @opindex E
7841 If any of these options is used, then the linker is not run, and
7842 object file names should not be used as arguments.  @xref{Overall
7843 Options}.
7845 @cindex Libraries
7846 @item -l@var{library}
7847 @itemx -l @var{library}
7848 @opindex l
7849 Search the library named @var{library} when linking.  (The second
7850 alternative with the library as a separate argument is only for
7851 POSIX compliance and is not recommended.)
7853 It makes a difference where in the command you write this option; the
7854 linker searches and processes libraries and object files in the order they
7855 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7856 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7857 to functions in @samp{z}, those functions may not be loaded.
7859 The linker searches a standard list of directories for the library,
7860 which is actually a file named @file{lib@var{library}.a}.  The linker
7861 then uses this file as if it had been specified precisely by name.
7863 The directories searched include several standard system directories
7864 plus any that you specify with @option{-L}.
7866 Normally the files found this way are library files---archive files
7867 whose members are object files.  The linker handles an archive file by
7868 scanning through it for members which define symbols that have so far
7869 been referenced but not defined.  But if the file that is found is an
7870 ordinary object file, it is linked in the usual fashion.  The only
7871 difference between using an @option{-l} option and specifying a file name
7872 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7873 and searches several directories.
7875 @item -lobjc
7876 @opindex lobjc
7877 You need this special case of the @option{-l} option in order to
7878 link an Objective-C or Objective-C++ program.
7880 @item -nostartfiles
7881 @opindex nostartfiles
7882 Do not use the standard system startup files when linking.
7883 The standard system libraries are used normally, unless @option{-nostdlib}
7884 or @option{-nodefaultlibs} is used.
7886 @item -nodefaultlibs
7887 @opindex nodefaultlibs
7888 Do not use the standard system libraries when linking.
7889 Only the libraries you specify will be passed to the linker.
7890 The standard startup files are used normally, unless @option{-nostartfiles}
7891 is used.  The compiler may generate calls to @code{memcmp},
7892 @code{memset}, @code{memcpy} and @code{memmove}.
7893 These entries are usually resolved by entries in
7894 libc.  These entry points should be supplied through some other
7895 mechanism when this option is specified.
7897 @item -nostdlib
7898 @opindex nostdlib
7899 Do not use the standard system startup files or libraries when linking.
7900 No startup files and only the libraries you specify will be passed to
7901 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7902 @code{memcpy} and @code{memmove}.
7903 These entries are usually resolved by entries in
7904 libc.  These entry points should be supplied through some other
7905 mechanism when this option is specified.
7907 @cindex @option{-lgcc}, use with @option{-nostdlib}
7908 @cindex @option{-nostdlib} and unresolved references
7909 @cindex unresolved references and @option{-nostdlib}
7910 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7911 @cindex @option{-nodefaultlibs} and unresolved references
7912 @cindex unresolved references and @option{-nodefaultlibs}
7913 One of the standard libraries bypassed by @option{-nostdlib} and
7914 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7915 that GCC uses to overcome shortcomings of particular machines, or special
7916 needs for some languages.
7917 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7918 Collection (GCC) Internals},
7919 for more discussion of @file{libgcc.a}.)
7920 In most cases, you need @file{libgcc.a} even when you want to avoid
7921 other standard libraries.  In other words, when you specify @option{-nostdlib}
7922 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7923 This ensures that you have no unresolved references to internal GCC
7924 library subroutines.  (For example, @samp{__main}, used to ensure C++
7925 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7926 GNU Compiler Collection (GCC) Internals}.)
7928 @item -pie
7929 @opindex pie
7930 Produce a position independent executable on targets which support it.
7931 For predictable results, you must also specify the same set of options
7932 that were used to generate code (@option{-fpie}, @option{-fPIE},
7933 or model suboptions) when you specify this option.
7935 @item -rdynamic
7936 @opindex rdynamic
7937 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7938 that support it. This instructs the linker to add all symbols, not
7939 only used ones, to the dynamic symbol table. This option is needed
7940 for some uses of @code{dlopen} or to allow obtaining backtraces
7941 from within a program.
7943 @item -s
7944 @opindex s
7945 Remove all symbol table and relocation information from the executable.
7947 @item -static
7948 @opindex static
7949 On systems that support dynamic linking, this prevents linking with the shared
7950 libraries.  On other systems, this option has no effect.
7952 @item -shared
7953 @opindex shared
7954 Produce a shared object which can then be linked with other objects to
7955 form an executable.  Not all systems support this option.  For predictable
7956 results, you must also specify the same set of options that were used to
7957 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7958 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7959 needs to build supplementary stub code for constructors to work.  On
7960 multi-libbed systems, @samp{gcc -shared} must select the correct support
7961 libraries to link against.  Failing to supply the correct flags may lead
7962 to subtle defects.  Supplying them in cases where they are not necessary
7963 is innocuous.}
7965 @item -shared-libgcc
7966 @itemx -static-libgcc
7967 @opindex shared-libgcc
7968 @opindex static-libgcc
7969 On systems that provide @file{libgcc} as a shared library, these options
7970 force the use of either the shared or static version respectively.
7971 If no shared version of @file{libgcc} was built when the compiler was
7972 configured, these options have no effect.
7974 There are several situations in which an application should use the
7975 shared @file{libgcc} instead of the static version.  The most common
7976 of these is when the application wishes to throw and catch exceptions
7977 across different shared libraries.  In that case, each of the libraries
7978 as well as the application itself should use the shared @file{libgcc}.
7980 Therefore, the G++ and GCJ drivers automatically add
7981 @option{-shared-libgcc} whenever you build a shared library or a main
7982 executable, because C++ and Java programs typically use exceptions, so
7983 this is the right thing to do.
7985 If, instead, you use the GCC driver to create shared libraries, you may
7986 find that they will not always be linked with the shared @file{libgcc}.
7987 If GCC finds, at its configuration time, that you have a non-GNU linker
7988 or a GNU linker that does not support option @option{--eh-frame-hdr},
7989 it will link the shared version of @file{libgcc} into shared libraries
7990 by default.  Otherwise, it will take advantage of the linker and optimize
7991 away the linking with the shared version of @file{libgcc}, linking with
7992 the static version of libgcc by default.  This allows exceptions to
7993 propagate through such shared libraries, without incurring relocation
7994 costs at library load time.
7996 However, if a library or main executable is supposed to throw or catch
7997 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7998 for the languages used in the program, or using the option
7999 @option{-shared-libgcc}, such that it is linked with the shared
8000 @file{libgcc}.
8002 @item -symbolic
8003 @opindex symbolic
8004 Bind references to global symbols when building a shared object.  Warn
8005 about any unresolved references (unless overridden by the link editor
8006 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8007 this option.
8009 @item -T @var{script}
8010 @opindex T
8011 @cindex linker script
8012 Use @var{script} as the linker script.  This option is supported by most
8013 systems using the GNU linker.  On some targets, such as bare-board
8014 targets without an operating system, the @option{-T} option may be required 
8015 when linking to avoid references to undefined symbols.
8017 @item -Xlinker @var{option}
8018 @opindex Xlinker
8019 Pass @var{option} as an option to the linker.  You can use this to
8020 supply system-specific linker options which GCC does not know how to
8021 recognize.
8023 If you want to pass an option that takes an argument, you must use
8024 @option{-Xlinker} twice, once for the option and once for the argument.
8025 For example, to pass @option{-assert definitions}, you must write
8026 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8027 @option{-Xlinker "-assert definitions"}, because this passes the entire
8028 string as a single argument, which is not what the linker expects.
8030 @item -Wl,@var{option}
8031 @opindex Wl
8032 Pass @var{option} as an option to the linker.  If @var{option} contains
8033 commas, it is split into multiple options at the commas.
8035 @item -u @var{symbol}
8036 @opindex u
8037 Pretend the symbol @var{symbol} is undefined, to force linking of
8038 library modules to define it.  You can use @option{-u} multiple times with
8039 different symbols to force loading of additional library modules.
8040 @end table
8042 @node Directory Options
8043 @section Options for Directory Search
8044 @cindex directory options
8045 @cindex options, directory search
8046 @cindex search path
8048 These options specify directories to search for header files, for
8049 libraries and for parts of the compiler:
8051 @table @gcctabopt
8052 @item -I@var{dir}
8053 @opindex I
8054 Add the directory @var{dir} to the head of the list of directories to be
8055 searched for header files.  This can be used to override a system header
8056 file, substituting your own version, since these directories are
8057 searched before the system header file directories.  However, you should
8058 not use this option to add directories that contain vendor-supplied
8059 system header files (use @option{-isystem} for that).  If you use more than
8060 one @option{-I} option, the directories are scanned in left-to-right
8061 order; the standard system directories come after.
8063 If a standard system include directory, or a directory specified with
8064 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8065 option will be ignored.  The directory will still be searched but as a
8066 system directory at its normal position in the system include chain.
8067 This is to ensure that GCC's procedure to fix buggy system headers and
8068 the ordering for the include_next directive are not inadvertently changed.
8069 If you really need to change the search order for system directories,
8070 use the @option{-nostdinc} and/or @option{-isystem} options.
8072 @item -iquote@var{dir}
8073 @opindex iquote
8074 Add the directory @var{dir} to the head of the list of directories to
8075 be searched for header files only for the case of @samp{#include
8076 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8077 otherwise just like @option{-I}.
8079 @item -L@var{dir}
8080 @opindex L
8081 Add directory @var{dir} to the list of directories to be searched
8082 for @option{-l}.
8084 @item -B@var{prefix}
8085 @opindex B
8086 This option specifies where to find the executables, libraries,
8087 include files, and data files of the compiler itself.
8089 The compiler driver program runs one or more of the subprograms
8090 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8091 @var{prefix} as a prefix for each program it tries to run, both with and
8092 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8094 For each subprogram to be run, the compiler driver first tries the
8095 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8096 was not specified, the driver tries two standard prefixes, which are
8097 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8098 those results in a file name that is found, the unmodified program
8099 name is searched for using the directories specified in your
8100 @env{PATH} environment variable.
8102 The compiler will check to see if the path provided by the @option{-B}
8103 refers to a directory, and if necessary it will add a directory
8104 separator character at the end of the path.
8106 @option{-B} prefixes that effectively specify directory names also apply
8107 to libraries in the linker, because the compiler translates these
8108 options into @option{-L} options for the linker.  They also apply to
8109 includes files in the preprocessor, because the compiler translates these
8110 options into @option{-isystem} options for the preprocessor.  In this case,
8111 the compiler appends @samp{include} to the prefix.
8113 The run-time support file @file{libgcc.a} can also be searched for using
8114 the @option{-B} prefix, if needed.  If it is not found there, the two
8115 standard prefixes above are tried, and that is all.  The file is left
8116 out of the link if it is not found by those means.
8118 Another way to specify a prefix much like the @option{-B} prefix is to use
8119 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8120 Variables}.
8122 As a special kludge, if the path provided by @option{-B} is
8123 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8124 9, then it will be replaced by @file{[dir/]include}.  This is to help
8125 with boot-strapping the compiler.
8127 @item -specs=@var{file}
8128 @opindex specs
8129 Process @var{file} after the compiler reads in the standard @file{specs}
8130 file, in order to override the defaults that the @file{gcc} driver
8131 program uses when determining what switches to pass to @file{cc1},
8132 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8133 @option{-specs=@var{file}} can be specified on the command line, and they
8134 are processed in order, from left to right.
8136 @item --sysroot=@var{dir}
8137 @opindex sysroot
8138 Use @var{dir} as the logical root directory for headers and libraries.
8139 For example, if the compiler would normally search for headers in
8140 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8141 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8143 If you use both this option and the @option{-isysroot} option, then
8144 the @option{--sysroot} option will apply to libraries, but the
8145 @option{-isysroot} option will apply to header files.
8147 The GNU linker (beginning with version 2.16) has the necessary support
8148 for this option.  If your linker does not support this option, the
8149 header file aspect of @option{--sysroot} will still work, but the
8150 library aspect will not.
8152 @item -I-
8153 @opindex I-
8154 This option has been deprecated.  Please use @option{-iquote} instead for
8155 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8156 Any directories you specify with @option{-I} options before the @option{-I-}
8157 option are searched only for the case of @samp{#include "@var{file}"};
8158 they are not searched for @samp{#include <@var{file}>}.
8160 If additional directories are specified with @option{-I} options after
8161 the @option{-I-}, these directories are searched for all @samp{#include}
8162 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8163 this way.)
8165 In addition, the @option{-I-} option inhibits the use of the current
8166 directory (where the current input file came from) as the first search
8167 directory for @samp{#include "@var{file}"}.  There is no way to
8168 override this effect of @option{-I-}.  With @option{-I.} you can specify
8169 searching the directory which was current when the compiler was
8170 invoked.  That is not exactly the same as what the preprocessor does
8171 by default, but it is often satisfactory.
8173 @option{-I-} does not inhibit the use of the standard system directories
8174 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8175 independent.
8176 @end table
8178 @c man end
8180 @node Spec Files
8181 @section Specifying subprocesses and the switches to pass to them
8182 @cindex Spec Files
8184 @command{gcc} is a driver program.  It performs its job by invoking a
8185 sequence of other programs to do the work of compiling, assembling and
8186 linking.  GCC interprets its command-line parameters and uses these to
8187 deduce which programs it should invoke, and which command-line options
8188 it ought to place on their command lines.  This behavior is controlled
8189 by @dfn{spec strings}.  In most cases there is one spec string for each
8190 program that GCC can invoke, but a few programs have multiple spec
8191 strings to control their behavior.  The spec strings built into GCC can
8192 be overridden by using the @option{-specs=} command-line switch to specify
8193 a spec file.
8195 @dfn{Spec files} are plaintext files that are used to construct spec
8196 strings.  They consist of a sequence of directives separated by blank
8197 lines.  The type of directive is determined by the first non-whitespace
8198 character on the line and it can be one of the following:
8200 @table @code
8201 @item %@var{command}
8202 Issues a @var{command} to the spec file processor.  The commands that can
8203 appear here are:
8205 @table @code
8206 @item %include <@var{file}>
8207 @cindex %include
8208 Search for @var{file} and insert its text at the current point in the
8209 specs file.
8211 @item %include_noerr <@var{file}>
8212 @cindex %include_noerr
8213 Just like @samp{%include}, but do not generate an error message if the include
8214 file cannot be found.
8216 @item %rename @var{old_name} @var{new_name}
8217 @cindex %rename
8218 Rename the spec string @var{old_name} to @var{new_name}.
8220 @end table
8222 @item *[@var{spec_name}]:
8223 This tells the compiler to create, override or delete the named spec
8224 string.  All lines after this directive up to the next directive or
8225 blank line are considered to be the text for the spec string.  If this
8226 results in an empty string then the spec will be deleted.  (Or, if the
8227 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8228 does not currently exist a new spec will be created.  If the spec does
8229 exist then its contents will be overridden by the text of this
8230 directive, unless the first character of that text is the @samp{+}
8231 character, in which case the text will be appended to the spec.
8233 @item [@var{suffix}]:
8234 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8235 and up to the next directive or blank line are considered to make up the
8236 spec string for the indicated suffix.  When the compiler encounters an
8237 input file with the named suffix, it will processes the spec string in
8238 order to work out how to compile that file.  For example:
8240 @smallexample
8241 .ZZ:
8242 z-compile -input %i
8243 @end smallexample
8245 This says that any input file whose name ends in @samp{.ZZ} should be
8246 passed to the program @samp{z-compile}, which should be invoked with the
8247 command-line switch @option{-input} and with the result of performing the
8248 @samp{%i} substitution.  (See below.)
8250 As an alternative to providing a spec string, the text that follows a
8251 suffix directive can be one of the following:
8253 @table @code
8254 @item @@@var{language}
8255 This says that the suffix is an alias for a known @var{language}.  This is
8256 similar to using the @option{-x} command-line switch to GCC to specify a
8257 language explicitly.  For example:
8259 @smallexample
8260 .ZZ:
8261 @@c++
8262 @end smallexample
8264 Says that .ZZ files are, in fact, C++ source files.
8266 @item #@var{name}
8267 This causes an error messages saying:
8269 @smallexample
8270 @var{name} compiler not installed on this system.
8271 @end smallexample
8272 @end table
8274 GCC already has an extensive list of suffixes built into it.
8275 This directive will add an entry to the end of the list of suffixes, but
8276 since the list is searched from the end backwards, it is effectively
8277 possible to override earlier entries using this technique.
8279 @end table
8281 GCC has the following spec strings built into it.  Spec files can
8282 override these strings or create their own.  Note that individual
8283 targets can also add their own spec strings to this list.
8285 @smallexample
8286 asm          Options to pass to the assembler
8287 asm_final    Options to pass to the assembler post-processor
8288 cpp          Options to pass to the C preprocessor
8289 cc1          Options to pass to the C compiler
8290 cc1plus      Options to pass to the C++ compiler
8291 endfile      Object files to include at the end of the link
8292 link         Options to pass to the linker
8293 lib          Libraries to include on the command line to the linker
8294 libgcc       Decides which GCC support library to pass to the linker
8295 linker       Sets the name of the linker
8296 predefines   Defines to be passed to the C preprocessor
8297 signed_char  Defines to pass to CPP to say whether @code{char} is signed
8298              by default
8299 startfile    Object files to include at the start of the link
8300 @end smallexample
8302 Here is a small example of a spec file:
8304 @smallexample
8305 %rename lib                 old_lib
8307 *lib:
8308 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
8309 @end smallexample
8311 This example renames the spec called @samp{lib} to @samp{old_lib} and
8312 then overrides the previous definition of @samp{lib} with a new one.
8313 The new definition adds in some extra command-line options before
8314 including the text of the old definition.
8316 @dfn{Spec strings} are a list of command-line options to be passed to their
8317 corresponding program.  In addition, the spec strings can contain
8318 @samp{%}-prefixed sequences to substitute variable text or to
8319 conditionally insert text into the command line.  Using these constructs
8320 it is possible to generate quite complex command lines.
8322 Here is a table of all defined @samp{%}-sequences for spec
8323 strings.  Note that spaces are not generated automatically around the
8324 results of expanding these sequences.  Therefore you can concatenate them
8325 together or combine them with constant text in a single argument.
8327 @table @code
8328 @item %%
8329 Substitute one @samp{%} into the program name or argument.
8331 @item %i
8332 Substitute the name of the input file being processed.
8334 @item %b
8335 Substitute the basename of the input file being processed.
8336 This is the substring up to (and not including) the last period
8337 and not including the directory.
8339 @item %B
8340 This is the same as @samp{%b}, but include the file suffix (text after
8341 the last period).
8343 @item %d
8344 Marks the argument containing or following the @samp{%d} as a
8345 temporary file name, so that that file will be deleted if GCC exits
8346 successfully.  Unlike @samp{%g}, this contributes no text to the
8347 argument.
8349 @item %g@var{suffix}
8350 Substitute a file name that has suffix @var{suffix} and is chosen
8351 once per compilation, and mark the argument in the same way as
8352 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
8353 name is now chosen in a way that is hard to predict even when previously
8354 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
8355 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
8356 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
8357 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
8358 was simply substituted with a file name chosen once per compilation,
8359 without regard to any appended suffix (which was therefore treated
8360 just like ordinary text), making such attacks more likely to succeed.
8362 @item %u@var{suffix}
8363 Like @samp{%g}, but generates a new temporary file name even if
8364 @samp{%u@var{suffix}} was already seen.
8366 @item %U@var{suffix}
8367 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
8368 new one if there is no such last file name.  In the absence of any
8369 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
8370 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
8371 would involve the generation of two distinct file names, one
8372 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
8373 simply substituted with a file name chosen for the previous @samp{%u},
8374 without regard to any appended suffix.
8376 @item %j@var{suffix}
8377 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8378 writable, and if save-temps is off; otherwise, substitute the name
8379 of a temporary file, just like @samp{%u}.  This temporary file is not
8380 meant for communication between processes, but rather as a junk
8381 disposal mechanism.
8383 @item %|@var{suffix}
8384 @itemx %m@var{suffix}
8385 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8386 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8387 all.  These are the two most common ways to instruct a program that it
8388 should read from standard input or write to standard output.  If you
8389 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8390 construct: see for example @file{f/lang-specs.h}.
8392 @item %.@var{SUFFIX}
8393 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8394 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8395 terminated by the next space or %.
8397 @item %w
8398 Marks the argument containing or following the @samp{%w} as the
8399 designated output file of this compilation.  This puts the argument
8400 into the sequence of arguments that @samp{%o} will substitute later.
8402 @item %o
8403 Substitutes the names of all the output files, with spaces
8404 automatically placed around them.  You should write spaces
8405 around the @samp{%o} as well or the results are undefined.
8406 @samp{%o} is for use in the specs for running the linker.
8407 Input files whose names have no recognized suffix are not compiled
8408 at all, but they are included among the output files, so they will
8409 be linked.
8411 @item %O
8412 Substitutes the suffix for object files.  Note that this is
8413 handled specially when it immediately follows @samp{%g, %u, or %U},
8414 because of the need for those to form complete file names.  The
8415 handling is such that @samp{%O} is treated exactly as if it had already
8416 been substituted, except that @samp{%g, %u, and %U} do not currently
8417 support additional @var{suffix} characters following @samp{%O} as they would
8418 following, for example, @samp{.o}.
8420 @item %p
8421 Substitutes the standard macro predefinitions for the
8422 current target machine.  Use this when running @code{cpp}.
8424 @item %P
8425 Like @samp{%p}, but puts @samp{__} before and after the name of each
8426 predefined macro, except for macros that start with @samp{__} or with
8427 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8430 @item %I
8431 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8432 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8433 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8434 and @option{-imultilib} as necessary.
8436 @item %s
8437 Current argument is the name of a library or startup file of some sort.
8438 Search for that file in a standard list of directories and substitute
8439 the full name found.
8441 @item %e@var{str}
8442 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8443 Use this when inconsistent options are detected.
8445 @item %(@var{name})
8446 Substitute the contents of spec string @var{name} at this point.
8448 @item %[@var{name}]
8449 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8451 @item %x@{@var{option}@}
8452 Accumulate an option for @samp{%X}.
8454 @item %X
8455 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8456 spec string.
8458 @item %Y
8459 Output the accumulated assembler options specified by @option{-Wa}.
8461 @item %Z
8462 Output the accumulated preprocessor options specified by @option{-Wp}.
8464 @item %a
8465 Process the @code{asm} spec.  This is used to compute the
8466 switches to be passed to the assembler.
8468 @item %A
8469 Process the @code{asm_final} spec.  This is a spec string for
8470 passing switches to an assembler post-processor, if such a program is
8471 needed.
8473 @item %l
8474 Process the @code{link} spec.  This is the spec for computing the
8475 command line passed to the linker.  Typically it will make use of the
8476 @samp{%L %G %S %D and %E} sequences.
8478 @item %D
8479 Dump out a @option{-L} option for each directory that GCC believes might
8480 contain startup files.  If the target supports multilibs then the
8481 current multilib directory will be prepended to each of these paths.
8483 @item %L
8484 Process the @code{lib} spec.  This is a spec string for deciding which
8485 libraries should be included on the command line to the linker.
8487 @item %G
8488 Process the @code{libgcc} spec.  This is a spec string for deciding
8489 which GCC support library should be included on the command line to the linker.
8491 @item %S
8492 Process the @code{startfile} spec.  This is a spec for deciding which
8493 object files should be the first ones passed to the linker.  Typically
8494 this might be a file named @file{crt0.o}.
8496 @item %E
8497 Process the @code{endfile} spec.  This is a spec string that specifies
8498 the last object files that will be passed to the linker.
8500 @item %C
8501 Process the @code{cpp} spec.  This is used to construct the arguments
8502 to be passed to the C preprocessor.
8504 @item %1
8505 Process the @code{cc1} spec.  This is used to construct the options to be
8506 passed to the actual C compiler (@samp{cc1}).
8508 @item %2
8509 Process the @code{cc1plus} spec.  This is used to construct the options to be
8510 passed to the actual C++ compiler (@samp{cc1plus}).
8512 @item %*
8513 Substitute the variable part of a matched option.  See below.
8514 Note that each comma in the substituted string is replaced by
8515 a single space.
8517 @item %<@code{S}
8518 Remove all occurrences of @code{-S} from the command line.  Note---this
8519 command is position dependent.  @samp{%} commands in the spec string
8520 before this one will see @code{-S}, @samp{%} commands in the spec string
8521 after this one will not.
8523 @item %:@var{function}(@var{args})
8524 Call the named function @var{function}, passing it @var{args}.
8525 @var{args} is first processed as a nested spec string, then split
8526 into an argument vector in the usual fashion.  The function returns
8527 a string which is processed as if it had appeared literally as part
8528 of the current spec.
8530 The following built-in spec functions are provided:
8532 @table @code
8533 @item @code{getenv}
8534 The @code{getenv} spec function takes two arguments: an environment
8535 variable name and a string.  If the environment variable is not
8536 defined, a fatal error is issued.  Otherwise, the return value is the
8537 value of the environment variable concatenated with the string.  For
8538 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8540 @smallexample
8541 %:getenv(TOPDIR /include)
8542 @end smallexample
8544 expands to @file{/path/to/top/include}.
8546 @item @code{if-exists}
8547 The @code{if-exists} spec function takes one argument, an absolute
8548 pathname to a file.  If the file exists, @code{if-exists} returns the
8549 pathname.  Here is a small example of its usage:
8551 @smallexample
8552 *startfile:
8553 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8554 @end smallexample
8556 @item @code{if-exists-else}
8557 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8558 spec function, except that it takes two arguments.  The first argument is
8559 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8560 returns the pathname.  If it does not exist, it returns the second argument.
8561 This way, @code{if-exists-else} can be used to select one file or another,
8562 based on the existence of the first.  Here is a small example of its usage:
8564 @smallexample
8565 *startfile:
8566 crt0%O%s %:if-exists(crti%O%s) \
8567 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8568 @end smallexample
8570 @item @code{replace-outfile}
8571 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8572 first argument in the outfiles array and replaces it with the second argument.  Here
8573 is a small example of its usage:
8575 @smallexample
8576 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8577 @end smallexample
8579 @item @code{print-asm-header}
8580 The @code{print-asm-header} function takes no arguments and simply
8581 prints a banner like:
8583 @smallexample
8584 Assembler options
8585 =================
8587 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8588 @end smallexample
8590 It is used to separate compiler options from assembler options
8591 in the @option{--target-help} output.
8592 @end table
8594 @item %@{@code{S}@}
8595 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8596 If that switch was not specified, this substitutes nothing.  Note that
8597 the leading dash is omitted when specifying this option, and it is
8598 automatically inserted if the substitution is performed.  Thus the spec
8599 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8600 and would output the command line option @option{-foo}.
8602 @item %W@{@code{S}@}
8603 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8604 deleted on failure.
8606 @item %@{@code{S}*@}
8607 Substitutes all the switches specified to GCC whose names start
8608 with @code{-S}, but which also take an argument.  This is used for
8609 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8610 GCC considers @option{-o foo} as being
8611 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8612 text, including the space.  Thus two arguments would be generated.
8614 @item %@{@code{S}*&@code{T}*@}
8615 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8616 (the order of @code{S} and @code{T} in the spec is not significant).
8617 There can be any number of ampersand-separated variables; for each the
8618 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8620 @item %@{@code{S}:@code{X}@}
8621 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8623 @item %@{!@code{S}:@code{X}@}
8624 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8626 @item %@{@code{S}*:@code{X}@}
8627 Substitutes @code{X} if one or more switches whose names start with
8628 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8629 once, no matter how many such switches appeared.  However, if @code{%*}
8630 appears somewhere in @code{X}, then @code{X} will be substituted once
8631 for each matching switch, with the @code{%*} replaced by the part of
8632 that switch that matched the @code{*}.
8634 @item %@{.@code{S}:@code{X}@}
8635 Substitutes @code{X}, if processing a file with suffix @code{S}.
8637 @item %@{!.@code{S}:@code{X}@}
8638 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8640 @item %@{,@code{S}:@code{X}@}
8641 Substitutes @code{X}, if processing a file for language @code{S}.
8643 @item %@{!,@code{S}:@code{X}@}
8644 Substitutes @code{X}, if not processing a file for language @code{S}.
8646 @item %@{@code{S}|@code{P}:@code{X}@}
8647 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8648 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8649 @code{*} sequences as well, although they have a stronger binding than
8650 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8651 alternatives must be starred, and only the first matching alternative
8652 is substituted.
8654 For example, a spec string like this:
8656 @smallexample
8657 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8658 @end smallexample
8660 will output the following command-line options from the following input
8661 command-line options:
8663 @smallexample
8664 fred.c        -foo -baz
8665 jim.d         -bar -boggle
8666 -d fred.c     -foo -baz -boggle
8667 -d jim.d      -bar -baz -boggle
8668 @end smallexample
8670 @item %@{S:X; T:Y; :D@}
8672 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8673 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8674 be as many clauses as you need.  This may be combined with @code{.},
8675 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8678 @end table
8680 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8681 construct may contain other nested @samp{%} constructs or spaces, or
8682 even newlines.  They are processed as usual, as described above.
8683 Trailing white space in @code{X} is ignored.  White space may also
8684 appear anywhere on the left side of the colon in these constructs,
8685 except between @code{.} or @code{*} and the corresponding word.
8687 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8688 handled specifically in these constructs.  If another value of
8689 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8690 @option{-W} switch is found later in the command line, the earlier
8691 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8692 just one letter, which passes all matching options.
8694 The character @samp{|} at the beginning of the predicate text is used to
8695 indicate that a command should be piped to the following command, but
8696 only if @option{-pipe} is specified.
8698 It is built into GCC which switches take arguments and which do not.
8699 (You might think it would be useful to generalize this to allow each
8700 compiler's spec to say which switches take arguments.  But this cannot
8701 be done in a consistent fashion.  GCC cannot even decide which input
8702 files have been specified without knowing which switches take arguments,
8703 and it must know which input files to compile in order to tell which
8704 compilers to run).
8706 GCC also knows implicitly that arguments starting in @option{-l} are to be
8707 treated as compiler output files, and passed to the linker in their
8708 proper position among the other output files.
8710 @c man begin OPTIONS
8712 @node Target Options
8713 @section Specifying Target Machine and Compiler Version
8714 @cindex target options
8715 @cindex cross compiling
8716 @cindex specifying machine version
8717 @cindex specifying compiler version and target machine
8718 @cindex compiler version, specifying
8719 @cindex target machine, specifying
8721 The usual way to run GCC is to run the executable called @file{gcc}, or
8722 @file{<machine>-gcc} when cross-compiling, or
8723 @file{<machine>-gcc-<version>} to run a version other than the one that
8724 was installed last.  Sometimes this is inconvenient, so GCC provides
8725 options that will switch to another cross-compiler or version.
8727 @table @gcctabopt
8728 @item -b @var{machine}
8729 @opindex b
8730 The argument @var{machine} specifies the target machine for compilation.
8732 The value to use for @var{machine} is the same as was specified as the
8733 machine type when configuring GCC as a cross-compiler.  For
8734 example, if a cross-compiler was configured with @samp{configure
8735 arm-elf}, meaning to compile for an arm processor with elf binaries,
8736 then you would specify @option{-b arm-elf} to run that cross compiler.
8737 Because there are other options beginning with @option{-b}, the
8738 configuration must contain a hyphen, or @option{-b} alone should be one
8739 argument followed by the configuration in the next argument.
8741 @item -V @var{version}
8742 @opindex V
8743 The argument @var{version} specifies which version of GCC to run.
8744 This is useful when multiple versions are installed.  For example,
8745 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8746 @end table
8748 The @option{-V} and @option{-b} options work by running the
8749 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8750 use them if you can just run that directly.
8752 @node Submodel Options
8753 @section Hardware Models and Configurations
8754 @cindex submodel options
8755 @cindex specifying hardware config
8756 @cindex hardware models and configurations, specifying
8757 @cindex machine dependent options
8759 Earlier we discussed the standard option @option{-b} which chooses among
8760 different installed compilers for completely different target
8761 machines, such as VAX vs.@: 68000 vs.@: 80386.
8763 In addition, each of these target machine types can have its own
8764 special options, starting with @samp{-m}, to choose among various
8765 hardware models or configurations---for example, 68010 vs 68020,
8766 floating coprocessor or none.  A single installed version of the
8767 compiler can compile for any model or configuration, according to the
8768 options specified.
8770 Some configurations of the compiler also support additional special
8771 options, usually for compatibility with other compilers on the same
8772 platform.
8774 @c This list is ordered alphanumerically by subsection name.
8775 @c It should be the same order and spelling as these options are listed
8776 @c in Machine Dependent Options
8778 @menu
8779 * ARC Options::
8780 * ARM Options::
8781 * AVR Options::
8782 * Blackfin Options::
8783 * CRIS Options::
8784 * CRX Options::
8785 * Darwin Options::
8786 * DEC Alpha Options::
8787 * DEC Alpha/VMS Options::
8788 * FRV Options::
8789 * GNU/Linux Options::
8790 * H8/300 Options::
8791 * HPPA Options::
8792 * i386 and x86-64 Options::
8793 * IA-64 Options::
8794 * M32C Options::
8795 * M32R/D Options::
8796 * M680x0 Options::
8797 * M68hc1x Options::
8798 * MCore Options::
8799 * MIPS Options::
8800 * MMIX Options::
8801 * MN10300 Options::
8802 * PDP-11 Options::
8803 * picoChip Options::
8804 * PowerPC Options::
8805 * RS/6000 and PowerPC Options::
8806 * S/390 and zSeries Options::
8807 * Score Options::
8808 * SH Options::
8809 * SPARC Options::
8810 * SPU Options::
8811 * System V Options::
8812 * V850 Options::
8813 * VAX Options::
8814 * VxWorks Options::
8815 * x86-64 Options::
8816 * Xstormy16 Options::
8817 * Xtensa Options::
8818 * zSeries Options::
8819 @end menu
8821 @node ARC Options
8822 @subsection ARC Options
8823 @cindex ARC Options
8825 These options are defined for ARC implementations:
8827 @table @gcctabopt
8828 @item -EL
8829 @opindex EL
8830 Compile code for little endian mode.  This is the default.
8832 @item -EB
8833 @opindex EB
8834 Compile code for big endian mode.
8836 @item -mmangle-cpu
8837 @opindex mmangle-cpu
8838 Prepend the name of the cpu to all public symbol names.
8839 In multiple-processor systems, there are many ARC variants with different
8840 instruction and register set characteristics.  This flag prevents code
8841 compiled for one cpu to be linked with code compiled for another.
8842 No facility exists for handling variants that are ``almost identical''.
8843 This is an all or nothing option.
8845 @item -mcpu=@var{cpu}
8846 @opindex mcpu
8847 Compile code for ARC variant @var{cpu}.
8848 Which variants are supported depend on the configuration.
8849 All variants support @option{-mcpu=base}, this is the default.
8851 @item -mtext=@var{text-section}
8852 @itemx -mdata=@var{data-section}
8853 @itemx -mrodata=@var{readonly-data-section}
8854 @opindex mtext
8855 @opindex mdata
8856 @opindex mrodata
8857 Put functions, data, and readonly data in @var{text-section},
8858 @var{data-section}, and @var{readonly-data-section} respectively
8859 by default.  This can be overridden with the @code{section} attribute.
8860 @xref{Variable Attributes}.
8862 @item -mfix-cortex-m3-ldrd
8863 @opindex mfix-cortex-m3-ldrd
8864 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
8865 with overlapping destination and base registers are used.  This option avoids
8866 generating these instructions.  This option is enabled by default when
8867 @option{-mcpu=cortex-m3} is specified.
8869 @end table
8871 @node ARM Options
8872 @subsection ARM Options
8873 @cindex ARM options
8875 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8876 architectures:
8878 @table @gcctabopt
8879 @item -mabi=@var{name}
8880 @opindex mabi
8881 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8882 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8884 @item -mapcs-frame
8885 @opindex mapcs-frame
8886 Generate a stack frame that is compliant with the ARM Procedure Call
8887 Standard for all functions, even if this is not strictly necessary for
8888 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8889 with this option will cause the stack frames not to be generated for
8890 leaf functions.  The default is @option{-mno-apcs-frame}.
8892 @item -mapcs
8893 @opindex mapcs
8894 This is a synonym for @option{-mapcs-frame}.
8896 @ignore
8897 @c not currently implemented
8898 @item -mapcs-stack-check
8899 @opindex mapcs-stack-check
8900 Generate code to check the amount of stack space available upon entry to
8901 every function (that actually uses some stack space).  If there is
8902 insufficient space available then either the function
8903 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8904 called, depending upon the amount of stack space required.  The run time
8905 system is required to provide these functions.  The default is
8906 @option{-mno-apcs-stack-check}, since this produces smaller code.
8908 @c not currently implemented
8909 @item -mapcs-float
8910 @opindex mapcs-float
8911 Pass floating point arguments using the float point registers.  This is
8912 one of the variants of the APCS@.  This option is recommended if the
8913 target hardware has a floating point unit or if a lot of floating point
8914 arithmetic is going to be performed by the code.  The default is
8915 @option{-mno-apcs-float}, since integer only code is slightly increased in
8916 size if @option{-mapcs-float} is used.
8918 @c not currently implemented
8919 @item -mapcs-reentrant
8920 @opindex mapcs-reentrant
8921 Generate reentrant, position independent code.  The default is
8922 @option{-mno-apcs-reentrant}.
8923 @end ignore
8925 @item -mthumb-interwork
8926 @opindex mthumb-interwork
8927 Generate code which supports calling between the ARM and Thumb
8928 instruction sets.  Without this option the two instruction sets cannot
8929 be reliably used inside one program.  The default is
8930 @option{-mno-thumb-interwork}, since slightly larger code is generated
8931 when @option{-mthumb-interwork} is specified.
8933 @item -mno-sched-prolog
8934 @opindex mno-sched-prolog
8935 Prevent the reordering of instructions in the function prolog, or the
8936 merging of those instruction with the instructions in the function's
8937 body.  This means that all functions will start with a recognizable set
8938 of instructions (or in fact one of a choice from a small set of
8939 different function prologues), and this information can be used to
8940 locate the start if functions inside an executable piece of code.  The
8941 default is @option{-msched-prolog}.
8943 @item -mfloat-abi=@var{name}
8944 @opindex mfloat-abi
8945 Specifies which floating-point ABI to use.  Permissible values
8946 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8948 Specifying @samp{soft} causes GCC to generate output containing 
8949 library calls for floating-point operations.
8950 @samp{softfp} allows the generation of code using hardware floating-point 
8951 instructions, but still uses the soft-float calling conventions.  
8952 @samp{hard} allows generation of floating-point instructions 
8953 and uses FPU-specific calling conventions.
8955 Using @option{-mfloat-abi=hard} with VFP coprocessors is not supported.
8956 Use @option{-mfloat-abi=softfp} with the appropriate @option{-mfpu} option
8957 to allow the compiler to generate code that makes use of the hardware
8958 floating-point capabilities for these CPUs.
8960 The default depends on the specific target configuration.  Note that
8961 the hard-float and soft-float ABIs are not link-compatible; you must
8962 compile your entire program with the same ABI, and link with a
8963 compatible set of libraries.
8965 @item -mhard-float
8966 @opindex mhard-float
8967 Equivalent to @option{-mfloat-abi=hard}.
8969 @item -msoft-float
8970 @opindex msoft-float
8971 Equivalent to @option{-mfloat-abi=soft}.
8973 @item -mlittle-endian
8974 @opindex mlittle-endian
8975 Generate code for a processor running in little-endian mode.  This is
8976 the default for all standard configurations.
8978 @item -mbig-endian
8979 @opindex mbig-endian
8980 Generate code for a processor running in big-endian mode; the default is
8981 to compile code for a little-endian processor.
8983 @item -mwords-little-endian
8984 @opindex mwords-little-endian
8985 This option only applies when generating code for big-endian processors.
8986 Generate code for a little-endian word order but a big-endian byte
8987 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8988 option should only be used if you require compatibility with code for
8989 big-endian ARM processors generated by versions of the compiler prior to
8990 2.8.
8992 @item -mcpu=@var{name}
8993 @opindex mcpu
8994 This specifies the name of the target ARM processor.  GCC uses this name
8995 to determine what kind of instructions it can emit when generating
8996 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8997 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8998 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8999 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9000 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9001 @samp{arm720},
9002 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9003 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9004 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9005 @samp{strongarm1110},
9006 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9007 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9008 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9009 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9010 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9011 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9012 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9013 @samp{cortex-a8}, @samp{cortex-a9},
9014 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9015 @samp{cortex-m1},
9016 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9018 @item -mtune=@var{name}
9019 @opindex mtune
9020 This option is very similar to the @option{-mcpu=} option, except that
9021 instead of specifying the actual target processor type, and hence
9022 restricting which instructions can be used, it specifies that GCC should
9023 tune the performance of the code as if the target were of the type
9024 specified in this option, but still choosing the instructions that it
9025 will generate based on the cpu specified by a @option{-mcpu=} option.
9026 For some ARM implementations better performance can be obtained by using
9027 this option.
9029 @item -march=@var{name}
9030 @opindex march
9031 This specifies the name of the target ARM architecture.  GCC uses this
9032 name to determine what kind of instructions it can emit when generating
9033 assembly code.  This option can be used in conjunction with or instead
9034 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9035 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9036 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9037 @samp{armv6}, @samp{armv6j},
9038 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9039 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9040 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9042 @item -mfpu=@var{name}
9043 @itemx -mfpe=@var{number}
9044 @itemx -mfp=@var{number}
9045 @opindex mfpu
9046 @opindex mfpe
9047 @opindex mfp
9048 This specifies what floating point hardware (or hardware emulation) is
9049 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9050 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-d16} and
9051 @samp{neon}.  @option{-mfp} and @option{-mfpe}
9052 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
9053 with older versions of GCC@.
9055 If @option{-msoft-float} is specified this specifies the format of
9056 floating point values.
9058 @item -mstructure-size-boundary=@var{n}
9059 @opindex mstructure-size-boundary
9060 The size of all structures and unions will be rounded up to a multiple
9061 of the number of bits set by this option.  Permissible values are 8, 32
9062 and 64.  The default value varies for different toolchains.  For the COFF
9063 targeted toolchain the default value is 8.  A value of 64 is only allowed
9064 if the underlying ABI supports it.
9066 Specifying the larger number can produce faster, more efficient code, but
9067 can also increase the size of the program.  Different values are potentially
9068 incompatible.  Code compiled with one value cannot necessarily expect to
9069 work with code or libraries compiled with another value, if they exchange
9070 information using structures or unions.
9072 @item -mabort-on-noreturn
9073 @opindex mabort-on-noreturn
9074 Generate a call to the function @code{abort} at the end of a
9075 @code{noreturn} function.  It will be executed if the function tries to
9076 return.
9078 @item -mlong-calls
9079 @itemx -mno-long-calls
9080 @opindex mlong-calls
9081 @opindex mno-long-calls
9082 Tells the compiler to perform function calls by first loading the
9083 address of the function into a register and then performing a subroutine
9084 call on this register.  This switch is needed if the target function
9085 will lie outside of the 64 megabyte addressing range of the offset based
9086 version of subroutine call instruction.
9088 Even if this switch is enabled, not all function calls will be turned
9089 into long calls.  The heuristic is that static functions, functions
9090 which have the @samp{short-call} attribute, functions that are inside
9091 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9092 definitions have already been compiled within the current compilation
9093 unit, will not be turned into long calls.  The exception to this rule is
9094 that weak function definitions, functions with the @samp{long-call}
9095 attribute or the @samp{section} attribute, and functions that are within
9096 the scope of a @samp{#pragma long_calls} directive, will always be
9097 turned into long calls.
9099 This feature is not enabled by default.  Specifying
9100 @option{-mno-long-calls} will restore the default behavior, as will
9101 placing the function calls within the scope of a @samp{#pragma
9102 long_calls_off} directive.  Note these switches have no effect on how
9103 the compiler generates code to handle function calls via function
9104 pointers.
9106 @item -mnop-fun-dllimport
9107 @opindex mnop-fun-dllimport
9108 Disable support for the @code{dllimport} attribute.
9110 @item -msingle-pic-base
9111 @opindex msingle-pic-base
9112 Treat the register used for PIC addressing as read-only, rather than
9113 loading it in the prologue for each function.  The run-time system is
9114 responsible for initializing this register with an appropriate value
9115 before execution begins.
9117 @item -mpic-register=@var{reg}
9118 @opindex mpic-register
9119 Specify the register to be used for PIC addressing.  The default is R10
9120 unless stack-checking is enabled, when R9 is used.
9122 @item -mcirrus-fix-invalid-insns
9123 @opindex mcirrus-fix-invalid-insns
9124 @opindex mno-cirrus-fix-invalid-insns
9125 Insert NOPs into the instruction stream to in order to work around
9126 problems with invalid Maverick instruction combinations.  This option
9127 is only valid if the @option{-mcpu=ep9312} option has been used to
9128 enable generation of instructions for the Cirrus Maverick floating
9129 point co-processor.  This option is not enabled by default, since the
9130 problem is only present in older Maverick implementations.  The default
9131 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9132 switch.
9134 @item -mpoke-function-name
9135 @opindex mpoke-function-name
9136 Write the name of each function into the text section, directly
9137 preceding the function prologue.  The generated code is similar to this:
9139 @smallexample
9140      t0
9141          .ascii "arm_poke_function_name", 0
9142          .align
9143      t1
9144          .word 0xff000000 + (t1 - t0)
9145      arm_poke_function_name
9146          mov     ip, sp
9147          stmfd   sp!, @{fp, ip, lr, pc@}
9148          sub     fp, ip, #4
9149 @end smallexample
9151 When performing a stack backtrace, code can inspect the value of
9152 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9153 location @code{pc - 12} and the top 8 bits are set, then we know that
9154 there is a function name embedded immediately preceding this location
9155 and has length @code{((pc[-3]) & 0xff000000)}.
9157 @item -mthumb
9158 @opindex mthumb
9159 Generate code for the Thumb instruction set.  The default is to
9160 use the 32-bit ARM instruction set.
9161 This option automatically enables either 16-bit Thumb-1 or
9162 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9163 and @option{-march=@var{name}} options.
9165 @item -mtpcs-frame
9166 @opindex mtpcs-frame
9167 Generate a stack frame that is compliant with the Thumb Procedure Call
9168 Standard for all non-leaf functions.  (A leaf function is one that does
9169 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9171 @item -mtpcs-leaf-frame
9172 @opindex mtpcs-leaf-frame
9173 Generate a stack frame that is compliant with the Thumb Procedure Call
9174 Standard for all leaf functions.  (A leaf function is one that does
9175 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9177 @item -mcallee-super-interworking
9178 @opindex mcallee-super-interworking
9179 Gives all externally visible functions in the file being compiled an ARM
9180 instruction set header which switches to Thumb mode before executing the
9181 rest of the function.  This allows these functions to be called from
9182 non-interworking code.
9184 @item -mcaller-super-interworking
9185 @opindex mcaller-super-interworking
9186 Allows calls via function pointers (including virtual functions) to
9187 execute correctly regardless of whether the target code has been
9188 compiled for interworking or not.  There is a small overhead in the cost
9189 of executing a function pointer if this option is enabled.
9191 @item -mtp=@var{name}
9192 @opindex mtp
9193 Specify the access model for the thread local storage pointer.  The valid
9194 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9195 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9196 (supported in the arm6k architecture), and @option{auto}, which uses the
9197 best available method for the selected processor.  The default setting is
9198 @option{auto}.
9200 @item -mword-relocations
9201 @opindex mword-relocations
9202 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9203 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9204 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9205 is specified.
9207 @end table
9209 @node AVR Options
9210 @subsection AVR Options
9211 @cindex AVR Options
9213 These options are defined for AVR implementations:
9215 @table @gcctabopt
9216 @item -mmcu=@var{mcu}
9217 @opindex mmcu
9218 Specify ATMEL AVR instruction set or MCU type.
9220 Instruction set avr1 is for the minimal AVR core, not supported by the C
9221 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9222 attiny11, attiny12, attiny15, attiny28).
9224 Instruction set avr2 (default) is for the classic AVR core with up to
9225 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9226 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9227 at90c8534, at90s8535).
9229 Instruction set avr3 is for the classic AVR core with up to 128K program
9230 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9232 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9233 memory space (MCU types: atmega8, atmega83, atmega85).
9235 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9236 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9237 atmega64, atmega128, at43usb355, at94k).
9239 @item -msize
9240 @opindex msize
9241 Output instruction sizes to the asm file.
9243 @item -minit-stack=@var{N}
9244 @opindex minit-stack
9245 Specify the initial stack address, which may be a symbol or numeric value,
9246 @samp{__stack} is the default.
9248 @item -mno-interrupts
9249 @opindex mno-interrupts
9250 Generated code is not compatible with hardware interrupts.
9251 Code size will be smaller.
9253 @item -mcall-prologues
9254 @opindex mcall-prologues
9255 Functions prologues/epilogues expanded as call to appropriate
9256 subroutines.  Code size will be smaller.
9258 @item -mno-tablejump
9259 @opindex mno-tablejump
9260 Do not generate tablejump insns which sometimes increase code size.
9262 @item -mtiny-stack
9263 @opindex mtiny-stack
9264 Change only the low 8 bits of the stack pointer.
9266 @item -mint8
9267 @opindex mint8
9268 Assume int to be 8 bit integer.  This affects the sizes of all types: A
9269 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
9270 and long long will be 4 bytes.  Please note that this option does not
9271 comply to the C standards, but it will provide you with smaller code
9272 size.
9273 @end table
9275 @node Blackfin Options
9276 @subsection Blackfin Options
9277 @cindex Blackfin Options
9279 @table @gcctabopt
9280 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
9281 @opindex mcpu=
9282 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
9283 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
9284 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
9285 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
9286 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
9287 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
9288 @samp{bf561}.
9289 The optional @var{sirevision} specifies the silicon revision of the target
9290 Blackfin processor.  Any workarounds available for the targeted silicon revision
9291 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
9292 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
9293 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
9294 hexadecimal digits representing the major and minor numbers in the silicon
9295 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
9296 is not defined.  If @var{sirevision} is @samp{any}, the
9297 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
9298 If this optional @var{sirevision} is not used, GCC assumes the latest known
9299 silicon revision of the targeted Blackfin processor.
9301 Support for @samp{bf561} is incomplete.  For @samp{bf561},
9302 Only the processor macro is defined.
9303 Without this option, @samp{bf532} is used as the processor by default.
9304 The corresponding predefined processor macros for @var{cpu} is to
9305 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
9306 provided by libgloss to be linked in if @option{-msim} is not given.
9308 @item -msim
9309 @opindex msim
9310 Specifies that the program will be run on the simulator.  This causes
9311 the simulator BSP provided by libgloss to be linked in.  This option
9312 has effect only for @samp{bfin-elf} toolchain.
9313 Certain other options, such as @option{-mid-shared-library} and
9314 @option{-mfdpic}, imply @option{-msim}.
9316 @item -momit-leaf-frame-pointer
9317 @opindex momit-leaf-frame-pointer
9318 Don't keep the frame pointer in a register for leaf functions.  This
9319 avoids the instructions to save, set up and restore frame pointers and
9320 makes an extra register available in leaf functions.  The option
9321 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9322 which might make debugging harder.
9324 @item -mspecld-anomaly
9325 @opindex mspecld-anomaly
9326 When enabled, the compiler will ensure that the generated code does not
9327 contain speculative loads after jump instructions. If this option is used,
9328 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
9330 @item -mno-specld-anomaly
9331 @opindex mno-specld-anomaly
9332 Don't generate extra code to prevent speculative loads from occurring.
9334 @item -mcsync-anomaly
9335 @opindex mcsync-anomaly
9336 When enabled, the compiler will ensure that the generated code does not
9337 contain CSYNC or SSYNC instructions too soon after conditional branches.
9338 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
9340 @item -mno-csync-anomaly
9341 @opindex mno-csync-anomaly
9342 Don't generate extra code to prevent CSYNC or SSYNC instructions from
9343 occurring too soon after a conditional branch.
9345 @item -mlow-64k
9346 @opindex mlow-64k
9347 When enabled, the compiler is free to take advantage of the knowledge that
9348 the entire program fits into the low 64k of memory.
9350 @item -mno-low-64k
9351 @opindex mno-low-64k
9352 Assume that the program is arbitrarily large.  This is the default.
9354 @item -mstack-check-l1
9355 @opindex mstack-check-l1
9356 Do stack checking using information placed into L1 scratchpad memory by the
9357 uClinux kernel.
9359 @item -mid-shared-library
9360 @opindex mid-shared-library
9361 Generate code that supports shared libraries via the library ID method.
9362 This allows for execute in place and shared libraries in an environment
9363 without virtual memory management.  This option implies @option{-fPIC}.
9364 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9366 @item -mno-id-shared-library
9367 @opindex mno-id-shared-library
9368 Generate code that doesn't assume ID based shared libraries are being used.
9369 This is the default.
9371 @item -mleaf-id-shared-library
9372 @opindex mleaf-id-shared-library
9373 Generate code that supports shared libraries via the library ID method,
9374 but assumes that this library or executable won't link against any other
9375 ID shared libraries.  That allows the compiler to use faster code for jumps
9376 and calls.
9378 @item -mno-leaf-id-shared-library
9379 @opindex mno-leaf-id-shared-library
9380 Do not assume that the code being compiled won't link against any ID shared
9381 libraries.  Slower code will be generated for jump and call insns.
9383 @item -mshared-library-id=n
9384 @opindex mshared-library-id
9385 Specified the identification number of the ID based shared library being
9386 compiled.  Specifying a value of 0 will generate more compact code, specifying
9387 other values will force the allocation of that number to the current
9388 library but is no more space or time efficient than omitting this option.
9390 @item -msep-data
9391 @opindex msep-data
9392 Generate code that allows the data segment to be located in a different
9393 area of memory from the text segment.  This allows for execute in place in
9394 an environment without virtual memory management by eliminating relocations
9395 against the text section.
9397 @item -mno-sep-data
9398 @opindex mno-sep-data
9399 Generate code that assumes that the data segment follows the text segment.
9400 This is the default.
9402 @item -mlong-calls
9403 @itemx -mno-long-calls
9404 @opindex mlong-calls
9405 @opindex mno-long-calls
9406 Tells the compiler to perform function calls by first loading the
9407 address of the function into a register and then performing a subroutine
9408 call on this register.  This switch is needed if the target function
9409 will lie outside of the 24 bit addressing range of the offset based
9410 version of subroutine call instruction.
9412 This feature is not enabled by default.  Specifying
9413 @option{-mno-long-calls} will restore the default behavior.  Note these
9414 switches have no effect on how the compiler generates code to handle
9415 function calls via function pointers.
9417 @item -mfast-fp
9418 @opindex mfast-fp
9419 Link with the fast floating-point library. This library relaxes some of
9420 the IEEE floating-point standard's rules for checking inputs against
9421 Not-a-Number (NAN), in the interest of performance.
9423 @item -minline-plt
9424 @opindex minline-plt
9425 Enable inlining of PLT entries in function calls to functions that are
9426 not known to bind locally.  It has no effect without @option{-mfdpic}.
9428 @item -mmulticore
9429 @opindex mmulticore
9430 Build standalone application for multicore Blackfin processor. Proper
9431 start files and link scripts will be used to support multicore.
9432 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9433 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9434 @option{-mcorea} or @option{-mcoreb}. If it's used without
9435 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9436 programming model is used. In this model, the main function of Core B
9437 should be named as coreb_main. If it's used with @option{-mcorea} or
9438 @option{-mcoreb}, one application per core programming model is used.
9439 If this option is not used, single core application programming
9440 model is used.
9442 @item -mcorea
9443 @opindex mcorea
9444 Build standalone application for Core A of BF561 when using
9445 one application per core programming model. Proper start files
9446 and link scripts will be used to support Core A. This option
9447 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9449 @item -mcoreb
9450 @opindex mcoreb
9451 Build standalone application for Core B of BF561 when using
9452 one application per core programming model. Proper start files
9453 and link scripts will be used to support Core B. This option
9454 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9455 should be used instead of main. It must be used with
9456 @option{-mmulticore}. 
9458 @item -msdram
9459 @opindex msdram
9460 Build standalone application for SDRAM. Proper start files and
9461 link scripts will be used to put the application into SDRAM.
9462 Loader should initialize SDRAM before loading the application
9463 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9465 @item -micplb
9466 @opindex micplb
9467 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
9468 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
9469 are enabled; for standalone applications the default is off.
9470 @end table
9472 @node CRIS Options
9473 @subsection CRIS Options
9474 @cindex CRIS Options
9476 These options are defined specifically for the CRIS ports.
9478 @table @gcctabopt
9479 @item -march=@var{architecture-type}
9480 @itemx -mcpu=@var{architecture-type}
9481 @opindex march
9482 @opindex mcpu
9483 Generate code for the specified architecture.  The choices for
9484 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9485 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9486 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9487 @samp{v10}.
9489 @item -mtune=@var{architecture-type}
9490 @opindex mtune
9491 Tune to @var{architecture-type} everything applicable about the generated
9492 code, except for the ABI and the set of available instructions.  The
9493 choices for @var{architecture-type} are the same as for
9494 @option{-march=@var{architecture-type}}.
9496 @item -mmax-stack-frame=@var{n}
9497 @opindex mmax-stack-frame
9498 Warn when the stack frame of a function exceeds @var{n} bytes.
9500 @item -metrax4
9501 @itemx -metrax100
9502 @opindex metrax4
9503 @opindex metrax100
9504 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9505 @option{-march=v3} and @option{-march=v8} respectively.
9507 @item -mmul-bug-workaround
9508 @itemx -mno-mul-bug-workaround
9509 @opindex mmul-bug-workaround
9510 @opindex mno-mul-bug-workaround
9511 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9512 models where it applies.  This option is active by default.
9514 @item -mpdebug
9515 @opindex mpdebug
9516 Enable CRIS-specific verbose debug-related information in the assembly
9517 code.  This option also has the effect to turn off the @samp{#NO_APP}
9518 formatted-code indicator to the assembler at the beginning of the
9519 assembly file.
9521 @item -mcc-init
9522 @opindex mcc-init
9523 Do not use condition-code results from previous instruction; always emit
9524 compare and test instructions before use of condition codes.
9526 @item -mno-side-effects
9527 @opindex mno-side-effects
9528 Do not emit instructions with side-effects in addressing modes other than
9529 post-increment.
9531 @item -mstack-align
9532 @itemx -mno-stack-align
9533 @itemx -mdata-align
9534 @itemx -mno-data-align
9535 @itemx -mconst-align
9536 @itemx -mno-const-align
9537 @opindex mstack-align
9538 @opindex mno-stack-align
9539 @opindex mdata-align
9540 @opindex mno-data-align
9541 @opindex mconst-align
9542 @opindex mno-const-align
9543 These options (no-options) arranges (eliminate arrangements) for the
9544 stack-frame, individual data and constants to be aligned for the maximum
9545 single data access size for the chosen CPU model.  The default is to
9546 arrange for 32-bit alignment.  ABI details such as structure layout are
9547 not affected by these options.
9549 @item -m32-bit
9550 @itemx -m16-bit
9551 @itemx -m8-bit
9552 @opindex m32-bit
9553 @opindex m16-bit
9554 @opindex m8-bit
9555 Similar to the stack- data- and const-align options above, these options
9556 arrange for stack-frame, writable data and constants to all be 32-bit,
9557 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9559 @item -mno-prologue-epilogue
9560 @itemx -mprologue-epilogue
9561 @opindex mno-prologue-epilogue
9562 @opindex mprologue-epilogue
9563 With @option{-mno-prologue-epilogue}, the normal function prologue and
9564 epilogue that sets up the stack-frame are omitted and no return
9565 instructions or return sequences are generated in the code.  Use this
9566 option only together with visual inspection of the compiled code: no
9567 warnings or errors are generated when call-saved registers must be saved,
9568 or storage for local variable needs to be allocated.
9570 @item -mno-gotplt
9571 @itemx -mgotplt
9572 @opindex mno-gotplt
9573 @opindex mgotplt
9574 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9575 instruction sequences that load addresses for functions from the PLT part
9576 of the GOT rather than (traditional on other architectures) calls to the
9577 PLT@.  The default is @option{-mgotplt}.
9579 @item -melf
9580 @opindex melf
9581 Legacy no-op option only recognized with the cris-axis-elf and
9582 cris-axis-linux-gnu targets.
9584 @item -mlinux
9585 @opindex mlinux
9586 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9588 @item -sim
9589 @opindex sim
9590 This option, recognized for the cris-axis-elf arranges
9591 to link with input-output functions from a simulator library.  Code,
9592 initialized data and zero-initialized data are allocated consecutively.
9594 @item -sim2
9595 @opindex sim2
9596 Like @option{-sim}, but pass linker options to locate initialized data at
9597 0x40000000 and zero-initialized data at 0x80000000.
9598 @end table
9600 @node CRX Options
9601 @subsection CRX Options
9602 @cindex CRX Options
9604 These options are defined specifically for the CRX ports.
9606 @table @gcctabopt
9608 @item -mmac
9609 @opindex mmac
9610 Enable the use of multiply-accumulate instructions. Disabled by default.
9612 @item -mpush-args
9613 @opindex mpush-args
9614 Push instructions will be used to pass outgoing arguments when functions
9615 are called. Enabled by default.
9616 @end table
9618 @node Darwin Options
9619 @subsection Darwin Options
9620 @cindex Darwin options
9622 These options are defined for all architectures running the Darwin operating
9623 system.
9625 FSF GCC on Darwin does not create ``fat'' object files; it will create
9626 an object file for the single architecture that it was built to
9627 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9628 @option{-arch} options are used; it does so by running the compiler or
9629 linker multiple times and joining the results together with
9630 @file{lipo}.
9632 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9633 @samp{i686}) is determined by the flags that specify the ISA
9634 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9635 @option{-force_cpusubtype_ALL} option can be used to override this.
9637 The Darwin tools vary in their behavior when presented with an ISA
9638 mismatch.  The assembler, @file{as}, will only permit instructions to
9639 be used that are valid for the subtype of the file it is generating,
9640 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9641 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9642 and print an error if asked to create a shared library with a less
9643 restrictive subtype than its input files (for instance, trying to put
9644 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9645 for executables, @file{ld}, will quietly give the executable the most
9646 restrictive subtype of any of its input files.
9648 @table @gcctabopt
9649 @item -F@var{dir}
9650 @opindex F
9651 Add the framework directory @var{dir} to the head of the list of
9652 directories to be searched for header files.  These directories are
9653 interleaved with those specified by @option{-I} options and are
9654 scanned in a left-to-right order.
9656 A framework directory is a directory with frameworks in it.  A
9657 framework is a directory with a @samp{"Headers"} and/or
9658 @samp{"PrivateHeaders"} directory contained directly in it that ends
9659 in @samp{".framework"}.  The name of a framework is the name of this
9660 directory excluding the @samp{".framework"}.  Headers associated with
9661 the framework are found in one of those two directories, with
9662 @samp{"Headers"} being searched first.  A subframework is a framework
9663 directory that is in a framework's @samp{"Frameworks"} directory.
9664 Includes of subframework headers can only appear in a header of a
9665 framework that contains the subframework, or in a sibling subframework
9666 header.  Two subframeworks are siblings if they occur in the same
9667 framework.  A subframework should not have the same name as a
9668 framework, a warning will be issued if this is violated.  Currently a
9669 subframework cannot have subframeworks, in the future, the mechanism
9670 may be extended to support this.  The standard frameworks can be found
9671 in @samp{"/System/Library/Frameworks"} and
9672 @samp{"/Library/Frameworks"}.  An example include looks like
9673 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9674 the name of the framework and header.h is found in the
9675 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9677 @item -iframework@var{dir}
9678 @opindex iframework
9679 Like @option{-F} except the directory is a treated as a system
9680 directory.  The main difference between this @option{-iframework} and
9681 @option{-F} is that with @option{-iframework} the compiler does not
9682 warn about constructs contained within header files found via
9683 @var{dir}.  This option is valid only for the C family of languages.
9685 @item -gused
9686 @opindex gused
9687 Emit debugging information for symbols that are used.  For STABS
9688 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9689 This is by default ON@.
9691 @item -gfull
9692 @opindex gfull
9693 Emit debugging information for all symbols and types.
9695 @item -mmacosx-version-min=@var{version}
9696 The earliest version of MacOS X that this executable will run on
9697 is @var{version}.  Typical values of @var{version} include @code{10.1},
9698 @code{10.2}, and @code{10.3.9}.
9700 If the compiler was built to use the system's headers by default,
9701 then the default for this option is the system version on which the
9702 compiler is running, otherwise the default is to make choices which
9703 are compatible with as many systems and code bases as possible.
9705 @item -mkernel
9706 @opindex mkernel
9707 Enable kernel development mode.  The @option{-mkernel} option sets
9708 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9709 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9710 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9711 applicable.  This mode also sets @option{-mno-altivec},
9712 @option{-msoft-float}, @option{-fno-builtin} and
9713 @option{-mlong-branch} for PowerPC targets.
9715 @item -mone-byte-bool
9716 @opindex mone-byte-bool
9717 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9718 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9719 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9720 option has no effect on x86.
9722 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9723 to generate code that is not binary compatible with code generated
9724 without that switch.  Using this switch may require recompiling all
9725 other modules in a program, including system libraries.  Use this
9726 switch to conform to a non-default data model.
9728 @item -mfix-and-continue
9729 @itemx -ffix-and-continue
9730 @itemx -findirect-data
9731 @opindex mfix-and-continue
9732 @opindex ffix-and-continue
9733 @opindex findirect-data
9734 Generate code suitable for fast turn around development.  Needed to
9735 enable gdb to dynamically load @code{.o} files into already running
9736 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9737 are provided for backwards compatibility.
9739 @item -all_load
9740 @opindex all_load
9741 Loads all members of static archive libraries.
9742 See man ld(1) for more information.
9744 @item -arch_errors_fatal
9745 @opindex arch_errors_fatal
9746 Cause the errors having to do with files that have the wrong architecture
9747 to be fatal.
9749 @item -bind_at_load
9750 @opindex bind_at_load
9751 Causes the output file to be marked such that the dynamic linker will
9752 bind all undefined references when the file is loaded or launched.
9754 @item -bundle
9755 @opindex bundle
9756 Produce a Mach-o bundle format file.
9757 See man ld(1) for more information.
9759 @item -bundle_loader @var{executable}
9760 @opindex bundle_loader
9761 This option specifies the @var{executable} that will be loading the build
9762 output file being linked.  See man ld(1) for more information.
9764 @item -dynamiclib
9765 @opindex dynamiclib
9766 When passed this option, GCC will produce a dynamic library instead of
9767 an executable when linking, using the Darwin @file{libtool} command.
9769 @item -force_cpusubtype_ALL
9770 @opindex force_cpusubtype_ALL
9771 This causes GCC's output file to have the @var{ALL} subtype, instead of
9772 one controlled by the @option{-mcpu} or @option{-march} option.
9774 @item -allowable_client  @var{client_name}
9775 @itemx -client_name
9776 @itemx -compatibility_version
9777 @itemx -current_version
9778 @itemx -dead_strip
9779 @itemx -dependency-file
9780 @itemx -dylib_file
9781 @itemx -dylinker_install_name
9782 @itemx -dynamic
9783 @itemx -exported_symbols_list
9784 @itemx -filelist
9785 @itemx -flat_namespace
9786 @itemx -force_flat_namespace
9787 @itemx -headerpad_max_install_names
9788 @itemx -image_base
9789 @itemx -init
9790 @itemx -install_name
9791 @itemx -keep_private_externs
9792 @itemx -multi_module
9793 @itemx -multiply_defined
9794 @itemx -multiply_defined_unused
9795 @itemx -noall_load
9796 @itemx -no_dead_strip_inits_and_terms
9797 @itemx -nofixprebinding
9798 @itemx -nomultidefs
9799 @itemx -noprebind
9800 @itemx -noseglinkedit
9801 @itemx -pagezero_size
9802 @itemx -prebind
9803 @itemx -prebind_all_twolevel_modules
9804 @itemx -private_bundle
9805 @itemx -read_only_relocs
9806 @itemx -sectalign
9807 @itemx -sectobjectsymbols
9808 @itemx -whyload
9809 @itemx -seg1addr
9810 @itemx -sectcreate
9811 @itemx -sectobjectsymbols
9812 @itemx -sectorder
9813 @itemx -segaddr
9814 @itemx -segs_read_only_addr
9815 @itemx -segs_read_write_addr
9816 @itemx -seg_addr_table
9817 @itemx -seg_addr_table_filename
9818 @itemx -seglinkedit
9819 @itemx -segprot
9820 @itemx -segs_read_only_addr
9821 @itemx -segs_read_write_addr
9822 @itemx -single_module
9823 @itemx -static
9824 @itemx -sub_library
9825 @itemx -sub_umbrella
9826 @itemx -twolevel_namespace
9827 @itemx -umbrella
9828 @itemx -undefined
9829 @itemx -unexported_symbols_list
9830 @itemx -weak_reference_mismatches
9831 @itemx -whatsloaded
9832 @opindex allowable_client
9833 @opindex client_name
9834 @opindex compatibility_version
9835 @opindex current_version
9836 @opindex dead_strip
9837 @opindex dependency-file
9838 @opindex dylib_file
9839 @opindex dylinker_install_name
9840 @opindex dynamic
9841 @opindex exported_symbols_list
9842 @opindex filelist
9843 @opindex flat_namespace
9844 @opindex force_flat_namespace
9845 @opindex headerpad_max_install_names
9846 @opindex image_base
9847 @opindex init
9848 @opindex install_name
9849 @opindex keep_private_externs
9850 @opindex multi_module
9851 @opindex multiply_defined
9852 @opindex multiply_defined_unused
9853 @opindex noall_load
9854 @opindex no_dead_strip_inits_and_terms
9855 @opindex nofixprebinding
9856 @opindex nomultidefs
9857 @opindex noprebind
9858 @opindex noseglinkedit
9859 @opindex pagezero_size
9860 @opindex prebind
9861 @opindex prebind_all_twolevel_modules
9862 @opindex private_bundle
9863 @opindex read_only_relocs
9864 @opindex sectalign
9865 @opindex sectobjectsymbols
9866 @opindex whyload
9867 @opindex seg1addr
9868 @opindex sectcreate
9869 @opindex sectobjectsymbols
9870 @opindex sectorder
9871 @opindex segaddr
9872 @opindex segs_read_only_addr
9873 @opindex segs_read_write_addr
9874 @opindex seg_addr_table
9875 @opindex seg_addr_table_filename
9876 @opindex seglinkedit
9877 @opindex segprot
9878 @opindex segs_read_only_addr
9879 @opindex segs_read_write_addr
9880 @opindex single_module
9881 @opindex static
9882 @opindex sub_library
9883 @opindex sub_umbrella
9884 @opindex twolevel_namespace
9885 @opindex umbrella
9886 @opindex undefined
9887 @opindex unexported_symbols_list
9888 @opindex weak_reference_mismatches
9889 @opindex whatsloaded
9890 These options are passed to the Darwin linker.  The Darwin linker man page
9891 describes them in detail.
9892 @end table
9894 @node DEC Alpha Options
9895 @subsection DEC Alpha Options
9897 These @samp{-m} options are defined for the DEC Alpha implementations:
9899 @table @gcctabopt
9900 @item -mno-soft-float
9901 @itemx -msoft-float
9902 @opindex mno-soft-float
9903 @opindex msoft-float
9904 Use (do not use) the hardware floating-point instructions for
9905 floating-point operations.  When @option{-msoft-float} is specified,
9906 functions in @file{libgcc.a} will be used to perform floating-point
9907 operations.  Unless they are replaced by routines that emulate the
9908 floating-point operations, or compiled in such a way as to call such
9909 emulations routines, these routines will issue floating-point
9910 operations.   If you are compiling for an Alpha without floating-point
9911 operations, you must ensure that the library is built so as not to call
9912 them.
9914 Note that Alpha implementations without floating-point operations are
9915 required to have floating-point registers.
9917 @item -mfp-reg
9918 @itemx -mno-fp-regs
9919 @opindex mfp-reg
9920 @opindex mno-fp-regs
9921 Generate code that uses (does not use) the floating-point register set.
9922 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9923 register set is not used, floating point operands are passed in integer
9924 registers as if they were integers and floating-point results are passed
9925 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9926 so any function with a floating-point argument or return value called by code
9927 compiled with @option{-mno-fp-regs} must also be compiled with that
9928 option.
9930 A typical use of this option is building a kernel that does not use,
9931 and hence need not save and restore, any floating-point registers.
9933 @item -mieee
9934 @opindex mieee
9935 The Alpha architecture implements floating-point hardware optimized for
9936 maximum performance.  It is mostly compliant with the IEEE floating
9937 point standard.  However, for full compliance, software assistance is
9938 required.  This option generates code fully IEEE compliant code
9939 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9940 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9941 defined during compilation.  The resulting code is less efficient but is
9942 able to correctly support denormalized numbers and exceptional IEEE
9943 values such as not-a-number and plus/minus infinity.  Other Alpha
9944 compilers call this option @option{-ieee_with_no_inexact}.
9946 @item -mieee-with-inexact
9947 @opindex mieee-with-inexact
9948 This is like @option{-mieee} except the generated code also maintains
9949 the IEEE @var{inexact-flag}.  Turning on this option causes the
9950 generated code to implement fully-compliant IEEE math.  In addition to
9951 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9952 macro.  On some Alpha implementations the resulting code may execute
9953 significantly slower than the code generated by default.  Since there is
9954 very little code that depends on the @var{inexact-flag}, you should
9955 normally not specify this option.  Other Alpha compilers call this
9956 option @option{-ieee_with_inexact}.
9958 @item -mfp-trap-mode=@var{trap-mode}
9959 @opindex mfp-trap-mode
9960 This option controls what floating-point related traps are enabled.
9961 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9962 The trap mode can be set to one of four values:
9964 @table @samp
9965 @item n
9966 This is the default (normal) setting.  The only traps that are enabled
9967 are the ones that cannot be disabled in software (e.g., division by zero
9968 trap).
9970 @item u
9971 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9972 as well.
9974 @item su
9975 Like @samp{u}, but the instructions are marked to be safe for software
9976 completion (see Alpha architecture manual for details).
9978 @item sui
9979 Like @samp{su}, but inexact traps are enabled as well.
9980 @end table
9982 @item -mfp-rounding-mode=@var{rounding-mode}
9983 @opindex mfp-rounding-mode
9984 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9985 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9988 @table @samp
9989 @item n
9990 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9991 the nearest machine number or towards the even machine number in case
9992 of a tie.
9994 @item m
9995 Round towards minus infinity.
9997 @item c
9998 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10000 @item d
10001 Dynamic rounding mode.  A field in the floating point control register
10002 (@var{fpcr}, see Alpha architecture reference manual) controls the
10003 rounding mode in effect.  The C library initializes this register for
10004 rounding towards plus infinity.  Thus, unless your program modifies the
10005 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10006 @end table
10008 @item -mtrap-precision=@var{trap-precision}
10009 @opindex mtrap-precision
10010 In the Alpha architecture, floating point traps are imprecise.  This
10011 means without software assistance it is impossible to recover from a
10012 floating trap and program execution normally needs to be terminated.
10013 GCC can generate code that can assist operating system trap handlers
10014 in determining the exact location that caused a floating point trap.
10015 Depending on the requirements of an application, different levels of
10016 precisions can be selected:
10018 @table @samp
10019 @item p
10020 Program precision.  This option is the default and means a trap handler
10021 can only identify which program caused a floating point exception.
10023 @item f
10024 Function precision.  The trap handler can determine the function that
10025 caused a floating point exception.
10027 @item i
10028 Instruction precision.  The trap handler can determine the exact
10029 instruction that caused a floating point exception.
10030 @end table
10032 Other Alpha compilers provide the equivalent options called
10033 @option{-scope_safe} and @option{-resumption_safe}.
10035 @item -mieee-conformant
10036 @opindex mieee-conformant
10037 This option marks the generated code as IEEE conformant.  You must not
10038 use this option unless you also specify @option{-mtrap-precision=i} and either
10039 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10040 is to emit the line @samp{.eflag 48} in the function prologue of the
10041 generated assembly file.  Under DEC Unix, this has the effect that
10042 IEEE-conformant math library routines will be linked in.
10044 @item -mbuild-constants
10045 @opindex mbuild-constants
10046 Normally GCC examines a 32- or 64-bit integer constant to
10047 see if it can construct it from smaller constants in two or three
10048 instructions.  If it cannot, it will output the constant as a literal and
10049 generate code to load it from the data segment at runtime.
10051 Use this option to require GCC to construct @emph{all} integer constants
10052 using code, even if it takes more instructions (the maximum is six).
10054 You would typically use this option to build a shared library dynamic
10055 loader.  Itself a shared library, it must relocate itself in memory
10056 before it can find the variables and constants in its own data segment.
10058 @item -malpha-as
10059 @itemx -mgas
10060 @opindex malpha-as
10061 @opindex mgas
10062 Select whether to generate code to be assembled by the vendor-supplied
10063 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10065 @item -mbwx
10066 @itemx -mno-bwx
10067 @itemx -mcix
10068 @itemx -mno-cix
10069 @itemx -mfix
10070 @itemx -mno-fix
10071 @itemx -mmax
10072 @itemx -mno-max
10073 @opindex mbwx
10074 @opindex mno-bwx
10075 @opindex mcix
10076 @opindex mno-cix
10077 @opindex mfix
10078 @opindex mno-fix
10079 @opindex mmax
10080 @opindex mno-max
10081 Indicate whether GCC should generate code to use the optional BWX,
10082 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10083 sets supported by the CPU type specified via @option{-mcpu=} option or that
10084 of the CPU on which GCC was built if none was specified.
10086 @item -mfloat-vax
10087 @itemx -mfloat-ieee
10088 @opindex mfloat-vax
10089 @opindex mfloat-ieee
10090 Generate code that uses (does not use) VAX F and G floating point
10091 arithmetic instead of IEEE single and double precision.
10093 @item -mexplicit-relocs
10094 @itemx -mno-explicit-relocs
10095 @opindex mexplicit-relocs
10096 @opindex mno-explicit-relocs
10097 Older Alpha assemblers provided no way to generate symbol relocations
10098 except via assembler macros.  Use of these macros does not allow
10099 optimal instruction scheduling.  GNU binutils as of version 2.12
10100 supports a new syntax that allows the compiler to explicitly mark
10101 which relocations should apply to which instructions.  This option
10102 is mostly useful for debugging, as GCC detects the capabilities of
10103 the assembler when it is built and sets the default accordingly.
10105 @item -msmall-data
10106 @itemx -mlarge-data
10107 @opindex msmall-data
10108 @opindex mlarge-data
10109 When @option{-mexplicit-relocs} is in effect, static data is
10110 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10111 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10112 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10113 16-bit relocations off of the @code{$gp} register.  This limits the
10114 size of the small data area to 64KB, but allows the variables to be
10115 directly accessed via a single instruction.
10117 The default is @option{-mlarge-data}.  With this option the data area
10118 is limited to just below 2GB@.  Programs that require more than 2GB of
10119 data must use @code{malloc} or @code{mmap} to allocate the data in the
10120 heap instead of in the program's data segment.
10122 When generating code for shared libraries, @option{-fpic} implies
10123 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10125 @item -msmall-text
10126 @itemx -mlarge-text
10127 @opindex msmall-text
10128 @opindex mlarge-text
10129 When @option{-msmall-text} is used, the compiler assumes that the
10130 code of the entire program (or shared library) fits in 4MB, and is
10131 thus reachable with a branch instruction.  When @option{-msmall-data}
10132 is used, the compiler can assume that all local symbols share the
10133 same @code{$gp} value, and thus reduce the number of instructions
10134 required for a function call from 4 to 1.
10136 The default is @option{-mlarge-text}.
10138 @item -mcpu=@var{cpu_type}
10139 @opindex mcpu
10140 Set the instruction set and instruction scheduling parameters for
10141 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10142 style name or the corresponding chip number.  GCC supports scheduling
10143 parameters for the EV4, EV5 and EV6 family of processors and will
10144 choose the default values for the instruction set from the processor
10145 you specify.  If you do not specify a processor type, GCC will default
10146 to the processor on which the compiler was built.
10148 Supported values for @var{cpu_type} are
10150 @table @samp
10151 @item ev4
10152 @itemx ev45
10153 @itemx 21064
10154 Schedules as an EV4 and has no instruction set extensions.
10156 @item ev5
10157 @itemx 21164
10158 Schedules as an EV5 and has no instruction set extensions.
10160 @item ev56
10161 @itemx 21164a
10162 Schedules as an EV5 and supports the BWX extension.
10164 @item pca56
10165 @itemx 21164pc
10166 @itemx 21164PC
10167 Schedules as an EV5 and supports the BWX and MAX extensions.
10169 @item ev6
10170 @itemx 21264
10171 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10173 @item ev67
10174 @itemx 21264a
10175 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10176 @end table
10178 @item -mtune=@var{cpu_type}
10179 @opindex mtune
10180 Set only the instruction scheduling parameters for machine type
10181 @var{cpu_type}.  The instruction set is not changed.
10183 @item -mmemory-latency=@var{time}
10184 @opindex mmemory-latency
10185 Sets the latency the scheduler should assume for typical memory
10186 references as seen by the application.  This number is highly
10187 dependent on the memory access patterns used by the application
10188 and the size of the external cache on the machine.
10190 Valid options for @var{time} are
10192 @table @samp
10193 @item @var{number}
10194 A decimal number representing clock cycles.
10196 @item L1
10197 @itemx L2
10198 @itemx L3
10199 @itemx main
10200 The compiler contains estimates of the number of clock cycles for
10201 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10202 (also called Dcache, Scache, and Bcache), as well as to main memory.
10203 Note that L3 is only valid for EV5.
10205 @end table
10206 @end table
10208 @node DEC Alpha/VMS Options
10209 @subsection DEC Alpha/VMS Options
10211 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10213 @table @gcctabopt
10214 @item -mvms-return-codes
10215 @opindex mvms-return-codes
10216 Return VMS condition codes from main.  The default is to return POSIX
10217 style condition (e.g.@: error) codes.
10218 @end table
10220 @node FRV Options
10221 @subsection FRV Options
10222 @cindex FRV Options
10224 @table @gcctabopt
10225 @item -mgpr-32
10226 @opindex mgpr-32
10228 Only use the first 32 general purpose registers.
10230 @item -mgpr-64
10231 @opindex mgpr-64
10233 Use all 64 general purpose registers.
10235 @item -mfpr-32
10236 @opindex mfpr-32
10238 Use only the first 32 floating point registers.
10240 @item -mfpr-64
10241 @opindex mfpr-64
10243 Use all 64 floating point registers
10245 @item -mhard-float
10246 @opindex mhard-float
10248 Use hardware instructions for floating point operations.
10250 @item -msoft-float
10251 @opindex msoft-float
10253 Use library routines for floating point operations.
10255 @item -malloc-cc
10256 @opindex malloc-cc
10258 Dynamically allocate condition code registers.
10260 @item -mfixed-cc
10261 @opindex mfixed-cc
10263 Do not try to dynamically allocate condition code registers, only
10264 use @code{icc0} and @code{fcc0}.
10266 @item -mdword
10267 @opindex mdword
10269 Change ABI to use double word insns.
10271 @item -mno-dword
10272 @opindex mno-dword
10274 Do not use double word instructions.
10276 @item -mdouble
10277 @opindex mdouble
10279 Use floating point double instructions.
10281 @item -mno-double
10282 @opindex mno-double
10284 Do not use floating point double instructions.
10286 @item -mmedia
10287 @opindex mmedia
10289 Use media instructions.
10291 @item -mno-media
10292 @opindex mno-media
10294 Do not use media instructions.
10296 @item -mmuladd
10297 @opindex mmuladd
10299 Use multiply and add/subtract instructions.
10301 @item -mno-muladd
10302 @opindex mno-muladd
10304 Do not use multiply and add/subtract instructions.
10306 @item -mfdpic
10307 @opindex mfdpic
10309 Select the FDPIC ABI, that uses function descriptors to represent
10310 pointers to functions.  Without any PIC/PIE-related options, it
10311 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
10312 assumes GOT entries and small data are within a 12-bit range from the
10313 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
10314 are computed with 32 bits.
10315 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10317 @item -minline-plt
10318 @opindex minline-plt
10320 Enable inlining of PLT entries in function calls to functions that are
10321 not known to bind locally.  It has no effect without @option{-mfdpic}.
10322 It's enabled by default if optimizing for speed and compiling for
10323 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
10324 optimization option such as @option{-O3} or above is present in the
10325 command line.
10327 @item -mTLS
10328 @opindex TLS
10330 Assume a large TLS segment when generating thread-local code.
10332 @item -mtls
10333 @opindex tls
10335 Do not assume a large TLS segment when generating thread-local code.
10337 @item -mgprel-ro
10338 @opindex mgprel-ro
10340 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
10341 that is known to be in read-only sections.  It's enabled by default,
10342 except for @option{-fpic} or @option{-fpie}: even though it may help
10343 make the global offset table smaller, it trades 1 instruction for 4.
10344 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
10345 one of which may be shared by multiple symbols, and it avoids the need
10346 for a GOT entry for the referenced symbol, so it's more likely to be a
10347 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
10349 @item -multilib-library-pic
10350 @opindex multilib-library-pic
10352 Link with the (library, not FD) pic libraries.  It's implied by
10353 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
10354 @option{-fpic} without @option{-mfdpic}.  You should never have to use
10355 it explicitly.
10357 @item -mlinked-fp
10358 @opindex mlinked-fp
10360 Follow the EABI requirement of always creating a frame pointer whenever
10361 a stack frame is allocated.  This option is enabled by default and can
10362 be disabled with @option{-mno-linked-fp}.
10364 @item -mlong-calls
10365 @opindex mlong-calls
10367 Use indirect addressing to call functions outside the current
10368 compilation unit.  This allows the functions to be placed anywhere
10369 within the 32-bit address space.
10371 @item -malign-labels
10372 @opindex malign-labels
10374 Try to align labels to an 8-byte boundary by inserting nops into the
10375 previous packet.  This option only has an effect when VLIW packing
10376 is enabled.  It doesn't create new packets; it merely adds nops to
10377 existing ones.
10379 @item -mlibrary-pic
10380 @opindex mlibrary-pic
10382 Generate position-independent EABI code.
10384 @item -macc-4
10385 @opindex macc-4
10387 Use only the first four media accumulator registers.
10389 @item -macc-8
10390 @opindex macc-8
10392 Use all eight media accumulator registers.
10394 @item -mpack
10395 @opindex mpack
10397 Pack VLIW instructions.
10399 @item -mno-pack
10400 @opindex mno-pack
10402 Do not pack VLIW instructions.
10404 @item -mno-eflags
10405 @opindex mno-eflags
10407 Do not mark ABI switches in e_flags.
10409 @item -mcond-move
10410 @opindex mcond-move
10412 Enable the use of conditional-move instructions (default).
10414 This switch is mainly for debugging the compiler and will likely be removed
10415 in a future version.
10417 @item -mno-cond-move
10418 @opindex mno-cond-move
10420 Disable the use of conditional-move instructions.
10422 This switch is mainly for debugging the compiler and will likely be removed
10423 in a future version.
10425 @item -mscc
10426 @opindex mscc
10428 Enable the use of conditional set instructions (default).
10430 This switch is mainly for debugging the compiler and will likely be removed
10431 in a future version.
10433 @item -mno-scc
10434 @opindex mno-scc
10436 Disable the use of conditional set instructions.
10438 This switch is mainly for debugging the compiler and will likely be removed
10439 in a future version.
10441 @item -mcond-exec
10442 @opindex mcond-exec
10444 Enable the use of conditional execution (default).
10446 This switch is mainly for debugging the compiler and will likely be removed
10447 in a future version.
10449 @item -mno-cond-exec
10450 @opindex mno-cond-exec
10452 Disable the use of conditional execution.
10454 This switch is mainly for debugging the compiler and will likely be removed
10455 in a future version.
10457 @item -mvliw-branch
10458 @opindex mvliw-branch
10460 Run a pass to pack branches into VLIW instructions (default).
10462 This switch is mainly for debugging the compiler and will likely be removed
10463 in a future version.
10465 @item -mno-vliw-branch
10466 @opindex mno-vliw-branch
10468 Do not run a pass to pack branches into VLIW instructions.
10470 This switch is mainly for debugging the compiler and will likely be removed
10471 in a future version.
10473 @item -mmulti-cond-exec
10474 @opindex mmulti-cond-exec
10476 Enable optimization of @code{&&} and @code{||} in conditional execution
10477 (default).
10479 This switch is mainly for debugging the compiler and will likely be removed
10480 in a future version.
10482 @item -mno-multi-cond-exec
10483 @opindex mno-multi-cond-exec
10485 Disable optimization of @code{&&} and @code{||} in conditional execution.
10487 This switch is mainly for debugging the compiler and will likely be removed
10488 in a future version.
10490 @item -mnested-cond-exec
10491 @opindex mnested-cond-exec
10493 Enable nested conditional execution optimizations (default).
10495 This switch is mainly for debugging the compiler and will likely be removed
10496 in a future version.
10498 @item -mno-nested-cond-exec
10499 @opindex mno-nested-cond-exec
10501 Disable nested conditional execution optimizations.
10503 This switch is mainly for debugging the compiler and will likely be removed
10504 in a future version.
10506 @item -moptimize-membar
10507 @opindex moptimize-membar
10509 This switch removes redundant @code{membar} instructions from the
10510 compiler generated code.  It is enabled by default.
10512 @item -mno-optimize-membar
10513 @opindex mno-optimize-membar
10515 This switch disables the automatic removal of redundant @code{membar}
10516 instructions from the generated code.
10518 @item -mtomcat-stats
10519 @opindex mtomcat-stats
10521 Cause gas to print out tomcat statistics.
10523 @item -mcpu=@var{cpu}
10524 @opindex mcpu
10526 Select the processor type for which to generate code.  Possible values are
10527 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10528 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10530 @end table
10532 @node GNU/Linux Options
10533 @subsection GNU/Linux Options
10535 These @samp{-m} options are defined for GNU/Linux targets:
10537 @table @gcctabopt
10538 @item -mglibc
10539 @opindex mglibc
10540 Use the GNU C library instead of uClibc.  This is the default except
10541 on @samp{*-*-linux-*uclibc*} targets.
10543 @item -muclibc
10544 @opindex muclibc
10545 Use uClibc instead of the GNU C library.  This is the default on
10546 @samp{*-*-linux-*uclibc*} targets.
10547 @end table
10549 @node H8/300 Options
10550 @subsection H8/300 Options
10552 These @samp{-m} options are defined for the H8/300 implementations:
10554 @table @gcctabopt
10555 @item -mrelax
10556 @opindex mrelax
10557 Shorten some address references at link time, when possible; uses the
10558 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10559 ld, Using ld}, for a fuller description.
10561 @item -mh
10562 @opindex mh
10563 Generate code for the H8/300H@.
10565 @item -ms
10566 @opindex ms
10567 Generate code for the H8S@.
10569 @item -mn
10570 @opindex mn
10571 Generate code for the H8S and H8/300H in the normal mode.  This switch
10572 must be used either with @option{-mh} or @option{-ms}.
10574 @item -ms2600
10575 @opindex ms2600
10576 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10578 @item -mint32
10579 @opindex mint32
10580 Make @code{int} data 32 bits by default.
10582 @item -malign-300
10583 @opindex malign-300
10584 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10585 The default for the H8/300H and H8S is to align longs and floats on 4
10586 byte boundaries.
10587 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10588 This option has no effect on the H8/300.
10589 @end table
10591 @node HPPA Options
10592 @subsection HPPA Options
10593 @cindex HPPA Options
10595 These @samp{-m} options are defined for the HPPA family of computers:
10597 @table @gcctabopt
10598 @item -march=@var{architecture-type}
10599 @opindex march
10600 Generate code for the specified architecture.  The choices for
10601 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10602 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10603 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10604 architecture option for your machine.  Code compiled for lower numbered
10605 architectures will run on higher numbered architectures, but not the
10606 other way around.
10608 @item -mpa-risc-1-0
10609 @itemx -mpa-risc-1-1
10610 @itemx -mpa-risc-2-0
10611 @opindex mpa-risc-1-0
10612 @opindex mpa-risc-1-1
10613 @opindex mpa-risc-2-0
10614 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10616 @item -mbig-switch
10617 @opindex mbig-switch
10618 Generate code suitable for big switch tables.  Use this option only if
10619 the assembler/linker complain about out of range branches within a switch
10620 table.
10622 @item -mjump-in-delay
10623 @opindex mjump-in-delay
10624 Fill delay slots of function calls with unconditional jump instructions
10625 by modifying the return pointer for the function call to be the target
10626 of the conditional jump.
10628 @item -mdisable-fpregs
10629 @opindex mdisable-fpregs
10630 Prevent floating point registers from being used in any manner.  This is
10631 necessary for compiling kernels which perform lazy context switching of
10632 floating point registers.  If you use this option and attempt to perform
10633 floating point operations, the compiler will abort.
10635 @item -mdisable-indexing
10636 @opindex mdisable-indexing
10637 Prevent the compiler from using indexing address modes.  This avoids some
10638 rather obscure problems when compiling MIG generated code under MACH@.
10640 @item -mno-space-regs
10641 @opindex mno-space-regs
10642 Generate code that assumes the target has no space registers.  This allows
10643 GCC to generate faster indirect calls and use unscaled index address modes.
10645 Such code is suitable for level 0 PA systems and kernels.
10647 @item -mfast-indirect-calls
10648 @opindex mfast-indirect-calls
10649 Generate code that assumes calls never cross space boundaries.  This
10650 allows GCC to emit code which performs faster indirect calls.
10652 This option will not work in the presence of shared libraries or nested
10653 functions.
10655 @item -mfixed-range=@var{register-range}
10656 @opindex mfixed-range
10657 Generate code treating the given register range as fixed registers.
10658 A fixed register is one that the register allocator can not use.  This is
10659 useful when compiling kernel code.  A register range is specified as
10660 two registers separated by a dash.  Multiple register ranges can be
10661 specified separated by a comma.
10663 @item -mlong-load-store
10664 @opindex mlong-load-store
10665 Generate 3-instruction load and store sequences as sometimes required by
10666 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10667 the HP compilers.
10669 @item -mportable-runtime
10670 @opindex mportable-runtime
10671 Use the portable calling conventions proposed by HP for ELF systems.
10673 @item -mgas
10674 @opindex mgas
10675 Enable the use of assembler directives only GAS understands.
10677 @item -mschedule=@var{cpu-type}
10678 @opindex mschedule
10679 Schedule code according to the constraints for the machine type
10680 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10681 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10682 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10683 proper scheduling option for your machine.  The default scheduling is
10684 @samp{8000}.
10686 @item -mlinker-opt
10687 @opindex mlinker-opt
10688 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10689 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10690 linkers in which they give bogus error messages when linking some programs.
10692 @item -msoft-float
10693 @opindex msoft-float
10694 Generate output containing library calls for floating point.
10695 @strong{Warning:} the requisite libraries are not available for all HPPA
10696 targets.  Normally the facilities of the machine's usual C compiler are
10697 used, but this cannot be done directly in cross-compilation.  You must make
10698 your own arrangements to provide suitable library functions for
10699 cross-compilation.
10701 @option{-msoft-float} changes the calling convention in the output file;
10702 therefore, it is only useful if you compile @emph{all} of a program with
10703 this option.  In particular, you need to compile @file{libgcc.a}, the
10704 library that comes with GCC, with @option{-msoft-float} in order for
10705 this to work.
10707 @item -msio
10708 @opindex msio
10709 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10710 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10711 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10712 options are available under HP-UX and HI-UX@.
10714 @item -mgnu-ld
10715 @opindex gnu-ld
10716 Use GNU ld specific options.  This passes @option{-shared} to ld when
10717 building a shared library.  It is the default when GCC is configured,
10718 explicitly or implicitly, with the GNU linker.  This option does not
10719 have any affect on which ld is called, it only changes what parameters
10720 are passed to that ld.  The ld that is called is determined by the
10721 @option{--with-ld} configure option, GCC's program search path, and
10722 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10723 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10724 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10726 @item -mhp-ld
10727 @opindex hp-ld
10728 Use HP ld specific options.  This passes @option{-b} to ld when building
10729 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10730 links.  It is the default when GCC is configured, explicitly or
10731 implicitly, with the HP linker.  This option does not have any affect on
10732 which ld is called, it only changes what parameters are passed to that
10733 ld.  The ld that is called is determined by the @option{--with-ld}
10734 configure option, GCC's program search path, and finally by the user's
10735 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10736 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10737 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10739 @item -mlong-calls
10740 @opindex mno-long-calls
10741 Generate code that uses long call sequences.  This ensures that a call
10742 is always able to reach linker generated stubs.  The default is to generate
10743 long calls only when the distance from the call site to the beginning
10744 of the function or translation unit, as the case may be, exceeds a
10745 predefined limit set by the branch type being used.  The limits for
10746 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10747 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10748 240,000 bytes.
10750 Distances are measured from the beginning of functions when using the
10751 @option{-ffunction-sections} option, or when using the @option{-mgas}
10752 and @option{-mno-portable-runtime} options together under HP-UX with
10753 the SOM linker.
10755 It is normally not desirable to use this option as it will degrade
10756 performance.  However, it may be useful in large applications,
10757 particularly when partial linking is used to build the application.
10759 The types of long calls used depends on the capabilities of the
10760 assembler and linker, and the type of code being generated.  The
10761 impact on systems that support long absolute calls, and long pic
10762 symbol-difference or pc-relative calls should be relatively small.
10763 However, an indirect call is used on 32-bit ELF systems in pic code
10764 and it is quite long.
10766 @item -munix=@var{unix-std}
10767 @opindex march
10768 Generate compiler predefines and select a startfile for the specified
10769 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10770 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10771 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10772 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10773 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10774 and later.
10776 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10777 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10778 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10779 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10780 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10781 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10783 It is @emph{important} to note that this option changes the interfaces
10784 for various library routines.  It also affects the operational behavior
10785 of the C library.  Thus, @emph{extreme} care is needed in using this
10786 option.
10788 Library code that is intended to operate with more than one UNIX
10789 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10790 as appropriate.  Most GNU software doesn't provide this capability.
10792 @item -nolibdld
10793 @opindex nolibdld
10794 Suppress the generation of link options to search libdld.sl when the
10795 @option{-static} option is specified on HP-UX 10 and later.
10797 @item -static
10798 @opindex static
10799 The HP-UX implementation of setlocale in libc has a dependency on
10800 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10801 when the @option{-static} option is specified, special link options
10802 are needed to resolve this dependency.
10804 On HP-UX 10 and later, the GCC driver adds the necessary options to
10805 link with libdld.sl when the @option{-static} option is specified.
10806 This causes the resulting binary to be dynamic.  On the 64-bit port,
10807 the linkers generate dynamic binaries by default in any case.  The
10808 @option{-nolibdld} option can be used to prevent the GCC driver from
10809 adding these link options.
10811 @item -threads
10812 @opindex threads
10813 Add support for multithreading with the @dfn{dce thread} library
10814 under HP-UX@.  This option sets flags for both the preprocessor and
10815 linker.
10816 @end table
10818 @node i386 and x86-64 Options
10819 @subsection Intel 386 and AMD x86-64 Options
10820 @cindex i386 Options
10821 @cindex x86-64 Options
10822 @cindex Intel 386 Options
10823 @cindex AMD x86-64 Options
10825 These @samp{-m} options are defined for the i386 and x86-64 family of
10826 computers:
10828 @table @gcctabopt
10829 @item -mtune=@var{cpu-type}
10830 @opindex mtune
10831 Tune to @var{cpu-type} everything applicable about the generated code, except
10832 for the ABI and the set of available instructions.  The choices for
10833 @var{cpu-type} are:
10834 @table @emph
10835 @item generic
10836 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10837 If you know the CPU on which your code will run, then you should use
10838 the corresponding @option{-mtune} option instead of
10839 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10840 of your application will have, then you should use this option.
10842 As new processors are deployed in the marketplace, the behavior of this
10843 option will change.  Therefore, if you upgrade to a newer version of
10844 GCC, the code generated option will change to reflect the processors
10845 that were most common when that version of GCC was released.
10847 There is no @option{-march=generic} option because @option{-march}
10848 indicates the instruction set the compiler can use, and there is no
10849 generic instruction set applicable to all processors.  In contrast,
10850 @option{-mtune} indicates the processor (or, in this case, collection of
10851 processors) for which the code is optimized.
10852 @item native
10853 This selects the CPU to tune for at compilation time by determining
10854 the processor type of the compiling machine.  Using @option{-mtune=native}
10855 will produce code optimized for the local machine under the constraints
10856 of the selected instruction set.  Using @option{-march=native} will
10857 enable all instruction subsets supported by the local machine (hence
10858 the result might not run on different machines).
10859 @item i386
10860 Original Intel's i386 CPU@.
10861 @item i486
10862 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10863 @item i586, pentium
10864 Intel Pentium CPU with no MMX support.
10865 @item pentium-mmx
10866 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10867 @item pentiumpro
10868 Intel PentiumPro CPU@.
10869 @item i686
10870 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10871 instruction set will be used, so the code will run on all i686 family chips.
10872 @item pentium2
10873 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10874 @item pentium3, pentium3m
10875 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10876 support.
10877 @item pentium-m
10878 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10879 support.  Used by Centrino notebooks.
10880 @item pentium4, pentium4m
10881 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10882 @item prescott
10883 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10884 set support.
10885 @item nocona
10886 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10887 SSE2 and SSE3 instruction set support.
10888 @item core2
10889 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10890 instruction set support.
10891 @item k6
10892 AMD K6 CPU with MMX instruction set support.
10893 @item k6-2, k6-3
10894 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10895 @item athlon, athlon-tbird
10896 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10897 support.
10898 @item athlon-4, athlon-xp, athlon-mp
10899 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10900 instruction set support.
10901 @item k8, opteron, athlon64, athlon-fx
10902 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10903 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10904 @item k8-sse3, opteron-sse3, athlon64-sse3
10905 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10906 @item amdfam10, barcelona
10907 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10908 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10909 instruction set extensions.)
10910 @item winchip-c6
10911 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10912 set support.
10913 @item winchip2
10914 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10915 instruction set support.
10916 @item c3
10917 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10918 implemented for this chip.)
10919 @item c3-2
10920 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10921 implemented for this chip.)
10922 @item geode
10923 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10924 @end table
10926 While picking a specific @var{cpu-type} will schedule things appropriately
10927 for that particular chip, the compiler will not generate any code that
10928 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10929 being used.
10931 @item -march=@var{cpu-type}
10932 @opindex march
10933 Generate instructions for the machine type @var{cpu-type}.  The choices
10934 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10935 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10937 @item -mcpu=@var{cpu-type}
10938 @opindex mcpu
10939 A deprecated synonym for @option{-mtune}.
10941 @item -mfpmath=@var{unit}
10942 @opindex march
10943 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10944 for @var{unit} are:
10946 @table @samp
10947 @item 387
10948 Use the standard 387 floating point coprocessor present majority of chips and
10949 emulated otherwise.  Code compiled with this option will run almost everywhere.
10950 The temporary results are computed in 80bit precision instead of precision
10951 specified by the type resulting in slightly different results compared to most
10952 of other chips.  See @option{-ffloat-store} for more detailed description.
10954 This is the default choice for i386 compiler.
10956 @item sse
10957 Use scalar floating point instructions present in the SSE instruction set.
10958 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10959 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10960 instruction set supports only single precision arithmetics, thus the double and
10961 extended precision arithmetics is still done using 387.  Later version, present
10962 only in Pentium4 and the future AMD x86-64 chips supports double precision
10963 arithmetics too.
10965 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10966 or @option{-msse2} switches to enable SSE extensions and make this option
10967 effective.  For the x86-64 compiler, these extensions are enabled by default.
10969 The resulting code should be considerably faster in the majority of cases and avoid
10970 the numerical instability problems of 387 code, but may break some existing
10971 code that expects temporaries to be 80bit.
10973 This is the default choice for the x86-64 compiler.
10975 @item sse,387
10976 @itemx sse+387
10977 @itemx both
10978 Attempt to utilize both instruction sets at once.  This effectively double the
10979 amount of available registers and on chips with separate execution units for
10980 387 and SSE the execution resources too.  Use this option with care, as it is
10981 still experimental, because the GCC register allocator does not model separate
10982 functional units well resulting in instable performance.
10983 @end table
10985 @item -masm=@var{dialect}
10986 @opindex masm=@var{dialect}
10987 Output asm instructions using selected @var{dialect}.  Supported
10988 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10989 not support @samp{intel}.
10991 @item -mieee-fp
10992 @itemx -mno-ieee-fp
10993 @opindex mieee-fp
10994 @opindex mno-ieee-fp
10995 Control whether or not the compiler uses IEEE floating point
10996 comparisons.  These handle correctly the case where the result of a
10997 comparison is unordered.
10999 @item -msoft-float
11000 @opindex msoft-float
11001 Generate output containing library calls for floating point.
11002 @strong{Warning:} the requisite libraries are not part of GCC@.
11003 Normally the facilities of the machine's usual C compiler are used, but
11004 this can't be done directly in cross-compilation.  You must make your
11005 own arrangements to provide suitable library functions for
11006 cross-compilation.
11008 On machines where a function returns floating point results in the 80387
11009 register stack, some floating point opcodes may be emitted even if
11010 @option{-msoft-float} is used.
11012 @item -mno-fp-ret-in-387
11013 @opindex mno-fp-ret-in-387
11014 Do not use the FPU registers for return values of functions.
11016 The usual calling convention has functions return values of types
11017 @code{float} and @code{double} in an FPU register, even if there
11018 is no FPU@.  The idea is that the operating system should emulate
11019 an FPU@.
11021 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11022 in ordinary CPU registers instead.
11024 @item -mno-fancy-math-387
11025 @opindex mno-fancy-math-387
11026 Some 387 emulators do not support the @code{sin}, @code{cos} and
11027 @code{sqrt} instructions for the 387.  Specify this option to avoid
11028 generating those instructions.  This option is the default on FreeBSD,
11029 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11030 indicates that the target cpu will always have an FPU and so the
11031 instruction will not need emulation.  As of revision 2.6.1, these
11032 instructions are not generated unless you also use the
11033 @option{-funsafe-math-optimizations} switch.
11035 @item -malign-double
11036 @itemx -mno-align-double
11037 @opindex malign-double
11038 @opindex mno-align-double
11039 Control whether GCC aligns @code{double}, @code{long double}, and
11040 @code{long long} variables on a two word boundary or a one word
11041 boundary.  Aligning @code{double} variables on a two word boundary will
11042 produce code that runs somewhat faster on a @samp{Pentium} at the
11043 expense of more memory.
11045 On x86-64, @option{-malign-double} is enabled by default.
11047 @strong{Warning:} if you use the @option{-malign-double} switch,
11048 structures containing the above types will be aligned differently than
11049 the published application binary interface specifications for the 386
11050 and will not be binary compatible with structures in code compiled
11051 without that switch.
11053 @item -m96bit-long-double
11054 @itemx -m128bit-long-double
11055 @opindex m96bit-long-double
11056 @opindex m128bit-long-double
11057 These switches control the size of @code{long double} type.  The i386
11058 application binary interface specifies the size to be 96 bits,
11059 so @option{-m96bit-long-double} is the default in 32 bit mode.
11061 Modern architectures (Pentium and newer) would prefer @code{long double}
11062 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11063 conforming to the ABI, this would not be possible.  So specifying a
11064 @option{-m128bit-long-double} will align @code{long double}
11065 to a 16 byte boundary by padding the @code{long double} with an additional
11066 32 bit zero.
11068 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11069 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11071 Notice that neither of these options enable any extra precision over the x87
11072 standard of 80 bits for a @code{long double}.
11074 @strong{Warning:} if you override the default value for your target ABI, the
11075 structures and arrays containing @code{long double} variables will change
11076 their size as well as function calling convention for function taking
11077 @code{long double} will be modified.  Hence they will not be binary
11078 compatible with arrays or structures in code compiled without that switch.
11080 @item -mlarge-data-threshold=@var{number}
11081 @opindex mlarge-data-threshold=@var{number}
11082 When @option{-mcmodel=medium} is specified, the data greater than
11083 @var{threshold} are placed in large data section.  This value must be the
11084 same across all object linked into the binary and defaults to 65535.
11086 @item -mrtd
11087 @opindex mrtd
11088 Use a different function-calling convention, in which functions that
11089 take a fixed number of arguments return with the @code{ret} @var{num}
11090 instruction, which pops their arguments while returning.  This saves one
11091 instruction in the caller since there is no need to pop the arguments
11092 there.
11094 You can specify that an individual function is called with this calling
11095 sequence with the function attribute @samp{stdcall}.  You can also
11096 override the @option{-mrtd} option by using the function attribute
11097 @samp{cdecl}.  @xref{Function Attributes}.
11099 @strong{Warning:} this calling convention is incompatible with the one
11100 normally used on Unix, so you cannot use it if you need to call
11101 libraries compiled with the Unix compiler.
11103 Also, you must provide function prototypes for all functions that
11104 take variable numbers of arguments (including @code{printf});
11105 otherwise incorrect code will be generated for calls to those
11106 functions.
11108 In addition, seriously incorrect code will result if you call a
11109 function with too many arguments.  (Normally, extra arguments are
11110 harmlessly ignored.)
11112 @item -mregparm=@var{num}
11113 @opindex mregparm
11114 Control how many registers are used to pass integer arguments.  By
11115 default, no registers are used to pass arguments, and at most 3
11116 registers can be used.  You can control this behavior for a specific
11117 function by using the function attribute @samp{regparm}.
11118 @xref{Function Attributes}.
11120 @strong{Warning:} if you use this switch, and
11121 @var{num} is nonzero, then you must build all modules with the same
11122 value, including any libraries.  This includes the system libraries and
11123 startup modules.
11125 @item -msseregparm
11126 @opindex msseregparm
11127 Use SSE register passing conventions for float and double arguments
11128 and return values.  You can control this behavior for a specific
11129 function by using the function attribute @samp{sseregparm}.
11130 @xref{Function Attributes}.
11132 @strong{Warning:} if you use this switch then you must build all
11133 modules with the same value, including any libraries.  This includes
11134 the system libraries and startup modules.
11136 @item -mpc32
11137 @itemx -mpc64
11138 @itemx -mpc80
11139 @opindex mpc32
11140 @opindex mpc64
11141 @opindex mpc80
11143 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11144 is specified, the significands of results of floating-point operations are
11145 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11146 significands of results of floating-point operations to 53 bits (double
11147 precision) and @option{-mpc80} rounds the significands of results of
11148 floating-point operations to 64 bits (extended double precision), which is
11149 the default.  When this option is used, floating-point operations in higher
11150 precisions are not available to the programmer without setting the FPU
11151 control word explicitly.
11153 Setting the rounding of floating-point operations to less than the default
11154 80 bits can speed some programs by 2% or more.  Note that some mathematical
11155 libraries assume that extended precision (80 bit) floating-point operations
11156 are enabled by default; routines in such libraries could suffer significant
11157 loss of accuracy, typically through so-called "catastrophic cancellation",
11158 when this option is used to set the precision to less than extended precision. 
11160 @item -mstackrealign
11161 @opindex mstackrealign
11162 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11163 option will generate an alternate prologue and epilogue that realigns the
11164 runtime stack if necessary.  This supports mixing legacy codes that keep
11165 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11166 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11167 applicable to individual functions.
11169 @item -mpreferred-stack-boundary=@var{num}
11170 @opindex mpreferred-stack-boundary
11171 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11172 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11173 the default is 4 (16 bytes or 128 bits).
11175 @item -mincoming-stack-boundary=@var{num}
11176 @opindex mincoming-stack-boundary
11177 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11178 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11179 the one specified by @option{-mpreferred-stack-boundary} will be used.
11181 On Pentium and PentiumPro, @code{double} and @code{long double} values
11182 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11183 suffer significant run time performance penalties.  On Pentium III, the
11184 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11185 properly if it is not 16 byte aligned.
11187 To ensure proper alignment of this values on the stack, the stack boundary
11188 must be as aligned as that required by any value stored on the stack.
11189 Further, every function must be generated such that it keeps the stack
11190 aligned.  Thus calling a function compiled with a higher preferred
11191 stack boundary from a function compiled with a lower preferred stack
11192 boundary will most likely misalign the stack.  It is recommended that
11193 libraries that use callbacks always use the default setting.
11195 This extra alignment does consume extra stack space, and generally
11196 increases code size.  Code that is sensitive to stack space usage, such
11197 as embedded systems and operating system kernels, may want to reduce the
11198 preferred alignment to @option{-mpreferred-stack-boundary=2}.
11200 @item -mmmx
11201 @itemx -mno-mmx
11202 @itemx -msse
11203 @itemx -mno-sse
11204 @itemx -msse2
11205 @itemx -mno-sse2
11206 @itemx -msse3
11207 @itemx -mno-sse3
11208 @itemx -mssse3
11209 @itemx -mno-ssse3
11210 @itemx -msse4.1
11211 @itemx -mno-sse4.1
11212 @itemx -msse4.2
11213 @itemx -mno-sse4.2
11214 @itemx -msse4
11215 @itemx -mno-sse4
11216 @itemx -mavx
11217 @itemx -mno-avx
11218 @itemx -maes
11219 @itemx -mno-aes
11220 @itemx -mpclmul
11221 @itemx -mno-pclmul
11222 @itemx -msse4a
11223 @itemx -mno-sse4a
11224 @itemx -msse5
11225 @itemx -mno-sse5
11226 @itemx -m3dnow
11227 @itemx -mno-3dnow
11228 @itemx -mpopcnt
11229 @itemx -mno-popcnt
11230 @itemx -mabm
11231 @itemx -mno-abm
11232 @opindex mmmx
11233 @opindex mno-mmx
11234 @opindex msse
11235 @opindex mno-sse
11236 @opindex m3dnow
11237 @opindex mno-3dnow
11238 These switches enable or disable the use of instructions in the MMX,
11239 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, SSE5, ABM or
11240 3DNow!@: extended instruction sets.
11241 These extensions are also available as built-in functions: see
11242 @ref{X86 Built-in Functions}, for details of the functions enabled and
11243 disabled by these switches.
11245 To have SSE/SSE2 instructions generated automatically from floating-point
11246 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
11248 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
11249 generates new AVX instructions or AVX equivalence for all SSEx instructions
11250 when needed.
11252 These options will enable GCC to use these extended instructions in
11253 generated code, even without @option{-mfpmath=sse}.  Applications which
11254 perform runtime CPU detection must compile separate files for each
11255 supported architecture, using the appropriate flags.  In particular,
11256 the file containing the CPU detection code should be compiled without
11257 these options.
11259 @item -mcld
11260 @opindex mcld
11261 This option instructs GCC to emit a @code{cld} instruction in the prologue
11262 of functions that use string instructions.  String instructions depend on
11263 the DF flag to select between autoincrement or autodecrement mode.  While the
11264 ABI specifies the DF flag to be cleared on function entry, some operating
11265 systems violate this specification by not clearing the DF flag in their
11266 exception dispatchers.  The exception handler can be invoked with the DF flag
11267 set which leads to wrong direction mode, when string instructions are used.
11268 This option can be enabled by default on 32-bit x86 targets by configuring
11269 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
11270 instructions can be suppressed with the @option{-mno-cld} compiler option
11271 in this case.
11273 @item -mcx16
11274 @opindex mcx16
11275 This option will enable GCC to use CMPXCHG16B instruction in generated code.
11276 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
11277 data types.  This is useful for high resolution counters that could be updated
11278 by multiple processors (or cores).  This instruction is generated as part of
11279 atomic built-in functions: see @ref{Atomic Builtins} for details.
11281 @item -msahf
11282 @opindex msahf
11283 This option will enable GCC to use SAHF instruction in generated 64-bit code.
11284 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
11285 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
11286 SAHF are load and store instructions, respectively, for certain status flags.
11287 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
11288 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
11290 @item -mrecip
11291 @opindex mrecip
11292 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
11293 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
11294 to increase precision instead of DIVSS and SQRTSS (and their vectorized
11295 variants) for single precision floating point arguments.  These instructions
11296 are generated only when @option{-funsafe-math-optimizations} is enabled
11297 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
11298 Note that while the throughput of the sequence is higher than the throughput
11299 of the non-reciprocal instruction, the precision of the sequence can be
11300 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
11302 @item -mveclibabi=@var{type}
11303 @opindex mveclibabi
11304 Specifies the ABI type to use for vectorizing intrinsics using an
11305 external library.  Supported types are @code{svml} for the Intel short
11306 vector math library and @code{acml} for the AMD math core library style
11307 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
11308 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
11309 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
11310 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
11311 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
11312 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
11313 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
11314 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
11315 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
11316 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
11317 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
11318 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
11319 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
11320 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
11321 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
11322 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
11323 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
11324 compatible library will have to be specified at link time.
11326 @item -mpush-args
11327 @itemx -mno-push-args
11328 @opindex mpush-args
11329 @opindex mno-push-args
11330 Use PUSH operations to store outgoing parameters.  This method is shorter
11331 and usually equally fast as method using SUB/MOV operations and is enabled
11332 by default.  In some cases disabling it may improve performance because of
11333 improved scheduling and reduced dependencies.
11335 @item -maccumulate-outgoing-args
11336 @opindex maccumulate-outgoing-args
11337 If enabled, the maximum amount of space required for outgoing arguments will be
11338 computed in the function prologue.  This is faster on most modern CPUs
11339 because of reduced dependencies, improved scheduling and reduced stack usage
11340 when preferred stack boundary is not equal to 2.  The drawback is a notable
11341 increase in code size.  This switch implies @option{-mno-push-args}.
11343 @item -mthreads
11344 @opindex mthreads
11345 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
11346 on thread-safe exception handling must compile and link all code with the
11347 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
11348 @option{-D_MT}; when linking, it links in a special thread helper library
11349 @option{-lmingwthrd} which cleans up per thread exception handling data.
11351 @item -mno-align-stringops
11352 @opindex mno-align-stringops
11353 Do not align destination of inlined string operations.  This switch reduces
11354 code size and improves performance in case the destination is already aligned,
11355 but GCC doesn't know about it.
11357 @item -minline-all-stringops
11358 @opindex minline-all-stringops
11359 By default GCC inlines string operations only when destination is known to be
11360 aligned at least to 4 byte boundary.  This enables more inlining, increase code
11361 size, but may improve performance of code that depends on fast memcpy, strlen
11362 and memset for short lengths.
11364 @item -minline-stringops-dynamically
11365 @opindex minline-stringops-dynamically
11366 For string operation of unknown size, inline runtime checks so for small
11367 blocks inline code is used, while for large blocks library call is used.
11369 @item -mstringop-strategy=@var{alg}
11370 @opindex mstringop-strategy=@var{alg}
11371 Overwrite internal decision heuristic about particular algorithm to inline
11372 string operation with.  The allowed values are @code{rep_byte},
11373 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
11374 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
11375 expanding inline loop, @code{libcall} for always expanding library call.
11377 @item -momit-leaf-frame-pointer
11378 @opindex momit-leaf-frame-pointer
11379 Don't keep the frame pointer in a register for leaf functions.  This
11380 avoids the instructions to save, set up and restore frame pointers and
11381 makes an extra register available in leaf functions.  The option
11382 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11383 which might make debugging harder.
11385 @item -mtls-direct-seg-refs
11386 @itemx -mno-tls-direct-seg-refs
11387 @opindex mtls-direct-seg-refs
11388 Controls whether TLS variables may be accessed with offsets from the
11389 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
11390 or whether the thread base pointer must be added.  Whether or not this
11391 is legal depends on the operating system, and whether it maps the
11392 segment to cover the entire TLS area.
11394 For systems that use GNU libc, the default is on.
11396 @item -mfused-madd
11397 @itemx -mno-fused-madd
11398 @opindex mfused-madd
11399 Enable automatic generation of fused floating point multiply-add instructions
11400 if the ISA supports such instructions.  The -mfused-madd option is on by
11401 default.  The fused multiply-add instructions have a different
11402 rounding behavior compared to executing a multiply followed by an add.
11404 @item -msse2avx
11405 @itemx -mno-sse2avx
11406 @opindex msse2avx
11407 Specify that the assembler should encode SSE instructions with VEX
11408 prefix.  The option @option{-mavx} turns this on by default.
11409 @end table
11411 These @samp{-m} switches are supported in addition to the above
11412 on AMD x86-64 processors in 64-bit environments.
11414 @table @gcctabopt
11415 @item -m32
11416 @itemx -m64
11417 @opindex m32
11418 @opindex m64
11419 Generate code for a 32-bit or 64-bit environment.
11420 The 32-bit environment sets int, long and pointer to 32 bits and
11421 generates code that runs on any i386 system.
11422 The 64-bit environment sets int to 32 bits and long and pointer
11423 to 64 bits and generates code for AMD's x86-64 architecture. For
11424 darwin only the -m64 option turns off the @option{-fno-pic} and
11425 @option{-mdynamic-no-pic} options.
11427 @item -mno-red-zone
11428 @opindex no-red-zone
11429 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11430 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11431 stack pointer that will not be modified by signal or interrupt handlers
11432 and therefore can be used for temporary data without adjusting the stack
11433 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11435 @item -mcmodel=small
11436 @opindex mcmodel=small
11437 Generate code for the small code model: the program and its symbols must
11438 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11439 Programs can be statically or dynamically linked.  This is the default
11440 code model.
11442 @item -mcmodel=kernel
11443 @opindex mcmodel=kernel
11444 Generate code for the kernel code model.  The kernel runs in the
11445 negative 2 GB of the address space.
11446 This model has to be used for Linux kernel code.
11448 @item -mcmodel=medium
11449 @opindex mcmodel=medium
11450 Generate code for the medium model: The program is linked in the lower 2
11451 GB of the address space.  Small symbols are also placed there.  Symbols
11452 with sizes larger than @option{-mlarge-data-threshold} are put into
11453 large data or bss sections and can be located above 2GB.  Programs can
11454 be statically or dynamically linked.
11456 @item -mcmodel=large
11457 @opindex mcmodel=large
11458 Generate code for the large model: This model makes no assumptions
11459 about addresses and sizes of sections.
11460 @end table
11462 @node IA-64 Options
11463 @subsection IA-64 Options
11464 @cindex IA-64 Options
11466 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11468 @table @gcctabopt
11469 @item -mbig-endian
11470 @opindex mbig-endian
11471 Generate code for a big endian target.  This is the default for HP-UX@.
11473 @item -mlittle-endian
11474 @opindex mlittle-endian
11475 Generate code for a little endian target.  This is the default for AIX5
11476 and GNU/Linux.
11478 @item -mgnu-as
11479 @itemx -mno-gnu-as
11480 @opindex mgnu-as
11481 @opindex mno-gnu-as
11482 Generate (or don't) code for the GNU assembler.  This is the default.
11483 @c Also, this is the default if the configure option @option{--with-gnu-as}
11484 @c is used.
11486 @item -mgnu-ld
11487 @itemx -mno-gnu-ld
11488 @opindex mgnu-ld
11489 @opindex mno-gnu-ld
11490 Generate (or don't) code for the GNU linker.  This is the default.
11491 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11492 @c is used.
11494 @item -mno-pic
11495 @opindex mno-pic
11496 Generate code that does not use a global pointer register.  The result
11497 is not position independent code, and violates the IA-64 ABI@.
11499 @item -mvolatile-asm-stop
11500 @itemx -mno-volatile-asm-stop
11501 @opindex mvolatile-asm-stop
11502 @opindex mno-volatile-asm-stop
11503 Generate (or don't) a stop bit immediately before and after volatile asm
11504 statements.
11506 @item -mregister-names
11507 @itemx -mno-register-names
11508 @opindex mregister-names
11509 @opindex mno-register-names
11510 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11511 the stacked registers.  This may make assembler output more readable.
11513 @item -mno-sdata
11514 @itemx -msdata
11515 @opindex mno-sdata
11516 @opindex msdata
11517 Disable (or enable) optimizations that use the small data section.  This may
11518 be useful for working around optimizer bugs.
11520 @item -mconstant-gp
11521 @opindex mconstant-gp
11522 Generate code that uses a single constant global pointer value.  This is
11523 useful when compiling kernel code.
11525 @item -mauto-pic
11526 @opindex mauto-pic
11527 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11528 This is useful when compiling firmware code.
11530 @item -minline-float-divide-min-latency
11531 @opindex minline-float-divide-min-latency
11532 Generate code for inline divides of floating point values
11533 using the minimum latency algorithm.
11535 @item -minline-float-divide-max-throughput
11536 @opindex minline-float-divide-max-throughput
11537 Generate code for inline divides of floating point values
11538 using the maximum throughput algorithm.
11540 @item -minline-int-divide-min-latency
11541 @opindex minline-int-divide-min-latency
11542 Generate code for inline divides of integer values
11543 using the minimum latency algorithm.
11545 @item -minline-int-divide-max-throughput
11546 @opindex minline-int-divide-max-throughput
11547 Generate code for inline divides of integer values
11548 using the maximum throughput algorithm.
11550 @item -minline-sqrt-min-latency
11551 @opindex minline-sqrt-min-latency
11552 Generate code for inline square roots
11553 using the minimum latency algorithm.
11555 @item -minline-sqrt-max-throughput
11556 @opindex minline-sqrt-max-throughput
11557 Generate code for inline square roots
11558 using the maximum throughput algorithm.
11560 @item -mno-dwarf2-asm
11561 @itemx -mdwarf2-asm
11562 @opindex mno-dwarf2-asm
11563 @opindex mdwarf2-asm
11564 Don't (or do) generate assembler code for the DWARF2 line number debugging
11565 info.  This may be useful when not using the GNU assembler.
11567 @item -mearly-stop-bits
11568 @itemx -mno-early-stop-bits
11569 @opindex mearly-stop-bits
11570 @opindex mno-early-stop-bits
11571 Allow stop bits to be placed earlier than immediately preceding the
11572 instruction that triggered the stop bit.  This can improve instruction
11573 scheduling, but does not always do so.
11575 @item -mfixed-range=@var{register-range}
11576 @opindex mfixed-range
11577 Generate code treating the given register range as fixed registers.
11578 A fixed register is one that the register allocator can not use.  This is
11579 useful when compiling kernel code.  A register range is specified as
11580 two registers separated by a dash.  Multiple register ranges can be
11581 specified separated by a comma.
11583 @item -mtls-size=@var{tls-size}
11584 @opindex mtls-size
11585 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11588 @item -mtune=@var{cpu-type}
11589 @opindex mtune
11590 Tune the instruction scheduling for a particular CPU, Valid values are
11591 itanium, itanium1, merced, itanium2, and mckinley.
11593 @item -mt
11594 @itemx -pthread
11595 @opindex mt
11596 @opindex pthread
11597 Add support for multithreading using the POSIX threads library.  This
11598 option sets flags for both the preprocessor and linker.  It does
11599 not affect the thread safety of object code produced by the compiler or
11600 that of libraries supplied with it.  These are HP-UX specific flags.
11602 @item -milp32
11603 @itemx -mlp64
11604 @opindex milp32
11605 @opindex mlp64
11606 Generate code for a 32-bit or 64-bit environment.
11607 The 32-bit environment sets int, long and pointer to 32 bits.
11608 The 64-bit environment sets int to 32 bits and long and pointer
11609 to 64 bits.  These are HP-UX specific flags.
11611 @item -mno-sched-br-data-spec
11612 @itemx -msched-br-data-spec
11613 @opindex mno-sched-br-data-spec
11614 @opindex msched-br-data-spec
11615 (Dis/En)able data speculative scheduling before reload.
11616 This will result in generation of the ld.a instructions and
11617 the corresponding check instructions (ld.c / chk.a).
11618 The default is 'disable'.
11620 @item -msched-ar-data-spec
11621 @itemx -mno-sched-ar-data-spec
11622 @opindex msched-ar-data-spec
11623 @opindex mno-sched-ar-data-spec
11624 (En/Dis)able data speculative scheduling after reload.
11625 This will result in generation of the ld.a instructions and
11626 the corresponding check instructions (ld.c / chk.a).
11627 The default is 'enable'.
11629 @item -mno-sched-control-spec
11630 @itemx -msched-control-spec
11631 @opindex mno-sched-control-spec
11632 @opindex msched-control-spec
11633 (Dis/En)able control speculative scheduling.  This feature is
11634 available only during region scheduling (i.e.@: before reload).
11635 This will result in generation of the ld.s instructions and
11636 the corresponding check instructions chk.s .
11637 The default is 'disable'.
11639 @item -msched-br-in-data-spec
11640 @itemx -mno-sched-br-in-data-spec
11641 @opindex msched-br-in-data-spec
11642 @opindex mno-sched-br-in-data-spec
11643 (En/Dis)able speculative scheduling of the instructions that
11644 are dependent on the data speculative loads before reload.
11645 This is effective only with @option{-msched-br-data-spec} enabled.
11646 The default is 'enable'.
11648 @item -msched-ar-in-data-spec
11649 @itemx -mno-sched-ar-in-data-spec
11650 @opindex msched-ar-in-data-spec
11651 @opindex mno-sched-ar-in-data-spec
11652 (En/Dis)able speculative scheduling of the instructions that
11653 are dependent on the data speculative loads after reload.
11654 This is effective only with @option{-msched-ar-data-spec} enabled.
11655 The default is 'enable'.
11657 @item -msched-in-control-spec
11658 @itemx -mno-sched-in-control-spec
11659 @opindex msched-in-control-spec
11660 @opindex mno-sched-in-control-spec
11661 (En/Dis)able speculative scheduling of the instructions that
11662 are dependent on the control speculative loads.
11663 This is effective only with @option{-msched-control-spec} enabled.
11664 The default is 'enable'.
11666 @item -msched-ldc
11667 @itemx -mno-sched-ldc
11668 @opindex msched-ldc
11669 @opindex mno-sched-ldc
11670 (En/Dis)able use of simple data speculation checks ld.c .
11671 If disabled, only chk.a instructions will be emitted to check
11672 data speculative loads.
11673 The default is 'enable'.
11675 @item -mno-sched-control-ldc
11676 @itemx -msched-control-ldc
11677 @opindex mno-sched-control-ldc
11678 @opindex msched-control-ldc
11679 (Dis/En)able use of ld.c instructions to check control speculative loads.
11680 If enabled, in case of control speculative load with no speculatively
11681 scheduled dependent instructions this load will be emitted as ld.sa and
11682 ld.c will be used to check it.
11683 The default is 'disable'.
11685 @item -mno-sched-spec-verbose
11686 @itemx -msched-spec-verbose
11687 @opindex mno-sched-spec-verbose
11688 @opindex msched-spec-verbose
11689 (Dis/En)able printing of the information about speculative motions.
11691 @item -mno-sched-prefer-non-data-spec-insns
11692 @itemx -msched-prefer-non-data-spec-insns
11693 @opindex mno-sched-prefer-non-data-spec-insns
11694 @opindex msched-prefer-non-data-spec-insns
11695 If enabled, data speculative instructions will be chosen for schedule
11696 only if there are no other choices at the moment.  This will make
11697 the use of the data speculation much more conservative.
11698 The default is 'disable'.
11700 @item -mno-sched-prefer-non-control-spec-insns
11701 @itemx -msched-prefer-non-control-spec-insns
11702 @opindex mno-sched-prefer-non-control-spec-insns
11703 @opindex msched-prefer-non-control-spec-insns
11704 If enabled, control speculative instructions will be chosen for schedule
11705 only if there are no other choices at the moment.  This will make
11706 the use of the control speculation much more conservative.
11707 The default is 'disable'.
11709 @item -mno-sched-count-spec-in-critical-path
11710 @itemx -msched-count-spec-in-critical-path
11711 @opindex mno-sched-count-spec-in-critical-path
11712 @opindex msched-count-spec-in-critical-path
11713 If enabled, speculative dependencies will be considered during
11714 computation of the instructions priorities.  This will make the use of the
11715 speculation a bit more conservative.
11716 The default is 'disable'.
11718 @end table
11720 @node M32C Options
11721 @subsection M32C Options
11722 @cindex M32C options
11724 @table @gcctabopt
11725 @item -mcpu=@var{name}
11726 @opindex mcpu=
11727 Select the CPU for which code is generated.  @var{name} may be one of
11728 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11729 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11730 the M32C/80 series.
11732 @item -msim
11733 @opindex msim
11734 Specifies that the program will be run on the simulator.  This causes
11735 an alternate runtime library to be linked in which supports, for
11736 example, file I/O@.  You must not use this option when generating
11737 programs that will run on real hardware; you must provide your own
11738 runtime library for whatever I/O functions are needed.
11740 @item -memregs=@var{number}
11741 @opindex memregs=
11742 Specifies the number of memory-based pseudo-registers GCC will use
11743 during code generation.  These pseudo-registers will be used like real
11744 registers, so there is a tradeoff between GCC's ability to fit the
11745 code into available registers, and the performance penalty of using
11746 memory instead of registers.  Note that all modules in a program must
11747 be compiled with the same value for this option.  Because of that, you
11748 must not use this option with the default runtime libraries gcc
11749 builds.
11751 @end table
11753 @node M32R/D Options
11754 @subsection M32R/D Options
11755 @cindex M32R/D options
11757 These @option{-m} options are defined for Renesas M32R/D architectures:
11759 @table @gcctabopt
11760 @item -m32r2
11761 @opindex m32r2
11762 Generate code for the M32R/2@.
11764 @item -m32rx
11765 @opindex m32rx
11766 Generate code for the M32R/X@.
11768 @item -m32r
11769 @opindex m32r
11770 Generate code for the M32R@.  This is the default.
11772 @item -mmodel=small
11773 @opindex mmodel=small
11774 Assume all objects live in the lower 16MB of memory (so that their addresses
11775 can be loaded with the @code{ld24} instruction), and assume all subroutines
11776 are reachable with the @code{bl} instruction.
11777 This is the default.
11779 The addressability of a particular object can be set with the
11780 @code{model} attribute.
11782 @item -mmodel=medium
11783 @opindex mmodel=medium
11784 Assume objects may be anywhere in the 32-bit address space (the compiler
11785 will generate @code{seth/add3} instructions to load their addresses), and
11786 assume all subroutines are reachable with the @code{bl} instruction.
11788 @item -mmodel=large
11789 @opindex mmodel=large
11790 Assume objects may be anywhere in the 32-bit address space (the compiler
11791 will generate @code{seth/add3} instructions to load their addresses), and
11792 assume subroutines may not be reachable with the @code{bl} instruction
11793 (the compiler will generate the much slower @code{seth/add3/jl}
11794 instruction sequence).
11796 @item -msdata=none
11797 @opindex msdata=none
11798 Disable use of the small data area.  Variables will be put into
11799 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11800 @code{section} attribute has been specified).
11801 This is the default.
11803 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11804 Objects may be explicitly put in the small data area with the
11805 @code{section} attribute using one of these sections.
11807 @item -msdata=sdata
11808 @opindex msdata=sdata
11809 Put small global and static data in the small data area, but do not
11810 generate special code to reference them.
11812 @item -msdata=use
11813 @opindex msdata=use
11814 Put small global and static data in the small data area, and generate
11815 special instructions to reference them.
11817 @item -G @var{num}
11818 @opindex G
11819 @cindex smaller data references
11820 Put global and static objects less than or equal to @var{num} bytes
11821 into the small data or bss sections instead of the normal data or bss
11822 sections.  The default value of @var{num} is 8.
11823 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11824 for this option to have any effect.
11826 All modules should be compiled with the same @option{-G @var{num}} value.
11827 Compiling with different values of @var{num} may or may not work; if it
11828 doesn't the linker will give an error message---incorrect code will not be
11829 generated.
11831 @item -mdebug
11832 @opindex mdebug
11833 Makes the M32R specific code in the compiler display some statistics
11834 that might help in debugging programs.
11836 @item -malign-loops
11837 @opindex malign-loops
11838 Align all loops to a 32-byte boundary.
11840 @item -mno-align-loops
11841 @opindex mno-align-loops
11842 Do not enforce a 32-byte alignment for loops.  This is the default.
11844 @item -missue-rate=@var{number}
11845 @opindex missue-rate=@var{number}
11846 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11847 or 2.
11849 @item -mbranch-cost=@var{number}
11850 @opindex mbranch-cost=@var{number}
11851 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11852 preferred over conditional code, if it is 2, then the opposite will
11853 apply.
11855 @item -mflush-trap=@var{number}
11856 @opindex mflush-trap=@var{number}
11857 Specifies the trap number to use to flush the cache.  The default is
11858 12.  Valid numbers are between 0 and 15 inclusive.
11860 @item -mno-flush-trap
11861 @opindex mno-flush-trap
11862 Specifies that the cache cannot be flushed by using a trap.
11864 @item -mflush-func=@var{name}
11865 @opindex mflush-func=@var{name}
11866 Specifies the name of the operating system function to call to flush
11867 the cache.  The default is @emph{_flush_cache}, but a function call
11868 will only be used if a trap is not available.
11870 @item -mno-flush-func
11871 @opindex mno-flush-func
11872 Indicates that there is no OS function for flushing the cache.
11874 @end table
11876 @node M680x0 Options
11877 @subsection M680x0 Options
11878 @cindex M680x0 options
11880 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11881 The default settings depend on which architecture was selected when
11882 the compiler was configured; the defaults for the most common choices
11883 are given below.
11885 @table @gcctabopt
11886 @item -march=@var{arch}
11887 @opindex march
11888 Generate code for a specific M680x0 or ColdFire instruction set
11889 architecture.  Permissible values of @var{arch} for M680x0
11890 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11891 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11892 architectures are selected according to Freescale's ISA classification
11893 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11894 @samp{isab} and @samp{isac}.
11896 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11897 code for a ColdFire target.  The @var{arch} in this macro is one of the
11898 @option{-march} arguments given above.
11900 When used together, @option{-march} and @option{-mtune} select code
11901 that runs on a family of similar processors but that is optimized
11902 for a particular microarchitecture.
11904 @item -mcpu=@var{cpu}
11905 @opindex mcpu
11906 Generate code for a specific M680x0 or ColdFire processor.
11907 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11908 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11909 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11910 below, which also classifies the CPUs into families:
11912 @multitable @columnfractions 0.20 0.80
11913 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11914 @item @samp{51qe} @tab @samp{51qe}
11915 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11916 @item @samp{5206e} @tab @samp{5206e}
11917 @item @samp{5208} @tab @samp{5207} @samp{5208}
11918 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11919 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11920 @item @samp{5216} @tab @samp{5214} @samp{5216}
11921 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11922 @item @samp{5225} @tab @samp{5224} @samp{5225}
11923 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11924 @item @samp{5249} @tab @samp{5249}
11925 @item @samp{5250} @tab @samp{5250}
11926 @item @samp{5271} @tab @samp{5270} @samp{5271}
11927 @item @samp{5272} @tab @samp{5272}
11928 @item @samp{5275} @tab @samp{5274} @samp{5275}
11929 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11930 @item @samp{5307} @tab @samp{5307}
11931 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11932 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11933 @item @samp{5407} @tab @samp{5407}
11934 @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}
11935 @end multitable
11937 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11938 @var{arch} is compatible with @var{cpu}.  Other combinations of
11939 @option{-mcpu} and @option{-march} are rejected.
11941 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11942 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11943 where the value of @var{family} is given by the table above.
11945 @item -mtune=@var{tune}
11946 @opindex mtune
11947 Tune the code for a particular microarchitecture, within the
11948 constraints set by @option{-march} and @option{-mcpu}.
11949 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11950 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11951 and @samp{cpu32}.  The ColdFire microarchitectures
11952 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11954 You can also use @option{-mtune=68020-40} for code that needs
11955 to run relatively well on 68020, 68030 and 68040 targets.
11956 @option{-mtune=68020-60} is similar but includes 68060 targets
11957 as well.  These two options select the same tuning decisions as
11958 @option{-m68020-40} and @option{-m68020-60} respectively.
11960 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11961 when tuning for 680x0 architecture @var{arch}.  It also defines
11962 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11963 option is used.  If gcc is tuning for a range of architectures,
11964 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11965 it defines the macros for every architecture in the range.
11967 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11968 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11969 of the arguments given above.
11971 @item -m68000
11972 @itemx -mc68000
11973 @opindex m68000
11974 @opindex mc68000
11975 Generate output for a 68000.  This is the default
11976 when the compiler is configured for 68000-based systems.
11977 It is equivalent to @option{-march=68000}.
11979 Use this option for microcontrollers with a 68000 or EC000 core,
11980 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11982 @item -m68010
11983 @opindex m68010
11984 Generate output for a 68010.  This is the default
11985 when the compiler is configured for 68010-based systems.
11986 It is equivalent to @option{-march=68010}.
11988 @item -m68020
11989 @itemx -mc68020
11990 @opindex m68020
11991 @opindex mc68020
11992 Generate output for a 68020.  This is the default
11993 when the compiler is configured for 68020-based systems.
11994 It is equivalent to @option{-march=68020}.
11996 @item -m68030
11997 @opindex m68030
11998 Generate output for a 68030.  This is the default when the compiler is
11999 configured for 68030-based systems.  It is equivalent to
12000 @option{-march=68030}.
12002 @item -m68040
12003 @opindex m68040
12004 Generate output for a 68040.  This is the default when the compiler is
12005 configured for 68040-based systems.  It is equivalent to
12006 @option{-march=68040}.
12008 This option inhibits the use of 68881/68882 instructions that have to be
12009 emulated by software on the 68040.  Use this option if your 68040 does not
12010 have code to emulate those instructions.
12012 @item -m68060
12013 @opindex m68060
12014 Generate output for a 68060.  This is the default when the compiler is
12015 configured for 68060-based systems.  It is equivalent to
12016 @option{-march=68060}.
12018 This option inhibits the use of 68020 and 68881/68882 instructions that
12019 have to be emulated by software on the 68060.  Use this option if your 68060
12020 does not have code to emulate those instructions.
12022 @item -mcpu32
12023 @opindex mcpu32
12024 Generate output for a CPU32.  This is the default
12025 when the compiler is configured for CPU32-based systems.
12026 It is equivalent to @option{-march=cpu32}.
12028 Use this option for microcontrollers with a
12029 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12030 68336, 68340, 68341, 68349 and 68360.
12032 @item -m5200
12033 @opindex m5200
12034 Generate output for a 520X ColdFire CPU@.  This is the default
12035 when the compiler is configured for 520X-based systems.
12036 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12037 in favor of that option.
12039 Use this option for microcontroller with a 5200 core, including
12040 the MCF5202, MCF5203, MCF5204 and MCF5206.
12042 @item -m5206e
12043 @opindex m5206e
12044 Generate output for a 5206e ColdFire CPU@.  The option is now
12045 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12047 @item -m528x
12048 @opindex m528x
12049 Generate output for a member of the ColdFire 528X family.
12050 The option is now deprecated in favor of the equivalent
12051 @option{-mcpu=528x}.
12053 @item -m5307
12054 @opindex m5307
12055 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12056 in favor of the equivalent @option{-mcpu=5307}.
12058 @item -m5407
12059 @opindex m5407
12060 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12061 in favor of the equivalent @option{-mcpu=5407}.
12063 @item -mcfv4e
12064 @opindex mcfv4e
12065 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12066 This includes use of hardware floating point instructions.
12067 The option is equivalent to @option{-mcpu=547x}, and is now
12068 deprecated in favor of that option.
12070 @item -m68020-40
12071 @opindex m68020-40
12072 Generate output for a 68040, without using any of the new instructions.
12073 This results in code which can run relatively efficiently on either a
12074 68020/68881 or a 68030 or a 68040.  The generated code does use the
12075 68881 instructions that are emulated on the 68040.
12077 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12079 @item -m68020-60
12080 @opindex m68020-60
12081 Generate output for a 68060, without using any of the new instructions.
12082 This results in code which can run relatively efficiently on either a
12083 68020/68881 or a 68030 or a 68040.  The generated code does use the
12084 68881 instructions that are emulated on the 68060.
12086 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
12088 @item -mhard-float
12089 @itemx -m68881
12090 @opindex mhard-float
12091 @opindex m68881
12092 Generate floating-point instructions.  This is the default for 68020
12093 and above, and for ColdFire devices that have an FPU@.  It defines the
12094 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
12095 on ColdFire targets.
12097 @item -msoft-float
12098 @opindex msoft-float
12099 Do not generate floating-point instructions; use library calls instead.
12100 This is the default for 68000, 68010, and 68832 targets.  It is also
12101 the default for ColdFire devices that have no FPU.
12103 @item -mdiv
12104 @itemx -mno-div
12105 @opindex mdiv
12106 @opindex mno-div
12107 Generate (do not generate) ColdFire hardware divide and remainder
12108 instructions.  If @option{-march} is used without @option{-mcpu},
12109 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
12110 architectures.  Otherwise, the default is taken from the target CPU
12111 (either the default CPU, or the one specified by @option{-mcpu}).  For
12112 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
12113 @option{-mcpu=5206e}.
12115 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
12117 @item -mshort
12118 @opindex mshort
12119 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12120 Additionally, parameters passed on the stack are also aligned to a
12121 16-bit boundary even on targets whose API mandates promotion to 32-bit.
12123 @item -mno-short
12124 @opindex mno-short
12125 Do not consider type @code{int} to be 16 bits wide.  This is the default.
12127 @item -mnobitfield
12128 @itemx -mno-bitfield
12129 @opindex mnobitfield
12130 @opindex mno-bitfield
12131 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
12132 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
12134 @item -mbitfield
12135 @opindex mbitfield
12136 Do use the bit-field instructions.  The @option{-m68020} option implies
12137 @option{-mbitfield}.  This is the default if you use a configuration
12138 designed for a 68020.
12140 @item -mrtd
12141 @opindex mrtd
12142 Use a different function-calling convention, in which functions
12143 that take a fixed number of arguments return with the @code{rtd}
12144 instruction, which pops their arguments while returning.  This
12145 saves one instruction in the caller since there is no need to pop
12146 the arguments there.
12148 This calling convention is incompatible with the one normally
12149 used on Unix, so you cannot use it if you need to call libraries
12150 compiled with the Unix compiler.
12152 Also, you must provide function prototypes for all functions that
12153 take variable numbers of arguments (including @code{printf});
12154 otherwise incorrect code will be generated for calls to those
12155 functions.
12157 In addition, seriously incorrect code will result if you call a
12158 function with too many arguments.  (Normally, extra arguments are
12159 harmlessly ignored.)
12161 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
12162 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
12164 @item -mno-rtd
12165 @opindex mno-rtd
12166 Do not use the calling conventions selected by @option{-mrtd}.
12167 This is the default.
12169 @item -malign-int
12170 @itemx -mno-align-int
12171 @opindex malign-int
12172 @opindex mno-align-int
12173 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
12174 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
12175 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
12176 Aligning variables on 32-bit boundaries produces code that runs somewhat
12177 faster on processors with 32-bit busses at the expense of more memory.
12179 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
12180 align structures containing the above types  differently than
12181 most published application binary interface specifications for the m68k.
12183 @item -mpcrel
12184 @opindex mpcrel
12185 Use the pc-relative addressing mode of the 68000 directly, instead of
12186 using a global offset table.  At present, this option implies @option{-fpic},
12187 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
12188 not presently supported with @option{-mpcrel}, though this could be supported for
12189 68020 and higher processors.
12191 @item -mno-strict-align
12192 @itemx -mstrict-align
12193 @opindex mno-strict-align
12194 @opindex mstrict-align
12195 Do not (do) assume that unaligned memory references will be handled by
12196 the system.
12198 @item -msep-data
12199 Generate code that allows the data segment to be located in a different
12200 area of memory from the text segment.  This allows for execute in place in
12201 an environment without virtual memory management.  This option implies
12202 @option{-fPIC}.
12204 @item -mno-sep-data
12205 Generate code that assumes that the data segment follows the text segment.
12206 This is the default.
12208 @item -mid-shared-library
12209 Generate code that supports shared libraries via the library ID method.
12210 This allows for execute in place and shared libraries in an environment
12211 without virtual memory management.  This option implies @option{-fPIC}.
12213 @item -mno-id-shared-library
12214 Generate code that doesn't assume ID based shared libraries are being used.
12215 This is the default.
12217 @item -mshared-library-id=n
12218 Specified the identification number of the ID based shared library being
12219 compiled.  Specifying a value of 0 will generate more compact code, specifying
12220 other values will force the allocation of that number to the current
12221 library but is no more space or time efficient than omitting this option.
12223 @item -mxgot
12224 @itemx -mno-xgot
12225 @opindex mxgot
12226 @opindex mno-xgot
12227 When generating position-independent code for ColdFire, generate code
12228 that works if the GOT has more than 8192 entries.  This code is
12229 larger and slower than code generated without this option.  On M680x0
12230 processors, this option is not needed; @option{-fPIC} suffices.
12232 GCC normally uses a single instruction to load values from the GOT@.
12233 While this is relatively efficient, it only works if the GOT
12234 is smaller than about 64k.  Anything larger causes the linker
12235 to report an error such as:
12237 @cindex relocation truncated to fit (ColdFire)
12238 @smallexample
12239 relocation truncated to fit: R_68K_GOT16O foobar
12240 @end smallexample
12242 If this happens, you should recompile your code with @option{-mxgot}.
12243 It should then work with very large GOTs.  However, code generated with
12244 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
12245 the value of a global symbol.
12247 Note that some linkers, including newer versions of the GNU linker,
12248 can create multiple GOTs and sort GOT entries.  If you have such a linker,
12249 you should only need to use @option{-mxgot} when compiling a single
12250 object file that accesses more than 8192 GOT entries.  Very few do.
12252 These options have no effect unless GCC is generating
12253 position-independent code.
12255 @end table
12257 @node M68hc1x Options
12258 @subsection M68hc1x Options
12259 @cindex M68hc1x options
12261 These are the @samp{-m} options defined for the 68hc11 and 68hc12
12262 microcontrollers.  The default values for these options depends on
12263 which style of microcontroller was selected when the compiler was configured;
12264 the defaults for the most common choices are given below.
12266 @table @gcctabopt
12267 @item -m6811
12268 @itemx -m68hc11
12269 @opindex m6811
12270 @opindex m68hc11
12271 Generate output for a 68HC11.  This is the default
12272 when the compiler is configured for 68HC11-based systems.
12274 @item -m6812
12275 @itemx -m68hc12
12276 @opindex m6812
12277 @opindex m68hc12
12278 Generate output for a 68HC12.  This is the default
12279 when the compiler is configured for 68HC12-based systems.
12281 @item -m68S12
12282 @itemx -m68hcs12
12283 @opindex m68S12
12284 @opindex m68hcs12
12285 Generate output for a 68HCS12.
12287 @item -mauto-incdec
12288 @opindex mauto-incdec
12289 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
12290 addressing modes.
12292 @item -minmax
12293 @itemx -nominmax
12294 @opindex minmax
12295 @opindex mnominmax
12296 Enable the use of 68HC12 min and max instructions.
12298 @item -mlong-calls
12299 @itemx -mno-long-calls
12300 @opindex mlong-calls
12301 @opindex mno-long-calls
12302 Treat all calls as being far away (near).  If calls are assumed to be
12303 far away, the compiler will use the @code{call} instruction to
12304 call a function and the @code{rtc} instruction for returning.
12306 @item -mshort
12307 @opindex mshort
12308 Consider type @code{int} to be 16 bits wide, like @code{short int}.
12310 @item -msoft-reg-count=@var{count}
12311 @opindex msoft-reg-count
12312 Specify the number of pseudo-soft registers which are used for the
12313 code generation.  The maximum number is 32.  Using more pseudo-soft
12314 register may or may not result in better code depending on the program.
12315 The default is 4 for 68HC11 and 2 for 68HC12.
12317 @end table
12319 @node MCore Options
12320 @subsection MCore Options
12321 @cindex MCore options
12323 These are the @samp{-m} options defined for the Motorola M*Core
12324 processors.
12326 @table @gcctabopt
12328 @item -mhardlit
12329 @itemx -mno-hardlit
12330 @opindex mhardlit
12331 @opindex mno-hardlit
12332 Inline constants into the code stream if it can be done in two
12333 instructions or less.
12335 @item -mdiv
12336 @itemx -mno-div
12337 @opindex mdiv
12338 @opindex mno-div
12339 Use the divide instruction.  (Enabled by default).
12341 @item -mrelax-immediate
12342 @itemx -mno-relax-immediate
12343 @opindex mrelax-immediate
12344 @opindex mno-relax-immediate
12345 Allow arbitrary sized immediates in bit operations.
12347 @item -mwide-bitfields
12348 @itemx -mno-wide-bitfields
12349 @opindex mwide-bitfields
12350 @opindex mno-wide-bitfields
12351 Always treat bit-fields as int-sized.
12353 @item -m4byte-functions
12354 @itemx -mno-4byte-functions
12355 @opindex m4byte-functions
12356 @opindex mno-4byte-functions
12357 Force all functions to be aligned to a four byte boundary.
12359 @item -mcallgraph-data
12360 @itemx -mno-callgraph-data
12361 @opindex mcallgraph-data
12362 @opindex mno-callgraph-data
12363 Emit callgraph information.
12365 @item -mslow-bytes
12366 @itemx -mno-slow-bytes
12367 @opindex mslow-bytes
12368 @opindex mno-slow-bytes
12369 Prefer word access when reading byte quantities.
12371 @item -mlittle-endian
12372 @itemx -mbig-endian
12373 @opindex mlittle-endian
12374 @opindex mbig-endian
12375 Generate code for a little endian target.
12377 @item -m210
12378 @itemx -m340
12379 @opindex m210
12380 @opindex m340
12381 Generate code for the 210 processor.
12382 @end table
12384 @node MIPS Options
12385 @subsection MIPS Options
12386 @cindex MIPS options
12388 @table @gcctabopt
12390 @item -EB
12391 @opindex EB
12392 Generate big-endian code.
12394 @item -EL
12395 @opindex EL
12396 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
12397 configurations.
12399 @item -march=@var{arch}
12400 @opindex march
12401 Generate code that will run on @var{arch}, which can be the name of a
12402 generic MIPS ISA, or the name of a particular processor.
12403 The ISA names are:
12404 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
12405 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
12406 The processor names are:
12407 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
12408 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
12409 @samp{5kc}, @samp{5kf},
12410 @samp{20kc},
12411 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
12412 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
12413 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
12414 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
12415 @samp{loongson2e}, @samp{loongson2f},
12416 @samp{m4k},
12417 @samp{octeon},
12418 @samp{orion},
12419 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
12420 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
12421 @samp{rm7000}, @samp{rm9000},
12422 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
12423 @samp{sb1},
12424 @samp{sr71000},
12425 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
12426 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
12427 and @samp{xlr}.
12428 The special value @samp{from-abi} selects the
12429 most compatible architecture for the selected ABI (that is,
12430 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
12432 Native Linux/GNU toolchains also support the value @samp{native},
12433 which selects the best architecture option for the host processor.
12434 @option{-march=native} has no effect if GCC does not recognize
12435 the processor.
12437 In processor names, a final @samp{000} can be abbreviated as @samp{k}
12438 (for example, @samp{-march=r2k}).  Prefixes are optional, and
12439 @samp{vr} may be written @samp{r}.
12441 Names of the form @samp{@var{n}f2_1} refer to processors with
12442 FPUs clocked at half the rate of the core, names of the form
12443 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
12444 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
12445 processors with FPUs clocked a ratio of 3:2 with respect to the core.
12446 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
12447 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
12448 accepted as synonyms for @samp{@var{n}f1_1}.
12450 GCC defines two macros based on the value of this option.  The first
12451 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
12452 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
12453 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
12454 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
12455 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
12457 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
12458 above.  In other words, it will have the full prefix and will not
12459 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
12460 the macro names the resolved architecture (either @samp{"mips1"} or
12461 @samp{"mips3"}).  It names the default architecture when no
12462 @option{-march} option is given.
12464 @item -mtune=@var{arch}
12465 @opindex mtune
12466 Optimize for @var{arch}.  Among other things, this option controls
12467 the way instructions are scheduled, and the perceived cost of arithmetic
12468 operations.  The list of @var{arch} values is the same as for
12469 @option{-march}.
12471 When this option is not used, GCC will optimize for the processor
12472 specified by @option{-march}.  By using @option{-march} and
12473 @option{-mtune} together, it is possible to generate code that will
12474 run on a family of processors, but optimize the code for one
12475 particular member of that family.
12477 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
12478 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
12479 @samp{-march} ones described above.
12481 @item -mips1
12482 @opindex mips1
12483 Equivalent to @samp{-march=mips1}.
12485 @item -mips2
12486 @opindex mips2
12487 Equivalent to @samp{-march=mips2}.
12489 @item -mips3
12490 @opindex mips3
12491 Equivalent to @samp{-march=mips3}.
12493 @item -mips4
12494 @opindex mips4
12495 Equivalent to @samp{-march=mips4}.
12497 @item -mips32
12498 @opindex mips32
12499 Equivalent to @samp{-march=mips32}.
12501 @item -mips32r2
12502 @opindex mips32r2
12503 Equivalent to @samp{-march=mips32r2}.
12505 @item -mips64
12506 @opindex mips64
12507 Equivalent to @samp{-march=mips64}.
12509 @item -mips64r2
12510 @opindex mips64r2
12511 Equivalent to @samp{-march=mips64r2}.
12513 @item -mips16
12514 @itemx -mno-mips16
12515 @opindex mips16
12516 @opindex mno-mips16
12517 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12518 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12520 MIPS16 code generation can also be controlled on a per-function basis
12521 by means of @code{mips16} and @code{nomips16} attributes.  
12522 @xref{Function Attributes}, for more information.
12524 @item -mflip-mips16
12525 @opindex mflip-mips16
12526 Generate MIPS16 code on alternating functions.  This option is provided
12527 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12528 not intended for ordinary use in compiling user code.
12530 @item -minterlink-mips16
12531 @itemx -mno-interlink-mips16
12532 @opindex minterlink-mips16
12533 @opindex mno-interlink-mips16
12534 Require (do not require) that non-MIPS16 code be link-compatible with
12535 MIPS16 code.
12537 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12538 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12539 therefore disables direct jumps unless GCC knows that the target of the
12540 jump is not MIPS16.
12542 @item -mabi=32
12543 @itemx -mabi=o64
12544 @itemx -mabi=n32
12545 @itemx -mabi=64
12546 @itemx -mabi=eabi
12547 @opindex mabi=32
12548 @opindex mabi=o64
12549 @opindex mabi=n32
12550 @opindex mabi=64
12551 @opindex mabi=eabi
12552 Generate code for the given ABI@.
12554 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12555 generates 64-bit code when you select a 64-bit architecture, but you
12556 can use @option{-mgp32} to get 32-bit code instead.
12558 For information about the O64 ABI, see
12559 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12561 GCC supports a variant of the o32 ABI in which floating-point registers
12562 are 64 rather than 32 bits wide.  You can select this combination with
12563 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12564 and @samp{mfhc1} instructions and is therefore only supported for
12565 MIPS32R2 processors.
12567 The register assignments for arguments and return values remain the
12568 same, but each scalar value is passed in a single 64-bit register
12569 rather than a pair of 32-bit registers.  For example, scalar
12570 floating-point values are returned in @samp{$f0} only, not a
12571 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12572 remains the same, but all 64 bits are saved.
12574 @item -mabicalls
12575 @itemx -mno-abicalls
12576 @opindex mabicalls
12577 @opindex mno-abicalls
12578 Generate (do not generate) code that is suitable for SVR4-style
12579 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12580 systems.
12582 @item -mshared
12583 @itemx -mno-shared
12584 Generate (do not generate) code that is fully position-independent,
12585 and that can therefore be linked into shared libraries.  This option
12586 only affects @option{-mabicalls}.
12588 All @option{-mabicalls} code has traditionally been position-independent,
12589 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12590 as an extension, the GNU toolchain allows executables to use absolute
12591 accesses for locally-binding symbols.  It can also use shorter GP
12592 initialization sequences and generate direct calls to locally-defined
12593 functions.  This mode is selected by @option{-mno-shared}.
12595 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12596 objects that can only be linked by the GNU linker.  However, the option
12597 does not affect the ABI of the final executable; it only affects the ABI
12598 of relocatable objects.  Using @option{-mno-shared} will generally make
12599 executables both smaller and quicker.
12601 @option{-mshared} is the default.
12603 @item -mplt
12604 @itemx -mno-plt
12605 @opindex mplt
12606 @opindex mno-plt
12607 Assume (do not assume) that the static and dynamic linkers
12608 support PLTs and copy relocations.  This option only affects
12609 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
12610 has no effect without @samp{-msym32}.
12612 You can make @option{-mplt} the default by configuring
12613 GCC with @option{--with-mips-plt}.  The default is
12614 @option{-mno-plt} otherwise.
12616 @item -mxgot
12617 @itemx -mno-xgot
12618 @opindex mxgot
12619 @opindex mno-xgot
12620 Lift (do not lift) the usual restrictions on the size of the global
12621 offset table.
12623 GCC normally uses a single instruction to load values from the GOT@.
12624 While this is relatively efficient, it will only work if the GOT
12625 is smaller than about 64k.  Anything larger will cause the linker
12626 to report an error such as:
12628 @cindex relocation truncated to fit (MIPS)
12629 @smallexample
12630 relocation truncated to fit: R_MIPS_GOT16 foobar
12631 @end smallexample
12633 If this happens, you should recompile your code with @option{-mxgot}.
12634 It should then work with very large GOTs, although it will also be
12635 less efficient, since it will take three instructions to fetch the
12636 value of a global symbol.
12638 Note that some linkers can create multiple GOTs.  If you have such a
12639 linker, you should only need to use @option{-mxgot} when a single object
12640 file accesses more than 64k's worth of GOT entries.  Very few do.
12642 These options have no effect unless GCC is generating position
12643 independent code.
12645 @item -mgp32
12646 @opindex mgp32
12647 Assume that general-purpose registers are 32 bits wide.
12649 @item -mgp64
12650 @opindex mgp64
12651 Assume that general-purpose registers are 64 bits wide.
12653 @item -mfp32
12654 @opindex mfp32
12655 Assume that floating-point registers are 32 bits wide.
12657 @item -mfp64
12658 @opindex mfp64
12659 Assume that floating-point registers are 64 bits wide.
12661 @item -mhard-float
12662 @opindex mhard-float
12663 Use floating-point coprocessor instructions.
12665 @item -msoft-float
12666 @opindex msoft-float
12667 Do not use floating-point coprocessor instructions.  Implement
12668 floating-point calculations using library calls instead.
12670 @item -msingle-float
12671 @opindex msingle-float
12672 Assume that the floating-point coprocessor only supports single-precision
12673 operations.
12675 @item -mdouble-float
12676 @opindex mdouble-float
12677 Assume that the floating-point coprocessor supports double-precision
12678 operations.  This is the default.
12680 @item -mllsc
12681 @itemx -mno-llsc
12682 @opindex mllsc
12683 @opindex mno-llsc
12684 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12685 implement atomic memory built-in functions.  When neither option is
12686 specified, GCC will use the instructions if the target architecture
12687 supports them.
12689 @option{-mllsc} is useful if the runtime environment can emulate the
12690 instructions and @option{-mno-llsc} can be useful when compiling for
12691 nonstandard ISAs.  You can make either option the default by
12692 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12693 respectively.  @option{--with-llsc} is the default for some
12694 configurations; see the installation documentation for details.
12696 @item -mdsp
12697 @itemx -mno-dsp
12698 @opindex mdsp
12699 @opindex mno-dsp
12700 Use (do not use) revision 1 of the MIPS DSP ASE@.
12701 @xref{MIPS DSP Built-in Functions}.  This option defines the
12702 preprocessor macro @samp{__mips_dsp}.  It also defines
12703 @samp{__mips_dsp_rev} to 1.
12705 @item -mdspr2
12706 @itemx -mno-dspr2
12707 @opindex mdspr2
12708 @opindex mno-dspr2
12709 Use (do not use) revision 2 of the MIPS DSP ASE@.
12710 @xref{MIPS DSP Built-in Functions}.  This option defines the
12711 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12712 It also defines @samp{__mips_dsp_rev} to 2.
12714 @item -msmartmips
12715 @itemx -mno-smartmips
12716 @opindex msmartmips
12717 @opindex mno-smartmips
12718 Use (do not use) the MIPS SmartMIPS ASE.
12720 @item -mpaired-single
12721 @itemx -mno-paired-single
12722 @opindex mpaired-single
12723 @opindex mno-paired-single
12724 Use (do not use) paired-single floating-point instructions.
12725 @xref{MIPS Paired-Single Support}.  This option requires
12726 hardware floating-point support to be enabled.
12728 @item -mdmx
12729 @itemx -mno-mdmx
12730 @opindex mdmx
12731 @opindex mno-mdmx
12732 Use (do not use) MIPS Digital Media Extension instructions.
12733 This option can only be used when generating 64-bit code and requires
12734 hardware floating-point support to be enabled.
12736 @item -mips3d
12737 @itemx -mno-mips3d
12738 @opindex mips3d
12739 @opindex mno-mips3d
12740 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12741 The option @option{-mips3d} implies @option{-mpaired-single}.
12743 @item -mmt
12744 @itemx -mno-mt
12745 @opindex mmt
12746 @opindex mno-mt
12747 Use (do not use) MT Multithreading instructions.
12749 @item -mlong64
12750 @opindex mlong64
12751 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12752 an explanation of the default and the way that the pointer size is
12753 determined.
12755 @item -mlong32
12756 @opindex mlong32
12757 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12759 The default size of @code{int}s, @code{long}s and pointers depends on
12760 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12761 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12762 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12763 or the same size as integer registers, whichever is smaller.
12765 @item -msym32
12766 @itemx -mno-sym32
12767 @opindex msym32
12768 @opindex mno-sym32
12769 Assume (do not assume) that all symbols have 32-bit values, regardless
12770 of the selected ABI@.  This option is useful in combination with
12771 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12772 to generate shorter and faster references to symbolic addresses.
12774 @item -G @var{num}
12775 @opindex G
12776 Put definitions of externally-visible data in a small data section
12777 if that data is no bigger than @var{num} bytes.  GCC can then access
12778 the data more efficiently; see @option{-mgpopt} for details.
12780 The default @option{-G} option depends on the configuration.
12782 @item -mlocal-sdata
12783 @itemx -mno-local-sdata
12784 @opindex mlocal-sdata
12785 @opindex mno-local-sdata
12786 Extend (do not extend) the @option{-G} behavior to local data too,
12787 such as to static variables in C@.  @option{-mlocal-sdata} is the
12788 default for all configurations.
12790 If the linker complains that an application is using too much small data,
12791 you might want to try rebuilding the less performance-critical parts with
12792 @option{-mno-local-sdata}.  You might also want to build large
12793 libraries with @option{-mno-local-sdata}, so that the libraries leave
12794 more room for the main program.
12796 @item -mextern-sdata
12797 @itemx -mno-extern-sdata
12798 @opindex mextern-sdata
12799 @opindex mno-extern-sdata
12800 Assume (do not assume) that externally-defined data will be in
12801 a small data section if that data is within the @option{-G} limit.
12802 @option{-mextern-sdata} is the default for all configurations.
12804 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12805 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12806 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12807 is placed in a small data section.  If @var{Var} is defined by another
12808 module, you must either compile that module with a high-enough
12809 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12810 definition.  If @var{Var} is common, you must link the application
12811 with a high-enough @option{-G} setting.
12813 The easiest way of satisfying these restrictions is to compile
12814 and link every module with the same @option{-G} option.  However,
12815 you may wish to build a library that supports several different
12816 small data limits.  You can do this by compiling the library with
12817 the highest supported @option{-G} setting and additionally using
12818 @option{-mno-extern-sdata} to stop the library from making assumptions
12819 about externally-defined data.
12821 @item -mgpopt
12822 @itemx -mno-gpopt
12823 @opindex mgpopt
12824 @opindex mno-gpopt
12825 Use (do not use) GP-relative accesses for symbols that are known to be
12826 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12827 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12828 configurations.
12830 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12831 might not hold the value of @code{_gp}.  For example, if the code is
12832 part of a library that might be used in a boot monitor, programs that
12833 call boot monitor routines will pass an unknown value in @code{$gp}.
12834 (In such situations, the boot monitor itself would usually be compiled
12835 with @option{-G0}.)
12837 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12838 @option{-mno-extern-sdata}.
12840 @item -membedded-data
12841 @itemx -mno-embedded-data
12842 @opindex membedded-data
12843 @opindex mno-embedded-data
12844 Allocate variables to the read-only data section first if possible, then
12845 next in the small data section if possible, otherwise in data.  This gives
12846 slightly slower code than the default, but reduces the amount of RAM required
12847 when executing, and thus may be preferred for some embedded systems.
12849 @item -muninit-const-in-rodata
12850 @itemx -mno-uninit-const-in-rodata
12851 @opindex muninit-const-in-rodata
12852 @opindex mno-uninit-const-in-rodata
12853 Put uninitialized @code{const} variables in the read-only data section.
12854 This option is only meaningful in conjunction with @option{-membedded-data}.
12856 @item -mcode-readable=@var{setting}
12857 @opindex mcode-readable
12858 Specify whether GCC may generate code that reads from executable sections.
12859 There are three possible settings:
12861 @table @gcctabopt
12862 @item -mcode-readable=yes
12863 Instructions may freely access executable sections.  This is the
12864 default setting.
12866 @item -mcode-readable=pcrel
12867 MIPS16 PC-relative load instructions can access executable sections,
12868 but other instructions must not do so.  This option is useful on 4KSc
12869 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12870 It is also useful on processors that can be configured to have a dual
12871 instruction/data SRAM interface and that, like the M4K, automatically
12872 redirect PC-relative loads to the instruction RAM.
12874 @item -mcode-readable=no
12875 Instructions must not access executable sections.  This option can be
12876 useful on targets that are configured to have a dual instruction/data
12877 SRAM interface but that (unlike the M4K) do not automatically redirect
12878 PC-relative loads to the instruction RAM.
12879 @end table
12881 @item -msplit-addresses
12882 @itemx -mno-split-addresses
12883 @opindex msplit-addresses
12884 @opindex mno-split-addresses
12885 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12886 relocation operators.  This option has been superseded by
12887 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12889 @item -mexplicit-relocs
12890 @itemx -mno-explicit-relocs
12891 @opindex mexplicit-relocs
12892 @opindex mno-explicit-relocs
12893 Use (do not use) assembler relocation operators when dealing with symbolic
12894 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12895 is to use assembler macros instead.
12897 @option{-mexplicit-relocs} is the default if GCC was configured
12898 to use an assembler that supports relocation operators.
12900 @item -mcheck-zero-division
12901 @itemx -mno-check-zero-division
12902 @opindex mcheck-zero-division
12903 @opindex mno-check-zero-division
12904 Trap (do not trap) on integer division by zero.
12906 The default is @option{-mcheck-zero-division}.
12908 @item -mdivide-traps
12909 @itemx -mdivide-breaks
12910 @opindex mdivide-traps
12911 @opindex mdivide-breaks
12912 MIPS systems check for division by zero by generating either a
12913 conditional trap or a break instruction.  Using traps results in
12914 smaller code, but is only supported on MIPS II and later.  Also, some
12915 versions of the Linux kernel have a bug that prevents trap from
12916 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12917 allow conditional traps on architectures that support them and
12918 @option{-mdivide-breaks} to force the use of breaks.
12920 The default is usually @option{-mdivide-traps}, but this can be
12921 overridden at configure time using @option{--with-divide=breaks}.
12922 Divide-by-zero checks can be completely disabled using
12923 @option{-mno-check-zero-division}.
12925 @item -mmemcpy
12926 @itemx -mno-memcpy
12927 @opindex mmemcpy
12928 @opindex mno-memcpy
12929 Force (do not force) the use of @code{memcpy()} for non-trivial block
12930 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12931 most constant-sized copies.
12933 @item -mlong-calls
12934 @itemx -mno-long-calls
12935 @opindex mlong-calls
12936 @opindex mno-long-calls
12937 Disable (do not disable) use of the @code{jal} instruction.  Calling
12938 functions using @code{jal} is more efficient but requires the caller
12939 and callee to be in the same 256 megabyte segment.
12941 This option has no effect on abicalls code.  The default is
12942 @option{-mno-long-calls}.
12944 @item -mmad
12945 @itemx -mno-mad
12946 @opindex mmad
12947 @opindex mno-mad
12948 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12949 instructions, as provided by the R4650 ISA@.
12951 @item -mfused-madd
12952 @itemx -mno-fused-madd
12953 @opindex mfused-madd
12954 @opindex mno-fused-madd
12955 Enable (disable) use of the floating point multiply-accumulate
12956 instructions, when they are available.  The default is
12957 @option{-mfused-madd}.
12959 When multiply-accumulate instructions are used, the intermediate
12960 product is calculated to infinite precision and is not subject to
12961 the FCSR Flush to Zero bit.  This may be undesirable in some
12962 circumstances.
12964 @item -nocpp
12965 @opindex nocpp
12966 Tell the MIPS assembler to not run its preprocessor over user
12967 assembler files (with a @samp{.s} suffix) when assembling them.
12969 @item -mfix-r4000
12970 @itemx -mno-fix-r4000
12971 @opindex mfix-r4000
12972 @opindex mno-fix-r4000
12973 Work around certain R4000 CPU errata:
12974 @itemize @minus
12975 @item
12976 A double-word or a variable shift may give an incorrect result if executed
12977 immediately after starting an integer division.
12978 @item
12979 A double-word or a variable shift may give an incorrect result if executed
12980 while an integer multiplication is in progress.
12981 @item
12982 An integer division may give an incorrect result if started in a delay slot
12983 of a taken branch or a jump.
12984 @end itemize
12986 @item -mfix-r4400
12987 @itemx -mno-fix-r4400
12988 @opindex mfix-r4400
12989 @opindex mno-fix-r4400
12990 Work around certain R4400 CPU errata:
12991 @itemize @minus
12992 @item
12993 A double-word or a variable shift may give an incorrect result if executed
12994 immediately after starting an integer division.
12995 @end itemize
12997 @item -mfix-r10000
12998 @itemx -mno-fix-r10000
12999 @opindex mfix-r10000
13000 @opindex mno-fix-r10000
13001 Work around certain R10000 errata:
13002 @itemize @minus
13003 @item
13004 @code{ll}/@code{sc} sequences may not behave atomically on revisions
13005 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
13006 @end itemize
13008 This option can only be used if the target architecture supports
13009 branch-likely instructions.  @option{-mfix-r10000} is the default when
13010 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
13011 otherwise.
13013 @item -mfix-vr4120
13014 @itemx -mno-fix-vr4120
13015 @opindex mfix-vr4120
13016 Work around certain VR4120 errata:
13017 @itemize @minus
13018 @item
13019 @code{dmultu} does not always produce the correct result.
13020 @item
13021 @code{div} and @code{ddiv} do not always produce the correct result if one
13022 of the operands is negative.
13023 @end itemize
13024 The workarounds for the division errata rely on special functions in
13025 @file{libgcc.a}.  At present, these functions are only provided by
13026 the @code{mips64vr*-elf} configurations.
13028 Other VR4120 errata require a nop to be inserted between certain pairs of
13029 instructions.  These errata are handled by the assembler, not by GCC itself.
13031 @item -mfix-vr4130
13032 @opindex mfix-vr4130
13033 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
13034 workarounds are implemented by the assembler rather than by GCC,
13035 although GCC will avoid using @code{mflo} and @code{mfhi} if the
13036 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
13037 instructions are available instead.
13039 @item -mfix-sb1
13040 @itemx -mno-fix-sb1
13041 @opindex mfix-sb1
13042 Work around certain SB-1 CPU core errata.
13043 (This flag currently works around the SB-1 revision 2
13044 ``F1'' and ``F2'' floating point errata.)
13046 @item -mr10k-cache-barrier=@var{setting}
13047 @opindex mr10k-cache-barrier
13048 Specify whether GCC should insert cache barriers to avoid the
13049 side-effects of speculation on R10K processors.
13051 In common with many processors, the R10K tries to predict the outcome
13052 of a conditional branch and speculatively executes instructions from
13053 the ``taken'' branch.  It later aborts these instructions if the
13054 predicted outcome was wrong.  However, on the R10K, even aborted
13055 instructions can have side effects.
13057 This problem only affects kernel stores and, depending on the system,
13058 kernel loads.  As an example, a speculatively-executed store may load
13059 the target memory into cache and mark the cache line as dirty, even if
13060 the store itself is later aborted.  If a DMA operation writes to the
13061 same area of memory before the ``dirty'' line is flushed, the cached
13062 data will overwrite the DMA-ed data.  See the R10K processor manual
13063 for a full description, including other potential problems.
13065 One workaround is to insert cache barrier instructions before every memory
13066 access that might be speculatively executed and that might have side
13067 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
13068 controls GCC's implementation of this workaround.  It assumes that
13069 aborted accesses to any byte in the following regions will not have
13070 side effects:
13072 @enumerate
13073 @item
13074 the memory occupied by the current function's stack frame;
13076 @item
13077 the memory occupied by an incoming stack argument;
13079 @item
13080 the memory occupied by an object with a link-time-constant address.
13081 @end enumerate
13083 It is the kernel's responsibility to ensure that speculative
13084 accesses to these regions are indeed safe.
13086 If the input program contains a function declaration such as:
13088 @smallexample
13089 void foo (void);
13090 @end smallexample
13092 then the implementation of @code{foo} must allow @code{j foo} and
13093 @code{jal foo} to be executed speculatively.  GCC honors this
13094 restriction for functions it compiles itself.  It expects non-GCC
13095 functions (such as hand-written assembly code) to do the same.
13097 The option has three forms:
13099 @table @gcctabopt
13100 @item -mr10k-cache-barrier=load-store
13101 Insert a cache barrier before a load or store that might be
13102 speculatively executed and that might have side effects even
13103 if aborted.
13105 @item -mr10k-cache-barrier=store
13106 Insert a cache barrier before a store that might be speculatively
13107 executed and that might have side effects even if aborted.
13109 @item -mr10k-cache-barrier=none
13110 Disable the insertion of cache barriers.  This is the default setting.
13111 @end table
13113 @item -mflush-func=@var{func}
13114 @itemx -mno-flush-func
13115 @opindex mflush-func
13116 Specifies the function to call to flush the I and D caches, or to not
13117 call any such function.  If called, the function must take the same
13118 arguments as the common @code{_flush_func()}, that is, the address of the
13119 memory range for which the cache is being flushed, the size of the
13120 memory range, and the number 3 (to flush both caches).  The default
13121 depends on the target GCC was configured for, but commonly is either
13122 @samp{_flush_func} or @samp{__cpu_flush}.
13124 @item mbranch-cost=@var{num}
13125 @opindex mbranch-cost
13126 Set the cost of branches to roughly @var{num} ``simple'' instructions.
13127 This cost is only a heuristic and is not guaranteed to produce
13128 consistent results across releases.  A zero cost redundantly selects
13129 the default, which is based on the @option{-mtune} setting.
13131 @item -mbranch-likely
13132 @itemx -mno-branch-likely
13133 @opindex mbranch-likely
13134 @opindex mno-branch-likely
13135 Enable or disable use of Branch Likely instructions, regardless of the
13136 default for the selected architecture.  By default, Branch Likely
13137 instructions may be generated if they are supported by the selected
13138 architecture.  An exception is for the MIPS32 and MIPS64 architectures
13139 and processors which implement those architectures; for those, Branch
13140 Likely instructions will not be generated by default because the MIPS32
13141 and MIPS64 architectures specifically deprecate their use.
13143 @item -mfp-exceptions
13144 @itemx -mno-fp-exceptions
13145 @opindex mfp-exceptions
13146 Specifies whether FP exceptions are enabled.  This affects how we schedule
13147 FP instructions for some processors.  The default is that FP exceptions are
13148 enabled.
13150 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
13151 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
13152 FP pipe.
13154 @item -mvr4130-align
13155 @itemx -mno-vr4130-align
13156 @opindex mvr4130-align
13157 The VR4130 pipeline is two-way superscalar, but can only issue two
13158 instructions together if the first one is 8-byte aligned.  When this
13159 option is enabled, GCC will align pairs of instructions that it
13160 thinks should execute in parallel.
13162 This option only has an effect when optimizing for the VR4130.
13163 It normally makes code faster, but at the expense of making it bigger.
13164 It is enabled by default at optimization level @option{-O3}.
13165 @end table
13167 @node MMIX Options
13168 @subsection MMIX Options
13169 @cindex MMIX Options
13171 These options are defined for the MMIX:
13173 @table @gcctabopt
13174 @item -mlibfuncs
13175 @itemx -mno-libfuncs
13176 @opindex mlibfuncs
13177 @opindex mno-libfuncs
13178 Specify that intrinsic library functions are being compiled, passing all
13179 values in registers, no matter the size.
13181 @item -mepsilon
13182 @itemx -mno-epsilon
13183 @opindex mepsilon
13184 @opindex mno-epsilon
13185 Generate floating-point comparison instructions that compare with respect
13186 to the @code{rE} epsilon register.
13188 @item -mabi=mmixware
13189 @itemx -mabi=gnu
13190 @opindex mabi-mmixware
13191 @opindex mabi=gnu
13192 Generate code that passes function parameters and return values that (in
13193 the called function) are seen as registers @code{$0} and up, as opposed to
13194 the GNU ABI which uses global registers @code{$231} and up.
13196 @item -mzero-extend
13197 @itemx -mno-zero-extend
13198 @opindex mzero-extend
13199 @opindex mno-zero-extend
13200 When reading data from memory in sizes shorter than 64 bits, use (do not
13201 use) zero-extending load instructions by default, rather than
13202 sign-extending ones.
13204 @item -mknuthdiv
13205 @itemx -mno-knuthdiv
13206 @opindex mknuthdiv
13207 @opindex mno-knuthdiv
13208 Make the result of a division yielding a remainder have the same sign as
13209 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
13210 remainder follows the sign of the dividend.  Both methods are
13211 arithmetically valid, the latter being almost exclusively used.
13213 @item -mtoplevel-symbols
13214 @itemx -mno-toplevel-symbols
13215 @opindex mtoplevel-symbols
13216 @opindex mno-toplevel-symbols
13217 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
13218 code can be used with the @code{PREFIX} assembly directive.
13220 @item -melf
13221 @opindex melf
13222 Generate an executable in the ELF format, rather than the default
13223 @samp{mmo} format used by the @command{mmix} simulator.
13225 @item -mbranch-predict
13226 @itemx -mno-branch-predict
13227 @opindex mbranch-predict
13228 @opindex mno-branch-predict
13229 Use (do not use) the probable-branch instructions, when static branch
13230 prediction indicates a probable branch.
13232 @item -mbase-addresses
13233 @itemx -mno-base-addresses
13234 @opindex mbase-addresses
13235 @opindex mno-base-addresses
13236 Generate (do not generate) code that uses @emph{base addresses}.  Using a
13237 base address automatically generates a request (handled by the assembler
13238 and the linker) for a constant to be set up in a global register.  The
13239 register is used for one or more base address requests within the range 0
13240 to 255 from the value held in the register.  The generally leads to short
13241 and fast code, but the number of different data items that can be
13242 addressed is limited.  This means that a program that uses lots of static
13243 data may require @option{-mno-base-addresses}.
13245 @item -msingle-exit
13246 @itemx -mno-single-exit
13247 @opindex msingle-exit
13248 @opindex mno-single-exit
13249 Force (do not force) generated code to have a single exit point in each
13250 function.
13251 @end table
13253 @node MN10300 Options
13254 @subsection MN10300 Options
13255 @cindex MN10300 options
13257 These @option{-m} options are defined for Matsushita MN10300 architectures:
13259 @table @gcctabopt
13260 @item -mmult-bug
13261 @opindex mmult-bug
13262 Generate code to avoid bugs in the multiply instructions for the MN10300
13263 processors.  This is the default.
13265 @item -mno-mult-bug
13266 @opindex mno-mult-bug
13267 Do not generate code to avoid bugs in the multiply instructions for the
13268 MN10300 processors.
13270 @item -mam33
13271 @opindex mam33
13272 Generate code which uses features specific to the AM33 processor.
13274 @item -mno-am33
13275 @opindex mno-am33
13276 Do not generate code which uses features specific to the AM33 processor.  This
13277 is the default.
13279 @item -mreturn-pointer-on-d0
13280 @opindex mreturn-pointer-on-d0
13281 When generating a function which returns a pointer, return the pointer
13282 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
13283 only in a0, and attempts to call such functions without a prototype
13284 would result in errors.  Note that this option is on by default; use
13285 @option{-mno-return-pointer-on-d0} to disable it.
13287 @item -mno-crt0
13288 @opindex mno-crt0
13289 Do not link in the C run-time initialization object file.
13291 @item -mrelax
13292 @opindex mrelax
13293 Indicate to the linker that it should perform a relaxation optimization pass
13294 to shorten branches, calls and absolute memory addresses.  This option only
13295 has an effect when used on the command line for the final link step.
13297 This option makes symbolic debugging impossible.
13298 @end table
13300 @node PDP-11 Options
13301 @subsection PDP-11 Options
13302 @cindex PDP-11 Options
13304 These options are defined for the PDP-11:
13306 @table @gcctabopt
13307 @item -mfpu
13308 @opindex mfpu
13309 Use hardware FPP floating point.  This is the default.  (FIS floating
13310 point on the PDP-11/40 is not supported.)
13312 @item -msoft-float
13313 @opindex msoft-float
13314 Do not use hardware floating point.
13316 @item -mac0
13317 @opindex mac0
13318 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
13320 @item -mno-ac0
13321 @opindex mno-ac0
13322 Return floating-point results in memory.  This is the default.
13324 @item -m40
13325 @opindex m40
13326 Generate code for a PDP-11/40.
13328 @item -m45
13329 @opindex m45
13330 Generate code for a PDP-11/45.  This is the default.
13332 @item -m10
13333 @opindex m10
13334 Generate code for a PDP-11/10.
13336 @item -mbcopy-builtin
13337 @opindex bcopy-builtin
13338 Use inline @code{movmemhi} patterns for copying memory.  This is the
13339 default.
13341 @item -mbcopy
13342 @opindex mbcopy
13343 Do not use inline @code{movmemhi} patterns for copying memory.
13345 @item -mint16
13346 @itemx -mno-int32
13347 @opindex mint16
13348 @opindex mno-int32
13349 Use 16-bit @code{int}.  This is the default.
13351 @item -mint32
13352 @itemx -mno-int16
13353 @opindex mint32
13354 @opindex mno-int16
13355 Use 32-bit @code{int}.
13357 @item -mfloat64
13358 @itemx -mno-float32
13359 @opindex mfloat64
13360 @opindex mno-float32
13361 Use 64-bit @code{float}.  This is the default.
13363 @item -mfloat32
13364 @itemx -mno-float64
13365 @opindex mfloat32
13366 @opindex mno-float64
13367 Use 32-bit @code{float}.
13369 @item -mabshi
13370 @opindex mabshi
13371 Use @code{abshi2} pattern.  This is the default.
13373 @item -mno-abshi
13374 @opindex mno-abshi
13375 Do not use @code{abshi2} pattern.
13377 @item -mbranch-expensive
13378 @opindex mbranch-expensive
13379 Pretend that branches are expensive.  This is for experimenting with
13380 code generation only.
13382 @item -mbranch-cheap
13383 @opindex mbranch-cheap
13384 Do not pretend that branches are expensive.  This is the default.
13386 @item -msplit
13387 @opindex msplit
13388 Generate code for a system with split I&D@.
13390 @item -mno-split
13391 @opindex mno-split
13392 Generate code for a system without split I&D@.  This is the default.
13394 @item -munix-asm
13395 @opindex munix-asm
13396 Use Unix assembler syntax.  This is the default when configured for
13397 @samp{pdp11-*-bsd}.
13399 @item -mdec-asm
13400 @opindex mdec-asm
13401 Use DEC assembler syntax.  This is the default when configured for any
13402 PDP-11 target other than @samp{pdp11-*-bsd}.
13403 @end table
13405 @node picoChip Options
13406 @subsection picoChip Options
13407 @cindex picoChip options
13409 These @samp{-m} options are defined for picoChip implementations:
13411 @table @gcctabopt
13413 @item -mae=@var{ae_type}
13414 @opindex mcpu
13415 Set the instruction set, register set, and instruction scheduling
13416 parameters for array element type @var{ae_type}.  Supported values
13417 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
13419 @option{-mae=ANY} selects a completely generic AE type.  Code
13420 generated with this option will run on any of the other AE types.  The
13421 code will not be as efficient as it would be if compiled for a specific
13422 AE type, and some types of operation (e.g., multiplication) will not
13423 work properly on all types of AE.
13425 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
13426 for compiled code, and is the default.
13428 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
13429 option may suffer from poor performance of byte (char) manipulation,
13430 since the DSP AE does not provide hardware support for byte load/stores.
13432 @item -msymbol-as-address
13433 Enable the compiler to directly use a symbol name as an address in a
13434 load/store instruction, without first loading it into a
13435 register.  Typically, the use of this option will generate larger
13436 programs, which run faster than when the option isn't used.  However, the
13437 results vary from program to program, so it is left as a user option,
13438 rather than being permanently enabled.
13440 @item -mno-inefficient-warnings
13441 Disables warnings about the generation of inefficient code.  These
13442 warnings can be generated, for example, when compiling code which
13443 performs byte-level memory operations on the MAC AE type.  The MAC AE has
13444 no hardware support for byte-level memory operations, so all byte
13445 load/stores must be synthesized from word load/store operations.  This is
13446 inefficient and a warning will be generated indicating to the programmer
13447 that they should rewrite the code to avoid byte operations, or to target
13448 an AE type which has the necessary hardware support.  This option enables
13449 the warning to be turned off.
13451 @end table
13453 @node PowerPC Options
13454 @subsection PowerPC Options
13455 @cindex PowerPC options
13457 These are listed under @xref{RS/6000 and PowerPC Options}.
13459 @node RS/6000 and PowerPC Options
13460 @subsection IBM RS/6000 and PowerPC Options
13461 @cindex RS/6000 and PowerPC Options
13462 @cindex IBM RS/6000 and PowerPC Options
13464 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
13465 @table @gcctabopt
13466 @item -mpower
13467 @itemx -mno-power
13468 @itemx -mpower2
13469 @itemx -mno-power2
13470 @itemx -mpowerpc
13471 @itemx -mno-powerpc
13472 @itemx -mpowerpc-gpopt
13473 @itemx -mno-powerpc-gpopt
13474 @itemx -mpowerpc-gfxopt
13475 @itemx -mno-powerpc-gfxopt
13476 @itemx -mpowerpc64
13477 @itemx -mno-powerpc64
13478 @itemx -mmfcrf
13479 @itemx -mno-mfcrf
13480 @itemx -mpopcntb
13481 @itemx -mno-popcntb
13482 @itemx -mfprnd
13483 @itemx -mno-fprnd
13484 @itemx -mcmpb
13485 @itemx -mno-cmpb
13486 @itemx -mmfpgpr
13487 @itemx -mno-mfpgpr
13488 @itemx -mhard-dfp
13489 @itemx -mno-hard-dfp
13490 @opindex mpower
13491 @opindex mno-power
13492 @opindex mpower2
13493 @opindex mno-power2
13494 @opindex mpowerpc
13495 @opindex mno-powerpc
13496 @opindex mpowerpc-gpopt
13497 @opindex mno-powerpc-gpopt
13498 @opindex mpowerpc-gfxopt
13499 @opindex mno-powerpc-gfxopt
13500 @opindex mpowerpc64
13501 @opindex mno-powerpc64
13502 @opindex mmfcrf
13503 @opindex mno-mfcrf
13504 @opindex mpopcntb
13505 @opindex mno-popcntb
13506 @opindex mfprnd
13507 @opindex mno-fprnd
13508 @opindex mcmpb
13509 @opindex mno-cmpb
13510 @opindex mmfpgpr
13511 @opindex mno-mfpgpr
13512 @opindex mhard-dfp
13513 @opindex mno-hard-dfp
13514 GCC supports two related instruction set architectures for the
13515 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
13516 instructions supported by the @samp{rios} chip set used in the original
13517 RS/6000 systems and the @dfn{PowerPC} instruction set is the
13518 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
13519 the IBM 4xx, 6xx, and follow-on microprocessors.
13521 Neither architecture is a subset of the other.  However there is a
13522 large common subset of instructions supported by both.  An MQ
13523 register is included in processors supporting the POWER architecture.
13525 You use these options to specify which instructions are available on the
13526 processor you are using.  The default value of these options is
13527 determined when configuring GCC@.  Specifying the
13528 @option{-mcpu=@var{cpu_type}} overrides the specification of these
13529 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
13530 rather than the options listed above.
13532 The @option{-mpower} option allows GCC to generate instructions that
13533 are found only in the POWER architecture and to use the MQ register.
13534 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
13535 to generate instructions that are present in the POWER2 architecture but
13536 not the original POWER architecture.
13538 The @option{-mpowerpc} option allows GCC to generate instructions that
13539 are found only in the 32-bit subset of the PowerPC architecture.
13540 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
13541 GCC to use the optional PowerPC architecture instructions in the
13542 General Purpose group, including floating-point square root.  Specifying
13543 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
13544 use the optional PowerPC architecture instructions in the Graphics
13545 group, including floating-point select.
13547 The @option{-mmfcrf} option allows GCC to generate the move from
13548 condition register field instruction implemented on the POWER4
13549 processor and other processors that support the PowerPC V2.01
13550 architecture.
13551 The @option{-mpopcntb} option allows GCC to generate the popcount and
13552 double precision FP reciprocal estimate instruction implemented on the
13553 POWER5 processor and other processors that support the PowerPC V2.02
13554 architecture.
13555 The @option{-mfprnd} option allows GCC to generate the FP round to
13556 integer instructions implemented on the POWER5+ processor and other
13557 processors that support the PowerPC V2.03 architecture.
13558 The @option{-mcmpb} option allows GCC to generate the compare bytes
13559 instruction implemented on the POWER6 processor and other processors
13560 that support the PowerPC V2.05 architecture.
13561 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
13562 general purpose register instructions implemented on the POWER6X
13563 processor and other processors that support the extended PowerPC V2.05
13564 architecture.
13565 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
13566 point instructions implemented on some POWER processors.
13568 The @option{-mpowerpc64} option allows GCC to generate the additional
13569 64-bit instructions that are found in the full PowerPC64 architecture
13570 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
13571 @option{-mno-powerpc64}.
13573 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
13574 will use only the instructions in the common subset of both
13575 architectures plus some special AIX common-mode calls, and will not use
13576 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
13577 permits GCC to use any instruction from either architecture and to
13578 allow use of the MQ register; specify this for the Motorola MPC601.
13580 @item -mnew-mnemonics
13581 @itemx -mold-mnemonics
13582 @opindex mnew-mnemonics
13583 @opindex mold-mnemonics
13584 Select which mnemonics to use in the generated assembler code.  With
13585 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
13586 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
13587 assembler mnemonics defined for the POWER architecture.  Instructions
13588 defined in only one architecture have only one mnemonic; GCC uses that
13589 mnemonic irrespective of which of these options is specified.
13591 GCC defaults to the mnemonics appropriate for the architecture in
13592 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
13593 value of these option.  Unless you are building a cross-compiler, you
13594 should normally not specify either @option{-mnew-mnemonics} or
13595 @option{-mold-mnemonics}, but should instead accept the default.
13597 @item -mcpu=@var{cpu_type}
13598 @opindex mcpu
13599 Set architecture type, register usage, choice of mnemonics, and
13600 instruction scheduling parameters for machine type @var{cpu_type}.
13601 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
13602 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
13603 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
13604 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
13605 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
13606 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
13607 @samp{e500mc}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
13608 @samp{power}, @samp{power2}, @samp{power3}, @samp{power4},
13609 @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{power7}
13610 @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
13611 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13613 @option{-mcpu=common} selects a completely generic processor.  Code
13614 generated under this option will run on any POWER or PowerPC processor.
13615 GCC will use only the instructions in the common subset of both
13616 architectures, and will not use the MQ register.  GCC assumes a generic
13617 processor model for scheduling purposes.
13619 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13620 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13621 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13622 types, with an appropriate, generic processor model assumed for
13623 scheduling purposes.
13625 The other options specify a specific processor.  Code generated under
13626 those options will run best on that processor, and may not run at all on
13627 others.
13629 The @option{-mcpu} options automatically enable or disable the
13630 following options:
13632 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13633 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13634 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
13635 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13637 The particular options set for any particular CPU will vary between
13638 compiler versions, depending on what setting seems to produce optimal
13639 code for that CPU; it doesn't necessarily reflect the actual hardware's
13640 capabilities.  If you wish to set an individual option to a particular
13641 value, you may specify it after the @option{-mcpu} option, like
13642 @samp{-mcpu=970 -mno-altivec}.
13644 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13645 not enabled or disabled by the @option{-mcpu} option at present because
13646 AIX does not have full support for these options.  You may still
13647 enable or disable them individually if you're sure it'll work in your
13648 environment.
13650 @item -mtune=@var{cpu_type}
13651 @opindex mtune
13652 Set the instruction scheduling parameters for machine type
13653 @var{cpu_type}, but do not set the architecture type, register usage, or
13654 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13655 values for @var{cpu_type} are used for @option{-mtune} as for
13656 @option{-mcpu}.  If both are specified, the code generated will use the
13657 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13658 scheduling parameters set by @option{-mtune}.
13660 @item -mswdiv
13661 @itemx -mno-swdiv
13662 @opindex mswdiv
13663 @opindex mno-swdiv
13664 Generate code to compute division as reciprocal estimate and iterative
13665 refinement, creating opportunities for increased throughput.  This
13666 feature requires: optional PowerPC Graphics instruction set for single
13667 precision and FRE instruction for double precision, assuming divides
13668 cannot generate user-visible traps, and the domain values not include
13669 Infinities, denormals or zero denominator.
13671 @item -maltivec
13672 @itemx -mno-altivec
13673 @opindex maltivec
13674 @opindex mno-altivec
13675 Generate code that uses (does not use) AltiVec instructions, and also
13676 enable the use of built-in functions that allow more direct access to
13677 the AltiVec instruction set.  You may also need to set
13678 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13679 enhancements.
13681 @item -mvrsave
13682 @itemx -mno-vrsave
13683 @opindex mvrsave
13684 @opindex mno-vrsave
13685 Generate VRSAVE instructions when generating AltiVec code.
13687 @item -mgen-cell-microcode
13688 @opindex mgen-cell-microcode
13689 Generate Cell microcode instructions
13691 @item -mwarn-cell-microcode
13692 @opindex mwarn-cell-microcode
13693 Warning when a Cell microcode instruction is going to emitted.  An example
13694 of a Cell microcode instruction is a variable shift.
13696 @item -msecure-plt
13697 @opindex msecure-plt
13698 Generate code that allows ld and ld.so to build executables and shared
13699 libraries with non-exec .plt and .got sections.  This is a PowerPC
13700 32-bit SYSV ABI option.
13702 @item -mbss-plt
13703 @opindex mbss-plt
13704 Generate code that uses a BSS .plt section that ld.so fills in, and
13705 requires .plt and .got sections that are both writable and executable.
13706 This is a PowerPC 32-bit SYSV ABI option.
13708 @item -misel
13709 @itemx -mno-isel
13710 @opindex misel
13711 @opindex mno-isel
13712 This switch enables or disables the generation of ISEL instructions.
13714 @item -misel=@var{yes/no}
13715 This switch has been deprecated.  Use @option{-misel} and
13716 @option{-mno-isel} instead.
13718 @item -mspe
13719 @itemx -mno-spe
13720 @opindex mspe
13721 @opindex mno-spe
13722 This switch enables or disables the generation of SPE simd
13723 instructions.
13725 @item -mpaired
13726 @itemx -mno-paired
13727 @opindex mpaired
13728 @opindex mno-paired
13729 This switch enables or disables the generation of PAIRED simd
13730 instructions.
13732 @item -mspe=@var{yes/no}
13733 This option has been deprecated.  Use @option{-mspe} and
13734 @option{-mno-spe} instead.
13736 @item -mfloat-gprs=@var{yes/single/double/no}
13737 @itemx -mfloat-gprs
13738 @opindex mfloat-gprs
13739 This switch enables or disables the generation of floating point
13740 operations on the general purpose registers for architectures that
13741 support it.
13743 The argument @var{yes} or @var{single} enables the use of
13744 single-precision floating point operations.
13746 The argument @var{double} enables the use of single and
13747 double-precision floating point operations.
13749 The argument @var{no} disables floating point operations on the
13750 general purpose registers.
13752 This option is currently only available on the MPC854x.
13754 @item -m32
13755 @itemx -m64
13756 @opindex m32
13757 @opindex m64
13758 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13759 targets (including GNU/Linux).  The 32-bit environment sets int, long
13760 and pointer to 32 bits and generates code that runs on any PowerPC
13761 variant.  The 64-bit environment sets int to 32 bits and long and
13762 pointer to 64 bits, and generates code for PowerPC64, as for
13763 @option{-mpowerpc64}.
13765 @item -mfull-toc
13766 @itemx -mno-fp-in-toc
13767 @itemx -mno-sum-in-toc
13768 @itemx -mminimal-toc
13769 @opindex mfull-toc
13770 @opindex mno-fp-in-toc
13771 @opindex mno-sum-in-toc
13772 @opindex mminimal-toc
13773 Modify generation of the TOC (Table Of Contents), which is created for
13774 every executable file.  The @option{-mfull-toc} option is selected by
13775 default.  In that case, GCC will allocate at least one TOC entry for
13776 each unique non-automatic variable reference in your program.  GCC
13777 will also place floating-point constants in the TOC@.  However, only
13778 16,384 entries are available in the TOC@.
13780 If you receive a linker error message that saying you have overflowed
13781 the available TOC space, you can reduce the amount of TOC space used
13782 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13783 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13784 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13785 generate code to calculate the sum of an address and a constant at
13786 run-time instead of putting that sum into the TOC@.  You may specify one
13787 or both of these options.  Each causes GCC to produce very slightly
13788 slower and larger code at the expense of conserving TOC space.
13790 If you still run out of space in the TOC even when you specify both of
13791 these options, specify @option{-mminimal-toc} instead.  This option causes
13792 GCC to make only one TOC entry for every file.  When you specify this
13793 option, GCC will produce code that is slower and larger but which
13794 uses extremely little TOC space.  You may wish to use this option
13795 only on files that contain less frequently executed code.
13797 @item -maix64
13798 @itemx -maix32
13799 @opindex maix64
13800 @opindex maix32
13801 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13802 @code{long} type, and the infrastructure needed to support them.
13803 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13804 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13805 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13807 @item -mxl-compat
13808 @itemx -mno-xl-compat
13809 @opindex mxl-compat
13810 @opindex mno-xl-compat
13811 Produce code that conforms more closely to IBM XL compiler semantics
13812 when using AIX-compatible ABI@.  Pass floating-point arguments to
13813 prototyped functions beyond the register save area (RSA) on the stack
13814 in addition to argument FPRs.  Do not assume that most significant
13815 double in 128-bit long double value is properly rounded when comparing
13816 values and converting to double.  Use XL symbol names for long double
13817 support routines.
13819 The AIX calling convention was extended but not initially documented to
13820 handle an obscure K&R C case of calling a function that takes the
13821 address of its arguments with fewer arguments than declared.  IBM XL
13822 compilers access floating point arguments which do not fit in the
13823 RSA from the stack when a subroutine is compiled without
13824 optimization.  Because always storing floating-point arguments on the
13825 stack is inefficient and rarely needed, this option is not enabled by
13826 default and only is necessary when calling subroutines compiled by IBM
13827 XL compilers without optimization.
13829 @item -mpe
13830 @opindex mpe
13831 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13832 application written to use message passing with special startup code to
13833 enable the application to run.  The system must have PE installed in the
13834 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13835 must be overridden with the @option{-specs=} option to specify the
13836 appropriate directory location.  The Parallel Environment does not
13837 support threads, so the @option{-mpe} option and the @option{-pthread}
13838 option are incompatible.
13840 @item -malign-natural
13841 @itemx -malign-power
13842 @opindex malign-natural
13843 @opindex malign-power
13844 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13845 @option{-malign-natural} overrides the ABI-defined alignment of larger
13846 types, such as floating-point doubles, on their natural size-based boundary.
13847 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13848 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13850 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13851 is not supported.
13853 @item -msoft-float
13854 @itemx -mhard-float
13855 @opindex msoft-float
13856 @opindex mhard-float
13857 Generate code that does not use (uses) the floating-point register set.
13858 Software floating point emulation is provided if you use the
13859 @option{-msoft-float} option, and pass the option to GCC when linking.
13861 @item -msingle-float
13862 @itemx -mdouble-float
13863 @opindex msingle-float
13864 @opindex mdouble-float
13865 Generate code for single or double-precision floating point operations. 
13866 @option{-mdouble-float} implies @option{-msingle-float}. 
13868 @item -msimple-fpu
13869 @opindex msimple-fpu
13870 Do not generate sqrt and div instructions for hardware floating point unit.
13872 @item -mfpu
13873 @opindex mfpu
13874 Specify type of floating point unit.  Valid values are @var{sp_lite} 
13875 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
13876 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
13877 and @var{dp_full} (equivalent to -mdouble-float).
13879 @item -mxilinx-fpu
13880 @opindex mxilinx-fpu
13881 Perform optimizations for floating point unit on Xilinx PPC 405/440.
13883 @item -mmultiple
13884 @itemx -mno-multiple
13885 @opindex mmultiple
13886 @opindex mno-multiple
13887 Generate code that uses (does not use) the load multiple word
13888 instructions and the store multiple word instructions.  These
13889 instructions are generated by default on POWER systems, and not
13890 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13891 endian PowerPC systems, since those instructions do not work when the
13892 processor is in little endian mode.  The exceptions are PPC740 and
13893 PPC750 which permit the instructions usage in little endian mode.
13895 @item -mstring
13896 @itemx -mno-string
13897 @opindex mstring
13898 @opindex mno-string
13899 Generate code that uses (does not use) the load string instructions
13900 and the store string word instructions to save multiple registers and
13901 do small block moves.  These instructions are generated by default on
13902 POWER systems, and not generated on PowerPC systems.  Do not use
13903 @option{-mstring} on little endian PowerPC systems, since those
13904 instructions do not work when the processor is in little endian mode.
13905 The exceptions are PPC740 and PPC750 which permit the instructions
13906 usage in little endian mode.
13908 @item -mupdate
13909 @itemx -mno-update
13910 @opindex mupdate
13911 @opindex mno-update
13912 Generate code that uses (does not use) the load or store instructions
13913 that update the base register to the address of the calculated memory
13914 location.  These instructions are generated by default.  If you use
13915 @option{-mno-update}, there is a small window between the time that the
13916 stack pointer is updated and the address of the previous frame is
13917 stored, which means code that walks the stack frame across interrupts or
13918 signals may get corrupted data.
13920 @item -mavoid-indexed-addresses
13921 @item -mno-avoid-indexed-addresses
13922 @opindex mavoid-indexed-addresses
13923 @opindex mno-avoid-indexed-addresses
13924 Generate code that tries to avoid (not avoid) the use of indexed load
13925 or store instructions. These instructions can incur a performance
13926 penalty on Power6 processors in certain situations, such as when
13927 stepping through large arrays that cross a 16M boundary.  This option
13928 is enabled by default when targetting Power6 and disabled otherwise.
13930 @item -mfused-madd
13931 @itemx -mno-fused-madd
13932 @opindex mfused-madd
13933 @opindex mno-fused-madd
13934 Generate code that uses (does not use) the floating point multiply and
13935 accumulate instructions.  These instructions are generated by default if
13936 hardware floating is used.
13938 @item -mmulhw
13939 @itemx -mno-mulhw
13940 @opindex mmulhw
13941 @opindex mno-mulhw
13942 Generate code that uses (does not use) the half-word multiply and
13943 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
13944 These instructions are generated by default when targetting those
13945 processors.
13947 @item -mdlmzb
13948 @itemx -mno-dlmzb
13949 @opindex mdlmzb
13950 @opindex mno-dlmzb
13951 Generate code that uses (does not use) the string-search @samp{dlmzb}
13952 instruction on the IBM 405, 440 and 464 processors.  This instruction is
13953 generated by default when targetting those processors.
13955 @item -mno-bit-align
13956 @itemx -mbit-align
13957 @opindex mno-bit-align
13958 @opindex mbit-align
13959 On System V.4 and embedded PowerPC systems do not (do) force structures
13960 and unions that contain bit-fields to be aligned to the base type of the
13961 bit-field.
13963 For example, by default a structure containing nothing but 8
13964 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13965 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13966 the structure would be aligned to a 1 byte boundary and be one byte in
13967 size.
13969 @item -mno-strict-align
13970 @itemx -mstrict-align
13971 @opindex mno-strict-align
13972 @opindex mstrict-align
13973 On System V.4 and embedded PowerPC systems do not (do) assume that
13974 unaligned memory references will be handled by the system.
13976 @item -mrelocatable
13977 @itemx -mno-relocatable
13978 @opindex mrelocatable
13979 @opindex mno-relocatable
13980 On embedded PowerPC systems generate code that allows (does not allow)
13981 the program to be relocated to a different address at runtime.  If you
13982 use @option{-mrelocatable} on any module, all objects linked together must
13983 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13985 @item -mrelocatable-lib
13986 @itemx -mno-relocatable-lib
13987 @opindex mrelocatable-lib
13988 @opindex mno-relocatable-lib
13989 On embedded PowerPC systems generate code that allows (does not allow)
13990 the program to be relocated to a different address at runtime.  Modules
13991 compiled with @option{-mrelocatable-lib} can be linked with either modules
13992 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13993 with modules compiled with the @option{-mrelocatable} options.
13995 @item -mno-toc
13996 @itemx -mtoc
13997 @opindex mno-toc
13998 @opindex mtoc
13999 On System V.4 and embedded PowerPC systems do not (do) assume that
14000 register 2 contains a pointer to a global area pointing to the addresses
14001 used in the program.
14003 @item -mlittle
14004 @itemx -mlittle-endian
14005 @opindex mlittle
14006 @opindex mlittle-endian
14007 On System V.4 and embedded PowerPC systems compile code for the
14008 processor in little endian mode.  The @option{-mlittle-endian} option is
14009 the same as @option{-mlittle}.
14011 @item -mbig
14012 @itemx -mbig-endian
14013 @opindex mbig
14014 @opindex mbig-endian
14015 On System V.4 and embedded PowerPC systems compile code for the
14016 processor in big endian mode.  The @option{-mbig-endian} option is
14017 the same as @option{-mbig}.
14019 @item -mdynamic-no-pic
14020 @opindex mdynamic-no-pic
14021 On Darwin and Mac OS X systems, compile code so that it is not
14022 relocatable, but that its external references are relocatable.  The
14023 resulting code is suitable for applications, but not shared
14024 libraries.
14026 @item -mprioritize-restricted-insns=@var{priority}
14027 @opindex mprioritize-restricted-insns
14028 This option controls the priority that is assigned to
14029 dispatch-slot restricted instructions during the second scheduling
14030 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
14031 @var{no/highest/second-highest} priority to dispatch slot restricted
14032 instructions.
14034 @item -msched-costly-dep=@var{dependence_type}
14035 @opindex msched-costly-dep
14036 This option controls which dependences are considered costly
14037 by the target during instruction scheduling.  The argument
14038 @var{dependence_type} takes one of the following values:
14039 @var{no}: no dependence is costly,
14040 @var{all}: all dependences are costly,
14041 @var{true_store_to_load}: a true dependence from store to load is costly,
14042 @var{store_to_load}: any dependence from store to load is costly,
14043 @var{number}: any dependence which latency >= @var{number} is costly.
14045 @item -minsert-sched-nops=@var{scheme}
14046 @opindex minsert-sched-nops
14047 This option controls which nop insertion scheme will be used during
14048 the second scheduling pass.  The argument @var{scheme} takes one of the
14049 following values:
14050 @var{no}: Don't insert nops.
14051 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
14052 according to the scheduler's grouping.
14053 @var{regroup_exact}: Insert nops to force costly dependent insns into
14054 separate groups.  Insert exactly as many nops as needed to force an insn
14055 to a new group, according to the estimated processor grouping.
14056 @var{number}: Insert nops to force costly dependent insns into
14057 separate groups.  Insert @var{number} nops to force an insn to a new group.
14059 @item -mcall-sysv
14060 @opindex mcall-sysv
14061 On System V.4 and embedded PowerPC systems compile code using calling
14062 conventions that adheres to the March 1995 draft of the System V
14063 Application Binary Interface, PowerPC processor supplement.  This is the
14064 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
14066 @item -mcall-sysv-eabi
14067 @opindex mcall-sysv-eabi
14068 Specify both @option{-mcall-sysv} and @option{-meabi} options.
14070 @item -mcall-sysv-noeabi
14071 @opindex mcall-sysv-noeabi
14072 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
14074 @item -mcall-solaris
14075 @opindex mcall-solaris
14076 On System V.4 and embedded PowerPC systems compile code for the Solaris
14077 operating system.
14079 @item -mcall-linux
14080 @opindex mcall-linux
14081 On System V.4 and embedded PowerPC systems compile code for the
14082 Linux-based GNU system.
14084 @item -mcall-gnu
14085 @opindex mcall-gnu
14086 On System V.4 and embedded PowerPC systems compile code for the
14087 Hurd-based GNU system.
14089 @item -mcall-netbsd
14090 @opindex mcall-netbsd
14091 On System V.4 and embedded PowerPC systems compile code for the
14092 NetBSD operating system.
14094 @item -maix-struct-return
14095 @opindex maix-struct-return
14096 Return all structures in memory (as specified by the AIX ABI)@.
14098 @item -msvr4-struct-return
14099 @opindex msvr4-struct-return
14100 Return structures smaller than 8 bytes in registers (as specified by the
14101 SVR4 ABI)@.
14103 @item -mabi=@var{abi-type}
14104 @opindex mabi
14105 Extend the current ABI with a particular extension, or remove such extension.
14106 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
14107 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
14109 @item -mabi=spe
14110 @opindex mabi=spe
14111 Extend the current ABI with SPE ABI extensions.  This does not change
14112 the default ABI, instead it adds the SPE ABI extensions to the current
14113 ABI@.
14115 @item -mabi=no-spe
14116 @opindex mabi=no-spe
14117 Disable Booke SPE ABI extensions for the current ABI@.
14119 @item -mabi=ibmlongdouble
14120 @opindex mabi=ibmlongdouble
14121 Change the current ABI to use IBM extended precision long double.
14122 This is a PowerPC 32-bit SYSV ABI option.
14124 @item -mabi=ieeelongdouble
14125 @opindex mabi=ieeelongdouble
14126 Change the current ABI to use IEEE extended precision long double.
14127 This is a PowerPC 32-bit Linux ABI option.
14129 @item -mprototype
14130 @itemx -mno-prototype
14131 @opindex mprototype
14132 @opindex mno-prototype
14133 On System V.4 and embedded PowerPC systems assume that all calls to
14134 variable argument functions are properly prototyped.  Otherwise, the
14135 compiler must insert an instruction before every non prototyped call to
14136 set or clear bit 6 of the condition code register (@var{CR}) to
14137 indicate whether floating point values were passed in the floating point
14138 registers in case the function takes a variable arguments.  With
14139 @option{-mprototype}, only calls to prototyped variable argument functions
14140 will set or clear the bit.
14142 @item -msim
14143 @opindex msim
14144 On embedded PowerPC systems, assume that the startup module is called
14145 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
14146 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
14147 configurations.
14149 @item -mmvme
14150 @opindex mmvme
14151 On embedded PowerPC systems, assume that the startup module is called
14152 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
14153 @file{libc.a}.
14155 @item -mads
14156 @opindex mads
14157 On embedded PowerPC systems, assume that the startup module is called
14158 @file{crt0.o} and the standard C libraries are @file{libads.a} and
14159 @file{libc.a}.
14161 @item -myellowknife
14162 @opindex myellowknife
14163 On embedded PowerPC systems, assume that the startup module is called
14164 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
14165 @file{libc.a}.
14167 @item -mvxworks
14168 @opindex mvxworks
14169 On System V.4 and embedded PowerPC systems, specify that you are
14170 compiling for a VxWorks system.
14172 @item -memb
14173 @opindex memb
14174 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
14175 header to indicate that @samp{eabi} extended relocations are used.
14177 @item -meabi
14178 @itemx -mno-eabi
14179 @opindex meabi
14180 @opindex mno-eabi
14181 On System V.4 and embedded PowerPC systems do (do not) adhere to the
14182 Embedded Applications Binary Interface (eabi) which is a set of
14183 modifications to the System V.4 specifications.  Selecting @option{-meabi}
14184 means that the stack is aligned to an 8 byte boundary, a function
14185 @code{__eabi} is called to from @code{main} to set up the eabi
14186 environment, and the @option{-msdata} option can use both @code{r2} and
14187 @code{r13} to point to two separate small data areas.  Selecting
14188 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
14189 do not call an initialization function from @code{main}, and the
14190 @option{-msdata} option will only use @code{r13} to point to a single
14191 small data area.  The @option{-meabi} option is on by default if you
14192 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
14194 @item -msdata=eabi
14195 @opindex msdata=eabi
14196 On System V.4 and embedded PowerPC systems, put small initialized
14197 @code{const} global and static data in the @samp{.sdata2} section, which
14198 is pointed to by register @code{r2}.  Put small initialized
14199 non-@code{const} global and static data in the @samp{.sdata} section,
14200 which is pointed to by register @code{r13}.  Put small uninitialized
14201 global and static data in the @samp{.sbss} section, which is adjacent to
14202 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
14203 incompatible with the @option{-mrelocatable} option.  The
14204 @option{-msdata=eabi} option also sets the @option{-memb} option.
14206 @item -msdata=sysv
14207 @opindex msdata=sysv
14208 On System V.4 and embedded PowerPC systems, put small global and static
14209 data in the @samp{.sdata} section, which is pointed to by register
14210 @code{r13}.  Put small uninitialized global and static data in the
14211 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
14212 The @option{-msdata=sysv} option is incompatible with the
14213 @option{-mrelocatable} option.
14215 @item -msdata=default
14216 @itemx -msdata
14217 @opindex msdata=default
14218 @opindex msdata
14219 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
14220 compile code the same as @option{-msdata=eabi}, otherwise compile code the
14221 same as @option{-msdata=sysv}.
14223 @item -msdata-data
14224 @opindex msdata-data
14225 On System V.4 and embedded PowerPC systems, put small global
14226 data in the @samp{.sdata} section.  Put small uninitialized global
14227 data in the @samp{.sbss} section.  Do not use register @code{r13}
14228 to address small data however.  This is the default behavior unless
14229 other @option{-msdata} options are used.
14231 @item -msdata=none
14232 @itemx -mno-sdata
14233 @opindex msdata=none
14234 @opindex mno-sdata
14235 On embedded PowerPC systems, put all initialized global and static data
14236 in the @samp{.data} section, and all uninitialized data in the
14237 @samp{.bss} section.
14239 @item -G @var{num}
14240 @opindex G
14241 @cindex smaller data references (PowerPC)
14242 @cindex .sdata/.sdata2 references (PowerPC)
14243 On embedded PowerPC systems, put global and static items less than or
14244 equal to @var{num} bytes into the small data or bss sections instead of
14245 the normal data or bss section.  By default, @var{num} is 8.  The
14246 @option{-G @var{num}} switch is also passed to the linker.
14247 All modules should be compiled with the same @option{-G @var{num}} value.
14249 @item -mregnames
14250 @itemx -mno-regnames
14251 @opindex mregnames
14252 @opindex mno-regnames
14253 On System V.4 and embedded PowerPC systems do (do not) emit register
14254 names in the assembly language output using symbolic forms.
14256 @item -mlongcall
14257 @itemx -mno-longcall
14258 @opindex mlongcall
14259 @opindex mno-longcall
14260 By default assume that all calls are far away so that a longer more
14261 expensive calling sequence is required.  This is required for calls
14262 further than 32 megabytes (33,554,432 bytes) from the current location.
14263 A short call will be generated if the compiler knows
14264 the call cannot be that far away.  This setting can be overridden by
14265 the @code{shortcall} function attribute, or by @code{#pragma
14266 longcall(0)}.
14268 Some linkers are capable of detecting out-of-range calls and generating
14269 glue code on the fly.  On these systems, long calls are unnecessary and
14270 generate slower code.  As of this writing, the AIX linker can do this,
14271 as can the GNU linker for PowerPC/64.  It is planned to add this feature
14272 to the GNU linker for 32-bit PowerPC systems as well.
14274 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
14275 callee, L42'', plus a ``branch island'' (glue code).  The two target
14276 addresses represent the callee and the ``branch island''.  The
14277 Darwin/PPC linker will prefer the first address and generate a ``bl
14278 callee'' if the PPC ``bl'' instruction will reach the callee directly;
14279 otherwise, the linker will generate ``bl L42'' to call the ``branch
14280 island''.  The ``branch island'' is appended to the body of the
14281 calling function; it computes the full 32-bit address of the callee
14282 and jumps to it.
14284 On Mach-O (Darwin) systems, this option directs the compiler emit to
14285 the glue for every direct call, and the Darwin linker decides whether
14286 to use or discard it.
14288 In the future, we may cause GCC to ignore all longcall specifications
14289 when the linker is known to generate glue.
14291 @item -pthread
14292 @opindex pthread
14293 Adds support for multithreading with the @dfn{pthreads} library.
14294 This option sets flags for both the preprocessor and linker.
14296 @end table
14298 @node S/390 and zSeries Options
14299 @subsection S/390 and zSeries Options
14300 @cindex S/390 and zSeries Options
14302 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
14304 @table @gcctabopt
14305 @item -mhard-float
14306 @itemx -msoft-float
14307 @opindex mhard-float
14308 @opindex msoft-float
14309 Use (do not use) the hardware floating-point instructions and registers
14310 for floating-point operations.  When @option{-msoft-float} is specified,
14311 functions in @file{libgcc.a} will be used to perform floating-point
14312 operations.  When @option{-mhard-float} is specified, the compiler
14313 generates IEEE floating-point instructions.  This is the default.
14315 @item -mhard-dfp
14316 @itemx -mno-hard-dfp
14317 @opindex mhard-dfp
14318 @opindex mno-hard-dfp
14319 Use (do not use) the hardware decimal-floating-point instructions for
14320 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
14321 specified, functions in @file{libgcc.a} will be used to perform
14322 decimal-floating-point operations.  When @option{-mhard-dfp} is
14323 specified, the compiler generates decimal-floating-point hardware
14324 instructions.  This is the default for @option{-march=z9-ec} or higher.
14326 @item -mlong-double-64
14327 @itemx -mlong-double-128
14328 @opindex mlong-double-64
14329 @opindex mlong-double-128
14330 These switches control the size of @code{long double} type. A size
14331 of 64bit makes the @code{long double} type equivalent to the @code{double}
14332 type. This is the default.
14334 @item -mbackchain
14335 @itemx -mno-backchain
14336 @opindex mbackchain
14337 @opindex mno-backchain
14338 Store (do not store) the address of the caller's frame as backchain pointer
14339 into the callee's stack frame.
14340 A backchain may be needed to allow debugging using tools that do not understand
14341 DWARF-2 call frame information.
14342 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
14343 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
14344 the backchain is placed into the topmost word of the 96/160 byte register
14345 save area.
14347 In general, code compiled with @option{-mbackchain} is call-compatible with
14348 code compiled with @option{-mmo-backchain}; however, use of the backchain
14349 for debugging purposes usually requires that the whole binary is built with
14350 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
14351 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
14352 to build a linux kernel use @option{-msoft-float}.
14354 The default is to not maintain the backchain.
14356 @item -mpacked-stack
14357 @itemx -mno-packed-stack
14358 @opindex mpacked-stack
14359 @opindex mno-packed-stack
14360 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
14361 specified, the compiler uses the all fields of the 96/160 byte register save
14362 area only for their default purpose; unused fields still take up stack space.
14363 When @option{-mpacked-stack} is specified, register save slots are densely
14364 packed at the top of the register save area; unused space is reused for other
14365 purposes, allowing for more efficient use of the available stack space.
14366 However, when @option{-mbackchain} is also in effect, the topmost word of
14367 the save area is always used to store the backchain, and the return address
14368 register is always saved two words below the backchain.
14370 As long as the stack frame backchain is not used, code generated with
14371 @option{-mpacked-stack} is call-compatible with code generated with
14372 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
14373 S/390 or zSeries generated code that uses the stack frame backchain at run
14374 time, not just for debugging purposes.  Such code is not call-compatible
14375 with code compiled with @option{-mpacked-stack}.  Also, note that the
14376 combination of @option{-mbackchain},
14377 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
14378 to build a linux kernel use @option{-msoft-float}.
14380 The default is to not use the packed stack layout.
14382 @item -msmall-exec
14383 @itemx -mno-small-exec
14384 @opindex msmall-exec
14385 @opindex mno-small-exec
14386 Generate (or do not generate) code using the @code{bras} instruction
14387 to do subroutine calls.
14388 This only works reliably if the total executable size does not
14389 exceed 64k.  The default is to use the @code{basr} instruction instead,
14390 which does not have this limitation.
14392 @item -m64
14393 @itemx -m31
14394 @opindex m64
14395 @opindex m31
14396 When @option{-m31} is specified, generate code compliant to the
14397 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
14398 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
14399 particular to generate 64-bit instructions.  For the @samp{s390}
14400 targets, the default is @option{-m31}, while the @samp{s390x}
14401 targets default to @option{-m64}.
14403 @item -mzarch
14404 @itemx -mesa
14405 @opindex mzarch
14406 @opindex mesa
14407 When @option{-mzarch} is specified, generate code using the
14408 instructions available on z/Architecture.
14409 When @option{-mesa} is specified, generate code using the
14410 instructions available on ESA/390.  Note that @option{-mesa} is
14411 not possible with @option{-m64}.
14412 When generating code compliant to the GNU/Linux for S/390 ABI,
14413 the default is @option{-mesa}.  When generating code compliant
14414 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
14416 @item -mmvcle
14417 @itemx -mno-mvcle
14418 @opindex mmvcle
14419 @opindex mno-mvcle
14420 Generate (or do not generate) code using the @code{mvcle} instruction
14421 to perform block moves.  When @option{-mno-mvcle} is specified,
14422 use a @code{mvc} loop instead.  This is the default unless optimizing for
14423 size.
14425 @item -mdebug
14426 @itemx -mno-debug
14427 @opindex mdebug
14428 @opindex mno-debug
14429 Print (or do not print) additional debug information when compiling.
14430 The default is to not print debug information.
14432 @item -march=@var{cpu-type}
14433 @opindex march
14434 Generate code that will run on @var{cpu-type}, which is the name of a system
14435 representing a certain processor type.  Possible values for
14436 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
14437 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
14438 When generating code using the instructions available on z/Architecture,
14439 the default is @option{-march=z900}.  Otherwise, the default is
14440 @option{-march=g5}.
14442 @item -mtune=@var{cpu-type}
14443 @opindex mtune
14444 Tune to @var{cpu-type} everything applicable about the generated code,
14445 except for the ABI and the set of available instructions.
14446 The list of @var{cpu-type} values is the same as for @option{-march}.
14447 The default is the value used for @option{-march}.
14449 @item -mtpf-trace
14450 @itemx -mno-tpf-trace
14451 @opindex mtpf-trace
14452 @opindex mno-tpf-trace
14453 Generate code that adds (does not add) in TPF OS specific branches to trace
14454 routines in the operating system.  This option is off by default, even
14455 when compiling for the TPF OS@.
14457 @item -mfused-madd
14458 @itemx -mno-fused-madd
14459 @opindex mfused-madd
14460 @opindex mno-fused-madd
14461 Generate code that uses (does not use) the floating point multiply and
14462 accumulate instructions.  These instructions are generated by default if
14463 hardware floating point is used.
14465 @item -mwarn-framesize=@var{framesize}
14466 @opindex mwarn-framesize
14467 Emit a warning if the current function exceeds the given frame size.  Because
14468 this is a compile time check it doesn't need to be a real problem when the program
14469 runs.  It is intended to identify functions which most probably cause
14470 a stack overflow.  It is useful to be used in an environment with limited stack
14471 size e.g.@: the linux kernel.
14473 @item -mwarn-dynamicstack
14474 @opindex mwarn-dynamicstack
14475 Emit a warning if the function calls alloca or uses dynamically
14476 sized arrays.  This is generally a bad idea with a limited stack size.
14478 @item -mstack-guard=@var{stack-guard}
14479 @itemx -mstack-size=@var{stack-size}
14480 @opindex mstack-guard
14481 @opindex mstack-size
14482 If these options are provided the s390 back end emits additional instructions in
14483 the function prologue which trigger a trap if the stack size is @var{stack-guard}
14484 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
14485 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
14486 the frame size of the compiled function is chosen.
14487 These options are intended to be used to help debugging stack overflow problems.
14488 The additionally emitted code causes only little overhead and hence can also be
14489 used in production like systems without greater performance degradation.  The given
14490 values have to be exact powers of 2 and @var{stack-size} has to be greater than
14491 @var{stack-guard} without exceeding 64k.
14492 In order to be efficient the extra code makes the assumption that the stack starts
14493 at an address aligned to the value given by @var{stack-size}.
14494 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
14495 @end table
14497 @node Score Options
14498 @subsection Score Options
14499 @cindex Score Options
14501 These options are defined for Score implementations:
14503 @table @gcctabopt
14504 @item -meb
14505 @opindex meb
14506 Compile code for big endian mode.  This is the default.
14508 @item -mel
14509 @opindex mel
14510 Compile code for little endian mode. 
14512 @item -mnhwloop
14513 @opindex mnhwloop
14514 Disable generate bcnz instruction.
14516 @item -muls
14517 @opindex muls
14518 Enable generate unaligned load and store instruction.
14520 @item -mmac
14521 @opindex mmac
14522 Enable the use of multiply-accumulate instructions. Disabled by default. 
14524 @item -mscore5
14525 @opindex mscore5
14526 Specify the SCORE5 as the target architecture.
14528 @item -mscore5u
14529 @opindex mscore5u
14530 Specify the SCORE5U of the target architecture.
14532 @item -mscore7
14533 @opindex mscore7
14534 Specify the SCORE7 as the target architecture. This is the default.
14536 @item -mscore7d
14537 @opindex mscore7d
14538 Specify the SCORE7D as the target architecture.
14539 @end table
14541 @node SH Options
14542 @subsection SH Options
14544 These @samp{-m} options are defined for the SH implementations:
14546 @table @gcctabopt
14547 @item -m1
14548 @opindex m1
14549 Generate code for the SH1.
14551 @item -m2
14552 @opindex m2
14553 Generate code for the SH2.
14555 @item -m2e
14556 Generate code for the SH2e.
14558 @item -m3
14559 @opindex m3
14560 Generate code for the SH3.
14562 @item -m3e
14563 @opindex m3e
14564 Generate code for the SH3e.
14566 @item -m4-nofpu
14567 @opindex m4-nofpu
14568 Generate code for the SH4 without a floating-point unit.
14570 @item -m4-single-only
14571 @opindex m4-single-only
14572 Generate code for the SH4 with a floating-point unit that only
14573 supports single-precision arithmetic.
14575 @item -m4-single
14576 @opindex m4-single
14577 Generate code for the SH4 assuming the floating-point unit is in
14578 single-precision mode by default.
14580 @item -m4
14581 @opindex m4
14582 Generate code for the SH4.
14584 @item -m4a-nofpu
14585 @opindex m4a-nofpu
14586 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
14587 floating-point unit is not used.
14589 @item -m4a-single-only
14590 @opindex m4a-single-only
14591 Generate code for the SH4a, in such a way that no double-precision
14592 floating point operations are used.
14594 @item -m4a-single
14595 @opindex m4a-single
14596 Generate code for the SH4a assuming the floating-point unit is in
14597 single-precision mode by default.
14599 @item -m4a
14600 @opindex m4a
14601 Generate code for the SH4a.
14603 @item -m4al
14604 @opindex m4al
14605 Same as @option{-m4a-nofpu}, except that it implicitly passes
14606 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
14607 instructions at the moment.
14609 @item -mb
14610 @opindex mb
14611 Compile code for the processor in big endian mode.
14613 @item -ml
14614 @opindex ml
14615 Compile code for the processor in little endian mode.
14617 @item -mdalign
14618 @opindex mdalign
14619 Align doubles at 64-bit boundaries.  Note that this changes the calling
14620 conventions, and thus some functions from the standard C library will
14621 not work unless you recompile it first with @option{-mdalign}.
14623 @item -mrelax
14624 @opindex mrelax
14625 Shorten some address references at link time, when possible; uses the
14626 linker option @option{-relax}.
14628 @item -mbigtable
14629 @opindex mbigtable
14630 Use 32-bit offsets in @code{switch} tables.  The default is to use
14631 16-bit offsets.
14633 @item -mbitops
14634 @opindex mbitops
14635 Enable the use of bit manipulation instructions on SH2A.
14637 @item -mfmovd
14638 @opindex mfmovd
14639 Enable the use of the instruction @code{fmovd}.
14641 @item -mhitachi
14642 @opindex mhitachi
14643 Comply with the calling conventions defined by Renesas.
14645 @item -mrenesas
14646 @opindex mhitachi
14647 Comply with the calling conventions defined by Renesas.
14649 @item -mno-renesas
14650 @opindex mhitachi
14651 Comply with the calling conventions defined for GCC before the Renesas
14652 conventions were available.  This option is the default for all
14653 targets of the SH toolchain except for @samp{sh-symbianelf}.
14655 @item -mnomacsave
14656 @opindex mnomacsave
14657 Mark the @code{MAC} register as call-clobbered, even if
14658 @option{-mhitachi} is given.
14660 @item -mieee
14661 @opindex mieee
14662 Increase IEEE-compliance of floating-point code.
14663 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14664 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14665 comparisons of NANs / infinities incurs extra overhead in every
14666 floating point comparison, therefore the default is set to
14667 @option{-ffinite-math-only}.
14669 @item -minline-ic_invalidate
14670 @opindex minline-ic_invalidate
14671 Inline code to invalidate instruction cache entries after setting up
14672 nested function trampolines.
14673 This option has no effect if -musermode is in effect and the selected
14674 code generation option (e.g. -m4) does not allow the use of the icbi
14675 instruction.
14676 If the selected code generation option does not allow the use of the icbi
14677 instruction, and -musermode is not in effect, the inlined code will
14678 manipulate the instruction cache address array directly with an associative
14679 write.  This not only requires privileged mode, but it will also
14680 fail if the cache line had been mapped via the TLB and has become unmapped.
14682 @item -misize
14683 @opindex misize
14684 Dump instruction size and location in the assembly code.
14686 @item -mpadstruct
14687 @opindex mpadstruct
14688 This option is deprecated.  It pads structures to multiple of 4 bytes,
14689 which is incompatible with the SH ABI@.
14691 @item -mspace
14692 @opindex mspace
14693 Optimize for space instead of speed.  Implied by @option{-Os}.
14695 @item -mprefergot
14696 @opindex mprefergot
14697 When generating position-independent code, emit function calls using
14698 the Global Offset Table instead of the Procedure Linkage Table.
14700 @item -musermode
14701 @opindex musermode
14702 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14703 if the inlined code would not work in user mode.
14704 This is the default when the target is @code{sh-*-linux*}.
14706 @item -multcost=@var{number}
14707 @opindex multcost=@var{number}
14708 Set the cost to assume for a multiply insn.
14710 @item -mdiv=@var{strategy}
14711 @opindex mdiv=@var{strategy}
14712 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14713 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14714 inv:call2, inv:fp .
14715 "fp" performs the operation in floating point.  This has a very high latency,
14716 but needs only a few instructions, so it might be a good choice if
14717 your code has enough easily exploitable ILP to allow the compiler to
14718 schedule the floating point instructions together with other instructions.
14719 Division by zero causes a floating point exception.
14720 "inv" uses integer operations to calculate the inverse of the divisor,
14721 and then multiplies the dividend with the inverse.  This strategy allows
14722 cse and hoisting of the inverse calculation.  Division by zero calculates
14723 an unspecified result, but does not trap.
14724 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14725 have been found, or if the entire operation has been hoisted to the same
14726 place, the last stages of the inverse calculation are intertwined with the
14727 final multiply to reduce the overall latency, at the expense of using a few
14728 more instructions, and thus offering fewer scheduling opportunities with
14729 other code.
14730 "call" calls a library function that usually implements the inv:minlat
14731 strategy.
14732 This gives high code density for m5-*media-nofpu compilations.
14733 "call2" uses a different entry point of the same library function, where it
14734 assumes that a pointer to a lookup table has already been set up, which
14735 exposes the pointer load to cse / code hoisting optimizations.
14736 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14737 code generation, but if the code stays unoptimized, revert to the "call",
14738 "call2", or "fp" strategies, respectively.  Note that the
14739 potentially-trapping side effect of division by zero is carried by a
14740 separate instruction, so it is possible that all the integer instructions
14741 are hoisted out, but the marker for the side effect stays where it is.
14742 A recombination to fp operations or a call is not possible in that case.
14743 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14744 that the inverse calculation was nor separated from the multiply, they speed
14745 up division where the dividend fits into 20 bits (plus sign where applicable),
14746 by inserting a test to skip a number of operations in this case; this test
14747 slows down the case of larger dividends.  inv20u assumes the case of a such
14748 a small dividend to be unlikely, and inv20l assumes it to be likely.
14750 @item -mdivsi3_libfunc=@var{name}
14751 @opindex mdivsi3_libfunc=@var{name}
14752 Set the name of the library function used for 32 bit signed division to
14753 @var{name}.  This only affect the name used in the call and inv:call
14754 division strategies, and the compiler will still expect the same
14755 sets of input/output/clobbered registers as if this option was not present.
14757 @item -mfixed-range=@var{register-range}
14758 @opindex mfixed-range
14759 Generate code treating the given register range as fixed registers.
14760 A fixed register is one that the register allocator can not use.  This is
14761 useful when compiling kernel code.  A register range is specified as
14762 two registers separated by a dash.  Multiple register ranges can be
14763 specified separated by a comma.
14765 @item -madjust-unroll
14766 @opindex madjust-unroll
14767 Throttle unrolling to avoid thrashing target registers.
14768 This option only has an effect if the gcc code base supports the
14769 TARGET_ADJUST_UNROLL_MAX target hook.
14771 @item -mindexed-addressing
14772 @opindex mindexed-addressing
14773 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14774 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14775 semantics for the indexed addressing mode.  The architecture allows the
14776 implementation of processors with 64 bit MMU, which the OS could use to
14777 get 32 bit addressing, but since no current hardware implementation supports
14778 this or any other way to make the indexed addressing mode safe to use in
14779 the 32 bit ABI, the default is -mno-indexed-addressing.
14781 @item -mgettrcost=@var{number}
14782 @opindex mgettrcost=@var{number}
14783 Set the cost assumed for the gettr instruction to @var{number}.
14784 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14786 @item -mpt-fixed
14787 @opindex mpt-fixed
14788 Assume pt* instructions won't trap.  This will generally generate better
14789 scheduled code, but is unsafe on current hardware.  The current architecture
14790 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14791 This has the unintentional effect of making it unsafe to schedule ptabs /
14792 ptrel before a branch, or hoist it out of a loop.  For example,
14793 __do_global_ctors, a part of libgcc that runs constructors at program
14794 startup, calls functions in a list which is delimited by @minus{}1.  With the
14795 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14796 That means that all the constructors will be run a bit quicker, but when
14797 the loop comes to the end of the list, the program crashes because ptabs
14798 loads @minus{}1 into a target register.  Since this option is unsafe for any
14799 hardware implementing the current architecture specification, the default
14800 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14801 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14802 this deters register allocation using target registers for storing
14803 ordinary integers.
14805 @item -minvalid-symbols
14806 @opindex minvalid-symbols
14807 Assume symbols might be invalid.  Ordinary function symbols generated by
14808 the compiler will always be valid to load with movi/shori/ptabs or
14809 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14810 to generate symbols that will cause ptabs / ptrel to trap.
14811 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14812 It will then prevent cross-basic-block cse, hoisting and most scheduling
14813 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14814 @end table
14816 @node SPARC Options
14817 @subsection SPARC Options
14818 @cindex SPARC options
14820 These @samp{-m} options are supported on the SPARC:
14822 @table @gcctabopt
14823 @item -mno-app-regs
14824 @itemx -mapp-regs
14825 @opindex mno-app-regs
14826 @opindex mapp-regs
14827 Specify @option{-mapp-regs} to generate output using the global registers
14828 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14829 is the default.
14831 To be fully SVR4 ABI compliant at the cost of some performance loss,
14832 specify @option{-mno-app-regs}.  You should compile libraries and system
14833 software with this option.
14835 @item -mfpu
14836 @itemx -mhard-float
14837 @opindex mfpu
14838 @opindex mhard-float
14839 Generate output containing floating point instructions.  This is the
14840 default.
14842 @item -mno-fpu
14843 @itemx -msoft-float
14844 @opindex mno-fpu
14845 @opindex msoft-float
14846 Generate output containing library calls for floating point.
14847 @strong{Warning:} the requisite libraries are not available for all SPARC
14848 targets.  Normally the facilities of the machine's usual C compiler are
14849 used, but this cannot be done directly in cross-compilation.  You must make
14850 your own arrangements to provide suitable library functions for
14851 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14852 @samp{sparclite-*-*} do provide software floating point support.
14854 @option{-msoft-float} changes the calling convention in the output file;
14855 therefore, it is only useful if you compile @emph{all} of a program with
14856 this option.  In particular, you need to compile @file{libgcc.a}, the
14857 library that comes with GCC, with @option{-msoft-float} in order for
14858 this to work.
14860 @item -mhard-quad-float
14861 @opindex mhard-quad-float
14862 Generate output containing quad-word (long double) floating point
14863 instructions.
14865 @item -msoft-quad-float
14866 @opindex msoft-quad-float
14867 Generate output containing library calls for quad-word (long double)
14868 floating point instructions.  The functions called are those specified
14869 in the SPARC ABI@.  This is the default.
14871 As of this writing, there are no SPARC implementations that have hardware
14872 support for the quad-word floating point instructions.  They all invoke
14873 a trap handler for one of these instructions, and then the trap handler
14874 emulates the effect of the instruction.  Because of the trap handler overhead,
14875 this is much slower than calling the ABI library routines.  Thus the
14876 @option{-msoft-quad-float} option is the default.
14878 @item -mno-unaligned-doubles
14879 @itemx -munaligned-doubles
14880 @opindex mno-unaligned-doubles
14881 @opindex munaligned-doubles
14882 Assume that doubles have 8 byte alignment.  This is the default.
14884 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14885 alignment only if they are contained in another type, or if they have an
14886 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14887 Specifying this option avoids some rare compatibility problems with code
14888 generated by other compilers.  It is not the default because it results
14889 in a performance loss, especially for floating point code.
14891 @item -mno-faster-structs
14892 @itemx -mfaster-structs
14893 @opindex mno-faster-structs
14894 @opindex mfaster-structs
14895 With @option{-mfaster-structs}, the compiler assumes that structures
14896 should have 8 byte alignment.  This enables the use of pairs of
14897 @code{ldd} and @code{std} instructions for copies in structure
14898 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14899 However, the use of this changed alignment directly violates the SPARC
14900 ABI@.  Thus, it's intended only for use on targets where the developer
14901 acknowledges that their resulting code will not be directly in line with
14902 the rules of the ABI@.
14904 @item -mimpure-text
14905 @opindex mimpure-text
14906 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14907 the compiler to not pass @option{-z text} to the linker when linking a
14908 shared object.  Using this option, you can link position-dependent
14909 code into a shared object.
14911 @option{-mimpure-text} suppresses the ``relocations remain against
14912 allocatable but non-writable sections'' linker error message.
14913 However, the necessary relocations will trigger copy-on-write, and the
14914 shared object is not actually shared across processes.  Instead of
14915 using @option{-mimpure-text}, you should compile all source code with
14916 @option{-fpic} or @option{-fPIC}.
14918 This option is only available on SunOS and Solaris.
14920 @item -mcpu=@var{cpu_type}
14921 @opindex mcpu
14922 Set the instruction set, register set, and instruction scheduling parameters
14923 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14924 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14925 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14926 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14927 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14929 Default instruction scheduling parameters are used for values that select
14930 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14931 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14933 Here is a list of each supported architecture and their supported
14934 implementations.
14936 @smallexample
14937     v7:             cypress
14938     v8:             supersparc, hypersparc
14939     sparclite:      f930, f934, sparclite86x
14940     sparclet:       tsc701
14941     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14942 @end smallexample
14944 By default (unless configured otherwise), GCC generates code for the V7
14945 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14946 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14947 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14948 SPARCStation 1, 2, IPX etc.
14950 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14951 architecture.  The only difference from V7 code is that the compiler emits
14952 the integer multiply and integer divide instructions which exist in SPARC-V8
14953 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14954 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14955 2000 series.
14957 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14958 the SPARC architecture.  This adds the integer multiply, integer divide step
14959 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14960 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14961 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14962 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14963 MB86934 chip, which is the more recent SPARClite with FPU@.
14965 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14966 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14967 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14968 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14969 optimizes it for the TEMIC SPARClet chip.
14971 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14972 architecture.  This adds 64-bit integer and floating-point move instructions,
14973 3 additional floating-point condition code registers and conditional move
14974 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14975 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14976 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14977 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14978 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14979 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14980 additionally optimizes it for Sun UltraSPARC T2 chips.
14982 @item -mtune=@var{cpu_type}
14983 @opindex mtune
14984 Set the instruction scheduling parameters for machine type
14985 @var{cpu_type}, but do not set the instruction set or register set that the
14986 option @option{-mcpu=@var{cpu_type}} would.
14988 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14989 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14990 that select a particular cpu implementation.  Those are @samp{cypress},
14991 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14992 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14993 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14995 @item -mv8plus
14996 @itemx -mno-v8plus
14997 @opindex mv8plus
14998 @opindex mno-v8plus
14999 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
15000 difference from the V8 ABI is that the global and out registers are
15001 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
15002 mode for all SPARC-V9 processors.
15004 @item -mvis
15005 @itemx -mno-vis
15006 @opindex mvis
15007 @opindex mno-vis
15008 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
15009 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
15010 @end table
15012 These @samp{-m} options are supported in addition to the above
15013 on SPARC-V9 processors in 64-bit environments:
15015 @table @gcctabopt
15016 @item -mlittle-endian
15017 @opindex mlittle-endian
15018 Generate code for a processor running in little-endian mode.  It is only
15019 available for a few configurations and most notably not on Solaris and Linux.
15021 @item -m32
15022 @itemx -m64
15023 @opindex m32
15024 @opindex m64
15025 Generate code for a 32-bit or 64-bit environment.
15026 The 32-bit environment sets int, long and pointer to 32 bits.
15027 The 64-bit environment sets int to 32 bits and long and pointer
15028 to 64 bits.
15030 @item -mcmodel=medlow
15031 @opindex mcmodel=medlow
15032 Generate code for the Medium/Low code model: 64-bit addresses, programs
15033 must be linked in the low 32 bits of memory.  Programs can be statically
15034 or dynamically linked.
15036 @item -mcmodel=medmid
15037 @opindex mcmodel=medmid
15038 Generate code for the Medium/Middle code model: 64-bit addresses, programs
15039 must be linked in the low 44 bits of memory, the text and data segments must
15040 be less than 2GB in size and the data segment must be located within 2GB of
15041 the text segment.
15043 @item -mcmodel=medany
15044 @opindex mcmodel=medany
15045 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
15046 may be linked anywhere in memory, the text and data segments must be less
15047 than 2GB in size and the data segment must be located within 2GB of the
15048 text segment.
15050 @item -mcmodel=embmedany
15051 @opindex mcmodel=embmedany
15052 Generate code for the Medium/Anywhere code model for embedded systems:
15053 64-bit addresses, the text and data segments must be less than 2GB in
15054 size, both starting anywhere in memory (determined at link time).  The
15055 global register %g4 points to the base of the data segment.  Programs
15056 are statically linked and PIC is not supported.
15058 @item -mstack-bias
15059 @itemx -mno-stack-bias
15060 @opindex mstack-bias
15061 @opindex mno-stack-bias
15062 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
15063 frame pointer if present, are offset by @minus{}2047 which must be added back
15064 when making stack frame references.  This is the default in 64-bit mode.
15065 Otherwise, assume no such offset is present.
15066 @end table
15068 These switches are supported in addition to the above on Solaris:
15070 @table @gcctabopt
15071 @item -threads
15072 @opindex threads
15073 Add support for multithreading using the Solaris threads library.  This
15074 option sets flags for both the preprocessor and linker.  This option does
15075 not affect the thread safety of object code produced by the compiler or
15076 that of libraries supplied with it.
15078 @item -pthreads
15079 @opindex pthreads
15080 Add support for multithreading using the POSIX threads library.  This
15081 option sets flags for both the preprocessor and linker.  This option does
15082 not affect the thread safety of object code produced  by the compiler or
15083 that of libraries supplied with it.
15085 @item -pthread
15086 @opindex pthread
15087 This is a synonym for @option{-pthreads}.
15088 @end table
15090 @node SPU Options
15091 @subsection SPU Options
15092 @cindex SPU options
15094 These @samp{-m} options are supported on the SPU:
15096 @table @gcctabopt
15097 @item -mwarn-reloc
15098 @itemx -merror-reloc
15099 @opindex mwarn-reloc
15100 @opindex merror-reloc
15102 The loader for SPU does not handle dynamic relocations.  By default, GCC
15103 will give an error when it generates code that requires a dynamic
15104 relocation.  @option{-mno-error-reloc} disables the error,
15105 @option{-mwarn-reloc} will generate a warning instead.
15107 @item -msafe-dma
15108 @itemx -munsafe-dma
15109 @opindex msafe-dma
15110 @opindex munsafe-dma
15112 Instructions which initiate or test completion of DMA must not be
15113 reordered with respect to loads and stores of the memory which is being
15114 accessed.  Users typically address this problem using the volatile
15115 keyword, but that can lead to inefficient code in places where the
15116 memory is known to not change.  Rather than mark the memory as volatile
15117 we treat the DMA instructions as potentially effecting all memory.  With
15118 @option{-munsafe-dma} users must use the volatile keyword to protect
15119 memory accesses.
15121 @item -mbranch-hints
15122 @opindex mbranch-hints
15124 By default, GCC will generate a branch hint instruction to avoid
15125 pipeline stalls for always taken or probably taken branches.  A hint
15126 will not be generated closer than 8 instructions away from its branch.
15127 There is little reason to disable them, except for debugging purposes,
15128 or to make an object a little bit smaller.
15130 @item -msmall-mem
15131 @itemx -mlarge-mem
15132 @opindex msmall-mem
15133 @opindex mlarge-mem
15135 By default, GCC generates code assuming that addresses are never larger
15136 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
15137 a full 32 bit address.
15139 @item -mstdmain
15140 @opindex mstdmain
15142 By default, GCC links against startup code that assumes the SPU-style
15143 main function interface (which has an unconventional parameter list).
15144 With @option{-mstdmain}, GCC will link your program against startup
15145 code that assumes a C99-style interface to @code{main}, including a
15146 local copy of @code{argv} strings.
15148 @item -mfixed-range=@var{register-range}
15149 @opindex mfixed-range
15150 Generate code treating the given register range as fixed registers.
15151 A fixed register is one that the register allocator can not use.  This is
15152 useful when compiling kernel code.  A register range is specified as
15153 two registers separated by a dash.  Multiple register ranges can be
15154 specified separated by a comma.
15156 @item -mdual-nops
15157 @itemx -mdual-nops=@var{n}
15158 @opindex mdual-nops
15159 By default, GCC will insert nops to increase dual issue when it expects
15160 it to increase performance.  @var{n} can be a value from 0 to 10.  A
15161 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
15162 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
15164 @item -mhint-max-nops=@var{n}
15165 @opindex mhint-max-nops
15166 Maximum number of nops to insert for a branch hint.  A branch hint must
15167 be at least 8 instructions away from the branch it is effecting.  GCC
15168 will insert up to @var{n} nops to enforce this, otherwise it will not
15169 generate the branch hint.
15171 @item -mhint-max-distance=@var{n}
15172 @opindex mhint-max-distance
15173 The encoding of the branch hint instruction limits the hint to be within
15174 256 instructions of the branch it is effecting.  By default, GCC makes
15175 sure it is within 125. 
15177 @item -msafe-hints
15178 @opindex msafe-hints
15179 Work around a hardware bug which causes the SPU to stall indefinitely.
15180 By default, GCC will insert the @code{hbrp} instruction to make sure
15181 this stall won't happen.
15183 @end table
15185 @node System V Options
15186 @subsection Options for System V
15188 These additional options are available on System V Release 4 for
15189 compatibility with other compilers on those systems:
15191 @table @gcctabopt
15192 @item -G
15193 @opindex G
15194 Create a shared object.
15195 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
15197 @item -Qy
15198 @opindex Qy
15199 Identify the versions of each tool used by the compiler, in a
15200 @code{.ident} assembler directive in the output.
15202 @item -Qn
15203 @opindex Qn
15204 Refrain from adding @code{.ident} directives to the output file (this is
15205 the default).
15207 @item -YP,@var{dirs}
15208 @opindex YP
15209 Search the directories @var{dirs}, and no others, for libraries
15210 specified with @option{-l}.
15212 @item -Ym,@var{dir}
15213 @opindex Ym
15214 Look in the directory @var{dir} to find the M4 preprocessor.
15215 The assembler uses this option.
15216 @c This is supposed to go with a -Yd for predefined M4 macro files, but
15217 @c the generic assembler that comes with Solaris takes just -Ym.
15218 @end table
15220 @node V850 Options
15221 @subsection V850 Options
15222 @cindex V850 Options
15224 These @samp{-m} options are defined for V850 implementations:
15226 @table @gcctabopt
15227 @item -mlong-calls
15228 @itemx -mno-long-calls
15229 @opindex mlong-calls
15230 @opindex mno-long-calls
15231 Treat all calls as being far away (near).  If calls are assumed to be
15232 far away, the compiler will always load the functions address up into a
15233 register, and call indirect through the pointer.
15235 @item -mno-ep
15236 @itemx -mep
15237 @opindex mno-ep
15238 @opindex mep
15239 Do not optimize (do optimize) basic blocks that use the same index
15240 pointer 4 or more times to copy pointer into the @code{ep} register, and
15241 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
15242 option is on by default if you optimize.
15244 @item -mno-prolog-function
15245 @itemx -mprolog-function
15246 @opindex mno-prolog-function
15247 @opindex mprolog-function
15248 Do not use (do use) external functions to save and restore registers
15249 at the prologue and epilogue of a function.  The external functions
15250 are slower, but use less code space if more than one function saves
15251 the same number of registers.  The @option{-mprolog-function} option
15252 is on by default if you optimize.
15254 @item -mspace
15255 @opindex mspace
15256 Try to make the code as small as possible.  At present, this just turns
15257 on the @option{-mep} and @option{-mprolog-function} options.
15259 @item -mtda=@var{n}
15260 @opindex mtda
15261 Put static or global variables whose size is @var{n} bytes or less into
15262 the tiny data area that register @code{ep} points to.  The tiny data
15263 area can hold up to 256 bytes in total (128 bytes for byte references).
15265 @item -msda=@var{n}
15266 @opindex msda
15267 Put static or global variables whose size is @var{n} bytes or less into
15268 the small data area that register @code{gp} points to.  The small data
15269 area can hold up to 64 kilobytes.
15271 @item -mzda=@var{n}
15272 @opindex mzda
15273 Put static or global variables whose size is @var{n} bytes or less into
15274 the first 32 kilobytes of memory.
15276 @item -mv850
15277 @opindex mv850
15278 Specify that the target processor is the V850.
15280 @item -mbig-switch
15281 @opindex mbig-switch
15282 Generate code suitable for big switch tables.  Use this option only if
15283 the assembler/linker complain about out of range branches within a switch
15284 table.
15286 @item -mapp-regs
15287 @opindex mapp-regs
15288 This option will cause r2 and r5 to be used in the code generated by
15289 the compiler.  This setting is the default.
15291 @item -mno-app-regs
15292 @opindex mno-app-regs
15293 This option will cause r2 and r5 to be treated as fixed registers.
15295 @item -mv850e1
15296 @opindex mv850e1
15297 Specify that the target processor is the V850E1.  The preprocessor
15298 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
15299 this option is used.
15301 @item -mv850e
15302 @opindex mv850e
15303 Specify that the target processor is the V850E@.  The preprocessor
15304 constant @samp{__v850e__} will be defined if this option is used.
15306 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
15307 are defined then a default target processor will be chosen and the
15308 relevant @samp{__v850*__} preprocessor constant will be defined.
15310 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
15311 defined, regardless of which processor variant is the target.
15313 @item -mdisable-callt
15314 @opindex mdisable-callt
15315 This option will suppress generation of the CALLT instruction for the
15316 v850e and v850e1 flavors of the v850 architecture.  The default is
15317 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
15319 @end table
15321 @node VAX Options
15322 @subsection VAX Options
15323 @cindex VAX options
15325 These @samp{-m} options are defined for the VAX:
15327 @table @gcctabopt
15328 @item -munix
15329 @opindex munix
15330 Do not output certain jump instructions (@code{aobleq} and so on)
15331 that the Unix assembler for the VAX cannot handle across long
15332 ranges.
15334 @item -mgnu
15335 @opindex mgnu
15336 Do output those jump instructions, on the assumption that you
15337 will assemble with the GNU assembler.
15339 @item -mg
15340 @opindex mg
15341 Output code for g-format floating point numbers instead of d-format.
15342 @end table
15344 @node VxWorks Options
15345 @subsection VxWorks Options
15346 @cindex VxWorks Options
15348 The options in this section are defined for all VxWorks targets.
15349 Options specific to the target hardware are listed with the other
15350 options for that target.
15352 @table @gcctabopt
15353 @item -mrtp
15354 @opindex mrtp
15355 GCC can generate code for both VxWorks kernels and real time processes
15356 (RTPs).  This option switches from the former to the latter.  It also
15357 defines the preprocessor macro @code{__RTP__}.
15359 @item -non-static
15360 @opindex non-static
15361 Link an RTP executable against shared libraries rather than static
15362 libraries.  The options @option{-static} and @option{-shared} can
15363 also be used for RTPs (@pxref{Link Options}); @option{-static}
15364 is the default.
15366 @item -Bstatic
15367 @itemx -Bdynamic
15368 @opindex Bstatic
15369 @opindex Bdynamic
15370 These options are passed down to the linker.  They are defined for
15371 compatibility with Diab.
15373 @item -Xbind-lazy
15374 @opindex Xbind-lazy
15375 Enable lazy binding of function calls.  This option is equivalent to
15376 @option{-Wl,-z,now} and is defined for compatibility with Diab.
15378 @item -Xbind-now
15379 @opindex Xbind-now
15380 Disable lazy binding of function calls.  This option is the default and
15381 is defined for compatibility with Diab.
15382 @end table
15384 @node x86-64 Options
15385 @subsection x86-64 Options
15386 @cindex x86-64 options
15388 These are listed under @xref{i386 and x86-64 Options}.
15390 @node Xstormy16 Options
15391 @subsection Xstormy16 Options
15392 @cindex Xstormy16 Options
15394 These options are defined for Xstormy16:
15396 @table @gcctabopt
15397 @item -msim
15398 @opindex msim
15399 Choose startup files and linker script suitable for the simulator.
15400 @end table
15402 @node Xtensa Options
15403 @subsection Xtensa Options
15404 @cindex Xtensa Options
15406 These options are supported for Xtensa targets:
15408 @table @gcctabopt
15409 @item -mconst16
15410 @itemx -mno-const16
15411 @opindex mconst16
15412 @opindex mno-const16
15413 Enable or disable use of @code{CONST16} instructions for loading
15414 constant values.  The @code{CONST16} instruction is currently not a
15415 standard option from Tensilica.  When enabled, @code{CONST16}
15416 instructions are always used in place of the standard @code{L32R}
15417 instructions.  The use of @code{CONST16} is enabled by default only if
15418 the @code{L32R} instruction is not available.
15420 @item -mfused-madd
15421 @itemx -mno-fused-madd
15422 @opindex mfused-madd
15423 @opindex mno-fused-madd
15424 Enable or disable use of fused multiply/add and multiply/subtract
15425 instructions in the floating-point option.  This has no effect if the
15426 floating-point option is not also enabled.  Disabling fused multiply/add
15427 and multiply/subtract instructions forces the compiler to use separate
15428 instructions for the multiply and add/subtract operations.  This may be
15429 desirable in some cases where strict IEEE 754-compliant results are
15430 required: the fused multiply add/subtract instructions do not round the
15431 intermediate result, thereby producing results with @emph{more} bits of
15432 precision than specified by the IEEE standard.  Disabling fused multiply
15433 add/subtract instructions also ensures that the program output is not
15434 sensitive to the compiler's ability to combine multiply and add/subtract
15435 operations.
15437 @item -mserialize-volatile
15438 @itemx -mno-serialize-volatile
15439 @opindex mserialize-volatile
15440 @opindex mno-serialize-volatile
15441 When this option is enabled, GCC inserts @code{MEMW} instructions before
15442 @code{volatile} memory references to guarantee sequential consistency.
15443 The default is @option{-mserialize-volatile}.  Use
15444 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
15446 @item -mtext-section-literals
15447 @itemx -mno-text-section-literals
15448 @opindex mtext-section-literals
15449 @opindex mno-text-section-literals
15450 Control the treatment of literal pools.  The default is
15451 @option{-mno-text-section-literals}, which places literals in a separate
15452 section in the output file.  This allows the literal pool to be placed
15453 in a data RAM/ROM, and it also allows the linker to combine literal
15454 pools from separate object files to remove redundant literals and
15455 improve code size.  With @option{-mtext-section-literals}, the literals
15456 are interspersed in the text section in order to keep them as close as
15457 possible to their references.  This may be necessary for large assembly
15458 files.
15460 @item -mtarget-align
15461 @itemx -mno-target-align
15462 @opindex mtarget-align
15463 @opindex mno-target-align
15464 When this option is enabled, GCC instructs the assembler to
15465 automatically align instructions to reduce branch penalties at the
15466 expense of some code density.  The assembler attempts to widen density
15467 instructions to align branch targets and the instructions following call
15468 instructions.  If there are not enough preceding safe density
15469 instructions to align a target, no widening will be performed.  The
15470 default is @option{-mtarget-align}.  These options do not affect the
15471 treatment of auto-aligned instructions like @code{LOOP}, which the
15472 assembler will always align, either by widening density instructions or
15473 by inserting no-op instructions.
15475 @item -mlongcalls
15476 @itemx -mno-longcalls
15477 @opindex mlongcalls
15478 @opindex mno-longcalls
15479 When this option is enabled, GCC instructs the assembler to translate
15480 direct calls to indirect calls unless it can determine that the target
15481 of a direct call is in the range allowed by the call instruction.  This
15482 translation typically occurs for calls to functions in other source
15483 files.  Specifically, the assembler translates a direct @code{CALL}
15484 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
15485 The default is @option{-mno-longcalls}.  This option should be used in
15486 programs where the call target can potentially be out of range.  This
15487 option is implemented in the assembler, not the compiler, so the
15488 assembly code generated by GCC will still show direct call
15489 instructions---look at the disassembled object code to see the actual
15490 instructions.  Note that the assembler will use an indirect call for
15491 every cross-file call, not just those that really will be out of range.
15492 @end table
15494 @node zSeries Options
15495 @subsection zSeries Options
15496 @cindex zSeries options
15498 These are listed under @xref{S/390 and zSeries Options}.
15500 @node Code Gen Options
15501 @section Options for Code Generation Conventions
15502 @cindex code generation conventions
15503 @cindex options, code generation
15504 @cindex run-time options
15506 These machine-independent options control the interface conventions
15507 used in code generation.
15509 Most of them have both positive and negative forms; the negative form
15510 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
15511 one of the forms is listed---the one which is not the default.  You
15512 can figure out the other form by either removing @samp{no-} or adding
15515 @table @gcctabopt
15516 @item -fbounds-check
15517 @opindex fbounds-check
15518 For front-ends that support it, generate additional code to check that
15519 indices used to access arrays are within the declared range.  This is
15520 currently only supported by the Java and Fortran front-ends, where
15521 this option defaults to true and false respectively.
15523 @item -ftrapv
15524 @opindex ftrapv
15525 This option generates traps for signed overflow on addition, subtraction,
15526 multiplication operations.
15528 @item -fwrapv
15529 @opindex fwrapv
15530 This option instructs the compiler to assume that signed arithmetic
15531 overflow of addition, subtraction and multiplication wraps around
15532 using twos-complement representation.  This flag enables some optimizations
15533 and disables others.  This option is enabled by default for the Java
15534 front-end, as required by the Java language specification.
15536 @item -fexceptions
15537 @opindex fexceptions
15538 Enable exception handling.  Generates extra code needed to propagate
15539 exceptions.  For some targets, this implies GCC will generate frame
15540 unwind information for all functions, which can produce significant data
15541 size overhead, although it does not affect execution.  If you do not
15542 specify this option, GCC will enable it by default for languages like
15543 C++ which normally require exception handling, and disable it for
15544 languages like C that do not normally require it.  However, you may need
15545 to enable this option when compiling C code that needs to interoperate
15546 properly with exception handlers written in C++.  You may also wish to
15547 disable this option if you are compiling older C++ programs that don't
15548 use exception handling.
15550 @item -fnon-call-exceptions
15551 @opindex fnon-call-exceptions
15552 Generate code that allows trapping instructions to throw exceptions.
15553 Note that this requires platform-specific runtime support that does
15554 not exist everywhere.  Moreover, it only allows @emph{trapping}
15555 instructions to throw exceptions, i.e.@: memory references or floating
15556 point instructions.  It does not allow exceptions to be thrown from
15557 arbitrary signal handlers such as @code{SIGALRM}.
15559 @item -funwind-tables
15560 @opindex funwind-tables
15561 Similar to @option{-fexceptions}, except that it will just generate any needed
15562 static data, but will not affect the generated code in any other way.
15563 You will normally not enable this option; instead, a language processor
15564 that needs this handling would enable it on your behalf.
15566 @item -fasynchronous-unwind-tables
15567 @opindex fasynchronous-unwind-tables
15568 Generate unwind table in dwarf2 format, if supported by target machine.  The
15569 table is exact at each instruction boundary, so it can be used for stack
15570 unwinding from asynchronous events (such as debugger or garbage collector).
15572 @item -fpcc-struct-return
15573 @opindex fpcc-struct-return
15574 Return ``short'' @code{struct} and @code{union} values in memory like
15575 longer ones, rather than in registers.  This convention is less
15576 efficient, but it has the advantage of allowing intercallability between
15577 GCC-compiled files and files compiled with other compilers, particularly
15578 the Portable C Compiler (pcc).
15580 The precise convention for returning structures in memory depends
15581 on the target configuration macros.
15583 Short structures and unions are those whose size and alignment match
15584 that of some integer type.
15586 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
15587 switch is not binary compatible with code compiled with the
15588 @option{-freg-struct-return} switch.
15589 Use it to conform to a non-default application binary interface.
15591 @item -freg-struct-return
15592 @opindex freg-struct-return
15593 Return @code{struct} and @code{union} values in registers when possible.
15594 This is more efficient for small structures than
15595 @option{-fpcc-struct-return}.
15597 If you specify neither @option{-fpcc-struct-return} nor
15598 @option{-freg-struct-return}, GCC defaults to whichever convention is
15599 standard for the target.  If there is no standard convention, GCC
15600 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
15601 the principal compiler.  In those cases, we can choose the standard, and
15602 we chose the more efficient register return alternative.
15604 @strong{Warning:} code compiled with the @option{-freg-struct-return}
15605 switch is not binary compatible with code compiled with the
15606 @option{-fpcc-struct-return} switch.
15607 Use it to conform to a non-default application binary interface.
15609 @item -fshort-enums
15610 @opindex fshort-enums
15611 Allocate to an @code{enum} type only as many bytes as it needs for the
15612 declared range of possible values.  Specifically, the @code{enum} type
15613 will be equivalent to the smallest integer type which has enough room.
15615 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
15616 code that is not binary compatible with code generated without that switch.
15617 Use it to conform to a non-default application binary interface.
15619 @item -fshort-double
15620 @opindex fshort-double
15621 Use the same size for @code{double} as for @code{float}.
15623 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
15624 code that is not binary compatible with code generated without that switch.
15625 Use it to conform to a non-default application binary interface.
15627 @item -fshort-wchar
15628 @opindex fshort-wchar
15629 Override the underlying type for @samp{wchar_t} to be @samp{short
15630 unsigned int} instead of the default for the target.  This option is
15631 useful for building programs to run under WINE@.
15633 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
15634 code that is not binary compatible with code generated without that switch.
15635 Use it to conform to a non-default application binary interface.
15637 @item -fno-common
15638 @opindex fno-common
15639 In C, allocate even uninitialized global variables in the data section of the
15640 object file, rather than generating them as common blocks.  This has the
15641 effect that if the same variable is declared (without @code{extern}) in
15642 two different compilations, you will get an error when you link them.
15643 The only reason this might be useful is if you wish to verify that the
15644 program will work on other systems which always work this way.
15646 @item -fno-ident
15647 @opindex fno-ident
15648 Ignore the @samp{#ident} directive.
15650 @item -finhibit-size-directive
15651 @opindex finhibit-size-directive
15652 Don't output a @code{.size} assembler directive, or anything else that
15653 would cause trouble if the function is split in the middle, and the
15654 two halves are placed at locations far apart in memory.  This option is
15655 used when compiling @file{crtstuff.c}; you should not need to use it
15656 for anything else.
15658 @item -fverbose-asm
15659 @opindex fverbose-asm
15660 Put extra commentary information in the generated assembly code to
15661 make it more readable.  This option is generally only of use to those
15662 who actually need to read the generated assembly code (perhaps while
15663 debugging the compiler itself).
15665 @option{-fno-verbose-asm}, the default, causes the
15666 extra information to be omitted and is useful when comparing two assembler
15667 files.
15669 @item -frecord-gcc-switches
15670 @opindex frecord-gcc-switches
15671 This switch causes the command line that was used to invoke the
15672 compiler to be recorded into the object file that is being created.
15673 This switch is only implemented on some targets and the exact format
15674 of the recording is target and binary file format dependent, but it
15675 usually takes the form of a section containing ASCII text.  This
15676 switch is related to the @option{-fverbose-asm} switch, but that
15677 switch only records information in the assembler output file as
15678 comments, so it never reaches the object file.
15680 @item -fpic
15681 @opindex fpic
15682 @cindex global offset table
15683 @cindex PIC
15684 Generate position-independent code (PIC) suitable for use in a shared
15685 library, if supported for the target machine.  Such code accesses all
15686 constant addresses through a global offset table (GOT)@.  The dynamic
15687 loader resolves the GOT entries when the program starts (the dynamic
15688 loader is not part of GCC; it is part of the operating system).  If
15689 the GOT size for the linked executable exceeds a machine-specific
15690 maximum size, you get an error message from the linker indicating that
15691 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15692 instead.  (These maximums are 8k on the SPARC and 32k
15693 on the m68k and RS/6000.  The 386 has no such limit.)
15695 Position-independent code requires special support, and therefore works
15696 only on certain machines.  For the 386, GCC supports PIC for System V
15697 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15698 position-independent.
15700 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15701 are defined to 1.
15703 @item -fPIC
15704 @opindex fPIC
15705 If supported for the target machine, emit position-independent code,
15706 suitable for dynamic linking and avoiding any limit on the size of the
15707 global offset table.  This option makes a difference on the m68k,
15708 PowerPC and SPARC@.
15710 Position-independent code requires special support, and therefore works
15711 only on certain machines.
15713 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15714 are defined to 2.
15716 @item -fpie
15717 @itemx -fPIE
15718 @opindex fpie
15719 @opindex fPIE
15720 These options are similar to @option{-fpic} and @option{-fPIC}, but
15721 generated position independent code can be only linked into executables.
15722 Usually these options are used when @option{-pie} GCC option will be
15723 used during linking.
15725 @option{-fpie} and @option{-fPIE} both define the macros
15726 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15727 for @option{-fpie} and 2 for @option{-fPIE}.
15729 @item -fno-jump-tables
15730 @opindex fno-jump-tables
15731 Do not use jump tables for switch statements even where it would be
15732 more efficient than other code generation strategies.  This option is
15733 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15734 building code which forms part of a dynamic linker and cannot
15735 reference the address of a jump table.  On some targets, jump tables
15736 do not require a GOT and this option is not needed.
15738 @item -ffixed-@var{reg}
15739 @opindex ffixed
15740 Treat the register named @var{reg} as a fixed register; generated code
15741 should never refer to it (except perhaps as a stack pointer, frame
15742 pointer or in some other fixed role).
15744 @var{reg} must be the name of a register.  The register names accepted
15745 are machine-specific and are defined in the @code{REGISTER_NAMES}
15746 macro in the machine description macro file.
15748 This flag does not have a negative form, because it specifies a
15749 three-way choice.
15751 @item -fcall-used-@var{reg}
15752 @opindex fcall-used
15753 Treat the register named @var{reg} as an allocable register that is
15754 clobbered by function calls.  It may be allocated for temporaries or
15755 variables that do not live across a call.  Functions compiled this way
15756 will not save and restore the register @var{reg}.
15758 It is an error to used this flag with the frame pointer or stack pointer.
15759 Use of this flag for other registers that have fixed pervasive roles in
15760 the machine's execution model will produce disastrous results.
15762 This flag does not have a negative form, because it specifies a
15763 three-way choice.
15765 @item -fcall-saved-@var{reg}
15766 @opindex fcall-saved
15767 Treat the register named @var{reg} as an allocable register saved by
15768 functions.  It may be allocated even for temporaries or variables that
15769 live across a call.  Functions compiled this way will save and restore
15770 the register @var{reg} if they use it.
15772 It is an error to used this flag with the frame pointer or stack pointer.
15773 Use of this flag for other registers that have fixed pervasive roles in
15774 the machine's execution model will produce disastrous results.
15776 A different sort of disaster will result from the use of this flag for
15777 a register in which function values may be returned.
15779 This flag does not have a negative form, because it specifies a
15780 three-way choice.
15782 @item -fpack-struct[=@var{n}]
15783 @opindex fpack-struct
15784 Without a value specified, pack all structure members together without
15785 holes.  When a value is specified (which must be a small power of two), pack
15786 structure members according to this value, representing the maximum
15787 alignment (that is, objects with default alignment requirements larger than
15788 this will be output potentially unaligned at the next fitting location.
15790 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15791 code that is not binary compatible with code generated without that switch.
15792 Additionally, it makes the code suboptimal.
15793 Use it to conform to a non-default application binary interface.
15795 @item -finstrument-functions
15796 @opindex finstrument-functions
15797 Generate instrumentation calls for entry and exit to functions.  Just
15798 after function entry and just before function exit, the following
15799 profiling functions will be called with the address of the current
15800 function and its call site.  (On some platforms,
15801 @code{__builtin_return_address} does not work beyond the current
15802 function, so the call site information may not be available to the
15803 profiling functions otherwise.)
15805 @smallexample
15806 void __cyg_profile_func_enter (void *this_fn,
15807                                void *call_site);
15808 void __cyg_profile_func_exit  (void *this_fn,
15809                                void *call_site);
15810 @end smallexample
15812 The first argument is the address of the start of the current function,
15813 which may be looked up exactly in the symbol table.
15815 This instrumentation is also done for functions expanded inline in other
15816 functions.  The profiling calls will indicate where, conceptually, the
15817 inline function is entered and exited.  This means that addressable
15818 versions of such functions must be available.  If all your uses of a
15819 function are expanded inline, this may mean an additional expansion of
15820 code size.  If you use @samp{extern inline} in your C code, an
15821 addressable version of such functions must be provided.  (This is
15822 normally the case anyways, but if you get lucky and the optimizer always
15823 expands the functions inline, you might have gotten away without
15824 providing static copies.)
15826 A function may be given the attribute @code{no_instrument_function}, in
15827 which case this instrumentation will not be done.  This can be used, for
15828 example, for the profiling functions listed above, high-priority
15829 interrupt routines, and any functions from which the profiling functions
15830 cannot safely be called (perhaps signal handlers, if the profiling
15831 routines generate output or allocate memory).
15833 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15834 @opindex finstrument-functions-exclude-file-list
15836 Set the list of functions that are excluded from instrumentation (see
15837 the description of @code{-finstrument-functions}).  If the file that
15838 contains a function definition matches with one of @var{file}, then
15839 that function is not instrumented.  The match is done on substrings:
15840 if the @var{file} parameter is a substring of the file name, it is
15841 considered to be a match.
15843 For example,
15844 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15845 will exclude any inline function defined in files whose pathnames
15846 contain @code{/bits/stl} or @code{include/sys}.
15848 If, for some reason, you want to include letter @code{','} in one of
15849 @var{sym}, write @code{'\,'}. For example,
15850 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15851 (note the single quote surrounding the option).
15853 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15854 @opindex finstrument-functions-exclude-function-list
15856 This is similar to @code{-finstrument-functions-exclude-file-list},
15857 but this option sets the list of function names to be excluded from
15858 instrumentation.  The function name to be matched is its user-visible
15859 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15860 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15861 match is done on substrings: if the @var{sym} parameter is a substring
15862 of the function name, it is considered to be a match.
15864 @item -fstack-check
15865 @opindex fstack-check
15866 Generate code to verify that you do not go beyond the boundary of the
15867 stack.  You should specify this flag if you are running in an
15868 environment with multiple threads, but only rarely need to specify it in
15869 a single-threaded environment since stack overflow is automatically
15870 detected on nearly all systems if there is only one stack.
15872 Note that this switch does not actually cause checking to be done; the
15873 operating system or the language runtime must do that.  The switch causes
15874 generation of code to ensure that they see the stack being extended.
15876 You can additionally specify a string parameter: @code{no} means no
15877 checking, @code{generic} means force the use of old-style checking,
15878 @code{specific} means use the best checking method and is equivalent
15879 to bare @option{-fstack-check}.
15881 Old-style checking is a generic mechanism that requires no specific
15882 target support in the compiler but comes with the following drawbacks:
15884 @enumerate
15885 @item
15886 Modified allocation strategy for large objects: they will always be
15887 allocated dynamically if their size exceeds a fixed threshold.
15889 @item
15890 Fixed limit on the size of the static frame of functions: when it is
15891 topped by a particular function, stack checking is not reliable and
15892 a warning is issued by the compiler.
15894 @item
15895 Inefficiency: because of both the modified allocation strategy and the
15896 generic implementation, the performances of the code are hampered.
15897 @end enumerate
15899 Note that old-style stack checking is also the fallback method for
15900 @code{specific} if no target support has been added in the compiler.
15902 @item -fstack-limit-register=@var{reg}
15903 @itemx -fstack-limit-symbol=@var{sym}
15904 @itemx -fno-stack-limit
15905 @opindex fstack-limit-register
15906 @opindex fstack-limit-symbol
15907 @opindex fno-stack-limit
15908 Generate code to ensure that the stack does not grow beyond a certain value,
15909 either the value of a register or the address of a symbol.  If the stack
15910 would grow beyond the value, a signal is raised.  For most targets,
15911 the signal is raised before the stack overruns the boundary, so
15912 it is possible to catch the signal without taking special precautions.
15914 For instance, if the stack starts at absolute address @samp{0x80000000}
15915 and grows downwards, you can use the flags
15916 @option{-fstack-limit-symbol=__stack_limit} and
15917 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15918 of 128KB@.  Note that this may only work with the GNU linker.
15920 @cindex aliasing of parameters
15921 @cindex parameters, aliased
15922 @item -fargument-alias
15923 @itemx -fargument-noalias
15924 @itemx -fargument-noalias-global
15925 @itemx -fargument-noalias-anything
15926 @opindex fargument-alias
15927 @opindex fargument-noalias
15928 @opindex fargument-noalias-global
15929 @opindex fargument-noalias-anything
15930 Specify the possible relationships among parameters and between
15931 parameters and global data.
15933 @option{-fargument-alias} specifies that arguments (parameters) may
15934 alias each other and may alias global storage.@*
15935 @option{-fargument-noalias} specifies that arguments do not alias
15936 each other, but may alias global storage.@*
15937 @option{-fargument-noalias-global} specifies that arguments do not
15938 alias each other and do not alias global storage.
15939 @option{-fargument-noalias-anything} specifies that arguments do not
15940 alias any other storage.
15942 Each language will automatically use whatever option is required by
15943 the language standard.  You should not need to use these options yourself.
15945 @item -fleading-underscore
15946 @opindex fleading-underscore
15947 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15948 change the way C symbols are represented in the object file.  One use
15949 is to help link with legacy assembly code.
15951 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15952 generate code that is not binary compatible with code generated without that
15953 switch.  Use it to conform to a non-default application binary interface.
15954 Not all targets provide complete support for this switch.
15956 @item -ftls-model=@var{model}
15957 @opindex ftls-model
15958 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15959 The @var{model} argument should be one of @code{global-dynamic},
15960 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15962 The default without @option{-fpic} is @code{initial-exec}; with
15963 @option{-fpic} the default is @code{global-dynamic}.
15965 @item -fvisibility=@var{default|internal|hidden|protected}
15966 @opindex fvisibility
15967 Set the default ELF image symbol visibility to the specified option---all
15968 symbols will be marked with this unless overridden within the code.
15969 Using this feature can very substantially improve linking and
15970 load times of shared object libraries, produce more optimized
15971 code, provide near-perfect API export and prevent symbol clashes.
15972 It is @strong{strongly} recommended that you use this in any shared objects
15973 you distribute.
15975 Despite the nomenclature, @code{default} always means public ie;
15976 available to be linked against from outside the shared object.
15977 @code{protected} and @code{internal} are pretty useless in real-world
15978 usage so the only other commonly used option will be @code{hidden}.
15979 The default if @option{-fvisibility} isn't specified is
15980 @code{default}, i.e., make every
15981 symbol public---this causes the same behavior as previous versions of
15982 GCC@.
15984 A good explanation of the benefits offered by ensuring ELF
15985 symbols have the correct visibility is given by ``How To Write
15986 Shared Libraries'' by Ulrich Drepper (which can be found at
15987 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15988 solution made possible by this option to marking things hidden when
15989 the default is public is to make the default hidden and mark things
15990 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15991 and @code{__attribute__ ((visibility("default")))} instead of
15992 @code{__declspec(dllexport)} you get almost identical semantics with
15993 identical syntax.  This is a great boon to those working with
15994 cross-platform projects.
15996 For those adding visibility support to existing code, you may find
15997 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15998 the declarations you wish to set visibility for with (for example)
15999 @samp{#pragma GCC visibility push(hidden)} and
16000 @samp{#pragma GCC visibility pop}.
16001 Bear in mind that symbol visibility should be viewed @strong{as
16002 part of the API interface contract} and thus all new code should
16003 always specify visibility when it is not the default ie; declarations
16004 only for use within the local DSO should @strong{always} be marked explicitly
16005 as hidden as so to avoid PLT indirection overheads---making this
16006 abundantly clear also aids readability and self-documentation of the code.
16007 Note that due to ISO C++ specification requirements, operator new and
16008 operator delete must always be of default visibility.
16010 Be aware that headers from outside your project, in particular system
16011 headers and headers from any other library you use, may not be
16012 expecting to be compiled with visibility other than the default.  You
16013 may need to explicitly say @samp{#pragma GCC visibility push(default)}
16014 before including any such headers.
16016 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
16017 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
16018 no modifications.  However, this means that calls to @samp{extern}
16019 functions with no explicit visibility will use the PLT, so it is more
16020 effective to use @samp{__attribute ((visibility))} and/or
16021 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
16022 declarations should be treated as hidden.
16024 Note that @samp{-fvisibility} does affect C++ vague linkage
16025 entities. This means that, for instance, an exception class that will
16026 be thrown between DSOs must be explicitly marked with default
16027 visibility so that the @samp{type_info} nodes will be unified between
16028 the DSOs.
16030 An overview of these techniques, their benefits and how to use them
16031 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
16033 @end table
16035 @c man end
16037 @node Environment Variables
16038 @section Environment Variables Affecting GCC
16039 @cindex environment variables
16041 @c man begin ENVIRONMENT
16042 This section describes several environment variables that affect how GCC
16043 operates.  Some of them work by specifying directories or prefixes to use
16044 when searching for various kinds of files.  Some are used to specify other
16045 aspects of the compilation environment.
16047 Note that you can also specify places to search using options such as
16048 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
16049 take precedence over places specified using environment variables, which
16050 in turn take precedence over those specified by the configuration of GCC@.
16051 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
16052 GNU Compiler Collection (GCC) Internals}.
16054 @table @env
16055 @item LANG
16056 @itemx LC_CTYPE
16057 @c @itemx LC_COLLATE
16058 @itemx LC_MESSAGES
16059 @c @itemx LC_MONETARY
16060 @c @itemx LC_NUMERIC
16061 @c @itemx LC_TIME
16062 @itemx LC_ALL
16063 @findex LANG
16064 @findex LC_CTYPE
16065 @c @findex LC_COLLATE
16066 @findex LC_MESSAGES
16067 @c @findex LC_MONETARY
16068 @c @findex LC_NUMERIC
16069 @c @findex LC_TIME
16070 @findex LC_ALL
16071 @cindex locale
16072 These environment variables control the way that GCC uses
16073 localization information that allow GCC to work with different
16074 national conventions.  GCC inspects the locale categories
16075 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
16076 so.  These locale categories can be set to any value supported by your
16077 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
16078 Kingdom encoded in UTF-8.
16080 The @env{LC_CTYPE} environment variable specifies character
16081 classification.  GCC uses it to determine the character boundaries in
16082 a string; this is needed for some multibyte encodings that contain quote
16083 and escape characters that would otherwise be interpreted as a string
16084 end or escape.
16086 The @env{LC_MESSAGES} environment variable specifies the language to
16087 use in diagnostic messages.
16089 If the @env{LC_ALL} environment variable is set, it overrides the value
16090 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
16091 and @env{LC_MESSAGES} default to the value of the @env{LANG}
16092 environment variable.  If none of these variables are set, GCC
16093 defaults to traditional C English behavior.
16095 @item TMPDIR
16096 @findex TMPDIR
16097 If @env{TMPDIR} is set, it specifies the directory to use for temporary
16098 files.  GCC uses temporary files to hold the output of one stage of
16099 compilation which is to be used as input to the next stage: for example,
16100 the output of the preprocessor, which is the input to the compiler
16101 proper.
16103 @item GCC_EXEC_PREFIX
16104 @findex GCC_EXEC_PREFIX
16105 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
16106 names of the subprograms executed by the compiler.  No slash is added
16107 when this prefix is combined with the name of a subprogram, but you can
16108 specify a prefix that ends with a slash if you wish.
16110 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
16111 an appropriate prefix to use based on the pathname it was invoked with.
16113 If GCC cannot find the subprogram using the specified prefix, it
16114 tries looking in the usual places for the subprogram.
16116 The default value of @env{GCC_EXEC_PREFIX} is
16117 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
16118 the installed compiler. In many cases @var{prefix} is the value
16119 of @code{prefix} when you ran the @file{configure} script.
16121 Other prefixes specified with @option{-B} take precedence over this prefix.
16123 This prefix is also used for finding files such as @file{crt0.o} that are
16124 used for linking.
16126 In addition, the prefix is used in an unusual way in finding the
16127 directories to search for header files.  For each of the standard
16128 directories whose name normally begins with @samp{/usr/local/lib/gcc}
16129 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
16130 replacing that beginning with the specified prefix to produce an
16131 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
16132 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
16133 These alternate directories are searched first; the standard directories
16134 come next. If a standard directory begins with the configured
16135 @var{prefix} then the value of @var{prefix} is replaced by
16136 @env{GCC_EXEC_PREFIX} when looking for header files.
16138 @item COMPILER_PATH
16139 @findex COMPILER_PATH
16140 The value of @env{COMPILER_PATH} is a colon-separated list of
16141 directories, much like @env{PATH}.  GCC tries the directories thus
16142 specified when searching for subprograms, if it can't find the
16143 subprograms using @env{GCC_EXEC_PREFIX}.
16145 @item LIBRARY_PATH
16146 @findex LIBRARY_PATH
16147 The value of @env{LIBRARY_PATH} is a colon-separated list of
16148 directories, much like @env{PATH}.  When configured as a native compiler,
16149 GCC tries the directories thus specified when searching for special
16150 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
16151 using GCC also uses these directories when searching for ordinary
16152 libraries for the @option{-l} option (but directories specified with
16153 @option{-L} come first).
16155 @item LANG
16156 @findex LANG
16157 @cindex locale definition
16158 This variable is used to pass locale information to the compiler.  One way in
16159 which this information is used is to determine the character set to be used
16160 when character literals, string literals and comments are parsed in C and C++.
16161 When the compiler is configured to allow multibyte characters,
16162 the following values for @env{LANG} are recognized:
16164 @table @samp
16165 @item C-JIS
16166 Recognize JIS characters.
16167 @item C-SJIS
16168 Recognize SJIS characters.
16169 @item C-EUCJP
16170 Recognize EUCJP characters.
16171 @end table
16173 If @env{LANG} is not defined, or if it has some other value, then the
16174 compiler will use mblen and mbtowc as defined by the default locale to
16175 recognize and translate multibyte characters.
16176 @end table
16178 @noindent
16179 Some additional environments variables affect the behavior of the
16180 preprocessor.
16182 @include cppenv.texi
16184 @c man end
16186 @node Precompiled Headers
16187 @section Using Precompiled Headers
16188 @cindex precompiled headers
16189 @cindex speed of compilation
16191 Often large projects have many header files that are included in every
16192 source file.  The time the compiler takes to process these header files
16193 over and over again can account for nearly all of the time required to
16194 build the project.  To make builds faster, GCC allows users to
16195 `precompile' a header file; then, if builds can use the precompiled
16196 header file they will be much faster.
16198 To create a precompiled header file, simply compile it as you would any
16199 other file, if necessary using the @option{-x} option to make the driver
16200 treat it as a C or C++ header file.  You will probably want to use a
16201 tool like @command{make} to keep the precompiled header up-to-date when
16202 the headers it contains change.
16204 A precompiled header file will be searched for when @code{#include} is
16205 seen in the compilation.  As it searches for the included file
16206 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
16207 compiler looks for a precompiled header in each directory just before it
16208 looks for the include file in that directory.  The name searched for is
16209 the name specified in the @code{#include} with @samp{.gch} appended.  If
16210 the precompiled header file can't be used, it is ignored.
16212 For instance, if you have @code{#include "all.h"}, and you have
16213 @file{all.h.gch} in the same directory as @file{all.h}, then the
16214 precompiled header file will be used if possible, and the original
16215 header will be used otherwise.
16217 Alternatively, you might decide to put the precompiled header file in a
16218 directory and use @option{-I} to ensure that directory is searched
16219 before (or instead of) the directory containing the original header.
16220 Then, if you want to check that the precompiled header file is always
16221 used, you can put a file of the same name as the original header in this
16222 directory containing an @code{#error} command.
16224 This also works with @option{-include}.  So yet another way to use
16225 precompiled headers, good for projects not designed with precompiled
16226 header files in mind, is to simply take most of the header files used by
16227 a project, include them from another header file, precompile that header
16228 file, and @option{-include} the precompiled header.  If the header files
16229 have guards against multiple inclusion, they will be skipped because
16230 they've already been included (in the precompiled header).
16232 If you need to precompile the same header file for different
16233 languages, targets, or compiler options, you can instead make a
16234 @emph{directory} named like @file{all.h.gch}, and put each precompiled
16235 header in the directory, perhaps using @option{-o}.  It doesn't matter
16236 what you call the files in the directory, every precompiled header in
16237 the directory will be considered.  The first precompiled header
16238 encountered in the directory that is valid for this compilation will
16239 be used; they're searched in no particular order.
16241 There are many other possibilities, limited only by your imagination,
16242 good sense, and the constraints of your build system.
16244 A precompiled header file can be used only when these conditions apply:
16246 @itemize
16247 @item
16248 Only one precompiled header can be used in a particular compilation.
16250 @item
16251 A precompiled header can't be used once the first C token is seen.  You
16252 can have preprocessor directives before a precompiled header; you can
16253 even include a precompiled header from inside another header, so long as
16254 there are no C tokens before the @code{#include}.
16256 @item
16257 The precompiled header file must be produced for the same language as
16258 the current compilation.  You can't use a C precompiled header for a C++
16259 compilation.
16261 @item
16262 The precompiled header file must have been produced by the same compiler
16263 binary as the current compilation is using.
16265 @item
16266 Any macros defined before the precompiled header is included must
16267 either be defined in the same way as when the precompiled header was
16268 generated, or must not affect the precompiled header, which usually
16269 means that they don't appear in the precompiled header at all.
16271 The @option{-D} option is one way to define a macro before a
16272 precompiled header is included; using a @code{#define} can also do it.
16273 There are also some options that define macros implicitly, like
16274 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
16275 defined this way.
16277 @item If debugging information is output when using the precompiled
16278 header, using @option{-g} or similar, the same kind of debugging information
16279 must have been output when building the precompiled header.  However,
16280 a precompiled header built using @option{-g} can be used in a compilation
16281 when no debugging information is being output.
16283 @item The same @option{-m} options must generally be used when building
16284 and using the precompiled header.  @xref{Submodel Options},
16285 for any cases where this rule is relaxed.
16287 @item Each of the following options must be the same when building and using
16288 the precompiled header:
16290 @gccoptlist{-fexceptions}
16292 @item
16293 Some other command-line options starting with @option{-f},
16294 @option{-p}, or @option{-O} must be defined in the same way as when
16295 the precompiled header was generated.  At present, it's not clear
16296 which options are safe to change and which are not; the safest choice
16297 is to use exactly the same options when generating and using the
16298 precompiled header.  The following are known to be safe:
16300 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
16301 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
16302 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
16303 -pedantic-errors}
16305 @end itemize
16307 For all of these except the last, the compiler will automatically
16308 ignore the precompiled header if the conditions aren't met.  If you
16309 find an option combination that doesn't work and doesn't cause the
16310 precompiled header to be ignored, please consider filing a bug report,
16311 see @ref{Bugs}.
16313 If you do use differing options when generating and using the
16314 precompiled header, the actual behavior will be a mixture of the
16315 behavior for the options.  For instance, if you use @option{-g} to
16316 generate the precompiled header but not when using it, you may or may
16317 not get debugging information for routines in the precompiled header.
16319 @node Running Protoize
16320 @section Running Protoize
16322 The program @code{protoize} is an optional part of GCC@.  You can use
16323 it to add prototypes to a program, thus converting the program to ISO
16324 C in one respect.  The companion program @code{unprotoize} does the
16325 reverse: it removes argument types from any prototypes that are found.
16327 When you run these programs, you must specify a set of source files as
16328 command line arguments.  The conversion programs start out by compiling
16329 these files to see what functions they define.  The information gathered
16330 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
16332 After scanning comes actual conversion.  The specified files are all
16333 eligible to be converted; any files they include (whether sources or
16334 just headers) are eligible as well.
16336 But not all the eligible files are converted.  By default,
16337 @code{protoize} and @code{unprotoize} convert only source and header
16338 files in the current directory.  You can specify additional directories
16339 whose files should be converted with the @option{-d @var{directory}}
16340 option.  You can also specify particular files to exclude with the
16341 @option{-x @var{file}} option.  A file is converted if it is eligible, its
16342 directory name matches one of the specified directory names, and its
16343 name within the directory has not been excluded.
16345 Basic conversion with @code{protoize} consists of rewriting most
16346 function definitions and function declarations to specify the types of
16347 the arguments.  The only ones not rewritten are those for varargs
16348 functions.
16350 @code{protoize} optionally inserts prototype declarations at the
16351 beginning of the source file, to make them available for any calls that
16352 precede the function's definition.  Or it can insert prototype
16353 declarations with block scope in the blocks where undeclared functions
16354 are called.
16356 Basic conversion with @code{unprotoize} consists of rewriting most
16357 function declarations to remove any argument types, and rewriting
16358 function definitions to the old-style pre-ISO form.
16360 Both conversion programs print a warning for any function declaration or
16361 definition that they can't convert.  You can suppress these warnings
16362 with @option{-q}.
16364 The output from @code{protoize} or @code{unprotoize} replaces the
16365 original source file.  The original file is renamed to a name ending
16366 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
16367 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
16368 for DOS) file already exists, then the source file is simply discarded.
16370 @code{protoize} and @code{unprotoize} both depend on GCC itself to
16371 scan the program and collect information about the functions it uses.
16372 So neither of these programs will work until GCC is installed.
16374 Here is a table of the options you can use with @code{protoize} and
16375 @code{unprotoize}.  Each option works with both programs unless
16376 otherwise stated.
16378 @table @code
16379 @item -B @var{directory}
16380 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
16381 usual directory (normally @file{/usr/local/lib}).  This file contains
16382 prototype information about standard system functions.  This option
16383 applies only to @code{protoize}.
16385 @item -c @var{compilation-options}
16386 Use @var{compilation-options} as the options when running @command{gcc} to
16387 produce the @samp{.X} files.  The special option @option{-aux-info} is
16388 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
16390 Note that the compilation options must be given as a single argument to
16391 @code{protoize} or @code{unprotoize}.  If you want to specify several
16392 @command{gcc} options, you must quote the entire set of compilation options
16393 to make them a single word in the shell.
16395 There are certain @command{gcc} arguments that you cannot use, because they
16396 would produce the wrong kind of output.  These include @option{-g},
16397 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
16398 the @var{compilation-options}, they are ignored.
16400 @item -C
16401 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
16402 systems) instead of @samp{.c}.  This is convenient if you are converting
16403 a C program to C++.  This option applies only to @code{protoize}.
16405 @item -g
16406 Add explicit global declarations.  This means inserting explicit
16407 declarations at the beginning of each source file for each function
16408 that is called in the file and was not declared.  These declarations
16409 precede the first function definition that contains a call to an
16410 undeclared function.  This option applies only to @code{protoize}.
16412 @item -i @var{string}
16413 Indent old-style parameter declarations with the string @var{string}.
16414 This option applies only to @code{protoize}.
16416 @code{unprotoize} converts prototyped function definitions to old-style
16417 function definitions, where the arguments are declared between the
16418 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
16419 uses five spaces as the indentation.  If you want to indent with just
16420 one space instead, use @option{-i " "}.
16422 @item -k
16423 Keep the @samp{.X} files.  Normally, they are deleted after conversion
16424 is finished.
16426 @item -l
16427 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
16428 a prototype declaration for each function in each block which calls the
16429 function without any declaration.  This option applies only to
16430 @code{protoize}.
16432 @item -n
16433 Make no real changes.  This mode just prints information about the conversions
16434 that would have been done without @option{-n}.
16436 @item -N
16437 Make no @samp{.save} files.  The original files are simply deleted.
16438 Use this option with caution.
16440 @item -p @var{program}
16441 Use the program @var{program} as the compiler.  Normally, the name
16442 @file{gcc} is used.
16444 @item -q
16445 Work quietly.  Most warnings are suppressed.
16447 @item -v
16448 Print the version number, just like @option{-v} for @command{gcc}.
16449 @end table
16451 If you need special compiler options to compile one of your program's
16452 source files, then you should generate that file's @samp{.X} file
16453 specially, by running @command{gcc} on that source file with the
16454 appropriate options and the option @option{-aux-info}.  Then run
16455 @code{protoize} on the entire set of files.  @code{protoize} will use
16456 the existing @samp{.X} file because it is newer than the source file.
16457 For example:
16459 @smallexample
16460 gcc -Dfoo=bar file1.c -aux-info file1.X
16461 protoize *.c
16462 @end smallexample
16464 @noindent
16465 You need to include the special files along with the rest in the
16466 @code{protoize} command, even though their @samp{.X} files already
16467 exist, because otherwise they won't get converted.
16469 @xref{Protoize Caveats}, for more information on how to use
16470 @code{protoize} successfully.