2008-05-30 Vladimir Makarov <vmakarov@redhat.com>
[official-gcc.git] / gcc / doc / invoke.texi
blobc652b932bb251d729f24943813f9ccd752652be9
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{-dr} is very different from @w{@samp{-d
101 -r}}.
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 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
232 -Wchar-subscripts -Wclobbered  -Wcomment @gol
233 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
234 -Wno-deprecated-declarations -Wdisabled-optimization  -Wno-div-by-zero  @gol
235 -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
236 -Werror  -Werror=* @gol
237 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
238 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
239 -Wformat-security  -Wformat-y2k @gol
240 -Wframe-larger-than=@var{len} -Wignored-qualifiers @gol
241 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
242 -Winit-self  -Winline @gol
243 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
244 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
245 -Wlogical-op -Wlong-long @gol
246 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
247 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
248 -Wmissing-noreturn  -Wno-mudflap @gol
249 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
250 -Woverlength-strings  -Wpacked  -Wpadded @gol
251 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
252 -Wredundant-decls @gol
253 -Wreturn-type  -Wsequence-point  -Wshadow @gol
254 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
255 -Wstrict-aliasing -Wstrict-aliasing=n @gol
256 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
257 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
258 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
259 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
260 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
261 -Wunused-value  -Wunused-variable @gol
262 -Wvariadic-macros -Wvla @gol
263 -Wvolatile-register-var  -Wwrite-strings}
265 @item C and Objective-C-only Warning Options
266 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
267 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
268 -Wold-style-declaration  -Wold-style-definition @gol
269 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
270 -Wdeclaration-after-statement -Wpointer-sign}
272 @item Debugging Options
273 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
274 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
275 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
276 -fdump-noaddr -fdump-unnumbered -fdump-simple-rtl @gol
277 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
278 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
279 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
280 -fdump-statistics @gol
281 -fdump-tree-all @gol
282 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
283 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
285 -fdump-tree-ch @gol
286 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-nrv -fdump-tree-vect @gol
295 -fdump-tree-sink @gol
296 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
299 -ftree-vectorizer-verbose=@var{n} @gol
300 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
301 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
302 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
303 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
304 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
305 -ftest-coverage  -ftime-report -fvar-tracking @gol
306 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
307 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
308 -fno-merge-debug-strings -fdebug-prefix-map=@var{old}=@var{new} @gol
309 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
310 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
311 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
312 -print-multi-directory  -print-multi-lib @gol
313 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
314 -print-sysroot-headers-suffix @gol
315 -save-temps  -time}
317 @item Optimization Options
318 @xref{Optimize Options,,Options that Control Optimization}.
319 @gccoptlist{
320 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
321 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
322 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
323 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
324 -fcheck-data-deps -fcprop-registers -fcrossjumping -fcse-follow-jumps @gol
325 -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
326 -fdata-sections -fdce -fdce @gol
327 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
328 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
329 -ffinite-math-only -ffloat-store -fforward-propagate @gol
330 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
331 -fgcse-sm -fif-conversion -fif-conversion2 -finline-functions @gol
332 -finline-functions-called-once -finline-limit=@var{n} @gol
333 -finline-small-functions -fipa-cp -fipa-marix-reorg -fipa-pta @gol 
334 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
335 -fipa-type-escape -fira -fira-algorithm=@var{algorithm} @gol
336 -fira-coalesce -fira-ipra -fno-ira-move-spills @gol
337 -fira-propagate-cost -fno-ira-share-save-slots @gol
338 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
339 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
340 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
341 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
342 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
343 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
344 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
345 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
346 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
347 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
348 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
349 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
350 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
351 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
352 -freorder-blocks-and-partition -freorder-functions @gol
353 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
354 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
355 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
356 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
357 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
358 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
359 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
360 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer -ftree-ccp @gol
361 -ftree-ch -ftree-copy-prop -ftree-copyrename -ftree-dce @gol
362 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
363 -ftree-loop-distribution @gol
364 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
365 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
366 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-ter @gol
367 -ftree-vect-loop-version -ftree-vectorize -ftree-vrp -funit-at-a-time @gol
368 -funroll-all-loops -funroll-loops -funsafe-loop-optimizations @gol
369 -funsafe-math-optimizations -funswitch-loops @gol
370 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
371 -fwhole-program @gol
372 --param @var{name}=@var{value}
373 -O  -O0  -O1  -O2  -O3  -Os}
375 @item Preprocessor Options
376 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
377 @gccoptlist{-A@var{question}=@var{answer} @gol
378 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
379 -C  -dD  -dI  -dM  -dN @gol
380 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
381 -idirafter @var{dir} @gol
382 -include @var{file}  -imacros @var{file} @gol
383 -iprefix @var{file}  -iwithprefix @var{dir} @gol
384 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
385 -imultilib @var{dir} -isysroot @var{dir} @gol
386 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
387 -P  -fworking-directory  -remap @gol
388 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
389 -Xpreprocessor @var{option}}
391 @item Assembler Option
392 @xref{Assembler Options,,Passing Options to the Assembler}.
393 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
395 @item Linker Options
396 @xref{Link Options,,Options for Linking}.
397 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
398 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
399 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
400 -Wl,@var{option}  -Xlinker @var{option} @gol
401 -u @var{symbol}}
403 @item Directory Options
404 @xref{Directory Options,,Options for Directory Search}.
405 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
406 -specs=@var{file}  -I- --sysroot=@var{dir}}
408 @item Target Options
409 @c I wrote this xref this way to avoid overfull hbox. -- rms
410 @xref{Target Options}.
411 @gccoptlist{-V @var{version}  -b @var{machine}}
413 @item Machine Dependent Options
414 @xref{Submodel Options,,Hardware Models and Configurations}.
415 @c This list is ordered alphanumerically by subsection name.
416 @c Try and put the significant identifier (CPU or system) first,
417 @c so users have a clue at guessing where the ones they want will be.
419 @emph{ARC Options}
420 @gccoptlist{-EB  -EL @gol
421 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
422 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
424 @emph{ARM Options}
425 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
426 -mabi=@var{name} @gol
427 -mapcs-stack-check  -mno-apcs-stack-check @gol
428 -mapcs-float  -mno-apcs-float @gol
429 -mapcs-reentrant  -mno-apcs-reentrant @gol
430 -msched-prolog  -mno-sched-prolog @gol
431 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
432 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
433 -mthumb-interwork  -mno-thumb-interwork @gol
434 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
435 -mstructure-size-boundary=@var{n} @gol
436 -mabort-on-noreturn @gol
437 -mlong-calls  -mno-long-calls @gol
438 -msingle-pic-base  -mno-single-pic-base @gol
439 -mpic-register=@var{reg} @gol
440 -mnop-fun-dllimport @gol
441 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
442 -mpoke-function-name @gol
443 -mthumb  -marm @gol
444 -mtpcs-frame  -mtpcs-leaf-frame @gol
445 -mcaller-super-interworking  -mcallee-super-interworking @gol
446 -mtp=@var{name}}
448 @emph{AVR Options}
449 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
450 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
452 @emph{Blackfin Options}
453 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
454 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
455 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
456 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
457 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
458 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
459 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
460 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram}
462 @emph{CRIS Options}
463 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
464 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
465 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
466 -mstack-align  -mdata-align  -mconst-align @gol
467 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
468 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
469 -mmul-bug-workaround  -mno-mul-bug-workaround}
471 @emph{CRX Options}
472 @gccoptlist{-mmac -mpush-args}
474 @emph{Darwin Options}
475 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
476 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
477 -client_name  -compatibility_version  -current_version @gol
478 -dead_strip @gol
479 -dependency-file  -dylib_file  -dylinker_install_name @gol
480 -dynamic  -dynamiclib  -exported_symbols_list @gol
481 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
482 -force_flat_namespace  -headerpad_max_install_names @gol
483 -iframework @gol
484 -image_base  -init  -install_name  -keep_private_externs @gol
485 -multi_module  -multiply_defined  -multiply_defined_unused @gol
486 -noall_load   -no_dead_strip_inits_and_terms @gol
487 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
488 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
489 -private_bundle  -read_only_relocs  -sectalign @gol
490 -sectobjectsymbols  -whyload  -seg1addr @gol
491 -sectcreate  -sectobjectsymbols  -sectorder @gol
492 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
493 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
494 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
495 -single_module  -static  -sub_library  -sub_umbrella @gol
496 -twolevel_namespace  -umbrella  -undefined @gol
497 -unexported_symbols_list  -weak_reference_mismatches @gol
498 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
499 -mkernel -mone-byte-bool}
501 @emph{DEC Alpha Options}
502 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
503 -mieee  -mieee-with-inexact  -mieee-conformant @gol
504 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
505 -mtrap-precision=@var{mode}  -mbuild-constants @gol
506 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
507 -mbwx  -mmax  -mfix  -mcix @gol
508 -mfloat-vax  -mfloat-ieee @gol
509 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
510 -msmall-text  -mlarge-text @gol
511 -mmemory-latency=@var{time}}
513 @emph{DEC Alpha/VMS Options}
514 @gccoptlist{-mvms-return-codes}
516 @emph{FRV Options}
517 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
518 -mhard-float  -msoft-float @gol
519 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
520 -mdouble  -mno-double @gol
521 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
522 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
523 -mlinked-fp  -mlong-calls  -malign-labels @gol
524 -mlibrary-pic  -macc-4  -macc-8 @gol
525 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
526 -moptimize-membar -mno-optimize-membar @gol
527 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
528 -mvliw-branch  -mno-vliw-branch @gol
529 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
530 -mno-nested-cond-exec  -mtomcat-stats @gol
531 -mTLS -mtls @gol
532 -mcpu=@var{cpu}}
534 @emph{GNU/Linux Options}
535 @gccoptlist{-muclibc}
537 @emph{H8/300 Options}
538 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
540 @emph{HPPA Options}
541 @gccoptlist{-march=@var{architecture-type} @gol
542 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
543 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
544 -mfixed-range=@var{register-range} @gol
545 -mjump-in-delay -mlinker-opt -mlong-calls @gol
546 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
547 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
548 -mno-jump-in-delay  -mno-long-load-store @gol
549 -mno-portable-runtime  -mno-soft-float @gol
550 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
551 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
552 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
553 -munix=@var{unix-std}  -nolibdld  -static  -threads}
555 @emph{i386 and x86-64 Options}
556 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
557 -mfpmath=@var{unit} @gol
558 -masm=@var{dialect}  -mno-fancy-math-387 @gol
559 -mno-fp-ret-in-387  -msoft-float @gol
560 -mno-wide-multiply  -mrtd  -malign-double @gol
561 -mpreferred-stack-boundary=@var{num} -mcld -mcx16 -msahf -mrecip @gol
562 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
563 -maes -mpclmul @gol
564 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
565 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
566 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
567 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
568 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
569 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
570 -mcmodel=@var{code-model} @gol
571 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
572 -mfused-madd -mno-fused-madd}
574 @emph{IA-64 Options}
575 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
576 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
577 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
578 -minline-float-divide-max-throughput @gol
579 -minline-int-divide-min-latency @gol
580 -minline-int-divide-max-throughput  @gol
581 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
582 -mno-dwarf2-asm -mearly-stop-bits @gol
583 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
584 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
585 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
586 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
587 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
588 -mno-sched-prefer-non-data-spec-insns @gol
589 -mno-sched-prefer-non-control-spec-insns @gol
590 -mno-sched-count-spec-in-critical-path}
592 @emph{M32R/D Options}
593 @gccoptlist{-m32r2 -m32rx -m32r @gol
594 -mdebug @gol
595 -malign-loops -mno-align-loops @gol
596 -missue-rate=@var{number} @gol
597 -mbranch-cost=@var{number} @gol
598 -mmodel=@var{code-size-model-type} @gol
599 -msdata=@var{sdata-type} @gol
600 -mno-flush-func -mflush-func=@var{name} @gol
601 -mno-flush-trap -mflush-trap=@var{number} @gol
602 -G @var{num}}
604 @emph{M32C Options}
605 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
607 @emph{M680x0 Options}
608 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
609 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
610 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
611 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
612 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
613 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
614 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
615 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
617 @emph{M68hc1x Options}
618 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
619 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
620 -msoft-reg-count=@var{count}}
622 @emph{MCore Options}
623 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
624 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
625 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
626 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
627 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
629 @emph{MIPS Options}
630 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
631 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
632 -mips16  -mno-mips16  -mflip-mips16 @gol
633 -minterlink-mips16  -mno-interlink-mips16 @gol
634 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
635 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
636 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
637 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
638 -msmartmips  -mno-smartmips @gol
639 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
640 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
641 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
642 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
643 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
644 -membedded-data  -mno-embedded-data @gol
645 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
646 -mcode-readable=@var{setting} @gol
647 -msplit-addresses  -mno-split-addresses @gol
648 -mexplicit-relocs  -mno-explicit-relocs @gol
649 -mcheck-zero-division  -mno-check-zero-division @gol
650 -mdivide-traps  -mdivide-breaks @gol
651 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
652 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
653 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
654 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
655 -mfix-sb1  -mno-fix-sb1 @gol
656 -mflush-func=@var{func}  -mno-flush-func @gol
657 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
658 -mfp-exceptions -mno-fp-exceptions @gol
659 -mvr4130-align -mno-vr4130-align}
661 @emph{MMIX Options}
662 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
663 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
664 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
665 -mno-base-addresses  -msingle-exit  -mno-single-exit}
667 @emph{MN10300 Options}
668 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
669 -mam33  -mno-am33 @gol
670 -mam33-2  -mno-am33-2 @gol
671 -mreturn-pointer-on-d0 @gol
672 -mno-crt0  -mrelax}
674 @emph{MT Options}
675 @gccoptlist{-mno-crt0 -mbacc -msim @gol
676 -march=@var{cpu-type} }
678 @emph{PDP-11 Options}
679 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
680 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
681 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
682 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
683 -mbranch-expensive  -mbranch-cheap @gol
684 -msplit  -mno-split  -munix-asm  -mdec-asm}
686 @emph{PowerPC Options}
687 See RS/6000 and PowerPC Options.
689 @emph{RS/6000 and PowerPC Options}
690 @gccoptlist{-mcpu=@var{cpu-type} @gol
691 -mtune=@var{cpu-type} @gol
692 -mpower  -mno-power  -mpower2  -mno-power2 @gol
693 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
694 -maltivec  -mno-altivec @gol
695 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
696 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
697 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
698 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
699 -mnew-mnemonics  -mold-mnemonics @gol
700 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
701 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
702 -malign-power  -malign-natural @gol
703 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
704 -mstring  -mno-string  -mupdate  -mno-update @gol
705 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
706 -mstrict-align  -mno-strict-align  -mrelocatable @gol
707 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
708 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
709 -mdynamic-no-pic  -maltivec  -mswdiv @gol
710 -mprioritize-restricted-insns=@var{priority} @gol
711 -msched-costly-dep=@var{dependence_type} @gol
712 -minsert-sched-nops=@var{scheme} @gol
713 -mcall-sysv  -mcall-netbsd @gol
714 -maix-struct-return  -msvr4-struct-return @gol
715 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
716 -misel -mno-isel @gol
717 -misel=yes  -misel=no @gol
718 -mspe -mno-spe @gol
719 -mspe=yes  -mspe=no @gol
720 -mpaired @gol
721 -mvrsave -mno-vrsave @gol
722 -mmulhw -mno-mulhw @gol
723 -mdlmzb -mno-dlmzb @gol
724 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
725 -mprototype  -mno-prototype @gol
726 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
727 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
729 @emph{S/390 and zSeries Options}
730 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
731 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
732 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
733 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
734 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
735 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
736 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
738 @emph{Score Options}
739 @gccoptlist{-meb -mel @gol
740 -mnhwloop @gol
741 -muls @gol
742 -mmac @gol
743 -mscore5 -mscore5u -mscore7 -mscore7d}
745 @emph{SH Options}
746 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
747 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
748 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
749 -m5-64media  -m5-64media-nofpu @gol
750 -m5-32media  -m5-32media-nofpu @gol
751 -m5-compact  -m5-compact-nofpu @gol
752 -mb  -ml  -mdalign  -mrelax @gol
753 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
754 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
755 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
756 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
757 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
758  -minvalid-symbols}
760 @emph{SPARC Options}
761 @gccoptlist{-mcpu=@var{cpu-type} @gol
762 -mtune=@var{cpu-type} @gol
763 -mcmodel=@var{code-model} @gol
764 -m32  -m64  -mapp-regs  -mno-app-regs @gol
765 -mfaster-structs  -mno-faster-structs @gol
766 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
767 -mhard-quad-float  -msoft-quad-float @gol
768 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
769 -mstack-bias  -mno-stack-bias @gol
770 -munaligned-doubles  -mno-unaligned-doubles @gol
771 -mv8plus  -mno-v8plus  -mvis  -mno-vis
772 -threads -pthreads -pthread}
774 @emph{SPU Options}
775 @gccoptlist{-mwarn-reloc -merror-reloc @gol
776 -msafe-dma -munsafe-dma @gol
777 -mbranch-hints @gol
778 -msmall-mem -mlarge-mem -mstdmain @gol
779 -mfixed-range=@var{register-range}}
781 @emph{System V Options}
782 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
784 @emph{V850 Options}
785 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
786 -mprolog-function  -mno-prolog-function  -mspace @gol
787 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
788 -mapp-regs  -mno-app-regs @gol
789 -mdisable-callt  -mno-disable-callt @gol
790 -mv850e1 @gol
791 -mv850e @gol
792 -mv850  -mbig-switch}
794 @emph{VAX Options}
795 @gccoptlist{-mg  -mgnu  -munix}
797 @emph{VxWorks Options}
798 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
799 -Xbind-lazy  -Xbind-now}
801 @emph{x86-64 Options}
802 See i386 and x86-64 Options.
804 @emph{Xstormy16 Options}
805 @gccoptlist{-msim}
807 @emph{Xtensa Options}
808 @gccoptlist{-mconst16 -mno-const16 @gol
809 -mfused-madd  -mno-fused-madd @gol
810 -mserialize-volatile  -mno-serialize-volatile @gol
811 -mtext-section-literals  -mno-text-section-literals @gol
812 -mtarget-align  -mno-target-align @gol
813 -mlongcalls  -mno-longcalls}
815 @emph{zSeries Options}
816 See S/390 and zSeries Options.
818 @item Code Generation Options
819 @xref{Code Gen Options,,Options for Code Generation Conventions}.
820 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
821 -ffixed-@var{reg}  -fexceptions @gol
822 -fnon-call-exceptions  -funwind-tables @gol
823 -fasynchronous-unwind-tables @gol
824 -finhibit-size-directive  -finstrument-functions @gol
825 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
826 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
827 -fno-common  -fno-ident @gol
828 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
829 -fno-jump-tables @gol
830 -frecord-gcc-switches @gol
831 -freg-struct-return  -fshort-enums @gol
832 -fshort-double  -fshort-wchar @gol
833 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
834 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
835 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
836 -fargument-noalias-global  -fargument-noalias-anything @gol
837 -fleading-underscore  -ftls-model=@var{model} @gol
838 -ftrapv  -fwrapv  -fbounds-check @gol
839 -fvisibility}
840 @end table
842 @menu
843 * Overall Options::     Controlling the kind of output:
844                         an executable, object files, assembler files,
845                         or preprocessed source.
846 * C Dialect Options::   Controlling the variant of C language compiled.
847 * C++ Dialect Options:: Variations on C++.
848 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
849                         and Objective-C++.
850 * Language Independent Options:: Controlling how diagnostics should be
851                         formatted.
852 * Warning Options::     How picky should the compiler be?
853 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
854 * Optimize Options::    How much optimization?
855 * Preprocessor Options:: Controlling header files and macro definitions.
856                          Also, getting dependency information for Make.
857 * Assembler Options::   Passing options to the assembler.
858 * Link Options::        Specifying libraries and so on.
859 * Directory Options::   Where to find header files and libraries.
860                         Where to find the compiler executable files.
861 * Spec Files::          How to pass switches to sub-processes.
862 * Target Options::      Running a cross-compiler, or an old version of GCC.
863 @end menu
865 @node Overall Options
866 @section Options Controlling the Kind of Output
868 Compilation can involve up to four stages: preprocessing, compilation
869 proper, assembly and linking, always in that order.  GCC is capable of
870 preprocessing and compiling several files either into several
871 assembler input files, or into one assembler input file; then each
872 assembler input file produces an object file, and linking combines all
873 the object files (those newly compiled, and those specified as input)
874 into an executable file.
876 @cindex file name suffix
877 For any given input file, the file name suffix determines what kind of
878 compilation is done:
880 @table @gcctabopt
881 @item @var{file}.c
882 C source code which must be preprocessed.
884 @item @var{file}.i
885 C source code which should not be preprocessed.
887 @item @var{file}.ii
888 C++ source code which should not be preprocessed.
890 @item @var{file}.m
891 Objective-C source code.  Note that you must link with the @file{libobjc}
892 library to make an Objective-C program work.
894 @item @var{file}.mi
895 Objective-C source code which should not be preprocessed.
897 @item @var{file}.mm
898 @itemx @var{file}.M
899 Objective-C++ source code.  Note that you must link with the @file{libobjc}
900 library to make an Objective-C++ program work.  Note that @samp{.M} refers
901 to a literal capital M@.
903 @item @var{file}.mii
904 Objective-C++ source code which should not be preprocessed.
906 @item @var{file}.h
907 C, C++, Objective-C or Objective-C++ header file to be turned into a
908 precompiled header.
910 @item @var{file}.cc
911 @itemx @var{file}.cp
912 @itemx @var{file}.cxx
913 @itemx @var{file}.cpp
914 @itemx @var{file}.CPP
915 @itemx @var{file}.c++
916 @itemx @var{file}.C
917 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
918 the last two letters must both be literally @samp{x}.  Likewise,
919 @samp{.C} refers to a literal capital C@.
921 @item @var{file}.mm
922 @itemx @var{file}.M
923 Objective-C++ source code which must be preprocessed.
925 @item @var{file}.mii
926 Objective-C++ source code which should not be preprocessed.
928 @item @var{file}.hh
929 @itemx @var{file}.H
930 @itemx @var{file}.hp
931 @itemx @var{file}.hxx
932 @itemx @var{file}.hpp
933 @itemx @var{file}.HPP
934 @itemx @var{file}.h++
935 @itemx @var{file}.tcc
936 C++ header file to be turned into a precompiled header.
938 @item @var{file}.f
939 @itemx @var{file}.for
940 @itemx @var{file}.ftn
941 Fixed form Fortran source code which should not be preprocessed.
943 @item @var{file}.F
944 @itemx @var{file}.FOR
945 @itemx @var{file}.fpp
946 @itemx @var{file}.FPP
947 @itemx @var{file}.FTN
948 Fixed form Fortran source code which must be preprocessed (with the traditional
949 preprocessor).
951 @item @var{file}.f90
952 @itemx @var{file}.f95
953 @itemx @var{file}.f03
954 @itemx @var{file}.f08
955 Free form Fortran source code which should not be preprocessed.
957 @item @var{file}.F90
958 @itemx @var{file}.F95
959 @itemx @var{file}.F03
960 @itemx @var{file}.F08
961 Free form Fortran source code which must be preprocessed (with the
962 traditional preprocessor).
964 @c FIXME: Descriptions of Java file types.
965 @c @var{file}.java
966 @c @var{file}.class
967 @c @var{file}.zip
968 @c @var{file}.jar
970 @item @var{file}.ads
971 Ada source code file which contains a library unit declaration (a
972 declaration of a package, subprogram, or generic, or a generic
973 instantiation), or a library unit renaming declaration (a package,
974 generic, or subprogram renaming declaration).  Such files are also
975 called @dfn{specs}.
977 @item @var{file}.adb
978 Ada source code file containing a library unit body (a subprogram or
979 package body).  Such files are also called @dfn{bodies}.
981 @c GCC also knows about some suffixes for languages not yet included:
982 @c Pascal:
983 @c @var{file}.p
984 @c @var{file}.pas
985 @c Ratfor:
986 @c @var{file}.r
988 @item @var{file}.s
989 Assembler code.
991 @item @var{file}.S
992 @itemx @var{file}.sx
993 Assembler code which must be preprocessed.
995 @item @var{other}
996 An object file to be fed straight into linking.
997 Any file name with no recognized suffix is treated this way.
998 @end table
1000 @opindex x
1001 You can specify the input language explicitly with the @option{-x} option:
1003 @table @gcctabopt
1004 @item -x @var{language}
1005 Specify explicitly the @var{language} for the following input files
1006 (rather than letting the compiler choose a default based on the file
1007 name suffix).  This option applies to all following input files until
1008 the next @option{-x} option.  Possible values for @var{language} are:
1009 @smallexample
1010 c  c-header  c-cpp-output
1011 c++  c++-header  c++-cpp-output
1012 objective-c  objective-c-header  objective-c-cpp-output
1013 objective-c++ objective-c++-header objective-c++-cpp-output
1014 assembler  assembler-with-cpp
1016 f77  f77-cpp-input f95  f95-cpp-input
1017 java
1018 @end smallexample
1020 @item -x none
1021 Turn off any specification of a language, so that subsequent files are
1022 handled according to their file name suffixes (as they are if @option{-x}
1023 has not been used at all).
1025 @item -pass-exit-codes
1026 @opindex pass-exit-codes
1027 Normally the @command{gcc} program will exit with the code of 1 if any
1028 phase of the compiler returns a non-success return code.  If you specify
1029 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1030 numerically highest error produced by any phase that returned an error
1031 indication.  The C, C++, and Fortran frontends return 4, if an internal
1032 compiler error is encountered.
1033 @end table
1035 If you only want some of the stages of compilation, you can use
1036 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1037 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1038 @command{gcc} is to stop.  Note that some combinations (for example,
1039 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1041 @table @gcctabopt
1042 @item -c
1043 @opindex c
1044 Compile or assemble the source files, but do not link.  The linking
1045 stage simply is not done.  The ultimate output is in the form of an
1046 object file for each source file.
1048 By default, the object file name for a source file is made by replacing
1049 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1051 Unrecognized input files, not requiring compilation or assembly, are
1052 ignored.
1054 @item -S
1055 @opindex S
1056 Stop after the stage of compilation proper; do not assemble.  The output
1057 is in the form of an assembler code file for each non-assembler input
1058 file specified.
1060 By default, the assembler file name for a source file is made by
1061 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1063 Input files that don't require compilation are ignored.
1065 @item -E
1066 @opindex E
1067 Stop after the preprocessing stage; do not run the compiler proper.  The
1068 output is in the form of preprocessed source code, which is sent to the
1069 standard output.
1071 Input files which don't require preprocessing are ignored.
1073 @cindex output file option
1074 @item -o @var{file}
1075 @opindex o
1076 Place output in file @var{file}.  This applies regardless to whatever
1077 sort of output is being produced, whether it be an executable file,
1078 an object file, an assembler file or preprocessed C code.
1080 If @option{-o} is not specified, the default is to put an executable
1081 file in @file{a.out}, the object file for
1082 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1083 assembler file in @file{@var{source}.s}, a precompiled header file in
1084 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1085 standard output.
1087 @item -v
1088 @opindex v
1089 Print (on standard error output) the commands executed to run the stages
1090 of compilation.  Also print the version number of the compiler driver
1091 program and of the preprocessor and the compiler proper.
1093 @item -###
1094 @opindex ###
1095 Like @option{-v} except the commands are not executed and all command
1096 arguments are quoted.  This is useful for shell scripts to capture the
1097 driver-generated command lines.
1099 @item -pipe
1100 @opindex pipe
1101 Use pipes rather than temporary files for communication between the
1102 various stages of compilation.  This fails to work on some systems where
1103 the assembler is unable to read from a pipe; but the GNU assembler has
1104 no trouble.
1106 @item -combine
1107 @opindex combine
1108 If you are compiling multiple source files, this option tells the driver
1109 to pass all the source files to the compiler at once (for those
1110 languages for which the compiler can handle this).  This will allow
1111 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1112 language for which this is supported is C@.  If you pass source files for
1113 multiple languages to the driver, using this option, the driver will invoke
1114 the compiler(s) that support IMA once each, passing each compiler all the
1115 source files appropriate for it.  For those languages that do not support
1116 IMA this option will be ignored, and the compiler will be invoked once for
1117 each source file in that language.  If you use this option in conjunction
1118 with @option{-save-temps}, the compiler will generate multiple
1119 pre-processed files
1120 (one for each source file), but only one (combined) @file{.o} or
1121 @file{.s} file.
1123 @item --help
1124 @opindex help
1125 Print (on the standard output) a description of the command line options
1126 understood by @command{gcc}.  If the @option{-v} option is also specified
1127 then @option{--help} will also be passed on to the various processes
1128 invoked by @command{gcc}, so that they can display the command line options
1129 they accept.  If the @option{-Wextra} option has also been specified
1130 (prior to the @option{--help} option), then command line options which
1131 have no documentation associated with them will also be displayed.
1133 @item --target-help
1134 @opindex target-help
1135 Print (on the standard output) a description of target-specific command
1136 line options for each tool.  For some targets extra target-specific
1137 information may also be printed.
1139 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1140 Print (on the standard output) a description of the command line
1141 options understood by the compiler that fit into a specific class.
1142 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1143 @samp{params}, or @var{language}:
1145 @table @asis
1146 @item @samp{optimizers}
1147 This will display all of the optimization options supported by the
1148 compiler.
1150 @item @samp{warnings}
1151 This will display all of the options controlling warning messages
1152 produced by the compiler.
1154 @item @samp{target}
1155 This will display target-specific options.  Unlike the
1156 @option{--target-help} option however, target-specific options of the
1157 linker and assembler will not be displayed.  This is because those
1158 tools do not currently support the extended @option{--help=} syntax.
1160 @item @samp{params}
1161 This will display the values recognized by the @option{--param}
1162 option.
1164 @item @var{language}
1165 This will display the options supported for @var{language}, where 
1166 @var{language} is the name of one of the languages supported in this 
1167 version of GCC.
1169 @item @samp{common}
1170 This will display the options that are common to all languages.
1171 @end table
1173 It is possible to further refine the output of the @option{--help=}
1174 option by adding a comma separated list of qualifiers after the
1175 class.  These can be any from the following list:
1177 @table @asis
1178 @item @samp{undocumented}
1179 Display only those options which are undocumented.
1181 @item @samp{joined}
1182 Display options which take an argument that appears after an equal
1183 sign in the same continuous piece of text, such as:
1184 @samp{--help=target}.
1186 @item @samp{separate}
1187 Display options which take an argument that appears as a separate word
1188 following the original option, such as: @samp{-o output-file}.
1189 @end table
1191 Thus for example to display all the undocumented target-specific
1192 switches supported by the compiler the following can be used:
1194 @smallexample
1195 --help=target,undocumented
1196 @end smallexample
1198 The sense of a qualifier can be inverted by prefixing it with the
1199 @var{^} character, so for example to display all binary warning
1200 options (i.e., ones that are either on or off and that do not take an
1201 argument), which have a description the following can be used:
1203 @smallexample
1204 --help=warnings,^joined,^undocumented
1205 @end smallexample
1207 A class can also be used as a qualifier, although this usually
1208 restricts the output by so much that there is nothing to display.  One
1209 case where it does work however is when one of the classes is
1210 @var{target}.  So for example to display all the target-specific
1211 optimization options the following can be used:
1213 @smallexample
1214 --help=target,optimizers
1215 @end smallexample
1217 The @option{--help=} option can be repeated on the command line.  Each
1218 successive use will display its requested class of options, skipping
1219 those that have already been displayed.
1221 If the @option{-Q} option appears on the command line before the
1222 @option{--help=} option, then the descriptive text displayed by
1223 @option{--help=} is changed.  Instead of describing the displayed
1224 options, an indication is given as to whether the option is enabled,
1225 disabled or set to a specific value (assuming that the compiler
1226 knows this at the point where the @option{--help=} option is used).
1228 Here is a truncated example from the ARM port of @command{gcc}:
1230 @smallexample
1231   % gcc -Q -mabi=2 --help=target -c
1232   The following options are target specific:
1233   -mabi=                                2
1234   -mabort-on-noreturn                   [disabled]
1235   -mapcs                                [disabled]
1236 @end smallexample
1238 The output is sensitive to the effects of previous command line
1239 options, so for example it is possible to find out which optimizations
1240 are enabled at @option{-O2} by using:
1242 @smallexample
1243 -O2 --help=optimizers
1244 @end smallexample
1246 Alternatively you can discover which binary optimizations are enabled
1247 by @option{-O3} by using:
1249 @smallexample
1250 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1251 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1252 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1253 @end smallexample
1255 @item --version
1256 @opindex version
1257 Display the version number and copyrights of the invoked GCC@.
1259 @item -wrapper
1260 @opindex wrapper
1261 Invoke all subcommands under a wrapper program. It takes a single
1262 comma separated list as an argument, which will be used to invoke
1263 the wrapper:
1265 @smallexample
1266 gcc -c t.c -wrapper gdb,--args
1267 @end smallexample
1269 This will invoke all subprograms of gcc under "gdb --args",
1270 thus cc1 invocation will be "gdb --args cc1 ...".
1272 @include @value{srcdir}/../libiberty/at-file.texi
1273 @end table
1275 @node Invoking G++
1276 @section Compiling C++ Programs
1278 @cindex suffixes for C++ source
1279 @cindex C++ source file suffixes
1280 C++ source files conventionally use one of the suffixes @samp{.C},
1281 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1282 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1283 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1284 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1285 files with these names and compiles them as C++ programs even if you
1286 call the compiler the same way as for compiling C programs (usually
1287 with the name @command{gcc}).
1289 @findex g++
1290 @findex c++
1291 However, the use of @command{gcc} does not add the C++ library.
1292 @command{g++} is a program that calls GCC and treats @samp{.c},
1293 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1294 files unless @option{-x} is used, and automatically specifies linking
1295 against the C++ library.  This program is also useful when
1296 precompiling a C header file with a @samp{.h} extension for use in C++
1297 compilations.  On many systems, @command{g++} is also installed with
1298 the name @command{c++}.
1300 @cindex invoking @command{g++}
1301 When you compile C++ programs, you may specify many of the same
1302 command-line options that you use for compiling programs in any
1303 language; or command-line options meaningful for C and related
1304 languages; or options that are meaningful only for C++ programs.
1305 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1306 explanations of options for languages related to C@.
1307 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1308 explanations of options that are meaningful only for C++ programs.
1310 @node C Dialect Options
1311 @section Options Controlling C Dialect
1312 @cindex dialect options
1313 @cindex language dialect options
1314 @cindex options, dialect
1316 The following options control the dialect of C (or languages derived
1317 from C, such as C++, Objective-C and Objective-C++) that the compiler
1318 accepts:
1320 @table @gcctabopt
1321 @cindex ANSI support
1322 @cindex ISO support
1323 @item -ansi
1324 @opindex ansi
1325 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1326 equivalent to @samp{-std=c++98}.
1328 This turns off certain features of GCC that are incompatible with ISO
1329 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1330 such as the @code{asm} and @code{typeof} keywords, and
1331 predefined macros such as @code{unix} and @code{vax} that identify the
1332 type of system you are using.  It also enables the undesirable and
1333 rarely used ISO trigraph feature.  For the C compiler,
1334 it disables recognition of C++ style @samp{//} comments as well as
1335 the @code{inline} keyword.
1337 The alternate keywords @code{__asm__}, @code{__extension__},
1338 @code{__inline__} and @code{__typeof__} continue to work despite
1339 @option{-ansi}.  You would not want to use them in an ISO C program, of
1340 course, but it is useful to put them in header files that might be included
1341 in compilations done with @option{-ansi}.  Alternate predefined macros
1342 such as @code{__unix__} and @code{__vax__} are also available, with or
1343 without @option{-ansi}.
1345 The @option{-ansi} option does not cause non-ISO programs to be
1346 rejected gratuitously.  For that, @option{-pedantic} is required in
1347 addition to @option{-ansi}.  @xref{Warning Options}.
1349 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1350 option is used.  Some header files may notice this macro and refrain
1351 from declaring certain functions or defining certain macros that the
1352 ISO standard doesn't call for; this is to avoid interfering with any
1353 programs that might use these names for other things.
1355 Functions that would normally be built in but do not have semantics
1356 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1357 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1358 built-in functions provided by GCC}, for details of the functions
1359 affected.
1361 @item -std=
1362 @opindex std
1363 Determine the language standard. @xref{Standards,,Language Standards
1364 Supported by GCC}, for details of these standard versions.  This option
1365 is currently only supported when compiling C or C++. 
1367 The compiler can accept several base standards, such as @samp{c89} or
1368 @samp{c++98}, and GNU dialects of those standards, such as
1369 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1370 compiler will accept all programs following that standard and those
1371 using GNU extensions that do not contradict it.  For example,
1372 @samp{-std=c89} turns off certain features of GCC that are
1373 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1374 keywords, but not other GNU extensions that do not have a meaning in
1375 ISO C90, such as omitting the middle term of a @code{?:}
1376 expression. On the other hand, by specifing a GNU dialect of a
1377 standard, all features the compiler support are enabled, even when
1378 those features change the meaning of the base standard and some
1379 strict-conforming programs may be rejected.  The particular standard
1380 is used by @option{-pedantic} to identify which features are GNU
1381 extensions given that version of the standard. For example
1382 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1383 comments, while @samp{-std=gnu99 -pedantic} would not.
1385 A value for this option must be provided; possible values are
1387 @table @samp
1388 @item c89
1389 @itemx iso9899:1990
1390 Support all ISO C90 programs (certain GNU extensions that conflict
1391 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1393 @item iso9899:199409
1394 ISO C90 as modified in amendment 1.
1396 @item c99
1397 @itemx c9x
1398 @itemx iso9899:1999
1399 @itemx iso9899:199x
1400 ISO C99.  Note that this standard is not yet fully supported; see
1401 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1402 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1404 @item gnu89
1405 GNU dialect of ISO C90 (including some C99 features). This
1406 is the default for C code.
1408 @item gnu99
1409 @itemx gnu9x
1410 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1411 this will become the default.  The name @samp{gnu9x} is deprecated.
1413 @item c++98
1414 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1415 C++ code.
1417 @item gnu++98
1418 GNU dialect of @option{-std=c++98}.  This is the default for
1419 C++ code.
1421 @item c++0x
1422 The working draft of the upcoming ISO C++0x standard. This option
1423 enables experimental features that are likely to be included in
1424 C++0x. The working draft is constantly changing, and any feature that is
1425 enabled by this flag may be removed from future versions of GCC if it is
1426 not part of the C++0x standard.
1428 @item gnu++0x
1429 GNU dialect of @option{-std=c++0x}. This option enables
1430 experimental features that may be removed in future versions of GCC.
1431 @end table
1433 @item -fgnu89-inline
1434 @opindex fgnu89-inline
1435 The option @option{-fgnu89-inline} tells GCC to use the traditional
1436 GNU semantics for @code{inline} functions when in C99 mode.
1437 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1438 is accepted and ignored by GCC versions 4.1.3 up to but not including
1439 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1440 C99 mode.  Using this option is roughly equivalent to adding the
1441 @code{gnu_inline} function attribute to all inline functions
1442 (@pxref{Function Attributes}).
1444 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1445 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1446 specifies the default behavior).  This option was first supported in
1447 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1449 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1450 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1451 in effect for @code{inline} functions.  @xref{Common Predefined
1452 Macros,,,cpp,The C Preprocessor}.
1454 @item -aux-info @var{filename}
1455 @opindex aux-info
1456 Output to the given filename prototyped declarations for all functions
1457 declared and/or defined in a translation unit, including those in header
1458 files.  This option is silently ignored in any language other than C@.
1460 Besides declarations, the file indicates, in comments, the origin of
1461 each declaration (source file and line), whether the declaration was
1462 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1463 @samp{O} for old, respectively, in the first character after the line
1464 number and the colon), and whether it came from a declaration or a
1465 definition (@samp{C} or @samp{F}, respectively, in the following
1466 character).  In the case of function definitions, a K&R-style list of
1467 arguments followed by their declarations is also provided, inside
1468 comments, after the declaration.
1470 @item -fno-asm
1471 @opindex fno-asm
1472 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1473 keyword, so that code can use these words as identifiers.  You can use
1474 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1475 instead.  @option{-ansi} implies @option{-fno-asm}.
1477 In C++, this switch only affects the @code{typeof} keyword, since
1478 @code{asm} and @code{inline} are standard keywords.  You may want to
1479 use the @option{-fno-gnu-keywords} flag instead, which has the same
1480 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1481 switch only affects the @code{asm} and @code{typeof} keywords, since
1482 @code{inline} is a standard keyword in ISO C99.
1484 @item -fno-builtin
1485 @itemx -fno-builtin-@var{function}
1486 @opindex fno-builtin
1487 @cindex built-in functions
1488 Don't recognize built-in functions that do not begin with
1489 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1490 functions provided by GCC}, for details of the functions affected,
1491 including those which are not built-in functions when @option{-ansi} or
1492 @option{-std} options for strict ISO C conformance are used because they
1493 do not have an ISO standard meaning.
1495 GCC normally generates special code to handle certain built-in functions
1496 more efficiently; for instance, calls to @code{alloca} may become single
1497 instructions that adjust the stack directly, and calls to @code{memcpy}
1498 may become inline copy loops.  The resulting code is often both smaller
1499 and faster, but since the function calls no longer appear as such, you
1500 cannot set a breakpoint on those calls, nor can you change the behavior
1501 of the functions by linking with a different library.  In addition,
1502 when a function is recognized as a built-in function, GCC may use
1503 information about that function to warn about problems with calls to
1504 that function, or to generate more efficient code, even if the
1505 resulting code still contains calls to that function.  For example,
1506 warnings are given with @option{-Wformat} for bad calls to
1507 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1508 known not to modify global memory.
1510 With the @option{-fno-builtin-@var{function}} option
1511 only the built-in function @var{function} is
1512 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1513 function is named this is not built-in in this version of GCC, this
1514 option is ignored.  There is no corresponding
1515 @option{-fbuiltin-@var{function}} option; if you wish to enable
1516 built-in functions selectively when using @option{-fno-builtin} or
1517 @option{-ffreestanding}, you may define macros such as:
1519 @smallexample
1520 #define abs(n)          __builtin_abs ((n))
1521 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1522 @end smallexample
1524 @item -fhosted
1525 @opindex fhosted
1526 @cindex hosted environment
1528 Assert that compilation takes place in a hosted environment.  This implies
1529 @option{-fbuiltin}.  A hosted environment is one in which the
1530 entire standard library is available, and in which @code{main} has a return
1531 type of @code{int}.  Examples are nearly everything except a kernel.
1532 This is equivalent to @option{-fno-freestanding}.
1534 @item -ffreestanding
1535 @opindex ffreestanding
1536 @cindex hosted environment
1538 Assert that compilation takes place in a freestanding environment.  This
1539 implies @option{-fno-builtin}.  A freestanding environment
1540 is one in which the standard library may not exist, and program startup may
1541 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1542 This is equivalent to @option{-fno-hosted}.
1544 @xref{Standards,,Language Standards Supported by GCC}, for details of
1545 freestanding and hosted environments.
1547 @item -fopenmp
1548 @opindex fopenmp
1549 @cindex openmp parallel
1550 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1551 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1552 compiler generates parallel code according to the OpenMP Application
1553 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1554 implies @option{-pthread}, and thus is only supported on targets that
1555 have support for @option{-pthread}.
1557 @item -fms-extensions
1558 @opindex fms-extensions
1559 Accept some non-standard constructs used in Microsoft header files.
1561 Some cases of unnamed fields in structures and unions are only
1562 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1563 fields within structs/unions}, for details.
1565 @item -trigraphs
1566 @opindex trigraphs
1567 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1568 options for strict ISO C conformance) implies @option{-trigraphs}.
1570 @item -no-integrated-cpp
1571 @opindex no-integrated-cpp
1572 Performs a compilation in two passes: preprocessing and compiling.  This
1573 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1574 @option{-B} option.  The user supplied compilation step can then add in
1575 an additional preprocessing step after normal preprocessing but before
1576 compiling.  The default is to use the integrated cpp (internal cpp)
1578 The semantics of this option will change if "cc1", "cc1plus", and
1579 "cc1obj" are merged.
1581 @cindex traditional C language
1582 @cindex C language, traditional
1583 @item -traditional
1584 @itemx -traditional-cpp
1585 @opindex traditional-cpp
1586 @opindex traditional
1587 Formerly, these options caused GCC to attempt to emulate a pre-standard
1588 C compiler.  They are now only supported with the @option{-E} switch.
1589 The preprocessor continues to support a pre-standard mode.  See the GNU
1590 CPP manual for details.
1592 @item -fcond-mismatch
1593 @opindex fcond-mismatch
1594 Allow conditional expressions with mismatched types in the second and
1595 third arguments.  The value of such an expression is void.  This option
1596 is not supported for C++.
1598 @item -flax-vector-conversions
1599 @opindex flax-vector-conversions
1600 Allow implicit conversions between vectors with differing numbers of
1601 elements and/or incompatible element types.  This option should not be
1602 used for new code.
1604 @item -funsigned-char
1605 @opindex funsigned-char
1606 Let the type @code{char} be unsigned, like @code{unsigned char}.
1608 Each kind of machine has a default for what @code{char} should
1609 be.  It is either like @code{unsigned char} by default or like
1610 @code{signed char} by default.
1612 Ideally, a portable program should always use @code{signed char} or
1613 @code{unsigned char} when it depends on the signedness of an object.
1614 But many programs have been written to use plain @code{char} and
1615 expect it to be signed, or expect it to be unsigned, depending on the
1616 machines they were written for.  This option, and its inverse, let you
1617 make such a program work with the opposite default.
1619 The type @code{char} is always a distinct type from each of
1620 @code{signed char} or @code{unsigned char}, even though its behavior
1621 is always just like one of those two.
1623 @item -fsigned-char
1624 @opindex fsigned-char
1625 Let the type @code{char} be signed, like @code{signed char}.
1627 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1628 the negative form of @option{-funsigned-char}.  Likewise, the option
1629 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1631 @item -fsigned-bitfields
1632 @itemx -funsigned-bitfields
1633 @itemx -fno-signed-bitfields
1634 @itemx -fno-unsigned-bitfields
1635 @opindex fsigned-bitfields
1636 @opindex funsigned-bitfields
1637 @opindex fno-signed-bitfields
1638 @opindex fno-unsigned-bitfields
1639 These options control whether a bit-field is signed or unsigned, when the
1640 declaration does not use either @code{signed} or @code{unsigned}.  By
1641 default, such a bit-field is signed, because this is consistent: the
1642 basic integer types such as @code{int} are signed types.
1643 @end table
1645 @node C++ Dialect Options
1646 @section Options Controlling C++ Dialect
1648 @cindex compiler options, C++
1649 @cindex C++ options, command line
1650 @cindex options, C++
1651 This section describes the command-line options that are only meaningful
1652 for C++ programs; but you can also use most of the GNU compiler options
1653 regardless of what language your program is in.  For example, you
1654 might compile a file @code{firstClass.C} like this:
1656 @smallexample
1657 g++ -g -frepo -O -c firstClass.C
1658 @end smallexample
1660 @noindent
1661 In this example, only @option{-frepo} is an option meant
1662 only for C++ programs; you can use the other options with any
1663 language supported by GCC@.
1665 Here is a list of options that are @emph{only} for compiling C++ programs:
1667 @table @gcctabopt
1669 @item -fabi-version=@var{n}
1670 @opindex fabi-version
1671 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1672 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1673 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1674 the version that conforms most closely to the C++ ABI specification.
1675 Therefore, the ABI obtained using version 0 will change as ABI bugs
1676 are fixed.
1678 The default is version 2.
1680 @item -fno-access-control
1681 @opindex fno-access-control
1682 Turn off all access checking.  This switch is mainly useful for working
1683 around bugs in the access control code.
1685 @item -fcheck-new
1686 @opindex fcheck-new
1687 Check that the pointer returned by @code{operator new} is non-null
1688 before attempting to modify the storage allocated.  This check is
1689 normally unnecessary because the C++ standard specifies that
1690 @code{operator new} will only return @code{0} if it is declared
1691 @samp{throw()}, in which case the compiler will always check the
1692 return value even without this option.  In all other cases, when
1693 @code{operator new} has a non-empty exception specification, memory
1694 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1695 @samp{new (nothrow)}.
1697 @item -fconserve-space
1698 @opindex fconserve-space
1699 Put uninitialized or runtime-initialized global variables into the
1700 common segment, as C does.  This saves space in the executable at the
1701 cost of not diagnosing duplicate definitions.  If you compile with this
1702 flag and your program mysteriously crashes after @code{main()} has
1703 completed, you may have an object that is being destroyed twice because
1704 two definitions were merged.
1706 This option is no longer useful on most targets, now that support has
1707 been added for putting variables into BSS without making them common.
1709 @item -ffriend-injection
1710 @opindex ffriend-injection
1711 Inject friend functions into the enclosing namespace, so that they are
1712 visible outside the scope of the class in which they are declared.
1713 Friend functions were documented to work this way in the old Annotated
1714 C++ Reference Manual, and versions of G++ before 4.1 always worked
1715 that way.  However, in ISO C++ a friend function which is not declared
1716 in an enclosing scope can only be found using argument dependent
1717 lookup.  This option causes friends to be injected as they were in
1718 earlier releases.
1720 This option is for compatibility, and may be removed in a future
1721 release of G++.
1723 @item -fno-elide-constructors
1724 @opindex fno-elide-constructors
1725 The C++ standard allows an implementation to omit creating a temporary
1726 which is only used to initialize another object of the same type.
1727 Specifying this option disables that optimization, and forces G++ to
1728 call the copy constructor in all cases.
1730 @item -fno-enforce-eh-specs
1731 @opindex fno-enforce-eh-specs
1732 Don't generate code to check for violation of exception specifications
1733 at runtime.  This option violates the C++ standard, but may be useful
1734 for reducing code size in production builds, much like defining
1735 @samp{NDEBUG}.  This does not give user code permission to throw
1736 exceptions in violation of the exception specifications; the compiler
1737 will still optimize based on the specifications, so throwing an
1738 unexpected exception will result in undefined behavior.
1740 @item -ffor-scope
1741 @itemx -fno-for-scope
1742 @opindex ffor-scope
1743 @opindex fno-for-scope
1744 If @option{-ffor-scope} is specified, the scope of variables declared in
1745 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1746 as specified by the C++ standard.
1747 If @option{-fno-for-scope} is specified, the scope of variables declared in
1748 a @i{for-init-statement} extends to the end of the enclosing scope,
1749 as was the case in old versions of G++, and other (traditional)
1750 implementations of C++.
1752 The default if neither flag is given to follow the standard,
1753 but to allow and give a warning for old-style code that would
1754 otherwise be invalid, or have different behavior.
1756 @item -fno-gnu-keywords
1757 @opindex fno-gnu-keywords
1758 Do not recognize @code{typeof} as a keyword, so that code can use this
1759 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1760 @option{-ansi} implies @option{-fno-gnu-keywords}.
1762 @item -fno-implicit-templates
1763 @opindex fno-implicit-templates
1764 Never emit code for non-inline templates which are instantiated
1765 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1766 @xref{Template Instantiation}, for more information.
1768 @item -fno-implicit-inline-templates
1769 @opindex fno-implicit-inline-templates
1770 Don't emit code for implicit instantiations of inline templates, either.
1771 The default is to handle inlines differently so that compiles with and
1772 without optimization will need the same set of explicit instantiations.
1774 @item -fno-implement-inlines
1775 @opindex fno-implement-inlines
1776 To save space, do not emit out-of-line copies of inline functions
1777 controlled by @samp{#pragma implementation}.  This will cause linker
1778 errors if these functions are not inlined everywhere they are called.
1780 @item -fms-extensions
1781 @opindex fms-extensions
1782 Disable pedantic warnings about constructs used in MFC, such as implicit
1783 int and getting a pointer to member function via non-standard syntax.
1785 @item -fno-nonansi-builtins
1786 @opindex fno-nonansi-builtins
1787 Disable built-in declarations of functions that are not mandated by
1788 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1789 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1791 @item -fno-operator-names
1792 @opindex fno-operator-names
1793 Do not treat the operator name keywords @code{and}, @code{bitand},
1794 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1795 synonyms as keywords.
1797 @item -fno-optional-diags
1798 @opindex fno-optional-diags
1799 Disable diagnostics that the standard says a compiler does not need to
1800 issue.  Currently, the only such diagnostic issued by G++ is the one for
1801 a name having multiple meanings within a class.
1803 @item -fpermissive
1804 @opindex fpermissive
1805 Downgrade some diagnostics about nonconformant code from errors to
1806 warnings.  Thus, using @option{-fpermissive} will allow some
1807 nonconforming code to compile.
1809 @item -frepo
1810 @opindex frepo
1811 Enable automatic template instantiation at link time.  This option also
1812 implies @option{-fno-implicit-templates}.  @xref{Template
1813 Instantiation}, for more information.
1815 @item -fno-rtti
1816 @opindex fno-rtti
1817 Disable generation of information about every class with virtual
1818 functions for use by the C++ runtime type identification features
1819 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1820 of the language, you can save some space by using this flag.  Note that
1821 exception handling uses the same information, but it will generate it as
1822 needed. The @samp{dynamic_cast} operator can still be used for casts that
1823 do not require runtime type information, i.e.@: casts to @code{void *} or to
1824 unambiguous base classes.
1826 @item -fstats
1827 @opindex fstats
1828 Emit statistics about front-end processing at the end of the compilation.
1829 This information is generally only useful to the G++ development team.
1831 @item -ftemplate-depth-@var{n}
1832 @opindex ftemplate-depth
1833 Set the maximum instantiation depth for template classes to @var{n}.
1834 A limit on the template instantiation depth is needed to detect
1835 endless recursions during template class instantiation.  ANSI/ISO C++
1836 conforming programs must not rely on a maximum depth greater than 17.
1838 @item -fno-threadsafe-statics
1839 @opindex fno-threadsafe-statics
1840 Do not emit the extra code to use the routines specified in the C++
1841 ABI for thread-safe initialization of local statics.  You can use this
1842 option to reduce code size slightly in code that doesn't need to be
1843 thread-safe.
1845 @item -fuse-cxa-atexit
1846 @opindex fuse-cxa-atexit
1847 Register destructors for objects with static storage duration with the
1848 @code{__cxa_atexit} function rather than the @code{atexit} function.
1849 This option is required for fully standards-compliant handling of static
1850 destructors, but will only work if your C library supports
1851 @code{__cxa_atexit}.
1853 @item -fno-use-cxa-get-exception-ptr
1854 @opindex fno-use-cxa-get-exception-ptr
1855 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1856 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1857 if the runtime routine is not available.
1859 @item -fvisibility-inlines-hidden
1860 @opindex fvisibility-inlines-hidden
1861 This switch declares that the user does not attempt to compare
1862 pointers to inline methods where the addresses of the two functions
1863 were taken in different shared objects.
1865 The effect of this is that GCC may, effectively, mark inline methods with
1866 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1867 appear in the export table of a DSO and do not require a PLT indirection
1868 when used within the DSO@.  Enabling this option can have a dramatic effect
1869 on load and link times of a DSO as it massively reduces the size of the
1870 dynamic export table when the library makes heavy use of templates.
1872 The behavior of this switch is not quite the same as marking the
1873 methods as hidden directly, because it does not affect static variables
1874 local to the function or cause the compiler to deduce that
1875 the function is defined in only one shared object.
1877 You may mark a method as having a visibility explicitly to negate the
1878 effect of the switch for that method.  For example, if you do want to
1879 compare pointers to a particular inline method, you might mark it as
1880 having default visibility.  Marking the enclosing class with explicit
1881 visibility will have no effect.
1883 Explicitly instantiated inline methods are unaffected by this option
1884 as their linkage might otherwise cross a shared library boundary.
1885 @xref{Template Instantiation}.
1887 @item -fvisibility-ms-compat
1888 @opindex fvisibility-ms-compat
1889 This flag attempts to use visibility settings to make GCC's C++
1890 linkage model compatible with that of Microsoft Visual Studio.
1892 The flag makes these changes to GCC's linkage model:
1894 @enumerate
1895 @item
1896 It sets the default visibility to @code{hidden}, like
1897 @option{-fvisibility=hidden}.
1899 @item
1900 Types, but not their members, are not hidden by default.
1902 @item
1903 The One Definition Rule is relaxed for types without explicit
1904 visibility specifications which are defined in more than one different
1905 shared object: those declarations are permitted if they would have
1906 been permitted when this option was not used.
1907 @end enumerate
1909 In new code it is better to use @option{-fvisibility=hidden} and
1910 export those classes which are intended to be externally visible.
1911 Unfortunately it is possible for code to rely, perhaps accidentally,
1912 on the Visual Studio behavior.
1914 Among the consequences of these changes are that static data members
1915 of the same type with the same name but defined in different shared
1916 objects will be different, so changing one will not change the other;
1917 and that pointers to function members defined in different shared
1918 objects may not compare equal.  When this flag is given, it is a
1919 violation of the ODR to define types with the same name differently.
1921 @item -fno-weak
1922 @opindex fno-weak
1923 Do not use weak symbol support, even if it is provided by the linker.
1924 By default, G++ will use weak symbols if they are available.  This
1925 option exists only for testing, and should not be used by end-users;
1926 it will result in inferior code and has no benefits.  This option may
1927 be removed in a future release of G++.
1929 @item -nostdinc++
1930 @opindex nostdinc++
1931 Do not search for header files in the standard directories specific to
1932 C++, but do still search the other standard directories.  (This option
1933 is used when building the C++ library.)
1934 @end table
1936 In addition, these optimization, warning, and code generation options
1937 have meanings only for C++ programs:
1939 @table @gcctabopt
1940 @item -fno-default-inline
1941 @opindex fno-default-inline
1942 Do not assume @samp{inline} for functions defined inside a class scope.
1943 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1944 functions will have linkage like inline functions; they just won't be
1945 inlined by default.
1947 @item -Wabi @r{(C++ and Objective-C++ only)}
1948 @opindex Wabi
1949 @opindex Wno-abi
1950 Warn when G++ generates code that is probably not compatible with the
1951 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1952 all such cases, there are probably some cases that are not warned about,
1953 even though G++ is generating incompatible code.  There may also be
1954 cases where warnings are emitted even though the code that is generated
1955 will be compatible.
1957 You should rewrite your code to avoid these warnings if you are
1958 concerned about the fact that code generated by G++ may not be binary
1959 compatible with code generated by other compilers.
1961 The known incompatibilities at this point include:
1963 @itemize @bullet
1965 @item
1966 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1967 pack data into the same byte as a base class.  For example:
1969 @smallexample
1970 struct A @{ virtual void f(); int f1 : 1; @};
1971 struct B : public A @{ int f2 : 1; @};
1972 @end smallexample
1974 @noindent
1975 In this case, G++ will place @code{B::f2} into the same byte
1976 as@code{A::f1}; other compilers will not.  You can avoid this problem
1977 by explicitly padding @code{A} so that its size is a multiple of the
1978 byte size on your platform; that will cause G++ and other compilers to
1979 layout @code{B} identically.
1981 @item
1982 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1983 tail padding when laying out virtual bases.  For example:
1985 @smallexample
1986 struct A @{ virtual void f(); char c1; @};
1987 struct B @{ B(); char c2; @};
1988 struct C : public A, public virtual B @{@};
1989 @end smallexample
1991 @noindent
1992 In this case, G++ will not place @code{B} into the tail-padding for
1993 @code{A}; other compilers will.  You can avoid this problem by
1994 explicitly padding @code{A} so that its size is a multiple of its
1995 alignment (ignoring virtual base classes); that will cause G++ and other
1996 compilers to layout @code{C} identically.
1998 @item
1999 Incorrect handling of bit-fields with declared widths greater than that
2000 of their underlying types, when the bit-fields appear in a union.  For
2001 example:
2003 @smallexample
2004 union U @{ int i : 4096; @};
2005 @end smallexample
2007 @noindent
2008 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2009 union too small by the number of bits in an @code{int}.
2011 @item
2012 Empty classes can be placed at incorrect offsets.  For example:
2014 @smallexample
2015 struct A @{@};
2017 struct B @{
2018   A a;
2019   virtual void f ();
2022 struct C : public B, public A @{@};
2023 @end smallexample
2025 @noindent
2026 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2027 it should be placed at offset zero.  G++ mistakenly believes that the
2028 @code{A} data member of @code{B} is already at offset zero.
2030 @item
2031 Names of template functions whose types involve @code{typename} or
2032 template template parameters can be mangled incorrectly.
2034 @smallexample
2035 template <typename Q>
2036 void f(typename Q::X) @{@}
2038 template <template <typename> class Q>
2039 void f(typename Q<int>::X) @{@}
2040 @end smallexample
2042 @noindent
2043 Instantiations of these templates may be mangled incorrectly.
2045 @end itemize
2047 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2048 @opindex Wctor-dtor-privacy
2049 @opindex Wno-ctor-dtor-privacy
2050 Warn when a class seems unusable because all the constructors or
2051 destructors in that class are private, and it has neither friends nor
2052 public static member functions.
2054 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2055 @opindex Wnon-virtual-dtor
2056 @opindex Wno-non-virtual-dtor
2057 Warn when a class has virtual functions and accessible non-virtual
2058 destructor, in which case it would be possible but unsafe to delete
2059 an instance of a derived class through a pointer to the base class.
2060 This warning is also enabled if -Weffc++ is specified.
2062 @item -Wreorder @r{(C++ and Objective-C++ only)}
2063 @opindex Wreorder
2064 @opindex Wno-reorder
2065 @cindex reordering, warning
2066 @cindex warning for reordering of member initializers
2067 Warn when the order of member initializers given in the code does not
2068 match the order in which they must be executed.  For instance:
2070 @smallexample
2071 struct A @{
2072   int i;
2073   int j;
2074   A(): j (0), i (1) @{ @}
2076 @end smallexample
2078 The compiler will rearrange the member initializers for @samp{i}
2079 and @samp{j} to match the declaration order of the members, emitting
2080 a warning to that effect.  This warning is enabled by @option{-Wall}.
2081 @end table
2083 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2085 @table @gcctabopt
2086 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2087 @opindex Weffc++
2088 @opindex Wno-effc++
2089 Warn about violations of the following style guidelines from Scott Meyers'
2090 @cite{Effective C++} book:
2092 @itemize @bullet
2093 @item
2094 Item 11:  Define a copy constructor and an assignment operator for classes
2095 with dynamically allocated memory.
2097 @item
2098 Item 12:  Prefer initialization to assignment in constructors.
2100 @item
2101 Item 14:  Make destructors virtual in base classes.
2103 @item
2104 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2106 @item
2107 Item 23:  Don't try to return a reference when you must return an object.
2109 @end itemize
2111 Also warn about violations of the following style guidelines from
2112 Scott Meyers' @cite{More Effective C++} book:
2114 @itemize @bullet
2115 @item
2116 Item 6:  Distinguish between prefix and postfix forms of increment and
2117 decrement operators.
2119 @item
2120 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2122 @end itemize
2124 When selecting this option, be aware that the standard library
2125 headers do not obey all of these guidelines; use @samp{grep -v}
2126 to filter out those warnings.
2128 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2129 @opindex Wstrict-null-sentinel
2130 @opindex Wno-strict-null-sentinel
2131 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2132 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2133 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2134 it is guaranteed to of the same size as a pointer.  But this use is
2135 not portable across different compilers.
2137 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2138 @opindex Wno-non-template-friend
2139 @opindex Wnon-template-friend
2140 Disable warnings when non-templatized friend functions are declared
2141 within a template.  Since the advent of explicit template specification
2142 support in G++, if the name of the friend is an unqualified-id (i.e.,
2143 @samp{friend foo(int)}), the C++ language specification demands that the
2144 friend declare or define an ordinary, nontemplate function.  (Section
2145 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2146 could be interpreted as a particular specialization of a templatized
2147 function.  Because this non-conforming behavior is no longer the default
2148 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2149 check existing code for potential trouble spots and is on by default.
2150 This new compiler behavior can be turned off with
2151 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2152 but disables the helpful warning.
2154 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2155 @opindex Wold-style-cast
2156 @opindex Wno-old-style-cast
2157 Warn if an old-style (C-style) cast to a non-void type is used within
2158 a C++ program.  The new-style casts (@samp{dynamic_cast},
2159 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2160 less vulnerable to unintended effects and much easier to search for.
2162 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2163 @opindex Woverloaded-virtual
2164 @opindex Wno-overloaded-virtual
2165 @cindex overloaded virtual fn, warning
2166 @cindex warning for overloaded virtual fn
2167 Warn when a function declaration hides virtual functions from a
2168 base class.  For example, in:
2170 @smallexample
2171 struct A @{
2172   virtual void f();
2175 struct B: public A @{
2176   void f(int);
2178 @end smallexample
2180 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2181 like:
2183 @smallexample
2184 B* b;
2185 b->f();
2186 @end smallexample
2188 will fail to compile.
2190 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2191 @opindex Wno-pmf-conversions
2192 @opindex Wpmf-conversions
2193 Disable the diagnostic for converting a bound pointer to member function
2194 to a plain pointer.
2196 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2197 @opindex Wsign-promo
2198 @opindex Wno-sign-promo
2199 Warn when overload resolution chooses a promotion from unsigned or
2200 enumerated type to a signed type, over a conversion to an unsigned type of
2201 the same size.  Previous versions of G++ would try to preserve
2202 unsignedness, but the standard mandates the current behavior.
2204 @smallexample
2205 struct A @{
2206   operator int ();
2207   A& operator = (int);
2210 main ()
2212   A a,b;
2213   a = b;
2215 @end smallexample
2217 In this example, G++ will synthesize a default @samp{A& operator =
2218 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2219 @end table
2221 @node Objective-C and Objective-C++ Dialect Options
2222 @section Options Controlling Objective-C and Objective-C++ Dialects
2224 @cindex compiler options, Objective-C and Objective-C++
2225 @cindex Objective-C and Objective-C++ options, command line
2226 @cindex options, Objective-C and Objective-C++
2227 (NOTE: This manual does not describe the Objective-C and Objective-C++
2228 languages themselves.  See @xref{Standards,,Language Standards
2229 Supported by GCC}, for references.)
2231 This section describes the command-line options that are only meaningful
2232 for Objective-C and Objective-C++ programs, but you can also use most of
2233 the language-independent GNU compiler options.
2234 For example, you might compile a file @code{some_class.m} like this:
2236 @smallexample
2237 gcc -g -fgnu-runtime -O -c some_class.m
2238 @end smallexample
2240 @noindent
2241 In this example, @option{-fgnu-runtime} is an option meant only for
2242 Objective-C and Objective-C++ programs; you can use the other options with
2243 any language supported by GCC@.
2245 Note that since Objective-C is an extension of the C language, Objective-C
2246 compilations may also use options specific to the C front-end (e.g.,
2247 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2248 C++-specific options (e.g., @option{-Wabi}).
2250 Here is a list of options that are @emph{only} for compiling Objective-C
2251 and Objective-C++ programs:
2253 @table @gcctabopt
2254 @item -fconstant-string-class=@var{class-name}
2255 @opindex fconstant-string-class
2256 Use @var{class-name} as the name of the class to instantiate for each
2257 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2258 class name is @code{NXConstantString} if the GNU runtime is being used, and
2259 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2260 @option{-fconstant-cfstrings} option, if also present, will override the
2261 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2262 to be laid out as constant CoreFoundation strings.
2264 @item -fgnu-runtime
2265 @opindex fgnu-runtime
2266 Generate object code compatible with the standard GNU Objective-C
2267 runtime.  This is the default for most types of systems.
2269 @item -fnext-runtime
2270 @opindex fnext-runtime
2271 Generate output compatible with the NeXT runtime.  This is the default
2272 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2273 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2274 used.
2276 @item -fno-nil-receivers
2277 @opindex fno-nil-receivers
2278 Assume that all Objective-C message dispatches (e.g.,
2279 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2280 is not @code{nil}.  This allows for more efficient entry points in the runtime
2281 to be used.  Currently, this option is only available in conjunction with
2282 the NeXT runtime on Mac OS X 10.3 and later.
2284 @item -fobjc-call-cxx-cdtors
2285 @opindex fobjc-call-cxx-cdtors
2286 For each Objective-C class, check if any of its instance variables is a
2287 C++ object with a non-trivial default constructor.  If so, synthesize a
2288 special @code{- (id) .cxx_construct} instance method that will run
2289 non-trivial default constructors on any such instance variables, in order,
2290 and then return @code{self}.  Similarly, check if any instance variable
2291 is a C++ object with a non-trivial destructor, and if so, synthesize a
2292 special @code{- (void) .cxx_destruct} method that will run
2293 all such default destructors, in reverse order.
2295 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2296 thusly generated will only operate on instance variables declared in the
2297 current Objective-C class, and not those inherited from superclasses.  It
2298 is the responsibility of the Objective-C runtime to invoke all such methods
2299 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2300 will be invoked by the runtime immediately after a new object
2301 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2302 be invoked immediately before the runtime deallocates an object instance.
2304 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2305 support for invoking the @code{- (id) .cxx_construct} and
2306 @code{- (void) .cxx_destruct} methods.
2308 @item -fobjc-direct-dispatch
2309 @opindex fobjc-direct-dispatch
2310 Allow fast jumps to the message dispatcher.  On Darwin this is
2311 accomplished via the comm page.
2313 @item -fobjc-exceptions
2314 @opindex fobjc-exceptions
2315 Enable syntactic support for structured exception handling in Objective-C,
2316 similar to what is offered by C++ and Java.  This option is
2317 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2318 earlier.
2320 @smallexample
2321   @@try @{
2322     @dots{}
2323        @@throw expr;
2324     @dots{}
2325   @}
2326   @@catch (AnObjCClass *exc) @{
2327     @dots{}
2328       @@throw expr;
2329     @dots{}
2330       @@throw;
2331     @dots{}
2332   @}
2333   @@catch (AnotherClass *exc) @{
2334     @dots{}
2335   @}
2336   @@catch (id allOthers) @{
2337     @dots{}
2338   @}
2339   @@finally @{
2340     @dots{}
2341       @@throw expr;
2342     @dots{}
2343   @}
2344 @end smallexample
2346 The @code{@@throw} statement may appear anywhere in an Objective-C or
2347 Objective-C++ program; when used inside of a @code{@@catch} block, the
2348 @code{@@throw} may appear without an argument (as shown above), in which case
2349 the object caught by the @code{@@catch} will be rethrown.
2351 Note that only (pointers to) Objective-C objects may be thrown and
2352 caught using this scheme.  When an object is thrown, it will be caught
2353 by the nearest @code{@@catch} clause capable of handling objects of that type,
2354 analogously to how @code{catch} blocks work in C++ and Java.  A
2355 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2356 any and all Objective-C exceptions not caught by previous @code{@@catch}
2357 clauses (if any).
2359 The @code{@@finally} clause, if present, will be executed upon exit from the
2360 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2361 regardless of whether any exceptions are thrown, caught or rethrown
2362 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2363 of the @code{finally} clause in Java.
2365 There are several caveats to using the new exception mechanism:
2367 @itemize @bullet
2368 @item
2369 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2370 idioms provided by the @code{NSException} class, the new
2371 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2372 systems, due to additional functionality needed in the (NeXT) Objective-C
2373 runtime.
2375 @item
2376 As mentioned above, the new exceptions do not support handling
2377 types other than Objective-C objects.   Furthermore, when used from
2378 Objective-C++, the Objective-C exception model does not interoperate with C++
2379 exceptions at this time.  This means you cannot @code{@@throw} an exception
2380 from Objective-C and @code{catch} it in C++, or vice versa
2381 (i.e., @code{throw @dots{} @@catch}).
2382 @end itemize
2384 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2385 blocks for thread-safe execution:
2387 @smallexample
2388   @@synchronized (ObjCClass *guard) @{
2389     @dots{}
2390   @}
2391 @end smallexample
2393 Upon entering the @code{@@synchronized} block, a thread of execution shall
2394 first check whether a lock has been placed on the corresponding @code{guard}
2395 object by another thread.  If it has, the current thread shall wait until
2396 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2397 the current thread will place its own lock on it, execute the code contained in
2398 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2399 making @code{guard} available to other threads).
2401 Unlike Java, Objective-C does not allow for entire methods to be marked
2402 @code{@@synchronized}.  Note that throwing exceptions out of
2403 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2404 to be unlocked properly.
2406 @item -fobjc-gc
2407 @opindex fobjc-gc
2408 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2410 @item -freplace-objc-classes
2411 @opindex freplace-objc-classes
2412 Emit a special marker instructing @command{ld(1)} not to statically link in
2413 the resulting object file, and allow @command{dyld(1)} to load it in at
2414 run time instead.  This is used in conjunction with the Fix-and-Continue
2415 debugging mode, where the object file in question may be recompiled and
2416 dynamically reloaded in the course of program execution, without the need
2417 to restart the program itself.  Currently, Fix-and-Continue functionality
2418 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2419 and later.
2421 @item -fzero-link
2422 @opindex fzero-link
2423 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2424 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2425 compile time) with static class references that get initialized at load time,
2426 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2427 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2428 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2429 for individual class implementations to be modified during program execution.
2431 @item -gen-decls
2432 @opindex gen-decls
2433 Dump interface declarations for all classes seen in the source file to a
2434 file named @file{@var{sourcename}.decl}.
2436 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2437 @opindex Wassign-intercept
2438 @opindex Wno-assign-intercept
2439 Warn whenever an Objective-C assignment is being intercepted by the
2440 garbage collector.
2442 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2443 @opindex Wno-protocol
2444 @opindex Wprotocol
2445 If a class is declared to implement a protocol, a warning is issued for
2446 every method in the protocol that is not implemented by the class.  The
2447 default behavior is to issue a warning for every method not explicitly
2448 implemented in the class, even if a method implementation is inherited
2449 from the superclass.  If you use the @option{-Wno-protocol} option, then
2450 methods inherited from the superclass are considered to be implemented,
2451 and no warning is issued for them.
2453 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2454 @opindex Wselector
2455 @opindex Wno-selector
2456 Warn if multiple methods of different types for the same selector are
2457 found during compilation.  The check is performed on the list of methods
2458 in the final stage of compilation.  Additionally, a check is performed
2459 for each selector appearing in a @code{@@selector(@dots{})}
2460 expression, and a corresponding method for that selector has been found
2461 during compilation.  Because these checks scan the method table only at
2462 the end of compilation, these warnings are not produced if the final
2463 stage of compilation is not reached, for example because an error is
2464 found during compilation, or because the @option{-fsyntax-only} option is
2465 being used.
2467 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2468 @opindex Wstrict-selector-match
2469 @opindex Wno-strict-selector-match
2470 Warn if multiple methods with differing argument and/or return types are
2471 found for a given selector when attempting to send a message using this
2472 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2473 is off (which is the default behavior), the compiler will omit such warnings
2474 if any differences found are confined to types which share the same size
2475 and alignment.
2477 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2478 @opindex Wundeclared-selector
2479 @opindex Wno-undeclared-selector
2480 Warn if a @code{@@selector(@dots{})} expression referring to an
2481 undeclared selector is found.  A selector is considered undeclared if no
2482 method with that name has been declared before the
2483 @code{@@selector(@dots{})} expression, either explicitly in an
2484 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2485 an @code{@@implementation} section.  This option always performs its
2486 checks as soon as a @code{@@selector(@dots{})} expression is found,
2487 while @option{-Wselector} only performs its checks in the final stage of
2488 compilation.  This also enforces the coding style convention
2489 that methods and selectors must be declared before being used.
2491 @item -print-objc-runtime-info
2492 @opindex print-objc-runtime-info
2493 Generate C header describing the largest structure that is passed by
2494 value, if any.
2496 @end table
2498 @node Language Independent Options
2499 @section Options to Control Diagnostic Messages Formatting
2500 @cindex options to control diagnostics formatting
2501 @cindex diagnostic messages
2502 @cindex message formatting
2504 Traditionally, diagnostic messages have been formatted irrespective of
2505 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2506 below can be used to control the diagnostic messages formatting
2507 algorithm, e.g.@: how many characters per line, how often source location
2508 information should be reported.  Right now, only the C++ front end can
2509 honor these options.  However it is expected, in the near future, that
2510 the remaining front ends would be able to digest them correctly.
2512 @table @gcctabopt
2513 @item -fmessage-length=@var{n}
2514 @opindex fmessage-length
2515 Try to format error messages so that they fit on lines of about @var{n}
2516 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2517 the front ends supported by GCC@.  If @var{n} is zero, then no
2518 line-wrapping will be done; each error message will appear on a single
2519 line.
2521 @opindex fdiagnostics-show-location
2522 @item -fdiagnostics-show-location=once
2523 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2524 reporter to emit @emph{once} source location information; that is, in
2525 case the message is too long to fit on a single physical line and has to
2526 be wrapped, the source location won't be emitted (as prefix) again,
2527 over and over, in subsequent continuation lines.  This is the default
2528 behavior.
2530 @item -fdiagnostics-show-location=every-line
2531 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2532 messages reporter to emit the same source location information (as
2533 prefix) for physical lines that result from the process of breaking
2534 a message which is too long to fit on a single line.
2536 @item -fdiagnostics-show-option
2537 @opindex fdiagnostics-show-option
2538 This option instructs the diagnostic machinery to add text to each
2539 diagnostic emitted, which indicates which command line option directly
2540 controls that diagnostic, when such an option is known to the
2541 diagnostic machinery.
2543 @item -Wcoverage-mismatch
2544 @opindex Wcoverage-mismatch
2545 Warn if feedback profiles do not match when using the
2546 @option{-fprofile-use} option.
2547 If a source file was changed between @option{-fprofile-gen} and
2548 @option{-fprofile-use}, the files with the profile feedback can fail
2549 to match the source file and GCC can not use the profile feedback
2550 information.  By default, GCC emits an error message in this case.
2551 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2552 error.  GCC does not use appropriate feedback profiles, so using this
2553 option can result in poorly optimized code.  This option is useful
2554 only in the case of very minor changes such as bug fixes to an
2555 existing code-base.
2557 @end table
2559 @node Warning Options
2560 @section Options to Request or Suppress Warnings
2561 @cindex options to control warnings
2562 @cindex warning messages
2563 @cindex messages, warning
2564 @cindex suppressing warnings
2566 Warnings are diagnostic messages that report constructions which
2567 are not inherently erroneous but which are risky or suggest there
2568 may have been an error.
2570 The following language-independent options do not enable specific
2571 warnings but control the kinds of diagnostics produced by GCC.
2573 @table @gcctabopt
2574 @cindex syntax checking
2575 @item -fsyntax-only
2576 @opindex fsyntax-only
2577 Check the code for syntax errors, but don't do anything beyond that.
2579 @item -w
2580 @opindex w
2581 Inhibit all warning messages.
2583 @item -Werror
2584 @opindex Werror
2585 @opindex Wno-error
2586 Make all warnings into errors.
2588 @item -Werror=
2589 @opindex Werror=
2590 @opindex Wno-error=
2591 Make the specified warning into an error.  The specifier for a warning
2592 is appended, for example @option{-Werror=switch} turns the warnings
2593 controlled by @option{-Wswitch} into errors.  This switch takes a
2594 negative form, to be used to negate @option{-Werror} for specific
2595 warnings, for example @option{-Wno-error=switch} makes
2596 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2597 is in effect.  You can use the @option{-fdiagnostics-show-option}
2598 option to have each controllable warning amended with the option which
2599 controls it, to determine what to use with this option.
2601 Note that specifying @option{-Werror=}@var{foo} automatically implies
2602 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2603 imply anything.
2605 @item -Wfatal-errors
2606 @opindex Wfatal-errors
2607 @opindex Wno-fatal-errors
2608 This option causes the compiler to abort compilation on the first error
2609 occurred rather than trying to keep going and printing further error
2610 messages.
2612 @end table
2614 You can request many specific warnings with options beginning
2615 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2616 implicit declarations.  Each of these specific warning options also
2617 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2618 example, @option{-Wno-implicit}.  This manual lists only one of the
2619 two forms, whichever is not the default.  For further,
2620 language-specific options also refer to @ref{C++ Dialect Options} and
2621 @ref{Objective-C and Objective-C++ Dialect Options}.
2623 @table @gcctabopt
2624 @item -pedantic
2625 @opindex pedantic
2626 Issue all the warnings demanded by strict ISO C and ISO C++;
2627 reject all programs that use forbidden extensions, and some other
2628 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2629 version of the ISO C standard specified by any @option{-std} option used.
2631 Valid ISO C and ISO C++ programs should compile properly with or without
2632 this option (though a rare few will require @option{-ansi} or a
2633 @option{-std} option specifying the required version of ISO C)@.  However,
2634 without this option, certain GNU extensions and traditional C and C++
2635 features are supported as well.  With this option, they are rejected.
2637 @option{-pedantic} does not cause warning messages for use of the
2638 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2639 warnings are also disabled in the expression that follows
2640 @code{__extension__}.  However, only system header files should use
2641 these escape routes; application programs should avoid them.
2642 @xref{Alternate Keywords}.
2644 Some users try to use @option{-pedantic} to check programs for strict ISO
2645 C conformance.  They soon find that it does not do quite what they want:
2646 it finds some non-ISO practices, but not all---only those for which
2647 ISO C @emph{requires} a diagnostic, and some others for which
2648 diagnostics have been added.
2650 A feature to report any failure to conform to ISO C might be useful in
2651 some instances, but would require considerable additional work and would
2652 be quite different from @option{-pedantic}.  We don't have plans to
2653 support such a feature in the near future.
2655 Where the standard specified with @option{-std} represents a GNU
2656 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2657 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2658 extended dialect is based.  Warnings from @option{-pedantic} are given
2659 where they are required by the base standard.  (It would not make sense
2660 for such warnings to be given only for features not in the specified GNU
2661 C dialect, since by definition the GNU dialects of C include all
2662 features the compiler supports with the given option, and there would be
2663 nothing to warn about.)
2665 @item -pedantic-errors
2666 @opindex pedantic-errors
2667 Like @option{-pedantic}, except that errors are produced rather than
2668 warnings.
2670 @item -Wall
2671 @opindex Wall
2672 @opindex Wno-all
2673 This enables all the warnings about constructions that some users
2674 consider questionable, and that are easy to avoid (or modify to
2675 prevent the warning), even in conjunction with macros.  This also
2676 enables some language-specific warnings described in @ref{C++ Dialect
2677 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2679 @option{-Wall} turns on the following warning flags:
2681 @gccoptlist{-Waddress   @gol
2682 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2683 -Wc++0x-compat  @gol
2684 -Wchar-subscripts  @gol
2685 -Wimplicit-int  @gol
2686 -Wimplicit-function-declaration  @gol
2687 -Wcomment  @gol
2688 -Wformat   @gol
2689 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2690 -Wmissing-braces  @gol
2691 -Wnonnull  @gol
2692 -Wparentheses  @gol
2693 -Wpointer-sign  @gol
2694 -Wreorder   @gol
2695 -Wreturn-type  @gol
2696 -Wsequence-point  @gol
2697 -Wsign-compare @r{(only in C++)}  @gol
2698 -Wstrict-aliasing  @gol
2699 -Wstrict-overflow=1  @gol
2700 -Wswitch  @gol
2701 -Wtrigraphs  @gol
2702 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2703 -Wunknown-pragmas  @gol
2704 -Wunused-function  @gol
2705 -Wunused-label     @gol
2706 -Wunused-value     @gol
2707 -Wunused-variable  @gol
2708 -Wvolatile-register-var @gol
2711 Note that some warning flags are not implied by @option{-Wall}.  Some of
2712 them warn about constructions that users generally do not consider
2713 questionable, but which occasionally you might wish to check for;
2714 others warn about constructions that are necessary or hard to avoid in
2715 some cases, and there is no simple way to modify the code to suppress
2716 the warning. Some of them are enabled by @option{-Wextra} but many of
2717 them must be enabled individually.
2719 @item -Wextra
2720 @opindex W
2721 @opindex Wextra
2722 @opindex Wno-extra
2723 This enables some extra warning flags that are not enabled by
2724 @option{-Wall}. (This option used to be called @option{-W}.  The older
2725 name is still supported, but the newer name is more descriptive.)
2727 @gccoptlist{-Wclobbered  @gol
2728 -Wempty-body  @gol
2729 -Wignored-qualifiers @gol
2730 -Wmissing-field-initializers  @gol
2731 -Wmissing-parameter-type @r{(C only)}  @gol
2732 -Wold-style-declaration @r{(C only)}  @gol
2733 -Woverride-init  @gol
2734 -Wsign-compare  @gol
2735 -Wtype-limits  @gol
2736 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2737 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2740 The option @option{-Wextra} also prints warning messages for the
2741 following cases:
2743 @itemize @bullet
2745 @item
2746 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2747 @samp{>}, or @samp{>=}.
2749 @item 
2750 (C++ only) An enumerator and a non-enumerator both appear in a
2751 conditional expression.
2753 @item 
2754 (C++ only) A non-static reference or non-static @samp{const} member
2755 appears in a class without constructors.
2757 @item 
2758 (C++ only) Ambiguous virtual bases.
2760 @item 
2761 (C++ only) Subscripting an array which has been declared @samp{register}.
2763 @item 
2764 (C++ only) Taking the address of a variable which has been declared
2765 @samp{register}.
2767 @item 
2768 (C++ only) A base class is not initialized in a derived class' copy
2769 constructor.
2771 @end itemize
2773 @item -Wchar-subscripts
2774 @opindex Wchar-subscripts
2775 @opindex Wno-char-subscripts
2776 Warn if an array subscript has type @code{char}.  This is a common cause
2777 of error, as programmers often forget that this type is signed on some
2778 machines.
2779 This warning is enabled by @option{-Wall}.
2781 @item -Wcomment
2782 @opindex Wcomment
2783 @opindex Wno-comment
2784 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2785 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2786 This warning is enabled by @option{-Wall}.
2788 @item -Wformat
2789 @opindex Wformat
2790 @opindex Wno-format
2791 @opindex ffreestanding
2792 @opindex fno-builtin
2793 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2794 the arguments supplied have types appropriate to the format string
2795 specified, and that the conversions specified in the format string make
2796 sense.  This includes standard functions, and others specified by format
2797 attributes (@pxref{Function Attributes}), in the @code{printf},
2798 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2799 not in the C standard) families (or other target-specific families).
2800 Which functions are checked without format attributes having been
2801 specified depends on the standard version selected, and such checks of
2802 functions without the attribute specified are disabled by
2803 @option{-ffreestanding} or @option{-fno-builtin}.
2805 The formats are checked against the format features supported by GNU
2806 libc version 2.2.  These include all ISO C90 and C99 features, as well
2807 as features from the Single Unix Specification and some BSD and GNU
2808 extensions.  Other library implementations may not support all these
2809 features; GCC does not support warning about features that go beyond a
2810 particular library's limitations.  However, if @option{-pedantic} is used
2811 with @option{-Wformat}, warnings will be given about format features not
2812 in the selected standard version (but not for @code{strfmon} formats,
2813 since those are not in any version of the C standard).  @xref{C Dialect
2814 Options,,Options Controlling C Dialect}.
2816 Since @option{-Wformat} also checks for null format arguments for
2817 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2819 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2820 aspects of format checking, the options @option{-Wformat-y2k},
2821 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2822 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2823 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2825 @item -Wformat-y2k
2826 @opindex Wformat-y2k
2827 @opindex Wno-format-y2k
2828 If @option{-Wformat} is specified, also warn about @code{strftime}
2829 formats which may yield only a two-digit year.
2831 @item -Wno-format-contains-nul
2832 @opindex Wno-format-contains-nul
2833 @opindex Wformat-contains-nul
2834 If @option{-Wformat} is specified, do not warn about format strings that
2835 contain NUL bytes.
2837 @item -Wno-format-extra-args
2838 @opindex Wno-format-extra-args
2839 @opindex Wformat-extra-args
2840 If @option{-Wformat} is specified, do not warn about excess arguments to a
2841 @code{printf} or @code{scanf} format function.  The C standard specifies
2842 that such arguments are ignored.
2844 Where the unused arguments lie between used arguments that are
2845 specified with @samp{$} operand number specifications, normally
2846 warnings are still given, since the implementation could not know what
2847 type to pass to @code{va_arg} to skip the unused arguments.  However,
2848 in the case of @code{scanf} formats, this option will suppress the
2849 warning if the unused arguments are all pointers, since the Single
2850 Unix Specification says that such unused arguments are allowed.
2852 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2853 @opindex Wno-format-zero-length
2854 @opindex Wformat-zero-length
2855 If @option{-Wformat} is specified, do not warn about zero-length formats.
2856 The C standard specifies that zero-length formats are allowed.
2858 @item -Wformat-nonliteral
2859 @opindex Wformat-nonliteral
2860 @opindex Wno-format-nonliteral
2861 If @option{-Wformat} is specified, also warn if the format string is not a
2862 string literal and so cannot be checked, unless the format function
2863 takes its format arguments as a @code{va_list}.
2865 @item -Wformat-security
2866 @opindex Wformat-security
2867 @opindex Wno-format-security
2868 If @option{-Wformat} is specified, also warn about uses of format
2869 functions that represent possible security problems.  At present, this
2870 warns about calls to @code{printf} and @code{scanf} functions where the
2871 format string is not a string literal and there are no format arguments,
2872 as in @code{printf (foo);}.  This may be a security hole if the format
2873 string came from untrusted input and contains @samp{%n}.  (This is
2874 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2875 in future warnings may be added to @option{-Wformat-security} that are not
2876 included in @option{-Wformat-nonliteral}.)
2878 @item -Wformat=2
2879 @opindex Wformat=2
2880 @opindex Wno-format=2
2881 Enable @option{-Wformat} plus format checks not included in
2882 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2883 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2885 @item -Wnonnull @r{(C and Objective-C only)}
2886 @opindex Wnonnull
2887 @opindex Wno-nonnull
2888 Warn about passing a null pointer for arguments marked as
2889 requiring a non-null value by the @code{nonnull} function attribute.
2891 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2892 can be disabled with the @option{-Wno-nonnull} option.
2894 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2895 @opindex Winit-self
2896 @opindex Wno-init-self
2897 Warn about uninitialized variables which are initialized with themselves.
2898 Note this option can only be used with the @option{-Wuninitialized} option,
2899 which in turn only works with @option{-O1} and above.
2901 For example, GCC will warn about @code{i} being uninitialized in the
2902 following snippet only when @option{-Winit-self} has been specified:
2903 @smallexample
2904 @group
2905 int f()
2907   int i = i;
2908   return i;
2910 @end group
2911 @end smallexample
2913 @item -Wimplicit-int @r{(C and Objective-C only)}
2914 @opindex Wimplicit-int
2915 @opindex Wno-implicit-int
2916 Warn when a declaration does not specify a type.
2917 This warning is enabled by @option{-Wall}.
2919 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2920 @opindex Wimplicit-function-declaration
2921 @opindex Wno-implicit-function-declaration
2922 Give a warning whenever a function is used before being declared. In
2923 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2924 enabled by default and it is made into an error by
2925 @option{-pedantic-errors}. This warning is also enabled by
2926 @option{-Wall}.
2928 @item -Wimplicit
2929 @opindex Wimplicit
2930 @opindex Wno-implicit
2931 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2932 This warning is enabled by @option{-Wall}.
2934 @item -Wignored-qualifiers @r{(C and C++ only)}
2935 @opindex Wignored-qualifiers
2936 @opindex Wno-ignored-qualifiers
2937 Warn if the return type of a function has a type qualifier
2938 such as @code{const}.  For ISO C such a type qualifier has no effect,
2939 since the value returned by a function is not an lvalue.
2940 For C++, the warning is only emitted for scalar types or @code{void}.
2941 ISO C prohibits qualified @code{void} return types on function
2942 definitions, so such return types always receive a warning
2943 even without this option.
2945 This warning is also enabled by @option{-Wextra}.
2947 @item -Wmain
2948 @opindex Wmain
2949 @opindex Wno-main
2950 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2951 function with external linkage, returning int, taking either zero
2952 arguments, two, or three arguments of appropriate types.
2953 This warning is enabled by @option{-Wall}.
2955 @item -Wmissing-braces
2956 @opindex Wmissing-braces
2957 @opindex Wno-missing-braces
2958 Warn if an aggregate or union initializer is not fully bracketed.  In
2959 the following example, the initializer for @samp{a} is not fully
2960 bracketed, but that for @samp{b} is fully bracketed.
2962 @smallexample
2963 int a[2][2] = @{ 0, 1, 2, 3 @};
2964 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2965 @end smallexample
2967 This warning is enabled by @option{-Wall}.
2969 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2970 @opindex Wmissing-include-dirs
2971 @opindex Wno-missing-include-dirs
2972 Warn if a user-supplied include directory does not exist.
2974 @item -Wparentheses
2975 @opindex Wparentheses
2976 @opindex Wno-parentheses
2977 Warn if parentheses are omitted in certain contexts, such
2978 as when there is an assignment in a context where a truth value
2979 is expected, or when operators are nested whose precedence people
2980 often get confused about.
2982 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2983 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2984 interpretation from that of ordinary mathematical notation.
2986 Also warn about constructions where there may be confusion to which
2987 @code{if} statement an @code{else} branch belongs.  Here is an example of
2988 such a case:
2990 @smallexample
2991 @group
2993   if (a)
2994     if (b)
2995       foo ();
2996   else
2997     bar ();
2999 @end group
3000 @end smallexample
3002 In C/C++, every @code{else} branch belongs to the innermost possible
3003 @code{if} statement, which in this example is @code{if (b)}.  This is
3004 often not what the programmer expected, as illustrated in the above
3005 example by indentation the programmer chose.  When there is the
3006 potential for this confusion, GCC will issue a warning when this flag
3007 is specified.  To eliminate the warning, add explicit braces around
3008 the innermost @code{if} statement so there is no way the @code{else}
3009 could belong to the enclosing @code{if}.  The resulting code would
3010 look like this:
3012 @smallexample
3013 @group
3015   if (a)
3016     @{
3017       if (b)
3018         foo ();
3019       else
3020         bar ();
3021     @}
3023 @end group
3024 @end smallexample
3026 This warning is enabled by @option{-Wall}.
3028 @item -Wsequence-point
3029 @opindex Wsequence-point
3030 @opindex Wno-sequence-point
3031 Warn about code that may have undefined semantics because of violations
3032 of sequence point rules in the C and C++ standards.
3034 The C and C++ standards defines the order in which expressions in a C/C++
3035 program are evaluated in terms of @dfn{sequence points}, which represent
3036 a partial ordering between the execution of parts of the program: those
3037 executed before the sequence point, and those executed after it.  These
3038 occur after the evaluation of a full expression (one which is not part
3039 of a larger expression), after the evaluation of the first operand of a
3040 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3041 function is called (but after the evaluation of its arguments and the
3042 expression denoting the called function), and in certain other places.
3043 Other than as expressed by the sequence point rules, the order of
3044 evaluation of subexpressions of an expression is not specified.  All
3045 these rules describe only a partial order rather than a total order,
3046 since, for example, if two functions are called within one expression
3047 with no sequence point between them, the order in which the functions
3048 are called is not specified.  However, the standards committee have
3049 ruled that function calls do not overlap.
3051 It is not specified when between sequence points modifications to the
3052 values of objects take effect.  Programs whose behavior depends on this
3053 have undefined behavior; the C and C++ standards specify that ``Between
3054 the previous and next sequence point an object shall have its stored
3055 value modified at most once by the evaluation of an expression.
3056 Furthermore, the prior value shall be read only to determine the value
3057 to be stored.''.  If a program breaks these rules, the results on any
3058 particular implementation are entirely unpredictable.
3060 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3061 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3062 diagnosed by this option, and it may give an occasional false positive
3063 result, but in general it has been found fairly effective at detecting
3064 this sort of problem in programs.
3066 The standard is worded confusingly, therefore there is some debate
3067 over the precise meaning of the sequence point rules in subtle cases.
3068 Links to discussions of the problem, including proposed formal
3069 definitions, may be found on the GCC readings page, at
3070 @w{@uref{http://gcc.gnu.org/readings.html}}.
3072 This warning is enabled by @option{-Wall} for C and C++.
3074 @item -Wreturn-type
3075 @opindex Wreturn-type
3076 @opindex Wno-return-type
3077 Warn whenever a function is defined with a return-type that defaults
3078 to @code{int}.  Also warn about any @code{return} statement with no
3079 return-value in a function whose return-type is not @code{void}
3080 (falling off the end of the function body is considered returning
3081 without a value), and about a @code{return} statement with a
3082 expression in a function whose return-type is @code{void}.
3084 For C++, a function without return type always produces a diagnostic
3085 message, even when @option{-Wno-return-type} is specified.  The only
3086 exceptions are @samp{main} and functions defined in system headers.
3088 This warning is enabled by @option{-Wall}.
3090 @item -Wswitch
3091 @opindex Wswitch
3092 @opindex Wno-switch
3093 Warn whenever a @code{switch} statement has an index of enumerated type
3094 and lacks a @code{case} for one or more of the named codes of that
3095 enumeration.  (The presence of a @code{default} label prevents this
3096 warning.)  @code{case} labels outside the enumeration range also
3097 provoke warnings when this option is used.
3098 This warning is enabled by @option{-Wall}.
3100 @item -Wswitch-default
3101 @opindex Wswitch-default
3102 @opindex Wno-switch-default
3103 Warn whenever a @code{switch} statement does not have a @code{default}
3104 case.
3106 @item -Wswitch-enum
3107 @opindex Wswitch-enum
3108 @opindex Wno-switch-enum
3109 Warn whenever a @code{switch} statement has an index of enumerated type
3110 and lacks a @code{case} for one or more of the named codes of that
3111 enumeration.  @code{case} labels outside the enumeration range also
3112 provoke warnings when this option is used.
3114 @item -Wtrigraphs
3115 @opindex Wtrigraphs
3116 @opindex Wno-trigraphs
3117 Warn if any trigraphs are encountered that might change the meaning of
3118 the program (trigraphs within comments are not warned about).
3119 This warning is enabled by @option{-Wall}.
3121 @item -Wunused-function
3122 @opindex Wunused-function
3123 @opindex Wno-unused-function
3124 Warn whenever a static function is declared but not defined or a
3125 non-inline static function is unused.
3126 This warning is enabled by @option{-Wall}.
3128 @item -Wunused-label
3129 @opindex Wunused-label
3130 @opindex Wno-unused-label
3131 Warn whenever a label is declared but not used.
3132 This warning is enabled by @option{-Wall}.
3134 To suppress this warning use the @samp{unused} attribute
3135 (@pxref{Variable Attributes}).
3137 @item -Wunused-parameter
3138 @opindex Wunused-parameter
3139 @opindex Wno-unused-parameter
3140 Warn whenever a function parameter is unused aside from its declaration.
3142 To suppress this warning use the @samp{unused} attribute
3143 (@pxref{Variable Attributes}).
3145 @item -Wunused-variable
3146 @opindex Wunused-variable
3147 @opindex Wno-unused-variable
3148 Warn whenever a local variable or non-constant static variable is unused
3149 aside from its declaration.
3150 This warning is enabled by @option{-Wall}.
3152 To suppress this warning use the @samp{unused} attribute
3153 (@pxref{Variable Attributes}).
3155 @item -Wunused-value
3156 @opindex Wunused-value
3157 @opindex Wno-unused-value
3158 Warn whenever a statement computes a result that is explicitly not
3159 used. To suppress this warning cast the unused expression to
3160 @samp{void}. This includes an expression-statement or the left-hand
3161 side of a comma expression that contains no side effects. For example,
3162 an expression such as @samp{x[i,j]} will cause a warning, while
3163 @samp{x[(void)i,j]} will not.
3165 This warning is enabled by @option{-Wall}.
3167 @item -Wunused
3168 @opindex Wunused
3169 @opindex Wno-unused
3170 All the above @option{-Wunused} options combined.
3172 In order to get a warning about an unused function parameter, you must
3173 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3174 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3176 @item -Wuninitialized
3177 @opindex Wuninitialized
3178 @opindex Wno-uninitialized
3179 Warn if an automatic variable is used without first being initialized or
3180 if a variable may be clobbered by a @code{setjmp} call.
3182 These warnings are possible only in optimizing compilation,
3183 because they require data flow information that is computed only
3184 when optimizing.  If you do not specify @option{-O}, you will not get
3185 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3186 requiring @option{-O}.
3188 If you want to warn about code which uses the uninitialized value of the
3189 variable in its own initializer, use the @option{-Winit-self} option.
3191 These warnings occur for individual uninitialized or clobbered
3192 elements of structure, union or array variables as well as for
3193 variables which are uninitialized or clobbered as a whole.  They do
3194 not occur for variables or elements declared @code{volatile}.  Because
3195 these warnings depend on optimization, the exact variables or elements
3196 for which there are warnings will depend on the precise optimization
3197 options and version of GCC used.
3199 Note that there may be no warning about a variable that is used only
3200 to compute a value that itself is never used, because such
3201 computations may be deleted by data flow analysis before the warnings
3202 are printed.
3204 These warnings are made optional because GCC is not smart
3205 enough to see all the reasons why the code might be correct
3206 despite appearing to have an error.  Here is one example of how
3207 this can happen:
3209 @smallexample
3210 @group
3212   int x;
3213   switch (y)
3214     @{
3215     case 1: x = 1;
3216       break;
3217     case 2: x = 4;
3218       break;
3219     case 3: x = 5;
3220     @}
3221   foo (x);
3223 @end group
3224 @end smallexample
3226 @noindent
3227 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3228 always initialized, but GCC doesn't know this.  Here is
3229 another common case:
3231 @smallexample
3233   int save_y;
3234   if (change_y) save_y = y, y = new_y;
3235   @dots{}
3236   if (change_y) y = save_y;
3238 @end smallexample
3240 @noindent
3241 This has no bug because @code{save_y} is used only if it is set.
3243 @cindex @code{longjmp} warnings
3244 This option also warns when a non-volatile automatic variable might be
3245 changed by a call to @code{longjmp}.  These warnings as well are possible
3246 only in optimizing compilation.
3248 The compiler sees only the calls to @code{setjmp}.  It cannot know
3249 where @code{longjmp} will be called; in fact, a signal handler could
3250 call it at any point in the code.  As a result, you may get a warning
3251 even when there is in fact no problem because @code{longjmp} cannot
3252 in fact be called at the place which would cause a problem.
3254 Some spurious warnings can be avoided if you declare all the functions
3255 you use that never return as @code{noreturn}.  @xref{Function
3256 Attributes}.
3258 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3259 optimizing compilations (@option{-O1} and above).
3261 @item -Wunknown-pragmas
3262 @opindex Wunknown-pragmas
3263 @opindex Wno-unknown-pragmas
3264 @cindex warning for unknown pragmas
3265 @cindex unknown pragmas, warning
3266 @cindex pragmas, warning of unknown
3267 Warn when a #pragma directive is encountered which is not understood by
3268 GCC@.  If this command line option is used, warnings will even be issued
3269 for unknown pragmas in system header files.  This is not the case if
3270 the warnings were only enabled by the @option{-Wall} command line option.
3272 @item -Wno-pragmas
3273 @opindex Wno-pragmas
3274 @opindex Wpragmas
3275 Do not warn about misuses of pragmas, such as incorrect parameters,
3276 invalid syntax, or conflicts between pragmas.  See also
3277 @samp{-Wunknown-pragmas}.
3279 @item -Wstrict-aliasing
3280 @opindex Wstrict-aliasing
3281 @opindex Wno-strict-aliasing
3282 This option is only active when @option{-fstrict-aliasing} is active.
3283 It warns about code which might break the strict aliasing rules that the
3284 compiler is using for optimization.  The warning does not catch all
3285 cases, but does attempt to catch the more common pitfalls.  It is
3286 included in @option{-Wall}.
3287 It is equivalent to @option{-Wstrict-aliasing=3}
3289 @item -Wstrict-aliasing=n
3290 @opindex Wstrict-aliasing=n
3291 @opindex Wno-strict-aliasing=n
3292 This option is only active when @option{-fstrict-aliasing} is active.
3293 It warns about code which might break the strict aliasing rules that the
3294 compiler is using for optimization.
3295 Higher levels correspond to higher accuracy (fewer false positives).
3296 Higher levels also correspond to more effort, similar to the way -O works.
3297 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3298 with n=3.
3300 Level 1: Most aggressive, quick, least accurate.
3301 Possibly useful when higher levels
3302 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3303 false negatives.  However, it has many false positives.
3304 Warns for all pointer conversions between possibly incompatible types, 
3305 even if never dereferenced.  Runs in the frontend only.
3307 Level 2: Aggressive, quick, not too precise.
3308 May still have many false positives (not as many as level 1 though),
3309 and few false negatives (but possibly more than level 1).
3310 Unlike level 1, it only warns when an address is taken.  Warns about
3311 incomplete types.  Runs in the frontend only.
3313 Level 3 (default for @option{-Wstrict-aliasing}): 
3314 Should have very few false positives and few false 
3315 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3316 Takes care of the common punn+dereference pattern in the frontend:
3317 @code{*(int*)&some_float}.
3318 If optimization is enabled, it also runs in the backend, where it deals 
3319 with multiple statement cases using flow-sensitive points-to information.
3320 Only warns when the converted pointer is dereferenced.
3321 Does not warn about incomplete types.
3323 @item -Wstrict-overflow
3324 @itemx -Wstrict-overflow=@var{n}
3325 @opindex Wstrict-overflow
3326 @opindex Wno-strict-overflow
3327 This option is only active when @option{-fstrict-overflow} is active.
3328 It warns about cases where the compiler optimizes based on the
3329 assumption that signed overflow does not occur.  Note that it does not
3330 warn about all cases where the code might overflow: it only warns
3331 about cases where the compiler implements some optimization.  Thus
3332 this warning depends on the optimization level.
3334 An optimization which assumes that signed overflow does not occur is
3335 perfectly safe if the values of the variables involved are such that
3336 overflow never does, in fact, occur.  Therefore this warning can
3337 easily give a false positive: a warning about code which is not
3338 actually a problem.  To help focus on important issues, several
3339 warning levels are defined.  No warnings are issued for the use of
3340 undefined signed overflow when estimating how many iterations a loop
3341 will require, in particular when determining whether a loop will be
3342 executed at all.
3344 @table @gcctabopt
3345 @item -Wstrict-overflow=1
3346 Warn about cases which are both questionable and easy to avoid.  For
3347 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3348 compiler will simplify this to @code{1}.  This level of
3349 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3350 are not, and must be explicitly requested.
3352 @item -Wstrict-overflow=2
3353 Also warn about other cases where a comparison is simplified to a
3354 constant.  For example: @code{abs (x) >= 0}.  This can only be
3355 simplified when @option{-fstrict-overflow} is in effect, because
3356 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3357 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3358 @option{-Wstrict-overflow=2}.
3360 @item -Wstrict-overflow=3
3361 Also warn about other cases where a comparison is simplified.  For
3362 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3364 @item -Wstrict-overflow=4
3365 Also warn about other simplifications not covered by the above cases.
3366 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3368 @item -Wstrict-overflow=5
3369 Also warn about cases where the compiler reduces the magnitude of a
3370 constant involved in a comparison.  For example: @code{x + 2 > y} will
3371 be simplified to @code{x + 1 >= y}.  This is reported only at the
3372 highest warning level because this simplification applies to many
3373 comparisons, so this warning level will give a very large number of
3374 false positives.
3375 @end table
3377 @item -Warray-bounds
3378 @opindex Wno-array-bounds
3379 @opindex Warray-bounds
3380 This option is only active when @option{-ftree-vrp} is active
3381 (default for -O2 and above). It warns about subscripts to arrays
3382 that are always out of bounds. This warning is enabled by @option{-Wall}.
3384 @item -Wno-div-by-zero
3385 @opindex Wno-div-by-zero
3386 @opindex Wdiv-by-zero
3387 Do not warn about compile-time integer division by zero.  Floating point
3388 division by zero is not warned about, as it can be a legitimate way of
3389 obtaining infinities and NaNs.
3391 @item -Wsystem-headers
3392 @opindex Wsystem-headers
3393 @opindex Wno-system-headers
3394 @cindex warnings from system headers
3395 @cindex system headers, warnings from
3396 Print warning messages for constructs found in system header files.
3397 Warnings from system headers are normally suppressed, on the assumption
3398 that they usually do not indicate real problems and would only make the
3399 compiler output harder to read.  Using this command line option tells
3400 GCC to emit warnings from system headers as if they occurred in user
3401 code.  However, note that using @option{-Wall} in conjunction with this
3402 option will @emph{not} warn about unknown pragmas in system
3403 headers---for that, @option{-Wunknown-pragmas} must also be used.
3405 @item -Wfloat-equal
3406 @opindex Wfloat-equal
3407 @opindex Wno-float-equal
3408 Warn if floating point values are used in equality comparisons.
3410 The idea behind this is that sometimes it is convenient (for the
3411 programmer) to consider floating-point values as approximations to
3412 infinitely precise real numbers.  If you are doing this, then you need
3413 to compute (by analyzing the code, or in some other way) the maximum or
3414 likely maximum error that the computation introduces, and allow for it
3415 when performing comparisons (and when producing output, but that's a
3416 different problem).  In particular, instead of testing for equality, you
3417 would check to see whether the two values have ranges that overlap; and
3418 this is done with the relational operators, so equality comparisons are
3419 probably mistaken.
3421 @item -Wtraditional @r{(C and Objective-C only)}
3422 @opindex Wtraditional
3423 @opindex Wno-traditional
3424 Warn about certain constructs that behave differently in traditional and
3425 ISO C@.  Also warn about ISO C constructs that have no traditional C
3426 equivalent, and/or problematic constructs which should be avoided.
3428 @itemize @bullet
3429 @item
3430 Macro parameters that appear within string literals in the macro body.
3431 In traditional C macro replacement takes place within string literals,
3432 but does not in ISO C@.
3434 @item
3435 In traditional C, some preprocessor directives did not exist.
3436 Traditional preprocessors would only consider a line to be a directive
3437 if the @samp{#} appeared in column 1 on the line.  Therefore
3438 @option{-Wtraditional} warns about directives that traditional C
3439 understands but would ignore because the @samp{#} does not appear as the
3440 first character on the line.  It also suggests you hide directives like
3441 @samp{#pragma} not understood by traditional C by indenting them.  Some
3442 traditional implementations would not recognize @samp{#elif}, so it
3443 suggests avoiding it altogether.
3445 @item
3446 A function-like macro that appears without arguments.
3448 @item
3449 The unary plus operator.
3451 @item
3452 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3453 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3454 constants.)  Note, these suffixes appear in macros defined in the system
3455 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3456 Use of these macros in user code might normally lead to spurious
3457 warnings, however GCC's integrated preprocessor has enough context to
3458 avoid warning in these cases.
3460 @item
3461 A function declared external in one block and then used after the end of
3462 the block.
3464 @item
3465 A @code{switch} statement has an operand of type @code{long}.
3467 @item
3468 A non-@code{static} function declaration follows a @code{static} one.
3469 This construct is not accepted by some traditional C compilers.
3471 @item
3472 The ISO type of an integer constant has a different width or
3473 signedness from its traditional type.  This warning is only issued if
3474 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3475 typically represent bit patterns, are not warned about.
3477 @item
3478 Usage of ISO string concatenation is detected.
3480 @item
3481 Initialization of automatic aggregates.
3483 @item
3484 Identifier conflicts with labels.  Traditional C lacks a separate
3485 namespace for labels.
3487 @item
3488 Initialization of unions.  If the initializer is zero, the warning is
3489 omitted.  This is done under the assumption that the zero initializer in
3490 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3491 initializer warnings and relies on default initialization to zero in the
3492 traditional C case.
3494 @item
3495 Conversions by prototypes between fixed/floating point values and vice
3496 versa.  The absence of these prototypes when compiling with traditional
3497 C would cause serious problems.  This is a subset of the possible
3498 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3500 @item
3501 Use of ISO C style function definitions.  This warning intentionally is
3502 @emph{not} issued for prototype declarations or variadic functions
3503 because these ISO C features will appear in your code when using
3504 libiberty's traditional C compatibility macros, @code{PARAMS} and
3505 @code{VPARAMS}.  This warning is also bypassed for nested functions
3506 because that feature is already a GCC extension and thus not relevant to
3507 traditional C compatibility.
3508 @end itemize
3510 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3511 @opindex Wtraditional-conversion
3512 @opindex Wno-traditional-conversion
3513 Warn if a prototype causes a type conversion that is different from what
3514 would happen to the same argument in the absence of a prototype.  This
3515 includes conversions of fixed point to floating and vice versa, and
3516 conversions changing the width or signedness of a fixed point argument
3517 except when the same as the default promotion.
3519 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3520 @opindex Wdeclaration-after-statement
3521 @opindex Wno-declaration-after-statement
3522 Warn when a declaration is found after a statement in a block.  This
3523 construct, known from C++, was introduced with ISO C99 and is by default
3524 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3525 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3527 @item -Wundef
3528 @opindex Wundef
3529 @opindex Wno-undef
3530 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3532 @item -Wno-endif-labels
3533 @opindex Wno-endif-labels
3534 @opindex Wendif-labels
3535 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3537 @item -Wshadow
3538 @opindex Wshadow
3539 @opindex Wno-shadow
3540 Warn whenever a local variable shadows another local variable, parameter or
3541 global variable or whenever a built-in function is shadowed.
3543 @item -Wlarger-than=@var{len}
3544 @opindex Wlarger-than=@var{len}
3545 @opindex Wlarger-than-@var{len}
3546 Warn whenever an object of larger than @var{len} bytes is defined.
3548 @item -Wframe-larger-than=@var{len}
3549 @opindex Wframe-larger-than
3550 Warn if the size of a function frame is larger than @var{len} bytes.
3551 The computation done to determine the stack frame size is approximate
3552 and not conservative.
3553 The actual requirements may be somewhat greater than @var{len}
3554 even if you do not get a warning.  In addition, any space allocated
3555 via @code{alloca}, variable-length arrays, or related constructs
3556 is not included by the compiler when determining
3557 whether or not to issue a warning.
3559 @item -Wunsafe-loop-optimizations
3560 @opindex Wunsafe-loop-optimizations
3561 @opindex Wno-unsafe-loop-optimizations
3562 Warn if the loop cannot be optimized because the compiler could not
3563 assume anything on the bounds of the loop indices.  With
3564 @option{-funsafe-loop-optimizations} warn if the compiler made
3565 such assumptions.
3567 @item -Wpointer-arith
3568 @opindex Wpointer-arith
3569 @opindex Wno-pointer-arith
3570 Warn about anything that depends on the ``size of'' a function type or
3571 of @code{void}.  GNU C assigns these types a size of 1, for
3572 convenience in calculations with @code{void *} pointers and pointers
3573 to functions.  In C++, warn also when an arithmetic operation involves
3574 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3576 @item -Wtype-limits
3577 @opindex Wtype-limits
3578 @opindex Wno-type-limits
3579 Warn if a comparison is always true or always false due to the limited
3580 range of the data type, but do not warn for constant expressions.  For
3581 example, warn if an unsigned variable is compared against zero with
3582 @samp{<} or @samp{>=}.  This warning is also enabled by
3583 @option{-Wextra}.
3585 @item -Wbad-function-cast @r{(C and Objective-C only)}
3586 @opindex Wbad-function-cast
3587 @opindex Wno-bad-function-cast
3588 Warn whenever a function call is cast to a non-matching type.
3589 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3591 @item -Wc++-compat @r{(C and Objective-C only)}
3592 Warn about ISO C constructs that are outside of the common subset of
3593 ISO C and ISO C++, e.g.@: request for implicit conversion from
3594 @code{void *} to a pointer to non-@code{void} type.
3596 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3597 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3598 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3599 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3601 @item -Wcast-qual
3602 @opindex Wcast-qual
3603 @opindex Wno-cast-qual
3604 Warn whenever a pointer is cast so as to remove a type qualifier from
3605 the target type.  For example, warn if a @code{const char *} is cast
3606 to an ordinary @code{char *}.
3608 @item -Wcast-align
3609 @opindex Wcast-align
3610 @opindex Wno-cast-align
3611 Warn whenever a pointer is cast such that the required alignment of the
3612 target is increased.  For example, warn if a @code{char *} is cast to
3613 an @code{int *} on machines where integers can only be accessed at
3614 two- or four-byte boundaries.
3616 @item -Wwrite-strings
3617 @opindex Wwrite-strings
3618 @opindex Wno-write-strings
3619 When compiling C, give string constants the type @code{const
3620 char[@var{length}]} so that
3621 copying the address of one into a non-@code{const} @code{char *}
3622 pointer will get a warning; when compiling C++, warn about the
3623 deprecated conversion from string literals to @code{char *}.  This
3624 warning, by default, is enabled for C++ programs.
3625 These warnings will help you find at
3626 compile time code that can try to write into a string constant, but
3627 only if you have been very careful about using @code{const} in
3628 declarations and prototypes.  Otherwise, it will just be a nuisance;
3629 this is why we did not make @option{-Wall} request these warnings.
3631 @item -Wclobbered
3632 @opindex Wclobbered
3633 @opindex Wno-clobbered
3634 Warn for variables that might be changed by @samp{longjmp} or
3635 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3637 @item -Wconversion
3638 @opindex Wconversion
3639 @opindex Wno-conversion
3640 Warn for implicit conversions that may alter a value. This includes
3641 conversions between real and integer, like @code{abs (x)} when
3642 @code{x} is @code{double}; conversions between signed and unsigned,
3643 like @code{unsigned ui = -1}; and conversions to smaller types, like
3644 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3645 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3646 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3647 conversions between signed and unsigned integers can be disabled by
3648 using @option{-Wno-sign-conversion}.
3650 For C++, also warn for conversions between @code{NULL} and non-pointer
3651 types; confusing overload resolution for user-defined conversions; and
3652 conversions that will never use a type conversion operator:
3653 conversions to @code{void}, the same type, a base class or a reference
3654 to them. Warnings about conversions between signed and unsigned
3655 integers are disabled by default in C++ unless
3656 @option{-Wsign-conversion} is explicitly enabled.
3658 @item -Wempty-body
3659 @opindex Wempty-body
3660 @opindex Wno-empty-body
3661 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3662 while} statement.  Additionally, in C++, warn when an empty body occurs
3663 in a @samp{while} or @samp{for} statement with no whitespacing before
3664 the semicolon.  This warning is also enabled by @option{-Wextra}.
3666 @item -Wenum-compare @r{(C++ and Objective-C++ only)}
3667 @opindex Wenum-compare
3668 @opindex Wno-enum-compare
3669 Warn about a comparison between values of different enum types.
3671 @item -Wsign-compare
3672 @opindex Wsign-compare
3673 @opindex Wno-sign-compare
3674 @cindex warning for comparison of signed and unsigned values
3675 @cindex comparison of signed and unsigned values, warning
3676 @cindex signed and unsigned values, comparison warning
3677 Warn when a comparison between signed and unsigned values could produce
3678 an incorrect result when the signed value is converted to unsigned.
3679 This warning is also enabled by @option{-Wextra}; to get the other warnings
3680 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3682 @item -Wsign-conversion
3683 @opindex Wsign-conversion
3684 @opindex Wno-sign-conversion
3685 Warn for implicit conversions that may change the sign of an integer
3686 value, like assigning a signed integer expression to an unsigned
3687 integer variable. An explicit cast silences the warning. In C, this
3688 option is enabled also by @option{-Wconversion}.
3690 @item -Waddress
3691 @opindex Waddress
3692 @opindex Wno-address
3693 Warn about suspicious uses of memory addresses. These include using
3694 the address of a function in a conditional expression, such as
3695 @code{void func(void); if (func)}, and comparisons against the memory
3696 address of a string literal, such as @code{if (x == "abc")}.  Such
3697 uses typically indicate a programmer error: the address of a function
3698 always evaluates to true, so their use in a conditional usually
3699 indicate that the programmer forgot the parentheses in a function
3700 call; and comparisons against string literals result in unspecified
3701 behavior and are not portable in C, so they usually indicate that the
3702 programmer intended to use @code{strcmp}.  This warning is enabled by
3703 @option{-Wall}.
3705 @item -Wlogical-op
3706 @opindex Wlogical-op
3707 @opindex Wno-logical-op
3708 Warn about suspicious uses of logical operators in expressions.
3709 This includes using logical operators in contexts where a
3710 bit-wise operator is likely to be expected.
3712 @item -Waggregate-return
3713 @opindex Waggregate-return
3714 @opindex Wno-aggregate-return
3715 Warn if any functions that return structures or unions are defined or
3716 called.  (In languages where you can return an array, this also elicits
3717 a warning.)
3719 @item -Wno-attributes
3720 @opindex Wno-attributes
3721 @opindex Wattributes
3722 Do not warn if an unexpected @code{__attribute__} is used, such as
3723 unrecognized attributes, function attributes applied to variables,
3724 etc.  This will not stop errors for incorrect use of supported
3725 attributes.
3727 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3728 @opindex Wstrict-prototypes
3729 @opindex Wno-strict-prototypes
3730 Warn if a function is declared or defined without specifying the
3731 argument types.  (An old-style function definition is permitted without
3732 a warning if preceded by a declaration which specifies the argument
3733 types.)
3735 @item -Wold-style-declaration @r{(C and Objective-C only)}
3736 @opindex Wold-style-declaration
3737 @opindex Wno-old-style-declaration
3738 Warn for obsolescent usages, according to the C Standard, in a
3739 declaration. For example, warn if storage-class specifiers like
3740 @code{static} are not the first things in a declaration.  This warning
3741 is also enabled by @option{-Wextra}.
3743 @item -Wold-style-definition @r{(C and Objective-C only)}
3744 @opindex Wold-style-definition
3745 @opindex Wno-old-style-definition
3746 Warn if an old-style function definition is used.  A warning is given
3747 even if there is a previous prototype.
3749 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3750 @opindex Wmissing-parameter-type
3751 @opindex Wno-missing-parameter-type
3752 A function parameter is declared without a type specifier in K&R-style
3753 functions:
3755 @smallexample
3756 void foo(bar) @{ @}
3757 @end smallexample
3759 This warning is also enabled by @option{-Wextra}.
3761 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3762 @opindex Wmissing-prototypes
3763 @opindex Wno-missing-prototypes
3764 Warn if a global function is defined without a previous prototype
3765 declaration.  This warning is issued even if the definition itself
3766 provides a prototype.  The aim is to detect global functions that fail
3767 to be declared in header files.
3769 @item -Wmissing-declarations
3770 @opindex Wmissing-declarations
3771 @opindex Wno-missing-declarations
3772 Warn if a global function is defined without a previous declaration.
3773 Do so even if the definition itself provides a prototype.
3774 Use this option to detect global functions that are not declared in
3775 header files.  In C++, no warnings are issued for function templates,
3776 or for inline functions, or for functions in anonymous namespaces.
3778 @item -Wmissing-field-initializers
3779 @opindex Wmissing-field-initializers
3780 @opindex Wno-missing-field-initializers
3781 @opindex W
3782 @opindex Wextra
3783 @opindex Wno-extra
3784 Warn if a structure's initializer has some fields missing.  For
3785 example, the following code would cause such a warning, because
3786 @code{x.h} is implicitly zero:
3788 @smallexample
3789 struct s @{ int f, g, h; @};
3790 struct s x = @{ 3, 4 @};
3791 @end smallexample
3793 This option does not warn about designated initializers, so the following
3794 modification would not trigger a warning:
3796 @smallexample
3797 struct s @{ int f, g, h; @};
3798 struct s x = @{ .f = 3, .g = 4 @};
3799 @end smallexample
3801 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3802 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3804 @item -Wmissing-noreturn
3805 @opindex Wmissing-noreturn
3806 @opindex Wno-missing-noreturn
3807 Warn about functions which might be candidates for attribute @code{noreturn}.
3808 Note these are only possible candidates, not absolute ones.  Care should
3809 be taken to manually verify functions actually do not ever return before
3810 adding the @code{noreturn} attribute, otherwise subtle code generation
3811 bugs could be introduced.  You will not get a warning for @code{main} in
3812 hosted C environments.
3814 @item -Wmissing-format-attribute
3815 @opindex Wmissing-format-attribute
3816 @opindex Wno-missing-format-attribute
3817 @opindex Wformat
3818 @opindex Wno-format
3819 Warn about function pointers which might be candidates for @code{format}
3820 attributes.  Note these are only possible candidates, not absolute ones.
3821 GCC will guess that function pointers with @code{format} attributes that
3822 are used in assignment, initialization, parameter passing or return
3823 statements should have a corresponding @code{format} attribute in the
3824 resulting type.  I.e.@: the left-hand side of the assignment or
3825 initialization, the type of the parameter variable, or the return type
3826 of the containing function respectively should also have a @code{format}
3827 attribute to avoid the warning.
3829 GCC will also warn about function definitions which might be
3830 candidates for @code{format} attributes.  Again, these are only
3831 possible candidates.  GCC will guess that @code{format} attributes
3832 might be appropriate for any function that calls a function like
3833 @code{vprintf} or @code{vscanf}, but this might not always be the
3834 case, and some functions for which @code{format} attributes are
3835 appropriate may not be detected.
3837 @item -Wno-multichar
3838 @opindex Wno-multichar
3839 @opindex Wmultichar
3840 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3841 Usually they indicate a typo in the user's code, as they have
3842 implementation-defined values, and should not be used in portable code.
3844 @item -Wnormalized=<none|id|nfc|nfkc>
3845 @opindex Wnormalized=
3846 @cindex NFC
3847 @cindex NFKC
3848 @cindex character set, input normalization
3849 In ISO C and ISO C++, two identifiers are different if they are
3850 different sequences of characters.  However, sometimes when characters
3851 outside the basic ASCII character set are used, you can have two
3852 different character sequences that look the same.  To avoid confusion,
3853 the ISO 10646 standard sets out some @dfn{normalization rules} which
3854 when applied ensure that two sequences that look the same are turned into
3855 the same sequence.  GCC can warn you if you are using identifiers which
3856 have not been normalized; this option controls that warning.
3858 There are four levels of warning that GCC supports.  The default is
3859 @option{-Wnormalized=nfc}, which warns about any identifier which is
3860 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3861 recommended form for most uses.
3863 Unfortunately, there are some characters which ISO C and ISO C++ allow
3864 in identifiers that when turned into NFC aren't allowable as
3865 identifiers.  That is, there's no way to use these symbols in portable
3866 ISO C or C++ and have all your identifiers in NFC@.
3867 @option{-Wnormalized=id} suppresses the warning for these characters.
3868 It is hoped that future versions of the standards involved will correct
3869 this, which is why this option is not the default.
3871 You can switch the warning off for all characters by writing
3872 @option{-Wnormalized=none}.  You would only want to do this if you
3873 were using some other normalization scheme (like ``D''), because
3874 otherwise you can easily create bugs that are literally impossible to see.
3876 Some characters in ISO 10646 have distinct meanings but look identical
3877 in some fonts or display methodologies, especially once formatting has
3878 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3879 LETTER N'', will display just like a regular @code{n} which has been
3880 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3881 normalization scheme to convert all these into a standard form as
3882 well, and GCC will warn if your code is not in NFKC if you use
3883 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3884 about every identifier that contains the letter O because it might be
3885 confused with the digit 0, and so is not the default, but may be
3886 useful as a local coding convention if the programming environment is
3887 unable to be fixed to display these characters distinctly.
3889 @item -Wno-deprecated
3890 @opindex Wno-deprecated
3891 @opindex Wdeprecated
3892 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3894 @item -Wno-deprecated-declarations
3895 @opindex Wno-deprecated-declarations
3896 @opindex Wdeprecated-declarations
3897 Do not warn about uses of functions (@pxref{Function Attributes}),
3898 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3899 Attributes}) marked as deprecated by using the @code{deprecated}
3900 attribute.
3902 @item -Wno-overflow
3903 @opindex Wno-overflow
3904 @opindex Woverflow
3905 Do not warn about compile-time overflow in constant expressions.
3907 @item -Woverride-init @r{(C and Objective-C only)}
3908 @opindex Woverride-init
3909 @opindex Wno-override-init
3910 @opindex W
3911 @opindex Wextra
3912 @opindex Wno-extra
3913 Warn if an initialized field without side effects is overridden when
3914 using designated initializers (@pxref{Designated Inits, , Designated
3915 Initializers}).
3917 This warning is included in @option{-Wextra}.  To get other
3918 @option{-Wextra} warnings without this one, use @samp{-Wextra
3919 -Wno-override-init}.
3921 @item -Wpacked
3922 @opindex Wpacked
3923 @opindex Wno-packed
3924 Warn if a structure is given the packed attribute, but the packed
3925 attribute has no effect on the layout or size of the structure.
3926 Such structures may be mis-aligned for little benefit.  For
3927 instance, in this code, the variable @code{f.x} in @code{struct bar}
3928 will be misaligned even though @code{struct bar} does not itself
3929 have the packed attribute:
3931 @smallexample
3932 @group
3933 struct foo @{
3934   int x;
3935   char a, b, c, d;
3936 @} __attribute__((packed));
3937 struct bar @{
3938   char z;
3939   struct foo f;
3941 @end group
3942 @end smallexample
3944 @item -Wpadded
3945 @opindex Wpadded
3946 @opindex Wno-padded
3947 Warn if padding is included in a structure, either to align an element
3948 of the structure or to align the whole structure.  Sometimes when this
3949 happens it is possible to rearrange the fields of the structure to
3950 reduce the padding and so make the structure smaller.
3952 @item -Wredundant-decls
3953 @opindex Wredundant-decls
3954 @opindex Wno-redundant-decls
3955 Warn if anything is declared more than once in the same scope, even in
3956 cases where multiple declaration is valid and changes nothing.
3958 @item -Wnested-externs @r{(C and Objective-C only)}
3959 @opindex Wnested-externs
3960 @opindex Wno-nested-externs
3961 Warn if an @code{extern} declaration is encountered within a function.
3963 @item -Wunreachable-code
3964 @opindex Wunreachable-code
3965 @opindex Wno-unreachable-code
3966 Warn if the compiler detects that code will never be executed.
3968 This option is intended to warn when the compiler detects that at
3969 least a whole line of source code will never be executed, because
3970 some condition is never satisfied or because it is after a
3971 procedure that never returns.
3973 It is possible for this option to produce a warning even though there
3974 are circumstances under which part of the affected line can be executed,
3975 so care should be taken when removing apparently-unreachable code.
3977 For instance, when a function is inlined, a warning may mean that the
3978 line is unreachable in only one inlined copy of the function.
3980 This option is not made part of @option{-Wall} because in a debugging
3981 version of a program there is often substantial code which checks
3982 correct functioning of the program and is, hopefully, unreachable
3983 because the program does work.  Another common use of unreachable
3984 code is to provide behavior which is selectable at compile-time.
3986 @item -Winline
3987 @opindex Winline
3988 @opindex Wno-inline
3989 Warn if a function can not be inlined and it was declared as inline.
3990 Even with this option, the compiler will not warn about failures to
3991 inline functions declared in system headers.
3993 The compiler uses a variety of heuristics to determine whether or not
3994 to inline a function.  For example, the compiler takes into account
3995 the size of the function being inlined and the amount of inlining
3996 that has already been done in the current function.  Therefore,
3997 seemingly insignificant changes in the source program can cause the
3998 warnings produced by @option{-Winline} to appear or disappear.
4000 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4001 @opindex Wno-invalid-offsetof
4002 @opindex Winvalid-offsetof
4003 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4004 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4005 to a non-POD type is undefined.  In existing C++ implementations,
4006 however, @samp{offsetof} typically gives meaningful results even when
4007 applied to certain kinds of non-POD types. (Such as a simple
4008 @samp{struct} that fails to be a POD type only by virtue of having a
4009 constructor.)  This flag is for users who are aware that they are
4010 writing nonportable code and who have deliberately chosen to ignore the
4011 warning about it.
4013 The restrictions on @samp{offsetof} may be relaxed in a future version
4014 of the C++ standard.
4016 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4017 @opindex Wno-int-to-pointer-cast
4018 @opindex Wint-to-pointer-cast
4019 Suppress warnings from casts to pointer type of an integer of a
4020 different size.
4022 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4023 @opindex Wno-pointer-to-int-cast
4024 @opindex Wpointer-to-int-cast
4025 Suppress warnings from casts from a pointer to an integer type of a
4026 different size.
4028 @item -Winvalid-pch
4029 @opindex Winvalid-pch
4030 @opindex Wno-invalid-pch
4031 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4032 the search path but can't be used.
4034 @item -Wlong-long
4035 @opindex Wlong-long
4036 @opindex Wno-long-long
4037 Warn if @samp{long long} type is used.  This is default.  To inhibit
4038 the warning messages, use @option{-Wno-long-long}.  Flags
4039 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4040 only when @option{-pedantic} flag is used.
4042 @item -Wvariadic-macros
4043 @opindex Wvariadic-macros
4044 @opindex Wno-variadic-macros
4045 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4046 alternate syntax when in pedantic ISO C99 mode.  This is default.
4047 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4049 @item -Wvla
4050 @opindex Wvla
4051 @opindex Wno-vla
4052 Warn if variable length array is used in the code.
4053 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4054 the variable length array.
4056 @item -Wvolatile-register-var
4057 @opindex Wvolatile-register-var
4058 @opindex Wno-volatile-register-var
4059 Warn if a register variable is declared volatile.  The volatile
4060 modifier does not inhibit all optimizations that may eliminate reads
4061 and/or writes to register variables.  This warning is enabled by
4062 @option{-Wall}.
4064 @item -Wdisabled-optimization
4065 @opindex Wdisabled-optimization
4066 @opindex Wno-disabled-optimization
4067 Warn if a requested optimization pass is disabled.  This warning does
4068 not generally indicate that there is anything wrong with your code; it
4069 merely indicates that GCC's optimizers were unable to handle the code
4070 effectively.  Often, the problem is that your code is too big or too
4071 complex; GCC will refuse to optimize programs when the optimization
4072 itself is likely to take inordinate amounts of time.
4074 @item -Wpointer-sign @r{(C and Objective-C only)}
4075 @opindex Wpointer-sign
4076 @opindex Wno-pointer-sign
4077 Warn for pointer argument passing or assignment with different signedness.
4078 This option is only supported for C and Objective-C@.  It is implied by
4079 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4080 @option{-Wno-pointer-sign}.
4082 @item -Wstack-protector
4083 @opindex Wstack-protector
4084 @opindex Wno-stack-protector
4085 This option is only active when @option{-fstack-protector} is active.  It
4086 warns about functions that will not be protected against stack smashing.
4088 @item -Wno-mudflap
4089 @opindex Wno-mudflap
4090 Suppress warnings about constructs that cannot be instrumented by
4091 @option{-fmudflap}.
4093 @item -Woverlength-strings
4094 @opindex Woverlength-strings
4095 @opindex Wno-overlength-strings
4096 Warn about string constants which are longer than the ``minimum
4097 maximum'' length specified in the C standard.  Modern compilers
4098 generally allow string constants which are much longer than the
4099 standard's minimum limit, but very portable programs should avoid
4100 using longer strings.
4102 The limit applies @emph{after} string constant concatenation, and does
4103 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4104 C99, it was raised to 4095.  C++98 does not specify a normative
4105 minimum maximum, so we do not diagnose overlength strings in C++@.
4107 This option is implied by @option{-pedantic}, and can be disabled with
4108 @option{-Wno-overlength-strings}.
4109 @end table
4111 @node Debugging Options
4112 @section Options for Debugging Your Program or GCC
4113 @cindex options, debugging
4114 @cindex debugging information options
4116 GCC has various special options that are used for debugging
4117 either your program or GCC:
4119 @table @gcctabopt
4120 @item -g
4121 @opindex g
4122 Produce debugging information in the operating system's native format
4123 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4124 information.
4126 On most systems that use stabs format, @option{-g} enables use of extra
4127 debugging information that only GDB can use; this extra information
4128 makes debugging work better in GDB but will probably make other debuggers
4129 crash or
4130 refuse to read the program.  If you want to control for certain whether
4131 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4132 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4134 GCC allows you to use @option{-g} with
4135 @option{-O}.  The shortcuts taken by optimized code may occasionally
4136 produce surprising results: some variables you declared may not exist
4137 at all; flow of control may briefly move where you did not expect it;
4138 some statements may not be executed because they compute constant
4139 results or their values were already at hand; some statements may
4140 execute in different places because they were moved out of loops.
4142 Nevertheless it proves possible to debug optimized output.  This makes
4143 it reasonable to use the optimizer for programs that might have bugs.
4145 The following options are useful when GCC is generated with the
4146 capability for more than one debugging format.
4148 @item -ggdb
4149 @opindex ggdb
4150 Produce debugging information for use by GDB@.  This means to use the
4151 most expressive format available (DWARF 2, stabs, or the native format
4152 if neither of those are supported), including GDB extensions if at all
4153 possible.
4155 @item -gstabs
4156 @opindex gstabs
4157 Produce debugging information in stabs format (if that is supported),
4158 without GDB extensions.  This is the format used by DBX on most BSD
4159 systems.  On MIPS, Alpha and System V Release 4 systems this option
4160 produces stabs debugging output which is not understood by DBX or SDB@.
4161 On System V Release 4 systems this option requires the GNU assembler.
4163 @item -feliminate-unused-debug-symbols
4164 @opindex feliminate-unused-debug-symbols
4165 Produce debugging information in stabs format (if that is supported),
4166 for only symbols that are actually used.
4168 @item -femit-class-debug-always
4169 Instead of emitting debugging information for a C++ class in only one
4170 object file, emit it in all object files using the class.  This option
4171 should be used only with debuggers that are unable to handle the way GCC
4172 normally emits debugging information for classes because using this
4173 option will increase the size of debugging information by as much as a
4174 factor of two.
4176 @item -gstabs+
4177 @opindex gstabs+
4178 Produce debugging information in stabs format (if that is supported),
4179 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4180 use of these extensions is likely to make other debuggers crash or
4181 refuse to read the program.
4183 @item -gcoff
4184 @opindex gcoff
4185 Produce debugging information in COFF format (if that is supported).
4186 This is the format used by SDB on most System V systems prior to
4187 System V Release 4.
4189 @item -gxcoff
4190 @opindex gxcoff
4191 Produce debugging information in XCOFF format (if that is supported).
4192 This is the format used by the DBX debugger on IBM RS/6000 systems.
4194 @item -gxcoff+
4195 @opindex gxcoff+
4196 Produce debugging information in XCOFF format (if that is supported),
4197 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4198 use of these extensions is likely to make other debuggers crash or
4199 refuse to read the program, and may cause assemblers other than the GNU
4200 assembler (GAS) to fail with an error.
4202 @item -gdwarf-2
4203 @opindex gdwarf-2
4204 Produce debugging information in DWARF version 2 format (if that is
4205 supported).  This is the format used by DBX on IRIX 6.  With this
4206 option, GCC uses features of DWARF version 3 when they are useful;
4207 version 3 is upward compatible with version 2, but may still cause
4208 problems for older debuggers.
4210 @item -gvms
4211 @opindex gvms
4212 Produce debugging information in VMS debug format (if that is
4213 supported).  This is the format used by DEBUG on VMS systems.
4215 @item -g@var{level}
4216 @itemx -ggdb@var{level}
4217 @itemx -gstabs@var{level}
4218 @itemx -gcoff@var{level}
4219 @itemx -gxcoff@var{level}
4220 @itemx -gvms@var{level}
4221 Request debugging information and also use @var{level} to specify how
4222 much information.  The default level is 2.
4224 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4225 @option{-g}.
4227 Level 1 produces minimal information, enough for making backtraces in
4228 parts of the program that you don't plan to debug.  This includes
4229 descriptions of functions and external variables, but no information
4230 about local variables and no line numbers.
4232 Level 3 includes extra information, such as all the macro definitions
4233 present in the program.  Some debuggers support macro expansion when
4234 you use @option{-g3}.
4236 @option{-gdwarf-2} does not accept a concatenated debug level, because
4237 GCC used to support an option @option{-gdwarf} that meant to generate
4238 debug information in version 1 of the DWARF format (which is very
4239 different from version 2), and it would have been too confusing.  That
4240 debug format is long obsolete, but the option cannot be changed now.
4241 Instead use an additional @option{-g@var{level}} option to change the
4242 debug level for DWARF2.
4244 @item -feliminate-dwarf2-dups
4245 @opindex feliminate-dwarf2-dups
4246 Compress DWARF2 debugging information by eliminating duplicated
4247 information about each symbol.  This option only makes sense when
4248 generating DWARF2 debugging information with @option{-gdwarf-2}.
4250 @item -femit-struct-debug-baseonly
4251 Emit debug information for struct-like types
4252 only when the base name of the compilation source file
4253 matches the base name of file in which the struct was defined.
4255 This option substantially reduces the size of debugging information,
4256 but at significant potential loss in type information to the debugger.
4257 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4258 See @option{-femit-struct-debug-detailed} for more detailed control.
4260 This option works only with DWARF 2.
4262 @item -femit-struct-debug-reduced
4263 Emit debug information for struct-like types
4264 only when the base name of the compilation source file
4265 matches the base name of file in which the type was defined,
4266 unless the struct is a template or defined in a system header.
4268 This option significantly reduces the size of debugging information,
4269 with some potential loss in type information to the debugger.
4270 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4271 See @option{-femit-struct-debug-detailed} for more detailed control.
4273 This option works only with DWARF 2.
4275 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4276 Specify the struct-like types
4277 for which the compiler will generate debug information.
4278 The intent is to reduce duplicate struct debug information
4279 between different object files within the same program.
4281 This option is a detailed version of
4282 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4283 which will serve for most needs.
4285 A specification has the syntax
4286 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4288 The optional first word limits the specification to
4289 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4290 A struct type is used directly when it is the type of a variable, member.
4291 Indirect uses arise through pointers to structs.
4292 That is, when use of an incomplete struct would be legal, the use is indirect.
4293 An example is
4294 @samp{struct one direct; struct two * indirect;}.
4296 The optional second word limits the specification to
4297 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4298 Generic structs are a bit complicated to explain.
4299 For C++, these are non-explicit specializations of template classes,
4300 or non-template classes within the above.
4301 Other programming languages have generics,
4302 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4304 The third word specifies the source files for those
4305 structs for which the compiler will emit debug information.
4306 The values @samp{none} and @samp{any} have the normal meaning.
4307 The value @samp{base} means that
4308 the base of name of the file in which the type declaration appears
4309 must match the base of the name of the main compilation file.
4310 In practice, this means that
4311 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4312 but types declared in other header will not.
4313 The value @samp{sys} means those types satisfying @samp{base}
4314 or declared in system or compiler headers.
4316 You may need to experiment to determine the best settings for your application.
4318 The default is @samp{-femit-struct-debug-detailed=all}.
4320 This option works only with DWARF 2.
4322 @item -fno-merge-debug-strings
4323 @opindex fmerge-debug-strings
4324 @opindex fno-merge-debug-strings
4325 Direct the linker to merge together strings which are identical in
4326 different object files.  This is not supported by all assemblers or
4327 linker.  This decreases the size of the debug information in the
4328 output file at the cost of increasing link processing time.  This is
4329 on by default.
4331 @item -fdebug-prefix-map=@var{old}=@var{new}
4332 @opindex fdebug-prefix-map
4333 When compiling files in directory @file{@var{old}}, record debugging
4334 information describing them as in @file{@var{new}} instead.
4336 @cindex @command{prof}
4337 @item -p
4338 @opindex p
4339 Generate extra code to write profile information suitable for the
4340 analysis program @command{prof}.  You must use this option when compiling
4341 the source files you want data about, and you must also use it when
4342 linking.
4344 @cindex @command{gprof}
4345 @item -pg
4346 @opindex pg
4347 Generate extra code to write profile information suitable for the
4348 analysis program @command{gprof}.  You must use this option when compiling
4349 the source files you want data about, and you must also use it when
4350 linking.
4352 @item -Q
4353 @opindex Q
4354 Makes the compiler print out each function name as it is compiled, and
4355 print some statistics about each pass when it finishes.
4357 @item -ftime-report
4358 @opindex ftime-report
4359 Makes the compiler print some statistics about the time consumed by each
4360 pass when it finishes.
4362 @item -fmem-report
4363 @opindex fmem-report
4364 Makes the compiler print some statistics about permanent memory
4365 allocation when it finishes.
4367 @item -fpre-ipa-mem-report
4368 @opindex fpre-ipa-mem-report
4369 @item -fpost-ipa-mem-report
4370 @opindex fpost-ipa-mem-report
4371 Makes the compiler print some statistics about permanent memory
4372 allocation before or after interprocedural optimization.
4374 @item -fprofile-arcs
4375 @opindex fprofile-arcs
4376 Add code so that program flow @dfn{arcs} are instrumented.  During
4377 execution the program records how many times each branch and call is
4378 executed and how many times it is taken or returns.  When the compiled
4379 program exits it saves this data to a file called
4380 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4381 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4382 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4383 @var{auxname} is generated from the name of the output file, if
4384 explicitly specified and it is not the final executable, otherwise it is
4385 the basename of the source file.  In both cases any suffix is removed
4386 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4387 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4388 @xref{Cross-profiling}.
4390 @cindex @command{gcov}
4391 @item --coverage
4392 @opindex coverage
4394 This option is used to compile and link code instrumented for coverage
4395 analysis.  The option is a synonym for @option{-fprofile-arcs}
4396 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4397 linking).  See the documentation for those options for more details.
4399 @itemize
4401 @item
4402 Compile the source files with @option{-fprofile-arcs} plus optimization
4403 and code generation options.  For test coverage analysis, use the
4404 additional @option{-ftest-coverage} option.  You do not need to profile
4405 every source file in a program.
4407 @item
4408 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4409 (the latter implies the former).
4411 @item
4412 Run the program on a representative workload to generate the arc profile
4413 information.  This may be repeated any number of times.  You can run
4414 concurrent instances of your program, and provided that the file system
4415 supports locking, the data files will be correctly updated.  Also
4416 @code{fork} calls are detected and correctly handled (double counting
4417 will not happen).
4419 @item
4420 For profile-directed optimizations, compile the source files again with
4421 the same optimization and code generation options plus
4422 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4423 Control Optimization}).
4425 @item
4426 For test coverage analysis, use @command{gcov} to produce human readable
4427 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4428 @command{gcov} documentation for further information.
4430 @end itemize
4432 With @option{-fprofile-arcs}, for each function of your program GCC
4433 creates a program flow graph, then finds a spanning tree for the graph.
4434 Only arcs that are not on the spanning tree have to be instrumented: the
4435 compiler adds code to count the number of times that these arcs are
4436 executed.  When an arc is the only exit or only entrance to a block, the
4437 instrumentation code can be added to the block; otherwise, a new basic
4438 block must be created to hold the instrumentation code.
4440 @need 2000
4441 @item -ftest-coverage
4442 @opindex ftest-coverage
4443 Produce a notes file that the @command{gcov} code-coverage utility
4444 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4445 show program coverage.  Each source file's note file is called
4446 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4447 above for a description of @var{auxname} and instructions on how to
4448 generate test coverage data.  Coverage data will match the source files
4449 more closely, if you do not optimize.
4451 @item -fdbg-cnt-list
4452 @opindex fdbg-cnt-list
4453 Print the name and the counter upperbound for all debug counters.
4455 @item -fdbg-cnt=@var{counter-value-list}
4456 @opindex fdbg-cnt
4457 Set the internal debug counter upperbound. @var{counter-value-list} 
4458 is a comma-separated list of @var{name}:@var{value} pairs
4459 which sets the upperbound of each debug counter @var{name} to @var{value}.
4460 All debug counters have the initial upperbound of @var{UINT_MAX},
4461 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4462 e.g. With -fdbg-cnt=dce:10,tail_call:0
4463 dbg_cnt(dce) will return true only for first 10 invocations
4464 and dbg_cnt(tail_call) will return false always.
4466 @item -d@var{letters}
4467 @itemx -fdump-rtl-@var{pass}
4468 @opindex d
4469 Says to make debugging dumps during compilation at times specified by
4470 @var{letters}.    This is used for debugging the RTL-based passes of the
4471 compiler.  The file names for most of the dumps are made by appending a
4472 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4473 from the name of the output file, if explicitly specified and it is not
4474 an executable, otherwise it is the basename of the source file. These
4475 switches may have different effects when @option{-E} is used for
4476 preprocessing.
4478 Most debug dumps can be enabled either passing a letter to the @option{-d}
4479 option, or with a long @option{-fdump-rtl} switch; here are the possible
4480 letters for use in @var{letters} and @var{pass}, and their meanings:
4482 @table @gcctabopt
4483 @item -dA
4484 @opindex dA
4485 Annotate the assembler output with miscellaneous debugging information.
4487 @item -fdump-rtl-bbro
4488 @opindex fdump-rtl-bbro
4489 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4491 @item -fdump-rtl-combine
4492 @opindex fdump-rtl-combine
4493 Dump after the RTL instruction combination pass, to the file
4494 @file{@var{file}.129r.combine}.
4496 @item -fdump-rtl-ce1
4497 @itemx -fdump-rtl-ce2
4498 @opindex fdump-rtl-ce1
4499 @opindex fdump-rtl-ce2
4500 @option{-fdump-rtl-ce1} enable dumping after the
4501 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4502 @option{-fdump-rtl-ce2} enable dumping after the second if
4503 conversion, to the file @file{@var{file}.130r.ce2}.
4505 @item -fdump-rtl-btl
4506 @itemx -fdump-rtl-dbr
4507 @opindex fdump-rtl-btl
4508 @opindex fdump-rtl-dbr
4509 @option{-fdump-rtl-btl} enable dumping after branch
4510 target load optimization, to @file{@var{file}.31.btl}.  
4511 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4512 scheduling, to @file{@var{file}.36.dbr}.
4514 @item -dD
4515 @opindex dD
4516 Dump all macro definitions, at the end of preprocessing, in addition to
4517 normal output.
4519 @item -fdump-rtl-ce3
4520 @opindex fdump-rtl-ce3
4521 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4523 @item -fdump-rtl-cfg
4524 @itemx -fdump-rtl-life
4525 @opindex fdump-rtl-cfg
4526 @opindex fdump-rtl-life
4527 @option{-fdump-rtl-cfg} enable dumping after control
4528 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4529 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4530 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4532 @item -fdump-rtl-greg
4533 @opindex fdump-rtl-greg
4534 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4536 @item -fdump-rtl-gcse
4537 @itemx -fdump-rtl-bypass
4538 @opindex fdump-rtl-gcse
4539 @opindex fdump-rtl-bypass
4540 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4541 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4542 enable dumping after jump bypassing and control flow optimizations, to
4543 @file{@var{file}.115r.bypass}.
4545 @item -fdump-rtl-eh
4546 @opindex fdump-rtl-eh
4547 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4549 @item -fdump-rtl-sibling
4550 @opindex fdump-rtl-sibling
4551 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4553 @item -fdump-rtl-jump
4554 @opindex fdump-rtl-jump
4555 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4557 @item -fdump-rtl-stack
4558 @opindex fdump-rtl-stack
4559 Dump after conversion from GCC's "flat register file" registers to the
4560 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4562 @item -fdump-rtl-lreg
4563 @opindex fdump-rtl-lreg
4564 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4566 @item -fdump-rtl-loop2
4567 @opindex fdump-rtl-loop2
4568 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4569 loop optimization pass, to @file{@var{file}.119r.loop2},
4570 @file{@var{file}.120r.loop2_init},
4571 @file{@var{file}.121r.loop2_invariant}, and
4572 @file{@var{file}.125r.loop2_done}.
4574 @item -fdump-rtl-sms
4575 @opindex fdump-rtl-sms
4576 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4578 @item -fdump-rtl-mach
4579 @opindex fdump-rtl-mach
4580 Dump after performing the machine dependent reorganization pass, to
4581 @file{@var{file}.155r.mach} if that pass exists.
4583 @item -fdump-rtl-rnreg
4584 @opindex fdump-rtl-rnreg
4585 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4587 @item -fdump-rtl-regmove
4588 @opindex fdump-rtl-regmove
4589 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4591 @item -fdump-rtl-postreload
4592 @opindex fdump-rtl-postreload
4593 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4595 @item -fdump-rtl-expand
4596 @opindex fdump-rtl-expand
4597 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4599 @item -fdump-rtl-sched2
4600 @opindex fdump-rtl-sched2
4601 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4603 @item -fdump-rtl-cse
4604 @opindex fdump-rtl-cse
4605 Dump after CSE (including the jump optimization that sometimes follows
4606 CSE), to @file{@var{file}.113r.cse}.
4608 @item -fdump-rtl-sched1
4609 @opindex fdump-rtl-sched1
4610 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4612 @item -fdump-rtl-cse2
4613 @opindex fdump-rtl-cse2
4614 Dump after the second CSE pass (including the jump optimization that
4615 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4617 @item -fdump-rtl-tracer
4618 @opindex fdump-rtl-tracer
4619 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4621 @item -fdump-rtl-vpt
4622 @itemx -fdump-rtl-vartrack
4623 @opindex fdump-rtl-vpt
4624 @opindex fdump-rtl-vartrack
4625 @option{-fdump-rtl-vpt} enable dumping after the value
4626 profile transformations, to @file{@var{file}.10.vpt}.
4627 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4628 to @file{@var{file}.154r.vartrack}.
4630 @item -fdump-rtl-flow2
4631 @opindex fdump-rtl-flow2
4632 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4634 @item -fdump-rtl-peephole2
4635 @opindex fdump-rtl-peephole2
4636 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4638 @item -fdump-rtl-web
4639 @opindex fdump-rtl-web
4640 Dump after live range splitting, to @file{@var{file}.126r.web}.
4642 @item -fdump-rtl-all
4643 @opindex fdump-rtl-all
4644 Produce all the dumps listed above.
4646 @item -dH
4647 @opindex dH
4648 Produce a core dump whenever an error occurs.
4650 @item -dm
4651 @opindex dm
4652 Print statistics on memory usage, at the end of the run, to
4653 standard error.
4655 @item -dp
4656 @opindex dp
4657 Annotate the assembler output with a comment indicating which
4658 pattern and alternative was used.  The length of each instruction is
4659 also printed.
4661 @item -dP
4662 @opindex dP
4663 Dump the RTL in the assembler output as a comment before each instruction.
4664 Also turns on @option{-dp} annotation.
4666 @item -dv
4667 @opindex dv
4668 For each of the other indicated dump files (either with @option{-d} or
4669 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4670 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4672 @item -dx
4673 @opindex dx
4674 Just generate RTL for a function instead of compiling it.  Usually used
4675 with @samp{r} (@option{-fdump-rtl-expand}).
4677 @item -dy
4678 @opindex dy
4679 Dump debugging information during parsing, to standard error.
4680 @end table
4682 @item -fdump-noaddr
4683 @opindex fdump-noaddr
4684 When doing debugging dumps (see @option{-d} option above), suppress
4685 address output.  This makes it more feasible to use diff on debugging
4686 dumps for compiler invocations with different compiler binaries and/or
4687 different text / bss / data / heap / stack / dso start locations.
4689 @item -fdump-unnumbered
4690 @opindex fdump-unnumbered
4691 When doing debugging dumps (see @option{-d} option above), suppress instruction
4692 numbers and address output.  This makes it more feasible to
4693 use diff on debugging dumps for compiler invocations with different
4694 options, in particular with and without @option{-g}.
4696 @item -fdump-simple-rtl
4697 @opindex fdump-simple-rtl
4698 When doing debugging dumps (see @option{-d} option above), suppress
4699 output of flags, modes, etc.  This makes rtl dumps more compact.
4701 @item -fdump-translation-unit @r{(C++ only)}
4702 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4703 @opindex fdump-translation-unit
4704 Dump a representation of the tree structure for the entire translation
4705 unit to a file.  The file name is made by appending @file{.tu} to the
4706 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4707 controls the details of the dump as described for the
4708 @option{-fdump-tree} options.
4710 @item -fdump-class-hierarchy @r{(C++ only)}
4711 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4712 @opindex fdump-class-hierarchy
4713 Dump a representation of each class's hierarchy and virtual function
4714 table layout to a file.  The file name is made by appending @file{.class}
4715 to the source file name.  If the @samp{-@var{options}} form is used,
4716 @var{options} controls the details of the dump as described for the
4717 @option{-fdump-tree} options.
4719 @item -fdump-ipa-@var{switch}
4720 @opindex fdump-ipa
4721 Control the dumping at various stages of inter-procedural analysis
4722 language tree to a file.  The file name is generated by appending a switch
4723 specific suffix to the source file name.  The following dumps are possible:
4725 @table @samp
4726 @item all
4727 Enables all inter-procedural analysis dumps.
4729 @item cgraph
4730 Dumps information about call-graph optimization, unused function removal,
4731 and inlining decisions.
4733 @item inline
4734 Dump after function inlining.
4736 @end table
4738 @item -fdump-statistics-@var{option}
4739 @opindex -fdump-statistics
4740 Enable and control dumping of pass statistics in a separate file.  The
4741 file name is generated by appending a suffix ending in @samp{.statistics}
4742 to the source file name.  If the @samp{-@var{option}} form is used,
4743 @samp{-stats} will cause counters to be summed over the whole compilation unit
4744 while @samp{-details} will dump every event as the passes generate them.
4745 The default with no option is to sum counters for each function compiled.
4747 @item -fdump-tree-@var{switch}
4748 @itemx -fdump-tree-@var{switch}-@var{options}
4749 @opindex fdump-tree
4750 Control the dumping at various stages of processing the intermediate
4751 language tree to a file.  The file name is generated by appending a switch
4752 specific suffix to the source file name.  If the @samp{-@var{options}}
4753 form is used, @var{options} is a list of @samp{-} separated options that
4754 control the details of the dump.  Not all options are applicable to all
4755 dumps, those which are not meaningful will be ignored.  The following
4756 options are available
4758 @table @samp
4759 @item address
4760 Print the address of each node.  Usually this is not meaningful as it
4761 changes according to the environment and source file.  Its primary use
4762 is for tying up a dump file with a debug environment.
4763 @item slim
4764 Inhibit dumping of members of a scope or body of a function merely
4765 because that scope has been reached.  Only dump such items when they
4766 are directly reachable by some other path.  When dumping pretty-printed
4767 trees, this option inhibits dumping the bodies of control structures.
4768 @item raw
4769 Print a raw representation of the tree.  By default, trees are
4770 pretty-printed into a C-like representation.
4771 @item details
4772 Enable more detailed dumps (not honored by every dump option).
4773 @item stats
4774 Enable dumping various statistics about the pass (not honored by every dump
4775 option).
4776 @item blocks
4777 Enable showing basic block boundaries (disabled in raw dumps).
4778 @item vops
4779 Enable showing virtual operands for every statement.
4780 @item lineno
4781 Enable showing line numbers for statements.
4782 @item uid
4783 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4784 @item verbose
4785 Enable showing the tree dump for each statement.
4786 @item all
4787 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4788 and @option{lineno}.
4789 @end table
4791 The following tree dumps are possible:
4792 @table @samp
4794 @item original
4795 Dump before any tree based optimization, to @file{@var{file}.original}.
4797 @item optimized
4798 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4800 @item gimple
4801 @opindex fdump-tree-gimple
4802 Dump each function before and after the gimplification pass to a file.  The
4803 file name is made by appending @file{.gimple} to the source file name.
4805 @item cfg
4806 @opindex fdump-tree-cfg
4807 Dump the control flow graph of each function to a file.  The file name is
4808 made by appending @file{.cfg} to the source file name.
4810 @item vcg
4811 @opindex fdump-tree-vcg
4812 Dump the control flow graph of each function to a file in VCG format.  The
4813 file name is made by appending @file{.vcg} to the source file name.  Note
4814 that if the file contains more than one function, the generated file cannot
4815 be used directly by VCG@.  You will need to cut and paste each function's
4816 graph into its own separate file first.
4818 @item ch
4819 @opindex fdump-tree-ch
4820 Dump each function after copying loop headers.  The file name is made by
4821 appending @file{.ch} to the source file name.
4823 @item ssa
4824 @opindex fdump-tree-ssa
4825 Dump SSA related information to a file.  The file name is made by appending
4826 @file{.ssa} to the source file name.
4828 @item alias
4829 @opindex fdump-tree-alias
4830 Dump aliasing information for each function.  The file name is made by
4831 appending @file{.alias} to the source file name.
4833 @item ccp
4834 @opindex fdump-tree-ccp
4835 Dump each function after CCP@.  The file name is made by appending
4836 @file{.ccp} to the source file name.
4838 @item storeccp
4839 @opindex fdump-tree-storeccp
4840 Dump each function after STORE-CCP@.  The file name is made by appending
4841 @file{.storeccp} to the source file name.
4843 @item pre
4844 @opindex fdump-tree-pre
4845 Dump trees after partial redundancy elimination.  The file name is made
4846 by appending @file{.pre} to the source file name.
4848 @item fre
4849 @opindex fdump-tree-fre
4850 Dump trees after full redundancy elimination.  The file name is made
4851 by appending @file{.fre} to the source file name.
4853 @item copyprop
4854 @opindex fdump-tree-copyprop
4855 Dump trees after copy propagation.  The file name is made
4856 by appending @file{.copyprop} to the source file name.
4858 @item store_copyprop
4859 @opindex fdump-tree-store_copyprop
4860 Dump trees after store copy-propagation.  The file name is made
4861 by appending @file{.store_copyprop} to the source file name.
4863 @item dce
4864 @opindex fdump-tree-dce
4865 Dump each function after dead code elimination.  The file name is made by
4866 appending @file{.dce} to the source file name.
4868 @item mudflap
4869 @opindex fdump-tree-mudflap
4870 Dump each function after adding mudflap instrumentation.  The file name is
4871 made by appending @file{.mudflap} to the source file name.
4873 @item sra
4874 @opindex fdump-tree-sra
4875 Dump each function after performing scalar replacement of aggregates.  The
4876 file name is made by appending @file{.sra} to the source file name.
4878 @item sink
4879 @opindex fdump-tree-sink
4880 Dump each function after performing code sinking.  The file name is made
4881 by appending @file{.sink} to the source file name.
4883 @item dom
4884 @opindex fdump-tree-dom
4885 Dump each function after applying dominator tree optimizations.  The file
4886 name is made by appending @file{.dom} to the source file name.
4888 @item dse
4889 @opindex fdump-tree-dse
4890 Dump each function after applying dead store elimination.  The file
4891 name is made by appending @file{.dse} to the source file name.
4893 @item phiopt
4894 @opindex fdump-tree-phiopt
4895 Dump each function after optimizing PHI nodes into straightline code.  The file
4896 name is made by appending @file{.phiopt} to the source file name.
4898 @item forwprop
4899 @opindex fdump-tree-forwprop
4900 Dump each function after forward propagating single use variables.  The file
4901 name is made by appending @file{.forwprop} to the source file name.
4903 @item copyrename
4904 @opindex fdump-tree-copyrename
4905 Dump each function after applying the copy rename optimization.  The file
4906 name is made by appending @file{.copyrename} to the source file name.
4908 @item nrv
4909 @opindex fdump-tree-nrv
4910 Dump each function after applying the named return value optimization on
4911 generic trees.  The file name is made by appending @file{.nrv} to the source
4912 file name.
4914 @item vect
4915 @opindex fdump-tree-vect
4916 Dump each function after applying vectorization of loops.  The file name is
4917 made by appending @file{.vect} to the source file name.
4919 @item vrp
4920 @opindex fdump-tree-vrp
4921 Dump each function after Value Range Propagation (VRP).  The file name
4922 is made by appending @file{.vrp} to the source file name.
4924 @item all
4925 @opindex fdump-tree-all
4926 Enable all the available tree dumps with the flags provided in this option.
4927 @end table
4929 @item -ftree-vectorizer-verbose=@var{n}
4930 @opindex ftree-vectorizer-verbose
4931 This option controls the amount of debugging output the vectorizer prints.
4932 This information is written to standard error, unless
4933 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4934 in which case it is output to the usual dump listing file, @file{.vect}.
4935 For @var{n}=0 no diagnostic information is reported.
4936 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4937 and the total number of loops that got vectorized.
4938 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4939 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4940 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4941 level that @option{-fdump-tree-vect-stats} uses.
4942 Higher verbosity levels mean either more information dumped for each
4943 reported loop, or same amount of information reported for more loops:
4944 If @var{n}=3, alignment related information is added to the reports.
4945 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4946 memory access-patterns) is added to the reports.
4947 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4948 that did not pass the first analysis phase (i.e., may not be countable, or
4949 may have complicated control-flow).
4950 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4951 For @var{n}=7, all the information the vectorizer generates during its
4952 analysis and transformation is reported.  This is the same verbosity level
4953 that @option{-fdump-tree-vect-details} uses.
4955 @item -frandom-seed=@var{string}
4956 @opindex frandom-string
4957 This option provides a seed that GCC uses when it would otherwise use
4958 random numbers.  It is used to generate certain symbol names
4959 that have to be different in every compiled file.  It is also used to
4960 place unique stamps in coverage data files and the object files that
4961 produce them.  You can use the @option{-frandom-seed} option to produce
4962 reproducibly identical object files.
4964 The @var{string} should be different for every file you compile.
4966 @item -fsched-verbose=@var{n}
4967 @opindex fsched-verbose
4968 On targets that use instruction scheduling, this option controls the
4969 amount of debugging output the scheduler prints.  This information is
4970 written to standard error, unless @option{-dS} or @option{-dR} is
4971 specified, in which case it is output to the usual dump
4972 listing file, @file{.sched} or @file{.sched2} respectively.  However
4973 for @var{n} greater than nine, the output is always printed to standard
4974 error.
4976 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4977 same information as @option{-dRS}.  For @var{n} greater than one, it
4978 also output basic block probabilities, detailed ready list information
4979 and unit/insn info.  For @var{n} greater than two, it includes RTL
4980 at abort point, control-flow and regions info.  And for @var{n} over
4981 four, @option{-fsched-verbose} also includes dependence info.
4983 @item -save-temps
4984 @opindex save-temps
4985 Store the usual ``temporary'' intermediate files permanently; place them
4986 in the current directory and name them based on the source file.  Thus,
4987 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4988 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4989 preprocessed @file{foo.i} output file even though the compiler now
4990 normally uses an integrated preprocessor.
4992 When used in combination with the @option{-x} command line option,
4993 @option{-save-temps} is sensible enough to avoid over writing an
4994 input source file with the same extension as an intermediate file.
4995 The corresponding intermediate file may be obtained by renaming the
4996 source file before using @option{-save-temps}.
4998 @item -time
4999 @opindex time
5000 Report the CPU time taken by each subprocess in the compilation
5001 sequence.  For C source files, this is the compiler proper and assembler
5002 (plus the linker if linking is done).  The output looks like this:
5004 @smallexample
5005 # cc1 0.12 0.01
5006 # as 0.00 0.01
5007 @end smallexample
5009 The first number on each line is the ``user time'', that is time spent
5010 executing the program itself.  The second number is ``system time'',
5011 time spent executing operating system routines on behalf of the program.
5012 Both numbers are in seconds.
5014 @item -fvar-tracking
5015 @opindex fvar-tracking
5016 Run variable tracking pass.  It computes where variables are stored at each
5017 position in code.  Better debugging information is then generated
5018 (if the debugging information format supports this information).
5020 It is enabled by default when compiling with optimization (@option{-Os},
5021 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5022 the debug info format supports it.
5024 @item -print-file-name=@var{library}
5025 @opindex print-file-name
5026 Print the full absolute name of the library file @var{library} that
5027 would be used when linking---and don't do anything else.  With this
5028 option, GCC does not compile or link anything; it just prints the
5029 file name.
5031 @item -print-multi-directory
5032 @opindex print-multi-directory
5033 Print the directory name corresponding to the multilib selected by any
5034 other switches present in the command line.  This directory is supposed
5035 to exist in @env{GCC_EXEC_PREFIX}.
5037 @item -print-multi-lib
5038 @opindex print-multi-lib
5039 Print the mapping from multilib directory names to compiler switches
5040 that enable them.  The directory name is separated from the switches by
5041 @samp{;}, and each switch starts with an @samp{@@} instead of the
5042 @samp{-}, without spaces between multiple switches.  This is supposed to
5043 ease shell-processing.
5045 @item -print-prog-name=@var{program}
5046 @opindex print-prog-name
5047 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5049 @item -print-libgcc-file-name
5050 @opindex print-libgcc-file-name
5051 Same as @option{-print-file-name=libgcc.a}.
5053 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5054 but you do want to link with @file{libgcc.a}.  You can do
5056 @smallexample
5057 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5058 @end smallexample
5060 @item -print-search-dirs
5061 @opindex print-search-dirs
5062 Print the name of the configured installation directory and a list of
5063 program and library directories @command{gcc} will search---and don't do anything else.
5065 This is useful when @command{gcc} prints the error message
5066 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5067 To resolve this you either need to put @file{cpp0} and the other compiler
5068 components where @command{gcc} expects to find them, or you can set the environment
5069 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5070 Don't forget the trailing @samp{/}.
5071 @xref{Environment Variables}.
5073 @item -print-sysroot-headers-suffix
5074 @opindex print-sysroot-headers-suffix
5075 Print the suffix added to the target sysroot when searching for
5076 headers, or give an error if the compiler is not configured with such
5077 a suffix---and don't do anything else.
5079 @item -dumpmachine
5080 @opindex dumpmachine
5081 Print the compiler's target machine (for example,
5082 @samp{i686-pc-linux-gnu})---and don't do anything else.
5084 @item -dumpversion
5085 @opindex dumpversion
5086 Print the compiler version (for example, @samp{3.0})---and don't do
5087 anything else.
5089 @item -dumpspecs
5090 @opindex dumpspecs
5091 Print the compiler's built-in specs---and don't do anything else.  (This
5092 is used when GCC itself is being built.)  @xref{Spec Files}.
5094 @item -feliminate-unused-debug-types
5095 @opindex feliminate-unused-debug-types
5096 Normally, when producing DWARF2 output, GCC will emit debugging
5097 information for all types declared in a compilation
5098 unit, regardless of whether or not they are actually used
5099 in that compilation unit.  Sometimes this is useful, such as
5100 if, in the debugger, you want to cast a value to a type that is
5101 not actually used in your program (but is declared).  More often,
5102 however, this results in a significant amount of wasted space.
5103 With this option, GCC will avoid producing debug symbol output
5104 for types that are nowhere used in the source file being compiled.
5105 @end table
5107 @node Optimize Options
5108 @section Options That Control Optimization
5109 @cindex optimize options
5110 @cindex options, optimization
5112 These options control various sorts of optimizations.
5114 Without any optimization option, the compiler's goal is to reduce the
5115 cost of compilation and to make debugging produce the expected
5116 results.  Statements are independent: if you stop the program with a
5117 breakpoint between statements, you can then assign a new value to any
5118 variable or change the program counter to any other statement in the
5119 function and get exactly the results you would expect from the source
5120 code.
5122 Turning on optimization flags makes the compiler attempt to improve
5123 the performance and/or code size at the expense of compilation time
5124 and possibly the ability to debug the program.
5126 The compiler performs optimization based on the knowledge it has of
5127 the program.  Optimization levels @option{-O} and above, in
5128 particular, enable @emph{unit-at-a-time} mode, which allows the
5129 compiler to consider information gained from later functions in
5130 the file when compiling a function.  Compiling multiple files at
5131 once to a single output file in @emph{unit-at-a-time} mode allows
5132 the compiler to use information gained from all of the files when
5133 compiling each of them.
5135 Not all optimizations are controlled directly by a flag.  Only
5136 optimizations that have a flag are listed.
5138 @table @gcctabopt
5139 @item -O
5140 @itemx -O1
5141 @opindex O
5142 @opindex O1
5143 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5144 more memory for a large function.
5146 With @option{-O}, the compiler tries to reduce code size and execution
5147 time, without performing any optimizations that take a great deal of
5148 compilation time.
5150 @option{-O} turns on the following optimization flags:
5151 @gccoptlist{
5152 -fauto-inc-dec @gol
5153 -fcprop-registers @gol
5154 -fdce @gol
5155 -fdefer-pop @gol
5156 -fdelayed-branch @gol
5157 -fdse @gol
5158 -fguess-branch-probability @gol
5159 -fif-conversion2 @gol
5160 -fif-conversion @gol
5161 -finline-small-functions @gol
5162 -fipa-pure-const @gol
5163 -fipa-reference @gol
5164 -fmerge-constants
5165 -fsplit-wide-types @gol
5166 -ftree-ccp @gol
5167 -ftree-ch @gol
5168 -ftree-copyrename @gol
5169 -ftree-dce @gol
5170 -ftree-dominator-opts @gol
5171 -ftree-dse @gol
5172 -ftree-fre @gol
5173 -ftree-sra @gol
5174 -ftree-ter @gol
5175 -funit-at-a-time}
5177 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5178 where doing so does not interfere with debugging.
5180 @item -O2
5181 @opindex O2
5182 Optimize even more.  GCC performs nearly all supported optimizations
5183 that do not involve a space-speed tradeoff.  The compiler does not
5184 perform loop unrolling or function inlining when you specify @option{-O2}.
5185 As compared to @option{-O}, this option increases both compilation time
5186 and the performance of the generated code.
5188 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5189 also turns on the following optimization flags:
5190 @gccoptlist{-fthread-jumps @gol
5191 -falign-functions  -falign-jumps @gol
5192 -falign-loops  -falign-labels @gol
5193 -fcaller-saves @gol
5194 -fcrossjumping @gol
5195 -fcse-follow-jumps  -fcse-skip-blocks @gol
5196 -fdelete-null-pointer-checks @gol
5197 -fexpensive-optimizations @gol
5198 -fgcse  -fgcse-lm  @gol
5199 -foptimize-sibling-calls @gol
5200 -fpeephole2 @gol
5201 -fregmove @gol
5202 -freorder-blocks  -freorder-functions @gol
5203 -frerun-cse-after-loop  @gol
5204 -fsched-interblock  -fsched-spec @gol
5205 -fschedule-insns  -fschedule-insns2 @gol
5206 -fstrict-aliasing -fstrict-overflow @gol
5207 -ftree-pre @gol
5208 -ftree-vrp}
5210 Please note the warning under @option{-fgcse} about
5211 invoking @option{-O2} on programs that use computed gotos.
5213 @item -O3
5214 @opindex O3
5215 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5216 @option{-O2} and also turns on the @option{-finline-functions},
5217 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5218 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5220 @item -O0
5221 @opindex O0
5222 Reduce compilation time and make debugging produce the expected
5223 results.  This is the default.
5225 @item -Os
5226 @opindex Os
5227 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5228 do not typically increase code size.  It also performs further
5229 optimizations designed to reduce code size.
5231 @option{-Os} disables the following optimization flags:
5232 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5233 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5234 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5236 If you use multiple @option{-O} options, with or without level numbers,
5237 the last such option is the one that is effective.
5238 @end table
5240 Options of the form @option{-f@var{flag}} specify machine-independent
5241 flags.  Most flags have both positive and negative forms; the negative
5242 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5243 below, only one of the forms is listed---the one you typically will
5244 use.  You can figure out the other form by either removing @samp{no-}
5245 or adding it.
5247 The following options control specific optimizations.  They are either
5248 activated by @option{-O} options or are related to ones that are.  You
5249 can use the following flags in the rare cases when ``fine-tuning'' of
5250 optimizations to be performed is desired.
5252 @table @gcctabopt
5253 @item -fno-default-inline
5254 @opindex fno-default-inline
5255 Do not make member functions inline by default merely because they are
5256 defined inside the class scope (C++ only).  Otherwise, when you specify
5257 @w{@option{-O}}, member functions defined inside class scope are compiled
5258 inline by default; i.e., you don't need to add @samp{inline} in front of
5259 the member function name.
5261 @item -fno-defer-pop
5262 @opindex fno-defer-pop
5263 Always pop the arguments to each function call as soon as that function
5264 returns.  For machines which must pop arguments after a function call,
5265 the compiler normally lets arguments accumulate on the stack for several
5266 function calls and pops them all at once.
5268 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5270 @item -fforward-propagate
5271 @opindex fforward-propagate
5272 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5273 instructions and checks if the result can be simplified.  If loop unrolling
5274 is active, two passes are performed and the second is scheduled after
5275 loop unrolling.
5277 This option is enabled by default at optimization levels @option{-O2},
5278 @option{-O3}, @option{-Os}.
5280 @item -fomit-frame-pointer
5281 @opindex fomit-frame-pointer
5282 Don't keep the frame pointer in a register for functions that
5283 don't need one.  This avoids the instructions to save, set up and
5284 restore frame pointers; it also makes an extra register available
5285 in many functions.  @strong{It also makes debugging impossible on
5286 some machines.}
5288 On some machines, such as the VAX, this flag has no effect, because
5289 the standard calling sequence automatically handles the frame pointer
5290 and nothing is saved by pretending it doesn't exist.  The
5291 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5292 whether a target machine supports this flag.  @xref{Registers,,Register
5293 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5295 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5297 @item -foptimize-sibling-calls
5298 @opindex foptimize-sibling-calls
5299 Optimize sibling and tail recursive calls.
5301 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5303 @item -fno-inline
5304 @opindex fno-inline
5305 Don't pay attention to the @code{inline} keyword.  Normally this option
5306 is used to keep the compiler from expanding any functions inline.
5307 Note that if you are not optimizing, no functions can be expanded inline.
5309 @item -finline-small-functions
5310 @opindex finline-small-functions
5311 Integrate functions into their callers when their body is smaller than expected
5312 function call code (so overall size of program gets smaller).  The compiler
5313 heuristically decides which functions are simple enough to be worth integrating
5314 in this way.
5316 Enabled at level @option{-O2}.
5318 @item -finline-functions
5319 @opindex finline-functions
5320 Integrate all simple functions into their callers.  The compiler
5321 heuristically decides which functions are simple enough to be worth
5322 integrating in this way.
5324 If all calls to a given function are integrated, and the function is
5325 declared @code{static}, then the function is normally not output as
5326 assembler code in its own right.
5328 Enabled at level @option{-O3}.
5330 @item -finline-functions-called-once
5331 @opindex finline-functions-called-once
5332 Consider all @code{static} functions called once for inlining into their
5333 caller even if they are not marked @code{inline}.  If a call to a given
5334 function is integrated, then the function is not output as assembler code
5335 in its own right.
5337 Enabled if @option{-funit-at-a-time} is enabled.
5339 @item -fearly-inlining
5340 @opindex fearly-inlining
5341 Inline functions marked by @code{always_inline} and functions whose body seems
5342 smaller than the function call overhead early before doing
5343 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5344 makes profiling significantly cheaper and usually inlining faster on programs
5345 having large chains of nested wrapper functions.
5347 Enabled by default.
5349 @item -finline-limit=@var{n}
5350 @opindex finline-limit
5351 By default, GCC limits the size of functions that can be inlined.  This flag
5352 allows coarse control of this limit.  @var{n} is the size of functions that
5353 can be inlined in number of pseudo instructions.
5355 Inlining is actually controlled by a number of parameters, which may be
5356 specified individually by using @option{--param @var{name}=@var{value}}.
5357 The @option{-finline-limit=@var{n}} option sets some of these parameters
5358 as follows:
5360 @table @gcctabopt
5361 @item max-inline-insns-single
5362  is set to @var{n}/2.
5363 @item max-inline-insns-auto
5364  is set to @var{n}/2.
5365 @end table
5367 See below for a documentation of the individual
5368 parameters controlling inlining and for the defaults of these parameters.
5370 @emph{Note:} there may be no value to @option{-finline-limit} that results
5371 in default behavior.
5373 @emph{Note:} pseudo instruction represents, in this particular context, an
5374 abstract measurement of function's size.  In no way does it represent a count
5375 of assembly instructions and as such its exact meaning might change from one
5376 release to an another.
5378 @item -fkeep-inline-functions
5379 @opindex fkeep-inline-functions
5380 In C, emit @code{static} functions that are declared @code{inline}
5381 into the object file, even if the function has been inlined into all
5382 of its callers.  This switch does not affect functions using the
5383 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5384 inline functions into the object file.
5386 @item -fkeep-static-consts
5387 @opindex fkeep-static-consts
5388 Emit variables declared @code{static const} when optimization isn't turned
5389 on, even if the variables aren't referenced.
5391 GCC enables this option by default.  If you want to force the compiler to
5392 check if the variable was referenced, regardless of whether or not
5393 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5395 @item -fmerge-constants
5396 @opindex fmerge-constants
5397 Attempt to merge identical constants (string constants and floating point
5398 constants) across compilation units.
5400 This option is the default for optimized compilation if the assembler and
5401 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5402 behavior.
5404 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5406 @item -fmerge-all-constants
5407 @opindex fmerge-all-constants
5408 Attempt to merge identical constants and identical variables.
5410 This option implies @option{-fmerge-constants}.  In addition to
5411 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5412 arrays or initialized constant variables with integral or floating point
5413 types.  Languages like C or C++ require each non-automatic variable to
5414 have distinct location, so using this option will result in non-conforming
5415 behavior.
5417 @item -fmodulo-sched
5418 @opindex fmodulo-sched
5419 Perform swing modulo scheduling immediately before the first scheduling
5420 pass.  This pass looks at innermost loops and reorders their
5421 instructions by overlapping different iterations.
5423 @item -fmodulo-sched-allow-regmoves
5424 @opindex fmodulo-sched-allow-regmoves
5425 Perform more aggressive SMS based modulo scheduling with register moves
5426 allowed.  By setting this flag certain anti-dependences edges will be
5427 deleted which will trigger the generation of reg-moves based on the
5428 life-range analysis.  This option is effective only with
5429 @option{-fmodulo-sched} enabled.
5431 @item -fno-branch-count-reg
5432 @opindex fno-branch-count-reg
5433 Do not use ``decrement and branch'' instructions on a count register,
5434 but instead generate a sequence of instructions that decrement a
5435 register, compare it against zero, then branch based upon the result.
5436 This option is only meaningful on architectures that support such
5437 instructions, which include x86, PowerPC, IA-64 and S/390.
5439 The default is @option{-fbranch-count-reg}.
5441 @item -fno-function-cse
5442 @opindex fno-function-cse
5443 Do not put function addresses in registers; make each instruction that
5444 calls a constant function contain the function's address explicitly.
5446 This option results in less efficient code, but some strange hacks
5447 that alter the assembler output may be confused by the optimizations
5448 performed when this option is not used.
5450 The default is @option{-ffunction-cse}
5452 @item -fno-zero-initialized-in-bss
5453 @opindex fno-zero-initialized-in-bss
5454 If the target supports a BSS section, GCC by default puts variables that
5455 are initialized to zero into BSS@.  This can save space in the resulting
5456 code.
5458 This option turns off this behavior because some programs explicitly
5459 rely on variables going to the data section.  E.g., so that the
5460 resulting executable can find the beginning of that section and/or make
5461 assumptions based on that.
5463 The default is @option{-fzero-initialized-in-bss}.
5465 @item -fmudflap -fmudflapth -fmudflapir
5466 @opindex fmudflap
5467 @opindex fmudflapth
5468 @opindex fmudflapir
5469 @cindex bounds checking
5470 @cindex mudflap
5471 For front-ends that support it (C and C++), instrument all risky
5472 pointer/array dereferencing operations, some standard library
5473 string/heap functions, and some other associated constructs with
5474 range/validity tests.  Modules so instrumented should be immune to
5475 buffer overflows, invalid heap use, and some other classes of C/C++
5476 programming errors.  The instrumentation relies on a separate runtime
5477 library (@file{libmudflap}), which will be linked into a program if
5478 @option{-fmudflap} is given at link time.  Run-time behavior of the
5479 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5480 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5481 for its options.
5483 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5484 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5485 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5486 instrumentation should ignore pointer reads.  This produces less
5487 instrumentation (and therefore faster execution) and still provides
5488 some protection against outright memory corrupting writes, but allows
5489 erroneously read data to propagate within a program.
5491 @item -fthread-jumps
5492 @opindex fthread-jumps
5493 Perform optimizations where we check to see if a jump branches to a
5494 location where another comparison subsumed by the first is found.  If
5495 so, the first branch is redirected to either the destination of the
5496 second branch or a point immediately following it, depending on whether
5497 the condition is known to be true or false.
5499 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5501 @item -fsplit-wide-types
5502 @opindex fsplit-wide-types
5503 When using a type that occupies multiple registers, such as @code{long
5504 long} on a 32-bit system, split the registers apart and allocate them
5505 independently.  This normally generates better code for those types,
5506 but may make debugging more difficult.
5508 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5509 @option{-Os}.
5511 @item -fcse-follow-jumps
5512 @opindex fcse-follow-jumps
5513 In common subexpression elimination (CSE), scan through jump instructions
5514 when the target of the jump is not reached by any other path.  For
5515 example, when CSE encounters an @code{if} statement with an
5516 @code{else} clause, CSE will follow the jump when the condition
5517 tested is false.
5519 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5521 @item -fcse-skip-blocks
5522 @opindex fcse-skip-blocks
5523 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5524 follow jumps which conditionally skip over blocks.  When CSE
5525 encounters a simple @code{if} statement with no else clause,
5526 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5527 body of the @code{if}.
5529 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5531 @item -frerun-cse-after-loop
5532 @opindex frerun-cse-after-loop
5533 Re-run common subexpression elimination after loop optimizations has been
5534 performed.
5536 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5538 @item -fgcse
5539 @opindex fgcse
5540 Perform a global common subexpression elimination pass.
5541 This pass also performs global constant and copy propagation.
5543 @emph{Note:} When compiling a program using computed gotos, a GCC
5544 extension, you may get better runtime performance if you disable
5545 the global common subexpression elimination pass by adding
5546 @option{-fno-gcse} to the command line.
5548 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5550 @item -fgcse-lm
5551 @opindex fgcse-lm
5552 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5553 attempt to move loads which are only killed by stores into themselves.  This
5554 allows a loop containing a load/store sequence to be changed to a load outside
5555 the loop, and a copy/store within the loop.
5557 Enabled by default when gcse is enabled.
5559 @item -fgcse-sm
5560 @opindex fgcse-sm
5561 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5562 global common subexpression elimination.  This pass will attempt to move
5563 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5564 loops containing a load/store sequence can be changed to a load before
5565 the loop and a store after the loop.
5567 Not enabled at any optimization level.
5569 @item -fgcse-las
5570 @opindex fgcse-las
5571 When @option{-fgcse-las} is enabled, the global common subexpression
5572 elimination pass eliminates redundant loads that come after stores to the
5573 same memory location (both partial and full redundancies).
5575 Not enabled at any optimization level.
5577 @item -fgcse-after-reload
5578 @opindex fgcse-after-reload
5579 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5580 pass is performed after reload.  The purpose of this pass is to cleanup
5581 redundant spilling.
5583 @item -funsafe-loop-optimizations
5584 @opindex funsafe-loop-optimizations
5585 If given, the loop optimizer will assume that loop indices do not
5586 overflow, and that the loops with nontrivial exit condition are not
5587 infinite.  This enables a wider range of loop optimizations even if
5588 the loop optimizer itself cannot prove that these assumptions are valid.
5589 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5590 if it finds this kind of loop.
5592 @item -fcrossjumping
5593 @opindex fcrossjumping
5594 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5595 resulting code may or may not perform better than without cross-jumping.
5597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5599 @item -fauto-inc-dec
5600 @opindex fauto-inc-dec
5601 Combine increments or decrements of addresses with memory accesses.
5602 This pass is always skipped on architectures that do not have
5603 instructions to support this.  Enabled by default at @option{-O} and
5604 higher on architectures that support this.
5606 @item -fdce
5607 @opindex fdce
5608 Perform dead code elimination (DCE) on RTL@.
5609 Enabled by default at @option{-O} and higher.
5611 @item -fdse
5612 @opindex fdse
5613 Perform dead store elimination (DSE) on RTL@.
5614 Enabled by default at @option{-O} and higher.
5616 @item -fif-conversion
5617 @opindex fif-conversion
5618 Attempt to transform conditional jumps into branch-less equivalents.  This
5619 include use of conditional moves, min, max, set flags and abs instructions, and
5620 some tricks doable by standard arithmetics.  The use of conditional execution
5621 on chips where it is available is controlled by @code{if-conversion2}.
5623 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5625 @item -fif-conversion2
5626 @opindex fif-conversion2
5627 Use conditional execution (where available) to transform conditional jumps into
5628 branch-less equivalents.
5630 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5632 @item -fdelete-null-pointer-checks
5633 @opindex fdelete-null-pointer-checks
5634 Use global dataflow analysis to identify and eliminate useless checks
5635 for null pointers.  The compiler assumes that dereferencing a null
5636 pointer would have halted the program.  If a pointer is checked after
5637 it has already been dereferenced, it cannot be null.
5639 In some environments, this assumption is not true, and programs can
5640 safely dereference null pointers.  Use
5641 @option{-fno-delete-null-pointer-checks} to disable this optimization
5642 for programs which depend on that behavior.
5644 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5646 @item -fexpensive-optimizations
5647 @opindex fexpensive-optimizations
5648 Perform a number of minor optimizations that are relatively expensive.
5650 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5652 @item -foptimize-register-move
5653 @itemx -fregmove
5654 @opindex foptimize-register-move
5655 @opindex fregmove
5656 Attempt to reassign register numbers in move instructions and as
5657 operands of other simple instructions in order to maximize the amount of
5658 register tying.  This is especially helpful on machines with two-operand
5659 instructions.
5661 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5662 optimization.
5664 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5666 @item -fira
5667 @opindex fira
5668 If supported for the target machine, use the integrated register
5669 allocator (@acronym{IRA}) for the register allocation.
5671 @item -fira-algorithm=@var{algorithm}
5672 Use specified algorithm for the integrated register allocator.  The
5673 @var{algorithm} argument should be one of @code{regional}, @code{CB},
5674 or @code{mixed}.  The second algorithm specifies Chaitin-Briggs
5675 coloring, the first one specifies regional coloring based on
5676 Chaitin-Briggs coloring, and the third one which is the default
5677 specifies a mix of Chaitin-Briggs and regional algorithms where loops
5678 with small register pressure are ignored.  The first algorithm can
5679 give best result for machines with small size and irregular register
5680 set, the second one is faster and generates decent code and the
5681 smallest size code, and the mixed algorithm usually give the best
5682 results in most cases and for most architectures.
5684 @item -fira-coalesce
5685 @opindex fira-coalesce
5686 Do optimistic register coalescing.  This option might be profitable for
5687 architectures with big regular register files.
5689 @item -fira-ipra
5690 @opindex fira-ipra
5691 Switch on a simple form of inter-procedural register allocation when
5692 the integrated register allocator (@acronym{IRA}) is used.
5694 @item -fira-propagate-cost
5695 @opindex -fira-propagate-cost
5696 This is an experimental option used to propagate hard reg costs down
5697 to nested regions for regional or mixed ira allocation algorithm.
5699 @item -fno-ira-move-spills
5700 @opindex fno-ira-move-spills
5701 Switch off increasing gap between the corresponding save and restore
5702 insns.  All saves and the corresponding restores of call used hard
5703 registers living through a call will be in the same basic block.
5705 @item -fno-ira-share-save-slots
5706 @opindex fno-ira-share-save-slots
5707 Switch off sharing stack slots used for saving call used hard
5708 registers living through a call.  Each hard register will get a
5709 separate stack slot and as a result function stack frame will be
5710 bigger.
5712 @item -fno-ira-share-spill-slots
5713 @opindex fno-ira-share-spill-slots
5714 Switch off sharing stack slots allocated for pseudo-registers.  Each
5715 pseudo-register which did not get a hard register will get a separate
5716 stack slot and as a result function stack frame will be bigger.
5718 @item -fira-verbose=@var{n}
5719 @opindex fira-verbose
5720 Set up how verbose dump file for the integrated register allocator
5721 will be.  Default value is 5.  If the value is greater or equal to 10,
5722 the dump file will be stderr as if the value were @var{n} minus 10.
5724 @item -fdelayed-branch
5725 @opindex fdelayed-branch
5726 If supported for the target machine, attempt to reorder instructions
5727 to exploit instruction slots available after delayed branch
5728 instructions.
5730 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5732 @item -fschedule-insns
5733 @opindex fschedule-insns
5734 If supported for the target machine, attempt to reorder instructions to
5735 eliminate execution stalls due to required data being unavailable.  This
5736 helps machines that have slow floating point or memory load instructions
5737 by allowing other instructions to be issued until the result of the load
5738 or floating point instruction is required.
5740 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5742 @item -fschedule-insns2
5743 @opindex fschedule-insns2
5744 Similar to @option{-fschedule-insns}, but requests an additional pass of
5745 instruction scheduling after register allocation has been done.  This is
5746 especially useful on machines with a relatively small number of
5747 registers and where memory load instructions take more than one cycle.
5749 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5751 @item -fno-sched-interblock
5752 @opindex fno-sched-interblock
5753 Don't schedule instructions across basic blocks.  This is normally
5754 enabled by default when scheduling before register allocation, i.e.@:
5755 with @option{-fschedule-insns} or at @option{-O2} or higher.
5757 @item -fno-sched-spec
5758 @opindex fno-sched-spec
5759 Don't allow speculative motion of non-load instructions.  This is normally
5760 enabled by default when scheduling before register allocation, i.e.@:
5761 with @option{-fschedule-insns} or at @option{-O2} or higher.
5763 @item -fsched-spec-load
5764 @opindex fsched-spec-load
5765 Allow speculative motion of some load instructions.  This only makes
5766 sense when scheduling before register allocation, i.e.@: with
5767 @option{-fschedule-insns} or at @option{-O2} or higher.
5769 @item -fsched-spec-load-dangerous
5770 @opindex fsched-spec-load-dangerous
5771 Allow speculative motion of more load instructions.  This only makes
5772 sense when scheduling before register allocation, i.e.@: with
5773 @option{-fschedule-insns} or at @option{-O2} or higher.
5775 @item -fsched-stalled-insns
5776 @itemx -fsched-stalled-insns=@var{n}
5777 @opindex fsched-stalled-insns
5778 Define how many insns (if any) can be moved prematurely from the queue
5779 of stalled insns into the ready list, during the second scheduling pass.
5780 @option{-fno-sched-stalled-insns} means that no insns will be moved
5781 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5782 on how many queued insns can be moved prematurely.
5783 @option{-fsched-stalled-insns} without a value is equivalent to
5784 @option{-fsched-stalled-insns=1}.
5786 @item -fsched-stalled-insns-dep
5787 @itemx -fsched-stalled-insns-dep=@var{n}
5788 @opindex fsched-stalled-insns-dep
5789 Define how many insn groups (cycles) will be examined for a dependency
5790 on a stalled insn that is candidate for premature removal from the queue
5791 of stalled insns.  This has an effect only during the second scheduling pass,
5792 and only if @option{-fsched-stalled-insns} is used.
5793 @option{-fno-sched-stalled-insns-dep} is equivalent to
5794 @option{-fsched-stalled-insns-dep=0}.
5795 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5796 @option{-fsched-stalled-insns-dep=1}.
5798 @item -fsched2-use-superblocks
5799 @opindex fsched2-use-superblocks
5800 When scheduling after register allocation, do use superblock scheduling
5801 algorithm.  Superblock scheduling allows motion across basic block boundaries
5802 resulting on faster schedules.  This option is experimental, as not all machine
5803 descriptions used by GCC model the CPU closely enough to avoid unreliable
5804 results from the algorithm.
5806 This only makes sense when scheduling after register allocation, i.e.@: with
5807 @option{-fschedule-insns2} or at @option{-O2} or higher.
5809 @item -fsched2-use-traces
5810 @opindex fsched2-use-traces
5811 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5812 allocation and additionally perform code duplication in order to increase the
5813 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5814 trace formation.
5816 This mode should produce faster but significantly longer programs.  Also
5817 without @option{-fbranch-probabilities} the traces constructed may not
5818 match the reality and hurt the performance.  This only makes
5819 sense when scheduling after register allocation, i.e.@: with
5820 @option{-fschedule-insns2} or at @option{-O2} or higher.
5822 @item -fsee
5823 @opindex fsee
5824 Eliminate redundant sign extension instructions and move the non-redundant
5825 ones to optimal placement using lazy code motion (LCM).
5827 @item -freschedule-modulo-scheduled-loops
5828 @opindex freschedule-modulo-scheduled-loops
5829 The modulo scheduling comes before the traditional scheduling, if a loop
5830 was modulo scheduled we may want to prevent the later scheduling passes
5831 from changing its schedule, we use this option to control that.
5833 @item -fcaller-saves
5834 @opindex fcaller-saves
5835 Enable values to be allocated in registers that will be clobbered by
5836 function calls, by emitting extra instructions to save and restore the
5837 registers around such calls.  Such allocation is done only when it
5838 seems to result in better code than would otherwise be produced.
5840 This option is always enabled by default on certain machines, usually
5841 those which have no call-preserved registers to use instead.
5843 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5845 @item -ftree-reassoc
5846 @opindex ftree-reassoc
5847 Perform reassociation on trees.  This flag is enabled by default
5848 at @option{-O} and higher.
5850 @item -ftree-pre
5851 @opindex ftree-pre
5852 Perform partial redundancy elimination (PRE) on trees.  This flag is
5853 enabled by default at @option{-O2} and @option{-O3}.
5855 @item -ftree-fre
5856 @opindex ftree-fre
5857 Perform full redundancy elimination (FRE) on trees.  The difference
5858 between FRE and PRE is that FRE only considers expressions
5859 that are computed on all paths leading to the redundant computation.
5860 This analysis is faster than PRE, though it exposes fewer redundancies.
5861 This flag is enabled by default at @option{-O} and higher.
5863 @item -ftree-copy-prop
5864 @opindex ftree-copy-prop
5865 Perform copy propagation on trees.  This pass eliminates unnecessary
5866 copy operations.  This flag is enabled by default at @option{-O} and
5867 higher.
5869 @item -fipa-pure-const
5870 @opindex fipa-pure-const
5871 Discover which functions are pure or constant.
5872 Enabled by default at @option{-O} and higher.
5874 @item -fipa-reference
5875 @opindex fipa-reference
5876 Discover which static variables do not escape cannot escape the
5877 compilation unit.
5878 Enabled by default at @option{-O} and higher.
5880 @item -fipa-struct-reorg
5881 @opindex fipa-struct-reorg
5882 Perform structure reorganization optimization, that change C-like structures 
5883 layout in order to better utilize spatial locality.  This transformation is 
5884 affective for programs containing arrays of structures.  Available in two 
5885 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5886 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5887 to provide the safety of this transformation.  It works only in whole program
5888 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5889 enabled.  Structures considered @samp{cold} by this transformation are not
5890 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5892 With this flag, the program debug info reflects a new structure layout.
5894 @item -fipa-pta
5895 @opindex fipa-pta
5896 Perform interprocedural pointer analysis.
5898 @item -fipa-cp
5899 @opindex fipa-cp
5900 Perform interprocedural constant propagation.
5901 This optimization analyzes the program to determine when values passed
5902 to functions are constants and then optimizes accordingly.  
5903 This optimization can substantially increase performance
5904 if the application has constants passed to functions, but
5905 because this optimization can create multiple copies of functions,
5906 it may significantly increase code size.
5908 @item -fipa-matrix-reorg
5909 @opindex fipa-matrix-reorg
5910 Perform matrix flattening and transposing.
5911 Matrix flattening tries to replace a m-dimensional matrix 
5912 with its equivalent n-dimensional matrix, where n < m.
5913 This reduces the level of indirection needed for accessing the elements
5914 of the matrix. The second optimization is matrix transposing that
5915 attemps to change the order of the matrix's dimensions in order to 
5916 improve cache locality.
5917 Both optimizations need fwhole-program flag. 
5918 Transposing is enabled only if profiling information is avaliable.
5921 @item -ftree-sink
5922 @opindex ftree-sink
5923 Perform forward store motion  on trees.  This flag is
5924 enabled by default at @option{-O} and higher.
5926 @item -ftree-ccp
5927 @opindex ftree-ccp
5928 Perform sparse conditional constant propagation (CCP) on trees.  This
5929 pass only operates on local scalar variables and is enabled by default
5930 at @option{-O} and higher.
5932 @item -ftree-store-ccp
5933 @opindex ftree-store-ccp
5934 Perform sparse conditional constant propagation (CCP) on trees.  This
5935 pass operates on both local scalar variables and memory stores and
5936 loads (global variables, structures, arrays, etc).  This flag is
5937 enabled by default at @option{-O2} and higher.
5939 @item -ftree-dce
5940 @opindex ftree-dce
5941 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5942 default at @option{-O} and higher.
5944 @item -ftree-dominator-opts
5945 @opindex ftree-dominator-opts
5946 Perform a variety of simple scalar cleanups (constant/copy
5947 propagation, redundancy elimination, range propagation and expression
5948 simplification) based on a dominator tree traversal.  This also
5949 performs jump threading (to reduce jumps to jumps). This flag is
5950 enabled by default at @option{-O} and higher.
5952 @item -ftree-dse
5953 @opindex ftree-dse
5954 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5955 a memory location which will later be overwritten by another store without
5956 any intervening loads.  In this case the earlier store can be deleted.  This
5957 flag is enabled by default at @option{-O} and higher.
5959 @item -ftree-ch
5960 @opindex ftree-ch
5961 Perform loop header copying on trees.  This is beneficial since it increases
5962 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5963 is enabled by default at @option{-O} and higher.  It is not enabled
5964 for @option{-Os}, since it usually increases code size.
5966 @item -ftree-loop-optimize
5967 @opindex ftree-loop-optimize
5968 Perform loop optimizations on trees.  This flag is enabled by default
5969 at @option{-O} and higher.
5971 @item -ftree-loop-linear
5972 @opindex ftree-loop-linear
5973 Perform linear loop transformations on tree.  This flag can improve cache
5974 performance and allow further loop optimizations to take place.
5976 @item -fcheck-data-deps
5977 @opindex fcheck-data-deps
5978 Compare the results of several data dependence analyzers.  This option
5979 is used for debugging the data dependence analyzers.
5981 @item -ftree-loop-distribution
5982 Perform loop distribution.  This flag can improve cache performance on
5983 big loop bodies and allow further loop optimizations, like
5984 parallelization or vectorization, to take place.  For example, the loop
5985 @smallexample
5986 DO I = 1, N
5987   A(I) = B(I) + C
5988   D(I) = E(I) * F
5989 ENDDO
5990 @end smallexample
5991 is transformed to
5992 @smallexample
5993 DO I = 1, N
5994    A(I) = B(I) + C
5995 ENDDO
5996 DO I = 1, N
5997    D(I) = E(I) * F
5998 ENDDO
5999 @end smallexample
6001 @item -ftree-loop-im
6002 @opindex ftree-loop-im
6003 Perform loop invariant motion on trees.  This pass moves only invariants that
6004 would be hard to handle at RTL level (function calls, operations that expand to
6005 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6006 operands of conditions that are invariant out of the loop, so that we can use
6007 just trivial invariantness analysis in loop unswitching.  The pass also includes
6008 store motion.
6010 @item -ftree-loop-ivcanon
6011 @opindex ftree-loop-ivcanon
6012 Create a canonical counter for number of iterations in the loop for that
6013 determining number of iterations requires complicated analysis.  Later
6014 optimizations then may determine the number easily.  Useful especially
6015 in connection with unrolling.
6017 @item -fivopts
6018 @opindex fivopts
6019 Perform induction variable optimizations (strength reduction, induction
6020 variable merging and induction variable elimination) on trees.
6022 @item -ftree-parallelize-loops=n
6023 @opindex ftree-parallelize-loops
6024 Parallelize loops, i.e., split their iteration space to run in n threads.
6025 This is only possible for loops whose iterations are independent
6026 and can be arbitrarily reordered.  The optimization is only
6027 profitable on multiprocessor machines, for loops that are CPU-intensive,
6028 rather than constrained e.g.@: by memory bandwidth.  This option
6029 implies @option{-pthread}, and thus is only supported on targets
6030 that have support for @option{-pthread}.
6032 @item -ftree-sra
6033 @opindex ftree-sra
6034 Perform scalar replacement of aggregates.  This pass replaces structure
6035 references with scalars to prevent committing structures to memory too
6036 early.  This flag is enabled by default at @option{-O} and higher.
6038 @item -ftree-copyrename
6039 @opindex ftree-copyrename
6040 Perform copy renaming on trees.  This pass attempts to rename compiler
6041 temporaries to other variables at copy locations, usually resulting in
6042 variable names which more closely resemble the original variables.  This flag
6043 is enabled by default at @option{-O} and higher.
6045 @item -ftree-ter
6046 @opindex ftree-ter
6047 Perform temporary expression replacement during the SSA->normal phase.  Single
6048 use/single def temporaries are replaced at their use location with their
6049 defining expression.  This results in non-GIMPLE code, but gives the expanders
6050 much more complex trees to work on resulting in better RTL generation.  This is
6051 enabled by default at @option{-O} and higher.
6053 @item -ftree-vectorize
6054 @opindex ftree-vectorize
6055 Perform loop vectorization on trees. This flag is enabled by default at
6056 @option{-O3}.
6058 @item -ftree-vect-loop-version
6059 @opindex ftree-vect-loop-version
6060 Perform loop versioning when doing loop vectorization on trees.  When a loop
6061 appears to be vectorizable except that data alignment or data dependence cannot
6062 be determined at compile time then vectorized and non-vectorized versions of
6063 the loop are generated along with runtime checks for alignment or dependence
6064 to control which version is executed.  This option is enabled by default
6065 except at level @option{-Os} where it is disabled.
6067 @item -fvect-cost-model
6068 @opindex fvect-cost-model
6069 Enable cost model for vectorization.
6071 @item -ftree-vrp
6072 @opindex ftree-vrp
6073 Perform Value Range Propagation on trees.  This is similar to the
6074 constant propagation pass, but instead of values, ranges of values are
6075 propagated.  This allows the optimizers to remove unnecessary range
6076 checks like array bound checks and null pointer checks.  This is
6077 enabled by default at @option{-O2} and higher.  Null pointer check
6078 elimination is only done if @option{-fdelete-null-pointer-checks} is
6079 enabled.
6081 @item -ftracer
6082 @opindex ftracer
6083 Perform tail duplication to enlarge superblock size.  This transformation
6084 simplifies the control flow of the function allowing other optimizations to do
6085 better job.
6087 @item -funroll-loops
6088 @opindex funroll-loops
6089 Unroll loops whose number of iterations can be determined at compile
6090 time or upon entry to the loop.  @option{-funroll-loops} implies
6091 @option{-frerun-cse-after-loop}.  This option makes code larger,
6092 and may or may not make it run faster.
6094 @item -funroll-all-loops
6095 @opindex funroll-all-loops
6096 Unroll all loops, even if their number of iterations is uncertain when
6097 the loop is entered.  This usually makes programs run more slowly.
6098 @option{-funroll-all-loops} implies the same options as
6099 @option{-funroll-loops},
6101 @item -fsplit-ivs-in-unroller
6102 @opindex fsplit-ivs-in-unroller
6103 Enables expressing of values of induction variables in later iterations
6104 of the unrolled loop using the value in the first iteration.  This breaks
6105 long dependency chains, thus improving efficiency of the scheduling passes.
6107 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6108 same effect.  However in cases the loop body is more complicated than
6109 a single basic block, this is not reliable.  It also does not work at all
6110 on some of the architectures due to restrictions in the CSE pass.
6112 This optimization is enabled by default.
6114 @item -fvariable-expansion-in-unroller
6115 @opindex fvariable-expansion-in-unroller
6116 With this option, the compiler will create multiple copies of some
6117 local variables when unrolling a loop which can result in superior code.
6119 @item -fpredictive-commoning
6120 @opindex fpredictive-commoning
6121 Perform predictive commoning optimization, i.e., reusing computations
6122 (especially memory loads and stores) performed in previous
6123 iterations of loops.
6125 This option is enabled at level @option{-O3}.
6127 @item -fprefetch-loop-arrays
6128 @opindex fprefetch-loop-arrays
6129 If supported by the target machine, generate instructions to prefetch
6130 memory to improve the performance of loops that access large arrays.
6132 This option may generate better or worse code; results are highly
6133 dependent on the structure of loops within the source code.
6135 Disabled at level @option{-Os}.
6137 @item -fno-peephole
6138 @itemx -fno-peephole2
6139 @opindex fno-peephole
6140 @opindex fno-peephole2
6141 Disable any machine-specific peephole optimizations.  The difference
6142 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6143 are implemented in the compiler; some targets use one, some use the
6144 other, a few use both.
6146 @option{-fpeephole} is enabled by default.
6147 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6149 @item -fno-guess-branch-probability
6150 @opindex fno-guess-branch-probability
6151 Do not guess branch probabilities using heuristics.
6153 GCC will use heuristics to guess branch probabilities if they are
6154 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6155 heuristics are based on the control flow graph.  If some branch probabilities
6156 are specified by @samp{__builtin_expect}, then the heuristics will be
6157 used to guess branch probabilities for the rest of the control flow graph,
6158 taking the @samp{__builtin_expect} info into account.  The interactions
6159 between the heuristics and @samp{__builtin_expect} can be complex, and in
6160 some cases, it may be useful to disable the heuristics so that the effects
6161 of @samp{__builtin_expect} are easier to understand.
6163 The default is @option{-fguess-branch-probability} at levels
6164 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6166 @item -freorder-blocks
6167 @opindex freorder-blocks
6168 Reorder basic blocks in the compiled function in order to reduce number of
6169 taken branches and improve code locality.
6171 Enabled at levels @option{-O2}, @option{-O3}.
6173 @item -freorder-blocks-and-partition
6174 @opindex freorder-blocks-and-partition
6175 In addition to reordering basic blocks in the compiled function, in order
6176 to reduce number of taken branches, partitions hot and cold basic blocks
6177 into separate sections of the assembly and .o files, to improve
6178 paging and cache locality performance.
6180 This optimization is automatically turned off in the presence of
6181 exception handling, for linkonce sections, for functions with a user-defined
6182 section attribute and on any architecture that does not support named
6183 sections.
6185 @item -freorder-functions
6186 @opindex freorder-functions
6187 Reorder functions in the object file in order to
6188 improve code locality.  This is implemented by using special
6189 subsections @code{.text.hot} for most frequently executed functions and
6190 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6191 the linker so object file format must support named sections and linker must
6192 place them in a reasonable way.
6194 Also profile feedback must be available in to make this option effective.  See
6195 @option{-fprofile-arcs} for details.
6197 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6199 @item -fstrict-aliasing
6200 @opindex fstrict-aliasing
6201 Allows the compiler to assume the strictest aliasing rules applicable to
6202 the language being compiled.  For C (and C++), this activates
6203 optimizations based on the type of expressions.  In particular, an
6204 object of one type is assumed never to reside at the same address as an
6205 object of a different type, unless the types are almost the same.  For
6206 example, an @code{unsigned int} can alias an @code{int}, but not a
6207 @code{void*} or a @code{double}.  A character type may alias any other
6208 type.
6210 Pay special attention to code like this:
6211 @smallexample
6212 union a_union @{
6213   int i;
6214   double d;
6217 int f() @{
6218   a_union t;
6219   t.d = 3.0;
6220   return t.i;
6222 @end smallexample
6223 The practice of reading from a different union member than the one most
6224 recently written to (called ``type-punning'') is common.  Even with
6225 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6226 is accessed through the union type.  So, the code above will work as
6227 expected.  However, this code might not:
6228 @smallexample
6229 int f() @{
6230   a_union t;
6231   int* ip;
6232   t.d = 3.0;
6233   ip = &t.i;
6234   return *ip;
6236 @end smallexample
6238 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6240 @item -fstrict-overflow
6241 @opindex fstrict-overflow
6242 Allow the compiler to assume strict signed overflow rules, depending
6243 on the language being compiled.  For C (and C++) this means that
6244 overflow when doing arithmetic with signed numbers is undefined, which
6245 means that the compiler may assume that it will not happen.  This
6246 permits various optimizations.  For example, the compiler will assume
6247 that an expression like @code{i + 10 > i} will always be true for
6248 signed @code{i}.  This assumption is only valid if signed overflow is
6249 undefined, as the expression is false if @code{i + 10} overflows when
6250 using twos complement arithmetic.  When this option is in effect any
6251 attempt to determine whether an operation on signed numbers will
6252 overflow must be written carefully to not actually involve overflow.
6254 This option also allows the compiler to assume strict pointer
6255 semantics: given a pointer to an object, if adding an offset to that
6256 pointer does not produce a pointer to the same object, the addition is
6257 undefined.  This permits the compiler to conclude that @code{p + u >
6258 p} is always true for a pointer @code{p} and unsigned integer
6259 @code{u}.  This assumption is only valid because pointer wraparound is
6260 undefined, as the expression is false if @code{p + u} overflows using
6261 twos complement arithmetic.
6263 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6264 that integer signed overflow is fully defined: it wraps.  When
6265 @option{-fwrapv} is used, there is no difference between
6266 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6267 integers.  With @option{-fwrapv} certain types of overflow are
6268 permitted.  For example, if the compiler gets an overflow when doing
6269 arithmetic on constants, the overflowed value can still be used with
6270 @option{-fwrapv}, but not otherwise.
6272 The @option{-fstrict-overflow} option is enabled at levels
6273 @option{-O2}, @option{-O3}, @option{-Os}.
6275 @item -falign-functions
6276 @itemx -falign-functions=@var{n}
6277 @opindex falign-functions
6278 Align the start of functions to the next power-of-two greater than
6279 @var{n}, skipping up to @var{n} bytes.  For instance,
6280 @option{-falign-functions=32} aligns functions to the next 32-byte
6281 boundary, but @option{-falign-functions=24} would align to the next
6282 32-byte boundary only if this can be done by skipping 23 bytes or less.
6284 @option{-fno-align-functions} and @option{-falign-functions=1} are
6285 equivalent and mean that functions will not be aligned.
6287 Some assemblers only support this flag when @var{n} is a power of two;
6288 in that case, it is rounded up.
6290 If @var{n} is not specified or is zero, use a machine-dependent default.
6292 Enabled at levels @option{-O2}, @option{-O3}.
6294 @item -falign-labels
6295 @itemx -falign-labels=@var{n}
6296 @opindex falign-labels
6297 Align all branch targets to a power-of-two boundary, skipping up to
6298 @var{n} bytes like @option{-falign-functions}.  This option can easily
6299 make code slower, because it must insert dummy operations for when the
6300 branch target is reached in the usual flow of the code.
6302 @option{-fno-align-labels} and @option{-falign-labels=1} are
6303 equivalent and mean that labels will not be aligned.
6305 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6306 are greater than this value, then their values are used instead.
6308 If @var{n} is not specified or is zero, use a machine-dependent default
6309 which is very likely to be @samp{1}, meaning no alignment.
6311 Enabled at levels @option{-O2}, @option{-O3}.
6313 @item -falign-loops
6314 @itemx -falign-loops=@var{n}
6315 @opindex falign-loops
6316 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6317 like @option{-falign-functions}.  The hope is that the loop will be
6318 executed many times, which will make up for any execution of the dummy
6319 operations.
6321 @option{-fno-align-loops} and @option{-falign-loops=1} are
6322 equivalent and mean that loops will not be aligned.
6324 If @var{n} is not specified or is zero, use a machine-dependent default.
6326 Enabled at levels @option{-O2}, @option{-O3}.
6328 @item -falign-jumps
6329 @itemx -falign-jumps=@var{n}
6330 @opindex falign-jumps
6331 Align branch targets to a power-of-two boundary, for branch targets
6332 where the targets can only be reached by jumping, skipping up to @var{n}
6333 bytes like @option{-falign-functions}.  In this case, no dummy operations
6334 need be executed.
6336 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6337 equivalent and mean that loops will not be aligned.
6339 If @var{n} is not specified or is zero, use a machine-dependent default.
6341 Enabled at levels @option{-O2}, @option{-O3}.
6343 @item -funit-at-a-time
6344 @opindex funit-at-a-time
6345 Parse the whole compilation unit before starting to produce code.
6346 This allows some extra optimizations to take place but consumes
6347 more memory (in general).  There are some compatibility issues
6348 with @emph{unit-at-a-time} mode:
6349 @itemize @bullet
6350 @item
6351 enabling @emph{unit-at-a-time} mode may change the order
6352 in which functions, variables, and top-level @code{asm} statements
6353 are emitted, and will likely break code relying on some particular
6354 ordering.  The majority of such top-level @code{asm} statements,
6355 though, can be replaced by @code{section} attributes.  The
6356 @option{fno-toplevel-reorder} option may be used to keep the ordering
6357 used in the input file, at the cost of some optimizations.
6359 @item
6360 @emph{unit-at-a-time} mode removes unreferenced static variables
6361 and functions.  This may result in undefined references
6362 when an @code{asm} statement refers directly to variables or functions
6363 that are otherwise unused.  In that case either the variable/function
6364 shall be listed as an operand of the @code{asm} statement operand or,
6365 in the case of top-level @code{asm} statements the attribute @code{used}
6366 shall be used on the declaration.
6368 @item
6369 Static functions now can use non-standard passing conventions that
6370 may break @code{asm} statements calling functions directly.  Again,
6371 attribute @code{used} will prevent this behavior.
6372 @end itemize
6374 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6375 but this scheme may not be supported by future releases of GCC@.
6377 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6379 @item -fno-toplevel-reorder
6380 @opindex fno-toplevel-reorder
6381 Do not reorder top-level functions, variables, and @code{asm}
6382 statements.  Output them in the same order that they appear in the
6383 input file.  When this option is used, unreferenced static variables
6384 will not be removed.  This option is intended to support existing code
6385 which relies on a particular ordering.  For new code, it is better to
6386 use attributes.
6388 @item -fweb
6389 @opindex fweb
6390 Constructs webs as commonly used for register allocation purposes and assign
6391 each web individual pseudo register.  This allows the register allocation pass
6392 to operate on pseudos directly, but also strengthens several other optimization
6393 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6394 however, make debugging impossible, since variables will no longer stay in a
6395 ``home register''.
6397 Enabled by default with @option{-funroll-loops}.
6399 @item -fwhole-program
6400 @opindex fwhole-program
6401 Assume that the current compilation unit represents whole program being
6402 compiled.  All public functions and variables with the exception of @code{main}
6403 and those merged by attribute @code{externally_visible} become static functions
6404 and in a affect gets more aggressively optimized by interprocedural optimizers.
6405 While this option is equivalent to proper use of @code{static} keyword for
6406 programs consisting of single file, in combination with option
6407 @option{--combine} this flag can be used to compile most of smaller scale C
6408 programs since the functions and variables become local for the whole combined
6409 compilation unit, not for the single source file itself.
6411 This option is not supported for Fortran programs.
6413 @item -fcprop-registers
6414 @opindex fcprop-registers
6415 After register allocation and post-register allocation instruction splitting,
6416 we perform a copy-propagation pass to try to reduce scheduling dependencies
6417 and occasionally eliminate the copy.
6419 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6421 @item -fprofile-dir=@var{path}
6422 @opindex fprofile-dir
6424 Set the directory to search the profile data files in to @var{path}.
6425 This option affects only the profile data generated by
6426 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6427 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6428 and its related options.
6429 By default, GCC will use the current directory as @var{path}
6430 thus the profile data file will appear in the same directory as the object file.
6432 @item -fprofile-generate
6433 @itemx -fprofile-generate=@var{path}
6434 @opindex fprofile-generate
6436 Enable options usually used for instrumenting application to produce
6437 profile useful for later recompilation with profile feedback based
6438 optimization.  You must use @option{-fprofile-generate} both when
6439 compiling and when linking your program.
6441 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6443 If @var{path} is specified, GCC will look at the @var{path} to find
6444 the profile feeedback data files. See @option{-fprofile-dir}.
6446 @item -fprofile-use
6447 @itemx -fprofile-use=@var{path}
6448 @opindex fprofile-use
6449 Enable profile feedback directed optimizations, and optimizations
6450 generally profitable only with profile feedback available.
6452 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6453 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6455 By default, GCC emits an error message if the feedback profiles do not
6456 match the source code.  This error can be turned into a warning by using
6457 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6458 code.
6460 If @var{path} is specified, GCC will look at the @var{path} to find
6461 the profile feedback data files. See @option{-fprofile-dir}.
6462 @end table
6464 The following options control compiler behavior regarding floating
6465 point arithmetic.  These options trade off between speed and
6466 correctness.  All must be specifically enabled.
6468 @table @gcctabopt
6469 @item -ffloat-store
6470 @opindex ffloat-store
6471 Do not store floating point variables in registers, and inhibit other
6472 options that might change whether a floating point value is taken from a
6473 register or memory.
6475 @cindex floating point precision
6476 This option prevents undesirable excess precision on machines such as
6477 the 68000 where the floating registers (of the 68881) keep more
6478 precision than a @code{double} is supposed to have.  Similarly for the
6479 x86 architecture.  For most programs, the excess precision does only
6480 good, but a few programs rely on the precise definition of IEEE floating
6481 point.  Use @option{-ffloat-store} for such programs, after modifying
6482 them to store all pertinent intermediate computations into variables.
6484 @item -ffast-math
6485 @opindex ffast-math
6486 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6487 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6488 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6490 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6492 This option is not turned on by any @option{-O} option since
6493 it can result in incorrect output for programs which depend on
6494 an exact implementation of IEEE or ISO rules/specifications for
6495 math functions. It may, however, yield faster code for programs
6496 that do not require the guarantees of these specifications.
6498 @item -fno-math-errno
6499 @opindex fno-math-errno
6500 Do not set ERRNO after calling math functions that are executed
6501 with a single instruction, e.g., sqrt.  A program that relies on
6502 IEEE exceptions for math error handling may want to use this flag
6503 for speed while maintaining IEEE arithmetic compatibility.
6505 This option is not turned on by any @option{-O} option since
6506 it can result in incorrect output for programs which depend on
6507 an exact implementation of IEEE or ISO rules/specifications for
6508 math functions. It may, however, yield faster code for programs
6509 that do not require the guarantees of these specifications.
6511 The default is @option{-fmath-errno}.
6513 On Darwin systems, the math library never sets @code{errno}.  There is
6514 therefore no reason for the compiler to consider the possibility that
6515 it might, and @option{-fno-math-errno} is the default.
6517 @item -funsafe-math-optimizations
6518 @opindex funsafe-math-optimizations
6520 Allow optimizations for floating-point arithmetic that (a) assume
6521 that arguments and results are valid and (b) may violate IEEE or
6522 ANSI standards.  When used at link-time, it may include libraries
6523 or startup files that change the default FPU control word or other
6524 similar optimizations.
6526 This option is not turned on by any @option{-O} option since
6527 it can result in incorrect output for programs which depend on
6528 an exact implementation of IEEE or ISO rules/specifications for
6529 math functions. It may, however, yield faster code for programs
6530 that do not require the guarantees of these specifications.
6531 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6532 @option{-fassociative-math} and @option{-freciprocal-math}.
6534 The default is @option{-fno-unsafe-math-optimizations}.
6536 @item -fassociative-math
6537 @opindex fassociative-math
6539 Allow re-association of operands in series of floating-point operations.
6540 This violates the ISO C and C++ language standard by possibly changing
6541 computation result.  NOTE: re-ordering may change the sign of zero as
6542 well as ignore NaNs and inhibit or create underflow or overflow (and
6543 thus cannot be used on a code which relies on rounding behavior like
6544 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6545 and thus may not be used when ordered comparisons are required.
6546 This option requires that both @option{-fno-signed-zeros} and
6547 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6548 much sense with @option{-frounding-math}.
6550 The default is @option{-fno-associative-math}.
6552 @item -freciprocal-math
6553 @opindex freciprocal-math
6555 Allow the reciprocal of a value to be used instead of dividing by
6556 the value if this enables optimizations.  For example @code{x / y}
6557 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6558 is subject to common subexpression elimination.  Note that this loses
6559 precision and increases the number of flops operating on the value.
6561 The default is @option{-fno-reciprocal-math}.
6563 @item -ffinite-math-only
6564 @opindex ffinite-math-only
6565 Allow optimizations for floating-point arithmetic that assume
6566 that arguments and results are not NaNs or +-Infs.
6568 This option is not turned on by any @option{-O} option since
6569 it can result in incorrect output for programs which depend on
6570 an exact implementation of IEEE or ISO rules/specifications for
6571 math functions. It may, however, yield faster code for programs
6572 that do not require the guarantees of these specifications.
6574 The default is @option{-fno-finite-math-only}.
6576 @item -fno-signed-zeros
6577 @opindex fno-signed-zeros
6578 Allow optimizations for floating point arithmetic that ignore the
6579 signedness of zero.  IEEE arithmetic specifies the behavior of
6580 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6581 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6582 This option implies that the sign of a zero result isn't significant.
6584 The default is @option{-fsigned-zeros}.
6586 @item -fno-trapping-math
6587 @opindex fno-trapping-math
6588 Compile code assuming that floating-point operations cannot generate
6589 user-visible traps.  These traps include division by zero, overflow,
6590 underflow, inexact result and invalid operation.  This option requires
6591 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6592 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6594 This option should never be turned on by any @option{-O} option since
6595 it can result in incorrect output for programs which depend on
6596 an exact implementation of IEEE or ISO rules/specifications for
6597 math functions.
6599 The default is @option{-ftrapping-math}.
6601 @item -frounding-math
6602 @opindex frounding-math
6603 Disable transformations and optimizations that assume default floating
6604 point rounding behavior.  This is round-to-zero for all floating point
6605 to integer conversions, and round-to-nearest for all other arithmetic
6606 truncations.  This option should be specified for programs that change
6607 the FP rounding mode dynamically, or that may be executed with a
6608 non-default rounding mode.  This option disables constant folding of
6609 floating point expressions at compile-time (which may be affected by
6610 rounding mode) and arithmetic transformations that are unsafe in the
6611 presence of sign-dependent rounding modes.
6613 The default is @option{-fno-rounding-math}.
6615 This option is experimental and does not currently guarantee to
6616 disable all GCC optimizations that are affected by rounding mode.
6617 Future versions of GCC may provide finer control of this setting
6618 using C99's @code{FENV_ACCESS} pragma.  This command line option
6619 will be used to specify the default state for @code{FENV_ACCESS}.
6621 @item -frtl-abstract-sequences
6622 @opindex frtl-abstract-sequences
6623 It is a size optimization method. This option is to find identical
6624 sequences of code, which can be turned into pseudo-procedures  and
6625 then  replace  all  occurrences with  calls to  the  newly created
6626 subroutine. It is kind of an opposite of @option{-finline-functions}.
6627 This optimization runs at RTL level.
6629 @item -fsignaling-nans
6630 @opindex fsignaling-nans
6631 Compile code assuming that IEEE signaling NaNs may generate user-visible
6632 traps during floating-point operations.  Setting this option disables
6633 optimizations that may change the number of exceptions visible with
6634 signaling NaNs.  This option implies @option{-ftrapping-math}.
6636 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6637 be defined.
6639 The default is @option{-fno-signaling-nans}.
6641 This option is experimental and does not currently guarantee to
6642 disable all GCC optimizations that affect signaling NaN behavior.
6644 @item -fsingle-precision-constant
6645 @opindex fsingle-precision-constant
6646 Treat floating point constant as single precision constant instead of
6647 implicitly converting it to double precision constant.
6649 @item -fcx-limited-range
6650 @opindex fcx-limited-range
6651 When enabled, this option states that a range reduction step is not
6652 needed when performing complex division.  Also, there is no checking
6653 whether the result of a complex multiplication or division is @code{NaN
6654 + I*NaN}, with an attempt to rescue the situation in that case.  The
6655 default is @option{-fno-cx-limited-range}, but is enabled by
6656 @option{-ffast-math}.
6658 This option controls the default setting of the ISO C99
6659 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6660 all languages.
6662 @item -fcx-fortran-rules
6663 @opindex fcx-fortran-rules
6664 Complex multiplication and division follow Fortran rules.  Range
6665 reduction is done as part of complex division, but there is no checking
6666 whether the result of a complex multiplication or division is @code{NaN
6667 + I*NaN}, with an attempt to rescue the situation in that case.
6669 The default is @option{-fno-cx-fortran-rules}.
6671 @end table
6673 The following options control optimizations that may improve
6674 performance, but are not enabled by any @option{-O} options.  This
6675 section includes experimental options that may produce broken code.
6677 @table @gcctabopt
6678 @item -fbranch-probabilities
6679 @opindex fbranch-probabilities
6680 After running a program compiled with @option{-fprofile-arcs}
6681 (@pxref{Debugging Options,, Options for Debugging Your Program or
6682 @command{gcc}}), you can compile it a second time using
6683 @option{-fbranch-probabilities}, to improve optimizations based on
6684 the number of times each branch was taken.  When the program
6685 compiled with @option{-fprofile-arcs} exits it saves arc execution
6686 counts to a file called @file{@var{sourcename}.gcda} for each source
6687 file.  The information in this data file is very dependent on the
6688 structure of the generated code, so you must use the same source code
6689 and the same optimization options for both compilations.
6691 With @option{-fbranch-probabilities}, GCC puts a
6692 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6693 These can be used to improve optimization.  Currently, they are only
6694 used in one place: in @file{reorg.c}, instead of guessing which path a
6695 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6696 exactly determine which path is taken more often.
6698 @item -fprofile-values
6699 @opindex fprofile-values
6700 If combined with @option{-fprofile-arcs}, it adds code so that some
6701 data about values of expressions in the program is gathered.
6703 With @option{-fbranch-probabilities}, it reads back the data gathered
6704 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6705 notes to instructions for their later usage in optimizations.
6707 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6709 @item -fvpt
6710 @opindex fvpt
6711 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6712 a code to gather information about values of expressions.
6714 With @option{-fbranch-probabilities}, it reads back the data gathered
6715 and actually performs the optimizations based on them.
6716 Currently the optimizations include specialization of division operation
6717 using the knowledge about the value of the denominator.
6719 @item -frename-registers
6720 @opindex frename-registers
6721 Attempt to avoid false dependencies in scheduled code by making use
6722 of registers left over after register allocation.  This optimization
6723 will most benefit processors with lots of registers.  Depending on the
6724 debug information format adopted by the target, however, it can
6725 make debugging impossible, since variables will no longer stay in
6726 a ``home register''.
6728 Enabled by default with @option{-funroll-loops}.
6730 @item -ftracer
6731 @opindex ftracer
6732 Perform tail duplication to enlarge superblock size.  This transformation
6733 simplifies the control flow of the function allowing other optimizations to do
6734 better job.
6736 Enabled with @option{-fprofile-use}.
6738 @item -funroll-loops
6739 @opindex funroll-loops
6740 Unroll loops whose number of iterations can be determined at compile time or
6741 upon entry to the loop.  @option{-funroll-loops} implies
6742 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6743 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6744 small constant number of iterations).  This option makes code larger, and may
6745 or may not make it run faster.
6747 Enabled with @option{-fprofile-use}.
6749 @item -funroll-all-loops
6750 @opindex funroll-all-loops
6751 Unroll all loops, even if their number of iterations is uncertain when
6752 the loop is entered.  This usually makes programs run more slowly.
6753 @option{-funroll-all-loops} implies the same options as
6754 @option{-funroll-loops}.
6756 @item -fpeel-loops
6757 @opindex fpeel-loops
6758 Peels the loops for that there is enough information that they do not
6759 roll much (from profile feedback).  It also turns on complete loop peeling
6760 (i.e.@: complete removal of loops with small constant number of iterations).
6762 Enabled with @option{-fprofile-use}.
6764 @item -fmove-loop-invariants
6765 @opindex fmove-loop-invariants
6766 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6767 at level @option{-O1}
6769 @item -funswitch-loops
6770 @opindex funswitch-loops
6771 Move branches with loop invariant conditions out of the loop, with duplicates
6772 of the loop on both branches (modified according to result of the condition).
6774 @item -ffunction-sections
6775 @itemx -fdata-sections
6776 @opindex ffunction-sections
6777 @opindex fdata-sections
6778 Place each function or data item into its own section in the output
6779 file if the target supports arbitrary sections.  The name of the
6780 function or the name of the data item determines the section's name
6781 in the output file.
6783 Use these options on systems where the linker can perform optimizations
6784 to improve locality of reference in the instruction space.  Most systems
6785 using the ELF object format and SPARC processors running Solaris 2 have
6786 linkers with such optimizations.  AIX may have these optimizations in
6787 the future.
6789 Only use these options when there are significant benefits from doing
6790 so.  When you specify these options, the assembler and linker will
6791 create larger object and executable files and will also be slower.
6792 You will not be able to use @code{gprof} on all systems if you
6793 specify this option and you may have problems with debugging if
6794 you specify both this option and @option{-g}.
6796 @item -fbranch-target-load-optimize
6797 @opindex fbranch-target-load-optimize
6798 Perform branch target register load optimization before prologue / epilogue
6799 threading.
6800 The use of target registers can typically be exposed only during reload,
6801 thus hoisting loads out of loops and doing inter-block scheduling needs
6802 a separate optimization pass.
6804 @item -fbranch-target-load-optimize2
6805 @opindex fbranch-target-load-optimize2
6806 Perform branch target register load optimization after prologue / epilogue
6807 threading.
6809 @item -fbtr-bb-exclusive
6810 @opindex fbtr-bb-exclusive
6811 When performing branch target register load optimization, don't reuse
6812 branch target registers in within any basic block.
6814 @item -fstack-protector
6815 @opindex fstack-protector
6816 Emit extra code to check for buffer overflows, such as stack smashing
6817 attacks.  This is done by adding a guard variable to functions with
6818 vulnerable objects.  This includes functions that call alloca, and
6819 functions with buffers larger than 8 bytes.  The guards are initialized
6820 when a function is entered and then checked when the function exits.
6821 If a guard check fails, an error message is printed and the program exits.
6823 @item -fstack-protector-all
6824 @opindex fstack-protector-all
6825 Like @option{-fstack-protector} except that all functions are protected.
6827 @item -fsection-anchors
6828 @opindex fsection-anchors
6829 Try to reduce the number of symbolic address calculations by using
6830 shared ``anchor'' symbols to address nearby objects.  This transformation
6831 can help to reduce the number of GOT entries and GOT accesses on some
6832 targets.
6834 For example, the implementation of the following function @code{foo}:
6836 @smallexample
6837 static int a, b, c;
6838 int foo (void) @{ return a + b + c; @}
6839 @end smallexample
6841 would usually calculate the addresses of all three variables, but if you
6842 compile it with @option{-fsection-anchors}, it will access the variables
6843 from a common anchor point instead.  The effect is similar to the
6844 following pseudocode (which isn't valid C):
6846 @smallexample
6847 int foo (void)
6849   register int *xr = &x;
6850   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6852 @end smallexample
6854 Not all targets support this option.
6856 @item --param @var{name}=@var{value}
6857 @opindex param
6858 In some places, GCC uses various constants to control the amount of
6859 optimization that is done.  For example, GCC will not inline functions
6860 that contain more that a certain number of instructions.  You can
6861 control some of these constants on the command-line using the
6862 @option{--param} option.
6864 The names of specific parameters, and the meaning of the values, are
6865 tied to the internals of the compiler, and are subject to change
6866 without notice in future releases.
6868 In each case, the @var{value} is an integer.  The allowable choices for
6869 @var{name} are given in the following table:
6871 @table @gcctabopt
6872 @item sra-max-structure-size
6873 The maximum structure size, in bytes, at which the scalar replacement
6874 of aggregates (SRA) optimization will perform block copies.  The
6875 default value, 0, implies that GCC will select the most appropriate
6876 size itself.
6878 @item sra-field-structure-ratio
6879 The threshold ratio (as a percentage) between instantiated fields and
6880 the complete structure size.  We say that if the ratio of the number
6881 of bytes in instantiated fields to the number of bytes in the complete
6882 structure exceeds this parameter, then block copies are not used.  The
6883 default is 75.
6885 @item struct-reorg-cold-struct-ratio
6886 The threshold ratio (as a percentage) between a structure frequency
6887 and the frequency of the hottest structure in the program.  This parameter
6888 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6889 We say that if the ratio of a structure frequency, calculated by profiling, 
6890 to the hottest structure frequency in the program is less than this 
6891 parameter, then structure reorganization is not applied to this structure.
6892 The default is 10.
6894 @item max-crossjump-edges
6895 The maximum number of incoming edges to consider for crossjumping.
6896 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6897 the number of edges incoming to each block.  Increasing values mean
6898 more aggressive optimization, making the compile time increase with
6899 probably small improvement in executable size.
6901 @item min-crossjump-insns
6902 The minimum number of instructions which must be matched at the end
6903 of two blocks before crossjumping will be performed on them.  This
6904 value is ignored in the case where all instructions in the block being
6905 crossjumped from are matched.  The default value is 5.
6907 @item max-grow-copy-bb-insns
6908 The maximum code size expansion factor when copying basic blocks
6909 instead of jumping.  The expansion is relative to a jump instruction.
6910 The default value is 8.
6912 @item max-goto-duplication-insns
6913 The maximum number of instructions to duplicate to a block that jumps
6914 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6915 passes, GCC factors computed gotos early in the compilation process,
6916 and unfactors them as late as possible.  Only computed jumps at the
6917 end of a basic blocks with no more than max-goto-duplication-insns are
6918 unfactored.  The default value is 8.
6920 @item max-delay-slot-insn-search
6921 The maximum number of instructions to consider when looking for an
6922 instruction to fill a delay slot.  If more than this arbitrary number of
6923 instructions is searched, the time savings from filling the delay slot
6924 will be minimal so stop searching.  Increasing values mean more
6925 aggressive optimization, making the compile time increase with probably
6926 small improvement in executable run time.
6928 @item max-delay-slot-live-search
6929 When trying to fill delay slots, the maximum number of instructions to
6930 consider when searching for a block with valid live register
6931 information.  Increasing this arbitrarily chosen value means more
6932 aggressive optimization, increasing the compile time.  This parameter
6933 should be removed when the delay slot code is rewritten to maintain the
6934 control-flow graph.
6936 @item max-gcse-memory
6937 The approximate maximum amount of memory that will be allocated in
6938 order to perform the global common subexpression elimination
6939 optimization.  If more memory than specified is required, the
6940 optimization will not be done.
6942 @item max-gcse-passes
6943 The maximum number of passes of GCSE to run.  The default is 1.
6945 @item max-pending-list-length
6946 The maximum number of pending dependencies scheduling will allow
6947 before flushing the current state and starting over.  Large functions
6948 with few branches or calls can create excessively large lists which
6949 needlessly consume memory and resources.
6951 @item max-inline-insns-single
6952 Several parameters control the tree inliner used in gcc.
6953 This number sets the maximum number of instructions (counted in GCC's
6954 internal representation) in a single function that the tree inliner
6955 will consider for inlining.  This only affects functions declared
6956 inline and methods implemented in a class declaration (C++).
6957 The default value is 450.
6959 @item max-inline-insns-auto
6960 When you use @option{-finline-functions} (included in @option{-O3}),
6961 a lot of functions that would otherwise not be considered for inlining
6962 by the compiler will be investigated.  To those functions, a different
6963 (more restrictive) limit compared to functions declared inline can
6964 be applied.
6965 The default value is 90.
6967 @item large-function-insns
6968 The limit specifying really large functions.  For functions larger than this
6969 limit after inlining inlining is constrained by
6970 @option{--param large-function-growth}.  This parameter is useful primarily
6971 to avoid extreme compilation time caused by non-linear algorithms used by the
6972 backend.
6973 This parameter is ignored when @option{-funit-at-a-time} is not used.
6974 The default value is 2700.
6976 @item large-function-growth
6977 Specifies maximal growth of large function caused by inlining in percents.
6978 This parameter is ignored when @option{-funit-at-a-time} is not used.
6979 The default value is 100 which limits large function growth to 2.0 times
6980 the original size.
6982 @item large-unit-insns
6983 The limit specifying large translation unit.  Growth caused by inlining of
6984 units larger than this limit is limited by @option{--param inline-unit-growth}.
6985 For small units this might be too tight (consider unit consisting of function A
6986 that is inline and B that just calls A three time.  If B is small relative to
6987 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6988 large units consisting of small inlineable functions however the overall unit
6989 growth limit is needed to avoid exponential explosion of code size.  Thus for
6990 smaller units, the size is increased to @option{--param large-unit-insns}
6991 before applying @option{--param inline-unit-growth}.  The default is 10000
6993 @item inline-unit-growth
6994 Specifies maximal overall growth of the compilation unit caused by inlining.
6995 This parameter is ignored when @option{-funit-at-a-time} is not used.
6996 The default value is 30 which limits unit growth to 1.3 times the original
6997 size.
6999 @item large-stack-frame
7000 The limit specifying large stack frames.  While inlining the algorithm is trying
7001 to not grow past this limit too much.  Default value is 256 bytes.
7003 @item large-stack-frame-growth
7004 Specifies maximal growth of large stack frames caused by inlining in percents.
7005 The default value is 1000 which limits large stack frame growth to 11 times
7006 the original size.
7008 @item max-inline-insns-recursive
7009 @itemx max-inline-insns-recursive-auto
7010 Specifies maximum number of instructions out-of-line copy of self recursive inline
7011 function can grow into by performing recursive inlining.
7013 For functions declared inline @option{--param max-inline-insns-recursive} is
7014 taken into account.  For function not declared inline, recursive inlining
7015 happens only when @option{-finline-functions} (included in @option{-O3}) is
7016 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
7017 default value is 450.
7019 @item max-inline-recursive-depth
7020 @itemx max-inline-recursive-depth-auto
7021 Specifies maximum recursion depth used by the recursive inlining.
7023 For functions declared inline @option{--param max-inline-recursive-depth} is
7024 taken into account.  For function not declared inline, recursive inlining
7025 happens only when @option{-finline-functions} (included in @option{-O3}) is
7026 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
7027 default value is 8.
7029 @item min-inline-recursive-probability
7030 Recursive inlining is profitable only for function having deep recursion
7031 in average and can hurt for function having little recursion depth by
7032 increasing the prologue size or complexity of function body to other
7033 optimizers.
7035 When profile feedback is available (see @option{-fprofile-generate}) the actual
7036 recursion depth can be guessed from probability that function will recurse via
7037 given call expression.  This parameter limits inlining only to call expression
7038 whose probability exceeds given threshold (in percents).  The default value is
7041 @item inline-call-cost
7042 Specify cost of call instruction relative to simple arithmetics operations
7043 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
7044 functions and at the same time increases size of leaf function that is believed to
7045 reduce function size by being inlined.  In effect it increases amount of
7046 inlining for code having large abstraction penalty (many functions that just
7047 pass the arguments to other functions) and decrease inlining for code with low
7048 abstraction penalty.  The default value is 12.
7050 @item min-vect-loop-bound
7051 The minimum number of iterations under which a loop will not get vectorized
7052 when @option{-ftree-vectorize} is used.  The number of iterations after
7053 vectorization needs to be greater than the value specified by this option
7054 to allow vectorization.  The default value is 0.
7056 @item max-unrolled-insns
7057 The maximum number of instructions that a loop should have if that loop
7058 is unrolled, and if the loop is unrolled, it determines how many times
7059 the loop code is unrolled.
7061 @item max-average-unrolled-insns
7062 The maximum number of instructions biased by probabilities of their execution
7063 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7064 it determines how many times the loop code is unrolled.
7066 @item max-unroll-times
7067 The maximum number of unrollings of a single loop.
7069 @item max-peeled-insns
7070 The maximum number of instructions that a loop should have if that loop
7071 is peeled, and if the loop is peeled, it determines how many times
7072 the loop code is peeled.
7074 @item max-peel-times
7075 The maximum number of peelings of a single loop.
7077 @item max-completely-peeled-insns
7078 The maximum number of insns of a completely peeled loop.
7080 @item max-completely-peel-times
7081 The maximum number of iterations of a loop to be suitable for complete peeling.
7083 @item max-unswitch-insns
7084 The maximum number of insns of an unswitched loop.
7086 @item max-unswitch-level
7087 The maximum number of branches unswitched in a single loop.
7089 @item lim-expensive
7090 The minimum cost of an expensive expression in the loop invariant motion.
7092 @item iv-consider-all-candidates-bound
7093 Bound on number of candidates for induction variables below that
7094 all candidates are considered for each use in induction variable
7095 optimizations.  Only the most relevant candidates are considered
7096 if there are more candidates, to avoid quadratic time complexity.
7098 @item iv-max-considered-uses
7099 The induction variable optimizations give up on loops that contain more
7100 induction variable uses.
7102 @item iv-always-prune-cand-set-bound
7103 If number of candidates in the set is smaller than this value,
7104 we always try to remove unnecessary ivs from the set during its
7105 optimization when a new iv is added to the set.
7107 @item scev-max-expr-size
7108 Bound on size of expressions used in the scalar evolutions analyzer.
7109 Large expressions slow the analyzer.
7111 @item omega-max-vars
7112 The maximum number of variables in an Omega constraint system.
7113 The default value is 128.
7115 @item omega-max-geqs
7116 The maximum number of inequalities in an Omega constraint system.
7117 The default value is 256.
7119 @item omega-max-eqs
7120 The maximum number of equalities in an Omega constraint system.
7121 The default value is 128.
7123 @item omega-max-wild-cards
7124 The maximum number of wildcard variables that the Omega solver will
7125 be able to insert.  The default value is 18.
7127 @item omega-hash-table-size
7128 The size of the hash table in the Omega solver.  The default value is
7129 550.
7131 @item omega-max-keys
7132 The maximal number of keys used by the Omega solver.  The default
7133 value is 500.
7135 @item omega-eliminate-redundant-constraints
7136 When set to 1, use expensive methods to eliminate all redundant
7137 constraints.  The default value is 0.
7139 @item vect-max-version-for-alignment-checks
7140 The maximum number of runtime checks that can be performed when
7141 doing loop versioning for alignment in the vectorizer.  See option
7142 ftree-vect-loop-version for more information.
7144 @item vect-max-version-for-alias-checks
7145 The maximum number of runtime checks that can be performed when
7146 doing loop versioning for alias in the vectorizer.  See option
7147 ftree-vect-loop-version for more information.
7149 @item max-iterations-to-track
7151 The maximum number of iterations of a loop the brute force algorithm
7152 for analysis of # of iterations of the loop tries to evaluate.
7154 @item hot-bb-count-fraction
7155 Select fraction of the maximal count of repetitions of basic block in program
7156 given basic block needs to have to be considered hot.
7158 @item hot-bb-frequency-fraction
7159 Select fraction of the maximal frequency of executions of basic block in
7160 function given basic block needs to have to be considered hot
7162 @item max-predicted-iterations
7163 The maximum number of loop iterations we predict statically.  This is useful
7164 in cases where function contain single loop with known bound and other loop
7165 with unknown.  We predict the known number of iterations correctly, while
7166 the unknown number of iterations average to roughly 10.  This means that the
7167 loop without bounds would appear artificially cold relative to the other one.
7169 @item align-threshold
7171 Select fraction of the maximal frequency of executions of basic block in
7172 function given basic block will get aligned.
7174 @item align-loop-iterations
7176 A loop expected to iterate at lest the selected number of iterations will get
7177 aligned.
7179 @item tracer-dynamic-coverage
7180 @itemx tracer-dynamic-coverage-feedback
7182 This value is used to limit superblock formation once the given percentage of
7183 executed instructions is covered.  This limits unnecessary code size
7184 expansion.
7186 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7187 feedback is available.  The real profiles (as opposed to statically estimated
7188 ones) are much less balanced allowing the threshold to be larger value.
7190 @item tracer-max-code-growth
7191 Stop tail duplication once code growth has reached given percentage.  This is
7192 rather hokey argument, as most of the duplicates will be eliminated later in
7193 cross jumping, so it may be set to much higher values than is the desired code
7194 growth.
7196 @item tracer-min-branch-ratio
7198 Stop reverse growth when the reverse probability of best edge is less than this
7199 threshold (in percent).
7201 @item tracer-min-branch-ratio
7202 @itemx tracer-min-branch-ratio-feedback
7204 Stop forward growth if the best edge do have probability lower than this
7205 threshold.
7207 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7208 compilation for profile feedback and one for compilation without.  The value
7209 for compilation with profile feedback needs to be more conservative (higher) in
7210 order to make tracer effective.
7212 @item max-cse-path-length
7214 Maximum number of basic blocks on path that cse considers.  The default is 10.
7216 @item max-cse-insns
7217 The maximum instructions CSE process before flushing. The default is 1000.
7219 @item max-aliased-vops
7221 Maximum number of virtual operands per function allowed to represent
7222 aliases before triggering the alias partitioning heuristic.  Alias
7223 partitioning reduces compile times and memory consumption needed for
7224 aliasing at the expense of precision loss in alias information.  The
7225 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7226 for -O3.
7228 Notice that if a function contains more memory statements than the
7229 value of this parameter, it is not really possible to achieve this
7230 reduction.  In this case, the compiler will use the number of memory
7231 statements as the value for @option{max-aliased-vops}.
7233 @item avg-aliased-vops
7235 Average number of virtual operands per statement allowed to represent
7236 aliases before triggering the alias partitioning heuristic.  This
7237 works in conjunction with @option{max-aliased-vops}.  If a function
7238 contains more than @option{max-aliased-vops} virtual operators, then
7239 memory symbols will be grouped into memory partitions until either the
7240 total number of virtual operators is below @option{max-aliased-vops}
7241 or the average number of virtual operators per memory statement is
7242 below @option{avg-aliased-vops}.  The default value for this parameter
7243 is 1 for -O1 and -O2, and 3 for -O3.
7245 @item ggc-min-expand
7247 GCC uses a garbage collector to manage its own memory allocation.  This
7248 parameter specifies the minimum percentage by which the garbage
7249 collector's heap should be allowed to expand between collections.
7250 Tuning this may improve compilation speed; it has no effect on code
7251 generation.
7253 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7254 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7255 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7256 GCC is not able to calculate RAM on a particular platform, the lower
7257 bound of 30% is used.  Setting this parameter and
7258 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7259 every opportunity.  This is extremely slow, but can be useful for
7260 debugging.
7262 @item ggc-min-heapsize
7264 Minimum size of the garbage collector's heap before it begins bothering
7265 to collect garbage.  The first collection occurs after the heap expands
7266 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7267 tuning this may improve compilation speed, and has no effect on code
7268 generation.
7270 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7271 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7272 with a lower bound of 4096 (four megabytes) and an upper bound of
7273 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7274 particular platform, the lower bound is used.  Setting this parameter
7275 very large effectively disables garbage collection.  Setting this
7276 parameter and @option{ggc-min-expand} to zero causes a full collection
7277 to occur at every opportunity.
7279 @item max-reload-search-insns
7280 The maximum number of instruction reload should look backward for equivalent
7281 register.  Increasing values mean more aggressive optimization, making the
7282 compile time increase with probably slightly better performance.  The default
7283 value is 100.
7285 @item max-cselib-memory-locations
7286 The maximum number of memory locations cselib should take into account.
7287 Increasing values mean more aggressive optimization, making the compile time
7288 increase with probably slightly better performance.  The default value is 500.
7290 @item reorder-blocks-duplicate
7291 @itemx reorder-blocks-duplicate-feedback
7293 Used by basic block reordering pass to decide whether to use unconditional
7294 branch or duplicate the code on its destination.  Code is duplicated when its
7295 estimated size is smaller than this value multiplied by the estimated size of
7296 unconditional jump in the hot spots of the program.
7298 The @option{reorder-block-duplicate-feedback} is used only when profile
7299 feedback is available and may be set to higher values than
7300 @option{reorder-block-duplicate} since information about the hot spots is more
7301 accurate.
7303 @item max-sched-ready-insns
7304 The maximum number of instructions ready to be issued the scheduler should
7305 consider at any given time during the first scheduling pass.  Increasing
7306 values mean more thorough searches, making the compilation time increase
7307 with probably little benefit.  The default value is 100.
7309 @item max-sched-region-blocks
7310 The maximum number of blocks in a region to be considered for
7311 interblock scheduling.  The default value is 10.
7313 @item max-sched-region-insns
7314 The maximum number of insns in a region to be considered for
7315 interblock scheduling.  The default value is 100.
7317 @item min-spec-prob
7318 The minimum probability (in percents) of reaching a source block
7319 for interblock speculative scheduling.  The default value is 40.
7321 @item max-sched-extend-regions-iters
7322 The maximum number of iterations through CFG to extend regions.
7323 0 - disable region extension,
7324 N - do at most N iterations.
7325 The default value is 0.
7327 @item max-sched-insn-conflict-delay
7328 The maximum conflict delay for an insn to be considered for speculative motion.
7329 The default value is 3.
7331 @item sched-spec-prob-cutoff
7332 The minimal probability of speculation success (in percents), so that
7333 speculative insn will be scheduled.
7334 The default value is 40.
7336 @item max-last-value-rtl
7338 The maximum size measured as number of RTLs that can be recorded in an expression
7339 in combiner for a pseudo register as last known value of that register.  The default
7340 is 10000.
7342 @item integer-share-limit
7343 Small integer constants can use a shared data structure, reducing the
7344 compiler's memory usage and increasing its speed.  This sets the maximum
7345 value of a shared integer constant.  The default value is 256.
7347 @item min-virtual-mappings
7348 Specifies the minimum number of virtual mappings in the incremental
7349 SSA updater that should be registered to trigger the virtual mappings
7350 heuristic defined by virtual-mappings-ratio.  The default value is
7351 100.
7353 @item virtual-mappings-ratio
7354 If the number of virtual mappings is virtual-mappings-ratio bigger
7355 than the number of virtual symbols to be updated, then the incremental
7356 SSA updater switches to a full update for those symbols.  The default
7357 ratio is 3.
7359 @item ssp-buffer-size
7360 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7361 protection when @option{-fstack-protection} is used.
7363 @item max-jump-thread-duplication-stmts
7364 Maximum number of statements allowed in a block that needs to be
7365 duplicated when threading jumps.
7367 @item max-fields-for-field-sensitive
7368 Maximum number of fields in a structure we will treat in
7369 a field sensitive manner during pointer analysis.
7371 @item prefetch-latency
7372 Estimate on average number of instructions that are executed before
7373 prefetch finishes.  The distance we prefetch ahead is proportional
7374 to this constant.  Increasing this number may also lead to less
7375 streams being prefetched (see @option{simultaneous-prefetches}).
7377 @item simultaneous-prefetches
7378 Maximum number of prefetches that can run at the same time.
7380 @item l1-cache-line-size
7381 The size of cache line in L1 cache, in bytes.
7383 @item l1-cache-size
7384 The size of L1 cache, in kilobytes.
7386 @item l2-cache-size
7387 The size of L2 cache, in kilobytes.
7389 @item use-canonical-types
7390 Whether the compiler should use the ``canonical'' type system.  By
7391 default, this should always be 1, which uses a more efficient internal
7392 mechanism for comparing types in C++ and Objective-C++.  However, if
7393 bugs in the canonical type system are causing compilation failures,
7394 set this value to 0 to disable canonical types.
7396 @item max-partial-antic-length
7397 Maximum length of the partial antic set computed during the tree
7398 partial redundancy elimination optimization (@option{-ftree-pre}) when
7399 optimizing at @option{-O3} and above.  For some sorts of source code
7400 the enhanced partial redundancy elimination optimization can run away,
7401 consuming all of the memory available on the host machine.  This
7402 parameter sets a limit on the length of the sets that are computed,
7403 which prevents the runaway behaviour.  Setting a value of 0 for
7404 this paramter will allow an unlimited set length.
7406 @item sccvn-max-scc-size
7407 Maximum size of a strongly connected component (SCC) during SCCVN
7408 processing.  If this limit is hit, SCCVN processing for the whole
7409 function will not be done and optimizations depending on it will
7410 be disabled.  The default maximum SCC size is 10000.
7412 @item ira-max-loops-num
7413 IRA uses a regional register allocation by default.  If a function
7414 contains loops more than number given by the parameter, non-regional
7415 register allocator will be used even when option
7416 @option{-fira-algorithm} is given.  The default value of the parameter
7417 is 20.
7419 @end table
7420 @end table
7422 @node Preprocessor Options
7423 @section Options Controlling the Preprocessor
7424 @cindex preprocessor options
7425 @cindex options, preprocessor
7427 These options control the C preprocessor, which is run on each C source
7428 file before actual compilation.
7430 If you use the @option{-E} option, nothing is done except preprocessing.
7431 Some of these options make sense only together with @option{-E} because
7432 they cause the preprocessor output to be unsuitable for actual
7433 compilation.
7435 @table @gcctabopt
7436 @opindex Wp
7437 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7438 and pass @var{option} directly through to the preprocessor.  If
7439 @var{option} contains commas, it is split into multiple options at the
7440 commas.  However, many options are modified, translated or interpreted
7441 by the compiler driver before being passed to the preprocessor, and
7442 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7443 interface is undocumented and subject to change, so whenever possible
7444 you should avoid using @option{-Wp} and let the driver handle the
7445 options instead.
7447 @item -Xpreprocessor @var{option}
7448 @opindex preprocessor
7449 Pass @var{option} as an option to the preprocessor.  You can use this to
7450 supply system-specific preprocessor options which GCC does not know how to
7451 recognize.
7453 If you want to pass an option that takes an argument, you must use
7454 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7455 @end table
7457 @include cppopts.texi
7459 @node Assembler Options
7460 @section Passing Options to the Assembler
7462 @c prevent bad page break with this line
7463 You can pass options to the assembler.
7465 @table @gcctabopt
7466 @item -Wa,@var{option}
7467 @opindex Wa
7468 Pass @var{option} as an option to the assembler.  If @var{option}
7469 contains commas, it is split into multiple options at the commas.
7471 @item -Xassembler @var{option}
7472 @opindex Xassembler
7473 Pass @var{option} as an option to the assembler.  You can use this to
7474 supply system-specific assembler options which GCC does not know how to
7475 recognize.
7477 If you want to pass an option that takes an argument, you must use
7478 @option{-Xassembler} twice, once for the option and once for the argument.
7480 @end table
7482 @node Link Options
7483 @section Options for Linking
7484 @cindex link options
7485 @cindex options, linking
7487 These options come into play when the compiler links object files into
7488 an executable output file.  They are meaningless if the compiler is
7489 not doing a link step.
7491 @table @gcctabopt
7492 @cindex file names
7493 @item @var{object-file-name}
7494 A file name that does not end in a special recognized suffix is
7495 considered to name an object file or library.  (Object files are
7496 distinguished from libraries by the linker according to the file
7497 contents.)  If linking is done, these object files are used as input
7498 to the linker.
7500 @item -c
7501 @itemx -S
7502 @itemx -E
7503 @opindex c
7504 @opindex S
7505 @opindex E
7506 If any of these options is used, then the linker is not run, and
7507 object file names should not be used as arguments.  @xref{Overall
7508 Options}.
7510 @cindex Libraries
7511 @item -l@var{library}
7512 @itemx -l @var{library}
7513 @opindex l
7514 Search the library named @var{library} when linking.  (The second
7515 alternative with the library as a separate argument is only for
7516 POSIX compliance and is not recommended.)
7518 It makes a difference where in the command you write this option; the
7519 linker searches and processes libraries and object files in the order they
7520 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7521 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7522 to functions in @samp{z}, those functions may not be loaded.
7524 The linker searches a standard list of directories for the library,
7525 which is actually a file named @file{lib@var{library}.a}.  The linker
7526 then uses this file as if it had been specified precisely by name.
7528 The directories searched include several standard system directories
7529 plus any that you specify with @option{-L}.
7531 Normally the files found this way are library files---archive files
7532 whose members are object files.  The linker handles an archive file by
7533 scanning through it for members which define symbols that have so far
7534 been referenced but not defined.  But if the file that is found is an
7535 ordinary object file, it is linked in the usual fashion.  The only
7536 difference between using an @option{-l} option and specifying a file name
7537 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7538 and searches several directories.
7540 @item -lobjc
7541 @opindex lobjc
7542 You need this special case of the @option{-l} option in order to
7543 link an Objective-C or Objective-C++ program.
7545 @item -nostartfiles
7546 @opindex nostartfiles
7547 Do not use the standard system startup files when linking.
7548 The standard system libraries are used normally, unless @option{-nostdlib}
7549 or @option{-nodefaultlibs} is used.
7551 @item -nodefaultlibs
7552 @opindex nodefaultlibs
7553 Do not use the standard system libraries when linking.
7554 Only the libraries you specify will be passed to the linker.
7555 The standard startup files are used normally, unless @option{-nostartfiles}
7556 is used.  The compiler may generate calls to @code{memcmp},
7557 @code{memset}, @code{memcpy} and @code{memmove}.
7558 These entries are usually resolved by entries in
7559 libc.  These entry points should be supplied through some other
7560 mechanism when this option is specified.
7562 @item -nostdlib
7563 @opindex nostdlib
7564 Do not use the standard system startup files or libraries when linking.
7565 No startup files and only the libraries you specify will be passed to
7566 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7567 @code{memcpy} and @code{memmove}.
7568 These entries are usually resolved by entries in
7569 libc.  These entry points should be supplied through some other
7570 mechanism when this option is specified.
7572 @cindex @option{-lgcc}, use with @option{-nostdlib}
7573 @cindex @option{-nostdlib} and unresolved references
7574 @cindex unresolved references and @option{-nostdlib}
7575 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7576 @cindex @option{-nodefaultlibs} and unresolved references
7577 @cindex unresolved references and @option{-nodefaultlibs}
7578 One of the standard libraries bypassed by @option{-nostdlib} and
7579 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7580 that GCC uses to overcome shortcomings of particular machines, or special
7581 needs for some languages.
7582 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7583 Collection (GCC) Internals},
7584 for more discussion of @file{libgcc.a}.)
7585 In most cases, you need @file{libgcc.a} even when you want to avoid
7586 other standard libraries.  In other words, when you specify @option{-nostdlib}
7587 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7588 This ensures that you have no unresolved references to internal GCC
7589 library subroutines.  (For example, @samp{__main}, used to ensure C++
7590 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7591 GNU Compiler Collection (GCC) Internals}.)
7593 @item -pie
7594 @opindex pie
7595 Produce a position independent executable on targets which support it.
7596 For predictable results, you must also specify the same set of options
7597 that were used to generate code (@option{-fpie}, @option{-fPIE},
7598 or model suboptions) when you specify this option.
7600 @item -rdynamic
7601 @opindex rdynamic
7602 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7603 that support it. This instructs the linker to add all symbols, not
7604 only used ones, to the dynamic symbol table. This option is needed
7605 for some uses of @code{dlopen} or to allow obtaining backtraces
7606 from within a program.
7608 @item -s
7609 @opindex s
7610 Remove all symbol table and relocation information from the executable.
7612 @item -static
7613 @opindex static
7614 On systems that support dynamic linking, this prevents linking with the shared
7615 libraries.  On other systems, this option has no effect.
7617 @item -shared
7618 @opindex shared
7619 Produce a shared object which can then be linked with other objects to
7620 form an executable.  Not all systems support this option.  For predictable
7621 results, you must also specify the same set of options that were used to
7622 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7623 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7624 needs to build supplementary stub code for constructors to work.  On
7625 multi-libbed systems, @samp{gcc -shared} must select the correct support
7626 libraries to link against.  Failing to supply the correct flags may lead
7627 to subtle defects.  Supplying them in cases where they are not necessary
7628 is innocuous.}
7630 @item -shared-libgcc
7631 @itemx -static-libgcc
7632 @opindex shared-libgcc
7633 @opindex static-libgcc
7634 On systems that provide @file{libgcc} as a shared library, these options
7635 force the use of either the shared or static version respectively.
7636 If no shared version of @file{libgcc} was built when the compiler was
7637 configured, these options have no effect.
7639 There are several situations in which an application should use the
7640 shared @file{libgcc} instead of the static version.  The most common
7641 of these is when the application wishes to throw and catch exceptions
7642 across different shared libraries.  In that case, each of the libraries
7643 as well as the application itself should use the shared @file{libgcc}.
7645 Therefore, the G++ and GCJ drivers automatically add
7646 @option{-shared-libgcc} whenever you build a shared library or a main
7647 executable, because C++ and Java programs typically use exceptions, so
7648 this is the right thing to do.
7650 If, instead, you use the GCC driver to create shared libraries, you may
7651 find that they will not always be linked with the shared @file{libgcc}.
7652 If GCC finds, at its configuration time, that you have a non-GNU linker
7653 or a GNU linker that does not support option @option{--eh-frame-hdr},
7654 it will link the shared version of @file{libgcc} into shared libraries
7655 by default.  Otherwise, it will take advantage of the linker and optimize
7656 away the linking with the shared version of @file{libgcc}, linking with
7657 the static version of libgcc by default.  This allows exceptions to
7658 propagate through such shared libraries, without incurring relocation
7659 costs at library load time.
7661 However, if a library or main executable is supposed to throw or catch
7662 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7663 for the languages used in the program, or using the option
7664 @option{-shared-libgcc}, such that it is linked with the shared
7665 @file{libgcc}.
7667 @item -symbolic
7668 @opindex symbolic
7669 Bind references to global symbols when building a shared object.  Warn
7670 about any unresolved references (unless overridden by the link editor
7671 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7672 this option.
7674 @item -Xlinker @var{option}
7675 @opindex Xlinker
7676 Pass @var{option} as an option to the linker.  You can use this to
7677 supply system-specific linker options which GCC does not know how to
7678 recognize.
7680 If you want to pass an option that takes an argument, you must use
7681 @option{-Xlinker} twice, once for the option and once for the argument.
7682 For example, to pass @option{-assert definitions}, you must write
7683 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7684 @option{-Xlinker "-assert definitions"}, because this passes the entire
7685 string as a single argument, which is not what the linker expects.
7687 @item -Wl,@var{option}
7688 @opindex Wl
7689 Pass @var{option} as an option to the linker.  If @var{option} contains
7690 commas, it is split into multiple options at the commas.
7692 @item -u @var{symbol}
7693 @opindex u
7694 Pretend the symbol @var{symbol} is undefined, to force linking of
7695 library modules to define it.  You can use @option{-u} multiple times with
7696 different symbols to force loading of additional library modules.
7697 @end table
7699 @node Directory Options
7700 @section Options for Directory Search
7701 @cindex directory options
7702 @cindex options, directory search
7703 @cindex search path
7705 These options specify directories to search for header files, for
7706 libraries and for parts of the compiler:
7708 @table @gcctabopt
7709 @item -I@var{dir}
7710 @opindex I
7711 Add the directory @var{dir} to the head of the list of directories to be
7712 searched for header files.  This can be used to override a system header
7713 file, substituting your own version, since these directories are
7714 searched before the system header file directories.  However, you should
7715 not use this option to add directories that contain vendor-supplied
7716 system header files (use @option{-isystem} for that).  If you use more than
7717 one @option{-I} option, the directories are scanned in left-to-right
7718 order; the standard system directories come after.
7720 If a standard system include directory, or a directory specified with
7721 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7722 option will be ignored.  The directory will still be searched but as a
7723 system directory at its normal position in the system include chain.
7724 This is to ensure that GCC's procedure to fix buggy system headers and
7725 the ordering for the include_next directive are not inadvertently changed.
7726 If you really need to change the search order for system directories,
7727 use the @option{-nostdinc} and/or @option{-isystem} options.
7729 @item -iquote@var{dir}
7730 @opindex iquote
7731 Add the directory @var{dir} to the head of the list of directories to
7732 be searched for header files only for the case of @samp{#include
7733 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7734 otherwise just like @option{-I}.
7736 @item -L@var{dir}
7737 @opindex L
7738 Add directory @var{dir} to the list of directories to be searched
7739 for @option{-l}.
7741 @item -B@var{prefix}
7742 @opindex B
7743 This option specifies where to find the executables, libraries,
7744 include files, and data files of the compiler itself.
7746 The compiler driver program runs one or more of the subprograms
7747 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7748 @var{prefix} as a prefix for each program it tries to run, both with and
7749 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7751 For each subprogram to be run, the compiler driver first tries the
7752 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7753 was not specified, the driver tries two standard prefixes, which are
7754 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7755 those results in a file name that is found, the unmodified program
7756 name is searched for using the directories specified in your
7757 @env{PATH} environment variable.
7759 The compiler will check to see if the path provided by the @option{-B}
7760 refers to a directory, and if necessary it will add a directory
7761 separator character at the end of the path.
7763 @option{-B} prefixes that effectively specify directory names also apply
7764 to libraries in the linker, because the compiler translates these
7765 options into @option{-L} options for the linker.  They also apply to
7766 includes files in the preprocessor, because the compiler translates these
7767 options into @option{-isystem} options for the preprocessor.  In this case,
7768 the compiler appends @samp{include} to the prefix.
7770 The run-time support file @file{libgcc.a} can also be searched for using
7771 the @option{-B} prefix, if needed.  If it is not found there, the two
7772 standard prefixes above are tried, and that is all.  The file is left
7773 out of the link if it is not found by those means.
7775 Another way to specify a prefix much like the @option{-B} prefix is to use
7776 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7777 Variables}.
7779 As a special kludge, if the path provided by @option{-B} is
7780 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7781 9, then it will be replaced by @file{[dir/]include}.  This is to help
7782 with boot-strapping the compiler.
7784 @item -specs=@var{file}
7785 @opindex specs
7786 Process @var{file} after the compiler reads in the standard @file{specs}
7787 file, in order to override the defaults that the @file{gcc} driver
7788 program uses when determining what switches to pass to @file{cc1},
7789 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7790 @option{-specs=@var{file}} can be specified on the command line, and they
7791 are processed in order, from left to right.
7793 @item --sysroot=@var{dir}
7794 @opindex sysroot
7795 Use @var{dir} as the logical root directory for headers and libraries.
7796 For example, if the compiler would normally search for headers in
7797 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7798 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7800 If you use both this option and the @option{-isysroot} option, then
7801 the @option{--sysroot} option will apply to libraries, but the
7802 @option{-isysroot} option will apply to header files.
7804 The GNU linker (beginning with version 2.16) has the necessary support
7805 for this option.  If your linker does not support this option, the
7806 header file aspect of @option{--sysroot} will still work, but the
7807 library aspect will not.
7809 @item -I-
7810 @opindex I-
7811 This option has been deprecated.  Please use @option{-iquote} instead for
7812 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7813 Any directories you specify with @option{-I} options before the @option{-I-}
7814 option are searched only for the case of @samp{#include "@var{file}"};
7815 they are not searched for @samp{#include <@var{file}>}.
7817 If additional directories are specified with @option{-I} options after
7818 the @option{-I-}, these directories are searched for all @samp{#include}
7819 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7820 this way.)
7822 In addition, the @option{-I-} option inhibits the use of the current
7823 directory (where the current input file came from) as the first search
7824 directory for @samp{#include "@var{file}"}.  There is no way to
7825 override this effect of @option{-I-}.  With @option{-I.} you can specify
7826 searching the directory which was current when the compiler was
7827 invoked.  That is not exactly the same as what the preprocessor does
7828 by default, but it is often satisfactory.
7830 @option{-I-} does not inhibit the use of the standard system directories
7831 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7832 independent.
7833 @end table
7835 @c man end
7837 @node Spec Files
7838 @section Specifying subprocesses and the switches to pass to them
7839 @cindex Spec Files
7841 @command{gcc} is a driver program.  It performs its job by invoking a
7842 sequence of other programs to do the work of compiling, assembling and
7843 linking.  GCC interprets its command-line parameters and uses these to
7844 deduce which programs it should invoke, and which command-line options
7845 it ought to place on their command lines.  This behavior is controlled
7846 by @dfn{spec strings}.  In most cases there is one spec string for each
7847 program that GCC can invoke, but a few programs have multiple spec
7848 strings to control their behavior.  The spec strings built into GCC can
7849 be overridden by using the @option{-specs=} command-line switch to specify
7850 a spec file.
7852 @dfn{Spec files} are plaintext files that are used to construct spec
7853 strings.  They consist of a sequence of directives separated by blank
7854 lines.  The type of directive is determined by the first non-whitespace
7855 character on the line and it can be one of the following:
7857 @table @code
7858 @item %@var{command}
7859 Issues a @var{command} to the spec file processor.  The commands that can
7860 appear here are:
7862 @table @code
7863 @item %include <@var{file}>
7864 @cindex %include
7865 Search for @var{file} and insert its text at the current point in the
7866 specs file.
7868 @item %include_noerr <@var{file}>
7869 @cindex %include_noerr
7870 Just like @samp{%include}, but do not generate an error message if the include
7871 file cannot be found.
7873 @item %rename @var{old_name} @var{new_name}
7874 @cindex %rename
7875 Rename the spec string @var{old_name} to @var{new_name}.
7877 @end table
7879 @item *[@var{spec_name}]:
7880 This tells the compiler to create, override or delete the named spec
7881 string.  All lines after this directive up to the next directive or
7882 blank line are considered to be the text for the spec string.  If this
7883 results in an empty string then the spec will be deleted.  (Or, if the
7884 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7885 does not currently exist a new spec will be created.  If the spec does
7886 exist then its contents will be overridden by the text of this
7887 directive, unless the first character of that text is the @samp{+}
7888 character, in which case the text will be appended to the spec.
7890 @item [@var{suffix}]:
7891 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7892 and up to the next directive or blank line are considered to make up the
7893 spec string for the indicated suffix.  When the compiler encounters an
7894 input file with the named suffix, it will processes the spec string in
7895 order to work out how to compile that file.  For example:
7897 @smallexample
7898 .ZZ:
7899 z-compile -input %i
7900 @end smallexample
7902 This says that any input file whose name ends in @samp{.ZZ} should be
7903 passed to the program @samp{z-compile}, which should be invoked with the
7904 command-line switch @option{-input} and with the result of performing the
7905 @samp{%i} substitution.  (See below.)
7907 As an alternative to providing a spec string, the text that follows a
7908 suffix directive can be one of the following:
7910 @table @code
7911 @item @@@var{language}
7912 This says that the suffix is an alias for a known @var{language}.  This is
7913 similar to using the @option{-x} command-line switch to GCC to specify a
7914 language explicitly.  For example:
7916 @smallexample
7917 .ZZ:
7918 @@c++
7919 @end smallexample
7921 Says that .ZZ files are, in fact, C++ source files.
7923 @item #@var{name}
7924 This causes an error messages saying:
7926 @smallexample
7927 @var{name} compiler not installed on this system.
7928 @end smallexample
7929 @end table
7931 GCC already has an extensive list of suffixes built into it.
7932 This directive will add an entry to the end of the list of suffixes, but
7933 since the list is searched from the end backwards, it is effectively
7934 possible to override earlier entries using this technique.
7936 @end table
7938 GCC has the following spec strings built into it.  Spec files can
7939 override these strings or create their own.  Note that individual
7940 targets can also add their own spec strings to this list.
7942 @smallexample
7943 asm          Options to pass to the assembler
7944 asm_final    Options to pass to the assembler post-processor
7945 cpp          Options to pass to the C preprocessor
7946 cc1          Options to pass to the C compiler
7947 cc1plus      Options to pass to the C++ compiler
7948 endfile      Object files to include at the end of the link
7949 link         Options to pass to the linker
7950 lib          Libraries to include on the command line to the linker
7951 libgcc       Decides which GCC support library to pass to the linker
7952 linker       Sets the name of the linker
7953 predefines   Defines to be passed to the C preprocessor
7954 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7955              by default
7956 startfile    Object files to include at the start of the link
7957 @end smallexample
7959 Here is a small example of a spec file:
7961 @smallexample
7962 %rename lib                 old_lib
7964 *lib:
7965 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7966 @end smallexample
7968 This example renames the spec called @samp{lib} to @samp{old_lib} and
7969 then overrides the previous definition of @samp{lib} with a new one.
7970 The new definition adds in some extra command-line options before
7971 including the text of the old definition.
7973 @dfn{Spec strings} are a list of command-line options to be passed to their
7974 corresponding program.  In addition, the spec strings can contain
7975 @samp{%}-prefixed sequences to substitute variable text or to
7976 conditionally insert text into the command line.  Using these constructs
7977 it is possible to generate quite complex command lines.
7979 Here is a table of all defined @samp{%}-sequences for spec
7980 strings.  Note that spaces are not generated automatically around the
7981 results of expanding these sequences.  Therefore you can concatenate them
7982 together or combine them with constant text in a single argument.
7984 @table @code
7985 @item %%
7986 Substitute one @samp{%} into the program name or argument.
7988 @item %i
7989 Substitute the name of the input file being processed.
7991 @item %b
7992 Substitute the basename of the input file being processed.
7993 This is the substring up to (and not including) the last period
7994 and not including the directory.
7996 @item %B
7997 This is the same as @samp{%b}, but include the file suffix (text after
7998 the last period).
8000 @item %d
8001 Marks the argument containing or following the @samp{%d} as a
8002 temporary file name, so that that file will be deleted if GCC exits
8003 successfully.  Unlike @samp{%g}, this contributes no text to the
8004 argument.
8006 @item %g@var{suffix}
8007 Substitute a file name that has suffix @var{suffix} and is chosen
8008 once per compilation, and mark the argument in the same way as
8009 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
8010 name is now chosen in a way that is hard to predict even when previously
8011 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
8012 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
8013 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
8014 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
8015 was simply substituted with a file name chosen once per compilation,
8016 without regard to any appended suffix (which was therefore treated
8017 just like ordinary text), making such attacks more likely to succeed.
8019 @item %u@var{suffix}
8020 Like @samp{%g}, but generates a new temporary file name even if
8021 @samp{%u@var{suffix}} was already seen.
8023 @item %U@var{suffix}
8024 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
8025 new one if there is no such last file name.  In the absence of any
8026 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
8027 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
8028 would involve the generation of two distinct file names, one
8029 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
8030 simply substituted with a file name chosen for the previous @samp{%u},
8031 without regard to any appended suffix.
8033 @item %j@var{suffix}
8034 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
8035 writable, and if save-temps is off; otherwise, substitute the name
8036 of a temporary file, just like @samp{%u}.  This temporary file is not
8037 meant for communication between processes, but rather as a junk
8038 disposal mechanism.
8040 @item %|@var{suffix}
8041 @itemx %m@var{suffix}
8042 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
8043 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
8044 all.  These are the two most common ways to instruct a program that it
8045 should read from standard input or write to standard output.  If you
8046 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
8047 construct: see for example @file{f/lang-specs.h}.
8049 @item %.@var{SUFFIX}
8050 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
8051 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
8052 terminated by the next space or %.
8054 @item %w
8055 Marks the argument containing or following the @samp{%w} as the
8056 designated output file of this compilation.  This puts the argument
8057 into the sequence of arguments that @samp{%o} will substitute later.
8059 @item %o
8060 Substitutes the names of all the output files, with spaces
8061 automatically placed around them.  You should write spaces
8062 around the @samp{%o} as well or the results are undefined.
8063 @samp{%o} is for use in the specs for running the linker.
8064 Input files whose names have no recognized suffix are not compiled
8065 at all, but they are included among the output files, so they will
8066 be linked.
8068 @item %O
8069 Substitutes the suffix for object files.  Note that this is
8070 handled specially when it immediately follows @samp{%g, %u, or %U},
8071 because of the need for those to form complete file names.  The
8072 handling is such that @samp{%O} is treated exactly as if it had already
8073 been substituted, except that @samp{%g, %u, and %U} do not currently
8074 support additional @var{suffix} characters following @samp{%O} as they would
8075 following, for example, @samp{.o}.
8077 @item %p
8078 Substitutes the standard macro predefinitions for the
8079 current target machine.  Use this when running @code{cpp}.
8081 @item %P
8082 Like @samp{%p}, but puts @samp{__} before and after the name of each
8083 predefined macro, except for macros that start with @samp{__} or with
8084 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8087 @item %I
8088 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8089 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8090 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8091 and @option{-imultilib} as necessary.
8093 @item %s
8094 Current argument is the name of a library or startup file of some sort.
8095 Search for that file in a standard list of directories and substitute
8096 the full name found.
8098 @item %e@var{str}
8099 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8100 Use this when inconsistent options are detected.
8102 @item %(@var{name})
8103 Substitute the contents of spec string @var{name} at this point.
8105 @item %[@var{name}]
8106 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8108 @item %x@{@var{option}@}
8109 Accumulate an option for @samp{%X}.
8111 @item %X
8112 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8113 spec string.
8115 @item %Y
8116 Output the accumulated assembler options specified by @option{-Wa}.
8118 @item %Z
8119 Output the accumulated preprocessor options specified by @option{-Wp}.
8121 @item %a
8122 Process the @code{asm} spec.  This is used to compute the
8123 switches to be passed to the assembler.
8125 @item %A
8126 Process the @code{asm_final} spec.  This is a spec string for
8127 passing switches to an assembler post-processor, if such a program is
8128 needed.
8130 @item %l
8131 Process the @code{link} spec.  This is the spec for computing the
8132 command line passed to the linker.  Typically it will make use of the
8133 @samp{%L %G %S %D and %E} sequences.
8135 @item %D
8136 Dump out a @option{-L} option for each directory that GCC believes might
8137 contain startup files.  If the target supports multilibs then the
8138 current multilib directory will be prepended to each of these paths.
8140 @item %L
8141 Process the @code{lib} spec.  This is a spec string for deciding which
8142 libraries should be included on the command line to the linker.
8144 @item %G
8145 Process the @code{libgcc} spec.  This is a spec string for deciding
8146 which GCC support library should be included on the command line to the linker.
8148 @item %S
8149 Process the @code{startfile} spec.  This is a spec for deciding which
8150 object files should be the first ones passed to the linker.  Typically
8151 this might be a file named @file{crt0.o}.
8153 @item %E
8154 Process the @code{endfile} spec.  This is a spec string that specifies
8155 the last object files that will be passed to the linker.
8157 @item %C
8158 Process the @code{cpp} spec.  This is used to construct the arguments
8159 to be passed to the C preprocessor.
8161 @item %1
8162 Process the @code{cc1} spec.  This is used to construct the options to be
8163 passed to the actual C compiler (@samp{cc1}).
8165 @item %2
8166 Process the @code{cc1plus} spec.  This is used to construct the options to be
8167 passed to the actual C++ compiler (@samp{cc1plus}).
8169 @item %*
8170 Substitute the variable part of a matched option.  See below.
8171 Note that each comma in the substituted string is replaced by
8172 a single space.
8174 @item %<@code{S}
8175 Remove all occurrences of @code{-S} from the command line.  Note---this
8176 command is position dependent.  @samp{%} commands in the spec string
8177 before this one will see @code{-S}, @samp{%} commands in the spec string
8178 after this one will not.
8180 @item %:@var{function}(@var{args})
8181 Call the named function @var{function}, passing it @var{args}.
8182 @var{args} is first processed as a nested spec string, then split
8183 into an argument vector in the usual fashion.  The function returns
8184 a string which is processed as if it had appeared literally as part
8185 of the current spec.
8187 The following built-in spec functions are provided:
8189 @table @code
8190 @item @code{getenv}
8191 The @code{getenv} spec function takes two arguments: an environment
8192 variable name and a string.  If the environment variable is not
8193 defined, a fatal error is issued.  Otherwise, the return value is the
8194 value of the environment variable concatenated with the string.  For
8195 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8197 @smallexample
8198 %:getenv(TOPDIR /include)
8199 @end smallexample
8201 expands to @file{/path/to/top/include}.
8203 @item @code{if-exists}
8204 The @code{if-exists} spec function takes one argument, an absolute
8205 pathname to a file.  If the file exists, @code{if-exists} returns the
8206 pathname.  Here is a small example of its usage:
8208 @smallexample
8209 *startfile:
8210 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8211 @end smallexample
8213 @item @code{if-exists-else}
8214 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8215 spec function, except that it takes two arguments.  The first argument is
8216 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8217 returns the pathname.  If it does not exist, it returns the second argument.
8218 This way, @code{if-exists-else} can be used to select one file or another,
8219 based on the existence of the first.  Here is a small example of its usage:
8221 @smallexample
8222 *startfile:
8223 crt0%O%s %:if-exists(crti%O%s) \
8224 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8225 @end smallexample
8227 @item @code{replace-outfile}
8228 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8229 first argument in the outfiles array and replaces it with the second argument.  Here
8230 is a small example of its usage:
8232 @smallexample
8233 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8234 @end smallexample
8236 @item @code{print-asm-header}
8237 The @code{print-asm-header} function takes no arguments and simply
8238 prints a banner like:
8240 @smallexample
8241 Assembler options
8242 =================
8244 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8245 @end smallexample
8247 It is used to separate compiler options from assembler options
8248 in the @option{--target-help} output.
8249 @end table
8251 @item %@{@code{S}@}
8252 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8253 If that switch was not specified, this substitutes nothing.  Note that
8254 the leading dash is omitted when specifying this option, and it is
8255 automatically inserted if the substitution is performed.  Thus the spec
8256 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8257 and would output the command line option @option{-foo}.
8259 @item %W@{@code{S}@}
8260 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8261 deleted on failure.
8263 @item %@{@code{S}*@}
8264 Substitutes all the switches specified to GCC whose names start
8265 with @code{-S}, but which also take an argument.  This is used for
8266 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8267 GCC considers @option{-o foo} as being
8268 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8269 text, including the space.  Thus two arguments would be generated.
8271 @item %@{@code{S}*&@code{T}*@}
8272 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8273 (the order of @code{S} and @code{T} in the spec is not significant).
8274 There can be any number of ampersand-separated variables; for each the
8275 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8277 @item %@{@code{S}:@code{X}@}
8278 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8280 @item %@{!@code{S}:@code{X}@}
8281 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8283 @item %@{@code{S}*:@code{X}@}
8284 Substitutes @code{X} if one or more switches whose names start with
8285 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8286 once, no matter how many such switches appeared.  However, if @code{%*}
8287 appears somewhere in @code{X}, then @code{X} will be substituted once
8288 for each matching switch, with the @code{%*} replaced by the part of
8289 that switch that matched the @code{*}.
8291 @item %@{.@code{S}:@code{X}@}
8292 Substitutes @code{X}, if processing a file with suffix @code{S}.
8294 @item %@{!.@code{S}:@code{X}@}
8295 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8297 @item %@{,@code{S}:@code{X}@}
8298 Substitutes @code{X}, if processing a file for language @code{S}.
8300 @item %@{!,@code{S}:@code{X}@}
8301 Substitutes @code{X}, if not processing a file for language @code{S}.
8303 @item %@{@code{S}|@code{P}:@code{X}@}
8304 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8305 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8306 @code{*} sequences as well, although they have a stronger binding than
8307 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8308 alternatives must be starred, and only the first matching alternative
8309 is substituted.
8311 For example, a spec string like this:
8313 @smallexample
8314 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8315 @end smallexample
8317 will output the following command-line options from the following input
8318 command-line options:
8320 @smallexample
8321 fred.c        -foo -baz
8322 jim.d         -bar -boggle
8323 -d fred.c     -foo -baz -boggle
8324 -d jim.d      -bar -baz -boggle
8325 @end smallexample
8327 @item %@{S:X; T:Y; :D@}
8329 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8330 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8331 be as many clauses as you need.  This may be combined with @code{.},
8332 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8335 @end table
8337 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8338 construct may contain other nested @samp{%} constructs or spaces, or
8339 even newlines.  They are processed as usual, as described above.
8340 Trailing white space in @code{X} is ignored.  White space may also
8341 appear anywhere on the left side of the colon in these constructs,
8342 except between @code{.} or @code{*} and the corresponding word.
8344 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8345 handled specifically in these constructs.  If another value of
8346 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8347 @option{-W} switch is found later in the command line, the earlier
8348 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8349 just one letter, which passes all matching options.
8351 The character @samp{|} at the beginning of the predicate text is used to
8352 indicate that a command should be piped to the following command, but
8353 only if @option{-pipe} is specified.
8355 It is built into GCC which switches take arguments and which do not.
8356 (You might think it would be useful to generalize this to allow each
8357 compiler's spec to say which switches take arguments.  But this cannot
8358 be done in a consistent fashion.  GCC cannot even decide which input
8359 files have been specified without knowing which switches take arguments,
8360 and it must know which input files to compile in order to tell which
8361 compilers to run).
8363 GCC also knows implicitly that arguments starting in @option{-l} are to be
8364 treated as compiler output files, and passed to the linker in their
8365 proper position among the other output files.
8367 @c man begin OPTIONS
8369 @node Target Options
8370 @section Specifying Target Machine and Compiler Version
8371 @cindex target options
8372 @cindex cross compiling
8373 @cindex specifying machine version
8374 @cindex specifying compiler version and target machine
8375 @cindex compiler version, specifying
8376 @cindex target machine, specifying
8378 The usual way to run GCC is to run the executable called @file{gcc}, or
8379 @file{<machine>-gcc} when cross-compiling, or
8380 @file{<machine>-gcc-<version>} to run a version other than the one that
8381 was installed last.  Sometimes this is inconvenient, so GCC provides
8382 options that will switch to another cross-compiler or version.
8384 @table @gcctabopt
8385 @item -b @var{machine}
8386 @opindex b
8387 The argument @var{machine} specifies the target machine for compilation.
8389 The value to use for @var{machine} is the same as was specified as the
8390 machine type when configuring GCC as a cross-compiler.  For
8391 example, if a cross-compiler was configured with @samp{configure
8392 arm-elf}, meaning to compile for an arm processor with elf binaries,
8393 then you would specify @option{-b arm-elf} to run that cross compiler.
8394 Because there are other options beginning with @option{-b}, the
8395 configuration must contain a hyphen.
8397 @item -V @var{version}
8398 @opindex V
8399 The argument @var{version} specifies which version of GCC to run.
8400 This is useful when multiple versions are installed.  For example,
8401 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8402 @end table
8404 The @option{-V} and @option{-b} options work by running the
8405 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8406 use them if you can just run that directly.
8408 @node Submodel Options
8409 @section Hardware Models and Configurations
8410 @cindex submodel options
8411 @cindex specifying hardware config
8412 @cindex hardware models and configurations, specifying
8413 @cindex machine dependent options
8415 Earlier we discussed the standard option @option{-b} which chooses among
8416 different installed compilers for completely different target
8417 machines, such as VAX vs.@: 68000 vs.@: 80386.
8419 In addition, each of these target machine types can have its own
8420 special options, starting with @samp{-m}, to choose among various
8421 hardware models or configurations---for example, 68010 vs 68020,
8422 floating coprocessor or none.  A single installed version of the
8423 compiler can compile for any model or configuration, according to the
8424 options specified.
8426 Some configurations of the compiler also support additional special
8427 options, usually for compatibility with other compilers on the same
8428 platform.
8430 @c This list is ordered alphanumerically by subsection name.
8431 @c It should be the same order and spelling as these options are listed
8432 @c in Machine Dependent Options
8434 @menu
8435 * ARC Options::
8436 * ARM Options::
8437 * AVR Options::
8438 * Blackfin Options::
8439 * CRIS Options::
8440 * CRX Options::
8441 * Darwin Options::
8442 * DEC Alpha Options::
8443 * DEC Alpha/VMS Options::
8444 * FRV Options::
8445 * GNU/Linux Options::
8446 * H8/300 Options::
8447 * HPPA Options::
8448 * i386 and x86-64 Options::
8449 * IA-64 Options::
8450 * M32C Options::
8451 * M32R/D Options::
8452 * M680x0 Options::
8453 * M68hc1x Options::
8454 * MCore Options::
8455 * MIPS Options::
8456 * MMIX Options::
8457 * MN10300 Options::
8458 * MT Options::
8459 * PDP-11 Options::
8460 * PowerPC Options::
8461 * RS/6000 and PowerPC Options::
8462 * S/390 and zSeries Options::
8463 * Score Options::
8464 * SH Options::
8465 * SPARC Options::
8466 * SPU Options::
8467 * System V Options::
8468 * V850 Options::
8469 * VAX Options::
8470 * VxWorks Options::
8471 * x86-64 Options::
8472 * Xstormy16 Options::
8473 * Xtensa Options::
8474 * zSeries Options::
8475 @end menu
8477 @node ARC Options
8478 @subsection ARC Options
8479 @cindex ARC Options
8481 These options are defined for ARC implementations:
8483 @table @gcctabopt
8484 @item -EL
8485 @opindex EL
8486 Compile code for little endian mode.  This is the default.
8488 @item -EB
8489 @opindex EB
8490 Compile code for big endian mode.
8492 @item -mmangle-cpu
8493 @opindex mmangle-cpu
8494 Prepend the name of the cpu to all public symbol names.
8495 In multiple-processor systems, there are many ARC variants with different
8496 instruction and register set characteristics.  This flag prevents code
8497 compiled for one cpu to be linked with code compiled for another.
8498 No facility exists for handling variants that are ``almost identical''.
8499 This is an all or nothing option.
8501 @item -mcpu=@var{cpu}
8502 @opindex mcpu
8503 Compile code for ARC variant @var{cpu}.
8504 Which variants are supported depend on the configuration.
8505 All variants support @option{-mcpu=base}, this is the default.
8507 @item -mtext=@var{text-section}
8508 @itemx -mdata=@var{data-section}
8509 @itemx -mrodata=@var{readonly-data-section}
8510 @opindex mtext
8511 @opindex mdata
8512 @opindex mrodata
8513 Put functions, data, and readonly data in @var{text-section},
8514 @var{data-section}, and @var{readonly-data-section} respectively
8515 by default.  This can be overridden with the @code{section} attribute.
8516 @xref{Variable Attributes}.
8518 @end table
8520 @node ARM Options
8521 @subsection ARM Options
8522 @cindex ARM options
8524 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8525 architectures:
8527 @table @gcctabopt
8528 @item -mabi=@var{name}
8529 @opindex mabi
8530 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8531 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8533 @item -mapcs-frame
8534 @opindex mapcs-frame
8535 Generate a stack frame that is compliant with the ARM Procedure Call
8536 Standard for all functions, even if this is not strictly necessary for
8537 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8538 with this option will cause the stack frames not to be generated for
8539 leaf functions.  The default is @option{-mno-apcs-frame}.
8541 @item -mapcs
8542 @opindex mapcs
8543 This is a synonym for @option{-mapcs-frame}.
8545 @ignore
8546 @c not currently implemented
8547 @item -mapcs-stack-check
8548 @opindex mapcs-stack-check
8549 Generate code to check the amount of stack space available upon entry to
8550 every function (that actually uses some stack space).  If there is
8551 insufficient space available then either the function
8552 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8553 called, depending upon the amount of stack space required.  The run time
8554 system is required to provide these functions.  The default is
8555 @option{-mno-apcs-stack-check}, since this produces smaller code.
8557 @c not currently implemented
8558 @item -mapcs-float
8559 @opindex mapcs-float
8560 Pass floating point arguments using the float point registers.  This is
8561 one of the variants of the APCS@.  This option is recommended if the
8562 target hardware has a floating point unit or if a lot of floating point
8563 arithmetic is going to be performed by the code.  The default is
8564 @option{-mno-apcs-float}, since integer only code is slightly increased in
8565 size if @option{-mapcs-float} is used.
8567 @c not currently implemented
8568 @item -mapcs-reentrant
8569 @opindex mapcs-reentrant
8570 Generate reentrant, position independent code.  The default is
8571 @option{-mno-apcs-reentrant}.
8572 @end ignore
8574 @item -mthumb-interwork
8575 @opindex mthumb-interwork
8576 Generate code which supports calling between the ARM and Thumb
8577 instruction sets.  Without this option the two instruction sets cannot
8578 be reliably used inside one program.  The default is
8579 @option{-mno-thumb-interwork}, since slightly larger code is generated
8580 when @option{-mthumb-interwork} is specified.
8582 @item -mno-sched-prolog
8583 @opindex mno-sched-prolog
8584 Prevent the reordering of instructions in the function prolog, or the
8585 merging of those instruction with the instructions in the function's
8586 body.  This means that all functions will start with a recognizable set
8587 of instructions (or in fact one of a choice from a small set of
8588 different function prologues), and this information can be used to
8589 locate the start if functions inside an executable piece of code.  The
8590 default is @option{-msched-prolog}.
8592 @item -mhard-float
8593 @opindex mhard-float
8594 Generate output containing floating point instructions.  This is the
8595 default.
8597 @item -msoft-float
8598 @opindex msoft-float
8599 Generate output containing library calls for floating point.
8600 @strong{Warning:} the requisite libraries are not available for all ARM
8601 targets.  Normally the facilities of the machine's usual C compiler are
8602 used, but this cannot be done directly in cross-compilation.  You must make
8603 your own arrangements to provide suitable library functions for
8604 cross-compilation.
8606 @option{-msoft-float} changes the calling convention in the output file;
8607 therefore, it is only useful if you compile @emph{all} of a program with
8608 this option.  In particular, you need to compile @file{libgcc.a}, the
8609 library that comes with GCC, with @option{-msoft-float} in order for
8610 this to work.
8612 @item -mfloat-abi=@var{name}
8613 @opindex mfloat-abi
8614 Specifies which ABI to use for floating point values.  Permissible values
8615 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8617 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8618 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8619 of floating point instructions, but still uses the soft-float calling
8620 conventions.
8622 @item -mlittle-endian
8623 @opindex mlittle-endian
8624 Generate code for a processor running in little-endian mode.  This is
8625 the default for all standard configurations.
8627 @item -mbig-endian
8628 @opindex mbig-endian
8629 Generate code for a processor running in big-endian mode; the default is
8630 to compile code for a little-endian processor.
8632 @item -mwords-little-endian
8633 @opindex mwords-little-endian
8634 This option only applies when generating code for big-endian processors.
8635 Generate code for a little-endian word order but a big-endian byte
8636 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8637 option should only be used if you require compatibility with code for
8638 big-endian ARM processors generated by versions of the compiler prior to
8639 2.8.
8641 @item -mcpu=@var{name}
8642 @opindex mcpu
8643 This specifies the name of the target ARM processor.  GCC uses this name
8644 to determine what kind of instructions it can emit when generating
8645 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8646 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8647 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8648 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8649 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8650 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8651 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8652 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8653 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8654 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8655 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8656 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8657 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8658 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8659 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8660 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8662 @item -mtune=@var{name}
8663 @opindex mtune
8664 This option is very similar to the @option{-mcpu=} option, except that
8665 instead of specifying the actual target processor type, and hence
8666 restricting which instructions can be used, it specifies that GCC should
8667 tune the performance of the code as if the target were of the type
8668 specified in this option, but still choosing the instructions that it
8669 will generate based on the cpu specified by a @option{-mcpu=} option.
8670 For some ARM implementations better performance can be obtained by using
8671 this option.
8673 @item -march=@var{name}
8674 @opindex march
8675 This specifies the name of the target ARM architecture.  GCC uses this
8676 name to determine what kind of instructions it can emit when generating
8677 assembly code.  This option can be used in conjunction with or instead
8678 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8679 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8680 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8681 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8682 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8683 @samp{iwmmxt}, @samp{ep9312}.
8685 @item -mfpu=@var{name}
8686 @itemx -mfpe=@var{number}
8687 @itemx -mfp=@var{number}
8688 @opindex mfpu
8689 @opindex mfpe
8690 @opindex mfp
8691 This specifies what floating point hardware (or hardware emulation) is
8692 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8693 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8694 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8695 with older versions of GCC@.
8697 If @option{-msoft-float} is specified this specifies the format of
8698 floating point values.
8700 @item -mstructure-size-boundary=@var{n}
8701 @opindex mstructure-size-boundary
8702 The size of all structures and unions will be rounded up to a multiple
8703 of the number of bits set by this option.  Permissible values are 8, 32
8704 and 64.  The default value varies for different toolchains.  For the COFF
8705 targeted toolchain the default value is 8.  A value of 64 is only allowed
8706 if the underlying ABI supports it.
8708 Specifying the larger number can produce faster, more efficient code, but
8709 can also increase the size of the program.  Different values are potentially
8710 incompatible.  Code compiled with one value cannot necessarily expect to
8711 work with code or libraries compiled with another value, if they exchange
8712 information using structures or unions.
8714 @item -mabort-on-noreturn
8715 @opindex mabort-on-noreturn
8716 Generate a call to the function @code{abort} at the end of a
8717 @code{noreturn} function.  It will be executed if the function tries to
8718 return.
8720 @item -mlong-calls
8721 @itemx -mno-long-calls
8722 @opindex mlong-calls
8723 @opindex mno-long-calls
8724 Tells the compiler to perform function calls by first loading the
8725 address of the function into a register and then performing a subroutine
8726 call on this register.  This switch is needed if the target function
8727 will lie outside of the 64 megabyte addressing range of the offset based
8728 version of subroutine call instruction.
8730 Even if this switch is enabled, not all function calls will be turned
8731 into long calls.  The heuristic is that static functions, functions
8732 which have the @samp{short-call} attribute, functions that are inside
8733 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8734 definitions have already been compiled within the current compilation
8735 unit, will not be turned into long calls.  The exception to this rule is
8736 that weak function definitions, functions with the @samp{long-call}
8737 attribute or the @samp{section} attribute, and functions that are within
8738 the scope of a @samp{#pragma long_calls} directive, will always be
8739 turned into long calls.
8741 This feature is not enabled by default.  Specifying
8742 @option{-mno-long-calls} will restore the default behavior, as will
8743 placing the function calls within the scope of a @samp{#pragma
8744 long_calls_off} directive.  Note these switches have no effect on how
8745 the compiler generates code to handle function calls via function
8746 pointers.
8748 @item -mnop-fun-dllimport
8749 @opindex mnop-fun-dllimport
8750 Disable support for the @code{dllimport} attribute.
8752 @item -msingle-pic-base
8753 @opindex msingle-pic-base
8754 Treat the register used for PIC addressing as read-only, rather than
8755 loading it in the prologue for each function.  The run-time system is
8756 responsible for initializing this register with an appropriate value
8757 before execution begins.
8759 @item -mpic-register=@var{reg}
8760 @opindex mpic-register
8761 Specify the register to be used for PIC addressing.  The default is R10
8762 unless stack-checking is enabled, when R9 is used.
8764 @item -mcirrus-fix-invalid-insns
8765 @opindex mcirrus-fix-invalid-insns
8766 @opindex mno-cirrus-fix-invalid-insns
8767 Insert NOPs into the instruction stream to in order to work around
8768 problems with invalid Maverick instruction combinations.  This option
8769 is only valid if the @option{-mcpu=ep9312} option has been used to
8770 enable generation of instructions for the Cirrus Maverick floating
8771 point co-processor.  This option is not enabled by default, since the
8772 problem is only present in older Maverick implementations.  The default
8773 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8774 switch.
8776 @item -mpoke-function-name
8777 @opindex mpoke-function-name
8778 Write the name of each function into the text section, directly
8779 preceding the function prologue.  The generated code is similar to this:
8781 @smallexample
8782      t0
8783          .ascii "arm_poke_function_name", 0
8784          .align
8785      t1
8786          .word 0xff000000 + (t1 - t0)
8787      arm_poke_function_name
8788          mov     ip, sp
8789          stmfd   sp!, @{fp, ip, lr, pc@}
8790          sub     fp, ip, #4
8791 @end smallexample
8793 When performing a stack backtrace, code can inspect the value of
8794 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8795 location @code{pc - 12} and the top 8 bits are set, then we know that
8796 there is a function name embedded immediately preceding this location
8797 and has length @code{((pc[-3]) & 0xff000000)}.
8799 @item -mthumb
8800 @opindex mthumb
8801 Generate code for the Thumb instruction set.  The default is to
8802 use the 32-bit ARM instruction set.
8803 This option automatically enables either 16-bit Thumb-1 or
8804 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8805 and @option{-march=@var{name}} options.
8807 @item -mtpcs-frame
8808 @opindex mtpcs-frame
8809 Generate a stack frame that is compliant with the Thumb Procedure Call
8810 Standard for all non-leaf functions.  (A leaf function is one that does
8811 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8813 @item -mtpcs-leaf-frame
8814 @opindex mtpcs-leaf-frame
8815 Generate a stack frame that is compliant with the Thumb Procedure Call
8816 Standard for all leaf functions.  (A leaf function is one that does
8817 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8819 @item -mcallee-super-interworking
8820 @opindex mcallee-super-interworking
8821 Gives all externally visible functions in the file being compiled an ARM
8822 instruction set header which switches to Thumb mode before executing the
8823 rest of the function.  This allows these functions to be called from
8824 non-interworking code.
8826 @item -mcaller-super-interworking
8827 @opindex mcaller-super-interworking
8828 Allows calls via function pointers (including virtual functions) to
8829 execute correctly regardless of whether the target code has been
8830 compiled for interworking or not.  There is a small overhead in the cost
8831 of executing a function pointer if this option is enabled.
8833 @item -mtp=@var{name}
8834 @opindex mtp
8835 Specify the access model for the thread local storage pointer.  The valid
8836 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8837 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8838 (supported in the arm6k architecture), and @option{auto}, which uses the
8839 best available method for the selected processor.  The default setting is
8840 @option{auto}.
8842 @end table
8844 @node AVR Options
8845 @subsection AVR Options
8846 @cindex AVR Options
8848 These options are defined for AVR implementations:
8850 @table @gcctabopt
8851 @item -mmcu=@var{mcu}
8852 @opindex mmcu
8853 Specify ATMEL AVR instruction set or MCU type.
8855 Instruction set avr1 is for the minimal AVR core, not supported by the C
8856 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8857 attiny11, attiny12, attiny15, attiny28).
8859 Instruction set avr2 (default) is for the classic AVR core with up to
8860 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8861 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8862 at90c8534, at90s8535).
8864 Instruction set avr3 is for the classic AVR core with up to 128K program
8865 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8867 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8868 memory space (MCU types: atmega8, atmega83, atmega85).
8870 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8871 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8872 atmega64, atmega128, at43usb355, at94k).
8874 @item -msize
8875 @opindex msize
8876 Output instruction sizes to the asm file.
8878 @item -minit-stack=@var{N}
8879 @opindex minit-stack
8880 Specify the initial stack address, which may be a symbol or numeric value,
8881 @samp{__stack} is the default.
8883 @item -mno-interrupts
8884 @opindex mno-interrupts
8885 Generated code is not compatible with hardware interrupts.
8886 Code size will be smaller.
8888 @item -mcall-prologues
8889 @opindex mcall-prologues
8890 Functions prologues/epilogues expanded as call to appropriate
8891 subroutines.  Code size will be smaller.
8893 @item -mno-tablejump
8894 @opindex mno-tablejump
8895 Do not generate tablejump insns which sometimes increase code size.
8897 @item -mtiny-stack
8898 @opindex mtiny-stack
8899 Change only the low 8 bits of the stack pointer.
8901 @item -mint8
8902 @opindex mint8
8903 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8904 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8905 and long long will be 4 bytes.  Please note that this option does not
8906 comply to the C standards, but it will provide you with smaller code
8907 size.
8908 @end table
8910 @node Blackfin Options
8911 @subsection Blackfin Options
8912 @cindex Blackfin Options
8914 @table @gcctabopt
8915 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8916 @opindex mcpu=
8917 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8918 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8919 @samp{bf525}, @samp{bf526}, @samp{bf527},
8920 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8921 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8922 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8923 @samp{bf561}.
8924 The optional @var{sirevision} specifies the silicon revision of the target
8925 Blackfin processor.  Any workarounds available for the targeted silicon revision
8926 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8927 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8928 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8929 hexadecimal digits representing the major and minor numbers in the silicon
8930 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8931 is not defined.  If @var{sirevision} is @samp{any}, the
8932 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8933 If this optional @var{sirevision} is not used, GCC assumes the latest known
8934 silicon revision of the targeted Blackfin processor.
8936 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8937 Only the processor macro is defined.
8938 Without this option, @samp{bf532} is used as the processor by default.
8939 The corresponding predefined processor macros for @var{cpu} is to
8940 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8941 provided by libgloss to be linked in if @option{-msim} is not given.
8943 @item -msim
8944 @opindex msim
8945 Specifies that the program will be run on the simulator.  This causes
8946 the simulator BSP provided by libgloss to be linked in.  This option
8947 has effect only for @samp{bfin-elf} toolchain.
8948 Certain other options, such as @option{-mid-shared-library} and
8949 @option{-mfdpic}, imply @option{-msim}.
8951 @item -momit-leaf-frame-pointer
8952 @opindex momit-leaf-frame-pointer
8953 Don't keep the frame pointer in a register for leaf functions.  This
8954 avoids the instructions to save, set up and restore frame pointers and
8955 makes an extra register available in leaf functions.  The option
8956 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8957 which might make debugging harder.
8959 @item -mspecld-anomaly
8960 @opindex mspecld-anomaly
8961 When enabled, the compiler will ensure that the generated code does not
8962 contain speculative loads after jump instructions. If this option is used,
8963 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8965 @item -mno-specld-anomaly
8966 @opindex mno-specld-anomaly
8967 Don't generate extra code to prevent speculative loads from occurring.
8969 @item -mcsync-anomaly
8970 @opindex mcsync-anomaly
8971 When enabled, the compiler will ensure that the generated code does not
8972 contain CSYNC or SSYNC instructions too soon after conditional branches.
8973 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8975 @item -mno-csync-anomaly
8976 @opindex mno-csync-anomaly
8977 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8978 occurring too soon after a conditional branch.
8980 @item -mlow-64k
8981 @opindex mlow-64k
8982 When enabled, the compiler is free to take advantage of the knowledge that
8983 the entire program fits into the low 64k of memory.
8985 @item -mno-low-64k
8986 @opindex mno-low-64k
8987 Assume that the program is arbitrarily large.  This is the default.
8989 @item -mstack-check-l1
8990 @opindex mstack-check-l1
8991 Do stack checking using information placed into L1 scratchpad memory by the
8992 uClinux kernel.
8994 @item -mid-shared-library
8995 @opindex mid-shared-library
8996 Generate code that supports shared libraries via the library ID method.
8997 This allows for execute in place and shared libraries in an environment
8998 without virtual memory management.  This option implies @option{-fPIC}.
8999 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9001 @item -mno-id-shared-library
9002 @opindex mno-id-shared-library
9003 Generate code that doesn't assume ID based shared libraries are being used.
9004 This is the default.
9006 @item -mleaf-id-shared-library
9007 @opindex mleaf-id-shared-library
9008 Generate code that supports shared libraries via the library ID method,
9009 but assumes that this library or executable won't link against any other
9010 ID shared libraries.  That allows the compiler to use faster code for jumps
9011 and calls.
9013 @item -mno-leaf-id-shared-library
9014 @opindex mno-leaf-id-shared-library
9015 Do not assume that the code being compiled won't link against any ID shared
9016 libraries.  Slower code will be generated for jump and call insns.
9018 @item -mshared-library-id=n
9019 @opindex mshared-library-id
9020 Specified the identification number of the ID based shared library being
9021 compiled.  Specifying a value of 0 will generate more compact code, specifying
9022 other values will force the allocation of that number to the current
9023 library but is no more space or time efficient than omitting this option.
9025 @item -msep-data
9026 @opindex msep-data
9027 Generate code that allows the data segment to be located in a different
9028 area of memory from the text segment.  This allows for execute in place in
9029 an environment without virtual memory management by eliminating relocations
9030 against the text section.
9032 @item -mno-sep-data
9033 @opindex mno-sep-data
9034 Generate code that assumes that the data segment follows the text segment.
9035 This is the default.
9037 @item -mlong-calls
9038 @itemx -mno-long-calls
9039 @opindex mlong-calls
9040 @opindex mno-long-calls
9041 Tells the compiler to perform function calls by first loading the
9042 address of the function into a register and then performing a subroutine
9043 call on this register.  This switch is needed if the target function
9044 will lie outside of the 24 bit addressing range of the offset based
9045 version of subroutine call instruction.
9047 This feature is not enabled by default.  Specifying
9048 @option{-mno-long-calls} will restore the default behavior.  Note these
9049 switches have no effect on how the compiler generates code to handle
9050 function calls via function pointers.
9052 @item -mfast-fp
9053 @opindex mfast-fp
9054 Link with the fast floating-point library. This library relaxes some of
9055 the IEEE floating-point standard's rules for checking inputs against
9056 Not-a-Number (NAN), in the interest of performance.
9058 @item -minline-plt
9059 @opindex minline-plt
9060 Enable inlining of PLT entries in function calls to functions that are
9061 not known to bind locally.  It has no effect without @option{-mfdpic}.
9063 @item -mmulticore
9064 @opindex mmulticore
9065 Build standalone application for multicore Blackfin processor. Proper
9066 start files and link scripts will be used to support multicore.
9067 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9068 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9069 @option{-mcorea} or @option{-mcoreb}. If it's used without
9070 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9071 programming model is used. In this model, the main function of Core B
9072 should be named as coreb_main. If it's used with @option{-mcorea} or
9073 @option{-mcoreb}, one application per core programming model is used.
9074 If this option is not used, single core application programming
9075 model is used.
9077 @item -mcorea
9078 @opindex mcorea
9079 Build standalone application for Core A of BF561 when using
9080 one application per core programming model. Proper start files
9081 and link scripts will be used to support Core A. This option
9082 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9084 @item -mcoreb
9085 @opindex mcoreb
9086 Build standalone application for Core B of BF561 when using
9087 one application per core programming model. Proper start files
9088 and link scripts will be used to support Core B. This option
9089 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9090 should be used instead of main. It must be used with
9091 @option{-mmulticore}. 
9093 @item -msdram
9094 @opindex msdram
9095 Build standalone application for SDRAM. Proper start files and
9096 link scripts will be used to put the application into SDRAM.
9097 Loader should initialize SDRAM before loading the application
9098 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9099 @end table
9100   
9101 @node CRIS Options
9102 @subsection CRIS Options
9103 @cindex CRIS Options
9105 These options are defined specifically for the CRIS ports.
9107 @table @gcctabopt
9108 @item -march=@var{architecture-type}
9109 @itemx -mcpu=@var{architecture-type}
9110 @opindex march
9111 @opindex mcpu
9112 Generate code for the specified architecture.  The choices for
9113 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9114 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9115 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9116 @samp{v10}.
9118 @item -mtune=@var{architecture-type}
9119 @opindex mtune
9120 Tune to @var{architecture-type} everything applicable about the generated
9121 code, except for the ABI and the set of available instructions.  The
9122 choices for @var{architecture-type} are the same as for
9123 @option{-march=@var{architecture-type}}.
9125 @item -mmax-stack-frame=@var{n}
9126 @opindex mmax-stack-frame
9127 Warn when the stack frame of a function exceeds @var{n} bytes.
9129 @item -melinux-stacksize=@var{n}
9130 @opindex melinux-stacksize
9131 Only available with the @samp{cris-axis-aout} target.  Arranges for
9132 indications in the program to the kernel loader that the stack of the
9133 program should be set to @var{n} bytes.
9135 @item -metrax4
9136 @itemx -metrax100
9137 @opindex metrax4
9138 @opindex metrax100
9139 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9140 @option{-march=v3} and @option{-march=v8} respectively.
9142 @item -mmul-bug-workaround
9143 @itemx -mno-mul-bug-workaround
9144 @opindex mmul-bug-workaround
9145 @opindex mno-mul-bug-workaround
9146 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9147 models where it applies.  This option is active by default.
9149 @item -mpdebug
9150 @opindex mpdebug
9151 Enable CRIS-specific verbose debug-related information in the assembly
9152 code.  This option also has the effect to turn off the @samp{#NO_APP}
9153 formatted-code indicator to the assembler at the beginning of the
9154 assembly file.
9156 @item -mcc-init
9157 @opindex mcc-init
9158 Do not use condition-code results from previous instruction; always emit
9159 compare and test instructions before use of condition codes.
9161 @item -mno-side-effects
9162 @opindex mno-side-effects
9163 Do not emit instructions with side-effects in addressing modes other than
9164 post-increment.
9166 @item -mstack-align
9167 @itemx -mno-stack-align
9168 @itemx -mdata-align
9169 @itemx -mno-data-align
9170 @itemx -mconst-align
9171 @itemx -mno-const-align
9172 @opindex mstack-align
9173 @opindex mno-stack-align
9174 @opindex mdata-align
9175 @opindex mno-data-align
9176 @opindex mconst-align
9177 @opindex mno-const-align
9178 These options (no-options) arranges (eliminate arrangements) for the
9179 stack-frame, individual data and constants to be aligned for the maximum
9180 single data access size for the chosen CPU model.  The default is to
9181 arrange for 32-bit alignment.  ABI details such as structure layout are
9182 not affected by these options.
9184 @item -m32-bit
9185 @itemx -m16-bit
9186 @itemx -m8-bit
9187 @opindex m32-bit
9188 @opindex m16-bit
9189 @opindex m8-bit
9190 Similar to the stack- data- and const-align options above, these options
9191 arrange for stack-frame, writable data and constants to all be 32-bit,
9192 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9194 @item -mno-prologue-epilogue
9195 @itemx -mprologue-epilogue
9196 @opindex mno-prologue-epilogue
9197 @opindex mprologue-epilogue
9198 With @option{-mno-prologue-epilogue}, the normal function prologue and
9199 epilogue that sets up the stack-frame are omitted and no return
9200 instructions or return sequences are generated in the code.  Use this
9201 option only together with visual inspection of the compiled code: no
9202 warnings or errors are generated when call-saved registers must be saved,
9203 or storage for local variable needs to be allocated.
9205 @item -mno-gotplt
9206 @itemx -mgotplt
9207 @opindex mno-gotplt
9208 @opindex mgotplt
9209 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9210 instruction sequences that load addresses for functions from the PLT part
9211 of the GOT rather than (traditional on other architectures) calls to the
9212 PLT@.  The default is @option{-mgotplt}.
9214 @item -maout
9215 @opindex maout
9216 Legacy no-op option only recognized with the cris-axis-aout target.
9218 @item -melf
9219 @opindex melf
9220 Legacy no-op option only recognized with the cris-axis-elf and
9221 cris-axis-linux-gnu targets.
9223 @item -melinux
9224 @opindex melinux
9225 Only recognized with the cris-axis-aout target, where it selects a
9226 GNU/linux-like multilib, include files and instruction set for
9227 @option{-march=v8}.
9229 @item -mlinux
9230 @opindex mlinux
9231 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9233 @item -sim
9234 @opindex sim
9235 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9236 to link with input-output functions from a simulator library.  Code,
9237 initialized data and zero-initialized data are allocated consecutively.
9239 @item -sim2
9240 @opindex sim2
9241 Like @option{-sim}, but pass linker options to locate initialized data at
9242 0x40000000 and zero-initialized data at 0x80000000.
9243 @end table
9245 @node CRX Options
9246 @subsection CRX Options
9247 @cindex CRX Options
9249 These options are defined specifically for the CRX ports.
9251 @table @gcctabopt
9253 @item -mmac
9254 @opindex mmac
9255 Enable the use of multiply-accumulate instructions. Disabled by default.
9257 @item -mpush-args
9258 @opindex mpush-args
9259 Push instructions will be used to pass outgoing arguments when functions
9260 are called. Enabled by default.
9261 @end table
9263 @node Darwin Options
9264 @subsection Darwin Options
9265 @cindex Darwin options
9267 These options are defined for all architectures running the Darwin operating
9268 system.
9270 FSF GCC on Darwin does not create ``fat'' object files; it will create
9271 an object file for the single architecture that it was built to
9272 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9273 @option{-arch} options are used; it does so by running the compiler or
9274 linker multiple times and joining the results together with
9275 @file{lipo}.
9277 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9278 @samp{i686}) is determined by the flags that specify the ISA
9279 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9280 @option{-force_cpusubtype_ALL} option can be used to override this.
9282 The Darwin tools vary in their behavior when presented with an ISA
9283 mismatch.  The assembler, @file{as}, will only permit instructions to
9284 be used that are valid for the subtype of the file it is generating,
9285 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9286 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9287 and print an error if asked to create a shared library with a less
9288 restrictive subtype than its input files (for instance, trying to put
9289 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9290 for executables, @file{ld}, will quietly give the executable the most
9291 restrictive subtype of any of its input files.
9293 @table @gcctabopt
9294 @item -F@var{dir}
9295 @opindex F
9296 Add the framework directory @var{dir} to the head of the list of
9297 directories to be searched for header files.  These directories are
9298 interleaved with those specified by @option{-I} options and are
9299 scanned in a left-to-right order.
9301 A framework directory is a directory with frameworks in it.  A
9302 framework is a directory with a @samp{"Headers"} and/or
9303 @samp{"PrivateHeaders"} directory contained directly in it that ends
9304 in @samp{".framework"}.  The name of a framework is the name of this
9305 directory excluding the @samp{".framework"}.  Headers associated with
9306 the framework are found in one of those two directories, with
9307 @samp{"Headers"} being searched first.  A subframework is a framework
9308 directory that is in a framework's @samp{"Frameworks"} directory.
9309 Includes of subframework headers can only appear in a header of a
9310 framework that contains the subframework, or in a sibling subframework
9311 header.  Two subframeworks are siblings if they occur in the same
9312 framework.  A subframework should not have the same name as a
9313 framework, a warning will be issued if this is violated.  Currently a
9314 subframework cannot have subframeworks, in the future, the mechanism
9315 may be extended to support this.  The standard frameworks can be found
9316 in @samp{"/System/Library/Frameworks"} and
9317 @samp{"/Library/Frameworks"}.  An example include looks like
9318 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9319 the name of the framework and header.h is found in the
9320 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9322 @item -iframework@var{dir}
9323 @opindex iframework
9324 Like @option{-F} except the directory is a treated as a system
9325 directory.  The main difference between this @option{-iframework} and
9326 @option{-F} is that with @option{-iframework} the compiler does not
9327 warn about constructs contained within header files found via
9328 @var{dir}.  This option is valid only for the C family of languages.
9330 @item -gused
9331 @opindex gused
9332 Emit debugging information for symbols that are used.  For STABS
9333 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9334 This is by default ON@.
9336 @item -gfull
9337 @opindex gfull
9338 Emit debugging information for all symbols and types.
9340 @item -mmacosx-version-min=@var{version}
9341 The earliest version of MacOS X that this executable will run on
9342 is @var{version}.  Typical values of @var{version} include @code{10.1},
9343 @code{10.2}, and @code{10.3.9}.
9345 If the compiler was built to use the system's headers by default,
9346 then the default for this option is the system version on which the
9347 compiler is running, otherwise the default is to make choices which
9348 are compatible with as many systems and code bases as possible.
9350 @item -mkernel
9351 @opindex mkernel
9352 Enable kernel development mode.  The @option{-mkernel} option sets
9353 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9354 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9355 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9356 applicable.  This mode also sets @option{-mno-altivec},
9357 @option{-msoft-float}, @option{-fno-builtin} and
9358 @option{-mlong-branch} for PowerPC targets.
9360 @item -mone-byte-bool
9361 @opindex mone-byte-bool
9362 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9363 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9364 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9365 option has no effect on x86.
9367 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9368 to generate code that is not binary compatible with code generated
9369 without that switch.  Using this switch may require recompiling all
9370 other modules in a program, including system libraries.  Use this
9371 switch to conform to a non-default data model.
9373 @item -mfix-and-continue
9374 @itemx -ffix-and-continue
9375 @itemx -findirect-data
9376 @opindex mfix-and-continue
9377 @opindex ffix-and-continue
9378 @opindex findirect-data
9379 Generate code suitable for fast turn around development.  Needed to
9380 enable gdb to dynamically load @code{.o} files into already running
9381 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9382 are provided for backwards compatibility.
9384 @item -all_load
9385 @opindex all_load
9386 Loads all members of static archive libraries.
9387 See man ld(1) for more information.
9389 @item -arch_errors_fatal
9390 @opindex arch_errors_fatal
9391 Cause the errors having to do with files that have the wrong architecture
9392 to be fatal.
9394 @item -bind_at_load
9395 @opindex bind_at_load
9396 Causes the output file to be marked such that the dynamic linker will
9397 bind all undefined references when the file is loaded or launched.
9399 @item -bundle
9400 @opindex bundle
9401 Produce a Mach-o bundle format file.
9402 See man ld(1) for more information.
9404 @item -bundle_loader @var{executable}
9405 @opindex bundle_loader
9406 This option specifies the @var{executable} that will be loading the build
9407 output file being linked.  See man ld(1) for more information.
9409 @item -dynamiclib
9410 @opindex dynamiclib
9411 When passed this option, GCC will produce a dynamic library instead of
9412 an executable when linking, using the Darwin @file{libtool} command.
9414 @item -force_cpusubtype_ALL
9415 @opindex force_cpusubtype_ALL
9416 This causes GCC's output file to have the @var{ALL} subtype, instead of
9417 one controlled by the @option{-mcpu} or @option{-march} option.
9419 @item -allowable_client  @var{client_name}
9420 @itemx -client_name
9421 @itemx -compatibility_version
9422 @itemx -current_version
9423 @itemx -dead_strip
9424 @itemx -dependency-file
9425 @itemx -dylib_file
9426 @itemx -dylinker_install_name
9427 @itemx -dynamic
9428 @itemx -exported_symbols_list
9429 @itemx -filelist
9430 @itemx -flat_namespace
9431 @itemx -force_flat_namespace
9432 @itemx -headerpad_max_install_names
9433 @itemx -image_base
9434 @itemx -init
9435 @itemx -install_name
9436 @itemx -keep_private_externs
9437 @itemx -multi_module
9438 @itemx -multiply_defined
9439 @itemx -multiply_defined_unused
9440 @itemx -noall_load
9441 @itemx -no_dead_strip_inits_and_terms
9442 @itemx -nofixprebinding
9443 @itemx -nomultidefs
9444 @itemx -noprebind
9445 @itemx -noseglinkedit
9446 @itemx -pagezero_size
9447 @itemx -prebind
9448 @itemx -prebind_all_twolevel_modules
9449 @itemx -private_bundle
9450 @itemx -read_only_relocs
9451 @itemx -sectalign
9452 @itemx -sectobjectsymbols
9453 @itemx -whyload
9454 @itemx -seg1addr
9455 @itemx -sectcreate
9456 @itemx -sectobjectsymbols
9457 @itemx -sectorder
9458 @itemx -segaddr
9459 @itemx -segs_read_only_addr
9460 @itemx -segs_read_write_addr
9461 @itemx -seg_addr_table
9462 @itemx -seg_addr_table_filename
9463 @itemx -seglinkedit
9464 @itemx -segprot
9465 @itemx -segs_read_only_addr
9466 @itemx -segs_read_write_addr
9467 @itemx -single_module
9468 @itemx -static
9469 @itemx -sub_library
9470 @itemx -sub_umbrella
9471 @itemx -twolevel_namespace
9472 @itemx -umbrella
9473 @itemx -undefined
9474 @itemx -unexported_symbols_list
9475 @itemx -weak_reference_mismatches
9476 @itemx -whatsloaded
9477 @opindex allowable_client
9478 @opindex client_name
9479 @opindex compatibility_version
9480 @opindex current_version
9481 @opindex dead_strip
9482 @opindex dependency-file
9483 @opindex dylib_file
9484 @opindex dylinker_install_name
9485 @opindex dynamic
9486 @opindex exported_symbols_list
9487 @opindex filelist
9488 @opindex flat_namespace
9489 @opindex force_flat_namespace
9490 @opindex headerpad_max_install_names
9491 @opindex image_base
9492 @opindex init
9493 @opindex install_name
9494 @opindex keep_private_externs
9495 @opindex multi_module
9496 @opindex multiply_defined
9497 @opindex multiply_defined_unused
9498 @opindex noall_load
9499 @opindex no_dead_strip_inits_and_terms
9500 @opindex nofixprebinding
9501 @opindex nomultidefs
9502 @opindex noprebind
9503 @opindex noseglinkedit
9504 @opindex pagezero_size
9505 @opindex prebind
9506 @opindex prebind_all_twolevel_modules
9507 @opindex private_bundle
9508 @opindex read_only_relocs
9509 @opindex sectalign
9510 @opindex sectobjectsymbols
9511 @opindex whyload
9512 @opindex seg1addr
9513 @opindex sectcreate
9514 @opindex sectobjectsymbols
9515 @opindex sectorder
9516 @opindex segaddr
9517 @opindex segs_read_only_addr
9518 @opindex segs_read_write_addr
9519 @opindex seg_addr_table
9520 @opindex seg_addr_table_filename
9521 @opindex seglinkedit
9522 @opindex segprot
9523 @opindex segs_read_only_addr
9524 @opindex segs_read_write_addr
9525 @opindex single_module
9526 @opindex static
9527 @opindex sub_library
9528 @opindex sub_umbrella
9529 @opindex twolevel_namespace
9530 @opindex umbrella
9531 @opindex undefined
9532 @opindex unexported_symbols_list
9533 @opindex weak_reference_mismatches
9534 @opindex whatsloaded
9535 These options are passed to the Darwin linker.  The Darwin linker man page
9536 describes them in detail.
9537 @end table
9539 @node DEC Alpha Options
9540 @subsection DEC Alpha Options
9542 These @samp{-m} options are defined for the DEC Alpha implementations:
9544 @table @gcctabopt
9545 @item -mno-soft-float
9546 @itemx -msoft-float
9547 @opindex mno-soft-float
9548 @opindex msoft-float
9549 Use (do not use) the hardware floating-point instructions for
9550 floating-point operations.  When @option{-msoft-float} is specified,
9551 functions in @file{libgcc.a} will be used to perform floating-point
9552 operations.  Unless they are replaced by routines that emulate the
9553 floating-point operations, or compiled in such a way as to call such
9554 emulations routines, these routines will issue floating-point
9555 operations.   If you are compiling for an Alpha without floating-point
9556 operations, you must ensure that the library is built so as not to call
9557 them.
9559 Note that Alpha implementations without floating-point operations are
9560 required to have floating-point registers.
9562 @item -mfp-reg
9563 @itemx -mno-fp-regs
9564 @opindex mfp-reg
9565 @opindex mno-fp-regs
9566 Generate code that uses (does not use) the floating-point register set.
9567 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9568 register set is not used, floating point operands are passed in integer
9569 registers as if they were integers and floating-point results are passed
9570 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9571 so any function with a floating-point argument or return value called by code
9572 compiled with @option{-mno-fp-regs} must also be compiled with that
9573 option.
9575 A typical use of this option is building a kernel that does not use,
9576 and hence need not save and restore, any floating-point registers.
9578 @item -mieee
9579 @opindex mieee
9580 The Alpha architecture implements floating-point hardware optimized for
9581 maximum performance.  It is mostly compliant with the IEEE floating
9582 point standard.  However, for full compliance, software assistance is
9583 required.  This option generates code fully IEEE compliant code
9584 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9585 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9586 defined during compilation.  The resulting code is less efficient but is
9587 able to correctly support denormalized numbers and exceptional IEEE
9588 values such as not-a-number and plus/minus infinity.  Other Alpha
9589 compilers call this option @option{-ieee_with_no_inexact}.
9591 @item -mieee-with-inexact
9592 @opindex mieee-with-inexact
9593 This is like @option{-mieee} except the generated code also maintains
9594 the IEEE @var{inexact-flag}.  Turning on this option causes the
9595 generated code to implement fully-compliant IEEE math.  In addition to
9596 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9597 macro.  On some Alpha implementations the resulting code may execute
9598 significantly slower than the code generated by default.  Since there is
9599 very little code that depends on the @var{inexact-flag}, you should
9600 normally not specify this option.  Other Alpha compilers call this
9601 option @option{-ieee_with_inexact}.
9603 @item -mfp-trap-mode=@var{trap-mode}
9604 @opindex mfp-trap-mode
9605 This option controls what floating-point related traps are enabled.
9606 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9607 The trap mode can be set to one of four values:
9609 @table @samp
9610 @item n
9611 This is the default (normal) setting.  The only traps that are enabled
9612 are the ones that cannot be disabled in software (e.g., division by zero
9613 trap).
9615 @item u
9616 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9617 as well.
9619 @item su
9620 Like @samp{u}, but the instructions are marked to be safe for software
9621 completion (see Alpha architecture manual for details).
9623 @item sui
9624 Like @samp{su}, but inexact traps are enabled as well.
9625 @end table
9627 @item -mfp-rounding-mode=@var{rounding-mode}
9628 @opindex mfp-rounding-mode
9629 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9630 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9633 @table @samp
9634 @item n
9635 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9636 the nearest machine number or towards the even machine number in case
9637 of a tie.
9639 @item m
9640 Round towards minus infinity.
9642 @item c
9643 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9645 @item d
9646 Dynamic rounding mode.  A field in the floating point control register
9647 (@var{fpcr}, see Alpha architecture reference manual) controls the
9648 rounding mode in effect.  The C library initializes this register for
9649 rounding towards plus infinity.  Thus, unless your program modifies the
9650 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9651 @end table
9653 @item -mtrap-precision=@var{trap-precision}
9654 @opindex mtrap-precision
9655 In the Alpha architecture, floating point traps are imprecise.  This
9656 means without software assistance it is impossible to recover from a
9657 floating trap and program execution normally needs to be terminated.
9658 GCC can generate code that can assist operating system trap handlers
9659 in determining the exact location that caused a floating point trap.
9660 Depending on the requirements of an application, different levels of
9661 precisions can be selected:
9663 @table @samp
9664 @item p
9665 Program precision.  This option is the default and means a trap handler
9666 can only identify which program caused a floating point exception.
9668 @item f
9669 Function precision.  The trap handler can determine the function that
9670 caused a floating point exception.
9672 @item i
9673 Instruction precision.  The trap handler can determine the exact
9674 instruction that caused a floating point exception.
9675 @end table
9677 Other Alpha compilers provide the equivalent options called
9678 @option{-scope_safe} and @option{-resumption_safe}.
9680 @item -mieee-conformant
9681 @opindex mieee-conformant
9682 This option marks the generated code as IEEE conformant.  You must not
9683 use this option unless you also specify @option{-mtrap-precision=i} and either
9684 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9685 is to emit the line @samp{.eflag 48} in the function prologue of the
9686 generated assembly file.  Under DEC Unix, this has the effect that
9687 IEEE-conformant math library routines will be linked in.
9689 @item -mbuild-constants
9690 @opindex mbuild-constants
9691 Normally GCC examines a 32- or 64-bit integer constant to
9692 see if it can construct it from smaller constants in two or three
9693 instructions.  If it cannot, it will output the constant as a literal and
9694 generate code to load it from the data segment at runtime.
9696 Use this option to require GCC to construct @emph{all} integer constants
9697 using code, even if it takes more instructions (the maximum is six).
9699 You would typically use this option to build a shared library dynamic
9700 loader.  Itself a shared library, it must relocate itself in memory
9701 before it can find the variables and constants in its own data segment.
9703 @item -malpha-as
9704 @itemx -mgas
9705 @opindex malpha-as
9706 @opindex mgas
9707 Select whether to generate code to be assembled by the vendor-supplied
9708 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9710 @item -mbwx
9711 @itemx -mno-bwx
9712 @itemx -mcix
9713 @itemx -mno-cix
9714 @itemx -mfix
9715 @itemx -mno-fix
9716 @itemx -mmax
9717 @itemx -mno-max
9718 @opindex mbwx
9719 @opindex mno-bwx
9720 @opindex mcix
9721 @opindex mno-cix
9722 @opindex mfix
9723 @opindex mno-fix
9724 @opindex mmax
9725 @opindex mno-max
9726 Indicate whether GCC should generate code to use the optional BWX,
9727 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9728 sets supported by the CPU type specified via @option{-mcpu=} option or that
9729 of the CPU on which GCC was built if none was specified.
9731 @item -mfloat-vax
9732 @itemx -mfloat-ieee
9733 @opindex mfloat-vax
9734 @opindex mfloat-ieee
9735 Generate code that uses (does not use) VAX F and G floating point
9736 arithmetic instead of IEEE single and double precision.
9738 @item -mexplicit-relocs
9739 @itemx -mno-explicit-relocs
9740 @opindex mexplicit-relocs
9741 @opindex mno-explicit-relocs
9742 Older Alpha assemblers provided no way to generate symbol relocations
9743 except via assembler macros.  Use of these macros does not allow
9744 optimal instruction scheduling.  GNU binutils as of version 2.12
9745 supports a new syntax that allows the compiler to explicitly mark
9746 which relocations should apply to which instructions.  This option
9747 is mostly useful for debugging, as GCC detects the capabilities of
9748 the assembler when it is built and sets the default accordingly.
9750 @item -msmall-data
9751 @itemx -mlarge-data
9752 @opindex msmall-data
9753 @opindex mlarge-data
9754 When @option{-mexplicit-relocs} is in effect, static data is
9755 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9756 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9757 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9758 16-bit relocations off of the @code{$gp} register.  This limits the
9759 size of the small data area to 64KB, but allows the variables to be
9760 directly accessed via a single instruction.
9762 The default is @option{-mlarge-data}.  With this option the data area
9763 is limited to just below 2GB@.  Programs that require more than 2GB of
9764 data must use @code{malloc} or @code{mmap} to allocate the data in the
9765 heap instead of in the program's data segment.
9767 When generating code for shared libraries, @option{-fpic} implies
9768 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9770 @item -msmall-text
9771 @itemx -mlarge-text
9772 @opindex msmall-text
9773 @opindex mlarge-text
9774 When @option{-msmall-text} is used, the compiler assumes that the
9775 code of the entire program (or shared library) fits in 4MB, and is
9776 thus reachable with a branch instruction.  When @option{-msmall-data}
9777 is used, the compiler can assume that all local symbols share the
9778 same @code{$gp} value, and thus reduce the number of instructions
9779 required for a function call from 4 to 1.
9781 The default is @option{-mlarge-text}.
9783 @item -mcpu=@var{cpu_type}
9784 @opindex mcpu
9785 Set the instruction set and instruction scheduling parameters for
9786 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9787 style name or the corresponding chip number.  GCC supports scheduling
9788 parameters for the EV4, EV5 and EV6 family of processors and will
9789 choose the default values for the instruction set from the processor
9790 you specify.  If you do not specify a processor type, GCC will default
9791 to the processor on which the compiler was built.
9793 Supported values for @var{cpu_type} are
9795 @table @samp
9796 @item ev4
9797 @itemx ev45
9798 @itemx 21064
9799 Schedules as an EV4 and has no instruction set extensions.
9801 @item ev5
9802 @itemx 21164
9803 Schedules as an EV5 and has no instruction set extensions.
9805 @item ev56
9806 @itemx 21164a
9807 Schedules as an EV5 and supports the BWX extension.
9809 @item pca56
9810 @itemx 21164pc
9811 @itemx 21164PC
9812 Schedules as an EV5 and supports the BWX and MAX extensions.
9814 @item ev6
9815 @itemx 21264
9816 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9818 @item ev67
9819 @itemx 21264a
9820 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9821 @end table
9823 @item -mtune=@var{cpu_type}
9824 @opindex mtune
9825 Set only the instruction scheduling parameters for machine type
9826 @var{cpu_type}.  The instruction set is not changed.
9828 @item -mmemory-latency=@var{time}
9829 @opindex mmemory-latency
9830 Sets the latency the scheduler should assume for typical memory
9831 references as seen by the application.  This number is highly
9832 dependent on the memory access patterns used by the application
9833 and the size of the external cache on the machine.
9835 Valid options for @var{time} are
9837 @table @samp
9838 @item @var{number}
9839 A decimal number representing clock cycles.
9841 @item L1
9842 @itemx L2
9843 @itemx L3
9844 @itemx main
9845 The compiler contains estimates of the number of clock cycles for
9846 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9847 (also called Dcache, Scache, and Bcache), as well as to main memory.
9848 Note that L3 is only valid for EV5.
9850 @end table
9851 @end table
9853 @node DEC Alpha/VMS Options
9854 @subsection DEC Alpha/VMS Options
9856 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9858 @table @gcctabopt
9859 @item -mvms-return-codes
9860 @opindex mvms-return-codes
9861 Return VMS condition codes from main.  The default is to return POSIX
9862 style condition (e.g.@: error) codes.
9863 @end table
9865 @node FRV Options
9866 @subsection FRV Options
9867 @cindex FRV Options
9869 @table @gcctabopt
9870 @item -mgpr-32
9871 @opindex mgpr-32
9873 Only use the first 32 general purpose registers.
9875 @item -mgpr-64
9876 @opindex mgpr-64
9878 Use all 64 general purpose registers.
9880 @item -mfpr-32
9881 @opindex mfpr-32
9883 Use only the first 32 floating point registers.
9885 @item -mfpr-64
9886 @opindex mfpr-64
9888 Use all 64 floating point registers
9890 @item -mhard-float
9891 @opindex mhard-float
9893 Use hardware instructions for floating point operations.
9895 @item -msoft-float
9896 @opindex msoft-float
9898 Use library routines for floating point operations.
9900 @item -malloc-cc
9901 @opindex malloc-cc
9903 Dynamically allocate condition code registers.
9905 @item -mfixed-cc
9906 @opindex mfixed-cc
9908 Do not try to dynamically allocate condition code registers, only
9909 use @code{icc0} and @code{fcc0}.
9911 @item -mdword
9912 @opindex mdword
9914 Change ABI to use double word insns.
9916 @item -mno-dword
9917 @opindex mno-dword
9919 Do not use double word instructions.
9921 @item -mdouble
9922 @opindex mdouble
9924 Use floating point double instructions.
9926 @item -mno-double
9927 @opindex mno-double
9929 Do not use floating point double instructions.
9931 @item -mmedia
9932 @opindex mmedia
9934 Use media instructions.
9936 @item -mno-media
9937 @opindex mno-media
9939 Do not use media instructions.
9941 @item -mmuladd
9942 @opindex mmuladd
9944 Use multiply and add/subtract instructions.
9946 @item -mno-muladd
9947 @opindex mno-muladd
9949 Do not use multiply and add/subtract instructions.
9951 @item -mfdpic
9952 @opindex mfdpic
9954 Select the FDPIC ABI, that uses function descriptors to represent
9955 pointers to functions.  Without any PIC/PIE-related options, it
9956 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9957 assumes GOT entries and small data are within a 12-bit range from the
9958 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9959 are computed with 32 bits.
9960 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9962 @item -minline-plt
9963 @opindex minline-plt
9965 Enable inlining of PLT entries in function calls to functions that are
9966 not known to bind locally.  It has no effect without @option{-mfdpic}.
9967 It's enabled by default if optimizing for speed and compiling for
9968 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9969 optimization option such as @option{-O3} or above is present in the
9970 command line.
9972 @item -mTLS
9973 @opindex TLS
9975 Assume a large TLS segment when generating thread-local code.
9977 @item -mtls
9978 @opindex tls
9980 Do not assume a large TLS segment when generating thread-local code.
9982 @item -mgprel-ro
9983 @opindex mgprel-ro
9985 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9986 that is known to be in read-only sections.  It's enabled by default,
9987 except for @option{-fpic} or @option{-fpie}: even though it may help
9988 make the global offset table smaller, it trades 1 instruction for 4.
9989 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9990 one of which may be shared by multiple symbols, and it avoids the need
9991 for a GOT entry for the referenced symbol, so it's more likely to be a
9992 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9994 @item -multilib-library-pic
9995 @opindex multilib-library-pic
9997 Link with the (library, not FD) pic libraries.  It's implied by
9998 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9999 @option{-fpic} without @option{-mfdpic}.  You should never have to use
10000 it explicitly.
10002 @item -mlinked-fp
10003 @opindex mlinked-fp
10005 Follow the EABI requirement of always creating a frame pointer whenever
10006 a stack frame is allocated.  This option is enabled by default and can
10007 be disabled with @option{-mno-linked-fp}.
10009 @item -mlong-calls
10010 @opindex mlong-calls
10012 Use indirect addressing to call functions outside the current
10013 compilation unit.  This allows the functions to be placed anywhere
10014 within the 32-bit address space.
10016 @item -malign-labels
10017 @opindex malign-labels
10019 Try to align labels to an 8-byte boundary by inserting nops into the
10020 previous packet.  This option only has an effect when VLIW packing
10021 is enabled.  It doesn't create new packets; it merely adds nops to
10022 existing ones.
10024 @item -mlibrary-pic
10025 @opindex mlibrary-pic
10027 Generate position-independent EABI code.
10029 @item -macc-4
10030 @opindex macc-4
10032 Use only the first four media accumulator registers.
10034 @item -macc-8
10035 @opindex macc-8
10037 Use all eight media accumulator registers.
10039 @item -mpack
10040 @opindex mpack
10042 Pack VLIW instructions.
10044 @item -mno-pack
10045 @opindex mno-pack
10047 Do not pack VLIW instructions.
10049 @item -mno-eflags
10050 @opindex mno-eflags
10052 Do not mark ABI switches in e_flags.
10054 @item -mcond-move
10055 @opindex mcond-move
10057 Enable the use of conditional-move instructions (default).
10059 This switch is mainly for debugging the compiler and will likely be removed
10060 in a future version.
10062 @item -mno-cond-move
10063 @opindex mno-cond-move
10065 Disable the use of conditional-move instructions.
10067 This switch is mainly for debugging the compiler and will likely be removed
10068 in a future version.
10070 @item -mscc
10071 @opindex mscc
10073 Enable the use of conditional set instructions (default).
10075 This switch is mainly for debugging the compiler and will likely be removed
10076 in a future version.
10078 @item -mno-scc
10079 @opindex mno-scc
10081 Disable the use of conditional set instructions.
10083 This switch is mainly for debugging the compiler and will likely be removed
10084 in a future version.
10086 @item -mcond-exec
10087 @opindex mcond-exec
10089 Enable the use of conditional execution (default).
10091 This switch is mainly for debugging the compiler and will likely be removed
10092 in a future version.
10094 @item -mno-cond-exec
10095 @opindex mno-cond-exec
10097 Disable the use of conditional execution.
10099 This switch is mainly for debugging the compiler and will likely be removed
10100 in a future version.
10102 @item -mvliw-branch
10103 @opindex mvliw-branch
10105 Run a pass to pack branches into VLIW instructions (default).
10107 This switch is mainly for debugging the compiler and will likely be removed
10108 in a future version.
10110 @item -mno-vliw-branch
10111 @opindex mno-vliw-branch
10113 Do not run a pass to pack branches into VLIW instructions.
10115 This switch is mainly for debugging the compiler and will likely be removed
10116 in a future version.
10118 @item -mmulti-cond-exec
10119 @opindex mmulti-cond-exec
10121 Enable optimization of @code{&&} and @code{||} in conditional execution
10122 (default).
10124 This switch is mainly for debugging the compiler and will likely be removed
10125 in a future version.
10127 @item -mno-multi-cond-exec
10128 @opindex mno-multi-cond-exec
10130 Disable optimization of @code{&&} and @code{||} in conditional execution.
10132 This switch is mainly for debugging the compiler and will likely be removed
10133 in a future version.
10135 @item -mnested-cond-exec
10136 @opindex mnested-cond-exec
10138 Enable nested conditional execution optimizations (default).
10140 This switch is mainly for debugging the compiler and will likely be removed
10141 in a future version.
10143 @item -mno-nested-cond-exec
10144 @opindex mno-nested-cond-exec
10146 Disable nested conditional execution optimizations.
10148 This switch is mainly for debugging the compiler and will likely be removed
10149 in a future version.
10151 @item -moptimize-membar
10152 @opindex moptimize-membar
10154 This switch removes redundant @code{membar} instructions from the
10155 compiler generated code.  It is enabled by default.
10157 @item -mno-optimize-membar
10158 @opindex mno-optimize-membar
10160 This switch disables the automatic removal of redundant @code{membar}
10161 instructions from the generated code.
10163 @item -mtomcat-stats
10164 @opindex mtomcat-stats
10166 Cause gas to print out tomcat statistics.
10168 @item -mcpu=@var{cpu}
10169 @opindex mcpu
10171 Select the processor type for which to generate code.  Possible values are
10172 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10173 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10175 @end table
10177 @node GNU/Linux Options
10178 @subsection GNU/Linux Options
10180 These @samp{-m} options are defined for GNU/Linux targets:
10182 @table @gcctabopt
10183 @item -mglibc
10184 @opindex mglibc
10185 Use the GNU C library instead of uClibc.  This is the default except
10186 on @samp{*-*-linux-*uclibc*} targets.
10188 @item -muclibc
10189 @opindex muclibc
10190 Use uClibc instead of the GNU C library.  This is the default on
10191 @samp{*-*-linux-*uclibc*} targets.
10192 @end table
10194 @node H8/300 Options
10195 @subsection H8/300 Options
10197 These @samp{-m} options are defined for the H8/300 implementations:
10199 @table @gcctabopt
10200 @item -mrelax
10201 @opindex mrelax
10202 Shorten some address references at link time, when possible; uses the
10203 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10204 ld, Using ld}, for a fuller description.
10206 @item -mh
10207 @opindex mh
10208 Generate code for the H8/300H@.
10210 @item -ms
10211 @opindex ms
10212 Generate code for the H8S@.
10214 @item -mn
10215 @opindex mn
10216 Generate code for the H8S and H8/300H in the normal mode.  This switch
10217 must be used either with @option{-mh} or @option{-ms}.
10219 @item -ms2600
10220 @opindex ms2600
10221 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10223 @item -mint32
10224 @opindex mint32
10225 Make @code{int} data 32 bits by default.
10227 @item -malign-300
10228 @opindex malign-300
10229 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10230 The default for the H8/300H and H8S is to align longs and floats on 4
10231 byte boundaries.
10232 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10233 This option has no effect on the H8/300.
10234 @end table
10236 @node HPPA Options
10237 @subsection HPPA Options
10238 @cindex HPPA Options
10240 These @samp{-m} options are defined for the HPPA family of computers:
10242 @table @gcctabopt
10243 @item -march=@var{architecture-type}
10244 @opindex march
10245 Generate code for the specified architecture.  The choices for
10246 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10247 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10248 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10249 architecture option for your machine.  Code compiled for lower numbered
10250 architectures will run on higher numbered architectures, but not the
10251 other way around.
10253 @item -mpa-risc-1-0
10254 @itemx -mpa-risc-1-1
10255 @itemx -mpa-risc-2-0
10256 @opindex mpa-risc-1-0
10257 @opindex mpa-risc-1-1
10258 @opindex mpa-risc-2-0
10259 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10261 @item -mbig-switch
10262 @opindex mbig-switch
10263 Generate code suitable for big switch tables.  Use this option only if
10264 the assembler/linker complain about out of range branches within a switch
10265 table.
10267 @item -mjump-in-delay
10268 @opindex mjump-in-delay
10269 Fill delay slots of function calls with unconditional jump instructions
10270 by modifying the return pointer for the function call to be the target
10271 of the conditional jump.
10273 @item -mdisable-fpregs
10274 @opindex mdisable-fpregs
10275 Prevent floating point registers from being used in any manner.  This is
10276 necessary for compiling kernels which perform lazy context switching of
10277 floating point registers.  If you use this option and attempt to perform
10278 floating point operations, the compiler will abort.
10280 @item -mdisable-indexing
10281 @opindex mdisable-indexing
10282 Prevent the compiler from using indexing address modes.  This avoids some
10283 rather obscure problems when compiling MIG generated code under MACH@.
10285 @item -mno-space-regs
10286 @opindex mno-space-regs
10287 Generate code that assumes the target has no space registers.  This allows
10288 GCC to generate faster indirect calls and use unscaled index address modes.
10290 Such code is suitable for level 0 PA systems and kernels.
10292 @item -mfast-indirect-calls
10293 @opindex mfast-indirect-calls
10294 Generate code that assumes calls never cross space boundaries.  This
10295 allows GCC to emit code which performs faster indirect calls.
10297 This option will not work in the presence of shared libraries or nested
10298 functions.
10300 @item -mfixed-range=@var{register-range}
10301 @opindex mfixed-range
10302 Generate code treating the given register range as fixed registers.
10303 A fixed register is one that the register allocator can not use.  This is
10304 useful when compiling kernel code.  A register range is specified as
10305 two registers separated by a dash.  Multiple register ranges can be
10306 specified separated by a comma.
10308 @item -mlong-load-store
10309 @opindex mlong-load-store
10310 Generate 3-instruction load and store sequences as sometimes required by
10311 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10312 the HP compilers.
10314 @item -mportable-runtime
10315 @opindex mportable-runtime
10316 Use the portable calling conventions proposed by HP for ELF systems.
10318 @item -mgas
10319 @opindex mgas
10320 Enable the use of assembler directives only GAS understands.
10322 @item -mschedule=@var{cpu-type}
10323 @opindex mschedule
10324 Schedule code according to the constraints for the machine type
10325 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10326 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10327 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10328 proper scheduling option for your machine.  The default scheduling is
10329 @samp{8000}.
10331 @item -mlinker-opt
10332 @opindex mlinker-opt
10333 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10334 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10335 linkers in which they give bogus error messages when linking some programs.
10337 @item -msoft-float
10338 @opindex msoft-float
10339 Generate output containing library calls for floating point.
10340 @strong{Warning:} the requisite libraries are not available for all HPPA
10341 targets.  Normally the facilities of the machine's usual C compiler are
10342 used, but this cannot be done directly in cross-compilation.  You must make
10343 your own arrangements to provide suitable library functions for
10344 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
10345 does provide software floating point support.
10347 @option{-msoft-float} changes the calling convention in the output file;
10348 therefore, it is only useful if you compile @emph{all} of a program with
10349 this option.  In particular, you need to compile @file{libgcc.a}, the
10350 library that comes with GCC, with @option{-msoft-float} in order for
10351 this to work.
10353 @item -msio
10354 @opindex msio
10355 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10356 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10357 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10358 options are available under HP-UX and HI-UX@.
10360 @item -mgnu-ld
10361 @opindex gnu-ld
10362 Use GNU ld specific options.  This passes @option{-shared} to ld when
10363 building a shared library.  It is the default when GCC is configured,
10364 explicitly or implicitly, with the GNU linker.  This option does not
10365 have any affect on which ld is called, it only changes what parameters
10366 are passed to that ld.  The ld that is called is determined by the
10367 @option{--with-ld} configure option, GCC's program search path, and
10368 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10369 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10370 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10372 @item -mhp-ld
10373 @opindex hp-ld
10374 Use HP ld specific options.  This passes @option{-b} to ld when building
10375 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10376 links.  It is the default when GCC is configured, explicitly or
10377 implicitly, with the HP linker.  This option does not have any affect on
10378 which ld is called, it only changes what parameters are passed to that
10379 ld.  The ld that is called is determined by the @option{--with-ld}
10380 configure option, GCC's program search path, and finally by the user's
10381 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10382 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10383 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10385 @item -mlong-calls
10386 @opindex mno-long-calls
10387 Generate code that uses long call sequences.  This ensures that a call
10388 is always able to reach linker generated stubs.  The default is to generate
10389 long calls only when the distance from the call site to the beginning
10390 of the function or translation unit, as the case may be, exceeds a
10391 predefined limit set by the branch type being used.  The limits for
10392 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10393 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10394 240,000 bytes.
10396 Distances are measured from the beginning of functions when using the
10397 @option{-ffunction-sections} option, or when using the @option{-mgas}
10398 and @option{-mno-portable-runtime} options together under HP-UX with
10399 the SOM linker.
10401 It is normally not desirable to use this option as it will degrade
10402 performance.  However, it may be useful in large applications,
10403 particularly when partial linking is used to build the application.
10405 The types of long calls used depends on the capabilities of the
10406 assembler and linker, and the type of code being generated.  The
10407 impact on systems that support long absolute calls, and long pic
10408 symbol-difference or pc-relative calls should be relatively small.
10409 However, an indirect call is used on 32-bit ELF systems in pic code
10410 and it is quite long.
10412 @item -munix=@var{unix-std}
10413 @opindex march
10414 Generate compiler predefines and select a startfile for the specified
10415 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10416 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10417 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10418 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10419 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10420 and later.
10422 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10423 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10424 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10425 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10426 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10427 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10429 It is @emph{important} to note that this option changes the interfaces
10430 for various library routines.  It also affects the operational behavior
10431 of the C library.  Thus, @emph{extreme} care is needed in using this
10432 option.
10434 Library code that is intended to operate with more than one UNIX
10435 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10436 as appropriate.  Most GNU software doesn't provide this capability.
10438 @item -nolibdld
10439 @opindex nolibdld
10440 Suppress the generation of link options to search libdld.sl when the
10441 @option{-static} option is specified on HP-UX 10 and later.
10443 @item -static
10444 @opindex static
10445 The HP-UX implementation of setlocale in libc has a dependency on
10446 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10447 when the @option{-static} option is specified, special link options
10448 are needed to resolve this dependency.
10450 On HP-UX 10 and later, the GCC driver adds the necessary options to
10451 link with libdld.sl when the @option{-static} option is specified.
10452 This causes the resulting binary to be dynamic.  On the 64-bit port,
10453 the linkers generate dynamic binaries by default in any case.  The
10454 @option{-nolibdld} option can be used to prevent the GCC driver from
10455 adding these link options.
10457 @item -threads
10458 @opindex threads
10459 Add support for multithreading with the @dfn{dce thread} library
10460 under HP-UX@.  This option sets flags for both the preprocessor and
10461 linker.
10462 @end table
10464 @node i386 and x86-64 Options
10465 @subsection Intel 386 and AMD x86-64 Options
10466 @cindex i386 Options
10467 @cindex x86-64 Options
10468 @cindex Intel 386 Options
10469 @cindex AMD x86-64 Options
10471 These @samp{-m} options are defined for the i386 and x86-64 family of
10472 computers:
10474 @table @gcctabopt
10475 @item -mtune=@var{cpu-type}
10476 @opindex mtune
10477 Tune to @var{cpu-type} everything applicable about the generated code, except
10478 for the ABI and the set of available instructions.  The choices for
10479 @var{cpu-type} are:
10480 @table @emph
10481 @item generic
10482 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10483 If you know the CPU on which your code will run, then you should use
10484 the corresponding @option{-mtune} option instead of
10485 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10486 of your application will have, then you should use this option.
10488 As new processors are deployed in the marketplace, the behavior of this
10489 option will change.  Therefore, if you upgrade to a newer version of
10490 GCC, the code generated option will change to reflect the processors
10491 that were most common when that version of GCC was released.
10493 There is no @option{-march=generic} option because @option{-march}
10494 indicates the instruction set the compiler can use, and there is no
10495 generic instruction set applicable to all processors.  In contrast,
10496 @option{-mtune} indicates the processor (or, in this case, collection of
10497 processors) for which the code is optimized.
10498 @item native
10499 This selects the CPU to tune for at compilation time by determining
10500 the processor type of the compiling machine.  Using @option{-mtune=native}
10501 will produce code optimized for the local machine under the constraints
10502 of the selected instruction set.  Using @option{-march=native} will
10503 enable all instruction subsets supported by the local machine (hence
10504 the result might not run on different machines).
10505 @item i386
10506 Original Intel's i386 CPU@.
10507 @item i486
10508 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10509 @item i586, pentium
10510 Intel Pentium CPU with no MMX support.
10511 @item pentium-mmx
10512 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10513 @item pentiumpro
10514 Intel PentiumPro CPU@.
10515 @item i686
10516 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10517 instruction set will be used, so the code will run on all i686 family chips.
10518 @item pentium2
10519 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10520 @item pentium3, pentium3m
10521 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10522 support.
10523 @item pentium-m
10524 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10525 support.  Used by Centrino notebooks.
10526 @item pentium4, pentium4m
10527 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10528 @item prescott
10529 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10530 set support.
10531 @item nocona
10532 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10533 SSE2 and SSE3 instruction set support.
10534 @item core2
10535 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10536 instruction set support.
10537 @item k6
10538 AMD K6 CPU with MMX instruction set support.
10539 @item k6-2, k6-3
10540 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10541 @item athlon, athlon-tbird
10542 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10543 support.
10544 @item athlon-4, athlon-xp, athlon-mp
10545 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10546 instruction set support.
10547 @item k8, opteron, athlon64, athlon-fx
10548 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10549 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10550 @item k8-sse3, opteron-sse3, athlon64-sse3
10551 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10552 @item amdfam10, barcelona
10553 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10554 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10555 instruction set extensions.)
10556 @item winchip-c6
10557 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10558 set support.
10559 @item winchip2
10560 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10561 instruction set support.
10562 @item c3
10563 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10564 implemented for this chip.)
10565 @item c3-2
10566 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10567 implemented for this chip.)
10568 @item geode
10569 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10570 @end table
10572 While picking a specific @var{cpu-type} will schedule things appropriately
10573 for that particular chip, the compiler will not generate any code that
10574 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10575 being used.
10577 @item -march=@var{cpu-type}
10578 @opindex march
10579 Generate instructions for the machine type @var{cpu-type}.  The choices
10580 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10581 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10583 @item -mcpu=@var{cpu-type}
10584 @opindex mcpu
10585 A deprecated synonym for @option{-mtune}.
10587 @item -mfpmath=@var{unit}
10588 @opindex march
10589 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10590 for @var{unit} are:
10592 @table @samp
10593 @item 387
10594 Use the standard 387 floating point coprocessor present majority of chips and
10595 emulated otherwise.  Code compiled with this option will run almost everywhere.
10596 The temporary results are computed in 80bit precision instead of precision
10597 specified by the type resulting in slightly different results compared to most
10598 of other chips.  See @option{-ffloat-store} for more detailed description.
10600 This is the default choice for i386 compiler.
10602 @item sse
10603 Use scalar floating point instructions present in the SSE instruction set.
10604 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10605 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10606 instruction set supports only single precision arithmetics, thus the double and
10607 extended precision arithmetics is still done using 387.  Later version, present
10608 only in Pentium4 and the future AMD x86-64 chips supports double precision
10609 arithmetics too.
10611 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10612 or @option{-msse2} switches to enable SSE extensions and make this option
10613 effective.  For the x86-64 compiler, these extensions are enabled by default.
10615 The resulting code should be considerably faster in the majority of cases and avoid
10616 the numerical instability problems of 387 code, but may break some existing
10617 code that expects temporaries to be 80bit.
10619 This is the default choice for the x86-64 compiler.
10621 @item sse,387
10622 Attempt to utilize both instruction sets at once.  This effectively double the
10623 amount of available registers and on chips with separate execution units for
10624 387 and SSE the execution resources too.  Use this option with care, as it is
10625 still experimental, because the GCC register allocator does not model separate
10626 functional units well resulting in instable performance.
10627 @end table
10629 @item -masm=@var{dialect}
10630 @opindex masm=@var{dialect}
10631 Output asm instructions using selected @var{dialect}.  Supported
10632 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10633 not support @samp{intel}.
10635 @item -mieee-fp
10636 @itemx -mno-ieee-fp
10637 @opindex mieee-fp
10638 @opindex mno-ieee-fp
10639 Control whether or not the compiler uses IEEE floating point
10640 comparisons.  These handle correctly the case where the result of a
10641 comparison is unordered.
10643 @item -msoft-float
10644 @opindex msoft-float
10645 Generate output containing library calls for floating point.
10646 @strong{Warning:} the requisite libraries are not part of GCC@.
10647 Normally the facilities of the machine's usual C compiler are used, but
10648 this can't be done directly in cross-compilation.  You must make your
10649 own arrangements to provide suitable library functions for
10650 cross-compilation.
10652 On machines where a function returns floating point results in the 80387
10653 register stack, some floating point opcodes may be emitted even if
10654 @option{-msoft-float} is used.
10656 @item -mno-fp-ret-in-387
10657 @opindex mno-fp-ret-in-387
10658 Do not use the FPU registers for return values of functions.
10660 The usual calling convention has functions return values of types
10661 @code{float} and @code{double} in an FPU register, even if there
10662 is no FPU@.  The idea is that the operating system should emulate
10663 an FPU@.
10665 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10666 in ordinary CPU registers instead.
10668 @item -mno-fancy-math-387
10669 @opindex mno-fancy-math-387
10670 Some 387 emulators do not support the @code{sin}, @code{cos} and
10671 @code{sqrt} instructions for the 387.  Specify this option to avoid
10672 generating those instructions.  This option is the default on FreeBSD,
10673 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10674 indicates that the target cpu will always have an FPU and so the
10675 instruction will not need emulation.  As of revision 2.6.1, these
10676 instructions are not generated unless you also use the
10677 @option{-funsafe-math-optimizations} switch.
10679 @item -malign-double
10680 @itemx -mno-align-double
10681 @opindex malign-double
10682 @opindex mno-align-double
10683 Control whether GCC aligns @code{double}, @code{long double}, and
10684 @code{long long} variables on a two word boundary or a one word
10685 boundary.  Aligning @code{double} variables on a two word boundary will
10686 produce code that runs somewhat faster on a @samp{Pentium} at the
10687 expense of more memory.
10689 On x86-64, @option{-malign-double} is enabled by default.
10691 @strong{Warning:} if you use the @option{-malign-double} switch,
10692 structures containing the above types will be aligned differently than
10693 the published application binary interface specifications for the 386
10694 and will not be binary compatible with structures in code compiled
10695 without that switch.
10697 @item -m96bit-long-double
10698 @itemx -m128bit-long-double
10699 @opindex m96bit-long-double
10700 @opindex m128bit-long-double
10701 These switches control the size of @code{long double} type.  The i386
10702 application binary interface specifies the size to be 96 bits,
10703 so @option{-m96bit-long-double} is the default in 32 bit mode.
10705 Modern architectures (Pentium and newer) would prefer @code{long double}
10706 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10707 conforming to the ABI, this would not be possible.  So specifying a
10708 @option{-m128bit-long-double} will align @code{long double}
10709 to a 16 byte boundary by padding the @code{long double} with an additional
10710 32 bit zero.
10712 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10713 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10715 Notice that neither of these options enable any extra precision over the x87
10716 standard of 80 bits for a @code{long double}.
10718 @strong{Warning:} if you override the default value for your target ABI, the
10719 structures and arrays containing @code{long double} variables will change
10720 their size as well as function calling convention for function taking
10721 @code{long double} will be modified.  Hence they will not be binary
10722 compatible with arrays or structures in code compiled without that switch.
10724 @item -mmlarge-data-threshold=@var{number}
10725 @opindex mlarge-data-threshold=@var{number}
10726 When @option{-mcmodel=medium} is specified, the data greater than
10727 @var{threshold} are placed in large data section.  This value must be the
10728 same across all object linked into the binary and defaults to 65535.
10730 @item -mrtd
10731 @opindex mrtd
10732 Use a different function-calling convention, in which functions that
10733 take a fixed number of arguments return with the @code{ret} @var{num}
10734 instruction, which pops their arguments while returning.  This saves one
10735 instruction in the caller since there is no need to pop the arguments
10736 there.
10738 You can specify that an individual function is called with this calling
10739 sequence with the function attribute @samp{stdcall}.  You can also
10740 override the @option{-mrtd} option by using the function attribute
10741 @samp{cdecl}.  @xref{Function Attributes}.
10743 @strong{Warning:} this calling convention is incompatible with the one
10744 normally used on Unix, so you cannot use it if you need to call
10745 libraries compiled with the Unix compiler.
10747 Also, you must provide function prototypes for all functions that
10748 take variable numbers of arguments (including @code{printf});
10749 otherwise incorrect code will be generated for calls to those
10750 functions.
10752 In addition, seriously incorrect code will result if you call a
10753 function with too many arguments.  (Normally, extra arguments are
10754 harmlessly ignored.)
10756 @item -mregparm=@var{num}
10757 @opindex mregparm
10758 Control how many registers are used to pass integer arguments.  By
10759 default, no registers are used to pass arguments, and at most 3
10760 registers can be used.  You can control this behavior for a specific
10761 function by using the function attribute @samp{regparm}.
10762 @xref{Function Attributes}.
10764 @strong{Warning:} if you use this switch, and
10765 @var{num} is nonzero, then you must build all modules with the same
10766 value, including any libraries.  This includes the system libraries and
10767 startup modules.
10769 @item -msseregparm
10770 @opindex msseregparm
10771 Use SSE register passing conventions for float and double arguments
10772 and return values.  You can control this behavior for a specific
10773 function by using the function attribute @samp{sseregparm}.
10774 @xref{Function Attributes}.
10776 @strong{Warning:} if you use this switch then you must build all
10777 modules with the same value, including any libraries.  This includes
10778 the system libraries and startup modules.
10780 @item -mpc32
10781 @itemx -mpc64
10782 @itemx -mpc80
10783 @opindex mpc32
10784 @opindex mpc64
10785 @opindex mpc80
10787 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10788 is specified, the significands of results of floating-point operations are
10789 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10790 significands of results of floating-point operations to 53 bits (double
10791 precision) and @option{-mpc80} rounds the significands of results of
10792 floating-point operations to 64 bits (extended double precision), which is
10793 the default.  When this option is used, floating-point operations in higher
10794 precisions are not available to the programmer without setting the FPU
10795 control word explicitly.
10797 Setting the rounding of floating-point operations to less than the default
10798 80 bits can speed some programs by 2% or more.  Note that some mathematical
10799 libraries assume that extended precision (80 bit) floating-point operations
10800 are enabled by default; routines in such libraries could suffer significant
10801 loss of accuracy, typically through so-called "catastrophic cancellation",
10802 when this option is used to set the precision to less than extended precision. 
10804 @item -mstackrealign
10805 @opindex mstackrealign
10806 Realign the stack at entry.  On the Intel x86, the
10807 @option{-mstackrealign} option will generate an alternate prologue and
10808 epilogue that realigns the runtime stack.  This supports mixing legacy
10809 codes that keep a 4-byte aligned stack with modern codes that keep a
10810 16-byte stack for SSE compatibility.  The alternate prologue and
10811 epilogue are slower and bigger than the regular ones, and the
10812 alternate prologue requires an extra scratch register; this lowers the
10813 number of registers available if used in conjunction with the
10814 @code{regparm} attribute.  The @option{-mstackrealign} option is
10815 incompatible with the nested function prologue; this is considered a
10816 hard error.  See also the attribute @code{force_align_arg_pointer},
10817 applicable to individual functions.
10819 @item -mpreferred-stack-boundary=@var{num}
10820 @opindex mpreferred-stack-boundary
10821 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10822 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10823 the default is 4 (16 bytes or 128 bits).
10825 On Pentium and PentiumPro, @code{double} and @code{long double} values
10826 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10827 suffer significant run time performance penalties.  On Pentium III, the
10828 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10829 properly if it is not 16 byte aligned.
10831 To ensure proper alignment of this values on the stack, the stack boundary
10832 must be as aligned as that required by any value stored on the stack.
10833 Further, every function must be generated such that it keeps the stack
10834 aligned.  Thus calling a function compiled with a higher preferred
10835 stack boundary from a function compiled with a lower preferred stack
10836 boundary will most likely misalign the stack.  It is recommended that
10837 libraries that use callbacks always use the default setting.
10839 This extra alignment does consume extra stack space, and generally
10840 increases code size.  Code that is sensitive to stack space usage, such
10841 as embedded systems and operating system kernels, may want to reduce the
10842 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10844 @item -mmmx
10845 @itemx -mno-mmx
10846 @itemx -msse
10847 @itemx -mno-sse
10848 @itemx -msse2
10849 @itemx -mno-sse2
10850 @itemx -msse3
10851 @itemx -mno-sse3
10852 @itemx -mssse3
10853 @itemx -mno-ssse3
10854 @itemx -msse4.1
10855 @itemx -mno-sse4.1
10856 @itemx -msse4.2
10857 @itemx -mno-sse4.2
10858 @itemx -msse4
10859 @itemx -mno-sse4
10860 @itemx -maes
10861 @itemx -mno-aes
10862 @itemx -mpclmul
10863 @itemx -mno-pclmul
10864 @itemx -msse4a
10865 @itemx -mno-sse4a
10866 @itemx -msse5
10867 @itemx -mno-sse5
10868 @itemx -m3dnow
10869 @itemx -mno-3dnow
10870 @itemx -mpopcnt
10871 @itemx -mno-popcnt
10872 @itemx -mabm
10873 @itemx -mno-abm
10874 @opindex mmmx
10875 @opindex mno-mmx
10876 @opindex msse
10877 @opindex mno-sse
10878 @opindex m3dnow
10879 @opindex mno-3dnow
10880 These switches enable or disable the use of instructions in the MMX,
10881 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10882 3DNow!@: extended instruction sets.
10883 These extensions are also available as built-in functions: see
10884 @ref{X86 Built-in Functions}, for details of the functions enabled and
10885 disabled by these switches.
10887 To have SSE/SSE2 instructions generated automatically from floating-point
10888 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10890 These options will enable GCC to use these extended instructions in
10891 generated code, even without @option{-mfpmath=sse}.  Applications which
10892 perform runtime CPU detection must compile separate files for each
10893 supported architecture, using the appropriate flags.  In particular,
10894 the file containing the CPU detection code should be compiled without
10895 these options.
10897 @item -mcld
10898 @opindex mcld
10899 This option instructs GCC to emit a @code{cld} instruction in the prologue
10900 of functions that use string instructions.  String instructions depend on
10901 the DF flag to select between autoincrement or autodecrement mode.  While the
10902 ABI specifies the DF flag to be cleared on function entry, some operating
10903 systems violate this specification by not clearing the DF flag in their
10904 exception dispatchers.  The exception handler can be invoked with the DF flag
10905 set which leads to wrong direction mode, when string instructions are used.
10906 This option can be enabled by default on 32-bit x86 targets by configuring
10907 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
10908 instructions can be suppressed with the @option{-mno-cld} compiler option
10909 in this case.
10911 @item -mcx16
10912 @opindex mcx16
10913 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10914 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10915 data types.  This is useful for high resolution counters that could be updated
10916 by multiple processors (or cores).  This instruction is generated as part of
10917 atomic built-in functions: see @ref{Atomic Builtins} for details.
10919 @item -msahf
10920 @opindex msahf
10921 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10922 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10923 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10924 SAHF are load and store instructions, respectively, for certain status flags.
10925 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10926 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10928 @item -mrecip
10929 @opindex mrecip
10930 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10931 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10932 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10933 variants) for single precision floating point arguments.  These instructions
10934 are generated only when @option{-funsafe-math-optimizations} is enabled
10935 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10936 Note that while the throughput of the sequence is higher than the throughput
10937 of the non-reciprocal instruction, the precision of the sequence can be
10938 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10940 @item -mveclibabi=@var{type}
10941 @opindex mveclibabi
10942 Specifies the ABI type to use for vectorizing intrinsics using an
10943 external library.  Supported types are @code{svml} for the Intel short
10944 vector math library and @code{acml} for the AMD math core library style
10945 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10946 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10947 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10948 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10949 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10950 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10951 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10952 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10953 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10954 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10955 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10956 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10957 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10958 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10959 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10960 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10961 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10962 compatible library will have to be specified at link time.
10964 @item -mpush-args
10965 @itemx -mno-push-args
10966 @opindex mpush-args
10967 @opindex mno-push-args
10968 Use PUSH operations to store outgoing parameters.  This method is shorter
10969 and usually equally fast as method using SUB/MOV operations and is enabled
10970 by default.  In some cases disabling it may improve performance because of
10971 improved scheduling and reduced dependencies.
10973 @item -maccumulate-outgoing-args
10974 @opindex maccumulate-outgoing-args
10975 If enabled, the maximum amount of space required for outgoing arguments will be
10976 computed in the function prologue.  This is faster on most modern CPUs
10977 because of reduced dependencies, improved scheduling and reduced stack usage
10978 when preferred stack boundary is not equal to 2.  The drawback is a notable
10979 increase in code size.  This switch implies @option{-mno-push-args}.
10981 @item -mthreads
10982 @opindex mthreads
10983 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10984 on thread-safe exception handling must compile and link all code with the
10985 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10986 @option{-D_MT}; when linking, it links in a special thread helper library
10987 @option{-lmingwthrd} which cleans up per thread exception handling data.
10989 @item -mno-align-stringops
10990 @opindex mno-align-stringops
10991 Do not align destination of inlined string operations.  This switch reduces
10992 code size and improves performance in case the destination is already aligned,
10993 but GCC doesn't know about it.
10995 @item -minline-all-stringops
10996 @opindex minline-all-stringops
10997 By default GCC inlines string operations only when destination is known to be
10998 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10999 size, but may improve performance of code that depends on fast memcpy, strlen
11000 and memset for short lengths.
11002 @item -minline-stringops-dynamically
11003 @opindex minline-stringops-dynamically
11004 For string operation of unknown size, inline runtime checks so for small
11005 blocks inline code is used, while for large blocks library call is used.
11007 @item -mstringop-strategy=@var{alg}
11008 @opindex mstringop-strategy=@var{alg}
11009 Overwrite internal decision heuristic about particular algorithm to inline
11010 string operation with.  The allowed values are @code{rep_byte},
11011 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
11012 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
11013 expanding inline loop, @code{libcall} for always expanding library call.
11015 @item -momit-leaf-frame-pointer
11016 @opindex momit-leaf-frame-pointer
11017 Don't keep the frame pointer in a register for leaf functions.  This
11018 avoids the instructions to save, set up and restore frame pointers and
11019 makes an extra register available in leaf functions.  The option
11020 @option{-fomit-frame-pointer} removes the frame pointer for all functions
11021 which might make debugging harder.
11023 @item -mtls-direct-seg-refs
11024 @itemx -mno-tls-direct-seg-refs
11025 @opindex mtls-direct-seg-refs
11026 Controls whether TLS variables may be accessed with offsets from the
11027 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
11028 or whether the thread base pointer must be added.  Whether or not this
11029 is legal depends on the operating system, and whether it maps the
11030 segment to cover the entire TLS area.
11032 For systems that use GNU libc, the default is on.
11034 @item -mfused-madd
11035 @itemx -mno-fused-madd
11036 @opindex mfused-madd
11037 Enable automatic generation of fused floating point multiply-add instructions
11038 if the ISA supports such instructions.  The -mfused-madd option is on by
11039 default.  The fused multiply-add instructions have a different
11040 rounding behavior compared to executing a multiply followed by an add.
11041 @end table
11043 These @samp{-m} switches are supported in addition to the above
11044 on AMD x86-64 processors in 64-bit environments.
11046 @table @gcctabopt
11047 @item -m32
11048 @itemx -m64
11049 @opindex m32
11050 @opindex m64
11051 Generate code for a 32-bit or 64-bit environment.
11052 The 32-bit environment sets int, long and pointer to 32 bits and
11053 generates code that runs on any i386 system.
11054 The 64-bit environment sets int to 32 bits and long and pointer
11055 to 64 bits and generates code for AMD's x86-64 architecture. For
11056 darwin only the -m64 option turns off the @option{-fno-pic} and
11057 @option{-mdynamic-no-pic} options.
11059 @item -mno-red-zone
11060 @opindex no-red-zone
11061 Do not use a so called red zone for x86-64 code.  The red zone is mandated
11062 by the x86-64 ABI, it is a 128-byte area beyond the location of the
11063 stack pointer that will not be modified by signal or interrupt handlers
11064 and therefore can be used for temporary data without adjusting the stack
11065 pointer.  The flag @option{-mno-red-zone} disables this red zone.
11067 @item -mcmodel=small
11068 @opindex mcmodel=small
11069 Generate code for the small code model: the program and its symbols must
11070 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
11071 Programs can be statically or dynamically linked.  This is the default
11072 code model.
11074 @item -mcmodel=kernel
11075 @opindex mcmodel=kernel
11076 Generate code for the kernel code model.  The kernel runs in the
11077 negative 2 GB of the address space.
11078 This model has to be used for Linux kernel code.
11080 @item -mcmodel=medium
11081 @opindex mcmodel=medium
11082 Generate code for the medium model: The program is linked in the lower 2
11083 GB of the address space but symbols can be located anywhere in the
11084 address space.  Programs can be statically or dynamically linked, but
11085 building of shared libraries are not supported with the medium model.
11087 @item -mcmodel=large
11088 @opindex mcmodel=large
11089 Generate code for the large model: This model makes no assumptions
11090 about addresses and sizes of sections.
11091 @end table
11093 @node IA-64 Options
11094 @subsection IA-64 Options
11095 @cindex IA-64 Options
11097 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11099 @table @gcctabopt
11100 @item -mbig-endian
11101 @opindex mbig-endian
11102 Generate code for a big endian target.  This is the default for HP-UX@.
11104 @item -mlittle-endian
11105 @opindex mlittle-endian
11106 Generate code for a little endian target.  This is the default for AIX5
11107 and GNU/Linux.
11109 @item -mgnu-as
11110 @itemx -mno-gnu-as
11111 @opindex mgnu-as
11112 @opindex mno-gnu-as
11113 Generate (or don't) code for the GNU assembler.  This is the default.
11114 @c Also, this is the default if the configure option @option{--with-gnu-as}
11115 @c is used.
11117 @item -mgnu-ld
11118 @itemx -mno-gnu-ld
11119 @opindex mgnu-ld
11120 @opindex mno-gnu-ld
11121 Generate (or don't) code for the GNU linker.  This is the default.
11122 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11123 @c is used.
11125 @item -mno-pic
11126 @opindex mno-pic
11127 Generate code that does not use a global pointer register.  The result
11128 is not position independent code, and violates the IA-64 ABI@.
11130 @item -mvolatile-asm-stop
11131 @itemx -mno-volatile-asm-stop
11132 @opindex mvolatile-asm-stop
11133 @opindex mno-volatile-asm-stop
11134 Generate (or don't) a stop bit immediately before and after volatile asm
11135 statements.
11137 @item -mregister-names
11138 @itemx -mno-register-names
11139 @opindex mregister-names
11140 @opindex mno-register-names
11141 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11142 the stacked registers.  This may make assembler output more readable.
11144 @item -mno-sdata
11145 @itemx -msdata
11146 @opindex mno-sdata
11147 @opindex msdata
11148 Disable (or enable) optimizations that use the small data section.  This may
11149 be useful for working around optimizer bugs.
11151 @item -mconstant-gp
11152 @opindex mconstant-gp
11153 Generate code that uses a single constant global pointer value.  This is
11154 useful when compiling kernel code.
11156 @item -mauto-pic
11157 @opindex mauto-pic
11158 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11159 This is useful when compiling firmware code.
11161 @item -minline-float-divide-min-latency
11162 @opindex minline-float-divide-min-latency
11163 Generate code for inline divides of floating point values
11164 using the minimum latency algorithm.
11166 @item -minline-float-divide-max-throughput
11167 @opindex minline-float-divide-max-throughput
11168 Generate code for inline divides of floating point values
11169 using the maximum throughput algorithm.
11171 @item -minline-int-divide-min-latency
11172 @opindex minline-int-divide-min-latency
11173 Generate code for inline divides of integer values
11174 using the minimum latency algorithm.
11176 @item -minline-int-divide-max-throughput
11177 @opindex minline-int-divide-max-throughput
11178 Generate code for inline divides of integer values
11179 using the maximum throughput algorithm.
11181 @item -minline-sqrt-min-latency
11182 @opindex minline-sqrt-min-latency
11183 Generate code for inline square roots
11184 using the minimum latency algorithm.
11186 @item -minline-sqrt-max-throughput
11187 @opindex minline-sqrt-max-throughput
11188 Generate code for inline square roots
11189 using the maximum throughput algorithm.
11191 @item -mno-dwarf2-asm
11192 @itemx -mdwarf2-asm
11193 @opindex mno-dwarf2-asm
11194 @opindex mdwarf2-asm
11195 Don't (or do) generate assembler code for the DWARF2 line number debugging
11196 info.  This may be useful when not using the GNU assembler.
11198 @item -mearly-stop-bits
11199 @itemx -mno-early-stop-bits
11200 @opindex mearly-stop-bits
11201 @opindex mno-early-stop-bits
11202 Allow stop bits to be placed earlier than immediately preceding the
11203 instruction that triggered the stop bit.  This can improve instruction
11204 scheduling, but does not always do so.
11206 @item -mfixed-range=@var{register-range}
11207 @opindex mfixed-range
11208 Generate code treating the given register range as fixed registers.
11209 A fixed register is one that the register allocator can not use.  This is
11210 useful when compiling kernel code.  A register range is specified as
11211 two registers separated by a dash.  Multiple register ranges can be
11212 specified separated by a comma.
11214 @item -mtls-size=@var{tls-size}
11215 @opindex mtls-size
11216 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11219 @item -mtune=@var{cpu-type}
11220 @opindex mtune
11221 Tune the instruction scheduling for a particular CPU, Valid values are
11222 itanium, itanium1, merced, itanium2, and mckinley.
11224 @item -mt
11225 @itemx -pthread
11226 @opindex mt
11227 @opindex pthread
11228 Add support for multithreading using the POSIX threads library.  This
11229 option sets flags for both the preprocessor and linker.  It does
11230 not affect the thread safety of object code produced by the compiler or
11231 that of libraries supplied with it.  These are HP-UX specific flags.
11233 @item -milp32
11234 @itemx -mlp64
11235 @opindex milp32
11236 @opindex mlp64
11237 Generate code for a 32-bit or 64-bit environment.
11238 The 32-bit environment sets int, long and pointer to 32 bits.
11239 The 64-bit environment sets int to 32 bits and long and pointer
11240 to 64 bits.  These are HP-UX specific flags.
11242 @item -mno-sched-br-data-spec
11243 @itemx -msched-br-data-spec
11244 @opindex mno-sched-br-data-spec
11245 @opindex msched-br-data-spec
11246 (Dis/En)able data speculative scheduling before reload.
11247 This will result in generation of the ld.a instructions and
11248 the corresponding check instructions (ld.c / chk.a).
11249 The default is 'disable'.
11251 @item -msched-ar-data-spec
11252 @itemx -mno-sched-ar-data-spec
11253 @opindex msched-ar-data-spec
11254 @opindex mno-sched-ar-data-spec
11255 (En/Dis)able data speculative scheduling after reload.
11256 This will result in generation of the ld.a instructions and
11257 the corresponding check instructions (ld.c / chk.a).
11258 The default is 'enable'.
11260 @item -mno-sched-control-spec
11261 @itemx -msched-control-spec
11262 @opindex mno-sched-control-spec
11263 @opindex msched-control-spec
11264 (Dis/En)able control speculative scheduling.  This feature is
11265 available only during region scheduling (i.e.@: before reload).
11266 This will result in generation of the ld.s instructions and
11267 the corresponding check instructions chk.s .
11268 The default is 'disable'.
11270 @item -msched-br-in-data-spec
11271 @itemx -mno-sched-br-in-data-spec
11272 @opindex msched-br-in-data-spec
11273 @opindex mno-sched-br-in-data-spec
11274 (En/Dis)able speculative scheduling of the instructions that
11275 are dependent on the data speculative loads before reload.
11276 This is effective only with @option{-msched-br-data-spec} enabled.
11277 The default is 'enable'.
11279 @item -msched-ar-in-data-spec
11280 @itemx -mno-sched-ar-in-data-spec
11281 @opindex msched-ar-in-data-spec
11282 @opindex mno-sched-ar-in-data-spec
11283 (En/Dis)able speculative scheduling of the instructions that
11284 are dependent on the data speculative loads after reload.
11285 This is effective only with @option{-msched-ar-data-spec} enabled.
11286 The default is 'enable'.
11288 @item -msched-in-control-spec
11289 @itemx -mno-sched-in-control-spec
11290 @opindex msched-in-control-spec
11291 @opindex mno-sched-in-control-spec
11292 (En/Dis)able speculative scheduling of the instructions that
11293 are dependent on the control speculative loads.
11294 This is effective only with @option{-msched-control-spec} enabled.
11295 The default is 'enable'.
11297 @item -msched-ldc
11298 @itemx -mno-sched-ldc
11299 @opindex msched-ldc
11300 @opindex mno-sched-ldc
11301 (En/Dis)able use of simple data speculation checks ld.c .
11302 If disabled, only chk.a instructions will be emitted to check
11303 data speculative loads.
11304 The default is 'enable'.
11306 @item -mno-sched-control-ldc
11307 @itemx -msched-control-ldc
11308 @opindex mno-sched-control-ldc
11309 @opindex msched-control-ldc
11310 (Dis/En)able use of ld.c instructions to check control speculative loads.
11311 If enabled, in case of control speculative load with no speculatively
11312 scheduled dependent instructions this load will be emitted as ld.sa and
11313 ld.c will be used to check it.
11314 The default is 'disable'.
11316 @item -mno-sched-spec-verbose
11317 @itemx -msched-spec-verbose
11318 @opindex mno-sched-spec-verbose
11319 @opindex msched-spec-verbose
11320 (Dis/En)able printing of the information about speculative motions.
11322 @item -mno-sched-prefer-non-data-spec-insns
11323 @itemx -msched-prefer-non-data-spec-insns
11324 @opindex mno-sched-prefer-non-data-spec-insns
11325 @opindex msched-prefer-non-data-spec-insns
11326 If enabled, data speculative instructions will be chosen for schedule
11327 only if there are no other choices at the moment.  This will make
11328 the use of the data speculation much more conservative.
11329 The default is 'disable'.
11331 @item -mno-sched-prefer-non-control-spec-insns
11332 @itemx -msched-prefer-non-control-spec-insns
11333 @opindex mno-sched-prefer-non-control-spec-insns
11334 @opindex msched-prefer-non-control-spec-insns
11335 If enabled, control speculative instructions will be chosen for schedule
11336 only if there are no other choices at the moment.  This will make
11337 the use of the control speculation much more conservative.
11338 The default is 'disable'.
11340 @item -mno-sched-count-spec-in-critical-path
11341 @itemx -msched-count-spec-in-critical-path
11342 @opindex mno-sched-count-spec-in-critical-path
11343 @opindex msched-count-spec-in-critical-path
11344 If enabled, speculative dependencies will be considered during
11345 computation of the instructions priorities.  This will make the use of the
11346 speculation a bit more conservative.
11347 The default is 'disable'.
11349 @end table
11351 @node M32C Options
11352 @subsection M32C Options
11353 @cindex M32C options
11355 @table @gcctabopt
11356 @item -mcpu=@var{name}
11357 @opindex mcpu=
11358 Select the CPU for which code is generated.  @var{name} may be one of
11359 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11360 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11361 the M32C/80 series.
11363 @item -msim
11364 @opindex msim
11365 Specifies that the program will be run on the simulator.  This causes
11366 an alternate runtime library to be linked in which supports, for
11367 example, file I/O@.  You must not use this option when generating
11368 programs that will run on real hardware; you must provide your own
11369 runtime library for whatever I/O functions are needed.
11371 @item -memregs=@var{number}
11372 @opindex memregs=
11373 Specifies the number of memory-based pseudo-registers GCC will use
11374 during code generation.  These pseudo-registers will be used like real
11375 registers, so there is a tradeoff between GCC's ability to fit the
11376 code into available registers, and the performance penalty of using
11377 memory instead of registers.  Note that all modules in a program must
11378 be compiled with the same value for this option.  Because of that, you
11379 must not use this option with the default runtime libraries gcc
11380 builds.
11382 @end table
11384 @node M32R/D Options
11385 @subsection M32R/D Options
11386 @cindex M32R/D options
11388 These @option{-m} options are defined for Renesas M32R/D architectures:
11390 @table @gcctabopt
11391 @item -m32r2
11392 @opindex m32r2
11393 Generate code for the M32R/2@.
11395 @item -m32rx
11396 @opindex m32rx
11397 Generate code for the M32R/X@.
11399 @item -m32r
11400 @opindex m32r
11401 Generate code for the M32R@.  This is the default.
11403 @item -mmodel=small
11404 @opindex mmodel=small
11405 Assume all objects live in the lower 16MB of memory (so that their addresses
11406 can be loaded with the @code{ld24} instruction), and assume all subroutines
11407 are reachable with the @code{bl} instruction.
11408 This is the default.
11410 The addressability of a particular object can be set with the
11411 @code{model} attribute.
11413 @item -mmodel=medium
11414 @opindex mmodel=medium
11415 Assume objects may be anywhere in the 32-bit address space (the compiler
11416 will generate @code{seth/add3} instructions to load their addresses), and
11417 assume all subroutines are reachable with the @code{bl} instruction.
11419 @item -mmodel=large
11420 @opindex mmodel=large
11421 Assume objects may be anywhere in the 32-bit address space (the compiler
11422 will generate @code{seth/add3} instructions to load their addresses), and
11423 assume subroutines may not be reachable with the @code{bl} instruction
11424 (the compiler will generate the much slower @code{seth/add3/jl}
11425 instruction sequence).
11427 @item -msdata=none
11428 @opindex msdata=none
11429 Disable use of the small data area.  Variables will be put into
11430 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11431 @code{section} attribute has been specified).
11432 This is the default.
11434 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11435 Objects may be explicitly put in the small data area with the
11436 @code{section} attribute using one of these sections.
11438 @item -msdata=sdata
11439 @opindex msdata=sdata
11440 Put small global and static data in the small data area, but do not
11441 generate special code to reference them.
11443 @item -msdata=use
11444 @opindex msdata=use
11445 Put small global and static data in the small data area, and generate
11446 special instructions to reference them.
11448 @item -G @var{num}
11449 @opindex G
11450 @cindex smaller data references
11451 Put global and static objects less than or equal to @var{num} bytes
11452 into the small data or bss sections instead of the normal data or bss
11453 sections.  The default value of @var{num} is 8.
11454 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11455 for this option to have any effect.
11457 All modules should be compiled with the same @option{-G @var{num}} value.
11458 Compiling with different values of @var{num} may or may not work; if it
11459 doesn't the linker will give an error message---incorrect code will not be
11460 generated.
11462 @item -mdebug
11463 @opindex mdebug
11464 Makes the M32R specific code in the compiler display some statistics
11465 that might help in debugging programs.
11467 @item -malign-loops
11468 @opindex malign-loops
11469 Align all loops to a 32-byte boundary.
11471 @item -mno-align-loops
11472 @opindex mno-align-loops
11473 Do not enforce a 32-byte alignment for loops.  This is the default.
11475 @item -missue-rate=@var{number}
11476 @opindex missue-rate=@var{number}
11477 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11478 or 2.
11480 @item -mbranch-cost=@var{number}
11481 @opindex mbranch-cost=@var{number}
11482 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11483 preferred over conditional code, if it is 2, then the opposite will
11484 apply.
11486 @item -mflush-trap=@var{number}
11487 @opindex mflush-trap=@var{number}
11488 Specifies the trap number to use to flush the cache.  The default is
11489 12.  Valid numbers are between 0 and 15 inclusive.
11491 @item -mno-flush-trap
11492 @opindex mno-flush-trap
11493 Specifies that the cache cannot be flushed by using a trap.
11495 @item -mflush-func=@var{name}
11496 @opindex mflush-func=@var{name}
11497 Specifies the name of the operating system function to call to flush
11498 the cache.  The default is @emph{_flush_cache}, but a function call
11499 will only be used if a trap is not available.
11501 @item -mno-flush-func
11502 @opindex mno-flush-func
11503 Indicates that there is no OS function for flushing the cache.
11505 @end table
11507 @node M680x0 Options
11508 @subsection M680x0 Options
11509 @cindex M680x0 options
11511 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11512 The default settings depend on which architecture was selected when
11513 the compiler was configured; the defaults for the most common choices
11514 are given below.
11516 @table @gcctabopt
11517 @item -march=@var{arch}
11518 @opindex march
11519 Generate code for a specific M680x0 or ColdFire instruction set
11520 architecture.  Permissible values of @var{arch} for M680x0
11521 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11522 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11523 architectures are selected according to Freescale's ISA classification
11524 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11525 @samp{isab} and @samp{isac}.
11527 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11528 code for a ColdFire target.  The @var{arch} in this macro is one of the
11529 @option{-march} arguments given above.
11531 When used together, @option{-march} and @option{-mtune} select code
11532 that runs on a family of similar processors but that is optimized
11533 for a particular microarchitecture.
11535 @item -mcpu=@var{cpu}
11536 @opindex mcpu
11537 Generate code for a specific M680x0 or ColdFire processor.
11538 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11539 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11540 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11541 below, which also classifies the CPUs into families:
11543 @multitable @columnfractions 0.20 0.80
11544 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11545 @item @samp{51qe} @tab @samp{51qe}
11546 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11547 @item @samp{5206e} @tab @samp{5206e}
11548 @item @samp{5208} @tab @samp{5207} @samp{5208}
11549 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11550 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11551 @item @samp{5216} @tab @samp{5214} @samp{5216}
11552 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11553 @item @samp{5225} @tab @samp{5224} @samp{5225}
11554 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11555 @item @samp{5249} @tab @samp{5249}
11556 @item @samp{5250} @tab @samp{5250}
11557 @item @samp{5271} @tab @samp{5270} @samp{5271}
11558 @item @samp{5272} @tab @samp{5272}
11559 @item @samp{5275} @tab @samp{5274} @samp{5275}
11560 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11561 @item @samp{5307} @tab @samp{5307}
11562 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11563 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11564 @item @samp{5407} @tab @samp{5407}
11565 @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}
11566 @end multitable
11568 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11569 @var{arch} is compatible with @var{cpu}.  Other combinations of
11570 @option{-mcpu} and @option{-march} are rejected.
11572 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11573 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11574 where the value of @var{family} is given by the table above.
11576 @item -mtune=@var{tune}
11577 @opindex mtune
11578 Tune the code for a particular microarchitecture, within the
11579 constraints set by @option{-march} and @option{-mcpu}.
11580 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11581 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11582 and @samp{cpu32}.  The ColdFire microarchitectures
11583 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11585 You can also use @option{-mtune=68020-40} for code that needs
11586 to run relatively well on 68020, 68030 and 68040 targets.
11587 @option{-mtune=68020-60} is similar but includes 68060 targets
11588 as well.  These two options select the same tuning decisions as
11589 @option{-m68020-40} and @option{-m68020-60} respectively.
11591 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11592 when tuning for 680x0 architecture @var{arch}.  It also defines
11593 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11594 option is used.  If gcc is tuning for a range of architectures,
11595 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11596 it defines the macros for every architecture in the range.
11598 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11599 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11600 of the arguments given above.
11602 @item -m68000
11603 @itemx -mc68000
11604 @opindex m68000
11605 @opindex mc68000
11606 Generate output for a 68000.  This is the default
11607 when the compiler is configured for 68000-based systems.
11608 It is equivalent to @option{-march=68000}.
11610 Use this option for microcontrollers with a 68000 or EC000 core,
11611 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11613 @item -m68010
11614 @opindex m68010
11615 Generate output for a 68010.  This is the default
11616 when the compiler is configured for 68010-based systems.
11617 It is equivalent to @option{-march=68010}.
11619 @item -m68020
11620 @itemx -mc68020
11621 @opindex m68020
11622 @opindex mc68020
11623 Generate output for a 68020.  This is the default
11624 when the compiler is configured for 68020-based systems.
11625 It is equivalent to @option{-march=68020}.
11627 @item -m68030
11628 @opindex m68030
11629 Generate output for a 68030.  This is the default when the compiler is
11630 configured for 68030-based systems.  It is equivalent to
11631 @option{-march=68030}.
11633 @item -m68040
11634 @opindex m68040
11635 Generate output for a 68040.  This is the default when the compiler is
11636 configured for 68040-based systems.  It is equivalent to
11637 @option{-march=68040}.
11639 This option inhibits the use of 68881/68882 instructions that have to be
11640 emulated by software on the 68040.  Use this option if your 68040 does not
11641 have code to emulate those instructions.
11643 @item -m68060
11644 @opindex m68060
11645 Generate output for a 68060.  This is the default when the compiler is
11646 configured for 68060-based systems.  It is equivalent to
11647 @option{-march=68060}.
11649 This option inhibits the use of 68020 and 68881/68882 instructions that
11650 have to be emulated by software on the 68060.  Use this option if your 68060
11651 does not have code to emulate those instructions.
11653 @item -mcpu32
11654 @opindex mcpu32
11655 Generate output for a CPU32.  This is the default
11656 when the compiler is configured for CPU32-based systems.
11657 It is equivalent to @option{-march=cpu32}.
11659 Use this option for microcontrollers with a
11660 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11661 68336, 68340, 68341, 68349 and 68360.
11663 @item -m5200
11664 @opindex m5200
11665 Generate output for a 520X ColdFire CPU@.  This is the default
11666 when the compiler is configured for 520X-based systems.
11667 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11668 in favor of that option.
11670 Use this option for microcontroller with a 5200 core, including
11671 the MCF5202, MCF5203, MCF5204 and MCF5206.
11673 @item -m5206e
11674 @opindex m5206e
11675 Generate output for a 5206e ColdFire CPU@.  The option is now
11676 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11678 @item -m528x
11679 @opindex m528x
11680 Generate output for a member of the ColdFire 528X family.
11681 The option is now deprecated in favor of the equivalent
11682 @option{-mcpu=528x}.
11684 @item -m5307
11685 @opindex m5307
11686 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11687 in favor of the equivalent @option{-mcpu=5307}.
11689 @item -m5407
11690 @opindex m5407
11691 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11692 in favor of the equivalent @option{-mcpu=5407}.
11694 @item -mcfv4e
11695 @opindex mcfv4e
11696 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11697 This includes use of hardware floating point instructions.
11698 The option is equivalent to @option{-mcpu=547x}, and is now
11699 deprecated in favor of that option.
11701 @item -m68020-40
11702 @opindex m68020-40
11703 Generate output for a 68040, without using any of the new instructions.
11704 This results in code which can run relatively efficiently on either a
11705 68020/68881 or a 68030 or a 68040.  The generated code does use the
11706 68881 instructions that are emulated on the 68040.
11708 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11710 @item -m68020-60
11711 @opindex m68020-60
11712 Generate output for a 68060, without using any of the new instructions.
11713 This results in code which can run relatively efficiently on either a
11714 68020/68881 or a 68030 or a 68040.  The generated code does use the
11715 68881 instructions that are emulated on the 68060.
11717 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11719 @item -mhard-float
11720 @itemx -m68881
11721 @opindex mhard-float
11722 @opindex m68881
11723 Generate floating-point instructions.  This is the default for 68020
11724 and above, and for ColdFire devices that have an FPU@.  It defines the
11725 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11726 on ColdFire targets.
11728 @item -msoft-float
11729 @opindex msoft-float
11730 Do not generate floating-point instructions; use library calls instead.
11731 This is the default for 68000, 68010, and 68832 targets.  It is also
11732 the default for ColdFire devices that have no FPU.
11734 @item -mdiv
11735 @itemx -mno-div
11736 @opindex mdiv
11737 @opindex mno-div
11738 Generate (do not generate) ColdFire hardware divide and remainder
11739 instructions.  If @option{-march} is used without @option{-mcpu},
11740 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11741 architectures.  Otherwise, the default is taken from the target CPU
11742 (either the default CPU, or the one specified by @option{-mcpu}).  For
11743 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11744 @option{-mcpu=5206e}.
11746 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11748 @item -mshort
11749 @opindex mshort
11750 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11751 Additionally, parameters passed on the stack are also aligned to a
11752 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11754 @item -mno-short
11755 @opindex mno-short
11756 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11758 @item -mnobitfield
11759 @itemx -mno-bitfield
11760 @opindex mnobitfield
11761 @opindex mno-bitfield
11762 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11763 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11765 @item -mbitfield
11766 @opindex mbitfield
11767 Do use the bit-field instructions.  The @option{-m68020} option implies
11768 @option{-mbitfield}.  This is the default if you use a configuration
11769 designed for a 68020.
11771 @item -mrtd
11772 @opindex mrtd
11773 Use a different function-calling convention, in which functions
11774 that take a fixed number of arguments return with the @code{rtd}
11775 instruction, which pops their arguments while returning.  This
11776 saves one instruction in the caller since there is no need to pop
11777 the arguments there.
11779 This calling convention is incompatible with the one normally
11780 used on Unix, so you cannot use it if you need to call libraries
11781 compiled with the Unix compiler.
11783 Also, you must provide function prototypes for all functions that
11784 take variable numbers of arguments (including @code{printf});
11785 otherwise incorrect code will be generated for calls to those
11786 functions.
11788 In addition, seriously incorrect code will result if you call a
11789 function with too many arguments.  (Normally, extra arguments are
11790 harmlessly ignored.)
11792 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11793 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11795 @item -mno-rtd
11796 @opindex mno-rtd
11797 Do not use the calling conventions selected by @option{-mrtd}.
11798 This is the default.
11800 @item -malign-int
11801 @itemx -mno-align-int
11802 @opindex malign-int
11803 @opindex mno-align-int
11804 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11805 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11806 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11807 Aligning variables on 32-bit boundaries produces code that runs somewhat
11808 faster on processors with 32-bit busses at the expense of more memory.
11810 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11811 align structures containing the above types  differently than
11812 most published application binary interface specifications for the m68k.
11814 @item -mpcrel
11815 @opindex mpcrel
11816 Use the pc-relative addressing mode of the 68000 directly, instead of
11817 using a global offset table.  At present, this option implies @option{-fpic},
11818 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11819 not presently supported with @option{-mpcrel}, though this could be supported for
11820 68020 and higher processors.
11822 @item -mno-strict-align
11823 @itemx -mstrict-align
11824 @opindex mno-strict-align
11825 @opindex mstrict-align
11826 Do not (do) assume that unaligned memory references will be handled by
11827 the system.
11829 @item -msep-data
11830 Generate code that allows the data segment to be located in a different
11831 area of memory from the text segment.  This allows for execute in place in
11832 an environment without virtual memory management.  This option implies
11833 @option{-fPIC}.
11835 @item -mno-sep-data
11836 Generate code that assumes that the data segment follows the text segment.
11837 This is the default.
11839 @item -mid-shared-library
11840 Generate code that supports shared libraries via the library ID method.
11841 This allows for execute in place and shared libraries in an environment
11842 without virtual memory management.  This option implies @option{-fPIC}.
11844 @item -mno-id-shared-library
11845 Generate code that doesn't assume ID based shared libraries are being used.
11846 This is the default.
11848 @item -mshared-library-id=n
11849 Specified the identification number of the ID based shared library being
11850 compiled.  Specifying a value of 0 will generate more compact code, specifying
11851 other values will force the allocation of that number to the current
11852 library but is no more space or time efficient than omitting this option.
11854 @end table
11856 @node M68hc1x Options
11857 @subsection M68hc1x Options
11858 @cindex M68hc1x options
11860 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11861 microcontrollers.  The default values for these options depends on
11862 which style of microcontroller was selected when the compiler was configured;
11863 the defaults for the most common choices are given below.
11865 @table @gcctabopt
11866 @item -m6811
11867 @itemx -m68hc11
11868 @opindex m6811
11869 @opindex m68hc11
11870 Generate output for a 68HC11.  This is the default
11871 when the compiler is configured for 68HC11-based systems.
11873 @item -m6812
11874 @itemx -m68hc12
11875 @opindex m6812
11876 @opindex m68hc12
11877 Generate output for a 68HC12.  This is the default
11878 when the compiler is configured for 68HC12-based systems.
11880 @item -m68S12
11881 @itemx -m68hcs12
11882 @opindex m68S12
11883 @opindex m68hcs12
11884 Generate output for a 68HCS12.
11886 @item -mauto-incdec
11887 @opindex mauto-incdec
11888 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11889 addressing modes.
11891 @item -minmax
11892 @itemx -nominmax
11893 @opindex minmax
11894 @opindex mnominmax
11895 Enable the use of 68HC12 min and max instructions.
11897 @item -mlong-calls
11898 @itemx -mno-long-calls
11899 @opindex mlong-calls
11900 @opindex mno-long-calls
11901 Treat all calls as being far away (near).  If calls are assumed to be
11902 far away, the compiler will use the @code{call} instruction to
11903 call a function and the @code{rtc} instruction for returning.
11905 @item -mshort
11906 @opindex mshort
11907 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11909 @item -msoft-reg-count=@var{count}
11910 @opindex msoft-reg-count
11911 Specify the number of pseudo-soft registers which are used for the
11912 code generation.  The maximum number is 32.  Using more pseudo-soft
11913 register may or may not result in better code depending on the program.
11914 The default is 4 for 68HC11 and 2 for 68HC12.
11916 @end table
11918 @node MCore Options
11919 @subsection MCore Options
11920 @cindex MCore options
11922 These are the @samp{-m} options defined for the Motorola M*Core
11923 processors.
11925 @table @gcctabopt
11927 @item -mhardlit
11928 @itemx -mno-hardlit
11929 @opindex mhardlit
11930 @opindex mno-hardlit
11931 Inline constants into the code stream if it can be done in two
11932 instructions or less.
11934 @item -mdiv
11935 @itemx -mno-div
11936 @opindex mdiv
11937 @opindex mno-div
11938 Use the divide instruction.  (Enabled by default).
11940 @item -mrelax-immediate
11941 @itemx -mno-relax-immediate
11942 @opindex mrelax-immediate
11943 @opindex mno-relax-immediate
11944 Allow arbitrary sized immediates in bit operations.
11946 @item -mwide-bitfields
11947 @itemx -mno-wide-bitfields
11948 @opindex mwide-bitfields
11949 @opindex mno-wide-bitfields
11950 Always treat bit-fields as int-sized.
11952 @item -m4byte-functions
11953 @itemx -mno-4byte-functions
11954 @opindex m4byte-functions
11955 @opindex mno-4byte-functions
11956 Force all functions to be aligned to a four byte boundary.
11958 @item -mcallgraph-data
11959 @itemx -mno-callgraph-data
11960 @opindex mcallgraph-data
11961 @opindex mno-callgraph-data
11962 Emit callgraph information.
11964 @item -mslow-bytes
11965 @itemx -mno-slow-bytes
11966 @opindex mslow-bytes
11967 @opindex mno-slow-bytes
11968 Prefer word access when reading byte quantities.
11970 @item -mlittle-endian
11971 @itemx -mbig-endian
11972 @opindex mlittle-endian
11973 @opindex mbig-endian
11974 Generate code for a little endian target.
11976 @item -m210
11977 @itemx -m340
11978 @opindex m210
11979 @opindex m340
11980 Generate code for the 210 processor.
11981 @end table
11983 @node MIPS Options
11984 @subsection MIPS Options
11985 @cindex MIPS options
11987 @table @gcctabopt
11989 @item -EB
11990 @opindex EB
11991 Generate big-endian code.
11993 @item -EL
11994 @opindex EL
11995 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11996 configurations.
11998 @item -march=@var{arch}
11999 @opindex march
12000 Generate code that will run on @var{arch}, which can be the name of a
12001 generic MIPS ISA, or the name of a particular processor.
12002 The ISA names are:
12003 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
12004 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
12005 The processor names are:
12006 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
12007 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
12008 @samp{5kc}, @samp{5kf},
12009 @samp{20kc},
12010 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
12011 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
12012 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
12013 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
12014 @samp{loongson2e}, @samp{loongson2f},
12015 @samp{m4k},
12016 @samp{orion},
12017 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
12018 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
12019 @samp{rm7000}, @samp{rm9000},
12020 @samp{sb1},
12021 @samp{sr71000},
12022 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
12023 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
12024 The special value @samp{from-abi} selects the
12025 most compatible architecture for the selected ABI (that is,
12026 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
12028 In processor names, a final @samp{000} can be abbreviated as @samp{k}
12029 (for example, @samp{-march=r2k}).  Prefixes are optional, and
12030 @samp{vr} may be written @samp{r}.
12032 Names of the form @samp{@var{n}f2_1} refer to processors with
12033 FPUs clocked at half the rate of the core, names of the form
12034 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
12035 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
12036 processors with FPUs clocked a ratio of 3:2 with respect to the core.
12037 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
12038 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
12039 accepted as synonyms for @samp{@var{n}f1_1}.
12041 GCC defines two macros based on the value of this option.  The first
12042 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
12043 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
12044 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
12045 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
12046 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
12048 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
12049 above.  In other words, it will have the full prefix and will not
12050 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
12051 the macro names the resolved architecture (either @samp{"mips1"} or
12052 @samp{"mips3"}).  It names the default architecture when no
12053 @option{-march} option is given.
12055 @item -mtune=@var{arch}
12056 @opindex mtune
12057 Optimize for @var{arch}.  Among other things, this option controls
12058 the way instructions are scheduled, and the perceived cost of arithmetic
12059 operations.  The list of @var{arch} values is the same as for
12060 @option{-march}.
12062 When this option is not used, GCC will optimize for the processor
12063 specified by @option{-march}.  By using @option{-march} and
12064 @option{-mtune} together, it is possible to generate code that will
12065 run on a family of processors, but optimize the code for one
12066 particular member of that family.
12068 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
12069 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
12070 @samp{-march} ones described above.
12072 @item -mips1
12073 @opindex mips1
12074 Equivalent to @samp{-march=mips1}.
12076 @item -mips2
12077 @opindex mips2
12078 Equivalent to @samp{-march=mips2}.
12080 @item -mips3
12081 @opindex mips3
12082 Equivalent to @samp{-march=mips3}.
12084 @item -mips4
12085 @opindex mips4
12086 Equivalent to @samp{-march=mips4}.
12088 @item -mips32
12089 @opindex mips32
12090 Equivalent to @samp{-march=mips32}.
12092 @item -mips32r2
12093 @opindex mips32r2
12094 Equivalent to @samp{-march=mips32r2}.
12096 @item -mips64
12097 @opindex mips64
12098 Equivalent to @samp{-march=mips64}.
12100 @item -mips16
12101 @itemx -mno-mips16
12102 @opindex mips16
12103 @opindex mno-mips16
12104 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12105 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12107 MIPS16 code generation can also be controlled on a per-function basis
12108 by means of @code{mips16} and @code{nomips16} attributes.  
12109 @xref{Function Attributes}, for more information.
12111 @item -mflip-mips16
12112 @opindex mflip-mips16
12113 Generate MIPS16 code on alternating functions.  This option is provided
12114 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12115 not intended for ordinary use in compiling user code.
12117 @item -minterlink-mips16
12118 @itemx -mno-interlink-mips16
12119 @opindex minterlink-mips16
12120 @opindex mno-interlink-mips16
12121 Require (do not require) that non-MIPS16 code be link-compatible with
12122 MIPS16 code.
12124 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12125 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12126 therefore disables direct jumps unless GCC knows that the target of the
12127 jump is not MIPS16.
12129 @item -mabi=32
12130 @itemx -mabi=o64
12131 @itemx -mabi=n32
12132 @itemx -mabi=64
12133 @itemx -mabi=eabi
12134 @opindex mabi=32
12135 @opindex mabi=o64
12136 @opindex mabi=n32
12137 @opindex mabi=64
12138 @opindex mabi=eabi
12139 Generate code for the given ABI@.
12141 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12142 generates 64-bit code when you select a 64-bit architecture, but you
12143 can use @option{-mgp32} to get 32-bit code instead.
12145 For information about the O64 ABI, see
12146 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12148 GCC supports a variant of the o32 ABI in which floating-point registers
12149 are 64 rather than 32 bits wide.  You can select this combination with
12150 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12151 and @samp{mfhc1} instructions and is therefore only supported for
12152 MIPS32R2 processors.
12154 The register assignments for arguments and return values remain the
12155 same, but each scalar value is passed in a single 64-bit register
12156 rather than a pair of 32-bit registers.  For example, scalar
12157 floating-point values are returned in @samp{$f0} only, not a
12158 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12159 remains the same, but all 64 bits are saved.
12161 @item -mabicalls
12162 @itemx -mno-abicalls
12163 @opindex mabicalls
12164 @opindex mno-abicalls
12165 Generate (do not generate) code that is suitable for SVR4-style
12166 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12167 systems.
12169 @item -mshared
12170 @itemx -mno-shared
12171 Generate (do not generate) code that is fully position-independent,
12172 and that can therefore be linked into shared libraries.  This option
12173 only affects @option{-mabicalls}.
12175 All @option{-mabicalls} code has traditionally been position-independent,
12176 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12177 as an extension, the GNU toolchain allows executables to use absolute
12178 accesses for locally-binding symbols.  It can also use shorter GP
12179 initialization sequences and generate direct calls to locally-defined
12180 functions.  This mode is selected by @option{-mno-shared}.
12182 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12183 objects that can only be linked by the GNU linker.  However, the option
12184 does not affect the ABI of the final executable; it only affects the ABI
12185 of relocatable objects.  Using @option{-mno-shared} will generally make
12186 executables both smaller and quicker.
12188 @option{-mshared} is the default.
12190 @item -mxgot
12191 @itemx -mno-xgot
12192 @opindex mxgot
12193 @opindex mno-xgot
12194 Lift (do not lift) the usual restrictions on the size of the global
12195 offset table.
12197 GCC normally uses a single instruction to load values from the GOT@.
12198 While this is relatively efficient, it will only work if the GOT
12199 is smaller than about 64k.  Anything larger will cause the linker
12200 to report an error such as:
12202 @cindex relocation truncated to fit (MIPS)
12203 @smallexample
12204 relocation truncated to fit: R_MIPS_GOT16 foobar
12205 @end smallexample
12207 If this happens, you should recompile your code with @option{-mxgot}.
12208 It should then work with very large GOTs, although it will also be
12209 less efficient, since it will take three instructions to fetch the
12210 value of a global symbol.
12212 Note that some linkers can create multiple GOTs.  If you have such a
12213 linker, you should only need to use @option{-mxgot} when a single object
12214 file accesses more than 64k's worth of GOT entries.  Very few do.
12216 These options have no effect unless GCC is generating position
12217 independent code.
12219 @item -mgp32
12220 @opindex mgp32
12221 Assume that general-purpose registers are 32 bits wide.
12223 @item -mgp64
12224 @opindex mgp64
12225 Assume that general-purpose registers are 64 bits wide.
12227 @item -mfp32
12228 @opindex mfp32
12229 Assume that floating-point registers are 32 bits wide.
12231 @item -mfp64
12232 @opindex mfp64
12233 Assume that floating-point registers are 64 bits wide.
12235 @item -mhard-float
12236 @opindex mhard-float
12237 Use floating-point coprocessor instructions.
12239 @item -msoft-float
12240 @opindex msoft-float
12241 Do not use floating-point coprocessor instructions.  Implement
12242 floating-point calculations using library calls instead.
12244 @item -msingle-float
12245 @opindex msingle-float
12246 Assume that the floating-point coprocessor only supports single-precision
12247 operations.
12249 @item -mdouble-float
12250 @opindex mdouble-float
12251 Assume that the floating-point coprocessor supports double-precision
12252 operations.  This is the default.
12254 @item -mllsc
12255 @itemx -mno-llsc
12256 @opindex mllsc
12257 @opindex mno-llsc
12258 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12259 implement atomic memory built-in functions.  When neither option is
12260 specified, GCC will use the instructions if the target architecture
12261 supports them.
12263 @option{-mllsc} is useful if the runtime environment can emulate the
12264 instructions and @option{-mno-llsc} can be useful when compiling for
12265 nonstandard ISAs.  You can make either option the default by
12266 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12267 respectively.  @option{--with-llsc} is the default for some
12268 configurations; see the installation documentation for details.
12270 @item -mdsp
12271 @itemx -mno-dsp
12272 @opindex mdsp
12273 @opindex mno-dsp
12274 Use (do not use) revision 1 of the MIPS DSP ASE@.
12275 @xref{MIPS DSP Built-in Functions}.  This option defines the
12276 preprocessor macro @samp{__mips_dsp}.  It also defines
12277 @samp{__mips_dsp_rev} to 1.
12279 @item -mdspr2
12280 @itemx -mno-dspr2
12281 @opindex mdspr2
12282 @opindex mno-dspr2
12283 Use (do not use) revision 2 of the MIPS DSP ASE@.
12284 @xref{MIPS DSP Built-in Functions}.  This option defines the
12285 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12286 It also defines @samp{__mips_dsp_rev} to 2.
12288 @item -msmartmips
12289 @itemx -mno-smartmips
12290 @opindex msmartmips
12291 @opindex mno-smartmips
12292 Use (do not use) the MIPS SmartMIPS ASE.
12294 @item -mpaired-single
12295 @itemx -mno-paired-single
12296 @opindex mpaired-single
12297 @opindex mno-paired-single
12298 Use (do not use) paired-single floating-point instructions.
12299 @xref{MIPS Paired-Single Support}.  This option requires
12300 hardware floating-point support to be enabled.
12302 @item -mdmx
12303 @itemx -mno-mdmx
12304 @opindex mdmx
12305 @opindex mno-mdmx
12306 Use (do not use) MIPS Digital Media Extension instructions.
12307 This option can only be used when generating 64-bit code and requires
12308 hardware floating-point support to be enabled.
12310 @item -mips3d
12311 @itemx -mno-mips3d
12312 @opindex mips3d
12313 @opindex mno-mips3d
12314 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12315 The option @option{-mips3d} implies @option{-mpaired-single}.
12317 @item -mmt
12318 @itemx -mno-mt
12319 @opindex mmt
12320 @opindex mno-mt
12321 Use (do not use) MT Multithreading instructions.
12323 @item -mlong64
12324 @opindex mlong64
12325 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12326 an explanation of the default and the way that the pointer size is
12327 determined.
12329 @item -mlong32
12330 @opindex mlong32
12331 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12333 The default size of @code{int}s, @code{long}s and pointers depends on
12334 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12335 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12336 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12337 or the same size as integer registers, whichever is smaller.
12339 @item -msym32
12340 @itemx -mno-sym32
12341 @opindex msym32
12342 @opindex mno-sym32
12343 Assume (do not assume) that all symbols have 32-bit values, regardless
12344 of the selected ABI@.  This option is useful in combination with
12345 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12346 to generate shorter and faster references to symbolic addresses.
12348 @item -G @var{num}
12349 @opindex G
12350 Put definitions of externally-visible data in a small data section
12351 if that data is no bigger than @var{num} bytes.  GCC can then access
12352 the data more efficiently; see @option{-mgpopt} for details.
12354 The default @option{-G} option depends on the configuration.
12356 @item -mlocal-sdata
12357 @itemx -mno-local-sdata
12358 @opindex mlocal-sdata
12359 @opindex mno-local-sdata
12360 Extend (do not extend) the @option{-G} behavior to local data too,
12361 such as to static variables in C@.  @option{-mlocal-sdata} is the
12362 default for all configurations.
12364 If the linker complains that an application is using too much small data,
12365 you might want to try rebuilding the less performance-critical parts with
12366 @option{-mno-local-sdata}.  You might also want to build large
12367 libraries with @option{-mno-local-sdata}, so that the libraries leave
12368 more room for the main program.
12370 @item -mextern-sdata
12371 @itemx -mno-extern-sdata
12372 @opindex mextern-sdata
12373 @opindex mno-extern-sdata
12374 Assume (do not assume) that externally-defined data will be in
12375 a small data section if that data is within the @option{-G} limit.
12376 @option{-mextern-sdata} is the default for all configurations.
12378 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12379 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12380 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12381 is placed in a small data section.  If @var{Var} is defined by another
12382 module, you must either compile that module with a high-enough
12383 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12384 definition.  If @var{Var} is common, you must link the application
12385 with a high-enough @option{-G} setting.
12387 The easiest way of satisfying these restrictions is to compile
12388 and link every module with the same @option{-G} option.  However,
12389 you may wish to build a library that supports several different
12390 small data limits.  You can do this by compiling the library with
12391 the highest supported @option{-G} setting and additionally using
12392 @option{-mno-extern-sdata} to stop the library from making assumptions
12393 about externally-defined data.
12395 @item -mgpopt
12396 @itemx -mno-gpopt
12397 @opindex mgpopt
12398 @opindex mno-gpopt
12399 Use (do not use) GP-relative accesses for symbols that are known to be
12400 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12401 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12402 configurations.
12404 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12405 might not hold the value of @code{_gp}.  For example, if the code is
12406 part of a library that might be used in a boot monitor, programs that
12407 call boot monitor routines will pass an unknown value in @code{$gp}.
12408 (In such situations, the boot monitor itself would usually be compiled
12409 with @option{-G0}.)
12411 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12412 @option{-mno-extern-sdata}.
12414 @item -membedded-data
12415 @itemx -mno-embedded-data
12416 @opindex membedded-data
12417 @opindex mno-embedded-data
12418 Allocate variables to the read-only data section first if possible, then
12419 next in the small data section if possible, otherwise in data.  This gives
12420 slightly slower code than the default, but reduces the amount of RAM required
12421 when executing, and thus may be preferred for some embedded systems.
12423 @item -muninit-const-in-rodata
12424 @itemx -mno-uninit-const-in-rodata
12425 @opindex muninit-const-in-rodata
12426 @opindex mno-uninit-const-in-rodata
12427 Put uninitialized @code{const} variables in the read-only data section.
12428 This option is only meaningful in conjunction with @option{-membedded-data}.
12430 @item -mcode-readable=@var{setting}
12431 @opindex mcode-readable
12432 Specify whether GCC may generate code that reads from executable sections.
12433 There are three possible settings:
12435 @table @gcctabopt
12436 @item -mcode-readable=yes
12437 Instructions may freely access executable sections.  This is the
12438 default setting.
12440 @item -mcode-readable=pcrel
12441 MIPS16 PC-relative load instructions can access executable sections,
12442 but other instructions must not do so.  This option is useful on 4KSc
12443 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12444 It is also useful on processors that can be configured to have a dual
12445 instruction/data SRAM interface and that, like the M4K, automatically
12446 redirect PC-relative loads to the instruction RAM.
12448 @item -mcode-readable=no
12449 Instructions must not access executable sections.  This option can be
12450 useful on targets that are configured to have a dual instruction/data
12451 SRAM interface but that (unlike the M4K) do not automatically redirect
12452 PC-relative loads to the instruction RAM.
12453 @end table
12455 @item -msplit-addresses
12456 @itemx -mno-split-addresses
12457 @opindex msplit-addresses
12458 @opindex mno-split-addresses
12459 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12460 relocation operators.  This option has been superseded by
12461 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12463 @item -mexplicit-relocs
12464 @itemx -mno-explicit-relocs
12465 @opindex mexplicit-relocs
12466 @opindex mno-explicit-relocs
12467 Use (do not use) assembler relocation operators when dealing with symbolic
12468 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12469 is to use assembler macros instead.
12471 @option{-mexplicit-relocs} is the default if GCC was configured
12472 to use an assembler that supports relocation operators.
12474 @item -mcheck-zero-division
12475 @itemx -mno-check-zero-division
12476 @opindex mcheck-zero-division
12477 @opindex mno-check-zero-division
12478 Trap (do not trap) on integer division by zero.
12480 The default is @option{-mcheck-zero-division}.
12482 @item -mdivide-traps
12483 @itemx -mdivide-breaks
12484 @opindex mdivide-traps
12485 @opindex mdivide-breaks
12486 MIPS systems check for division by zero by generating either a
12487 conditional trap or a break instruction.  Using traps results in
12488 smaller code, but is only supported on MIPS II and later.  Also, some
12489 versions of the Linux kernel have a bug that prevents trap from
12490 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12491 allow conditional traps on architectures that support them and
12492 @option{-mdivide-breaks} to force the use of breaks.
12494 The default is usually @option{-mdivide-traps}, but this can be
12495 overridden at configure time using @option{--with-divide=breaks}.
12496 Divide-by-zero checks can be completely disabled using
12497 @option{-mno-check-zero-division}.
12499 @item -mmemcpy
12500 @itemx -mno-memcpy
12501 @opindex mmemcpy
12502 @opindex mno-memcpy
12503 Force (do not force) the use of @code{memcpy()} for non-trivial block
12504 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12505 most constant-sized copies.
12507 @item -mlong-calls
12508 @itemx -mno-long-calls
12509 @opindex mlong-calls
12510 @opindex mno-long-calls
12511 Disable (do not disable) use of the @code{jal} instruction.  Calling
12512 functions using @code{jal} is more efficient but requires the caller
12513 and callee to be in the same 256 megabyte segment.
12515 This option has no effect on abicalls code.  The default is
12516 @option{-mno-long-calls}.
12518 @item -mmad
12519 @itemx -mno-mad
12520 @opindex mmad
12521 @opindex mno-mad
12522 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12523 instructions, as provided by the R4650 ISA@.
12525 @item -mfused-madd
12526 @itemx -mno-fused-madd
12527 @opindex mfused-madd
12528 @opindex mno-fused-madd
12529 Enable (disable) use of the floating point multiply-accumulate
12530 instructions, when they are available.  The default is
12531 @option{-mfused-madd}.
12533 When multiply-accumulate instructions are used, the intermediate
12534 product is calculated to infinite precision and is not subject to
12535 the FCSR Flush to Zero bit.  This may be undesirable in some
12536 circumstances.
12538 @item -nocpp
12539 @opindex nocpp
12540 Tell the MIPS assembler to not run its preprocessor over user
12541 assembler files (with a @samp{.s} suffix) when assembling them.
12543 @item -mfix-r4000
12544 @itemx -mno-fix-r4000
12545 @opindex mfix-r4000
12546 @opindex mno-fix-r4000
12547 Work around certain R4000 CPU errata:
12548 @itemize @minus
12549 @item
12550 A double-word or a variable shift may give an incorrect result if executed
12551 immediately after starting an integer division.
12552 @item
12553 A double-word or a variable shift may give an incorrect result if executed
12554 while an integer multiplication is in progress.
12555 @item
12556 An integer division may give an incorrect result if started in a delay slot
12557 of a taken branch or a jump.
12558 @end itemize
12560 @item -mfix-r4400
12561 @itemx -mno-fix-r4400
12562 @opindex mfix-r4400
12563 @opindex mno-fix-r4400
12564 Work around certain R4400 CPU errata:
12565 @itemize @minus
12566 @item
12567 A double-word or a variable shift may give an incorrect result if executed
12568 immediately after starting an integer division.
12569 @end itemize
12571 @item -mfix-vr4120
12572 @itemx -mno-fix-vr4120
12573 @opindex mfix-vr4120
12574 Work around certain VR4120 errata:
12575 @itemize @minus
12576 @item
12577 @code{dmultu} does not always produce the correct result.
12578 @item
12579 @code{div} and @code{ddiv} do not always produce the correct result if one
12580 of the operands is negative.
12581 @end itemize
12582 The workarounds for the division errata rely on special functions in
12583 @file{libgcc.a}.  At present, these functions are only provided by
12584 the @code{mips64vr*-elf} configurations.
12586 Other VR4120 errata require a nop to be inserted between certain pairs of
12587 instructions.  These errata are handled by the assembler, not by GCC itself.
12589 @item -mfix-vr4130
12590 @opindex mfix-vr4130
12591 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12592 workarounds are implemented by the assembler rather than by GCC,
12593 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12594 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12595 instructions are available instead.
12597 @item -mfix-sb1
12598 @itemx -mno-fix-sb1
12599 @opindex mfix-sb1
12600 Work around certain SB-1 CPU core errata.
12601 (This flag currently works around the SB-1 revision 2
12602 ``F1'' and ``F2'' floating point errata.)
12604 @item -mflush-func=@var{func}
12605 @itemx -mno-flush-func
12606 @opindex mflush-func
12607 Specifies the function to call to flush the I and D caches, or to not
12608 call any such function.  If called, the function must take the same
12609 arguments as the common @code{_flush_func()}, that is, the address of the
12610 memory range for which the cache is being flushed, the size of the
12611 memory range, and the number 3 (to flush both caches).  The default
12612 depends on the target GCC was configured for, but commonly is either
12613 @samp{_flush_func} or @samp{__cpu_flush}.
12615 @item mbranch-cost=@var{num}
12616 @opindex mbranch-cost
12617 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12618 This cost is only a heuristic and is not guaranteed to produce
12619 consistent results across releases.  A zero cost redundantly selects
12620 the default, which is based on the @option{-mtune} setting.
12622 @item -mbranch-likely
12623 @itemx -mno-branch-likely
12624 @opindex mbranch-likely
12625 @opindex mno-branch-likely
12626 Enable or disable use of Branch Likely instructions, regardless of the
12627 default for the selected architecture.  By default, Branch Likely
12628 instructions may be generated if they are supported by the selected
12629 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12630 and processors which implement those architectures; for those, Branch
12631 Likely instructions will not be generated by default because the MIPS32
12632 and MIPS64 architectures specifically deprecate their use.
12634 @item -mfp-exceptions
12635 @itemx -mno-fp-exceptions
12636 @opindex mfp-exceptions
12637 Specifies whether FP exceptions are enabled.  This affects how we schedule
12638 FP instructions for some processors.  The default is that FP exceptions are
12639 enabled.
12641 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12642 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12643 FP pipe.
12645 @item -mvr4130-align
12646 @itemx -mno-vr4130-align
12647 @opindex mvr4130-align
12648 The VR4130 pipeline is two-way superscalar, but can only issue two
12649 instructions together if the first one is 8-byte aligned.  When this
12650 option is enabled, GCC will align pairs of instructions that it
12651 thinks should execute in parallel.
12653 This option only has an effect when optimizing for the VR4130.
12654 It normally makes code faster, but at the expense of making it bigger.
12655 It is enabled by default at optimization level @option{-O3}.
12656 @end table
12658 @node MMIX Options
12659 @subsection MMIX Options
12660 @cindex MMIX Options
12662 These options are defined for the MMIX:
12664 @table @gcctabopt
12665 @item -mlibfuncs
12666 @itemx -mno-libfuncs
12667 @opindex mlibfuncs
12668 @opindex mno-libfuncs
12669 Specify that intrinsic library functions are being compiled, passing all
12670 values in registers, no matter the size.
12672 @item -mepsilon
12673 @itemx -mno-epsilon
12674 @opindex mepsilon
12675 @opindex mno-epsilon
12676 Generate floating-point comparison instructions that compare with respect
12677 to the @code{rE} epsilon register.
12679 @item -mabi=mmixware
12680 @itemx -mabi=gnu
12681 @opindex mabi-mmixware
12682 @opindex mabi=gnu
12683 Generate code that passes function parameters and return values that (in
12684 the called function) are seen as registers @code{$0} and up, as opposed to
12685 the GNU ABI which uses global registers @code{$231} and up.
12687 @item -mzero-extend
12688 @itemx -mno-zero-extend
12689 @opindex mzero-extend
12690 @opindex mno-zero-extend
12691 When reading data from memory in sizes shorter than 64 bits, use (do not
12692 use) zero-extending load instructions by default, rather than
12693 sign-extending ones.
12695 @item -mknuthdiv
12696 @itemx -mno-knuthdiv
12697 @opindex mknuthdiv
12698 @opindex mno-knuthdiv
12699 Make the result of a division yielding a remainder have the same sign as
12700 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12701 remainder follows the sign of the dividend.  Both methods are
12702 arithmetically valid, the latter being almost exclusively used.
12704 @item -mtoplevel-symbols
12705 @itemx -mno-toplevel-symbols
12706 @opindex mtoplevel-symbols
12707 @opindex mno-toplevel-symbols
12708 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12709 code can be used with the @code{PREFIX} assembly directive.
12711 @item -melf
12712 @opindex melf
12713 Generate an executable in the ELF format, rather than the default
12714 @samp{mmo} format used by the @command{mmix} simulator.
12716 @item -mbranch-predict
12717 @itemx -mno-branch-predict
12718 @opindex mbranch-predict
12719 @opindex mno-branch-predict
12720 Use (do not use) the probable-branch instructions, when static branch
12721 prediction indicates a probable branch.
12723 @item -mbase-addresses
12724 @itemx -mno-base-addresses
12725 @opindex mbase-addresses
12726 @opindex mno-base-addresses
12727 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12728 base address automatically generates a request (handled by the assembler
12729 and the linker) for a constant to be set up in a global register.  The
12730 register is used for one or more base address requests within the range 0
12731 to 255 from the value held in the register.  The generally leads to short
12732 and fast code, but the number of different data items that can be
12733 addressed is limited.  This means that a program that uses lots of static
12734 data may require @option{-mno-base-addresses}.
12736 @item -msingle-exit
12737 @itemx -mno-single-exit
12738 @opindex msingle-exit
12739 @opindex mno-single-exit
12740 Force (do not force) generated code to have a single exit point in each
12741 function.
12742 @end table
12744 @node MN10300 Options
12745 @subsection MN10300 Options
12746 @cindex MN10300 options
12748 These @option{-m} options are defined for Matsushita MN10300 architectures:
12750 @table @gcctabopt
12751 @item -mmult-bug
12752 @opindex mmult-bug
12753 Generate code to avoid bugs in the multiply instructions for the MN10300
12754 processors.  This is the default.
12756 @item -mno-mult-bug
12757 @opindex mno-mult-bug
12758 Do not generate code to avoid bugs in the multiply instructions for the
12759 MN10300 processors.
12761 @item -mam33
12762 @opindex mam33
12763 Generate code which uses features specific to the AM33 processor.
12765 @item -mno-am33
12766 @opindex mno-am33
12767 Do not generate code which uses features specific to the AM33 processor.  This
12768 is the default.
12770 @item -mreturn-pointer-on-d0
12771 @opindex mreturn-pointer-on-d0
12772 When generating a function which returns a pointer, return the pointer
12773 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12774 only in a0, and attempts to call such functions without a prototype
12775 would result in errors.  Note that this option is on by default; use
12776 @option{-mno-return-pointer-on-d0} to disable it.
12778 @item -mno-crt0
12779 @opindex mno-crt0
12780 Do not link in the C run-time initialization object file.
12782 @item -mrelax
12783 @opindex mrelax
12784 Indicate to the linker that it should perform a relaxation optimization pass
12785 to shorten branches, calls and absolute memory addresses.  This option only
12786 has an effect when used on the command line for the final link step.
12788 This option makes symbolic debugging impossible.
12789 @end table
12791 @node MT Options
12792 @subsection MT Options
12793 @cindex MT options
12795 These @option{-m} options are defined for Morpho MT architectures:
12797 @table @gcctabopt
12799 @item -march=@var{cpu-type}
12800 @opindex march
12801 Generate code that will run on @var{cpu-type}, which is the name of a system
12802 representing a certain processor type.  Possible values for
12803 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12804 @samp{ms1-16-003} and @samp{ms2}.
12806 When this option is not used, the default is @option{-march=ms1-16-002}.
12808 @item -mbacc
12809 @opindex mbacc
12810 Use byte loads and stores when generating code.
12812 @item -mno-bacc
12813 @opindex mno-bacc
12814 Do not use byte loads and stores when generating code.
12816 @item -msim
12817 @opindex msim
12818 Use simulator runtime
12820 @item -mno-crt0
12821 @opindex mno-crt0
12822 Do not link in the C run-time initialization object file
12823 @file{crti.o}.  Other run-time initialization and termination files
12824 such as @file{startup.o} and @file{exit.o} are still included on the
12825 linker command line.
12827 @end table
12829 @node PDP-11 Options
12830 @subsection PDP-11 Options
12831 @cindex PDP-11 Options
12833 These options are defined for the PDP-11:
12835 @table @gcctabopt
12836 @item -mfpu
12837 @opindex mfpu
12838 Use hardware FPP floating point.  This is the default.  (FIS floating
12839 point on the PDP-11/40 is not supported.)
12841 @item -msoft-float
12842 @opindex msoft-float
12843 Do not use hardware floating point.
12845 @item -mac0
12846 @opindex mac0
12847 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12849 @item -mno-ac0
12850 @opindex mno-ac0
12851 Return floating-point results in memory.  This is the default.
12853 @item -m40
12854 @opindex m40
12855 Generate code for a PDP-11/40.
12857 @item -m45
12858 @opindex m45
12859 Generate code for a PDP-11/45.  This is the default.
12861 @item -m10
12862 @opindex m10
12863 Generate code for a PDP-11/10.
12865 @item -mbcopy-builtin
12866 @opindex bcopy-builtin
12867 Use inline @code{movmemhi} patterns for copying memory.  This is the
12868 default.
12870 @item -mbcopy
12871 @opindex mbcopy
12872 Do not use inline @code{movmemhi} patterns for copying memory.
12874 @item -mint16
12875 @itemx -mno-int32
12876 @opindex mint16
12877 @opindex mno-int32
12878 Use 16-bit @code{int}.  This is the default.
12880 @item -mint32
12881 @itemx -mno-int16
12882 @opindex mint32
12883 @opindex mno-int16
12884 Use 32-bit @code{int}.
12886 @item -mfloat64
12887 @itemx -mno-float32
12888 @opindex mfloat64
12889 @opindex mno-float32
12890 Use 64-bit @code{float}.  This is the default.
12892 @item -mfloat32
12893 @itemx -mno-float64
12894 @opindex mfloat32
12895 @opindex mno-float64
12896 Use 32-bit @code{float}.
12898 @item -mabshi
12899 @opindex mabshi
12900 Use @code{abshi2} pattern.  This is the default.
12902 @item -mno-abshi
12903 @opindex mno-abshi
12904 Do not use @code{abshi2} pattern.
12906 @item -mbranch-expensive
12907 @opindex mbranch-expensive
12908 Pretend that branches are expensive.  This is for experimenting with
12909 code generation only.
12911 @item -mbranch-cheap
12912 @opindex mbranch-cheap
12913 Do not pretend that branches are expensive.  This is the default.
12915 @item -msplit
12916 @opindex msplit
12917 Generate code for a system with split I&D@.
12919 @item -mno-split
12920 @opindex mno-split
12921 Generate code for a system without split I&D@.  This is the default.
12923 @item -munix-asm
12924 @opindex munix-asm
12925 Use Unix assembler syntax.  This is the default when configured for
12926 @samp{pdp11-*-bsd}.
12928 @item -mdec-asm
12929 @opindex mdec-asm
12930 Use DEC assembler syntax.  This is the default when configured for any
12931 PDP-11 target other than @samp{pdp11-*-bsd}.
12932 @end table
12934 @node PowerPC Options
12935 @subsection PowerPC Options
12936 @cindex PowerPC options
12938 These are listed under @xref{RS/6000 and PowerPC Options}.
12940 @node RS/6000 and PowerPC Options
12941 @subsection IBM RS/6000 and PowerPC Options
12942 @cindex RS/6000 and PowerPC Options
12943 @cindex IBM RS/6000 and PowerPC Options
12945 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12946 @table @gcctabopt
12947 @item -mpower
12948 @itemx -mno-power
12949 @itemx -mpower2
12950 @itemx -mno-power2
12951 @itemx -mpowerpc
12952 @itemx -mno-powerpc
12953 @itemx -mpowerpc-gpopt
12954 @itemx -mno-powerpc-gpopt
12955 @itemx -mpowerpc-gfxopt
12956 @itemx -mno-powerpc-gfxopt
12957 @itemx -mpowerpc64
12958 @itemx -mno-powerpc64
12959 @itemx -mmfcrf
12960 @itemx -mno-mfcrf
12961 @itemx -mpopcntb
12962 @itemx -mno-popcntb
12963 @itemx -mfprnd
12964 @itemx -mno-fprnd
12965 @itemx -mcmpb
12966 @itemx -mno-cmpb
12967 @itemx -mmfpgpr
12968 @itemx -mno-mfpgpr
12969 @itemx -mhard-dfp
12970 @itemx -mno-hard-dfp
12971 @opindex mpower
12972 @opindex mno-power
12973 @opindex mpower2
12974 @opindex mno-power2
12975 @opindex mpowerpc
12976 @opindex mno-powerpc
12977 @opindex mpowerpc-gpopt
12978 @opindex mno-powerpc-gpopt
12979 @opindex mpowerpc-gfxopt
12980 @opindex mno-powerpc-gfxopt
12981 @opindex mpowerpc64
12982 @opindex mno-powerpc64
12983 @opindex mmfcrf
12984 @opindex mno-mfcrf
12985 @opindex mpopcntb
12986 @opindex mno-popcntb
12987 @opindex mfprnd
12988 @opindex mno-fprnd
12989 @opindex mcmpb
12990 @opindex mno-cmpb
12991 @opindex mmfpgpr
12992 @opindex mno-mfpgpr
12993 @opindex mhard-dfp
12994 @opindex mno-hard-dfp
12995 GCC supports two related instruction set architectures for the
12996 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12997 instructions supported by the @samp{rios} chip set used in the original
12998 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12999 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
13000 the IBM 4xx, 6xx, and follow-on microprocessors.
13002 Neither architecture is a subset of the other.  However there is a
13003 large common subset of instructions supported by both.  An MQ
13004 register is included in processors supporting the POWER architecture.
13006 You use these options to specify which instructions are available on the
13007 processor you are using.  The default value of these options is
13008 determined when configuring GCC@.  Specifying the
13009 @option{-mcpu=@var{cpu_type}} overrides the specification of these
13010 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
13011 rather than the options listed above.
13013 The @option{-mpower} option allows GCC to generate instructions that
13014 are found only in the POWER architecture and to use the MQ register.
13015 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
13016 to generate instructions that are present in the POWER2 architecture but
13017 not the original POWER architecture.
13019 The @option{-mpowerpc} option allows GCC to generate instructions that
13020 are found only in the 32-bit subset of the PowerPC architecture.
13021 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
13022 GCC to use the optional PowerPC architecture instructions in the
13023 General Purpose group, including floating-point square root.  Specifying
13024 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
13025 use the optional PowerPC architecture instructions in the Graphics
13026 group, including floating-point select.
13028 The @option{-mmfcrf} option allows GCC to generate the move from
13029 condition register field instruction implemented on the POWER4
13030 processor and other processors that support the PowerPC V2.01
13031 architecture.
13032 The @option{-mpopcntb} option allows GCC to generate the popcount and
13033 double precision FP reciprocal estimate instruction implemented on the
13034 POWER5 processor and other processors that support the PowerPC V2.02
13035 architecture.
13036 The @option{-mfprnd} option allows GCC to generate the FP round to
13037 integer instructions implemented on the POWER5+ processor and other
13038 processors that support the PowerPC V2.03 architecture.
13039 The @option{-mcmpb} option allows GCC to generate the compare bytes
13040 instruction implemented on the POWER6 processor and other processors
13041 that support the PowerPC V2.05 architecture.
13042 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
13043 general purpose register instructions implemented on the POWER6X
13044 processor and other processors that support the extended PowerPC V2.05
13045 architecture.
13046 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
13047 point instructions implemented on some POWER processors.
13049 The @option{-mpowerpc64} option allows GCC to generate the additional
13050 64-bit instructions that are found in the full PowerPC64 architecture
13051 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
13052 @option{-mno-powerpc64}.
13054 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
13055 will use only the instructions in the common subset of both
13056 architectures plus some special AIX common-mode calls, and will not use
13057 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
13058 permits GCC to use any instruction from either architecture and to
13059 allow use of the MQ register; specify this for the Motorola MPC601.
13061 @item -mnew-mnemonics
13062 @itemx -mold-mnemonics
13063 @opindex mnew-mnemonics
13064 @opindex mold-mnemonics
13065 Select which mnemonics to use in the generated assembler code.  With
13066 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
13067 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
13068 assembler mnemonics defined for the POWER architecture.  Instructions
13069 defined in only one architecture have only one mnemonic; GCC uses that
13070 mnemonic irrespective of which of these options is specified.
13072 GCC defaults to the mnemonics appropriate for the architecture in
13073 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
13074 value of these option.  Unless you are building a cross-compiler, you
13075 should normally not specify either @option{-mnew-mnemonics} or
13076 @option{-mold-mnemonics}, but should instead accept the default.
13078 @item -mcpu=@var{cpu_type}
13079 @opindex mcpu
13080 Set architecture type, register usage, choice of mnemonics, and
13081 instruction scheduling parameters for machine type @var{cpu_type}.
13082 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
13083 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
13084 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
13085 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
13086 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
13087 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
13088 @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, @samp{power},
13089 @samp{power2}, @samp{power3}, @samp{power4}, @samp{power5},
13090 @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{common},
13091 @samp{powerpc}, @samp{powerpc64}, @samp{rios}, @samp{rios1},
13092 @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13094 @option{-mcpu=common} selects a completely generic processor.  Code
13095 generated under this option will run on any POWER or PowerPC processor.
13096 GCC will use only the instructions in the common subset of both
13097 architectures, and will not use the MQ register.  GCC assumes a generic
13098 processor model for scheduling purposes.
13100 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13101 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13102 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13103 types, with an appropriate, generic processor model assumed for
13104 scheduling purposes.
13106 The other options specify a specific processor.  Code generated under
13107 those options will run best on that processor, and may not run at all on
13108 others.
13110 The @option{-mcpu} options automatically enable or disable the
13111 following options:
13113 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13114 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13115 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13117 The particular options set for any particular CPU will vary between
13118 compiler versions, depending on what setting seems to produce optimal
13119 code for that CPU; it doesn't necessarily reflect the actual hardware's
13120 capabilities.  If you wish to set an individual option to a particular
13121 value, you may specify it after the @option{-mcpu} option, like
13122 @samp{-mcpu=970 -mno-altivec}.
13124 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13125 not enabled or disabled by the @option{-mcpu} option at present because
13126 AIX does not have full support for these options.  You may still
13127 enable or disable them individually if you're sure it'll work in your
13128 environment.
13130 @item -mtune=@var{cpu_type}
13131 @opindex mtune
13132 Set the instruction scheduling parameters for machine type
13133 @var{cpu_type}, but do not set the architecture type, register usage, or
13134 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13135 values for @var{cpu_type} are used for @option{-mtune} as for
13136 @option{-mcpu}.  If both are specified, the code generated will use the
13137 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13138 scheduling parameters set by @option{-mtune}.
13140 @item -mswdiv
13141 @itemx -mno-swdiv
13142 @opindex mswdiv
13143 @opindex mno-swdiv
13144 Generate code to compute division as reciprocal estimate and iterative
13145 refinement, creating opportunities for increased throughput.  This
13146 feature requires: optional PowerPC Graphics instruction set for single
13147 precision and FRE instruction for double precision, assuming divides
13148 cannot generate user-visible traps, and the domain values not include
13149 Infinities, denormals or zero denominator.
13151 @item -maltivec
13152 @itemx -mno-altivec
13153 @opindex maltivec
13154 @opindex mno-altivec
13155 Generate code that uses (does not use) AltiVec instructions, and also
13156 enable the use of built-in functions that allow more direct access to
13157 the AltiVec instruction set.  You may also need to set
13158 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13159 enhancements.
13161 @item -mvrsave
13162 @itemx -mno-vrsave
13163 @opindex mvrsave
13164 @opindex mno-vrsave
13165 Generate VRSAVE instructions when generating AltiVec code.
13167 @item -msecure-plt
13168 @opindex msecure-plt
13169 Generate code that allows ld and ld.so to build executables and shared
13170 libraries with non-exec .plt and .got sections.  This is a PowerPC
13171 32-bit SYSV ABI option.
13173 @item -mbss-plt
13174 @opindex mbss-plt
13175 Generate code that uses a BSS .plt section that ld.so fills in, and
13176 requires .plt and .got sections that are both writable and executable.
13177 This is a PowerPC 32-bit SYSV ABI option.
13179 @item -misel
13180 @itemx -mno-isel
13181 @opindex misel
13182 @opindex mno-isel
13183 This switch enables or disables the generation of ISEL instructions.
13185 @item -misel=@var{yes/no}
13186 This switch has been deprecated.  Use @option{-misel} and
13187 @option{-mno-isel} instead.
13189 @item -mspe
13190 @itemx -mno-spe
13191 @opindex mspe
13192 @opindex mno-spe
13193 This switch enables or disables the generation of SPE simd
13194 instructions.
13196 @item -mpaired
13197 @itemx -mno-paired
13198 @opindex mpaired
13199 @opindex mno-paired
13200 This switch enables or disables the generation of PAIRED simd
13201 instructions.
13203 @item -mspe=@var{yes/no}
13204 This option has been deprecated.  Use @option{-mspe} and
13205 @option{-mno-spe} instead.
13207 @item -mfloat-gprs=@var{yes/single/double/no}
13208 @itemx -mfloat-gprs
13209 @opindex mfloat-gprs
13210 This switch enables or disables the generation of floating point
13211 operations on the general purpose registers for architectures that
13212 support it.
13214 The argument @var{yes} or @var{single} enables the use of
13215 single-precision floating point operations.
13217 The argument @var{double} enables the use of single and
13218 double-precision floating point operations.
13220 The argument @var{no} disables floating point operations on the
13221 general purpose registers.
13223 This option is currently only available on the MPC854x.
13225 @item -m32
13226 @itemx -m64
13227 @opindex m32
13228 @opindex m64
13229 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13230 targets (including GNU/Linux).  The 32-bit environment sets int, long
13231 and pointer to 32 bits and generates code that runs on any PowerPC
13232 variant.  The 64-bit environment sets int to 32 bits and long and
13233 pointer to 64 bits, and generates code for PowerPC64, as for
13234 @option{-mpowerpc64}.
13236 @item -mfull-toc
13237 @itemx -mno-fp-in-toc
13238 @itemx -mno-sum-in-toc
13239 @itemx -mminimal-toc
13240 @opindex mfull-toc
13241 @opindex mno-fp-in-toc
13242 @opindex mno-sum-in-toc
13243 @opindex mminimal-toc
13244 Modify generation of the TOC (Table Of Contents), which is created for
13245 every executable file.  The @option{-mfull-toc} option is selected by
13246 default.  In that case, GCC will allocate at least one TOC entry for
13247 each unique non-automatic variable reference in your program.  GCC
13248 will also place floating-point constants in the TOC@.  However, only
13249 16,384 entries are available in the TOC@.
13251 If you receive a linker error message that saying you have overflowed
13252 the available TOC space, you can reduce the amount of TOC space used
13253 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13254 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13255 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13256 generate code to calculate the sum of an address and a constant at
13257 run-time instead of putting that sum into the TOC@.  You may specify one
13258 or both of these options.  Each causes GCC to produce very slightly
13259 slower and larger code at the expense of conserving TOC space.
13261 If you still run out of space in the TOC even when you specify both of
13262 these options, specify @option{-mminimal-toc} instead.  This option causes
13263 GCC to make only one TOC entry for every file.  When you specify this
13264 option, GCC will produce code that is slower and larger but which
13265 uses extremely little TOC space.  You may wish to use this option
13266 only on files that contain less frequently executed code.
13268 @item -maix64
13269 @itemx -maix32
13270 @opindex maix64
13271 @opindex maix32
13272 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13273 @code{long} type, and the infrastructure needed to support them.
13274 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13275 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13276 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13278 @item -mxl-compat
13279 @itemx -mno-xl-compat
13280 @opindex mxl-compat
13281 @opindex mno-xl-compat
13282 Produce code that conforms more closely to IBM XL compiler semantics
13283 when using AIX-compatible ABI@.  Pass floating-point arguments to
13284 prototyped functions beyond the register save area (RSA) on the stack
13285 in addition to argument FPRs.  Do not assume that most significant
13286 double in 128-bit long double value is properly rounded when comparing
13287 values and converting to double.  Use XL symbol names for long double
13288 support routines.
13290 The AIX calling convention was extended but not initially documented to
13291 handle an obscure K&R C case of calling a function that takes the
13292 address of its arguments with fewer arguments than declared.  IBM XL
13293 compilers access floating point arguments which do not fit in the
13294 RSA from the stack when a subroutine is compiled without
13295 optimization.  Because always storing floating-point arguments on the
13296 stack is inefficient and rarely needed, this option is not enabled by
13297 default and only is necessary when calling subroutines compiled by IBM
13298 XL compilers without optimization.
13300 @item -mpe
13301 @opindex mpe
13302 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13303 application written to use message passing with special startup code to
13304 enable the application to run.  The system must have PE installed in the
13305 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13306 must be overridden with the @option{-specs=} option to specify the
13307 appropriate directory location.  The Parallel Environment does not
13308 support threads, so the @option{-mpe} option and the @option{-pthread}
13309 option are incompatible.
13311 @item -malign-natural
13312 @itemx -malign-power
13313 @opindex malign-natural
13314 @opindex malign-power
13315 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13316 @option{-malign-natural} overrides the ABI-defined alignment of larger
13317 types, such as floating-point doubles, on their natural size-based boundary.
13318 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13319 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13321 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13322 is not supported.
13324 @item -msoft-float
13325 @itemx -mhard-float
13326 @opindex msoft-float
13327 @opindex mhard-float
13328 Generate code that does not use (uses) the floating-point register set.
13329 Software floating point emulation is provided if you use the
13330 @option{-msoft-float} option, and pass the option to GCC when linking.
13332 @item -mmultiple
13333 @itemx -mno-multiple
13334 @opindex mmultiple
13335 @opindex mno-multiple
13336 Generate code that uses (does not use) the load multiple word
13337 instructions and the store multiple word instructions.  These
13338 instructions are generated by default on POWER systems, and not
13339 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13340 endian PowerPC systems, since those instructions do not work when the
13341 processor is in little endian mode.  The exceptions are PPC740 and
13342 PPC750 which permit the instructions usage in little endian mode.
13344 @item -mstring
13345 @itemx -mno-string
13346 @opindex mstring
13347 @opindex mno-string
13348 Generate code that uses (does not use) the load string instructions
13349 and the store string word instructions to save multiple registers and
13350 do small block moves.  These instructions are generated by default on
13351 POWER systems, and not generated on PowerPC systems.  Do not use
13352 @option{-mstring} on little endian PowerPC systems, since those
13353 instructions do not work when the processor is in little endian mode.
13354 The exceptions are PPC740 and PPC750 which permit the instructions
13355 usage in little endian mode.
13357 @item -mupdate
13358 @itemx -mno-update
13359 @opindex mupdate
13360 @opindex mno-update
13361 Generate code that uses (does not use) the load or store instructions
13362 that update the base register to the address of the calculated memory
13363 location.  These instructions are generated by default.  If you use
13364 @option{-mno-update}, there is a small window between the time that the
13365 stack pointer is updated and the address of the previous frame is
13366 stored, which means code that walks the stack frame across interrupts or
13367 signals may get corrupted data.
13369 @item -mfused-madd
13370 @itemx -mno-fused-madd
13371 @opindex mfused-madd
13372 @opindex mno-fused-madd
13373 Generate code that uses (does not use) the floating point multiply and
13374 accumulate instructions.  These instructions are generated by default if
13375 hardware floating is used.
13377 @item -mmulhw
13378 @itemx -mno-mulhw
13379 @opindex mmulhw
13380 @opindex mno-mulhw
13381 Generate code that uses (does not use) the half-word multiply and
13382 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
13383 These instructions are generated by default when targetting those
13384 processors.
13386 @item -mdlmzb
13387 @itemx -mno-dlmzb
13388 @opindex mdlmzb
13389 @opindex mno-dlmzb
13390 Generate code that uses (does not use) the string-search @samp{dlmzb}
13391 instruction on the IBM 405, 440 and 464 processors.  This instruction is
13392 generated by default when targetting those processors.
13394 @item -mno-bit-align
13395 @itemx -mbit-align
13396 @opindex mno-bit-align
13397 @opindex mbit-align
13398 On System V.4 and embedded PowerPC systems do not (do) force structures
13399 and unions that contain bit-fields to be aligned to the base type of the
13400 bit-field.
13402 For example, by default a structure containing nothing but 8
13403 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13404 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13405 the structure would be aligned to a 1 byte boundary and be one byte in
13406 size.
13408 @item -mno-strict-align
13409 @itemx -mstrict-align
13410 @opindex mno-strict-align
13411 @opindex mstrict-align
13412 On System V.4 and embedded PowerPC systems do not (do) assume that
13413 unaligned memory references will be handled by the system.
13415 @item -mrelocatable
13416 @itemx -mno-relocatable
13417 @opindex mrelocatable
13418 @opindex mno-relocatable
13419 On embedded PowerPC systems generate code that allows (does not allow)
13420 the program to be relocated to a different address at runtime.  If you
13421 use @option{-mrelocatable} on any module, all objects linked together must
13422 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13424 @item -mrelocatable-lib
13425 @itemx -mno-relocatable-lib
13426 @opindex mrelocatable-lib
13427 @opindex mno-relocatable-lib
13428 On embedded PowerPC systems generate code that allows (does not allow)
13429 the program to be relocated to a different address at runtime.  Modules
13430 compiled with @option{-mrelocatable-lib} can be linked with either modules
13431 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13432 with modules compiled with the @option{-mrelocatable} options.
13434 @item -mno-toc
13435 @itemx -mtoc
13436 @opindex mno-toc
13437 @opindex mtoc
13438 On System V.4 and embedded PowerPC systems do not (do) assume that
13439 register 2 contains a pointer to a global area pointing to the addresses
13440 used in the program.
13442 @item -mlittle
13443 @itemx -mlittle-endian
13444 @opindex mlittle
13445 @opindex mlittle-endian
13446 On System V.4 and embedded PowerPC systems compile code for the
13447 processor in little endian mode.  The @option{-mlittle-endian} option is
13448 the same as @option{-mlittle}.
13450 @item -mbig
13451 @itemx -mbig-endian
13452 @opindex mbig
13453 @opindex mbig-endian
13454 On System V.4 and embedded PowerPC systems compile code for the
13455 processor in big endian mode.  The @option{-mbig-endian} option is
13456 the same as @option{-mbig}.
13458 @item -mdynamic-no-pic
13459 @opindex mdynamic-no-pic
13460 On Darwin and Mac OS X systems, compile code so that it is not
13461 relocatable, but that its external references are relocatable.  The
13462 resulting code is suitable for applications, but not shared
13463 libraries.
13465 @item -mprioritize-restricted-insns=@var{priority}
13466 @opindex mprioritize-restricted-insns
13467 This option controls the priority that is assigned to
13468 dispatch-slot restricted instructions during the second scheduling
13469 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13470 @var{no/highest/second-highest} priority to dispatch slot restricted
13471 instructions.
13473 @item -msched-costly-dep=@var{dependence_type}
13474 @opindex msched-costly-dep
13475 This option controls which dependences are considered costly
13476 by the target during instruction scheduling.  The argument
13477 @var{dependence_type} takes one of the following values:
13478 @var{no}: no dependence is costly,
13479 @var{all}: all dependences are costly,
13480 @var{true_store_to_load}: a true dependence from store to load is costly,
13481 @var{store_to_load}: any dependence from store to load is costly,
13482 @var{number}: any dependence which latency >= @var{number} is costly.
13484 @item -minsert-sched-nops=@var{scheme}
13485 @opindex minsert-sched-nops
13486 This option controls which nop insertion scheme will be used during
13487 the second scheduling pass.  The argument @var{scheme} takes one of the
13488 following values:
13489 @var{no}: Don't insert nops.
13490 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13491 according to the scheduler's grouping.
13492 @var{regroup_exact}: Insert nops to force costly dependent insns into
13493 separate groups.  Insert exactly as many nops as needed to force an insn
13494 to a new group, according to the estimated processor grouping.
13495 @var{number}: Insert nops to force costly dependent insns into
13496 separate groups.  Insert @var{number} nops to force an insn to a new group.
13498 @item -mcall-sysv
13499 @opindex mcall-sysv
13500 On System V.4 and embedded PowerPC systems compile code using calling
13501 conventions that adheres to the March 1995 draft of the System V
13502 Application Binary Interface, PowerPC processor supplement.  This is the
13503 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13505 @item -mcall-sysv-eabi
13506 @opindex mcall-sysv-eabi
13507 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13509 @item -mcall-sysv-noeabi
13510 @opindex mcall-sysv-noeabi
13511 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13513 @item -mcall-solaris
13514 @opindex mcall-solaris
13515 On System V.4 and embedded PowerPC systems compile code for the Solaris
13516 operating system.
13518 @item -mcall-linux
13519 @opindex mcall-linux
13520 On System V.4 and embedded PowerPC systems compile code for the
13521 Linux-based GNU system.
13523 @item -mcall-gnu
13524 @opindex mcall-gnu
13525 On System V.4 and embedded PowerPC systems compile code for the
13526 Hurd-based GNU system.
13528 @item -mcall-netbsd
13529 @opindex mcall-netbsd
13530 On System V.4 and embedded PowerPC systems compile code for the
13531 NetBSD operating system.
13533 @item -maix-struct-return
13534 @opindex maix-struct-return
13535 Return all structures in memory (as specified by the AIX ABI)@.
13537 @item -msvr4-struct-return
13538 @opindex msvr4-struct-return
13539 Return structures smaller than 8 bytes in registers (as specified by the
13540 SVR4 ABI)@.
13542 @item -mabi=@var{abi-type}
13543 @opindex mabi
13544 Extend the current ABI with a particular extension, or remove such extension.
13545 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13546 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13548 @item -mabi=spe
13549 @opindex mabi=spe
13550 Extend the current ABI with SPE ABI extensions.  This does not change
13551 the default ABI, instead it adds the SPE ABI extensions to the current
13552 ABI@.
13554 @item -mabi=no-spe
13555 @opindex mabi=no-spe
13556 Disable Booke SPE ABI extensions for the current ABI@.
13558 @item -mabi=ibmlongdouble
13559 @opindex mabi=ibmlongdouble
13560 Change the current ABI to use IBM extended precision long double.
13561 This is a PowerPC 32-bit SYSV ABI option.
13563 @item -mabi=ieeelongdouble
13564 @opindex mabi=ieeelongdouble
13565 Change the current ABI to use IEEE extended precision long double.
13566 This is a PowerPC 32-bit Linux ABI option.
13568 @item -mprototype
13569 @itemx -mno-prototype
13570 @opindex mprototype
13571 @opindex mno-prototype
13572 On System V.4 and embedded PowerPC systems assume that all calls to
13573 variable argument functions are properly prototyped.  Otherwise, the
13574 compiler must insert an instruction before every non prototyped call to
13575 set or clear bit 6 of the condition code register (@var{CR}) to
13576 indicate whether floating point values were passed in the floating point
13577 registers in case the function takes a variable arguments.  With
13578 @option{-mprototype}, only calls to prototyped variable argument functions
13579 will set or clear the bit.
13581 @item -msim
13582 @opindex msim
13583 On embedded PowerPC systems, assume that the startup module is called
13584 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13585 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13586 configurations.
13588 @item -mmvme
13589 @opindex mmvme
13590 On embedded PowerPC systems, assume that the startup module is called
13591 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13592 @file{libc.a}.
13594 @item -mads
13595 @opindex mads
13596 On embedded PowerPC systems, assume that the startup module is called
13597 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13598 @file{libc.a}.
13600 @item -myellowknife
13601 @opindex myellowknife
13602 On embedded PowerPC systems, assume that the startup module is called
13603 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13604 @file{libc.a}.
13606 @item -mvxworks
13607 @opindex mvxworks
13608 On System V.4 and embedded PowerPC systems, specify that you are
13609 compiling for a VxWorks system.
13611 @item -mwindiss
13612 @opindex mwindiss
13613 Specify that you are compiling for the WindISS simulation environment.
13615 @item -memb
13616 @opindex memb
13617 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13618 header to indicate that @samp{eabi} extended relocations are used.
13620 @item -meabi
13621 @itemx -mno-eabi
13622 @opindex meabi
13623 @opindex mno-eabi
13624 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13625 Embedded Applications Binary Interface (eabi) which is a set of
13626 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13627 means that the stack is aligned to an 8 byte boundary, a function
13628 @code{__eabi} is called to from @code{main} to set up the eabi
13629 environment, and the @option{-msdata} option can use both @code{r2} and
13630 @code{r13} to point to two separate small data areas.  Selecting
13631 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13632 do not call an initialization function from @code{main}, and the
13633 @option{-msdata} option will only use @code{r13} to point to a single
13634 small data area.  The @option{-meabi} option is on by default if you
13635 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13637 @item -msdata=eabi
13638 @opindex msdata=eabi
13639 On System V.4 and embedded PowerPC systems, put small initialized
13640 @code{const} global and static data in the @samp{.sdata2} section, which
13641 is pointed to by register @code{r2}.  Put small initialized
13642 non-@code{const} global and static data in the @samp{.sdata} section,
13643 which is pointed to by register @code{r13}.  Put small uninitialized
13644 global and static data in the @samp{.sbss} section, which is adjacent to
13645 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13646 incompatible with the @option{-mrelocatable} option.  The
13647 @option{-msdata=eabi} option also sets the @option{-memb} option.
13649 @item -msdata=sysv
13650 @opindex msdata=sysv
13651 On System V.4 and embedded PowerPC systems, put small global and static
13652 data in the @samp{.sdata} section, which is pointed to by register
13653 @code{r13}.  Put small uninitialized global and static data in the
13654 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13655 The @option{-msdata=sysv} option is incompatible with the
13656 @option{-mrelocatable} option.
13658 @item -msdata=default
13659 @itemx -msdata
13660 @opindex msdata=default
13661 @opindex msdata
13662 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13663 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13664 same as @option{-msdata=sysv}.
13666 @item -msdata-data
13667 @opindex msdata-data
13668 On System V.4 and embedded PowerPC systems, put small global
13669 data in the @samp{.sdata} section.  Put small uninitialized global
13670 data in the @samp{.sbss} section.  Do not use register @code{r13}
13671 to address small data however.  This is the default behavior unless
13672 other @option{-msdata} options are used.
13674 @item -msdata=none
13675 @itemx -mno-sdata
13676 @opindex msdata=none
13677 @opindex mno-sdata
13678 On embedded PowerPC systems, put all initialized global and static data
13679 in the @samp{.data} section, and all uninitialized data in the
13680 @samp{.bss} section.
13682 @item -G @var{num}
13683 @opindex G
13684 @cindex smaller data references (PowerPC)
13685 @cindex .sdata/.sdata2 references (PowerPC)
13686 On embedded PowerPC systems, put global and static items less than or
13687 equal to @var{num} bytes into the small data or bss sections instead of
13688 the normal data or bss section.  By default, @var{num} is 8.  The
13689 @option{-G @var{num}} switch is also passed to the linker.
13690 All modules should be compiled with the same @option{-G @var{num}} value.
13692 @item -mregnames
13693 @itemx -mno-regnames
13694 @opindex mregnames
13695 @opindex mno-regnames
13696 On System V.4 and embedded PowerPC systems do (do not) emit register
13697 names in the assembly language output using symbolic forms.
13699 @item -mlongcall
13700 @itemx -mno-longcall
13701 @opindex mlongcall
13702 @opindex mno-longcall
13703 By default assume that all calls are far away so that a longer more
13704 expensive calling sequence is required.  This is required for calls
13705 further than 32 megabytes (33,554,432 bytes) from the current location.
13706 A short call will be generated if the compiler knows
13707 the call cannot be that far away.  This setting can be overridden by
13708 the @code{shortcall} function attribute, or by @code{#pragma
13709 longcall(0)}.
13711 Some linkers are capable of detecting out-of-range calls and generating
13712 glue code on the fly.  On these systems, long calls are unnecessary and
13713 generate slower code.  As of this writing, the AIX linker can do this,
13714 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13715 to the GNU linker for 32-bit PowerPC systems as well.
13717 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13718 callee, L42'', plus a ``branch island'' (glue code).  The two target
13719 addresses represent the callee and the ``branch island''.  The
13720 Darwin/PPC linker will prefer the first address and generate a ``bl
13721 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13722 otherwise, the linker will generate ``bl L42'' to call the ``branch
13723 island''.  The ``branch island'' is appended to the body of the
13724 calling function; it computes the full 32-bit address of the callee
13725 and jumps to it.
13727 On Mach-O (Darwin) systems, this option directs the compiler emit to
13728 the glue for every direct call, and the Darwin linker decides whether
13729 to use or discard it.
13731 In the future, we may cause GCC to ignore all longcall specifications
13732 when the linker is known to generate glue.
13734 @item -pthread
13735 @opindex pthread
13736 Adds support for multithreading with the @dfn{pthreads} library.
13737 This option sets flags for both the preprocessor and linker.
13739 @end table
13741 @node S/390 and zSeries Options
13742 @subsection S/390 and zSeries Options
13743 @cindex S/390 and zSeries Options
13745 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13747 @table @gcctabopt
13748 @item -mhard-float
13749 @itemx -msoft-float
13750 @opindex mhard-float
13751 @opindex msoft-float
13752 Use (do not use) the hardware floating-point instructions and registers
13753 for floating-point operations.  When @option{-msoft-float} is specified,
13754 functions in @file{libgcc.a} will be used to perform floating-point
13755 operations.  When @option{-mhard-float} is specified, the compiler
13756 generates IEEE floating-point instructions.  This is the default.
13758 @item -mlong-double-64
13759 @itemx -mlong-double-128
13760 @opindex mlong-double-64
13761 @opindex mlong-double-128
13762 These switches control the size of @code{long double} type. A size
13763 of 64bit makes the @code{long double} type equivalent to the @code{double}
13764 type. This is the default.
13766 @item -mbackchain
13767 @itemx -mno-backchain
13768 @opindex mbackchain
13769 @opindex mno-backchain
13770 Store (do not store) the address of the caller's frame as backchain pointer
13771 into the callee's stack frame.
13772 A backchain may be needed to allow debugging using tools that do not understand
13773 DWARF-2 call frame information.
13774 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13775 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13776 the backchain is placed into the topmost word of the 96/160 byte register
13777 save area.
13779 In general, code compiled with @option{-mbackchain} is call-compatible with
13780 code compiled with @option{-mmo-backchain}; however, use of the backchain
13781 for debugging purposes usually requires that the whole binary is built with
13782 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13783 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13784 to build a linux kernel use @option{-msoft-float}.
13786 The default is to not maintain the backchain.
13788 @item -mpacked-stack
13789 @itemx -mno-packed-stack
13790 @opindex mpacked-stack
13791 @opindex mno-packed-stack
13792 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13793 specified, the compiler uses the all fields of the 96/160 byte register save
13794 area only for their default purpose; unused fields still take up stack space.
13795 When @option{-mpacked-stack} is specified, register save slots are densely
13796 packed at the top of the register save area; unused space is reused for other
13797 purposes, allowing for more efficient use of the available stack space.
13798 However, when @option{-mbackchain} is also in effect, the topmost word of
13799 the save area is always used to store the backchain, and the return address
13800 register is always saved two words below the backchain.
13802 As long as the stack frame backchain is not used, code generated with
13803 @option{-mpacked-stack} is call-compatible with code generated with
13804 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13805 S/390 or zSeries generated code that uses the stack frame backchain at run
13806 time, not just for debugging purposes.  Such code is not call-compatible
13807 with code compiled with @option{-mpacked-stack}.  Also, note that the
13808 combination of @option{-mbackchain},
13809 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13810 to build a linux kernel use @option{-msoft-float}.
13812 The default is to not use the packed stack layout.
13814 @item -msmall-exec
13815 @itemx -mno-small-exec
13816 @opindex msmall-exec
13817 @opindex mno-small-exec
13818 Generate (or do not generate) code using the @code{bras} instruction
13819 to do subroutine calls.
13820 This only works reliably if the total executable size does not
13821 exceed 64k.  The default is to use the @code{basr} instruction instead,
13822 which does not have this limitation.
13824 @item -m64
13825 @itemx -m31
13826 @opindex m64
13827 @opindex m31
13828 When @option{-m31} is specified, generate code compliant to the
13829 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13830 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13831 particular to generate 64-bit instructions.  For the @samp{s390}
13832 targets, the default is @option{-m31}, while the @samp{s390x}
13833 targets default to @option{-m64}.
13835 @item -mzarch
13836 @itemx -mesa
13837 @opindex mzarch
13838 @opindex mesa
13839 When @option{-mzarch} is specified, generate code using the
13840 instructions available on z/Architecture.
13841 When @option{-mesa} is specified, generate code using the
13842 instructions available on ESA/390.  Note that @option{-mesa} is
13843 not possible with @option{-m64}.
13844 When generating code compliant to the GNU/Linux for S/390 ABI,
13845 the default is @option{-mesa}.  When generating code compliant
13846 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13848 @item -mmvcle
13849 @itemx -mno-mvcle
13850 @opindex mmvcle
13851 @opindex mno-mvcle
13852 Generate (or do not generate) code using the @code{mvcle} instruction
13853 to perform block moves.  When @option{-mno-mvcle} is specified,
13854 use a @code{mvc} loop instead.  This is the default unless optimizing for
13855 size.
13857 @item -mdebug
13858 @itemx -mno-debug
13859 @opindex mdebug
13860 @opindex mno-debug
13861 Print (or do not print) additional debug information when compiling.
13862 The default is to not print debug information.
13864 @item -march=@var{cpu-type}
13865 @opindex march
13866 Generate code that will run on @var{cpu-type}, which is the name of a system
13867 representing a certain processor type.  Possible values for
13868 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13869 When generating code using the instructions available on z/Architecture,
13870 the default is @option{-march=z900}.  Otherwise, the default is
13871 @option{-march=g5}.
13873 @item -mtune=@var{cpu-type}
13874 @opindex mtune
13875 Tune to @var{cpu-type} everything applicable about the generated code,
13876 except for the ABI and the set of available instructions.
13877 The list of @var{cpu-type} values is the same as for @option{-march}.
13878 The default is the value used for @option{-march}.
13880 @item -mtpf-trace
13881 @itemx -mno-tpf-trace
13882 @opindex mtpf-trace
13883 @opindex mno-tpf-trace
13884 Generate code that adds (does not add) in TPF OS specific branches to trace
13885 routines in the operating system.  This option is off by default, even
13886 when compiling for the TPF OS@.
13888 @item -mfused-madd
13889 @itemx -mno-fused-madd
13890 @opindex mfused-madd
13891 @opindex mno-fused-madd
13892 Generate code that uses (does not use) the floating point multiply and
13893 accumulate instructions.  These instructions are generated by default if
13894 hardware floating point is used.
13896 @item -mwarn-framesize=@var{framesize}
13897 @opindex mwarn-framesize
13898 Emit a warning if the current function exceeds the given frame size.  Because
13899 this is a compile time check it doesn't need to be a real problem when the program
13900 runs.  It is intended to identify functions which most probably cause
13901 a stack overflow.  It is useful to be used in an environment with limited stack
13902 size e.g.@: the linux kernel.
13904 @item -mwarn-dynamicstack
13905 @opindex mwarn-dynamicstack
13906 Emit a warning if the function calls alloca or uses dynamically
13907 sized arrays.  This is generally a bad idea with a limited stack size.
13909 @item -mstack-guard=@var{stack-guard}
13910 @itemx -mstack-size=@var{stack-size}
13911 @opindex mstack-guard
13912 @opindex mstack-size
13913 If these options are provided the s390 back end emits additional instructions in
13914 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13915 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13916 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13917 the frame size of the compiled function is chosen.
13918 These options are intended to be used to help debugging stack overflow problems.
13919 The additionally emitted code causes only little overhead and hence can also be
13920 used in production like systems without greater performance degradation.  The given
13921 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13922 @var{stack-guard} without exceeding 64k.
13923 In order to be efficient the extra code makes the assumption that the stack starts
13924 at an address aligned to the value given by @var{stack-size}.
13925 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13926 @end table
13928 @node Score Options
13929 @subsection Score Options
13930 @cindex Score Options
13932 These options are defined for Score implementations:
13934 @table @gcctabopt
13935 @item -meb
13936 @opindex meb
13937 Compile code for big endian mode.  This is the default.
13939 @item -mel
13940 @opindex mel
13941 Compile code for little endian mode. 
13943 @item -mnhwloop
13944 @opindex mnhwloop
13945 Disable generate bcnz instruction.
13947 @item -muls
13948 @opindex muls
13949 Enable generate unaligned load and store instruction.
13951 @item -mmac
13952 @opindex mmac
13953 Enable the use of multiply-accumulate instructions. Disabled by default. 
13955 @item -mscore5
13956 @opindex mscore5
13957 Specify the SCORE5 as the target architecture.
13959 @item -mscore5u
13960 @opindex mscore5u
13961 Specify the SCORE5U of the target architecture.
13963 @item -mscore7
13964 @opindex mscore7
13965 Specify the SCORE7 as the target architecture. This is the default.
13967 @item -mscore7d
13968 @opindex mscore7d
13969 Specify the SCORE7D as the target architecture.
13970 @end table
13972 @node SH Options
13973 @subsection SH Options
13975 These @samp{-m} options are defined for the SH implementations:
13977 @table @gcctabopt
13978 @item -m1
13979 @opindex m1
13980 Generate code for the SH1.
13982 @item -m2
13983 @opindex m2
13984 Generate code for the SH2.
13986 @item -m2e
13987 Generate code for the SH2e.
13989 @item -m3
13990 @opindex m3
13991 Generate code for the SH3.
13993 @item -m3e
13994 @opindex m3e
13995 Generate code for the SH3e.
13997 @item -m4-nofpu
13998 @opindex m4-nofpu
13999 Generate code for the SH4 without a floating-point unit.
14001 @item -m4-single-only
14002 @opindex m4-single-only
14003 Generate code for the SH4 with a floating-point unit that only
14004 supports single-precision arithmetic.
14006 @item -m4-single
14007 @opindex m4-single
14008 Generate code for the SH4 assuming the floating-point unit is in
14009 single-precision mode by default.
14011 @item -m4
14012 @opindex m4
14013 Generate code for the SH4.
14015 @item -m4a-nofpu
14016 @opindex m4a-nofpu
14017 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
14018 floating-point unit is not used.
14020 @item -m4a-single-only
14021 @opindex m4a-single-only
14022 Generate code for the SH4a, in such a way that no double-precision
14023 floating point operations are used.
14025 @item -m4a-single
14026 @opindex m4a-single
14027 Generate code for the SH4a assuming the floating-point unit is in
14028 single-precision mode by default.
14030 @item -m4a
14031 @opindex m4a
14032 Generate code for the SH4a.
14034 @item -m4al
14035 @opindex m4al
14036 Same as @option{-m4a-nofpu}, except that it implicitly passes
14037 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
14038 instructions at the moment.
14040 @item -mb
14041 @opindex mb
14042 Compile code for the processor in big endian mode.
14044 @item -ml
14045 @opindex ml
14046 Compile code for the processor in little endian mode.
14048 @item -mdalign
14049 @opindex mdalign
14050 Align doubles at 64-bit boundaries.  Note that this changes the calling
14051 conventions, and thus some functions from the standard C library will
14052 not work unless you recompile it first with @option{-mdalign}.
14054 @item -mrelax
14055 @opindex mrelax
14056 Shorten some address references at link time, when possible; uses the
14057 linker option @option{-relax}.
14059 @item -mbigtable
14060 @opindex mbigtable
14061 Use 32-bit offsets in @code{switch} tables.  The default is to use
14062 16-bit offsets.
14064 @item -mbitops
14065 @opindex mbitops
14066 Enable the use of bit manipulation instructions on SH2A.
14068 @item -mfmovd
14069 @opindex mfmovd
14070 Enable the use of the instruction @code{fmovd}.
14072 @item -mhitachi
14073 @opindex mhitachi
14074 Comply with the calling conventions defined by Renesas.
14076 @item -mrenesas
14077 @opindex mhitachi
14078 Comply with the calling conventions defined by Renesas.
14080 @item -mno-renesas
14081 @opindex mhitachi
14082 Comply with the calling conventions defined for GCC before the Renesas
14083 conventions were available.  This option is the default for all
14084 targets of the SH toolchain except for @samp{sh-symbianelf}.
14086 @item -mnomacsave
14087 @opindex mnomacsave
14088 Mark the @code{MAC} register as call-clobbered, even if
14089 @option{-mhitachi} is given.
14091 @item -mieee
14092 @opindex mieee
14093 Increase IEEE-compliance of floating-point code.
14094 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14095 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14096 comparisons of NANs / infinities incurs extra overhead in every
14097 floating point comparison, therefore the default is set to
14098 @option{-ffinite-math-only}.
14100 @item -minline-ic_invalidate
14101 @opindex minline-ic_invalidate
14102 Inline code to invalidate instruction cache entries after setting up
14103 nested function trampolines.
14104 This option has no effect if -musermode is in effect and the selected
14105 code generation option (e.g. -m4) does not allow the use of the icbi
14106 instruction.
14107 If the selected code generation option does not allow the use of the icbi
14108 instruction, and -musermode is not in effect, the inlined code will
14109 manipulate the instruction cache address array directly with an associative
14110 write.  This not only requires privileged mode, but it will also
14111 fail if the cache line had been mapped via the TLB and has become unmapped.
14113 @item -misize
14114 @opindex misize
14115 Dump instruction size and location in the assembly code.
14117 @item -mpadstruct
14118 @opindex mpadstruct
14119 This option is deprecated.  It pads structures to multiple of 4 bytes,
14120 which is incompatible with the SH ABI@.
14122 @item -mspace
14123 @opindex mspace
14124 Optimize for space instead of speed.  Implied by @option{-Os}.
14126 @item -mprefergot
14127 @opindex mprefergot
14128 When generating position-independent code, emit function calls using
14129 the Global Offset Table instead of the Procedure Linkage Table.
14131 @item -musermode
14132 @opindex musermode
14133 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14134 if the inlined code would not work in user mode.
14135 This is the default when the target is @code{sh-*-linux*}.
14137 @item -multcost=@var{number}
14138 @opindex multcost=@var{number}
14139 Set the cost to assume for a multiply insn.
14141 @item -mdiv=@var{strategy}
14142 @opindex mdiv=@var{strategy}
14143 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14144 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14145 inv:call2, inv:fp .
14146 "fp" performs the operation in floating point.  This has a very high latency,
14147 but needs only a few instructions, so it might be a good choice if
14148 your code has enough easily exploitable ILP to allow the compiler to
14149 schedule the floating point instructions together with other instructions.
14150 Division by zero causes a floating point exception.
14151 "inv" uses integer operations to calculate the inverse of the divisor,
14152 and then multiplies the dividend with the inverse.  This strategy allows
14153 cse and hoisting of the inverse calculation.  Division by zero calculates
14154 an unspecified result, but does not trap.
14155 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14156 have been found, or if the entire operation has been hoisted to the same
14157 place, the last stages of the inverse calculation are intertwined with the
14158 final multiply to reduce the overall latency, at the expense of using a few
14159 more instructions, and thus offering fewer scheduling opportunities with
14160 other code.
14161 "call" calls a library function that usually implements the inv:minlat
14162 strategy.
14163 This gives high code density for m5-*media-nofpu compilations.
14164 "call2" uses a different entry point of the same library function, where it
14165 assumes that a pointer to a lookup table has already been set up, which
14166 exposes the pointer load to cse / code hoisting optimizations.
14167 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14168 code generation, but if the code stays unoptimized, revert to the "call",
14169 "call2", or "fp" strategies, respectively.  Note that the
14170 potentially-trapping side effect of division by zero is carried by a
14171 separate instruction, so it is possible that all the integer instructions
14172 are hoisted out, but the marker for the side effect stays where it is.
14173 A recombination to fp operations or a call is not possible in that case.
14174 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14175 that the inverse calculation was nor separated from the multiply, they speed
14176 up division where the dividend fits into 20 bits (plus sign where applicable),
14177 by inserting a test to skip a number of operations in this case; this test
14178 slows down the case of larger dividends.  inv20u assumes the case of a such
14179 a small dividend to be unlikely, and inv20l assumes it to be likely.
14181 @item -mdivsi3_libfunc=@var{name}
14182 @opindex mdivsi3_libfunc=@var{name}
14183 Set the name of the library function used for 32 bit signed division to
14184 @var{name}.  This only affect the name used in the call and inv:call
14185 division strategies, and the compiler will still expect the same
14186 sets of input/output/clobbered registers as if this option was not present.
14188 @item -mfixed-range=@var{register-range}
14189 @opindex mfixed-range
14190 Generate code treating the given register range as fixed registers.
14191 A fixed register is one that the register allocator can not use.  This is
14192 useful when compiling kernel code.  A register range is specified as
14193 two registers separated by a dash.  Multiple register ranges can be
14194 specified separated by a comma.
14196 @item -madjust-unroll
14197 @opindex madjust-unroll
14198 Throttle unrolling to avoid thrashing target registers.
14199 This option only has an effect if the gcc code base supports the
14200 TARGET_ADJUST_UNROLL_MAX target hook.
14202 @item -mindexed-addressing
14203 @opindex mindexed-addressing
14204 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14205 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14206 semantics for the indexed addressing mode.  The architecture allows the
14207 implementation of processors with 64 bit MMU, which the OS could use to
14208 get 32 bit addressing, but since no current hardware implementation supports
14209 this or any other way to make the indexed addressing mode safe to use in
14210 the 32 bit ABI, the default is -mno-indexed-addressing.
14212 @item -mgettrcost=@var{number}
14213 @opindex mgettrcost=@var{number}
14214 Set the cost assumed for the gettr instruction to @var{number}.
14215 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14217 @item -mpt-fixed
14218 @opindex mpt-fixed
14219 Assume pt* instructions won't trap.  This will generally generate better
14220 scheduled code, but is unsafe on current hardware.  The current architecture
14221 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14222 This has the unintentional effect of making it unsafe to schedule ptabs /
14223 ptrel before a branch, or hoist it out of a loop.  For example,
14224 __do_global_ctors, a part of libgcc that runs constructors at program
14225 startup, calls functions in a list which is delimited by @minus{}1.  With the
14226 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14227 That means that all the constructors will be run a bit quicker, but when
14228 the loop comes to the end of the list, the program crashes because ptabs
14229 loads @minus{}1 into a target register.  Since this option is unsafe for any
14230 hardware implementing the current architecture specification, the default
14231 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14232 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14233 this deters register allocation using target registers for storing
14234 ordinary integers.
14236 @item -minvalid-symbols
14237 @opindex minvalid-symbols
14238 Assume symbols might be invalid.  Ordinary function symbols generated by
14239 the compiler will always be valid to load with movi/shori/ptabs or
14240 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14241 to generate symbols that will cause ptabs / ptrel to trap.
14242 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14243 It will then prevent cross-basic-block cse, hoisting and most scheduling
14244 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14245 @end table
14247 @node SPARC Options
14248 @subsection SPARC Options
14249 @cindex SPARC options
14251 These @samp{-m} options are supported on the SPARC:
14253 @table @gcctabopt
14254 @item -mno-app-regs
14255 @itemx -mapp-regs
14256 @opindex mno-app-regs
14257 @opindex mapp-regs
14258 Specify @option{-mapp-regs} to generate output using the global registers
14259 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14260 is the default.
14262 To be fully SVR4 ABI compliant at the cost of some performance loss,
14263 specify @option{-mno-app-regs}.  You should compile libraries and system
14264 software with this option.
14266 @item -mfpu
14267 @itemx -mhard-float
14268 @opindex mfpu
14269 @opindex mhard-float
14270 Generate output containing floating point instructions.  This is the
14271 default.
14273 @item -mno-fpu
14274 @itemx -msoft-float
14275 @opindex mno-fpu
14276 @opindex msoft-float
14277 Generate output containing library calls for floating point.
14278 @strong{Warning:} the requisite libraries are not available for all SPARC
14279 targets.  Normally the facilities of the machine's usual C compiler are
14280 used, but this cannot be done directly in cross-compilation.  You must make
14281 your own arrangements to provide suitable library functions for
14282 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14283 @samp{sparclite-*-*} do provide software floating point support.
14285 @option{-msoft-float} changes the calling convention in the output file;
14286 therefore, it is only useful if you compile @emph{all} of a program with
14287 this option.  In particular, you need to compile @file{libgcc.a}, the
14288 library that comes with GCC, with @option{-msoft-float} in order for
14289 this to work.
14291 @item -mhard-quad-float
14292 @opindex mhard-quad-float
14293 Generate output containing quad-word (long double) floating point
14294 instructions.
14296 @item -msoft-quad-float
14297 @opindex msoft-quad-float
14298 Generate output containing library calls for quad-word (long double)
14299 floating point instructions.  The functions called are those specified
14300 in the SPARC ABI@.  This is the default.
14302 As of this writing, there are no SPARC implementations that have hardware
14303 support for the quad-word floating point instructions.  They all invoke
14304 a trap handler for one of these instructions, and then the trap handler
14305 emulates the effect of the instruction.  Because of the trap handler overhead,
14306 this is much slower than calling the ABI library routines.  Thus the
14307 @option{-msoft-quad-float} option is the default.
14309 @item -mno-unaligned-doubles
14310 @itemx -munaligned-doubles
14311 @opindex mno-unaligned-doubles
14312 @opindex munaligned-doubles
14313 Assume that doubles have 8 byte alignment.  This is the default.
14315 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14316 alignment only if they are contained in another type, or if they have an
14317 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14318 Specifying this option avoids some rare compatibility problems with code
14319 generated by other compilers.  It is not the default because it results
14320 in a performance loss, especially for floating point code.
14322 @item -mno-faster-structs
14323 @itemx -mfaster-structs
14324 @opindex mno-faster-structs
14325 @opindex mfaster-structs
14326 With @option{-mfaster-structs}, the compiler assumes that structures
14327 should have 8 byte alignment.  This enables the use of pairs of
14328 @code{ldd} and @code{std} instructions for copies in structure
14329 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14330 However, the use of this changed alignment directly violates the SPARC
14331 ABI@.  Thus, it's intended only for use on targets where the developer
14332 acknowledges that their resulting code will not be directly in line with
14333 the rules of the ABI@.
14335 @item -mimpure-text
14336 @opindex mimpure-text
14337 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14338 the compiler to not pass @option{-z text} to the linker when linking a
14339 shared object.  Using this option, you can link position-dependent
14340 code into a shared object.
14342 @option{-mimpure-text} suppresses the ``relocations remain against
14343 allocatable but non-writable sections'' linker error message.
14344 However, the necessary relocations will trigger copy-on-write, and the
14345 shared object is not actually shared across processes.  Instead of
14346 using @option{-mimpure-text}, you should compile all source code with
14347 @option{-fpic} or @option{-fPIC}.
14349 This option is only available on SunOS and Solaris.
14351 @item -mcpu=@var{cpu_type}
14352 @opindex mcpu
14353 Set the instruction set, register set, and instruction scheduling parameters
14354 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14355 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14356 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14357 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14358 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14360 Default instruction scheduling parameters are used for values that select
14361 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14362 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14364 Here is a list of each supported architecture and their supported
14365 implementations.
14367 @smallexample
14368     v7:             cypress
14369     v8:             supersparc, hypersparc
14370     sparclite:      f930, f934, sparclite86x
14371     sparclet:       tsc701
14372     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14373 @end smallexample
14375 By default (unless configured otherwise), GCC generates code for the V7
14376 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14377 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14378 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14379 SPARCStation 1, 2, IPX etc.
14381 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14382 architecture.  The only difference from V7 code is that the compiler emits
14383 the integer multiply and integer divide instructions which exist in SPARC-V8
14384 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14385 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14386 2000 series.
14388 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14389 the SPARC architecture.  This adds the integer multiply, integer divide step
14390 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14391 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14392 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14393 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14394 MB86934 chip, which is the more recent SPARClite with FPU@.
14396 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14397 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14398 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14399 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14400 optimizes it for the TEMIC SPARClet chip.
14402 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14403 architecture.  This adds 64-bit integer and floating-point move instructions,
14404 3 additional floating-point condition code registers and conditional move
14405 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14406 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14407 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14408 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14409 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14410 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14411 additionally optimizes it for Sun UltraSPARC T2 chips.
14413 @item -mtune=@var{cpu_type}
14414 @opindex mtune
14415 Set the instruction scheduling parameters for machine type
14416 @var{cpu_type}, but do not set the instruction set or register set that the
14417 option @option{-mcpu=@var{cpu_type}} would.
14419 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14420 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14421 that select a particular cpu implementation.  Those are @samp{cypress},
14422 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14423 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14424 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14426 @item -mv8plus
14427 @itemx -mno-v8plus
14428 @opindex mv8plus
14429 @opindex mno-v8plus
14430 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14431 difference from the V8 ABI is that the global and out registers are
14432 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14433 mode for all SPARC-V9 processors.
14435 @item -mvis
14436 @itemx -mno-vis
14437 @opindex mvis
14438 @opindex mno-vis
14439 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14440 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14441 @end table
14443 These @samp{-m} options are supported in addition to the above
14444 on SPARC-V9 processors in 64-bit environments:
14446 @table @gcctabopt
14447 @item -mlittle-endian
14448 @opindex mlittle-endian
14449 Generate code for a processor running in little-endian mode.  It is only
14450 available for a few configurations and most notably not on Solaris and Linux.
14452 @item -m32
14453 @itemx -m64
14454 @opindex m32
14455 @opindex m64
14456 Generate code for a 32-bit or 64-bit environment.
14457 The 32-bit environment sets int, long and pointer to 32 bits.
14458 The 64-bit environment sets int to 32 bits and long and pointer
14459 to 64 bits.
14461 @item -mcmodel=medlow
14462 @opindex mcmodel=medlow
14463 Generate code for the Medium/Low code model: 64-bit addresses, programs
14464 must be linked in the low 32 bits of memory.  Programs can be statically
14465 or dynamically linked.
14467 @item -mcmodel=medmid
14468 @opindex mcmodel=medmid
14469 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14470 must be linked in the low 44 bits of memory, the text and data segments must
14471 be less than 2GB in size and the data segment must be located within 2GB of
14472 the text segment.
14474 @item -mcmodel=medany
14475 @opindex mcmodel=medany
14476 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14477 may be linked anywhere in memory, the text and data segments must be less
14478 than 2GB in size and the data segment must be located within 2GB of the
14479 text segment.
14481 @item -mcmodel=embmedany
14482 @opindex mcmodel=embmedany
14483 Generate code for the Medium/Anywhere code model for embedded systems:
14484 64-bit addresses, the text and data segments must be less than 2GB in
14485 size, both starting anywhere in memory (determined at link time).  The
14486 global register %g4 points to the base of the data segment.  Programs
14487 are statically linked and PIC is not supported.
14489 @item -mstack-bias
14490 @itemx -mno-stack-bias
14491 @opindex mstack-bias
14492 @opindex mno-stack-bias
14493 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14494 frame pointer if present, are offset by @minus{}2047 which must be added back
14495 when making stack frame references.  This is the default in 64-bit mode.
14496 Otherwise, assume no such offset is present.
14497 @end table
14499 These switches are supported in addition to the above on Solaris:
14501 @table @gcctabopt
14502 @item -threads
14503 @opindex threads
14504 Add support for multithreading using the Solaris threads library.  This
14505 option sets flags for both the preprocessor and linker.  This option does
14506 not affect the thread safety of object code produced by the compiler or
14507 that of libraries supplied with it.
14509 @item -pthreads
14510 @opindex pthreads
14511 Add support for multithreading using the POSIX threads library.  This
14512 option sets flags for both the preprocessor and linker.  This option does
14513 not affect the thread safety of object code produced  by the compiler or
14514 that of libraries supplied with it.
14516 @item -pthread
14517 @opindex pthread
14518 This is a synonym for @option{-pthreads}.
14519 @end table
14521 @node SPU Options
14522 @subsection SPU Options
14523 @cindex SPU options
14525 These @samp{-m} options are supported on the SPU:
14527 @table @gcctabopt
14528 @item -mwarn-reloc
14529 @itemx -merror-reloc
14530 @opindex mwarn-reloc
14531 @opindex merror-reloc
14533 The loader for SPU does not handle dynamic relocations.  By default, GCC
14534 will give an error when it generates code that requires a dynamic
14535 relocation.  @option{-mno-error-reloc} disables the error,
14536 @option{-mwarn-reloc} will generate a warning instead.
14538 @item -msafe-dma
14539 @itemx -munsafe-dma
14540 @opindex msafe-dma
14541 @opindex munsafe-dma
14543 Instructions which initiate or test completion of DMA must not be
14544 reordered with respect to loads and stores of the memory which is being
14545 accessed.  Users typically address this problem using the volatile
14546 keyword, but that can lead to inefficient code in places where the
14547 memory is known to not change.  Rather than mark the memory as volatile
14548 we treat the DMA instructions as potentially effecting all memory.  With
14549 @option{-munsafe-dma} users must use the volatile keyword to protect
14550 memory accesses.
14552 @item -mbranch-hints
14553 @opindex mbranch-hints
14555 By default, GCC will generate a branch hint instruction to avoid
14556 pipeline stalls for always taken or probably taken branches.  A hint
14557 will not be generated closer than 8 instructions away from its branch.
14558 There is little reason to disable them, except for debugging purposes,
14559 or to make an object a little bit smaller.
14561 @item -msmall-mem
14562 @itemx -mlarge-mem
14563 @opindex msmall-mem
14564 @opindex mlarge-mem
14566 By default, GCC generates code assuming that addresses are never larger
14567 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14568 a full 32 bit address.
14570 @item -mstdmain
14571 @opindex mstdmain
14573 By default, GCC links against startup code that assumes the SPU-style
14574 main function interface (which has an unconventional parameter list).
14575 With @option{-mstdmain}, GCC will link your program against startup
14576 code that assumes a C99-style interface to @code{main}, including a
14577 local copy of @code{argv} strings.
14579 @item -mfixed-range=@var{register-range}
14580 @opindex mfixed-range
14581 Generate code treating the given register range as fixed registers.
14582 A fixed register is one that the register allocator can not use.  This is
14583 useful when compiling kernel code.  A register range is specified as
14584 two registers separated by a dash.  Multiple register ranges can be
14585 specified separated by a comma.
14587 @end table
14589 @node System V Options
14590 @subsection Options for System V
14592 These additional options are available on System V Release 4 for
14593 compatibility with other compilers on those systems:
14595 @table @gcctabopt
14596 @item -G
14597 @opindex G
14598 Create a shared object.
14599 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14601 @item -Qy
14602 @opindex Qy
14603 Identify the versions of each tool used by the compiler, in a
14604 @code{.ident} assembler directive in the output.
14606 @item -Qn
14607 @opindex Qn
14608 Refrain from adding @code{.ident} directives to the output file (this is
14609 the default).
14611 @item -YP,@var{dirs}
14612 @opindex YP
14613 Search the directories @var{dirs}, and no others, for libraries
14614 specified with @option{-l}.
14616 @item -Ym,@var{dir}
14617 @opindex Ym
14618 Look in the directory @var{dir} to find the M4 preprocessor.
14619 The assembler uses this option.
14620 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14621 @c the generic assembler that comes with Solaris takes just -Ym.
14622 @end table
14624 @node V850 Options
14625 @subsection V850 Options
14626 @cindex V850 Options
14628 These @samp{-m} options are defined for V850 implementations:
14630 @table @gcctabopt
14631 @item -mlong-calls
14632 @itemx -mno-long-calls
14633 @opindex mlong-calls
14634 @opindex mno-long-calls
14635 Treat all calls as being far away (near).  If calls are assumed to be
14636 far away, the compiler will always load the functions address up into a
14637 register, and call indirect through the pointer.
14639 @item -mno-ep
14640 @itemx -mep
14641 @opindex mno-ep
14642 @opindex mep
14643 Do not optimize (do optimize) basic blocks that use the same index
14644 pointer 4 or more times to copy pointer into the @code{ep} register, and
14645 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14646 option is on by default if you optimize.
14648 @item -mno-prolog-function
14649 @itemx -mprolog-function
14650 @opindex mno-prolog-function
14651 @opindex mprolog-function
14652 Do not use (do use) external functions to save and restore registers
14653 at the prologue and epilogue of a function.  The external functions
14654 are slower, but use less code space if more than one function saves
14655 the same number of registers.  The @option{-mprolog-function} option
14656 is on by default if you optimize.
14658 @item -mspace
14659 @opindex mspace
14660 Try to make the code as small as possible.  At present, this just turns
14661 on the @option{-mep} and @option{-mprolog-function} options.
14663 @item -mtda=@var{n}
14664 @opindex mtda
14665 Put static or global variables whose size is @var{n} bytes or less into
14666 the tiny data area that register @code{ep} points to.  The tiny data
14667 area can hold up to 256 bytes in total (128 bytes for byte references).
14669 @item -msda=@var{n}
14670 @opindex msda
14671 Put static or global variables whose size is @var{n} bytes or less into
14672 the small data area that register @code{gp} points to.  The small data
14673 area can hold up to 64 kilobytes.
14675 @item -mzda=@var{n}
14676 @opindex mzda
14677 Put static or global variables whose size is @var{n} bytes or less into
14678 the first 32 kilobytes of memory.
14680 @item -mv850
14681 @opindex mv850
14682 Specify that the target processor is the V850.
14684 @item -mbig-switch
14685 @opindex mbig-switch
14686 Generate code suitable for big switch tables.  Use this option only if
14687 the assembler/linker complain about out of range branches within a switch
14688 table.
14690 @item -mapp-regs
14691 @opindex mapp-regs
14692 This option will cause r2 and r5 to be used in the code generated by
14693 the compiler.  This setting is the default.
14695 @item -mno-app-regs
14696 @opindex mno-app-regs
14697 This option will cause r2 and r5 to be treated as fixed registers.
14699 @item -mv850e1
14700 @opindex mv850e1
14701 Specify that the target processor is the V850E1.  The preprocessor
14702 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14703 this option is used.
14705 @item -mv850e
14706 @opindex mv850e
14707 Specify that the target processor is the V850E@.  The preprocessor
14708 constant @samp{__v850e__} will be defined if this option is used.
14710 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14711 are defined then a default target processor will be chosen and the
14712 relevant @samp{__v850*__} preprocessor constant will be defined.
14714 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14715 defined, regardless of which processor variant is the target.
14717 @item -mdisable-callt
14718 @opindex mdisable-callt
14719 This option will suppress generation of the CALLT instruction for the
14720 v850e and v850e1 flavors of the v850 architecture.  The default is
14721 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14723 @end table
14725 @node VAX Options
14726 @subsection VAX Options
14727 @cindex VAX options
14729 These @samp{-m} options are defined for the VAX:
14731 @table @gcctabopt
14732 @item -munix
14733 @opindex munix
14734 Do not output certain jump instructions (@code{aobleq} and so on)
14735 that the Unix assembler for the VAX cannot handle across long
14736 ranges.
14738 @item -mgnu
14739 @opindex mgnu
14740 Do output those jump instructions, on the assumption that you
14741 will assemble with the GNU assembler.
14743 @item -mg
14744 @opindex mg
14745 Output code for g-format floating point numbers instead of d-format.
14746 @end table
14748 @node VxWorks Options
14749 @subsection VxWorks Options
14750 @cindex VxWorks Options
14752 The options in this section are defined for all VxWorks targets.
14753 Options specific to the target hardware are listed with the other
14754 options for that target.
14756 @table @gcctabopt
14757 @item -mrtp
14758 @opindex mrtp
14759 GCC can generate code for both VxWorks kernels and real time processes
14760 (RTPs).  This option switches from the former to the latter.  It also
14761 defines the preprocessor macro @code{__RTP__}.
14763 @item -non-static
14764 @opindex non-static
14765 Link an RTP executable against shared libraries rather than static
14766 libraries.  The options @option{-static} and @option{-shared} can
14767 also be used for RTPs (@pxref{Link Options}); @option{-static}
14768 is the default.
14770 @item -Bstatic
14771 @itemx -Bdynamic
14772 @opindex Bstatic
14773 @opindex Bdynamic
14774 These options are passed down to the linker.  They are defined for
14775 compatibility with Diab.
14777 @item -Xbind-lazy
14778 @opindex Xbind-lazy
14779 Enable lazy binding of function calls.  This option is equivalent to
14780 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14782 @item -Xbind-now
14783 @opindex Xbind-now
14784 Disable lazy binding of function calls.  This option is the default and
14785 is defined for compatibility with Diab.
14786 @end table
14788 @node x86-64 Options
14789 @subsection x86-64 Options
14790 @cindex x86-64 options
14792 These are listed under @xref{i386 and x86-64 Options}.
14794 @node Xstormy16 Options
14795 @subsection Xstormy16 Options
14796 @cindex Xstormy16 Options
14798 These options are defined for Xstormy16:
14800 @table @gcctabopt
14801 @item -msim
14802 @opindex msim
14803 Choose startup files and linker script suitable for the simulator.
14804 @end table
14806 @node Xtensa Options
14807 @subsection Xtensa Options
14808 @cindex Xtensa Options
14810 These options are supported for Xtensa targets:
14812 @table @gcctabopt
14813 @item -mconst16
14814 @itemx -mno-const16
14815 @opindex mconst16
14816 @opindex mno-const16
14817 Enable or disable use of @code{CONST16} instructions for loading
14818 constant values.  The @code{CONST16} instruction is currently not a
14819 standard option from Tensilica.  When enabled, @code{CONST16}
14820 instructions are always used in place of the standard @code{L32R}
14821 instructions.  The use of @code{CONST16} is enabled by default only if
14822 the @code{L32R} instruction is not available.
14824 @item -mfused-madd
14825 @itemx -mno-fused-madd
14826 @opindex mfused-madd
14827 @opindex mno-fused-madd
14828 Enable or disable use of fused multiply/add and multiply/subtract
14829 instructions in the floating-point option.  This has no effect if the
14830 floating-point option is not also enabled.  Disabling fused multiply/add
14831 and multiply/subtract instructions forces the compiler to use separate
14832 instructions for the multiply and add/subtract operations.  This may be
14833 desirable in some cases where strict IEEE 754-compliant results are
14834 required: the fused multiply add/subtract instructions do not round the
14835 intermediate result, thereby producing results with @emph{more} bits of
14836 precision than specified by the IEEE standard.  Disabling fused multiply
14837 add/subtract instructions also ensures that the program output is not
14838 sensitive to the compiler's ability to combine multiply and add/subtract
14839 operations.
14841 @item -mserialize-volatile
14842 @itemx -mno-serialize-volatile
14843 @opindex mserialize-volatile
14844 @opindex mno-serialize-volatile
14845 When this option is enabled, GCC inserts @code{MEMW} instructions before
14846 @code{volatile} memory references to guarantee sequential consistency.
14847 The default is @option{-mserialize-volatile}.  Use
14848 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14850 @item -mtext-section-literals
14851 @itemx -mno-text-section-literals
14852 @opindex mtext-section-literals
14853 @opindex mno-text-section-literals
14854 Control the treatment of literal pools.  The default is
14855 @option{-mno-text-section-literals}, which places literals in a separate
14856 section in the output file.  This allows the literal pool to be placed
14857 in a data RAM/ROM, and it also allows the linker to combine literal
14858 pools from separate object files to remove redundant literals and
14859 improve code size.  With @option{-mtext-section-literals}, the literals
14860 are interspersed in the text section in order to keep them as close as
14861 possible to their references.  This may be necessary for large assembly
14862 files.
14864 @item -mtarget-align
14865 @itemx -mno-target-align
14866 @opindex mtarget-align
14867 @opindex mno-target-align
14868 When this option is enabled, GCC instructs the assembler to
14869 automatically align instructions to reduce branch penalties at the
14870 expense of some code density.  The assembler attempts to widen density
14871 instructions to align branch targets and the instructions following call
14872 instructions.  If there are not enough preceding safe density
14873 instructions to align a target, no widening will be performed.  The
14874 default is @option{-mtarget-align}.  These options do not affect the
14875 treatment of auto-aligned instructions like @code{LOOP}, which the
14876 assembler will always align, either by widening density instructions or
14877 by inserting no-op instructions.
14879 @item -mlongcalls
14880 @itemx -mno-longcalls
14881 @opindex mlongcalls
14882 @opindex mno-longcalls
14883 When this option is enabled, GCC instructs the assembler to translate
14884 direct calls to indirect calls unless it can determine that the target
14885 of a direct call is in the range allowed by the call instruction.  This
14886 translation typically occurs for calls to functions in other source
14887 files.  Specifically, the assembler translates a direct @code{CALL}
14888 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14889 The default is @option{-mno-longcalls}.  This option should be used in
14890 programs where the call target can potentially be out of range.  This
14891 option is implemented in the assembler, not the compiler, so the
14892 assembly code generated by GCC will still show direct call
14893 instructions---look at the disassembled object code to see the actual
14894 instructions.  Note that the assembler will use an indirect call for
14895 every cross-file call, not just those that really will be out of range.
14896 @end table
14898 @node zSeries Options
14899 @subsection zSeries Options
14900 @cindex zSeries options
14902 These are listed under @xref{S/390 and zSeries Options}.
14904 @node Code Gen Options
14905 @section Options for Code Generation Conventions
14906 @cindex code generation conventions
14907 @cindex options, code generation
14908 @cindex run-time options
14910 These machine-independent options control the interface conventions
14911 used in code generation.
14913 Most of them have both positive and negative forms; the negative form
14914 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14915 one of the forms is listed---the one which is not the default.  You
14916 can figure out the other form by either removing @samp{no-} or adding
14919 @table @gcctabopt
14920 @item -fbounds-check
14921 @opindex fbounds-check
14922 For front-ends that support it, generate additional code to check that
14923 indices used to access arrays are within the declared range.  This is
14924 currently only supported by the Java and Fortran front-ends, where
14925 this option defaults to true and false respectively.
14927 @item -ftrapv
14928 @opindex ftrapv
14929 This option generates traps for signed overflow on addition, subtraction,
14930 multiplication operations.
14932 @item -fwrapv
14933 @opindex fwrapv
14934 This option instructs the compiler to assume that signed arithmetic
14935 overflow of addition, subtraction and multiplication wraps around
14936 using twos-complement representation.  This flag enables some optimizations
14937 and disables others.  This option is enabled by default for the Java
14938 front-end, as required by the Java language specification.
14940 @item -fexceptions
14941 @opindex fexceptions
14942 Enable exception handling.  Generates extra code needed to propagate
14943 exceptions.  For some targets, this implies GCC will generate frame
14944 unwind information for all functions, which can produce significant data
14945 size overhead, although it does not affect execution.  If you do not
14946 specify this option, GCC will enable it by default for languages like
14947 C++ which normally require exception handling, and disable it for
14948 languages like C that do not normally require it.  However, you may need
14949 to enable this option when compiling C code that needs to interoperate
14950 properly with exception handlers written in C++.  You may also wish to
14951 disable this option if you are compiling older C++ programs that don't
14952 use exception handling.
14954 @item -fnon-call-exceptions
14955 @opindex fnon-call-exceptions
14956 Generate code that allows trapping instructions to throw exceptions.
14957 Note that this requires platform-specific runtime support that does
14958 not exist everywhere.  Moreover, it only allows @emph{trapping}
14959 instructions to throw exceptions, i.e.@: memory references or floating
14960 point instructions.  It does not allow exceptions to be thrown from
14961 arbitrary signal handlers such as @code{SIGALRM}.
14963 @item -funwind-tables
14964 @opindex funwind-tables
14965 Similar to @option{-fexceptions}, except that it will just generate any needed
14966 static data, but will not affect the generated code in any other way.
14967 You will normally not enable this option; instead, a language processor
14968 that needs this handling would enable it on your behalf.
14970 @item -fasynchronous-unwind-tables
14971 @opindex fasynchronous-unwind-tables
14972 Generate unwind table in dwarf2 format, if supported by target machine.  The
14973 table is exact at each instruction boundary, so it can be used for stack
14974 unwinding from asynchronous events (such as debugger or garbage collector).
14976 @item -fpcc-struct-return
14977 @opindex fpcc-struct-return
14978 Return ``short'' @code{struct} and @code{union} values in memory like
14979 longer ones, rather than in registers.  This convention is less
14980 efficient, but it has the advantage of allowing intercallability between
14981 GCC-compiled files and files compiled with other compilers, particularly
14982 the Portable C Compiler (pcc).
14984 The precise convention for returning structures in memory depends
14985 on the target configuration macros.
14987 Short structures and unions are those whose size and alignment match
14988 that of some integer type.
14990 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14991 switch is not binary compatible with code compiled with the
14992 @option{-freg-struct-return} switch.
14993 Use it to conform to a non-default application binary interface.
14995 @item -freg-struct-return
14996 @opindex freg-struct-return
14997 Return @code{struct} and @code{union} values in registers when possible.
14998 This is more efficient for small structures than
14999 @option{-fpcc-struct-return}.
15001 If you specify neither @option{-fpcc-struct-return} nor
15002 @option{-freg-struct-return}, GCC defaults to whichever convention is
15003 standard for the target.  If there is no standard convention, GCC
15004 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
15005 the principal compiler.  In those cases, we can choose the standard, and
15006 we chose the more efficient register return alternative.
15008 @strong{Warning:} code compiled with the @option{-freg-struct-return}
15009 switch is not binary compatible with code compiled with the
15010 @option{-fpcc-struct-return} switch.
15011 Use it to conform to a non-default application binary interface.
15013 @item -fshort-enums
15014 @opindex fshort-enums
15015 Allocate to an @code{enum} type only as many bytes as it needs for the
15016 declared range of possible values.  Specifically, the @code{enum} type
15017 will be equivalent to the smallest integer type which has enough room.
15019 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
15020 code that is not binary compatible with code generated without that switch.
15021 Use it to conform to a non-default application binary interface.
15023 @item -fshort-double
15024 @opindex fshort-double
15025 Use the same size for @code{double} as for @code{float}.
15027 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
15028 code that is not binary compatible with code generated without that switch.
15029 Use it to conform to a non-default application binary interface.
15031 @item -fshort-wchar
15032 @opindex fshort-wchar
15033 Override the underlying type for @samp{wchar_t} to be @samp{short
15034 unsigned int} instead of the default for the target.  This option is
15035 useful for building programs to run under WINE@.
15037 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
15038 code that is not binary compatible with code generated without that switch.
15039 Use it to conform to a non-default application binary interface.
15041 @item -fno-common
15042 @opindex fno-common
15043 In C, allocate even uninitialized global variables in the data section of the
15044 object file, rather than generating them as common blocks.  This has the
15045 effect that if the same variable is declared (without @code{extern}) in
15046 two different compilations, you will get an error when you link them.
15047 The only reason this might be useful is if you wish to verify that the
15048 program will work on other systems which always work this way.
15050 @item -fno-ident
15051 @opindex fno-ident
15052 Ignore the @samp{#ident} directive.
15054 @item -finhibit-size-directive
15055 @opindex finhibit-size-directive
15056 Don't output a @code{.size} assembler directive, or anything else that
15057 would cause trouble if the function is split in the middle, and the
15058 two halves are placed at locations far apart in memory.  This option is
15059 used when compiling @file{crtstuff.c}; you should not need to use it
15060 for anything else.
15062 @item -fverbose-asm
15063 @opindex fverbose-asm
15064 Put extra commentary information in the generated assembly code to
15065 make it more readable.  This option is generally only of use to those
15066 who actually need to read the generated assembly code (perhaps while
15067 debugging the compiler itself).
15069 @option{-fno-verbose-asm}, the default, causes the
15070 extra information to be omitted and is useful when comparing two assembler
15071 files.
15073 @item -frecord-gcc-switches
15074 @opindex frecord-gcc-switches
15075 This switch causes the command line that was used to invoke the
15076 compiler to be recorded into the object file that is being created.
15077 This switch is only implemented on some targets and the exact format
15078 of the recording is target and binary file format dependent, but it
15079 usually takes the form of a section containing ASCII text.  This
15080 switch is related to the @option{-fverbose-asm} switch, but that
15081 switch only records information in the assembler output file as
15082 comments, so it never reaches the object file.
15084 @item -fpic
15085 @opindex fpic
15086 @cindex global offset table
15087 @cindex PIC
15088 Generate position-independent code (PIC) suitable for use in a shared
15089 library, if supported for the target machine.  Such code accesses all
15090 constant addresses through a global offset table (GOT)@.  The dynamic
15091 loader resolves the GOT entries when the program starts (the dynamic
15092 loader is not part of GCC; it is part of the operating system).  If
15093 the GOT size for the linked executable exceeds a machine-specific
15094 maximum size, you get an error message from the linker indicating that
15095 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15096 instead.  (These maximums are 8k on the SPARC and 32k
15097 on the m68k and RS/6000.  The 386 has no such limit.)
15099 Position-independent code requires special support, and therefore works
15100 only on certain machines.  For the 386, GCC supports PIC for System V
15101 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15102 position-independent.
15104 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15105 are defined to 1.
15107 @item -fPIC
15108 @opindex fPIC
15109 If supported for the target machine, emit position-independent code,
15110 suitable for dynamic linking and avoiding any limit on the size of the
15111 global offset table.  This option makes a difference on the m68k,
15112 PowerPC and SPARC@.
15114 Position-independent code requires special support, and therefore works
15115 only on certain machines.
15117 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15118 are defined to 2.
15120 @item -fpie
15121 @itemx -fPIE
15122 @opindex fpie
15123 @opindex fPIE
15124 These options are similar to @option{-fpic} and @option{-fPIC}, but
15125 generated position independent code can be only linked into executables.
15126 Usually these options are used when @option{-pie} GCC option will be
15127 used during linking.
15129 @option{-fpie} and @option{-fPIE} both define the macros
15130 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15131 for @option{-fpie} and 2 for @option{-fPIE}.
15133 @item -fno-jump-tables
15134 @opindex fno-jump-tables
15135 Do not use jump tables for switch statements even where it would be
15136 more efficient than other code generation strategies.  This option is
15137 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15138 building code which forms part of a dynamic linker and cannot
15139 reference the address of a jump table.  On some targets, jump tables
15140 do not require a GOT and this option is not needed.
15142 @item -ffixed-@var{reg}
15143 @opindex ffixed
15144 Treat the register named @var{reg} as a fixed register; generated code
15145 should never refer to it (except perhaps as a stack pointer, frame
15146 pointer or in some other fixed role).
15148 @var{reg} must be the name of a register.  The register names accepted
15149 are machine-specific and are defined in the @code{REGISTER_NAMES}
15150 macro in the machine description macro file.
15152 This flag does not have a negative form, because it specifies a
15153 three-way choice.
15155 @item -fcall-used-@var{reg}
15156 @opindex fcall-used
15157 Treat the register named @var{reg} as an allocable register that is
15158 clobbered by function calls.  It may be allocated for temporaries or
15159 variables that do not live across a call.  Functions compiled this way
15160 will not save and restore the register @var{reg}.
15162 It is an error to used this flag with the frame pointer or stack pointer.
15163 Use of this flag for other registers that have fixed pervasive roles in
15164 the machine's execution model will produce disastrous results.
15166 This flag does not have a negative form, because it specifies a
15167 three-way choice.
15169 @item -fcall-saved-@var{reg}
15170 @opindex fcall-saved
15171 Treat the register named @var{reg} as an allocable register saved by
15172 functions.  It may be allocated even for temporaries or variables that
15173 live across a call.  Functions compiled this way will save and restore
15174 the register @var{reg} if they use it.
15176 It is an error to used this flag with the frame pointer or stack pointer.
15177 Use of this flag for other registers that have fixed pervasive roles in
15178 the machine's execution model will produce disastrous results.
15180 A different sort of disaster will result from the use of this flag for
15181 a register in which function values may be returned.
15183 This flag does not have a negative form, because it specifies a
15184 three-way choice.
15186 @item -fpack-struct[=@var{n}]
15187 @opindex fpack-struct
15188 Without a value specified, pack all structure members together without
15189 holes.  When a value is specified (which must be a small power of two), pack
15190 structure members according to this value, representing the maximum
15191 alignment (that is, objects with default alignment requirements larger than
15192 this will be output potentially unaligned at the next fitting location.
15194 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15195 code that is not binary compatible with code generated without that switch.
15196 Additionally, it makes the code suboptimal.
15197 Use it to conform to a non-default application binary interface.
15199 @item -finstrument-functions
15200 @opindex finstrument-functions
15201 Generate instrumentation calls for entry and exit to functions.  Just
15202 after function entry and just before function exit, the following
15203 profiling functions will be called with the address of the current
15204 function and its call site.  (On some platforms,
15205 @code{__builtin_return_address} does not work beyond the current
15206 function, so the call site information may not be available to the
15207 profiling functions otherwise.)
15209 @smallexample
15210 void __cyg_profile_func_enter (void *this_fn,
15211                                void *call_site);
15212 void __cyg_profile_func_exit  (void *this_fn,
15213                                void *call_site);
15214 @end smallexample
15216 The first argument is the address of the start of the current function,
15217 which may be looked up exactly in the symbol table.
15219 This instrumentation is also done for functions expanded inline in other
15220 functions.  The profiling calls will indicate where, conceptually, the
15221 inline function is entered and exited.  This means that addressable
15222 versions of such functions must be available.  If all your uses of a
15223 function are expanded inline, this may mean an additional expansion of
15224 code size.  If you use @samp{extern inline} in your C code, an
15225 addressable version of such functions must be provided.  (This is
15226 normally the case anyways, but if you get lucky and the optimizer always
15227 expands the functions inline, you might have gotten away without
15228 providing static copies.)
15230 A function may be given the attribute @code{no_instrument_function}, in
15231 which case this instrumentation will not be done.  This can be used, for
15232 example, for the profiling functions listed above, high-priority
15233 interrupt routines, and any functions from which the profiling functions
15234 cannot safely be called (perhaps signal handlers, if the profiling
15235 routines generate output or allocate memory).
15237 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15238 @opindex finstrument-functions-exclude-file-list
15240 Set the list of functions that are excluded from instrumentation (see
15241 the description of @code{-finstrument-functions}).  If the file that
15242 contains a function definition matches with one of @var{file}, then
15243 that function is not instrumented.  The match is done on substrings:
15244 if the @var{file} parameter is a substring of the file name, it is
15245 considered to be a match.
15247 For example,
15248 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15249 will exclude any inline function defined in files whose pathnames
15250 contain @code{/bits/stl} or @code{include/sys}.
15252 If, for some reason, you want to include letter @code{','} in one of
15253 @var{sym}, write @code{'\,'}. For example,
15254 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15255 (note the single quote surrounding the option).
15257 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15258 @opindex finstrument-functions-exclude-function-list
15260 This is similar to @code{-finstrument-functions-exclude-file-list},
15261 but this option sets the list of function names to be excluded from
15262 instrumentation.  The function name to be matched is its user-visible
15263 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15264 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15265 match is done on substrings: if the @var{sym} parameter is a substring
15266 of the function name, it is considered to be a match.
15268 @item -fstack-check
15269 @opindex fstack-check
15270 Generate code to verify that you do not go beyond the boundary of the
15271 stack.  You should specify this flag if you are running in an
15272 environment with multiple threads, but only rarely need to specify it in
15273 a single-threaded environment since stack overflow is automatically
15274 detected on nearly all systems if there is only one stack.
15276 Note that this switch does not actually cause checking to be done; the
15277 operating system must do that.  The switch causes generation of code
15278 to ensure that the operating system sees the stack being extended.
15280 @item -fstack-limit-register=@var{reg}
15281 @itemx -fstack-limit-symbol=@var{sym}
15282 @itemx -fno-stack-limit
15283 @opindex fstack-limit-register
15284 @opindex fstack-limit-symbol
15285 @opindex fno-stack-limit
15286 Generate code to ensure that the stack does not grow beyond a certain value,
15287 either the value of a register or the address of a symbol.  If the stack
15288 would grow beyond the value, a signal is raised.  For most targets,
15289 the signal is raised before the stack overruns the boundary, so
15290 it is possible to catch the signal without taking special precautions.
15292 For instance, if the stack starts at absolute address @samp{0x80000000}
15293 and grows downwards, you can use the flags
15294 @option{-fstack-limit-symbol=__stack_limit} and
15295 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15296 of 128KB@.  Note that this may only work with the GNU linker.
15298 @cindex aliasing of parameters
15299 @cindex parameters, aliased
15300 @item -fargument-alias
15301 @itemx -fargument-noalias
15302 @itemx -fargument-noalias-global
15303 @itemx -fargument-noalias-anything
15304 @opindex fargument-alias
15305 @opindex fargument-noalias
15306 @opindex fargument-noalias-global
15307 @opindex fargument-noalias-anything
15308 Specify the possible relationships among parameters and between
15309 parameters and global data.
15311 @option{-fargument-alias} specifies that arguments (parameters) may
15312 alias each other and may alias global storage.@*
15313 @option{-fargument-noalias} specifies that arguments do not alias
15314 each other, but may alias global storage.@*
15315 @option{-fargument-noalias-global} specifies that arguments do not
15316 alias each other and do not alias global storage.
15317 @option{-fargument-noalias-anything} specifies that arguments do not
15318 alias any other storage.
15320 Each language will automatically use whatever option is required by
15321 the language standard.  You should not need to use these options yourself.
15323 @item -fleading-underscore
15324 @opindex fleading-underscore
15325 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15326 change the way C symbols are represented in the object file.  One use
15327 is to help link with legacy assembly code.
15329 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15330 generate code that is not binary compatible with code generated without that
15331 switch.  Use it to conform to a non-default application binary interface.
15332 Not all targets provide complete support for this switch.
15334 @item -ftls-model=@var{model}
15335 @opindex ftls-model
15336 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15337 The @var{model} argument should be one of @code{global-dynamic},
15338 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15340 The default without @option{-fpic} is @code{initial-exec}; with
15341 @option{-fpic} the default is @code{global-dynamic}.
15343 @item -fvisibility=@var{default|internal|hidden|protected}
15344 @opindex fvisibility
15345 Set the default ELF image symbol visibility to the specified option---all
15346 symbols will be marked with this unless overridden within the code.
15347 Using this feature can very substantially improve linking and
15348 load times of shared object libraries, produce more optimized
15349 code, provide near-perfect API export and prevent symbol clashes.
15350 It is @strong{strongly} recommended that you use this in any shared objects
15351 you distribute.
15353 Despite the nomenclature, @code{default} always means public ie;
15354 available to be linked against from outside the shared object.
15355 @code{protected} and @code{internal} are pretty useless in real-world
15356 usage so the only other commonly used option will be @code{hidden}.
15357 The default if @option{-fvisibility} isn't specified is
15358 @code{default}, i.e., make every
15359 symbol public---this causes the same behavior as previous versions of
15360 GCC@.
15362 A good explanation of the benefits offered by ensuring ELF
15363 symbols have the correct visibility is given by ``How To Write
15364 Shared Libraries'' by Ulrich Drepper (which can be found at
15365 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15366 solution made possible by this option to marking things hidden when
15367 the default is public is to make the default hidden and mark things
15368 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15369 and @code{__attribute__ ((visibility("default")))} instead of
15370 @code{__declspec(dllexport)} you get almost identical semantics with
15371 identical syntax.  This is a great boon to those working with
15372 cross-platform projects.
15374 For those adding visibility support to existing code, you may find
15375 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15376 the declarations you wish to set visibility for with (for example)
15377 @samp{#pragma GCC visibility push(hidden)} and
15378 @samp{#pragma GCC visibility pop}.
15379 Bear in mind that symbol visibility should be viewed @strong{as
15380 part of the API interface contract} and thus all new code should
15381 always specify visibility when it is not the default ie; declarations
15382 only for use within the local DSO should @strong{always} be marked explicitly
15383 as hidden as so to avoid PLT indirection overheads---making this
15384 abundantly clear also aids readability and self-documentation of the code.
15385 Note that due to ISO C++ specification requirements, operator new and
15386 operator delete must always be of default visibility.
15388 Be aware that headers from outside your project, in particular system
15389 headers and headers from any other library you use, may not be
15390 expecting to be compiled with visibility other than the default.  You
15391 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15392 before including any such headers.
15394 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15395 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15396 no modifications.  However, this means that calls to @samp{extern}
15397 functions with no explicit visibility will use the PLT, so it is more
15398 effective to use @samp{__attribute ((visibility))} and/or
15399 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15400 declarations should be treated as hidden.
15402 Note that @samp{-fvisibility} does affect C++ vague linkage
15403 entities. This means that, for instance, an exception class that will
15404 be thrown between DSOs must be explicitly marked with default
15405 visibility so that the @samp{type_info} nodes will be unified between
15406 the DSOs.
15408 An overview of these techniques, their benefits and how to use them
15409 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15411 @end table
15413 @c man end
15415 @node Environment Variables
15416 @section Environment Variables Affecting GCC
15417 @cindex environment variables
15419 @c man begin ENVIRONMENT
15420 This section describes several environment variables that affect how GCC
15421 operates.  Some of them work by specifying directories or prefixes to use
15422 when searching for various kinds of files.  Some are used to specify other
15423 aspects of the compilation environment.
15425 Note that you can also specify places to search using options such as
15426 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15427 take precedence over places specified using environment variables, which
15428 in turn take precedence over those specified by the configuration of GCC@.
15429 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15430 GNU Compiler Collection (GCC) Internals}.
15432 @table @env
15433 @item LANG
15434 @itemx LC_CTYPE
15435 @c @itemx LC_COLLATE
15436 @itemx LC_MESSAGES
15437 @c @itemx LC_MONETARY
15438 @c @itemx LC_NUMERIC
15439 @c @itemx LC_TIME
15440 @itemx LC_ALL
15441 @findex LANG
15442 @findex LC_CTYPE
15443 @c @findex LC_COLLATE
15444 @findex LC_MESSAGES
15445 @c @findex LC_MONETARY
15446 @c @findex LC_NUMERIC
15447 @c @findex LC_TIME
15448 @findex LC_ALL
15449 @cindex locale
15450 These environment variables control the way that GCC uses
15451 localization information that allow GCC to work with different
15452 national conventions.  GCC inspects the locale categories
15453 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15454 so.  These locale categories can be set to any value supported by your
15455 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15456 Kingdom encoded in UTF-8.
15458 The @env{LC_CTYPE} environment variable specifies character
15459 classification.  GCC uses it to determine the character boundaries in
15460 a string; this is needed for some multibyte encodings that contain quote
15461 and escape characters that would otherwise be interpreted as a string
15462 end or escape.
15464 The @env{LC_MESSAGES} environment variable specifies the language to
15465 use in diagnostic messages.
15467 If the @env{LC_ALL} environment variable is set, it overrides the value
15468 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15469 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15470 environment variable.  If none of these variables are set, GCC
15471 defaults to traditional C English behavior.
15473 @item TMPDIR
15474 @findex TMPDIR
15475 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15476 files.  GCC uses temporary files to hold the output of one stage of
15477 compilation which is to be used as input to the next stage: for example,
15478 the output of the preprocessor, which is the input to the compiler
15479 proper.
15481 @item GCC_EXEC_PREFIX
15482 @findex GCC_EXEC_PREFIX
15483 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15484 names of the subprograms executed by the compiler.  No slash is added
15485 when this prefix is combined with the name of a subprogram, but you can
15486 specify a prefix that ends with a slash if you wish.
15488 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15489 an appropriate prefix to use based on the pathname it was invoked with.
15491 If GCC cannot find the subprogram using the specified prefix, it
15492 tries looking in the usual places for the subprogram.
15494 The default value of @env{GCC_EXEC_PREFIX} is
15495 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15496 the installed compiler. In many cases @var{prefix} is the value
15497 of @code{prefix} when you ran the @file{configure} script.
15499 Other prefixes specified with @option{-B} take precedence over this prefix.
15501 This prefix is also used for finding files such as @file{crt0.o} that are
15502 used for linking.
15504 In addition, the prefix is used in an unusual way in finding the
15505 directories to search for header files.  For each of the standard
15506 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15507 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15508 replacing that beginning with the specified prefix to produce an
15509 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15510 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15511 These alternate directories are searched first; the standard directories
15512 come next. If a standard directory begins with the configured
15513 @var{prefix} then the value of @var{prefix} is replaced by
15514 @env{GCC_EXEC_PREFIX} when looking for header files.
15516 @item COMPILER_PATH
15517 @findex COMPILER_PATH
15518 The value of @env{COMPILER_PATH} is a colon-separated list of
15519 directories, much like @env{PATH}.  GCC tries the directories thus
15520 specified when searching for subprograms, if it can't find the
15521 subprograms using @env{GCC_EXEC_PREFIX}.
15523 @item LIBRARY_PATH
15524 @findex LIBRARY_PATH
15525 The value of @env{LIBRARY_PATH} is a colon-separated list of
15526 directories, much like @env{PATH}.  When configured as a native compiler,
15527 GCC tries the directories thus specified when searching for special
15528 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15529 using GCC also uses these directories when searching for ordinary
15530 libraries for the @option{-l} option (but directories specified with
15531 @option{-L} come first).
15533 @item LANG
15534 @findex LANG
15535 @cindex locale definition
15536 This variable is used to pass locale information to the compiler.  One way in
15537 which this information is used is to determine the character set to be used
15538 when character literals, string literals and comments are parsed in C and C++.
15539 When the compiler is configured to allow multibyte characters,
15540 the following values for @env{LANG} are recognized:
15542 @table @samp
15543 @item C-JIS
15544 Recognize JIS characters.
15545 @item C-SJIS
15546 Recognize SJIS characters.
15547 @item C-EUCJP
15548 Recognize EUCJP characters.
15549 @end table
15551 If @env{LANG} is not defined, or if it has some other value, then the
15552 compiler will use mblen and mbtowc as defined by the default locale to
15553 recognize and translate multibyte characters.
15554 @end table
15556 @noindent
15557 Some additional environments variables affect the behavior of the
15558 preprocessor.
15560 @include cppenv.texi
15562 @c man end
15564 @node Precompiled Headers
15565 @section Using Precompiled Headers
15566 @cindex precompiled headers
15567 @cindex speed of compilation
15569 Often large projects have many header files that are included in every
15570 source file.  The time the compiler takes to process these header files
15571 over and over again can account for nearly all of the time required to
15572 build the project.  To make builds faster, GCC allows users to
15573 `precompile' a header file; then, if builds can use the precompiled
15574 header file they will be much faster.
15576 To create a precompiled header file, simply compile it as you would any
15577 other file, if necessary using the @option{-x} option to make the driver
15578 treat it as a C or C++ header file.  You will probably want to use a
15579 tool like @command{make} to keep the precompiled header up-to-date when
15580 the headers it contains change.
15582 A precompiled header file will be searched for when @code{#include} is
15583 seen in the compilation.  As it searches for the included file
15584 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15585 compiler looks for a precompiled header in each directory just before it
15586 looks for the include file in that directory.  The name searched for is
15587 the name specified in the @code{#include} with @samp{.gch} appended.  If
15588 the precompiled header file can't be used, it is ignored.
15590 For instance, if you have @code{#include "all.h"}, and you have
15591 @file{all.h.gch} in the same directory as @file{all.h}, then the
15592 precompiled header file will be used if possible, and the original
15593 header will be used otherwise.
15595 Alternatively, you might decide to put the precompiled header file in a
15596 directory and use @option{-I} to ensure that directory is searched
15597 before (or instead of) the directory containing the original header.
15598 Then, if you want to check that the precompiled header file is always
15599 used, you can put a file of the same name as the original header in this
15600 directory containing an @code{#error} command.
15602 This also works with @option{-include}.  So yet another way to use
15603 precompiled headers, good for projects not designed with precompiled
15604 header files in mind, is to simply take most of the header files used by
15605 a project, include them from another header file, precompile that header
15606 file, and @option{-include} the precompiled header.  If the header files
15607 have guards against multiple inclusion, they will be skipped because
15608 they've already been included (in the precompiled header).
15610 If you need to precompile the same header file for different
15611 languages, targets, or compiler options, you can instead make a
15612 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15613 header in the directory, perhaps using @option{-o}.  It doesn't matter
15614 what you call the files in the directory, every precompiled header in
15615 the directory will be considered.  The first precompiled header
15616 encountered in the directory that is valid for this compilation will
15617 be used; they're searched in no particular order.
15619 There are many other possibilities, limited only by your imagination,
15620 good sense, and the constraints of your build system.
15622 A precompiled header file can be used only when these conditions apply:
15624 @itemize
15625 @item
15626 Only one precompiled header can be used in a particular compilation.
15628 @item
15629 A precompiled header can't be used once the first C token is seen.  You
15630 can have preprocessor directives before a precompiled header; you can
15631 even include a precompiled header from inside another header, so long as
15632 there are no C tokens before the @code{#include}.
15634 @item
15635 The precompiled header file must be produced for the same language as
15636 the current compilation.  You can't use a C precompiled header for a C++
15637 compilation.
15639 @item
15640 The precompiled header file must have been produced by the same compiler
15641 binary as the current compilation is using.
15643 @item
15644 Any macros defined before the precompiled header is included must
15645 either be defined in the same way as when the precompiled header was
15646 generated, or must not affect the precompiled header, which usually
15647 means that they don't appear in the precompiled header at all.
15649 The @option{-D} option is one way to define a macro before a
15650 precompiled header is included; using a @code{#define} can also do it.
15651 There are also some options that define macros implicitly, like
15652 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15653 defined this way.
15655 @item If debugging information is output when using the precompiled
15656 header, using @option{-g} or similar, the same kind of debugging information
15657 must have been output when building the precompiled header.  However,
15658 a precompiled header built using @option{-g} can be used in a compilation
15659 when no debugging information is being output.
15661 @item The same @option{-m} options must generally be used when building
15662 and using the precompiled header.  @xref{Submodel Options},
15663 for any cases where this rule is relaxed.
15665 @item Each of the following options must be the same when building and using
15666 the precompiled header:
15668 @gccoptlist{-fexceptions -funit-at-a-time}
15670 @item
15671 Some other command-line options starting with @option{-f},
15672 @option{-p}, or @option{-O} must be defined in the same way as when
15673 the precompiled header was generated.  At present, it's not clear
15674 which options are safe to change and which are not; the safest choice
15675 is to use exactly the same options when generating and using the
15676 precompiled header.  The following are known to be safe:
15678 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15679 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15680 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15681 -pedantic-errors}
15683 @end itemize
15685 For all of these except the last, the compiler will automatically
15686 ignore the precompiled header if the conditions aren't met.  If you
15687 find an option combination that doesn't work and doesn't cause the
15688 precompiled header to be ignored, please consider filing a bug report,
15689 see @ref{Bugs}.
15691 If you do use differing options when generating and using the
15692 precompiled header, the actual behavior will be a mixture of the
15693 behavior for the options.  For instance, if you use @option{-g} to
15694 generate the precompiled header but not when using it, you may or may
15695 not get debugging information for routines in the precompiled header.
15697 @node Running Protoize
15698 @section Running Protoize
15700 The program @code{protoize} is an optional part of GCC@.  You can use
15701 it to add prototypes to a program, thus converting the program to ISO
15702 C in one respect.  The companion program @code{unprotoize} does the
15703 reverse: it removes argument types from any prototypes that are found.
15705 When you run these programs, you must specify a set of source files as
15706 command line arguments.  The conversion programs start out by compiling
15707 these files to see what functions they define.  The information gathered
15708 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15710 After scanning comes actual conversion.  The specified files are all
15711 eligible to be converted; any files they include (whether sources or
15712 just headers) are eligible as well.
15714 But not all the eligible files are converted.  By default,
15715 @code{protoize} and @code{unprotoize} convert only source and header
15716 files in the current directory.  You can specify additional directories
15717 whose files should be converted with the @option{-d @var{directory}}
15718 option.  You can also specify particular files to exclude with the
15719 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15720 directory name matches one of the specified directory names, and its
15721 name within the directory has not been excluded.
15723 Basic conversion with @code{protoize} consists of rewriting most
15724 function definitions and function declarations to specify the types of
15725 the arguments.  The only ones not rewritten are those for varargs
15726 functions.
15728 @code{protoize} optionally inserts prototype declarations at the
15729 beginning of the source file, to make them available for any calls that
15730 precede the function's definition.  Or it can insert prototype
15731 declarations with block scope in the blocks where undeclared functions
15732 are called.
15734 Basic conversion with @code{unprotoize} consists of rewriting most
15735 function declarations to remove any argument types, and rewriting
15736 function definitions to the old-style pre-ISO form.
15738 Both conversion programs print a warning for any function declaration or
15739 definition that they can't convert.  You can suppress these warnings
15740 with @option{-q}.
15742 The output from @code{protoize} or @code{unprotoize} replaces the
15743 original source file.  The original file is renamed to a name ending
15744 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15745 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15746 for DOS) file already exists, then the source file is simply discarded.
15748 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15749 scan the program and collect information about the functions it uses.
15750 So neither of these programs will work until GCC is installed.
15752 Here is a table of the options you can use with @code{protoize} and
15753 @code{unprotoize}.  Each option works with both programs unless
15754 otherwise stated.
15756 @table @code
15757 @item -B @var{directory}
15758 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15759 usual directory (normally @file{/usr/local/lib}).  This file contains
15760 prototype information about standard system functions.  This option
15761 applies only to @code{protoize}.
15763 @item -c @var{compilation-options}
15764 Use @var{compilation-options} as the options when running @command{gcc} to
15765 produce the @samp{.X} files.  The special option @option{-aux-info} is
15766 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15768 Note that the compilation options must be given as a single argument to
15769 @code{protoize} or @code{unprotoize}.  If you want to specify several
15770 @command{gcc} options, you must quote the entire set of compilation options
15771 to make them a single word in the shell.
15773 There are certain @command{gcc} arguments that you cannot use, because they
15774 would produce the wrong kind of output.  These include @option{-g},
15775 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15776 the @var{compilation-options}, they are ignored.
15778 @item -C
15779 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15780 systems) instead of @samp{.c}.  This is convenient if you are converting
15781 a C program to C++.  This option applies only to @code{protoize}.
15783 @item -g
15784 Add explicit global declarations.  This means inserting explicit
15785 declarations at the beginning of each source file for each function
15786 that is called in the file and was not declared.  These declarations
15787 precede the first function definition that contains a call to an
15788 undeclared function.  This option applies only to @code{protoize}.
15790 @item -i @var{string}
15791 Indent old-style parameter declarations with the string @var{string}.
15792 This option applies only to @code{protoize}.
15794 @code{unprotoize} converts prototyped function definitions to old-style
15795 function definitions, where the arguments are declared between the
15796 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15797 uses five spaces as the indentation.  If you want to indent with just
15798 one space instead, use @option{-i " "}.
15800 @item -k
15801 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15802 is finished.
15804 @item -l
15805 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15806 a prototype declaration for each function in each block which calls the
15807 function without any declaration.  This option applies only to
15808 @code{protoize}.
15810 @item -n
15811 Make no real changes.  This mode just prints information about the conversions
15812 that would have been done without @option{-n}.
15814 @item -N
15815 Make no @samp{.save} files.  The original files are simply deleted.
15816 Use this option with caution.
15818 @item -p @var{program}
15819 Use the program @var{program} as the compiler.  Normally, the name
15820 @file{gcc} is used.
15822 @item -q
15823 Work quietly.  Most warnings are suppressed.
15825 @item -v
15826 Print the version number, just like @option{-v} for @command{gcc}.
15827 @end table
15829 If you need special compiler options to compile one of your program's
15830 source files, then you should generate that file's @samp{.X} file
15831 specially, by running @command{gcc} on that source file with the
15832 appropriate options and the option @option{-aux-info}.  Then run
15833 @code{protoize} on the entire set of files.  @code{protoize} will use
15834 the existing @samp{.X} file because it is newer than the source file.
15835 For example:
15837 @smallexample
15838 gcc -Dfoo=bar file1.c -aux-info file1.X
15839 protoize *.c
15840 @end smallexample
15842 @noindent
15843 You need to include the special files along with the rest in the
15844 @code{protoize} command, even though their @samp{.X} files already
15845 exist, because otherwise they won't get converted.
15847 @xref{Protoize Caveats}, for more information on how to use
15848 @code{protoize} successfully.