Update concepts branch to revision 131834
[official-gcc.git] / gcc / doc / invoke.texi
blob9be3d679f6b0cf1a5b6161ac100e0c59ddaa1fbb
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-translation-unit@r{[}-@var{n}@r{]} @gol
277 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
278 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
279 -fdump-statistics @gol
280 -fdump-tree-all @gol
281 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
282 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
284 -fdump-tree-ch @gol
285 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
289 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-nrv -fdump-tree-vect @gol
294 -fdump-tree-sink @gol
295 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
298 -ftree-vectorizer-verbose=@var{n} @gol
299 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
300 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
301 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
302 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
303 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
304 -ftest-coverage  -ftime-report -fvar-tracking @gol
305 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
306 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
307 -fno-merge-debug-strings -fdebug-prefix-map=@var{old}=@var{new} @gol
308 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
309 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
310 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
311 -print-multi-directory  -print-multi-lib @gol
312 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
313 -print-sysroot-headers-suffix @gol
314 -save-temps  -time}
316 @item Optimization Options
317 @xref{Optimize Options,,Options that Control Optimization}.
318 @gccoptlist{
319 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
320 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
321 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
322 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
323 -fcheck-data-deps -fcprop-registers -fcrossjumping -fcse-follow-jumps @gol
324 -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
325 -fdata-sections -fdce -fdce @gol
326 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
327 -fearly-inlining -fexpensive-optimizations -ffast-math @gol
328 -ffinite-math-only -ffloat-store -fforward-propagate @gol
329 -ffunction-sections -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
330 -fgcse-sm -fif-conversion -fif-conversion2 -finline-functions @gol
331 -finline-functions-called-once -finline-limit=@var{n} @gol
332 -finline-small-functions -fipa-cp -fipa-marix-reorg -fipa-pta @gol 
333 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
334 -fipa-type-escape -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
335 -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
336 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
337 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
338 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
339 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
340 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
341 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
342 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
343 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
344 -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} @gol
345 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
346 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
347 -freorder-blocks-and-partition -freorder-functions @gol
348 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
349 -frounding-math -frtl-abstract-sequences -fsched2-use-superblocks @gol
350 -fsched2-use-traces -fsched-spec-load -fsched-spec-load-dangerous @gol
351 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
352 -fschedule-insns -fschedule-insns2 -fsection-anchors -fsee @gol
353 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
354 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
355 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
356 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
357 -ftree-copyrename -ftree-dce @gol
358 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
359 -ftree-loop-distribution @gol
360 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
361 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
362 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-ter @gol
363 -ftree-vect-loop-version -ftree-vectorize -ftree-vrp -funit-at-a-time @gol
364 -funroll-all-loops -funroll-loops -funsafe-loop-optimizations @gol
365 -funsafe-math-optimizations -funswitch-loops @gol
366 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
367 -fwhole-program @gol
368 --param @var{name}=@var{value}
369 -O  -O0  -O1  -O2  -O3  -Os}
371 @item Preprocessor Options
372 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
373 @gccoptlist{-A@var{question}=@var{answer} @gol
374 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
375 -C  -dD  -dI  -dM  -dN @gol
376 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
377 -idirafter @var{dir} @gol
378 -include @var{file}  -imacros @var{file} @gol
379 -iprefix @var{file}  -iwithprefix @var{dir} @gol
380 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
381 -imultilib @var{dir} -isysroot @var{dir} @gol
382 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
383 -P  -fworking-directory  -remap @gol
384 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
385 -Xpreprocessor @var{option}}
387 @item Assembler Option
388 @xref{Assembler Options,,Passing Options to the Assembler}.
389 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
391 @item Linker Options
392 @xref{Link Options,,Options for Linking}.
393 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
394 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
395 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
396 -Wl,@var{option}  -Xlinker @var{option} @gol
397 -u @var{symbol}}
399 @item Directory Options
400 @xref{Directory Options,,Options for Directory Search}.
401 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
402 -specs=@var{file}  -I- --sysroot=@var{dir}}
404 @item Target Options
405 @c I wrote this xref this way to avoid overfull hbox. -- rms
406 @xref{Target Options}.
407 @gccoptlist{-V @var{version}  -b @var{machine}}
409 @item Machine Dependent Options
410 @xref{Submodel Options,,Hardware Models and Configurations}.
411 @c This list is ordered alphanumerically by subsection name.
412 @c Try and put the significant identifier (CPU or system) first,
413 @c so users have a clue at guessing where the ones they want will be.
415 @emph{ARC Options}
416 @gccoptlist{-EB  -EL @gol
417 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
418 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
420 @emph{ARM Options}
421 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
422 -mabi=@var{name} @gol
423 -mapcs-stack-check  -mno-apcs-stack-check @gol
424 -mapcs-float  -mno-apcs-float @gol
425 -mapcs-reentrant  -mno-apcs-reentrant @gol
426 -msched-prolog  -mno-sched-prolog @gol
427 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
428 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
429 -mthumb-interwork  -mno-thumb-interwork @gol
430 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
431 -mstructure-size-boundary=@var{n} @gol
432 -mabort-on-noreturn @gol
433 -mlong-calls  -mno-long-calls @gol
434 -msingle-pic-base  -mno-single-pic-base @gol
435 -mpic-register=@var{reg} @gol
436 -mnop-fun-dllimport @gol
437 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
438 -mpoke-function-name @gol
439 -mthumb  -marm @gol
440 -mtpcs-frame  -mtpcs-leaf-frame @gol
441 -mcaller-super-interworking  -mcallee-super-interworking @gol
442 -mtp=@var{name}}
444 @emph{AVR Options}
445 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
446 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
448 @emph{Blackfin Options}
449 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
450 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
451 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
452 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
453 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
454 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
455 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
456 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram}
458 @emph{CRIS Options}
459 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
460 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
461 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
462 -mstack-align  -mdata-align  -mconst-align @gol
463 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
464 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
465 -mmul-bug-workaround  -mno-mul-bug-workaround}
467 @emph{CRX Options}
468 @gccoptlist{-mmac -mpush-args}
470 @emph{Darwin Options}
471 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
472 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
473 -client_name  -compatibility_version  -current_version @gol
474 -dead_strip @gol
475 -dependency-file  -dylib_file  -dylinker_install_name @gol
476 -dynamic  -dynamiclib  -exported_symbols_list @gol
477 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
478 -force_flat_namespace  -headerpad_max_install_names @gol
479 -iframework @gol
480 -image_base  -init  -install_name  -keep_private_externs @gol
481 -multi_module  -multiply_defined  -multiply_defined_unused @gol
482 -noall_load   -no_dead_strip_inits_and_terms @gol
483 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
484 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
485 -private_bundle  -read_only_relocs  -sectalign @gol
486 -sectobjectsymbols  -whyload  -seg1addr @gol
487 -sectcreate  -sectobjectsymbols  -sectorder @gol
488 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
489 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
490 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
491 -single_module  -static  -sub_library  -sub_umbrella @gol
492 -twolevel_namespace  -umbrella  -undefined @gol
493 -unexported_symbols_list  -weak_reference_mismatches @gol
494 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
495 -mkernel -mone-byte-bool}
497 @emph{DEC Alpha Options}
498 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
499 -mieee  -mieee-with-inexact  -mieee-conformant @gol
500 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
501 -mtrap-precision=@var{mode}  -mbuild-constants @gol
502 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
503 -mbwx  -mmax  -mfix  -mcix @gol
504 -mfloat-vax  -mfloat-ieee @gol
505 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
506 -msmall-text  -mlarge-text @gol
507 -mmemory-latency=@var{time}}
509 @emph{DEC Alpha/VMS Options}
510 @gccoptlist{-mvms-return-codes}
512 @emph{FRV Options}
513 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
514 -mhard-float  -msoft-float @gol
515 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
516 -mdouble  -mno-double @gol
517 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
518 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
519 -mlinked-fp  -mlong-calls  -malign-labels @gol
520 -mlibrary-pic  -macc-4  -macc-8 @gol
521 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
522 -moptimize-membar -mno-optimize-membar @gol
523 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
524 -mvliw-branch  -mno-vliw-branch @gol
525 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
526 -mno-nested-cond-exec  -mtomcat-stats @gol
527 -mTLS -mtls @gol
528 -mcpu=@var{cpu}}
530 @emph{GNU/Linux Options}
531 @gccoptlist{-muclibc}
533 @emph{H8/300 Options}
534 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
536 @emph{HPPA Options}
537 @gccoptlist{-march=@var{architecture-type} @gol
538 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
539 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
540 -mfixed-range=@var{register-range} @gol
541 -mjump-in-delay -mlinker-opt -mlong-calls @gol
542 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
543 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
544 -mno-jump-in-delay  -mno-long-load-store @gol
545 -mno-portable-runtime  -mno-soft-float @gol
546 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
547 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
548 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
549 -munix=@var{unix-std}  -nolibdld  -static  -threads}
551 @emph{i386 and x86-64 Options}
552 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
553 -mfpmath=@var{unit} @gol
554 -masm=@var{dialect}  -mno-fancy-math-387 @gol
555 -mno-fp-ret-in-387  -msoft-float @gol
556 -mno-wide-multiply  -mrtd  -malign-double @gol
557 -mpreferred-stack-boundary=@var{num} -mcld -mcx16 -msahf -mrecip @gol
558 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
559 -maes -mpclmul @gol
560 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
561 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
562 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
563 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
564 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
565 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
566 -mcmodel=@var{code-model} @gol
567 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
568 -mfused-madd -mno-fused-madd}
570 @emph{IA-64 Options}
571 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
572 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
573 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
574 -minline-float-divide-max-throughput @gol
575 -minline-int-divide-min-latency @gol
576 -minline-int-divide-max-throughput  @gol
577 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
578 -mno-dwarf2-asm -mearly-stop-bits @gol
579 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
580 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
581 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
582 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
583 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
584 -mno-sched-prefer-non-data-spec-insns @gol
585 -mno-sched-prefer-non-control-spec-insns @gol
586 -mno-sched-count-spec-in-critical-path}
588 @emph{M32R/D Options}
589 @gccoptlist{-m32r2 -m32rx -m32r @gol
590 -mdebug @gol
591 -malign-loops -mno-align-loops @gol
592 -missue-rate=@var{number} @gol
593 -mbranch-cost=@var{number} @gol
594 -mmodel=@var{code-size-model-type} @gol
595 -msdata=@var{sdata-type} @gol
596 -mno-flush-func -mflush-func=@var{name} @gol
597 -mno-flush-trap -mflush-trap=@var{number} @gol
598 -G @var{num}}
600 @emph{M32C Options}
601 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
603 @emph{M680x0 Options}
604 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
605 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
606 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
607 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
608 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
609 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
610 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
611 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
612 -mxgot -mno-xgot}
614 @emph{M68hc1x Options}
615 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
616 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
617 -msoft-reg-count=@var{count}}
619 @emph{MCore Options}
620 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
621 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
622 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
623 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
624 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
626 @emph{MIPS Options}
627 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
628 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
629 -mips16  -mno-mips16  -mflip-mips16 @gol
630 -minterlink-mips16  -mno-interlink-mips16 @gol
631 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
632 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
633 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
634 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
635 -msmartmips  -mno-smartmips @gol
636 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
637 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
638 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
639 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
640 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
641 -membedded-data  -mno-embedded-data @gol
642 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
643 -mcode-readable=@var{setting} @gol
644 -msplit-addresses  -mno-split-addresses @gol
645 -mexplicit-relocs  -mno-explicit-relocs @gol
646 -mcheck-zero-division  -mno-check-zero-division @gol
647 -mdivide-traps  -mdivide-breaks @gol
648 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
649 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
650 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
651 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
652 -mfix-sb1  -mno-fix-sb1 @gol
653 -mflush-func=@var{func}  -mno-flush-func @gol
654 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
655 -mfp-exceptions -mno-fp-exceptions @gol
656 -mvr4130-align -mno-vr4130-align}
658 @emph{MMIX Options}
659 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
660 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
661 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
662 -mno-base-addresses  -msingle-exit  -mno-single-exit}
664 @emph{MN10300 Options}
665 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
666 -mam33  -mno-am33 @gol
667 -mam33-2  -mno-am33-2 @gol
668 -mreturn-pointer-on-d0 @gol
669 -mno-crt0  -mrelax}
671 @emph{PDP-11 Options}
672 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
673 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
674 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
675 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
676 -mbranch-expensive  -mbranch-cheap @gol
677 -msplit  -mno-split  -munix-asm  -mdec-asm}
679 @emph{PowerPC Options}
680 See RS/6000 and PowerPC Options.
682 @emph{RS/6000 and PowerPC Options}
683 @gccoptlist{-mcpu=@var{cpu-type} @gol
684 -mtune=@var{cpu-type} @gol
685 -mpower  -mno-power  -mpower2  -mno-power2 @gol
686 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
687 -maltivec  -mno-altivec @gol
688 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
689 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
690 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
691 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
692 -mnew-mnemonics  -mold-mnemonics @gol
693 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
694 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
695 -malign-power  -malign-natural @gol
696 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
697 -mstring  -mno-string  -mupdate  -mno-update @gol
698 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
699 -mstrict-align  -mno-strict-align  -mrelocatable @gol
700 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
701 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
702 -mdynamic-no-pic  -maltivec  -mswdiv @gol
703 -mprioritize-restricted-insns=@var{priority} @gol
704 -msched-costly-dep=@var{dependence_type} @gol
705 -minsert-sched-nops=@var{scheme} @gol
706 -mcall-sysv  -mcall-netbsd @gol
707 -maix-struct-return  -msvr4-struct-return @gol
708 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
709 -misel -mno-isel @gol
710 -misel=yes  -misel=no @gol
711 -mspe -mno-spe @gol
712 -mspe=yes  -mspe=no @gol
713 -mpaired @gol
714 -mvrsave -mno-vrsave @gol
715 -mmulhw -mno-mulhw @gol
716 -mdlmzb -mno-dlmzb @gol
717 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
718 -mprototype  -mno-prototype @gol
719 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
720 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
722 @emph{S/390 and zSeries Options}
723 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
724 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
725 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
726 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
727 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
728 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
729 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
731 @emph{Score Options}
732 @gccoptlist{-meb -mel @gol
733 -mnhwloop @gol
734 -muls @gol
735 -mmac @gol
736 -mscore5 -mscore5u -mscore7 -mscore7d}
738 @emph{SH Options}
739 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
740 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
741 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
742 -m5-64media  -m5-64media-nofpu @gol
743 -m5-32media  -m5-32media-nofpu @gol
744 -m5-compact  -m5-compact-nofpu @gol
745 -mb  -ml  -mdalign  -mrelax @gol
746 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
747 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
748 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
749 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
750 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
751  -minvalid-symbols}
753 @emph{SPARC Options}
754 @gccoptlist{-mcpu=@var{cpu-type} @gol
755 -mtune=@var{cpu-type} @gol
756 -mcmodel=@var{code-model} @gol
757 -m32  -m64  -mapp-regs  -mno-app-regs @gol
758 -mfaster-structs  -mno-faster-structs @gol
759 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
760 -mhard-quad-float  -msoft-quad-float @gol
761 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
762 -mstack-bias  -mno-stack-bias @gol
763 -munaligned-doubles  -mno-unaligned-doubles @gol
764 -mv8plus  -mno-v8plus  -mvis  -mno-vis
765 -threads -pthreads -pthread}
767 @emph{SPU Options}
768 @gccoptlist{-mwarn-reloc -merror-reloc @gol
769 -msafe-dma -munsafe-dma @gol
770 -mbranch-hints @gol
771 -msmall-mem -mlarge-mem -mstdmain @gol
772 -mfixed-range=@var{register-range}}
774 @emph{System V Options}
775 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
777 @emph{V850 Options}
778 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
779 -mprolog-function  -mno-prolog-function  -mspace @gol
780 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
781 -mapp-regs  -mno-app-regs @gol
782 -mdisable-callt  -mno-disable-callt @gol
783 -mv850e1 @gol
784 -mv850e @gol
785 -mv850  -mbig-switch}
787 @emph{VAX Options}
788 @gccoptlist{-mg  -mgnu  -munix}
790 @emph{VxWorks Options}
791 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
792 -Xbind-lazy  -Xbind-now}
794 @emph{x86-64 Options}
795 See i386 and x86-64 Options.
797 @emph{Xstormy16 Options}
798 @gccoptlist{-msim}
800 @emph{Xtensa Options}
801 @gccoptlist{-mconst16 -mno-const16 @gol
802 -mfused-madd  -mno-fused-madd @gol
803 -mserialize-volatile  -mno-serialize-volatile @gol
804 -mtext-section-literals  -mno-text-section-literals @gol
805 -mtarget-align  -mno-target-align @gol
806 -mlongcalls  -mno-longcalls}
808 @emph{zSeries Options}
809 See S/390 and zSeries Options.
811 @item Code Generation Options
812 @xref{Code Gen Options,,Options for Code Generation Conventions}.
813 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
814 -ffixed-@var{reg}  -fexceptions @gol
815 -fnon-call-exceptions  -funwind-tables @gol
816 -fasynchronous-unwind-tables @gol
817 -finhibit-size-directive  -finstrument-functions @gol
818 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
819 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
820 -fno-common  -fno-ident @gol
821 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
822 -fno-jump-tables @gol
823 -frecord-gcc-switches @gol
824 -freg-struct-return  -fshort-enums @gol
825 -fshort-double  -fshort-wchar @gol
826 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
827 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
828 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
829 -fargument-noalias-global  -fargument-noalias-anything @gol
830 -fleading-underscore  -ftls-model=@var{model} @gol
831 -ftrapv  -fwrapv  -fbounds-check @gol
832 -fvisibility}
833 @end table
835 @menu
836 * Overall Options::     Controlling the kind of output:
837                         an executable, object files, assembler files,
838                         or preprocessed source.
839 * C Dialect Options::   Controlling the variant of C language compiled.
840 * C++ Dialect Options:: Variations on C++.
841 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
842                         and Objective-C++.
843 * Language Independent Options:: Controlling how diagnostics should be
844                         formatted.
845 * Warning Options::     How picky should the compiler be?
846 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
847 * Optimize Options::    How much optimization?
848 * Preprocessor Options:: Controlling header files and macro definitions.
849                          Also, getting dependency information for Make.
850 * Assembler Options::   Passing options to the assembler.
851 * Link Options::        Specifying libraries and so on.
852 * Directory Options::   Where to find header files and libraries.
853                         Where to find the compiler executable files.
854 * Spec Files::          How to pass switches to sub-processes.
855 * Target Options::      Running a cross-compiler, or an old version of GCC.
856 @end menu
858 @node Overall Options
859 @section Options Controlling the Kind of Output
861 Compilation can involve up to four stages: preprocessing, compilation
862 proper, assembly and linking, always in that order.  GCC is capable of
863 preprocessing and compiling several files either into several
864 assembler input files, or into one assembler input file; then each
865 assembler input file produces an object file, and linking combines all
866 the object files (those newly compiled, and those specified as input)
867 into an executable file.
869 @cindex file name suffix
870 For any given input file, the file name suffix determines what kind of
871 compilation is done:
873 @table @gcctabopt
874 @item @var{file}.c
875 C source code which must be preprocessed.
877 @item @var{file}.i
878 C source code which should not be preprocessed.
880 @item @var{file}.ii
881 C++ source code which should not be preprocessed.
883 @item @var{file}.m
884 Objective-C source code.  Note that you must link with the @file{libobjc}
885 library to make an Objective-C program work.
887 @item @var{file}.mi
888 Objective-C source code which should not be preprocessed.
890 @item @var{file}.mm
891 @itemx @var{file}.M
892 Objective-C++ source code.  Note that you must link with the @file{libobjc}
893 library to make an Objective-C++ program work.  Note that @samp{.M} refers
894 to a literal capital M@.
896 @item @var{file}.mii
897 Objective-C++ source code which should not be preprocessed.
899 @item @var{file}.h
900 C, C++, Objective-C or Objective-C++ header file to be turned into a
901 precompiled header.
903 @item @var{file}.cc
904 @itemx @var{file}.cp
905 @itemx @var{file}.cxx
906 @itemx @var{file}.cpp
907 @itemx @var{file}.CPP
908 @itemx @var{file}.c++
909 @itemx @var{file}.C
910 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
911 the last two letters must both be literally @samp{x}.  Likewise,
912 @samp{.C} refers to a literal capital C@.
914 @item @var{file}.mm
915 @itemx @var{file}.M
916 Objective-C++ source code which must be preprocessed.
918 @item @var{file}.mii
919 Objective-C++ source code which should not be preprocessed.
921 @item @var{file}.hh
922 @itemx @var{file}.H
923 @itemx @var{file}.hp
924 @itemx @var{file}.hxx
925 @itemx @var{file}.hpp
926 @itemx @var{file}.HPP
927 @itemx @var{file}.h++
928 @itemx @var{file}.tcc
929 C++ header file to be turned into a precompiled header.
931 @item @var{file}.f
932 @itemx @var{file}.for
933 @itemx @var{file}.ftn
934 Fixed form Fortran source code which should not be preprocessed.
936 @item @var{file}.F
937 @itemx @var{file}.FOR
938 @itemx @var{file}.fpp
939 @itemx @var{file}.FPP
940 @itemx @var{file}.FTN
941 Fixed form Fortran source code which must be preprocessed (with the traditional
942 preprocessor).
944 @item @var{file}.f90
945 @itemx @var{file}.f95
946 @itemx @var{file}.f03
947 @itemx @var{file}.f08
948 Free form Fortran source code which should not be preprocessed.
950 @item @var{file}.F90
951 @itemx @var{file}.F95
952 @itemx @var{file}.F03
953 @itemx @var{file}.F08
954 Free form Fortran source code which must be preprocessed (with the
955 traditional preprocessor).
957 @c FIXME: Descriptions of Java file types.
958 @c @var{file}.java
959 @c @var{file}.class
960 @c @var{file}.zip
961 @c @var{file}.jar
963 @item @var{file}.ads
964 Ada source code file which contains a library unit declaration (a
965 declaration of a package, subprogram, or generic, or a generic
966 instantiation), or a library unit renaming declaration (a package,
967 generic, or subprogram renaming declaration).  Such files are also
968 called @dfn{specs}.
970 @item @var{file}.adb
971 Ada source code file containing a library unit body (a subprogram or
972 package body).  Such files are also called @dfn{bodies}.
974 @c GCC also knows about some suffixes for languages not yet included:
975 @c Pascal:
976 @c @var{file}.p
977 @c @var{file}.pas
978 @c Ratfor:
979 @c @var{file}.r
981 @item @var{file}.s
982 Assembler code.
984 @item @var{file}.S
985 @itemx @var{file}.sx
986 Assembler code which must be preprocessed.
988 @item @var{other}
989 An object file to be fed straight into linking.
990 Any file name with no recognized suffix is treated this way.
991 @end table
993 @opindex x
994 You can specify the input language explicitly with the @option{-x} option:
996 @table @gcctabopt
997 @item -x @var{language}
998 Specify explicitly the @var{language} for the following input files
999 (rather than letting the compiler choose a default based on the file
1000 name suffix).  This option applies to all following input files until
1001 the next @option{-x} option.  Possible values for @var{language} are:
1002 @smallexample
1003 c  c-header  c-cpp-output
1004 c++  c++-header  c++-cpp-output
1005 objective-c  objective-c-header  objective-c-cpp-output
1006 objective-c++ objective-c++-header objective-c++-cpp-output
1007 assembler  assembler-with-cpp
1009 f77  f77-cpp-input f95  f95-cpp-input
1010 java
1011 @end smallexample
1013 @item -x none
1014 Turn off any specification of a language, so that subsequent files are
1015 handled according to their file name suffixes (as they are if @option{-x}
1016 has not been used at all).
1018 @item -pass-exit-codes
1019 @opindex pass-exit-codes
1020 Normally the @command{gcc} program will exit with the code of 1 if any
1021 phase of the compiler returns a non-success return code.  If you specify
1022 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1023 numerically highest error produced by any phase that returned an error
1024 indication.  The C, C++, and Fortran frontends return 4, if an internal
1025 compiler error is encountered.
1026 @end table
1028 If you only want some of the stages of compilation, you can use
1029 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1030 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1031 @command{gcc} is to stop.  Note that some combinations (for example,
1032 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1034 @table @gcctabopt
1035 @item -c
1036 @opindex c
1037 Compile or assemble the source files, but do not link.  The linking
1038 stage simply is not done.  The ultimate output is in the form of an
1039 object file for each source file.
1041 By default, the object file name for a source file is made by replacing
1042 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1044 Unrecognized input files, not requiring compilation or assembly, are
1045 ignored.
1047 @item -S
1048 @opindex S
1049 Stop after the stage of compilation proper; do not assemble.  The output
1050 is in the form of an assembler code file for each non-assembler input
1051 file specified.
1053 By default, the assembler file name for a source file is made by
1054 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1056 Input files that don't require compilation are ignored.
1058 @item -E
1059 @opindex E
1060 Stop after the preprocessing stage; do not run the compiler proper.  The
1061 output is in the form of preprocessed source code, which is sent to the
1062 standard output.
1064 Input files which don't require preprocessing are ignored.
1066 @cindex output file option
1067 @item -o @var{file}
1068 @opindex o
1069 Place output in file @var{file}.  This applies regardless to whatever
1070 sort of output is being produced, whether it be an executable file,
1071 an object file, an assembler file or preprocessed C code.
1073 If @option{-o} is not specified, the default is to put an executable
1074 file in @file{a.out}, the object file for
1075 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1076 assembler file in @file{@var{source}.s}, a precompiled header file in
1077 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1078 standard output.
1080 @item -v
1081 @opindex v
1082 Print (on standard error output) the commands executed to run the stages
1083 of compilation.  Also print the version number of the compiler driver
1084 program and of the preprocessor and the compiler proper.
1086 @item -###
1087 @opindex ###
1088 Like @option{-v} except the commands are not executed and all command
1089 arguments are quoted.  This is useful for shell scripts to capture the
1090 driver-generated command lines.
1092 @item -pipe
1093 @opindex pipe
1094 Use pipes rather than temporary files for communication between the
1095 various stages of compilation.  This fails to work on some systems where
1096 the assembler is unable to read from a pipe; but the GNU assembler has
1097 no trouble.
1099 @item -combine
1100 @opindex combine
1101 If you are compiling multiple source files, this option tells the driver
1102 to pass all the source files to the compiler at once (for those
1103 languages for which the compiler can handle this).  This will allow
1104 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1105 language for which this is supported is C@.  If you pass source files for
1106 multiple languages to the driver, using this option, the driver will invoke
1107 the compiler(s) that support IMA once each, passing each compiler all the
1108 source files appropriate for it.  For those languages that do not support
1109 IMA this option will be ignored, and the compiler will be invoked once for
1110 each source file in that language.  If you use this option in conjunction
1111 with @option{-save-temps}, the compiler will generate multiple
1112 pre-processed files
1113 (one for each source file), but only one (combined) @file{.o} or
1114 @file{.s} file.
1116 @item --help
1117 @opindex help
1118 Print (on the standard output) a description of the command line options
1119 understood by @command{gcc}.  If the @option{-v} option is also specified
1120 then @option{--help} will also be passed on to the various processes
1121 invoked by @command{gcc}, so that they can display the command line options
1122 they accept.  If the @option{-Wextra} option has also been specified
1123 (prior to the @option{--help} option), then command line options which
1124 have no documentation associated with them will also be displayed.
1126 @item --target-help
1127 @opindex target-help
1128 Print (on the standard output) a description of target-specific command
1129 line options for each tool.  For some targets extra target-specific
1130 information may also be printed.
1132 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1133 Print (on the standard output) a description of the command line
1134 options understood by the compiler that fit into a specific class.
1135 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1136 @samp{params}, or @var{language}:
1138 @table @asis
1139 @item @samp{optimizers}
1140 This will display all of the optimization options supported by the
1141 compiler.
1143 @item @samp{warnings}
1144 This will display all of the options controlling warning messages
1145 produced by the compiler.
1147 @item @samp{target}
1148 This will display target-specific options.  Unlike the
1149 @option{--target-help} option however, target-specific options of the
1150 linker and assembler will not be displayed.  This is because those
1151 tools do not currently support the extended @option{--help=} syntax.
1153 @item @samp{params}
1154 This will display the values recognized by the @option{--param}
1155 option.
1157 @item @var{language}
1158 This will display the options supported for @var{language}, where 
1159 @var{language} is the name of one of the languages supported in this 
1160 version of GCC.
1162 @item @samp{common}
1163 This will display the options that are common to all languages.
1164 @end table
1166 It is possible to further refine the output of the @option{--help=}
1167 option by adding a comma separated list of qualifiers after the
1168 class.  These can be any from the following list:
1170 @table @asis
1171 @item @samp{undocumented}
1172 Display only those options which are undocumented.
1174 @item @samp{joined}
1175 Display options which take an argument that appears after an equal
1176 sign in the same continuous piece of text, such as:
1177 @samp{--help=target}.
1179 @item @samp{separate}
1180 Display options which take an argument that appears as a separate word
1181 following the original option, such as: @samp{-o output-file}.
1182 @end table
1184 Thus for example to display all the undocumented target-specific
1185 switches supported by the compiler the following can be used:
1187 @smallexample
1188 --help=target,undocumented
1189 @end smallexample
1191 The sense of a qualifier can be inverted by prefixing it with the
1192 @var{^} character, so for example to display all binary warning
1193 options (i.e., ones that are either on or off and that do not take an
1194 argument), which have a description the following can be used:
1196 @smallexample
1197 --help=warnings,^joined,^undocumented
1198 @end smallexample
1200 A class can also be used as a qualifier, although this usually
1201 restricts the output by so much that there is nothing to display.  One
1202 case where it does work however is when one of the classes is
1203 @var{target}.  So for example to display all the target-specific
1204 optimization options the following can be used:
1206 @smallexample
1207 --help=target,optimizers
1208 @end smallexample
1210 The @option{--help=} option can be repeated on the command line.  Each
1211 successive use will display its requested class of options, skipping
1212 those that have already been displayed.
1214 If the @option{-Q} option appears on the command line before the
1215 @option{--help=} option, then the descriptive text displayed by
1216 @option{--help=} is changed.  Instead of describing the displayed
1217 options, an indication is given as to whether the option is enabled,
1218 disabled or set to a specific value (assuming that the compiler
1219 knows this at the point where the @option{--help=} option is used).
1221 Here is a truncated example from the ARM port of @command{gcc}:
1223 @smallexample
1224   % gcc -Q -mabi=2 --help=target -c
1225   The following options are target specific:
1226   -mabi=                                2
1227   -mabort-on-noreturn                   [disabled]
1228   -mapcs                                [disabled]
1229 @end smallexample
1231 The output is sensitive to the effects of previous command line
1232 options, so for example it is possible to find out which optimizations
1233 are enabled at @option{-O2} by using:
1235 @smallexample
1236 -O2 --help=optimizers
1237 @end smallexample
1239 Alternatively you can discover which binary optimizations are enabled
1240 by @option{-O3} by using:
1242 @smallexample
1243 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1244 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1245 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1246 @end smallexample
1248 @item --version
1249 @opindex version
1250 Display the version number and copyrights of the invoked GCC@.
1252 @item -wrapper
1253 @opindex wrapper
1254 Invoke all subcommands under a wrapper program. It takes a single
1255 comma separated list as an argument, which will be used to invoke
1256 the wrapper:
1258 @smallexample
1259 gcc -c t.c -wrapper gdb,--args
1260 @end smallexample
1262 This will invoke all subprograms of gcc under "gdb --args",
1263 thus cc1 invocation will be "gdb --args cc1 ...".
1265 @include @value{srcdir}/../libiberty/at-file.texi
1266 @end table
1268 @node Invoking G++
1269 @section Compiling C++ Programs
1271 @cindex suffixes for C++ source
1272 @cindex C++ source file suffixes
1273 C++ source files conventionally use one of the suffixes @samp{.C},
1274 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1275 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1276 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1277 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1278 files with these names and compiles them as C++ programs even if you
1279 call the compiler the same way as for compiling C programs (usually
1280 with the name @command{gcc}).
1282 @findex g++
1283 @findex c++
1284 However, the use of @command{gcc} does not add the C++ library.
1285 @command{g++} is a program that calls GCC and treats @samp{.c},
1286 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1287 files unless @option{-x} is used, and automatically specifies linking
1288 against the C++ library.  This program is also useful when
1289 precompiling a C header file with a @samp{.h} extension for use in C++
1290 compilations.  On many systems, @command{g++} is also installed with
1291 the name @command{c++}.
1293 @cindex invoking @command{g++}
1294 When you compile C++ programs, you may specify many of the same
1295 command-line options that you use for compiling programs in any
1296 language; or command-line options meaningful for C and related
1297 languages; or options that are meaningful only for C++ programs.
1298 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1299 explanations of options for languages related to C@.
1300 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1301 explanations of options that are meaningful only for C++ programs.
1303 @node C Dialect Options
1304 @section Options Controlling C Dialect
1305 @cindex dialect options
1306 @cindex language dialect options
1307 @cindex options, dialect
1309 The following options control the dialect of C (or languages derived
1310 from C, such as C++, Objective-C and Objective-C++) that the compiler
1311 accepts:
1313 @table @gcctabopt
1314 @cindex ANSI support
1315 @cindex ISO support
1316 @item -ansi
1317 @opindex ansi
1318 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1319 equivalent to @samp{-std=c++98}.
1321 This turns off certain features of GCC that are incompatible with ISO
1322 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1323 such as the @code{asm} and @code{typeof} keywords, and
1324 predefined macros such as @code{unix} and @code{vax} that identify the
1325 type of system you are using.  It also enables the undesirable and
1326 rarely used ISO trigraph feature.  For the C compiler,
1327 it disables recognition of C++ style @samp{//} comments as well as
1328 the @code{inline} keyword.
1330 The alternate keywords @code{__asm__}, @code{__extension__},
1331 @code{__inline__} and @code{__typeof__} continue to work despite
1332 @option{-ansi}.  You would not want to use them in an ISO C program, of
1333 course, but it is useful to put them in header files that might be included
1334 in compilations done with @option{-ansi}.  Alternate predefined macros
1335 such as @code{__unix__} and @code{__vax__} are also available, with or
1336 without @option{-ansi}.
1338 The @option{-ansi} option does not cause non-ISO programs to be
1339 rejected gratuitously.  For that, @option{-pedantic} is required in
1340 addition to @option{-ansi}.  @xref{Warning Options}.
1342 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1343 option is used.  Some header files may notice this macro and refrain
1344 from declaring certain functions or defining certain macros that the
1345 ISO standard doesn't call for; this is to avoid interfering with any
1346 programs that might use these names for other things.
1348 Functions that would normally be built in but do not have semantics
1349 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1350 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1351 built-in functions provided by GCC}, for details of the functions
1352 affected.
1354 @item -std=
1355 @opindex std
1356 Determine the language standard. @xref{Standards,,Language Standards
1357 Supported by GCC}, for details of these standard versions.  This option
1358 is currently only supported when compiling C or C++. 
1360 The compiler can accept several base standards, such as @samp{c89} or
1361 @samp{c++98}, and GNU dialects of those standards, such as
1362 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1363 compiler will accept all programs following that standard and those
1364 using GNU extensions that do not contradict it.  For example,
1365 @samp{-std=c89} turns off certain features of GCC that are
1366 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1367 keywords, but not other GNU extensions that do not have a meaning in
1368 ISO C90, such as omitting the middle term of a @code{?:}
1369 expression. On the other hand, by specifing a GNU dialect of a
1370 standard, all features the compiler support are enabled, even when
1371 those features change the meaning of the base standard and some
1372 strict-conforming programs may be rejected.  The particular standard
1373 is used by @option{-pedantic} to identify which features are GNU
1374 extensions given that version of the standard. For example
1375 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1376 comments, while @samp{-std=gnu99 -pedantic} would not.
1378 A value for this option must be provided; possible values are
1380 @table @samp
1381 @item c89
1382 @itemx iso9899:1990
1383 Support all ISO C90 programs (certain GNU extensions that conflict
1384 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1386 @item iso9899:199409
1387 ISO C90 as modified in amendment 1.
1389 @item c99
1390 @itemx c9x
1391 @itemx iso9899:1999
1392 @itemx iso9899:199x
1393 ISO C99.  Note that this standard is not yet fully supported; see
1394 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1395 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1397 @item gnu89
1398 GNU dialect of ISO C90 (including some C99 features). This
1399 is the default for C code.
1401 @item gnu99
1402 @itemx gnu9x
1403 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1404 this will become the default.  The name @samp{gnu9x} is deprecated.
1406 @item c++98
1407 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1408 C++ code.
1410 @item gnu++98
1411 GNU dialect of @option{-std=c++98}.  This is the default for
1412 C++ code.
1414 @item c++0x
1415 The working draft of the upcoming ISO C++0x standard. This option
1416 enables experimental features that are likely to be included in
1417 C++0x. The working draft is constantly changing, and any feature that is
1418 enabled by this flag may be removed from future versions of GCC if it is
1419 not part of the C++0x standard.
1421 @item gnu++0x
1422 GNU dialect of @option{-std=c++0x}. This option enables
1423 experimental features that may be removed in future versions of GCC.
1424 @end table
1426 @item -fgnu89-inline
1427 @opindex fgnu89-inline
1428 The option @option{-fgnu89-inline} tells GCC to use the traditional
1429 GNU semantics for @code{inline} functions when in C99 mode.
1430 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1431 is accepted and ignored by GCC versions 4.1.3 up to but not including
1432 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1433 C99 mode.  Using this option is roughly equivalent to adding the
1434 @code{gnu_inline} function attribute to all inline functions
1435 (@pxref{Function Attributes}).
1437 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1438 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1439 specifies the default behavior).  This option was first supported in
1440 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1442 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1443 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1444 in effect for @code{inline} functions.  @xref{Common Predefined
1445 Macros,,,cpp,The C Preprocessor}.
1447 @item -aux-info @var{filename}
1448 @opindex aux-info
1449 Output to the given filename prototyped declarations for all functions
1450 declared and/or defined in a translation unit, including those in header
1451 files.  This option is silently ignored in any language other than C@.
1453 Besides declarations, the file indicates, in comments, the origin of
1454 each declaration (source file and line), whether the declaration was
1455 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1456 @samp{O} for old, respectively, in the first character after the line
1457 number and the colon), and whether it came from a declaration or a
1458 definition (@samp{C} or @samp{F}, respectively, in the following
1459 character).  In the case of function definitions, a K&R-style list of
1460 arguments followed by their declarations is also provided, inside
1461 comments, after the declaration.
1463 @item -fno-asm
1464 @opindex fno-asm
1465 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1466 keyword, so that code can use these words as identifiers.  You can use
1467 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1468 instead.  @option{-ansi} implies @option{-fno-asm}.
1470 In C++, this switch only affects the @code{typeof} keyword, since
1471 @code{asm} and @code{inline} are standard keywords.  You may want to
1472 use the @option{-fno-gnu-keywords} flag instead, which has the same
1473 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1474 switch only affects the @code{asm} and @code{typeof} keywords, since
1475 @code{inline} is a standard keyword in ISO C99.
1477 @item -fno-builtin
1478 @itemx -fno-builtin-@var{function}
1479 @opindex fno-builtin
1480 @cindex built-in functions
1481 Don't recognize built-in functions that do not begin with
1482 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1483 functions provided by GCC}, for details of the functions affected,
1484 including those which are not built-in functions when @option{-ansi} or
1485 @option{-std} options for strict ISO C conformance are used because they
1486 do not have an ISO standard meaning.
1488 GCC normally generates special code to handle certain built-in functions
1489 more efficiently; for instance, calls to @code{alloca} may become single
1490 instructions that adjust the stack directly, and calls to @code{memcpy}
1491 may become inline copy loops.  The resulting code is often both smaller
1492 and faster, but since the function calls no longer appear as such, you
1493 cannot set a breakpoint on those calls, nor can you change the behavior
1494 of the functions by linking with a different library.  In addition,
1495 when a function is recognized as a built-in function, GCC may use
1496 information about that function to warn about problems with calls to
1497 that function, or to generate more efficient code, even if the
1498 resulting code still contains calls to that function.  For example,
1499 warnings are given with @option{-Wformat} for bad calls to
1500 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1501 known not to modify global memory.
1503 With the @option{-fno-builtin-@var{function}} option
1504 only the built-in function @var{function} is
1505 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1506 function is named this is not built-in in this version of GCC, this
1507 option is ignored.  There is no corresponding
1508 @option{-fbuiltin-@var{function}} option; if you wish to enable
1509 built-in functions selectively when using @option{-fno-builtin} or
1510 @option{-ffreestanding}, you may define macros such as:
1512 @smallexample
1513 #define abs(n)          __builtin_abs ((n))
1514 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1515 @end smallexample
1517 @item -fhosted
1518 @opindex fhosted
1519 @cindex hosted environment
1521 Assert that compilation takes place in a hosted environment.  This implies
1522 @option{-fbuiltin}.  A hosted environment is one in which the
1523 entire standard library is available, and in which @code{main} has a return
1524 type of @code{int}.  Examples are nearly everything except a kernel.
1525 This is equivalent to @option{-fno-freestanding}.
1527 @item -ffreestanding
1528 @opindex ffreestanding
1529 @cindex hosted environment
1531 Assert that compilation takes place in a freestanding environment.  This
1532 implies @option{-fno-builtin}.  A freestanding environment
1533 is one in which the standard library may not exist, and program startup may
1534 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1535 This is equivalent to @option{-fno-hosted}.
1537 @xref{Standards,,Language Standards Supported by GCC}, for details of
1538 freestanding and hosted environments.
1540 @item -fopenmp
1541 @opindex fopenmp
1542 @cindex openmp parallel
1543 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1544 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1545 compiler generates parallel code according to the OpenMP Application
1546 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1547 implies @option{-pthread}, and thus is only supported on targets that
1548 have support for @option{-pthread}.
1550 @item -fms-extensions
1551 @opindex fms-extensions
1552 Accept some non-standard constructs used in Microsoft header files.
1554 Some cases of unnamed fields in structures and unions are only
1555 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1556 fields within structs/unions}, for details.
1558 @item -trigraphs
1559 @opindex trigraphs
1560 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1561 options for strict ISO C conformance) implies @option{-trigraphs}.
1563 @item -no-integrated-cpp
1564 @opindex no-integrated-cpp
1565 Performs a compilation in two passes: preprocessing and compiling.  This
1566 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1567 @option{-B} option.  The user supplied compilation step can then add in
1568 an additional preprocessing step after normal preprocessing but before
1569 compiling.  The default is to use the integrated cpp (internal cpp)
1571 The semantics of this option will change if "cc1", "cc1plus", and
1572 "cc1obj" are merged.
1574 @cindex traditional C language
1575 @cindex C language, traditional
1576 @item -traditional
1577 @itemx -traditional-cpp
1578 @opindex traditional-cpp
1579 @opindex traditional
1580 Formerly, these options caused GCC to attempt to emulate a pre-standard
1581 C compiler.  They are now only supported with the @option{-E} switch.
1582 The preprocessor continues to support a pre-standard mode.  See the GNU
1583 CPP manual for details.
1585 @item -fcond-mismatch
1586 @opindex fcond-mismatch
1587 Allow conditional expressions with mismatched types in the second and
1588 third arguments.  The value of such an expression is void.  This option
1589 is not supported for C++.
1591 @item -flax-vector-conversions
1592 @opindex flax-vector-conversions
1593 Allow implicit conversions between vectors with differing numbers of
1594 elements and/or incompatible element types.  This option should not be
1595 used for new code.
1597 @item -funsigned-char
1598 @opindex funsigned-char
1599 Let the type @code{char} be unsigned, like @code{unsigned char}.
1601 Each kind of machine has a default for what @code{char} should
1602 be.  It is either like @code{unsigned char} by default or like
1603 @code{signed char} by default.
1605 Ideally, a portable program should always use @code{signed char} or
1606 @code{unsigned char} when it depends on the signedness of an object.
1607 But many programs have been written to use plain @code{char} and
1608 expect it to be signed, or expect it to be unsigned, depending on the
1609 machines they were written for.  This option, and its inverse, let you
1610 make such a program work with the opposite default.
1612 The type @code{char} is always a distinct type from each of
1613 @code{signed char} or @code{unsigned char}, even though its behavior
1614 is always just like one of those two.
1616 @item -fsigned-char
1617 @opindex fsigned-char
1618 Let the type @code{char} be signed, like @code{signed char}.
1620 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1621 the negative form of @option{-funsigned-char}.  Likewise, the option
1622 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1624 @item -fsigned-bitfields
1625 @itemx -funsigned-bitfields
1626 @itemx -fno-signed-bitfields
1627 @itemx -fno-unsigned-bitfields
1628 @opindex fsigned-bitfields
1629 @opindex funsigned-bitfields
1630 @opindex fno-signed-bitfields
1631 @opindex fno-unsigned-bitfields
1632 These options control whether a bit-field is signed or unsigned, when the
1633 declaration does not use either @code{signed} or @code{unsigned}.  By
1634 default, such a bit-field is signed, because this is consistent: the
1635 basic integer types such as @code{int} are signed types.
1636 @end table
1638 @node C++ Dialect Options
1639 @section Options Controlling C++ Dialect
1641 @cindex compiler options, C++
1642 @cindex C++ options, command line
1643 @cindex options, C++
1644 This section describes the command-line options that are only meaningful
1645 for C++ programs; but you can also use most of the GNU compiler options
1646 regardless of what language your program is in.  For example, you
1647 might compile a file @code{firstClass.C} like this:
1649 @smallexample
1650 g++ -g -frepo -O -c firstClass.C
1651 @end smallexample
1653 @noindent
1654 In this example, only @option{-frepo} is an option meant
1655 only for C++ programs; you can use the other options with any
1656 language supported by GCC@.
1658 Here is a list of options that are @emph{only} for compiling C++ programs:
1660 @table @gcctabopt
1662 @item -fabi-version=@var{n}
1663 @opindex fabi-version
1664 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1665 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1666 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1667 the version that conforms most closely to the C++ ABI specification.
1668 Therefore, the ABI obtained using version 0 will change as ABI bugs
1669 are fixed.
1671 The default is version 2.
1673 @item -fno-access-control
1674 @opindex fno-access-control
1675 Turn off all access checking.  This switch is mainly useful for working
1676 around bugs in the access control code.
1678 @item -fcheck-new
1679 @opindex fcheck-new
1680 Check that the pointer returned by @code{operator new} is non-null
1681 before attempting to modify the storage allocated.  This check is
1682 normally unnecessary because the C++ standard specifies that
1683 @code{operator new} will only return @code{0} if it is declared
1684 @samp{throw()}, in which case the compiler will always check the
1685 return value even without this option.  In all other cases, when
1686 @code{operator new} has a non-empty exception specification, memory
1687 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1688 @samp{new (nothrow)}.
1690 @item -fconserve-space
1691 @opindex fconserve-space
1692 Put uninitialized or runtime-initialized global variables into the
1693 common segment, as C does.  This saves space in the executable at the
1694 cost of not diagnosing duplicate definitions.  If you compile with this
1695 flag and your program mysteriously crashes after @code{main()} has
1696 completed, you may have an object that is being destroyed twice because
1697 two definitions were merged.
1699 This option is no longer useful on most targets, now that support has
1700 been added for putting variables into BSS without making them common.
1702 @item -ffriend-injection
1703 @opindex ffriend-injection
1704 Inject friend functions into the enclosing namespace, so that they are
1705 visible outside the scope of the class in which they are declared.
1706 Friend functions were documented to work this way in the old Annotated
1707 C++ Reference Manual, and versions of G++ before 4.1 always worked
1708 that way.  However, in ISO C++ a friend function which is not declared
1709 in an enclosing scope can only be found using argument dependent
1710 lookup.  This option causes friends to be injected as they were in
1711 earlier releases.
1713 This option is for compatibility, and may be removed in a future
1714 release of G++.
1716 @item -fno-elide-constructors
1717 @opindex fno-elide-constructors
1718 The C++ standard allows an implementation to omit creating a temporary
1719 which is only used to initialize another object of the same type.
1720 Specifying this option disables that optimization, and forces G++ to
1721 call the copy constructor in all cases.
1723 @item -fno-enforce-eh-specs
1724 @opindex fno-enforce-eh-specs
1725 Don't generate code to check for violation of exception specifications
1726 at runtime.  This option violates the C++ standard, but may be useful
1727 for reducing code size in production builds, much like defining
1728 @samp{NDEBUG}.  This does not give user code permission to throw
1729 exceptions in violation of the exception specifications; the compiler
1730 will still optimize based on the specifications, so throwing an
1731 unexpected exception will result in undefined behavior.
1733 @item -ffor-scope
1734 @itemx -fno-for-scope
1735 @opindex ffor-scope
1736 @opindex fno-for-scope
1737 If @option{-ffor-scope} is specified, the scope of variables declared in
1738 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1739 as specified by the C++ standard.
1740 If @option{-fno-for-scope} is specified, the scope of variables declared in
1741 a @i{for-init-statement} extends to the end of the enclosing scope,
1742 as was the case in old versions of G++, and other (traditional)
1743 implementations of C++.
1745 The default if neither flag is given to follow the standard,
1746 but to allow and give a warning for old-style code that would
1747 otherwise be invalid, or have different behavior.
1749 @item -fno-gnu-keywords
1750 @opindex fno-gnu-keywords
1751 Do not recognize @code{typeof} as a keyword, so that code can use this
1752 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1753 @option{-ansi} implies @option{-fno-gnu-keywords}.
1755 @item -fno-implicit-templates
1756 @opindex fno-implicit-templates
1757 Never emit code for non-inline templates which are instantiated
1758 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1759 @xref{Template Instantiation}, for more information.
1761 @item -fno-implicit-inline-templates
1762 @opindex fno-implicit-inline-templates
1763 Don't emit code for implicit instantiations of inline templates, either.
1764 The default is to handle inlines differently so that compiles with and
1765 without optimization will need the same set of explicit instantiations.
1767 @item -fno-implement-inlines
1768 @opindex fno-implement-inlines
1769 To save space, do not emit out-of-line copies of inline functions
1770 controlled by @samp{#pragma implementation}.  This will cause linker
1771 errors if these functions are not inlined everywhere they are called.
1773 @item -fms-extensions
1774 @opindex fms-extensions
1775 Disable pedantic warnings about constructs used in MFC, such as implicit
1776 int and getting a pointer to member function via non-standard syntax.
1778 @item -fno-nonansi-builtins
1779 @opindex fno-nonansi-builtins
1780 Disable built-in declarations of functions that are not mandated by
1781 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1782 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1784 @item -fno-operator-names
1785 @opindex fno-operator-names
1786 Do not treat the operator name keywords @code{and}, @code{bitand},
1787 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1788 synonyms as keywords.
1790 @item -fno-optional-diags
1791 @opindex fno-optional-diags
1792 Disable diagnostics that the standard says a compiler does not need to
1793 issue.  Currently, the only such diagnostic issued by G++ is the one for
1794 a name having multiple meanings within a class.
1796 @item -fpermissive
1797 @opindex fpermissive
1798 Downgrade some diagnostics about nonconformant code from errors to
1799 warnings.  Thus, using @option{-fpermissive} will allow some
1800 nonconforming code to compile.
1802 @item -frepo
1803 @opindex frepo
1804 Enable automatic template instantiation at link time.  This option also
1805 implies @option{-fno-implicit-templates}.  @xref{Template
1806 Instantiation}, for more information.
1808 @item -fno-rtti
1809 @opindex fno-rtti
1810 Disable generation of information about every class with virtual
1811 functions for use by the C++ runtime type identification features
1812 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1813 of the language, you can save some space by using this flag.  Note that
1814 exception handling uses the same information, but it will generate it as
1815 needed. The @samp{dynamic_cast} operator can still be used for casts that
1816 do not require runtime type information, i.e.@: casts to @code{void *} or to
1817 unambiguous base classes.
1819 @item -fstats
1820 @opindex fstats
1821 Emit statistics about front-end processing at the end of the compilation.
1822 This information is generally only useful to the G++ development team.
1824 @item -ftemplate-depth-@var{n}
1825 @opindex ftemplate-depth
1826 Set the maximum instantiation depth for template classes to @var{n}.
1827 A limit on the template instantiation depth is needed to detect
1828 endless recursions during template class instantiation.  ANSI/ISO C++
1829 conforming programs must not rely on a maximum depth greater than 17.
1831 @item -fno-threadsafe-statics
1832 @opindex fno-threadsafe-statics
1833 Do not emit the extra code to use the routines specified in the C++
1834 ABI for thread-safe initialization of local statics.  You can use this
1835 option to reduce code size slightly in code that doesn't need to be
1836 thread-safe.
1838 @item -fuse-cxa-atexit
1839 @opindex fuse-cxa-atexit
1840 Register destructors for objects with static storage duration with the
1841 @code{__cxa_atexit} function rather than the @code{atexit} function.
1842 This option is required for fully standards-compliant handling of static
1843 destructors, but will only work if your C library supports
1844 @code{__cxa_atexit}.
1846 @item -fno-use-cxa-get-exception-ptr
1847 @opindex fno-use-cxa-get-exception-ptr
1848 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1849 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1850 if the runtime routine is not available.
1852 @item -fvisibility-inlines-hidden
1853 @opindex fvisibility-inlines-hidden
1854 This switch declares that the user does not attempt to compare
1855 pointers to inline methods where the addresses of the two functions
1856 were taken in different shared objects.
1858 The effect of this is that GCC may, effectively, mark inline methods with
1859 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1860 appear in the export table of a DSO and do not require a PLT indirection
1861 when used within the DSO@.  Enabling this option can have a dramatic effect
1862 on load and link times of a DSO as it massively reduces the size of the
1863 dynamic export table when the library makes heavy use of templates.
1865 The behavior of this switch is not quite the same as marking the
1866 methods as hidden directly, because it does not affect static variables
1867 local to the function or cause the compiler to deduce that
1868 the function is defined in only one shared object.
1870 You may mark a method as having a visibility explicitly to negate the
1871 effect of the switch for that method.  For example, if you do want to
1872 compare pointers to a particular inline method, you might mark it as
1873 having default visibility.  Marking the enclosing class with explicit
1874 visibility will have no effect.
1876 Explicitly instantiated inline methods are unaffected by this option
1877 as their linkage might otherwise cross a shared library boundary.
1878 @xref{Template Instantiation}.
1880 @item -fvisibility-ms-compat
1881 @opindex fvisibility-ms-compat
1882 This flag attempts to use visibility settings to make GCC's C++
1883 linkage model compatible with that of Microsoft Visual Studio.
1885 The flag makes these changes to GCC's linkage model:
1887 @enumerate
1888 @item
1889 It sets the default visibility to @code{hidden}, like
1890 @option{-fvisibility=hidden}.
1892 @item
1893 Types, but not their members, are not hidden by default.
1895 @item
1896 The One Definition Rule is relaxed for types without explicit
1897 visibility specifications which are defined in more than one different
1898 shared object: those declarations are permitted if they would have
1899 been permitted when this option was not used.
1900 @end enumerate
1902 In new code it is better to use @option{-fvisibility=hidden} and
1903 export those classes which are intended to be externally visible.
1904 Unfortunately it is possible for code to rely, perhaps accidentally,
1905 on the Visual Studio behavior.
1907 Among the consequences of these changes are that static data members
1908 of the same type with the same name but defined in different shared
1909 objects will be different, so changing one will not change the other;
1910 and that pointers to function members defined in different shared
1911 objects may not compare equal.  When this flag is given, it is a
1912 violation of the ODR to define types with the same name differently.
1914 @item -fno-weak
1915 @opindex fno-weak
1916 Do not use weak symbol support, even if it is provided by the linker.
1917 By default, G++ will use weak symbols if they are available.  This
1918 option exists only for testing, and should not be used by end-users;
1919 it will result in inferior code and has no benefits.  This option may
1920 be removed in a future release of G++.
1922 @item -nostdinc++
1923 @opindex nostdinc++
1924 Do not search for header files in the standard directories specific to
1925 C++, but do still search the other standard directories.  (This option
1926 is used when building the C++ library.)
1927 @end table
1929 In addition, these optimization, warning, and code generation options
1930 have meanings only for C++ programs:
1932 @table @gcctabopt
1933 @item -fno-default-inline
1934 @opindex fno-default-inline
1935 Do not assume @samp{inline} for functions defined inside a class scope.
1936 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1937 functions will have linkage like inline functions; they just won't be
1938 inlined by default.
1940 @item -Wabi @r{(C++ and Objective-C++ only)}
1941 @opindex Wabi
1942 @opindex Wno-abi
1943 Warn when G++ generates code that is probably not compatible with the
1944 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1945 all such cases, there are probably some cases that are not warned about,
1946 even though G++ is generating incompatible code.  There may also be
1947 cases where warnings are emitted even though the code that is generated
1948 will be compatible.
1950 You should rewrite your code to avoid these warnings if you are
1951 concerned about the fact that code generated by G++ may not be binary
1952 compatible with code generated by other compilers.
1954 The known incompatibilities at this point include:
1956 @itemize @bullet
1958 @item
1959 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1960 pack data into the same byte as a base class.  For example:
1962 @smallexample
1963 struct A @{ virtual void f(); int f1 : 1; @};
1964 struct B : public A @{ int f2 : 1; @};
1965 @end smallexample
1967 @noindent
1968 In this case, G++ will place @code{B::f2} into the same byte
1969 as@code{A::f1}; other compilers will not.  You can avoid this problem
1970 by explicitly padding @code{A} so that its size is a multiple of the
1971 byte size on your platform; that will cause G++ and other compilers to
1972 layout @code{B} identically.
1974 @item
1975 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1976 tail padding when laying out virtual bases.  For example:
1978 @smallexample
1979 struct A @{ virtual void f(); char c1; @};
1980 struct B @{ B(); char c2; @};
1981 struct C : public A, public virtual B @{@};
1982 @end smallexample
1984 @noindent
1985 In this case, G++ will not place @code{B} into the tail-padding for
1986 @code{A}; other compilers will.  You can avoid this problem by
1987 explicitly padding @code{A} so that its size is a multiple of its
1988 alignment (ignoring virtual base classes); that will cause G++ and other
1989 compilers to layout @code{C} identically.
1991 @item
1992 Incorrect handling of bit-fields with declared widths greater than that
1993 of their underlying types, when the bit-fields appear in a union.  For
1994 example:
1996 @smallexample
1997 union U @{ int i : 4096; @};
1998 @end smallexample
2000 @noindent
2001 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2002 union too small by the number of bits in an @code{int}.
2004 @item
2005 Empty classes can be placed at incorrect offsets.  For example:
2007 @smallexample
2008 struct A @{@};
2010 struct B @{
2011   A a;
2012   virtual void f ();
2015 struct C : public B, public A @{@};
2016 @end smallexample
2018 @noindent
2019 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2020 it should be placed at offset zero.  G++ mistakenly believes that the
2021 @code{A} data member of @code{B} is already at offset zero.
2023 @item
2024 Names of template functions whose types involve @code{typename} or
2025 template template parameters can be mangled incorrectly.
2027 @smallexample
2028 template <typename Q>
2029 void f(typename Q::X) @{@}
2031 template <template <typename> class Q>
2032 void f(typename Q<int>::X) @{@}
2033 @end smallexample
2035 @noindent
2036 Instantiations of these templates may be mangled incorrectly.
2038 @end itemize
2040 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2041 @opindex Wctor-dtor-privacy
2042 @opindex Wno-ctor-dtor-privacy
2043 Warn when a class seems unusable because all the constructors or
2044 destructors in that class are private, and it has neither friends nor
2045 public static member functions.
2047 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2048 @opindex Wnon-virtual-dtor
2049 @opindex Wno-non-virtual-dtor
2050 Warn when a class has virtual functions and accessible non-virtual
2051 destructor, in which case it would be possible but unsafe to delete
2052 an instance of a derived class through a pointer to the base class.
2053 This warning is also enabled if -Weffc++ is specified.
2055 @item -Wreorder @r{(C++ and Objective-C++ only)}
2056 @opindex Wreorder
2057 @opindex Wno-reorder
2058 @cindex reordering, warning
2059 @cindex warning for reordering of member initializers
2060 Warn when the order of member initializers given in the code does not
2061 match the order in which they must be executed.  For instance:
2063 @smallexample
2064 struct A @{
2065   int i;
2066   int j;
2067   A(): j (0), i (1) @{ @}
2069 @end smallexample
2071 The compiler will rearrange the member initializers for @samp{i}
2072 and @samp{j} to match the declaration order of the members, emitting
2073 a warning to that effect.  This warning is enabled by @option{-Wall}.
2074 @end table
2076 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2078 @table @gcctabopt
2079 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2080 @opindex Weffc++
2081 @opindex Wno-effc++
2082 Warn about violations of the following style guidelines from Scott Meyers'
2083 @cite{Effective C++} book:
2085 @itemize @bullet
2086 @item
2087 Item 11:  Define a copy constructor and an assignment operator for classes
2088 with dynamically allocated memory.
2090 @item
2091 Item 12:  Prefer initialization to assignment in constructors.
2093 @item
2094 Item 14:  Make destructors virtual in base classes.
2096 @item
2097 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2099 @item
2100 Item 23:  Don't try to return a reference when you must return an object.
2102 @end itemize
2104 Also warn about violations of the following style guidelines from
2105 Scott Meyers' @cite{More Effective C++} book:
2107 @itemize @bullet
2108 @item
2109 Item 6:  Distinguish between prefix and postfix forms of increment and
2110 decrement operators.
2112 @item
2113 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2115 @end itemize
2117 When selecting this option, be aware that the standard library
2118 headers do not obey all of these guidelines; use @samp{grep -v}
2119 to filter out those warnings.
2121 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2122 @opindex Wstrict-null-sentinel
2123 @opindex Wno-strict-null-sentinel
2124 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2125 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2126 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2127 it is guaranteed to of the same size as a pointer.  But this use is
2128 not portable across different compilers.
2130 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2131 @opindex Wno-non-template-friend
2132 @opindex Wnon-template-friend
2133 Disable warnings when non-templatized friend functions are declared
2134 within a template.  Since the advent of explicit template specification
2135 support in G++, if the name of the friend is an unqualified-id (i.e.,
2136 @samp{friend foo(int)}), the C++ language specification demands that the
2137 friend declare or define an ordinary, nontemplate function.  (Section
2138 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2139 could be interpreted as a particular specialization of a templatized
2140 function.  Because this non-conforming behavior is no longer the default
2141 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2142 check existing code for potential trouble spots and is on by default.
2143 This new compiler behavior can be turned off with
2144 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2145 but disables the helpful warning.
2147 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2148 @opindex Wold-style-cast
2149 @opindex Wno-old-style-cast
2150 Warn if an old-style (C-style) cast to a non-void type is used within
2151 a C++ program.  The new-style casts (@samp{dynamic_cast},
2152 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2153 less vulnerable to unintended effects and much easier to search for.
2155 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2156 @opindex Woverloaded-virtual
2157 @opindex Wno-overloaded-virtual
2158 @cindex overloaded virtual fn, warning
2159 @cindex warning for overloaded virtual fn
2160 Warn when a function declaration hides virtual functions from a
2161 base class.  For example, in:
2163 @smallexample
2164 struct A @{
2165   virtual void f();
2168 struct B: public A @{
2169   void f(int);
2171 @end smallexample
2173 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2174 like:
2176 @smallexample
2177 B* b;
2178 b->f();
2179 @end smallexample
2181 will fail to compile.
2183 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2184 @opindex Wno-pmf-conversions
2185 @opindex Wpmf-conversions
2186 Disable the diagnostic for converting a bound pointer to member function
2187 to a plain pointer.
2189 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2190 @opindex Wsign-promo
2191 @opindex Wno-sign-promo
2192 Warn when overload resolution chooses a promotion from unsigned or
2193 enumerated type to a signed type, over a conversion to an unsigned type of
2194 the same size.  Previous versions of G++ would try to preserve
2195 unsignedness, but the standard mandates the current behavior.
2197 @smallexample
2198 struct A @{
2199   operator int ();
2200   A& operator = (int);
2203 main ()
2205   A a,b;
2206   a = b;
2208 @end smallexample
2210 In this example, G++ will synthesize a default @samp{A& operator =
2211 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2212 @end table
2214 @node Objective-C and Objective-C++ Dialect Options
2215 @section Options Controlling Objective-C and Objective-C++ Dialects
2217 @cindex compiler options, Objective-C and Objective-C++
2218 @cindex Objective-C and Objective-C++ options, command line
2219 @cindex options, Objective-C and Objective-C++
2220 (NOTE: This manual does not describe the Objective-C and Objective-C++
2221 languages themselves.  See @xref{Standards,,Language Standards
2222 Supported by GCC}, for references.)
2224 This section describes the command-line options that are only meaningful
2225 for Objective-C and Objective-C++ programs, but you can also use most of
2226 the language-independent GNU compiler options.
2227 For example, you might compile a file @code{some_class.m} like this:
2229 @smallexample
2230 gcc -g -fgnu-runtime -O -c some_class.m
2231 @end smallexample
2233 @noindent
2234 In this example, @option{-fgnu-runtime} is an option meant only for
2235 Objective-C and Objective-C++ programs; you can use the other options with
2236 any language supported by GCC@.
2238 Note that since Objective-C is an extension of the C language, Objective-C
2239 compilations may also use options specific to the C front-end (e.g.,
2240 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2241 C++-specific options (e.g., @option{-Wabi}).
2243 Here is a list of options that are @emph{only} for compiling Objective-C
2244 and Objective-C++ programs:
2246 @table @gcctabopt
2247 @item -fconstant-string-class=@var{class-name}
2248 @opindex fconstant-string-class
2249 Use @var{class-name} as the name of the class to instantiate for each
2250 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2251 class name is @code{NXConstantString} if the GNU runtime is being used, and
2252 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2253 @option{-fconstant-cfstrings} option, if also present, will override the
2254 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2255 to be laid out as constant CoreFoundation strings.
2257 @item -fgnu-runtime
2258 @opindex fgnu-runtime
2259 Generate object code compatible with the standard GNU Objective-C
2260 runtime.  This is the default for most types of systems.
2262 @item -fnext-runtime
2263 @opindex fnext-runtime
2264 Generate output compatible with the NeXT runtime.  This is the default
2265 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2266 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2267 used.
2269 @item -fno-nil-receivers
2270 @opindex fno-nil-receivers
2271 Assume that all Objective-C message dispatches (e.g.,
2272 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2273 is not @code{nil}.  This allows for more efficient entry points in the runtime
2274 to be used.  Currently, this option is only available in conjunction with
2275 the NeXT runtime on Mac OS X 10.3 and later.
2277 @item -fobjc-call-cxx-cdtors
2278 @opindex fobjc-call-cxx-cdtors
2279 For each Objective-C class, check if any of its instance variables is a
2280 C++ object with a non-trivial default constructor.  If so, synthesize a
2281 special @code{- (id) .cxx_construct} instance method that will run
2282 non-trivial default constructors on any such instance variables, in order,
2283 and then return @code{self}.  Similarly, check if any instance variable
2284 is a C++ object with a non-trivial destructor, and if so, synthesize a
2285 special @code{- (void) .cxx_destruct} method that will run
2286 all such default destructors, in reverse order.
2288 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2289 thusly generated will only operate on instance variables declared in the
2290 current Objective-C class, and not those inherited from superclasses.  It
2291 is the responsibility of the Objective-C runtime to invoke all such methods
2292 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2293 will be invoked by the runtime immediately after a new object
2294 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2295 be invoked immediately before the runtime deallocates an object instance.
2297 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2298 support for invoking the @code{- (id) .cxx_construct} and
2299 @code{- (void) .cxx_destruct} methods.
2301 @item -fobjc-direct-dispatch
2302 @opindex fobjc-direct-dispatch
2303 Allow fast jumps to the message dispatcher.  On Darwin this is
2304 accomplished via the comm page.
2306 @item -fobjc-exceptions
2307 @opindex fobjc-exceptions
2308 Enable syntactic support for structured exception handling in Objective-C,
2309 similar to what is offered by C++ and Java.  This option is
2310 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2311 earlier.
2313 @smallexample
2314   @@try @{
2315     @dots{}
2316        @@throw expr;
2317     @dots{}
2318   @}
2319   @@catch (AnObjCClass *exc) @{
2320     @dots{}
2321       @@throw expr;
2322     @dots{}
2323       @@throw;
2324     @dots{}
2325   @}
2326   @@catch (AnotherClass *exc) @{
2327     @dots{}
2328   @}
2329   @@catch (id allOthers) @{
2330     @dots{}
2331   @}
2332   @@finally @{
2333     @dots{}
2334       @@throw expr;
2335     @dots{}
2336   @}
2337 @end smallexample
2339 The @code{@@throw} statement may appear anywhere in an Objective-C or
2340 Objective-C++ program; when used inside of a @code{@@catch} block, the
2341 @code{@@throw} may appear without an argument (as shown above), in which case
2342 the object caught by the @code{@@catch} will be rethrown.
2344 Note that only (pointers to) Objective-C objects may be thrown and
2345 caught using this scheme.  When an object is thrown, it will be caught
2346 by the nearest @code{@@catch} clause capable of handling objects of that type,
2347 analogously to how @code{catch} blocks work in C++ and Java.  A
2348 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2349 any and all Objective-C exceptions not caught by previous @code{@@catch}
2350 clauses (if any).
2352 The @code{@@finally} clause, if present, will be executed upon exit from the
2353 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2354 regardless of whether any exceptions are thrown, caught or rethrown
2355 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2356 of the @code{finally} clause in Java.
2358 There are several caveats to using the new exception mechanism:
2360 @itemize @bullet
2361 @item
2362 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2363 idioms provided by the @code{NSException} class, the new
2364 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2365 systems, due to additional functionality needed in the (NeXT) Objective-C
2366 runtime.
2368 @item
2369 As mentioned above, the new exceptions do not support handling
2370 types other than Objective-C objects.   Furthermore, when used from
2371 Objective-C++, the Objective-C exception model does not interoperate with C++
2372 exceptions at this time.  This means you cannot @code{@@throw} an exception
2373 from Objective-C and @code{catch} it in C++, or vice versa
2374 (i.e., @code{throw @dots{} @@catch}).
2375 @end itemize
2377 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2378 blocks for thread-safe execution:
2380 @smallexample
2381   @@synchronized (ObjCClass *guard) @{
2382     @dots{}
2383   @}
2384 @end smallexample
2386 Upon entering the @code{@@synchronized} block, a thread of execution shall
2387 first check whether a lock has been placed on the corresponding @code{guard}
2388 object by another thread.  If it has, the current thread shall wait until
2389 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2390 the current thread will place its own lock on it, execute the code contained in
2391 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2392 making @code{guard} available to other threads).
2394 Unlike Java, Objective-C does not allow for entire methods to be marked
2395 @code{@@synchronized}.  Note that throwing exceptions out of
2396 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2397 to be unlocked properly.
2399 @item -fobjc-gc
2400 @opindex fobjc-gc
2401 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2403 @item -freplace-objc-classes
2404 @opindex freplace-objc-classes
2405 Emit a special marker instructing @command{ld(1)} not to statically link in
2406 the resulting object file, and allow @command{dyld(1)} to load it in at
2407 run time instead.  This is used in conjunction with the Fix-and-Continue
2408 debugging mode, where the object file in question may be recompiled and
2409 dynamically reloaded in the course of program execution, without the need
2410 to restart the program itself.  Currently, Fix-and-Continue functionality
2411 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2412 and later.
2414 @item -fzero-link
2415 @opindex fzero-link
2416 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2417 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2418 compile time) with static class references that get initialized at load time,
2419 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2420 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2421 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2422 for individual class implementations to be modified during program execution.
2424 @item -gen-decls
2425 @opindex gen-decls
2426 Dump interface declarations for all classes seen in the source file to a
2427 file named @file{@var{sourcename}.decl}.
2429 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2430 @opindex Wassign-intercept
2431 @opindex Wno-assign-intercept
2432 Warn whenever an Objective-C assignment is being intercepted by the
2433 garbage collector.
2435 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2436 @opindex Wno-protocol
2437 @opindex Wprotocol
2438 If a class is declared to implement a protocol, a warning is issued for
2439 every method in the protocol that is not implemented by the class.  The
2440 default behavior is to issue a warning for every method not explicitly
2441 implemented in the class, even if a method implementation is inherited
2442 from the superclass.  If you use the @option{-Wno-protocol} option, then
2443 methods inherited from the superclass are considered to be implemented,
2444 and no warning is issued for them.
2446 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2447 @opindex Wselector
2448 @opindex Wno-selector
2449 Warn if multiple methods of different types for the same selector are
2450 found during compilation.  The check is performed on the list of methods
2451 in the final stage of compilation.  Additionally, a check is performed
2452 for each selector appearing in a @code{@@selector(@dots{})}
2453 expression, and a corresponding method for that selector has been found
2454 during compilation.  Because these checks scan the method table only at
2455 the end of compilation, these warnings are not produced if the final
2456 stage of compilation is not reached, for example because an error is
2457 found during compilation, or because the @option{-fsyntax-only} option is
2458 being used.
2460 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2461 @opindex Wstrict-selector-match
2462 @opindex Wno-strict-selector-match
2463 Warn if multiple methods with differing argument and/or return types are
2464 found for a given selector when attempting to send a message using this
2465 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2466 is off (which is the default behavior), the compiler will omit such warnings
2467 if any differences found are confined to types which share the same size
2468 and alignment.
2470 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2471 @opindex Wundeclared-selector
2472 @opindex Wno-undeclared-selector
2473 Warn if a @code{@@selector(@dots{})} expression referring to an
2474 undeclared selector is found.  A selector is considered undeclared if no
2475 method with that name has been declared before the
2476 @code{@@selector(@dots{})} expression, either explicitly in an
2477 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2478 an @code{@@implementation} section.  This option always performs its
2479 checks as soon as a @code{@@selector(@dots{})} expression is found,
2480 while @option{-Wselector} only performs its checks in the final stage of
2481 compilation.  This also enforces the coding style convention
2482 that methods and selectors must be declared before being used.
2484 @item -print-objc-runtime-info
2485 @opindex print-objc-runtime-info
2486 Generate C header describing the largest structure that is passed by
2487 value, if any.
2489 @end table
2491 @node Language Independent Options
2492 @section Options to Control Diagnostic Messages Formatting
2493 @cindex options to control diagnostics formatting
2494 @cindex diagnostic messages
2495 @cindex message formatting
2497 Traditionally, diagnostic messages have been formatted irrespective of
2498 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2499 below can be used to control the diagnostic messages formatting
2500 algorithm, e.g.@: how many characters per line, how often source location
2501 information should be reported.  Right now, only the C++ front end can
2502 honor these options.  However it is expected, in the near future, that
2503 the remaining front ends would be able to digest them correctly.
2505 @table @gcctabopt
2506 @item -fmessage-length=@var{n}
2507 @opindex fmessage-length
2508 Try to format error messages so that they fit on lines of about @var{n}
2509 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2510 the front ends supported by GCC@.  If @var{n} is zero, then no
2511 line-wrapping will be done; each error message will appear on a single
2512 line.
2514 @opindex fdiagnostics-show-location
2515 @item -fdiagnostics-show-location=once
2516 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2517 reporter to emit @emph{once} source location information; that is, in
2518 case the message is too long to fit on a single physical line and has to
2519 be wrapped, the source location won't be emitted (as prefix) again,
2520 over and over, in subsequent continuation lines.  This is the default
2521 behavior.
2523 @item -fdiagnostics-show-location=every-line
2524 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2525 messages reporter to emit the same source location information (as
2526 prefix) for physical lines that result from the process of breaking
2527 a message which is too long to fit on a single line.
2529 @item -fdiagnostics-show-option
2530 @opindex fdiagnostics-show-option
2531 This option instructs the diagnostic machinery to add text to each
2532 diagnostic emitted, which indicates which command line option directly
2533 controls that diagnostic, when such an option is known to the
2534 diagnostic machinery.
2536 @item -Wcoverage-mismatch
2537 @opindex Wcoverage-mismatch
2538 Warn if feedback profiles do not match when using the
2539 @option{-fprofile-use} option.
2540 If a source file was changed between @option{-fprofile-gen} and
2541 @option{-fprofile-use}, the files with the profile feedback can fail
2542 to match the source file and GCC can not use the profile feedback
2543 information.  By default, GCC emits an error message in this case.
2544 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2545 error.  GCC does not use appropriate feedback profiles, so using this
2546 option can result in poorly optimized code.  This option is useful
2547 only in the case of very minor changes such as bug fixes to an
2548 existing code-base.
2550 @end table
2552 @node Warning Options
2553 @section Options to Request or Suppress Warnings
2554 @cindex options to control warnings
2555 @cindex warning messages
2556 @cindex messages, warning
2557 @cindex suppressing warnings
2559 Warnings are diagnostic messages that report constructions which
2560 are not inherently erroneous but which are risky or suggest there
2561 may have been an error.
2563 The following language-independent options do not enable specific
2564 warnings but control the kinds of diagnostics produced by GCC.
2566 @table @gcctabopt
2567 @cindex syntax checking
2568 @item -fsyntax-only
2569 @opindex fsyntax-only
2570 Check the code for syntax errors, but don't do anything beyond that.
2572 @item -w
2573 @opindex w
2574 Inhibit all warning messages.
2576 @item -Werror
2577 @opindex Werror
2578 @opindex Wno-error
2579 Make all warnings into errors.
2581 @item -Werror=
2582 @opindex Werror=
2583 @opindex Wno-error=
2584 Make the specified warning into an error.  The specifier for a warning
2585 is appended, for example @option{-Werror=switch} turns the warnings
2586 controlled by @option{-Wswitch} into errors.  This switch takes a
2587 negative form, to be used to negate @option{-Werror} for specific
2588 warnings, for example @option{-Wno-error=switch} makes
2589 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2590 is in effect.  You can use the @option{-fdiagnostics-show-option}
2591 option to have each controllable warning amended with the option which
2592 controls it, to determine what to use with this option.
2594 Note that specifying @option{-Werror=}@var{foo} automatically implies
2595 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2596 imply anything.
2598 @item -Wfatal-errors
2599 @opindex Wfatal-errors
2600 @opindex Wno-fatal-errors
2601 This option causes the compiler to abort compilation on the first error
2602 occurred rather than trying to keep going and printing further error
2603 messages.
2605 @end table
2607 You can request many specific warnings with options beginning
2608 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2609 implicit declarations.  Each of these specific warning options also
2610 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2611 example, @option{-Wno-implicit}.  This manual lists only one of the
2612 two forms, whichever is not the default.  For further,
2613 language-specific options also refer to @ref{C++ Dialect Options} and
2614 @ref{Objective-C and Objective-C++ Dialect Options}.
2616 @table @gcctabopt
2617 @item -pedantic
2618 @opindex pedantic
2619 Issue all the warnings demanded by strict ISO C and ISO C++;
2620 reject all programs that use forbidden extensions, and some other
2621 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2622 version of the ISO C standard specified by any @option{-std} option used.
2624 Valid ISO C and ISO C++ programs should compile properly with or without
2625 this option (though a rare few will require @option{-ansi} or a
2626 @option{-std} option specifying the required version of ISO C)@.  However,
2627 without this option, certain GNU extensions and traditional C and C++
2628 features are supported as well.  With this option, they are rejected.
2630 @option{-pedantic} does not cause warning messages for use of the
2631 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2632 warnings are also disabled in the expression that follows
2633 @code{__extension__}.  However, only system header files should use
2634 these escape routes; application programs should avoid them.
2635 @xref{Alternate Keywords}.
2637 Some users try to use @option{-pedantic} to check programs for strict ISO
2638 C conformance.  They soon find that it does not do quite what they want:
2639 it finds some non-ISO practices, but not all---only those for which
2640 ISO C @emph{requires} a diagnostic, and some others for which
2641 diagnostics have been added.
2643 A feature to report any failure to conform to ISO C might be useful in
2644 some instances, but would require considerable additional work and would
2645 be quite different from @option{-pedantic}.  We don't have plans to
2646 support such a feature in the near future.
2648 Where the standard specified with @option{-std} represents a GNU
2649 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2650 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2651 extended dialect is based.  Warnings from @option{-pedantic} are given
2652 where they are required by the base standard.  (It would not make sense
2653 for such warnings to be given only for features not in the specified GNU
2654 C dialect, since by definition the GNU dialects of C include all
2655 features the compiler supports with the given option, and there would be
2656 nothing to warn about.)
2658 @item -pedantic-errors
2659 @opindex pedantic-errors
2660 Like @option{-pedantic}, except that errors are produced rather than
2661 warnings.
2663 @item -Wall
2664 @opindex Wall
2665 @opindex Wno-all
2666 This enables all the warnings about constructions that some users
2667 consider questionable, and that are easy to avoid (or modify to
2668 prevent the warning), even in conjunction with macros.  This also
2669 enables some language-specific warnings described in @ref{C++ Dialect
2670 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2672 @option{-Wall} turns on the following warning flags:
2674 @gccoptlist{-Waddress   @gol
2675 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2676 -Wc++0x-compat  @gol
2677 -Wchar-subscripts  @gol
2678 -Wimplicit-int  @gol
2679 -Wimplicit-function-declaration  @gol
2680 -Wcomment  @gol
2681 -Wformat   @gol
2682 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2683 -Wmissing-braces  @gol
2684 -Wnonnull  @gol
2685 -Wparentheses  @gol
2686 -Wpointer-sign  @gol
2687 -Wreorder   @gol
2688 -Wreturn-type  @gol
2689 -Wsequence-point  @gol
2690 -Wsign-compare @r{(only in C++)}  @gol
2691 -Wstrict-aliasing  @gol
2692 -Wstrict-overflow=1  @gol
2693 -Wswitch  @gol
2694 -Wtrigraphs  @gol
2695 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2696 -Wunknown-pragmas  @gol
2697 -Wunused-function  @gol
2698 -Wunused-label     @gol
2699 -Wunused-value     @gol
2700 -Wunused-variable  @gol
2701 -Wvolatile-register-var @gol
2704 Note that some warning flags are not implied by @option{-Wall}.  Some of
2705 them warn about constructions that users generally do not consider
2706 questionable, but which occasionally you might wish to check for;
2707 others warn about constructions that are necessary or hard to avoid in
2708 some cases, and there is no simple way to modify the code to suppress
2709 the warning. Some of them are enabled by @option{-Wextra} but many of
2710 them must be enabled individually.
2712 @item -Wextra
2713 @opindex W
2714 @opindex Wextra
2715 @opindex Wno-extra
2716 This enables some extra warning flags that are not enabled by
2717 @option{-Wall}. (This option used to be called @option{-W}.  The older
2718 name is still supported, but the newer name is more descriptive.)
2720 @gccoptlist{-Wclobbered  @gol
2721 -Wempty-body  @gol
2722 -Wignored-qualifiers @gol
2723 -Wmissing-field-initializers  @gol
2724 -Wmissing-parameter-type @r{(C only)}  @gol
2725 -Wold-style-declaration @r{(C only)}  @gol
2726 -Woverride-init  @gol
2727 -Wsign-compare  @gol
2728 -Wtype-limits  @gol
2729 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2730 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2733 The option @option{-Wextra} also prints warning messages for the
2734 following cases:
2736 @itemize @bullet
2738 @item
2739 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2740 @samp{>}, or @samp{>=}.
2742 @item 
2743 (C++ only) An enumerator and a non-enumerator both appear in a
2744 conditional expression.
2746 @item 
2747 (C++ only) A non-static reference or non-static @samp{const} member
2748 appears in a class without constructors.
2750 @item 
2751 (C++ only) Ambiguous virtual bases.
2753 @item 
2754 (C++ only) Subscripting an array which has been declared @samp{register}.
2756 @item 
2757 (C++ only) Taking the address of a variable which has been declared
2758 @samp{register}.
2760 @item 
2761 (C++ only) A base class is not initialized in a derived class' copy
2762 constructor.
2764 @end itemize
2766 @item -Wchar-subscripts
2767 @opindex Wchar-subscripts
2768 @opindex Wno-char-subscripts
2769 Warn if an array subscript has type @code{char}.  This is a common cause
2770 of error, as programmers often forget that this type is signed on some
2771 machines.
2772 This warning is enabled by @option{-Wall}.
2774 @item -Wcomment
2775 @opindex Wcomment
2776 @opindex Wno-comment
2777 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2778 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2779 This warning is enabled by @option{-Wall}.
2781 @item -Wformat
2782 @opindex Wformat
2783 @opindex Wno-format
2784 @opindex ffreestanding
2785 @opindex fno-builtin
2786 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2787 the arguments supplied have types appropriate to the format string
2788 specified, and that the conversions specified in the format string make
2789 sense.  This includes standard functions, and others specified by format
2790 attributes (@pxref{Function Attributes}), in the @code{printf},
2791 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2792 not in the C standard) families (or other target-specific families).
2793 Which functions are checked without format attributes having been
2794 specified depends on the standard version selected, and such checks of
2795 functions without the attribute specified are disabled by
2796 @option{-ffreestanding} or @option{-fno-builtin}.
2798 The formats are checked against the format features supported by GNU
2799 libc version 2.2.  These include all ISO C90 and C99 features, as well
2800 as features from the Single Unix Specification and some BSD and GNU
2801 extensions.  Other library implementations may not support all these
2802 features; GCC does not support warning about features that go beyond a
2803 particular library's limitations.  However, if @option{-pedantic} is used
2804 with @option{-Wformat}, warnings will be given about format features not
2805 in the selected standard version (but not for @code{strfmon} formats,
2806 since those are not in any version of the C standard).  @xref{C Dialect
2807 Options,,Options Controlling C Dialect}.
2809 Since @option{-Wformat} also checks for null format arguments for
2810 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2812 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2813 aspects of format checking, the options @option{-Wformat-y2k},
2814 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2815 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2816 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2818 @item -Wformat-y2k
2819 @opindex Wformat-y2k
2820 @opindex Wno-format-y2k
2821 If @option{-Wformat} is specified, also warn about @code{strftime}
2822 formats which may yield only a two-digit year.
2824 @item -Wno-format-contains-nul
2825 @opindex Wno-format-contains-nul
2826 @opindex Wformat-contains-nul
2827 If @option{-Wformat} is specified, do not warn about format strings that
2828 contain NUL bytes.
2830 @item -Wno-format-extra-args
2831 @opindex Wno-format-extra-args
2832 @opindex Wformat-extra-args
2833 If @option{-Wformat} is specified, do not warn about excess arguments to a
2834 @code{printf} or @code{scanf} format function.  The C standard specifies
2835 that such arguments are ignored.
2837 Where the unused arguments lie between used arguments that are
2838 specified with @samp{$} operand number specifications, normally
2839 warnings are still given, since the implementation could not know what
2840 type to pass to @code{va_arg} to skip the unused arguments.  However,
2841 in the case of @code{scanf} formats, this option will suppress the
2842 warning if the unused arguments are all pointers, since the Single
2843 Unix Specification says that such unused arguments are allowed.
2845 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2846 @opindex Wno-format-zero-length
2847 @opindex Wformat-zero-length
2848 If @option{-Wformat} is specified, do not warn about zero-length formats.
2849 The C standard specifies that zero-length formats are allowed.
2851 @item -Wformat-nonliteral
2852 @opindex Wformat-nonliteral
2853 @opindex Wno-format-nonliteral
2854 If @option{-Wformat} is specified, also warn if the format string is not a
2855 string literal and so cannot be checked, unless the format function
2856 takes its format arguments as a @code{va_list}.
2858 @item -Wformat-security
2859 @opindex Wformat-security
2860 @opindex Wno-format-security
2861 If @option{-Wformat} is specified, also warn about uses of format
2862 functions that represent possible security problems.  At present, this
2863 warns about calls to @code{printf} and @code{scanf} functions where the
2864 format string is not a string literal and there are no format arguments,
2865 as in @code{printf (foo);}.  This may be a security hole if the format
2866 string came from untrusted input and contains @samp{%n}.  (This is
2867 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2868 in future warnings may be added to @option{-Wformat-security} that are not
2869 included in @option{-Wformat-nonliteral}.)
2871 @item -Wformat=2
2872 @opindex Wformat=2
2873 @opindex Wno-format=2
2874 Enable @option{-Wformat} plus format checks not included in
2875 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2876 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2878 @item -Wnonnull @r{(C and Objective-C only)}
2879 @opindex Wnonnull
2880 @opindex Wno-nonnull
2881 Warn about passing a null pointer for arguments marked as
2882 requiring a non-null value by the @code{nonnull} function attribute.
2884 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2885 can be disabled with the @option{-Wno-nonnull} option.
2887 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2888 @opindex Winit-self
2889 @opindex Wno-init-self
2890 Warn about uninitialized variables which are initialized with themselves.
2891 Note this option can only be used with the @option{-Wuninitialized} option,
2892 which in turn only works with @option{-O1} and above.
2894 For example, GCC will warn about @code{i} being uninitialized in the
2895 following snippet only when @option{-Winit-self} has been specified:
2896 @smallexample
2897 @group
2898 int f()
2900   int i = i;
2901   return i;
2903 @end group
2904 @end smallexample
2906 @item -Wimplicit-int @r{(C and Objective-C only)}
2907 @opindex Wimplicit-int
2908 @opindex Wno-implicit-int
2909 Warn when a declaration does not specify a type.
2910 This warning is enabled by @option{-Wall}.
2912 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2913 @opindex Wimplicit-function-declaration
2914 @opindex Wno-implicit-function-declaration
2915 Give a warning whenever a function is used before being declared. In
2916 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2917 enabled by default and it is made into an error by
2918 @option{-pedantic-errors}. This warning is also enabled by
2919 @option{-Wall}.
2921 @item -Wimplicit
2922 @opindex Wimplicit
2923 @opindex Wno-implicit
2924 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2925 This warning is enabled by @option{-Wall}.
2927 @item -Wignored-qualifiers @r{(C and C++ only)}
2928 @opindex Wignored-qualifiers
2929 @opindex Wno-ignored-qualifiers
2930 Warn if the return type of a function has a type qualifier
2931 such as @code{const}.  For ISO C such a type qualifier has no effect,
2932 since the value returned by a function is not an lvalue.
2933 For C++, the warning is only emitted for scalar types or @code{void}.
2934 ISO C prohibits qualified @code{void} return types on function
2935 definitions, so such return types always receive a warning
2936 even without this option.
2938 This warning is also enabled by @option{-Wextra}.
2940 @item -Wmain
2941 @opindex Wmain
2942 @opindex Wno-main
2943 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2944 function with external linkage, returning int, taking either zero
2945 arguments, two, or three arguments of appropriate types.
2946 This warning is enabled by @option{-Wall}.
2948 @item -Wmissing-braces
2949 @opindex Wmissing-braces
2950 @opindex Wno-missing-braces
2951 Warn if an aggregate or union initializer is not fully bracketed.  In
2952 the following example, the initializer for @samp{a} is not fully
2953 bracketed, but that for @samp{b} is fully bracketed.
2955 @smallexample
2956 int a[2][2] = @{ 0, 1, 2, 3 @};
2957 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2958 @end smallexample
2960 This warning is enabled by @option{-Wall}.
2962 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2963 @opindex Wmissing-include-dirs
2964 @opindex Wno-missing-include-dirs
2965 Warn if a user-supplied include directory does not exist.
2967 @item -Wparentheses
2968 @opindex Wparentheses
2969 @opindex Wno-parentheses
2970 Warn if parentheses are omitted in certain contexts, such
2971 as when there is an assignment in a context where a truth value
2972 is expected, or when operators are nested whose precedence people
2973 often get confused about.
2975 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2976 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2977 interpretation from that of ordinary mathematical notation.
2979 Also warn about constructions where there may be confusion to which
2980 @code{if} statement an @code{else} branch belongs.  Here is an example of
2981 such a case:
2983 @smallexample
2984 @group
2986   if (a)
2987     if (b)
2988       foo ();
2989   else
2990     bar ();
2992 @end group
2993 @end smallexample
2995 In C/C++, every @code{else} branch belongs to the innermost possible
2996 @code{if} statement, which in this example is @code{if (b)}.  This is
2997 often not what the programmer expected, as illustrated in the above
2998 example by indentation the programmer chose.  When there is the
2999 potential for this confusion, GCC will issue a warning when this flag
3000 is specified.  To eliminate the warning, add explicit braces around
3001 the innermost @code{if} statement so there is no way the @code{else}
3002 could belong to the enclosing @code{if}.  The resulting code would
3003 look like this:
3005 @smallexample
3006 @group
3008   if (a)
3009     @{
3010       if (b)
3011         foo ();
3012       else
3013         bar ();
3014     @}
3016 @end group
3017 @end smallexample
3019 This warning is enabled by @option{-Wall}.
3021 @item -Wsequence-point
3022 @opindex Wsequence-point
3023 @opindex Wno-sequence-point
3024 Warn about code that may have undefined semantics because of violations
3025 of sequence point rules in the C and C++ standards.
3027 The C and C++ standards defines the order in which expressions in a C/C++
3028 program are evaluated in terms of @dfn{sequence points}, which represent
3029 a partial ordering between the execution of parts of the program: those
3030 executed before the sequence point, and those executed after it.  These
3031 occur after the evaluation of a full expression (one which is not part
3032 of a larger expression), after the evaluation of the first operand of a
3033 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3034 function is called (but after the evaluation of its arguments and the
3035 expression denoting the called function), and in certain other places.
3036 Other than as expressed by the sequence point rules, the order of
3037 evaluation of subexpressions of an expression is not specified.  All
3038 these rules describe only a partial order rather than a total order,
3039 since, for example, if two functions are called within one expression
3040 with no sequence point between them, the order in which the functions
3041 are called is not specified.  However, the standards committee have
3042 ruled that function calls do not overlap.
3044 It is not specified when between sequence points modifications to the
3045 values of objects take effect.  Programs whose behavior depends on this
3046 have undefined behavior; the C and C++ standards specify that ``Between
3047 the previous and next sequence point an object shall have its stored
3048 value modified at most once by the evaluation of an expression.
3049 Furthermore, the prior value shall be read only to determine the value
3050 to be stored.''.  If a program breaks these rules, the results on any
3051 particular implementation are entirely unpredictable.
3053 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3054 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3055 diagnosed by this option, and it may give an occasional false positive
3056 result, but in general it has been found fairly effective at detecting
3057 this sort of problem in programs.
3059 The standard is worded confusingly, therefore there is some debate
3060 over the precise meaning of the sequence point rules in subtle cases.
3061 Links to discussions of the problem, including proposed formal
3062 definitions, may be found on the GCC readings page, at
3063 @w{@uref{http://gcc.gnu.org/readings.html}}.
3065 This warning is enabled by @option{-Wall} for C and C++.
3067 @item -Wreturn-type
3068 @opindex Wreturn-type
3069 @opindex Wno-return-type
3070 Warn whenever a function is defined with a return-type that defaults
3071 to @code{int}.  Also warn about any @code{return} statement with no
3072 return-value in a function whose return-type is not @code{void}
3073 (falling off the end of the function body is considered returning
3074 without a value), and about a @code{return} statement with a
3075 expression in a function whose return-type is @code{void}.
3077 For C++, a function without return type always produces a diagnostic
3078 message, even when @option{-Wno-return-type} is specified.  The only
3079 exceptions are @samp{main} and functions defined in system headers.
3081 This warning is enabled by @option{-Wall}.
3083 @item -Wswitch
3084 @opindex Wswitch
3085 @opindex Wno-switch
3086 Warn whenever a @code{switch} statement has an index of enumerated type
3087 and lacks a @code{case} for one or more of the named codes of that
3088 enumeration.  (The presence of a @code{default} label prevents this
3089 warning.)  @code{case} labels outside the enumeration range also
3090 provoke warnings when this option is used.
3091 This warning is enabled by @option{-Wall}.
3093 @item -Wswitch-default
3094 @opindex Wswitch-default
3095 @opindex Wno-switch-default
3096 Warn whenever a @code{switch} statement does not have a @code{default}
3097 case.
3099 @item -Wswitch-enum
3100 @opindex Wswitch-enum
3101 @opindex Wno-switch-enum
3102 Warn whenever a @code{switch} statement has an index of enumerated type
3103 and lacks a @code{case} for one or more of the named codes of that
3104 enumeration.  @code{case} labels outside the enumeration range also
3105 provoke warnings when this option is used.
3107 @item -Wtrigraphs
3108 @opindex Wtrigraphs
3109 @opindex Wno-trigraphs
3110 Warn if any trigraphs are encountered that might change the meaning of
3111 the program (trigraphs within comments are not warned about).
3112 This warning is enabled by @option{-Wall}.
3114 @item -Wunused-function
3115 @opindex Wunused-function
3116 @opindex Wno-unused-function
3117 Warn whenever a static function is declared but not defined or a
3118 non-inline static function is unused.
3119 This warning is enabled by @option{-Wall}.
3121 @item -Wunused-label
3122 @opindex Wunused-label
3123 @opindex Wno-unused-label
3124 Warn whenever a label is declared but not used.
3125 This warning is enabled by @option{-Wall}.
3127 To suppress this warning use the @samp{unused} attribute
3128 (@pxref{Variable Attributes}).
3130 @item -Wunused-parameter
3131 @opindex Wunused-parameter
3132 @opindex Wno-unused-parameter
3133 Warn whenever a function parameter is unused aside from its declaration.
3135 To suppress this warning use the @samp{unused} attribute
3136 (@pxref{Variable Attributes}).
3138 @item -Wunused-variable
3139 @opindex Wunused-variable
3140 @opindex Wno-unused-variable
3141 Warn whenever a local variable or non-constant static variable is unused
3142 aside from its declaration.
3143 This warning is enabled by @option{-Wall}.
3145 To suppress this warning use the @samp{unused} attribute
3146 (@pxref{Variable Attributes}).
3148 @item -Wunused-value
3149 @opindex Wunused-value
3150 @opindex Wno-unused-value
3151 Warn whenever a statement computes a result that is explicitly not
3152 used. To suppress this warning cast the unused expression to
3153 @samp{void}. This includes an expression-statement or the left-hand
3154 side of a comma expression that contains no side effects. For example,
3155 an expression such as @samp{x[i,j]} will cause a warning, while
3156 @samp{x[(void)i,j]} will not.
3158 This warning is enabled by @option{-Wall}.
3160 @item -Wunused
3161 @opindex Wunused
3162 @opindex Wno-unused
3163 All the above @option{-Wunused} options combined.
3165 In order to get a warning about an unused function parameter, you must
3166 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3167 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3169 @item -Wuninitialized
3170 @opindex Wuninitialized
3171 @opindex Wno-uninitialized
3172 Warn if an automatic variable is used without first being initialized or
3173 if a variable may be clobbered by a @code{setjmp} call.
3175 These warnings are possible only in optimizing compilation,
3176 because they require data flow information that is computed only
3177 when optimizing.  If you do not specify @option{-O}, you will not get
3178 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3179 requiring @option{-O}.
3181 If you want to warn about code which uses the uninitialized value of the
3182 variable in its own initializer, use the @option{-Winit-self} option.
3184 These warnings occur for individual uninitialized or clobbered
3185 elements of structure, union or array variables as well as for
3186 variables which are uninitialized or clobbered as a whole.  They do
3187 not occur for variables or elements declared @code{volatile}.  Because
3188 these warnings depend on optimization, the exact variables or elements
3189 for which there are warnings will depend on the precise optimization
3190 options and version of GCC used.
3192 Note that there may be no warning about a variable that is used only
3193 to compute a value that itself is never used, because such
3194 computations may be deleted by data flow analysis before the warnings
3195 are printed.
3197 These warnings are made optional because GCC is not smart
3198 enough to see all the reasons why the code might be correct
3199 despite appearing to have an error.  Here is one example of how
3200 this can happen:
3202 @smallexample
3203 @group
3205   int x;
3206   switch (y)
3207     @{
3208     case 1: x = 1;
3209       break;
3210     case 2: x = 4;
3211       break;
3212     case 3: x = 5;
3213     @}
3214   foo (x);
3216 @end group
3217 @end smallexample
3219 @noindent
3220 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3221 always initialized, but GCC doesn't know this.  Here is
3222 another common case:
3224 @smallexample
3226   int save_y;
3227   if (change_y) save_y = y, y = new_y;
3228   @dots{}
3229   if (change_y) y = save_y;
3231 @end smallexample
3233 @noindent
3234 This has no bug because @code{save_y} is used only if it is set.
3236 @cindex @code{longjmp} warnings
3237 This option also warns when a non-volatile automatic variable might be
3238 changed by a call to @code{longjmp}.  These warnings as well are possible
3239 only in optimizing compilation.
3241 The compiler sees only the calls to @code{setjmp}.  It cannot know
3242 where @code{longjmp} will be called; in fact, a signal handler could
3243 call it at any point in the code.  As a result, you may get a warning
3244 even when there is in fact no problem because @code{longjmp} cannot
3245 in fact be called at the place which would cause a problem.
3247 Some spurious warnings can be avoided if you declare all the functions
3248 you use that never return as @code{noreturn}.  @xref{Function
3249 Attributes}.
3251 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3252 optimizing compilations (@option{-O1} and above).
3254 @item -Wunknown-pragmas
3255 @opindex Wunknown-pragmas
3256 @opindex Wno-unknown-pragmas
3257 @cindex warning for unknown pragmas
3258 @cindex unknown pragmas, warning
3259 @cindex pragmas, warning of unknown
3260 Warn when a #pragma directive is encountered which is not understood by
3261 GCC@.  If this command line option is used, warnings will even be issued
3262 for unknown pragmas in system header files.  This is not the case if
3263 the warnings were only enabled by the @option{-Wall} command line option.
3265 @item -Wno-pragmas
3266 @opindex Wno-pragmas
3267 @opindex Wpragmas
3268 Do not warn about misuses of pragmas, such as incorrect parameters,
3269 invalid syntax, or conflicts between pragmas.  See also
3270 @samp{-Wunknown-pragmas}.
3272 @item -Wstrict-aliasing
3273 @opindex Wstrict-aliasing
3274 @opindex Wno-strict-aliasing
3275 This option is only active when @option{-fstrict-aliasing} is active.
3276 It warns about code which might break the strict aliasing rules that the
3277 compiler is using for optimization.  The warning does not catch all
3278 cases, but does attempt to catch the more common pitfalls.  It is
3279 included in @option{-Wall}.
3280 It is equivalent to @option{-Wstrict-aliasing=3}
3282 @item -Wstrict-aliasing=n
3283 @opindex Wstrict-aliasing=n
3284 @opindex Wno-strict-aliasing=n
3285 This option is only active when @option{-fstrict-aliasing} is active.
3286 It warns about code which might break the strict aliasing rules that the
3287 compiler is using for optimization.
3288 Higher levels correspond to higher accuracy (fewer false positives).
3289 Higher levels also correspond to more effort, similar to the way -O works.
3290 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3291 with n=3.
3293 Level 1: Most aggressive, quick, least accurate.
3294 Possibly useful when higher levels
3295 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3296 false negatives.  However, it has many false positives.
3297 Warns for all pointer conversions between possibly incompatible types, 
3298 even if never dereferenced.  Runs in the frontend only.
3300 Level 2: Aggressive, quick, not too precise.
3301 May still have many false positives (not as many as level 1 though),
3302 and few false negatives (but possibly more than level 1).
3303 Unlike level 1, it only warns when an address is taken.  Warns about
3304 incomplete types.  Runs in the frontend only.
3306 Level 3 (default for @option{-Wstrict-aliasing}): 
3307 Should have very few false positives and few false 
3308 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3309 Takes care of the common punn+dereference pattern in the frontend:
3310 @code{*(int*)&some_float}.
3311 If optimization is enabled, it also runs in the backend, where it deals 
3312 with multiple statement cases using flow-sensitive points-to information.
3313 Only warns when the converted pointer is dereferenced.
3314 Does not warn about incomplete types.
3316 @item -Wstrict-overflow
3317 @itemx -Wstrict-overflow=@var{n}
3318 @opindex Wstrict-overflow
3319 @opindex Wno-strict-overflow
3320 This option is only active when @option{-fstrict-overflow} is active.
3321 It warns about cases where the compiler optimizes based on the
3322 assumption that signed overflow does not occur.  Note that it does not
3323 warn about all cases where the code might overflow: it only warns
3324 about cases where the compiler implements some optimization.  Thus
3325 this warning depends on the optimization level.
3327 An optimization which assumes that signed overflow does not occur is
3328 perfectly safe if the values of the variables involved are such that
3329 overflow never does, in fact, occur.  Therefore this warning can
3330 easily give a false positive: a warning about code which is not
3331 actually a problem.  To help focus on important issues, several
3332 warning levels are defined.  No warnings are issued for the use of
3333 undefined signed overflow when estimating how many iterations a loop
3334 will require, in particular when determining whether a loop will be
3335 executed at all.
3337 @table @gcctabopt
3338 @item -Wstrict-overflow=1
3339 Warn about cases which are both questionable and easy to avoid.  For
3340 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3341 compiler will simplify this to @code{1}.  This level of
3342 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3343 are not, and must be explicitly requested.
3345 @item -Wstrict-overflow=2
3346 Also warn about other cases where a comparison is simplified to a
3347 constant.  For example: @code{abs (x) >= 0}.  This can only be
3348 simplified when @option{-fstrict-overflow} is in effect, because
3349 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3350 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3351 @option{-Wstrict-overflow=2}.
3353 @item -Wstrict-overflow=3
3354 Also warn about other cases where a comparison is simplified.  For
3355 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3357 @item -Wstrict-overflow=4
3358 Also warn about other simplifications not covered by the above cases.
3359 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3361 @item -Wstrict-overflow=5
3362 Also warn about cases where the compiler reduces the magnitude of a
3363 constant involved in a comparison.  For example: @code{x + 2 > y} will
3364 be simplified to @code{x + 1 >= y}.  This is reported only at the
3365 highest warning level because this simplification applies to many
3366 comparisons, so this warning level will give a very large number of
3367 false positives.
3368 @end table
3370 @item -Warray-bounds
3371 @opindex Wno-array-bounds
3372 @opindex Warray-bounds
3373 This option is only active when @option{-ftree-vrp} is active
3374 (default for -O2 and above). It warns about subscripts to arrays
3375 that are always out of bounds. This warning is enabled by @option{-Wall}.
3377 @item -Wno-div-by-zero
3378 @opindex Wno-div-by-zero
3379 @opindex Wdiv-by-zero
3380 Do not warn about compile-time integer division by zero.  Floating point
3381 division by zero is not warned about, as it can be a legitimate way of
3382 obtaining infinities and NaNs.
3384 @item -Wsystem-headers
3385 @opindex Wsystem-headers
3386 @opindex Wno-system-headers
3387 @cindex warnings from system headers
3388 @cindex system headers, warnings from
3389 Print warning messages for constructs found in system header files.
3390 Warnings from system headers are normally suppressed, on the assumption
3391 that they usually do not indicate real problems and would only make the
3392 compiler output harder to read.  Using this command line option tells
3393 GCC to emit warnings from system headers as if they occurred in user
3394 code.  However, note that using @option{-Wall} in conjunction with this
3395 option will @emph{not} warn about unknown pragmas in system
3396 headers---for that, @option{-Wunknown-pragmas} must also be used.
3398 @item -Wfloat-equal
3399 @opindex Wfloat-equal
3400 @opindex Wno-float-equal
3401 Warn if floating point values are used in equality comparisons.
3403 The idea behind this is that sometimes it is convenient (for the
3404 programmer) to consider floating-point values as approximations to
3405 infinitely precise real numbers.  If you are doing this, then you need
3406 to compute (by analyzing the code, or in some other way) the maximum or
3407 likely maximum error that the computation introduces, and allow for it
3408 when performing comparisons (and when producing output, but that's a
3409 different problem).  In particular, instead of testing for equality, you
3410 would check to see whether the two values have ranges that overlap; and
3411 this is done with the relational operators, so equality comparisons are
3412 probably mistaken.
3414 @item -Wtraditional @r{(C and Objective-C only)}
3415 @opindex Wtraditional
3416 @opindex Wno-traditional
3417 Warn about certain constructs that behave differently in traditional and
3418 ISO C@.  Also warn about ISO C constructs that have no traditional C
3419 equivalent, and/or problematic constructs which should be avoided.
3421 @itemize @bullet
3422 @item
3423 Macro parameters that appear within string literals in the macro body.
3424 In traditional C macro replacement takes place within string literals,
3425 but does not in ISO C@.
3427 @item
3428 In traditional C, some preprocessor directives did not exist.
3429 Traditional preprocessors would only consider a line to be a directive
3430 if the @samp{#} appeared in column 1 on the line.  Therefore
3431 @option{-Wtraditional} warns about directives that traditional C
3432 understands but would ignore because the @samp{#} does not appear as the
3433 first character on the line.  It also suggests you hide directives like
3434 @samp{#pragma} not understood by traditional C by indenting them.  Some
3435 traditional implementations would not recognize @samp{#elif}, so it
3436 suggests avoiding it altogether.
3438 @item
3439 A function-like macro that appears without arguments.
3441 @item
3442 The unary plus operator.
3444 @item
3445 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3446 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3447 constants.)  Note, these suffixes appear in macros defined in the system
3448 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3449 Use of these macros in user code might normally lead to spurious
3450 warnings, however GCC's integrated preprocessor has enough context to
3451 avoid warning in these cases.
3453 @item
3454 A function declared external in one block and then used after the end of
3455 the block.
3457 @item
3458 A @code{switch} statement has an operand of type @code{long}.
3460 @item
3461 A non-@code{static} function declaration follows a @code{static} one.
3462 This construct is not accepted by some traditional C compilers.
3464 @item
3465 The ISO type of an integer constant has a different width or
3466 signedness from its traditional type.  This warning is only issued if
3467 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3468 typically represent bit patterns, are not warned about.
3470 @item
3471 Usage of ISO string concatenation is detected.
3473 @item
3474 Initialization of automatic aggregates.
3476 @item
3477 Identifier conflicts with labels.  Traditional C lacks a separate
3478 namespace for labels.
3480 @item
3481 Initialization of unions.  If the initializer is zero, the warning is
3482 omitted.  This is done under the assumption that the zero initializer in
3483 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3484 initializer warnings and relies on default initialization to zero in the
3485 traditional C case.
3487 @item
3488 Conversions by prototypes between fixed/floating point values and vice
3489 versa.  The absence of these prototypes when compiling with traditional
3490 C would cause serious problems.  This is a subset of the possible
3491 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3493 @item
3494 Use of ISO C style function definitions.  This warning intentionally is
3495 @emph{not} issued for prototype declarations or variadic functions
3496 because these ISO C features will appear in your code when using
3497 libiberty's traditional C compatibility macros, @code{PARAMS} and
3498 @code{VPARAMS}.  This warning is also bypassed for nested functions
3499 because that feature is already a GCC extension and thus not relevant to
3500 traditional C compatibility.
3501 @end itemize
3503 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3504 @opindex Wtraditional-conversion
3505 @opindex Wno-traditional-conversion
3506 Warn if a prototype causes a type conversion that is different from what
3507 would happen to the same argument in the absence of a prototype.  This
3508 includes conversions of fixed point to floating and vice versa, and
3509 conversions changing the width or signedness of a fixed point argument
3510 except when the same as the default promotion.
3512 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3513 @opindex Wdeclaration-after-statement
3514 @opindex Wno-declaration-after-statement
3515 Warn when a declaration is found after a statement in a block.  This
3516 construct, known from C++, was introduced with ISO C99 and is by default
3517 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3518 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3520 @item -Wundef
3521 @opindex Wundef
3522 @opindex Wno-undef
3523 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3525 @item -Wno-endif-labels
3526 @opindex Wno-endif-labels
3527 @opindex Wendif-labels
3528 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3530 @item -Wshadow
3531 @opindex Wshadow
3532 @opindex Wno-shadow
3533 Warn whenever a local variable shadows another local variable, parameter or
3534 global variable or whenever a built-in function is shadowed.
3536 @item -Wlarger-than=@var{len}
3537 @opindex Wlarger-than=@var{len}
3538 @opindex Wlarger-than-@var{len}
3539 Warn whenever an object of larger than @var{len} bytes is defined.
3541 @item -Wframe-larger-than=@var{len}
3542 @opindex Wframe-larger-than
3543 Warn if the size of a function frame is larger than @var{len} bytes.
3544 The computation done to determine the stack frame size is approximate
3545 and not conservative.
3546 The actual requirements may be somewhat greater than @var{len}
3547 even if you do not get a warning.  In addition, any space allocated
3548 via @code{alloca}, variable-length arrays, or related constructs
3549 is not included by the compiler when determining
3550 whether or not to issue a warning.
3552 @item -Wunsafe-loop-optimizations
3553 @opindex Wunsafe-loop-optimizations
3554 @opindex Wno-unsafe-loop-optimizations
3555 Warn if the loop cannot be optimized because the compiler could not
3556 assume anything on the bounds of the loop indices.  With
3557 @option{-funsafe-loop-optimizations} warn if the compiler made
3558 such assumptions.
3560 @item -Wpointer-arith
3561 @opindex Wpointer-arith
3562 @opindex Wno-pointer-arith
3563 Warn about anything that depends on the ``size of'' a function type or
3564 of @code{void}.  GNU C assigns these types a size of 1, for
3565 convenience in calculations with @code{void *} pointers and pointers
3566 to functions.  In C++, warn also when an arithmetic operation involves
3567 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3569 @item -Wtype-limits
3570 @opindex Wtype-limits
3571 @opindex Wno-type-limits
3572 Warn if a comparison is always true or always false due to the limited
3573 range of the data type, but do not warn for constant expressions.  For
3574 example, warn if an unsigned variable is compared against zero with
3575 @samp{<} or @samp{>=}.  This warning is also enabled by
3576 @option{-Wextra}.
3578 @item -Wbad-function-cast @r{(C and Objective-C only)}
3579 @opindex Wbad-function-cast
3580 @opindex Wno-bad-function-cast
3581 Warn whenever a function call is cast to a non-matching type.
3582 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3584 @item -Wc++-compat @r{(C and Objective-C only)}
3585 Warn about ISO C constructs that are outside of the common subset of
3586 ISO C and ISO C++, e.g.@: request for implicit conversion from
3587 @code{void *} to a pointer to non-@code{void} type.
3589 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3590 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3591 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3592 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3594 @item -Wcast-qual
3595 @opindex Wcast-qual
3596 @opindex Wno-cast-qual
3597 Warn whenever a pointer is cast so as to remove a type qualifier from
3598 the target type.  For example, warn if a @code{const char *} is cast
3599 to an ordinary @code{char *}.
3601 @item -Wcast-align
3602 @opindex Wcast-align
3603 @opindex Wno-cast-align
3604 Warn whenever a pointer is cast such that the required alignment of the
3605 target is increased.  For example, warn if a @code{char *} is cast to
3606 an @code{int *} on machines where integers can only be accessed at
3607 two- or four-byte boundaries.
3609 @item -Wwrite-strings
3610 @opindex Wwrite-strings
3611 @opindex Wno-write-strings
3612 When compiling C, give string constants the type @code{const
3613 char[@var{length}]} so that
3614 copying the address of one into a non-@code{const} @code{char *}
3615 pointer will get a warning; when compiling C++, warn about the
3616 deprecated conversion from string literals to @code{char *}.  This
3617 warning, by default, is enabled for C++ programs.
3618 These warnings will help you find at
3619 compile time code that can try to write into a string constant, but
3620 only if you have been very careful about using @code{const} in
3621 declarations and prototypes.  Otherwise, it will just be a nuisance;
3622 this is why we did not make @option{-Wall} request these warnings.
3624 @item -Wclobbered
3625 @opindex Wclobbered
3626 @opindex Wno-clobbered
3627 Warn for variables that might be changed by @samp{longjmp} or
3628 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3630 @item -Wconversion
3631 @opindex Wconversion
3632 @opindex Wno-conversion
3633 Warn for implicit conversions that may alter a value. This includes
3634 conversions between real and integer, like @code{abs (x)} when
3635 @code{x} is @code{double}; conversions between signed and unsigned,
3636 like @code{unsigned ui = -1}; and conversions to smaller types, like
3637 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3638 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3639 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3640 conversions between signed and unsigned integers can be disabled by
3641 using @option{-Wno-sign-conversion}.
3643 For C++, also warn for conversions between @code{NULL} and non-pointer
3644 types; confusing overload resolution for user-defined conversions; and
3645 conversions that will never use a type conversion operator:
3646 conversions to @code{void}, the same type, a base class or a reference
3647 to them. Warnings about conversions between signed and unsigned
3648 integers are disabled by default in C++ unless
3649 @option{-Wsign-conversion} is explicitly enabled.
3651 @item -Wempty-body
3652 @opindex Wempty-body
3653 @opindex Wno-empty-body
3654 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3655 while} statement.  Additionally, in C++, warn when an empty body occurs
3656 in a @samp{while} or @samp{for} statement with no whitespacing before
3657 the semicolon.  This warning is also enabled by @option{-Wextra}.
3659 @item -Wenum-compare @r{(C++ and Objective-C++ only)}
3660 @opindex Wenum-compare
3661 @opindex Wno-enum-compare
3662 Warn about a comparison between values of different enum types. This
3663 warning is enabled by default.
3665 @item -Wsign-compare
3666 @opindex Wsign-compare
3667 @opindex Wno-sign-compare
3668 @cindex warning for comparison of signed and unsigned values
3669 @cindex comparison of signed and unsigned values, warning
3670 @cindex signed and unsigned values, comparison warning
3671 Warn when a comparison between signed and unsigned values could produce
3672 an incorrect result when the signed value is converted to unsigned.
3673 This warning is also enabled by @option{-Wextra}; to get the other warnings
3674 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3676 @item -Wsign-conversion
3677 @opindex Wsign-conversion
3678 @opindex Wno-sign-conversion
3679 Warn for implicit conversions that may change the sign of an integer
3680 value, like assigning a signed integer expression to an unsigned
3681 integer variable. An explicit cast silences the warning. In C, this
3682 option is enabled also by @option{-Wconversion}.
3684 @item -Waddress
3685 @opindex Waddress
3686 @opindex Wno-address
3687 Warn about suspicious uses of memory addresses. These include using
3688 the address of a function in a conditional expression, such as
3689 @code{void func(void); if (func)}, and comparisons against the memory
3690 address of a string literal, such as @code{if (x == "abc")}.  Such
3691 uses typically indicate a programmer error: the address of a function
3692 always evaluates to true, so their use in a conditional usually
3693 indicate that the programmer forgot the parentheses in a function
3694 call; and comparisons against string literals result in unspecified
3695 behavior and are not portable in C, so they usually indicate that the
3696 programmer intended to use @code{strcmp}.  This warning is enabled by
3697 @option{-Wall}.
3699 @item -Wlogical-op
3700 @opindex Wlogical-op
3701 @opindex Wno-logical-op
3702 Warn about suspicious uses of logical operators in expressions.
3703 This includes using logical operators in contexts where a
3704 bit-wise operator is likely to be expected.
3706 @item -Waggregate-return
3707 @opindex Waggregate-return
3708 @opindex Wno-aggregate-return
3709 Warn if any functions that return structures or unions are defined or
3710 called.  (In languages where you can return an array, this also elicits
3711 a warning.)
3713 @item -Wno-attributes
3714 @opindex Wno-attributes
3715 @opindex Wattributes
3716 Do not warn if an unexpected @code{__attribute__} is used, such as
3717 unrecognized attributes, function attributes applied to variables,
3718 etc.  This will not stop errors for incorrect use of supported
3719 attributes.
3721 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3722 @opindex Wstrict-prototypes
3723 @opindex Wno-strict-prototypes
3724 Warn if a function is declared or defined without specifying the
3725 argument types.  (An old-style function definition is permitted without
3726 a warning if preceded by a declaration which specifies the argument
3727 types.)
3729 @item -Wold-style-declaration @r{(C and Objective-C only)}
3730 @opindex Wold-style-declaration
3731 @opindex Wno-old-style-declaration
3732 Warn for obsolescent usages, according to the C Standard, in a
3733 declaration. For example, warn if storage-class specifiers like
3734 @code{static} are not the first things in a declaration.  This warning
3735 is also enabled by @option{-Wextra}.
3737 @item -Wold-style-definition @r{(C and Objective-C only)}
3738 @opindex Wold-style-definition
3739 @opindex Wno-old-style-definition
3740 Warn if an old-style function definition is used.  A warning is given
3741 even if there is a previous prototype.
3743 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3744 @opindex Wmissing-parameter-type
3745 @opindex Wno-missing-parameter-type
3746 A function parameter is declared without a type specifier in K&R-style
3747 functions:
3749 @smallexample
3750 void foo(bar) @{ @}
3751 @end smallexample
3753 This warning is also enabled by @option{-Wextra}.
3755 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3756 @opindex Wmissing-prototypes
3757 @opindex Wno-missing-prototypes
3758 Warn if a global function is defined without a previous prototype
3759 declaration.  This warning is issued even if the definition itself
3760 provides a prototype.  The aim is to detect global functions that fail
3761 to be declared in header files.
3763 @item -Wmissing-declarations
3764 @opindex Wmissing-declarations
3765 @opindex Wno-missing-declarations
3766 Warn if a global function is defined without a previous declaration.
3767 Do so even if the definition itself provides a prototype.
3768 Use this option to detect global functions that are not declared in
3769 header files.  In C++, no warnings are issued for function templates,
3770 or for inline functions, or for functions in anonymous namespaces.
3772 @item -Wmissing-field-initializers
3773 @opindex Wmissing-field-initializers
3774 @opindex Wno-missing-field-initializers
3775 @opindex W
3776 @opindex Wextra
3777 @opindex Wno-extra
3778 Warn if a structure's initializer has some fields missing.  For
3779 example, the following code would cause such a warning, because
3780 @code{x.h} is implicitly zero:
3782 @smallexample
3783 struct s @{ int f, g, h; @};
3784 struct s x = @{ 3, 4 @};
3785 @end smallexample
3787 This option does not warn about designated initializers, so the following
3788 modification would not trigger a warning:
3790 @smallexample
3791 struct s @{ int f, g, h; @};
3792 struct s x = @{ .f = 3, .g = 4 @};
3793 @end smallexample
3795 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3796 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3798 @item -Wmissing-noreturn
3799 @opindex Wmissing-noreturn
3800 @opindex Wno-missing-noreturn
3801 Warn about functions which might be candidates for attribute @code{noreturn}.
3802 Note these are only possible candidates, not absolute ones.  Care should
3803 be taken to manually verify functions actually do not ever return before
3804 adding the @code{noreturn} attribute, otherwise subtle code generation
3805 bugs could be introduced.  You will not get a warning for @code{main} in
3806 hosted C environments.
3808 @item -Wmissing-format-attribute
3809 @opindex Wmissing-format-attribute
3810 @opindex Wno-missing-format-attribute
3811 @opindex Wformat
3812 @opindex Wno-format
3813 Warn about function pointers which might be candidates for @code{format}
3814 attributes.  Note these are only possible candidates, not absolute ones.
3815 GCC will guess that function pointers with @code{format} attributes that
3816 are used in assignment, initialization, parameter passing or return
3817 statements should have a corresponding @code{format} attribute in the
3818 resulting type.  I.e.@: the left-hand side of the assignment or
3819 initialization, the type of the parameter variable, or the return type
3820 of the containing function respectively should also have a @code{format}
3821 attribute to avoid the warning.
3823 GCC will also warn about function definitions which might be
3824 candidates for @code{format} attributes.  Again, these are only
3825 possible candidates.  GCC will guess that @code{format} attributes
3826 might be appropriate for any function that calls a function like
3827 @code{vprintf} or @code{vscanf}, but this might not always be the
3828 case, and some functions for which @code{format} attributes are
3829 appropriate may not be detected.
3831 @item -Wno-multichar
3832 @opindex Wno-multichar
3833 @opindex Wmultichar
3834 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3835 Usually they indicate a typo in the user's code, as they have
3836 implementation-defined values, and should not be used in portable code.
3838 @item -Wnormalized=<none|id|nfc|nfkc>
3839 @opindex Wnormalized=
3840 @cindex NFC
3841 @cindex NFKC
3842 @cindex character set, input normalization
3843 In ISO C and ISO C++, two identifiers are different if they are
3844 different sequences of characters.  However, sometimes when characters
3845 outside the basic ASCII character set are used, you can have two
3846 different character sequences that look the same.  To avoid confusion,
3847 the ISO 10646 standard sets out some @dfn{normalization rules} which
3848 when applied ensure that two sequences that look the same are turned into
3849 the same sequence.  GCC can warn you if you are using identifiers which
3850 have not been normalized; this option controls that warning.
3852 There are four levels of warning that GCC supports.  The default is
3853 @option{-Wnormalized=nfc}, which warns about any identifier which is
3854 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3855 recommended form for most uses.
3857 Unfortunately, there are some characters which ISO C and ISO C++ allow
3858 in identifiers that when turned into NFC aren't allowable as
3859 identifiers.  That is, there's no way to use these symbols in portable
3860 ISO C or C++ and have all your identifiers in NFC@.
3861 @option{-Wnormalized=id} suppresses the warning for these characters.
3862 It is hoped that future versions of the standards involved will correct
3863 this, which is why this option is not the default.
3865 You can switch the warning off for all characters by writing
3866 @option{-Wnormalized=none}.  You would only want to do this if you
3867 were using some other normalization scheme (like ``D''), because
3868 otherwise you can easily create bugs that are literally impossible to see.
3870 Some characters in ISO 10646 have distinct meanings but look identical
3871 in some fonts or display methodologies, especially once formatting has
3872 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3873 LETTER N'', will display just like a regular @code{n} which has been
3874 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3875 normalization scheme to convert all these into a standard form as
3876 well, and GCC will warn if your code is not in NFKC if you use
3877 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3878 about every identifier that contains the letter O because it might be
3879 confused with the digit 0, and so is not the default, but may be
3880 useful as a local coding convention if the programming environment is
3881 unable to be fixed to display these characters distinctly.
3883 @item -Wno-deprecated
3884 @opindex Wno-deprecated
3885 @opindex Wdeprecated
3886 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3888 @item -Wno-deprecated-declarations
3889 @opindex Wno-deprecated-declarations
3890 @opindex Wdeprecated-declarations
3891 Do not warn about uses of functions (@pxref{Function Attributes}),
3892 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3893 Attributes}) marked as deprecated by using the @code{deprecated}
3894 attribute.
3896 @item -Wno-overflow
3897 @opindex Wno-overflow
3898 @opindex Woverflow
3899 Do not warn about compile-time overflow in constant expressions.
3901 @item -Woverride-init @r{(C and Objective-C only)}
3902 @opindex Woverride-init
3903 @opindex Wno-override-init
3904 @opindex W
3905 @opindex Wextra
3906 @opindex Wno-extra
3907 Warn if an initialized field without side effects is overridden when
3908 using designated initializers (@pxref{Designated Inits, , Designated
3909 Initializers}).
3911 This warning is included in @option{-Wextra}.  To get other
3912 @option{-Wextra} warnings without this one, use @samp{-Wextra
3913 -Wno-override-init}.
3915 @item -Wpacked
3916 @opindex Wpacked
3917 @opindex Wno-packed
3918 Warn if a structure is given the packed attribute, but the packed
3919 attribute has no effect on the layout or size of the structure.
3920 Such structures may be mis-aligned for little benefit.  For
3921 instance, in this code, the variable @code{f.x} in @code{struct bar}
3922 will be misaligned even though @code{struct bar} does not itself
3923 have the packed attribute:
3925 @smallexample
3926 @group
3927 struct foo @{
3928   int x;
3929   char a, b, c, d;
3930 @} __attribute__((packed));
3931 struct bar @{
3932   char z;
3933   struct foo f;
3935 @end group
3936 @end smallexample
3938 @item -Wpadded
3939 @opindex Wpadded
3940 @opindex Wno-padded
3941 Warn if padding is included in a structure, either to align an element
3942 of the structure or to align the whole structure.  Sometimes when this
3943 happens it is possible to rearrange the fields of the structure to
3944 reduce the padding and so make the structure smaller.
3946 @item -Wredundant-decls
3947 @opindex Wredundant-decls
3948 @opindex Wno-redundant-decls
3949 Warn if anything is declared more than once in the same scope, even in
3950 cases where multiple declaration is valid and changes nothing.
3952 @item -Wnested-externs @r{(C and Objective-C only)}
3953 @opindex Wnested-externs
3954 @opindex Wno-nested-externs
3955 Warn if an @code{extern} declaration is encountered within a function.
3957 @item -Wunreachable-code
3958 @opindex Wunreachable-code
3959 @opindex Wno-unreachable-code
3960 Warn if the compiler detects that code will never be executed.
3962 This option is intended to warn when the compiler detects that at
3963 least a whole line of source code will never be executed, because
3964 some condition is never satisfied or because it is after a
3965 procedure that never returns.
3967 It is possible for this option to produce a warning even though there
3968 are circumstances under which part of the affected line can be executed,
3969 so care should be taken when removing apparently-unreachable code.
3971 For instance, when a function is inlined, a warning may mean that the
3972 line is unreachable in only one inlined copy of the function.
3974 This option is not made part of @option{-Wall} because in a debugging
3975 version of a program there is often substantial code which checks
3976 correct functioning of the program and is, hopefully, unreachable
3977 because the program does work.  Another common use of unreachable
3978 code is to provide behavior which is selectable at compile-time.
3980 @item -Winline
3981 @opindex Winline
3982 @opindex Wno-inline
3983 Warn if a function can not be inlined and it was declared as inline.
3984 Even with this option, the compiler will not warn about failures to
3985 inline functions declared in system headers.
3987 The compiler uses a variety of heuristics to determine whether or not
3988 to inline a function.  For example, the compiler takes into account
3989 the size of the function being inlined and the amount of inlining
3990 that has already been done in the current function.  Therefore,
3991 seemingly insignificant changes in the source program can cause the
3992 warnings produced by @option{-Winline} to appear or disappear.
3994 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
3995 @opindex Wno-invalid-offsetof
3996 @opindex Winvalid-offsetof
3997 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3998 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3999 to a non-POD type is undefined.  In existing C++ implementations,
4000 however, @samp{offsetof} typically gives meaningful results even when
4001 applied to certain kinds of non-POD types. (Such as a simple
4002 @samp{struct} that fails to be a POD type only by virtue of having a
4003 constructor.)  This flag is for users who are aware that they are
4004 writing nonportable code and who have deliberately chosen to ignore the
4005 warning about it.
4007 The restrictions on @samp{offsetof} may be relaxed in a future version
4008 of the C++ standard.
4010 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4011 @opindex Wno-int-to-pointer-cast
4012 @opindex Wint-to-pointer-cast
4013 Suppress warnings from casts to pointer type of an integer of a
4014 different size.
4016 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4017 @opindex Wno-pointer-to-int-cast
4018 @opindex Wpointer-to-int-cast
4019 Suppress warnings from casts from a pointer to an integer type of a
4020 different size.
4022 @item -Winvalid-pch
4023 @opindex Winvalid-pch
4024 @opindex Wno-invalid-pch
4025 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4026 the search path but can't be used.
4028 @item -Wlong-long
4029 @opindex Wlong-long
4030 @opindex Wno-long-long
4031 Warn if @samp{long long} type is used.  This is default.  To inhibit
4032 the warning messages, use @option{-Wno-long-long}.  Flags
4033 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4034 only when @option{-pedantic} flag is used.
4036 @item -Wvariadic-macros
4037 @opindex Wvariadic-macros
4038 @opindex Wno-variadic-macros
4039 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4040 alternate syntax when in pedantic ISO C99 mode.  This is default.
4041 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4043 @item -Wvla
4044 @opindex Wvla
4045 @opindex Wno-vla
4046 Warn if variable length array is used in the code.
4047 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4048 the variable length array.
4050 @item -Wvolatile-register-var
4051 @opindex Wvolatile-register-var
4052 @opindex Wno-volatile-register-var
4053 Warn if a register variable is declared volatile.  The volatile
4054 modifier does not inhibit all optimizations that may eliminate reads
4055 and/or writes to register variables.  This warning is enabled by
4056 @option{-Wall}.
4058 @item -Wdisabled-optimization
4059 @opindex Wdisabled-optimization
4060 @opindex Wno-disabled-optimization
4061 Warn if a requested optimization pass is disabled.  This warning does
4062 not generally indicate that there is anything wrong with your code; it
4063 merely indicates that GCC's optimizers were unable to handle the code
4064 effectively.  Often, the problem is that your code is too big or too
4065 complex; GCC will refuse to optimize programs when the optimization
4066 itself is likely to take inordinate amounts of time.
4068 @item -Wpointer-sign @r{(C and Objective-C only)}
4069 @opindex Wpointer-sign
4070 @opindex Wno-pointer-sign
4071 Warn for pointer argument passing or assignment with different signedness.
4072 This option is only supported for C and Objective-C@.  It is implied by
4073 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4074 @option{-Wno-pointer-sign}.
4076 @item -Wstack-protector
4077 @opindex Wstack-protector
4078 @opindex Wno-stack-protector
4079 This option is only active when @option{-fstack-protector} is active.  It
4080 warns about functions that will not be protected against stack smashing.
4082 @item -Wno-mudflap
4083 @opindex Wno-mudflap
4084 Suppress warnings about constructs that cannot be instrumented by
4085 @option{-fmudflap}.
4087 @item -Woverlength-strings
4088 @opindex Woverlength-strings
4089 @opindex Wno-overlength-strings
4090 Warn about string constants which are longer than the ``minimum
4091 maximum'' length specified in the C standard.  Modern compilers
4092 generally allow string constants which are much longer than the
4093 standard's minimum limit, but very portable programs should avoid
4094 using longer strings.
4096 The limit applies @emph{after} string constant concatenation, and does
4097 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4098 C99, it was raised to 4095.  C++98 does not specify a normative
4099 minimum maximum, so we do not diagnose overlength strings in C++@.
4101 This option is implied by @option{-pedantic}, and can be disabled with
4102 @option{-Wno-overlength-strings}.
4103 @end table
4105 @node Debugging Options
4106 @section Options for Debugging Your Program or GCC
4107 @cindex options, debugging
4108 @cindex debugging information options
4110 GCC has various special options that are used for debugging
4111 either your program or GCC:
4113 @table @gcctabopt
4114 @item -g
4115 @opindex g
4116 Produce debugging information in the operating system's native format
4117 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4118 information.
4120 On most systems that use stabs format, @option{-g} enables use of extra
4121 debugging information that only GDB can use; this extra information
4122 makes debugging work better in GDB but will probably make other debuggers
4123 crash or
4124 refuse to read the program.  If you want to control for certain whether
4125 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4126 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4128 GCC allows you to use @option{-g} with
4129 @option{-O}.  The shortcuts taken by optimized code may occasionally
4130 produce surprising results: some variables you declared may not exist
4131 at all; flow of control may briefly move where you did not expect it;
4132 some statements may not be executed because they compute constant
4133 results or their values were already at hand; some statements may
4134 execute in different places because they were moved out of loops.
4136 Nevertheless it proves possible to debug optimized output.  This makes
4137 it reasonable to use the optimizer for programs that might have bugs.
4139 The following options are useful when GCC is generated with the
4140 capability for more than one debugging format.
4142 @item -ggdb
4143 @opindex ggdb
4144 Produce debugging information for use by GDB@.  This means to use the
4145 most expressive format available (DWARF 2, stabs, or the native format
4146 if neither of those are supported), including GDB extensions if at all
4147 possible.
4149 @item -gstabs
4150 @opindex gstabs
4151 Produce debugging information in stabs format (if that is supported),
4152 without GDB extensions.  This is the format used by DBX on most BSD
4153 systems.  On MIPS, Alpha and System V Release 4 systems this option
4154 produces stabs debugging output which is not understood by DBX or SDB@.
4155 On System V Release 4 systems this option requires the GNU assembler.
4157 @item -feliminate-unused-debug-symbols
4158 @opindex feliminate-unused-debug-symbols
4159 Produce debugging information in stabs format (if that is supported),
4160 for only symbols that are actually used.
4162 @item -femit-class-debug-always
4163 Instead of emitting debugging information for a C++ class in only one
4164 object file, emit it in all object files using the class.  This option
4165 should be used only with debuggers that are unable to handle the way GCC
4166 normally emits debugging information for classes because using this
4167 option will increase the size of debugging information by as much as a
4168 factor of two.
4170 @item -gstabs+
4171 @opindex gstabs+
4172 Produce debugging information in stabs format (if that is supported),
4173 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4174 use of these extensions is likely to make other debuggers crash or
4175 refuse to read the program.
4177 @item -gcoff
4178 @opindex gcoff
4179 Produce debugging information in COFF format (if that is supported).
4180 This is the format used by SDB on most System V systems prior to
4181 System V Release 4.
4183 @item -gxcoff
4184 @opindex gxcoff
4185 Produce debugging information in XCOFF format (if that is supported).
4186 This is the format used by the DBX debugger on IBM RS/6000 systems.
4188 @item -gxcoff+
4189 @opindex gxcoff+
4190 Produce debugging information in XCOFF format (if that is supported),
4191 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4192 use of these extensions is likely to make other debuggers crash or
4193 refuse to read the program, and may cause assemblers other than the GNU
4194 assembler (GAS) to fail with an error.
4196 @item -gdwarf-2
4197 @opindex gdwarf-2
4198 Produce debugging information in DWARF version 2 format (if that is
4199 supported).  This is the format used by DBX on IRIX 6.  With this
4200 option, GCC uses features of DWARF version 3 when they are useful;
4201 version 3 is upward compatible with version 2, but may still cause
4202 problems for older debuggers.
4204 @item -gvms
4205 @opindex gvms
4206 Produce debugging information in VMS debug format (if that is
4207 supported).  This is the format used by DEBUG on VMS systems.
4209 @item -g@var{level}
4210 @itemx -ggdb@var{level}
4211 @itemx -gstabs@var{level}
4212 @itemx -gcoff@var{level}
4213 @itemx -gxcoff@var{level}
4214 @itemx -gvms@var{level}
4215 Request debugging information and also use @var{level} to specify how
4216 much information.  The default level is 2.
4218 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4219 @option{-g}.
4221 Level 1 produces minimal information, enough for making backtraces in
4222 parts of the program that you don't plan to debug.  This includes
4223 descriptions of functions and external variables, but no information
4224 about local variables and no line numbers.
4226 Level 3 includes extra information, such as all the macro definitions
4227 present in the program.  Some debuggers support macro expansion when
4228 you use @option{-g3}.
4230 @option{-gdwarf-2} does not accept a concatenated debug level, because
4231 GCC used to support an option @option{-gdwarf} that meant to generate
4232 debug information in version 1 of the DWARF format (which is very
4233 different from version 2), and it would have been too confusing.  That
4234 debug format is long obsolete, but the option cannot be changed now.
4235 Instead use an additional @option{-g@var{level}} option to change the
4236 debug level for DWARF2.
4238 @item -feliminate-dwarf2-dups
4239 @opindex feliminate-dwarf2-dups
4240 Compress DWARF2 debugging information by eliminating duplicated
4241 information about each symbol.  This option only makes sense when
4242 generating DWARF2 debugging information with @option{-gdwarf-2}.
4244 @item -femit-struct-debug-baseonly
4245 Emit debug information for struct-like types
4246 only when the base name of the compilation source file
4247 matches the base name of file in which the struct was defined.
4249 This option substantially reduces the size of debugging information,
4250 but at significant potential loss in type information to the debugger.
4251 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4252 See @option{-femit-struct-debug-detailed} for more detailed control.
4254 This option works only with DWARF 2.
4256 @item -femit-struct-debug-reduced
4257 Emit debug information for struct-like types
4258 only when the base name of the compilation source file
4259 matches the base name of file in which the type was defined,
4260 unless the struct is a template or defined in a system header.
4262 This option significantly reduces the size of debugging information,
4263 with some potential loss in type information to the debugger.
4264 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4265 See @option{-femit-struct-debug-detailed} for more detailed control.
4267 This option works only with DWARF 2.
4269 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4270 Specify the struct-like types
4271 for which the compiler will generate debug information.
4272 The intent is to reduce duplicate struct debug information
4273 between different object files within the same program.
4275 This option is a detailed version of
4276 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4277 which will serve for most needs.
4279 A specification has the syntax
4280 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4282 The optional first word limits the specification to
4283 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4284 A struct type is used directly when it is the type of a variable, member.
4285 Indirect uses arise through pointers to structs.
4286 That is, when use of an incomplete struct would be legal, the use is indirect.
4287 An example is
4288 @samp{struct one direct; struct two * indirect;}.
4290 The optional second word limits the specification to
4291 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4292 Generic structs are a bit complicated to explain.
4293 For C++, these are non-explicit specializations of template classes,
4294 or non-template classes within the above.
4295 Other programming languages have generics,
4296 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4298 The third word specifies the source files for those
4299 structs for which the compiler will emit debug information.
4300 The values @samp{none} and @samp{any} have the normal meaning.
4301 The value @samp{base} means that
4302 the base of name of the file in which the type declaration appears
4303 must match the base of the name of the main compilation file.
4304 In practice, this means that
4305 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4306 but types declared in other header will not.
4307 The value @samp{sys} means those types satisfying @samp{base}
4308 or declared in system or compiler headers.
4310 You may need to experiment to determine the best settings for your application.
4312 The default is @samp{-femit-struct-debug-detailed=all}.
4314 This option works only with DWARF 2.
4316 @item -fno-merge-debug-strings
4317 @opindex fmerge-debug-strings
4318 @opindex fno-merge-debug-strings
4319 Direct the linker to merge together strings which are identical in
4320 different object files.  This is not supported by all assemblers or
4321 linker.  This decreases the size of the debug information in the
4322 output file at the cost of increasing link processing time.  This is
4323 on by default.
4325 @item -fdebug-prefix-map=@var{old}=@var{new}
4326 @opindex fdebug-prefix-map
4327 When compiling files in directory @file{@var{old}}, record debugging
4328 information describing them as in @file{@var{new}} instead.
4330 @cindex @command{prof}
4331 @item -p
4332 @opindex p
4333 Generate extra code to write profile information suitable for the
4334 analysis program @command{prof}.  You must use this option when compiling
4335 the source files you want data about, and you must also use it when
4336 linking.
4338 @cindex @command{gprof}
4339 @item -pg
4340 @opindex pg
4341 Generate extra code to write profile information suitable for the
4342 analysis program @command{gprof}.  You must use this option when compiling
4343 the source files you want data about, and you must also use it when
4344 linking.
4346 @item -Q
4347 @opindex Q
4348 Makes the compiler print out each function name as it is compiled, and
4349 print some statistics about each pass when it finishes.
4351 @item -ftime-report
4352 @opindex ftime-report
4353 Makes the compiler print some statistics about the time consumed by each
4354 pass when it finishes.
4356 @item -fmem-report
4357 @opindex fmem-report
4358 Makes the compiler print some statistics about permanent memory
4359 allocation when it finishes.
4361 @item -fpre-ipa-mem-report
4362 @opindex fpre-ipa-mem-report
4363 @item -fpost-ipa-mem-report
4364 @opindex fpost-ipa-mem-report
4365 Makes the compiler print some statistics about permanent memory
4366 allocation before or after interprocedural optimization.
4368 @item -fprofile-arcs
4369 @opindex fprofile-arcs
4370 Add code so that program flow @dfn{arcs} are instrumented.  During
4371 execution the program records how many times each branch and call is
4372 executed and how many times it is taken or returns.  When the compiled
4373 program exits it saves this data to a file called
4374 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4375 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4376 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4377 @var{auxname} is generated from the name of the output file, if
4378 explicitly specified and it is not the final executable, otherwise it is
4379 the basename of the source file.  In both cases any suffix is removed
4380 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4381 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4382 @xref{Cross-profiling}.
4384 @cindex @command{gcov}
4385 @item --coverage
4386 @opindex coverage
4388 This option is used to compile and link code instrumented for coverage
4389 analysis.  The option is a synonym for @option{-fprofile-arcs}
4390 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4391 linking).  See the documentation for those options for more details.
4393 @itemize
4395 @item
4396 Compile the source files with @option{-fprofile-arcs} plus optimization
4397 and code generation options.  For test coverage analysis, use the
4398 additional @option{-ftest-coverage} option.  You do not need to profile
4399 every source file in a program.
4401 @item
4402 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4403 (the latter implies the former).
4405 @item
4406 Run the program on a representative workload to generate the arc profile
4407 information.  This may be repeated any number of times.  You can run
4408 concurrent instances of your program, and provided that the file system
4409 supports locking, the data files will be correctly updated.  Also
4410 @code{fork} calls are detected and correctly handled (double counting
4411 will not happen).
4413 @item
4414 For profile-directed optimizations, compile the source files again with
4415 the same optimization and code generation options plus
4416 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4417 Control Optimization}).
4419 @item
4420 For test coverage analysis, use @command{gcov} to produce human readable
4421 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4422 @command{gcov} documentation for further information.
4424 @end itemize
4426 With @option{-fprofile-arcs}, for each function of your program GCC
4427 creates a program flow graph, then finds a spanning tree for the graph.
4428 Only arcs that are not on the spanning tree have to be instrumented: the
4429 compiler adds code to count the number of times that these arcs are
4430 executed.  When an arc is the only exit or only entrance to a block, the
4431 instrumentation code can be added to the block; otherwise, a new basic
4432 block must be created to hold the instrumentation code.
4434 @need 2000
4435 @item -ftest-coverage
4436 @opindex ftest-coverage
4437 Produce a notes file that the @command{gcov} code-coverage utility
4438 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4439 show program coverage.  Each source file's note file is called
4440 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4441 above for a description of @var{auxname} and instructions on how to
4442 generate test coverage data.  Coverage data will match the source files
4443 more closely, if you do not optimize.
4445 @item -fdbg-cnt-list
4446 @opindex fdbg-cnt-list
4447 Print the name and the counter upperbound for all debug counters.
4449 @item -fdbg-cnt=@var{counter-value-list}
4450 @opindex fdbg-cnt
4451 Set the internal debug counter upperbound. @var{counter-value-list} 
4452 is a comma-separated list of @var{name}:@var{value} pairs
4453 which sets the upperbound of each debug counter @var{name} to @var{value}.
4454 All debug counters have the initial upperbound of @var{UINT_MAX},
4455 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4456 e.g. With -fdbg-cnt=dce:10,tail_call:0
4457 dbg_cnt(dce) will return true only for first 10 invocations
4458 and dbg_cnt(tail_call) will return false always.
4460 @item -d@var{letters}
4461 @itemx -fdump-rtl-@var{pass}
4462 @opindex d
4463 Says to make debugging dumps during compilation at times specified by
4464 @var{letters}.    This is used for debugging the RTL-based passes of the
4465 compiler.  The file names for most of the dumps are made by appending a
4466 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4467 from the name of the output file, if explicitly specified and it is not
4468 an executable, otherwise it is the basename of the source file. These
4469 switches may have different effects when @option{-E} is used for
4470 preprocessing.
4472 Most debug dumps can be enabled either passing a letter to the @option{-d}
4473 option, or with a long @option{-fdump-rtl} switch; here are the possible
4474 letters for use in @var{letters} and @var{pass}, and their meanings:
4476 @table @gcctabopt
4477 @item -dA
4478 @opindex dA
4479 Annotate the assembler output with miscellaneous debugging information.
4481 @item -fdump-rtl-bbro
4482 @opindex fdump-rtl-bbro
4483 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4485 @item -fdump-rtl-combine
4486 @opindex fdump-rtl-combine
4487 Dump after the RTL instruction combination pass, to the file
4488 @file{@var{file}.129r.combine}.
4490 @item -fdump-rtl-ce1
4491 @itemx -fdump-rtl-ce2
4492 @opindex fdump-rtl-ce1
4493 @opindex fdump-rtl-ce2
4494 @option{-fdump-rtl-ce1} enable dumping after the
4495 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4496 @option{-fdump-rtl-ce2} enable dumping after the second if
4497 conversion, to the file @file{@var{file}.130r.ce2}.
4499 @item -fdump-rtl-btl
4500 @itemx -fdump-rtl-dbr
4501 @opindex fdump-rtl-btl
4502 @opindex fdump-rtl-dbr
4503 @option{-fdump-rtl-btl} enable dumping after branch
4504 target load optimization, to @file{@var{file}.31.btl}.  
4505 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4506 scheduling, to @file{@var{file}.36.dbr}.
4508 @item -dD
4509 @opindex dD
4510 Dump all macro definitions, at the end of preprocessing, in addition to
4511 normal output.
4513 @item -fdump-rtl-ce3
4514 @opindex fdump-rtl-ce3
4515 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4517 @item -fdump-rtl-cfg
4518 @itemx -fdump-rtl-life
4519 @opindex fdump-rtl-cfg
4520 @opindex fdump-rtl-life
4521 @option{-fdump-rtl-cfg} enable dumping after control
4522 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4523 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4524 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4526 @item -fdump-rtl-greg
4527 @opindex fdump-rtl-greg
4528 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4530 @item -fdump-rtl-gcse
4531 @itemx -fdump-rtl-bypass
4532 @opindex fdump-rtl-gcse
4533 @opindex fdump-rtl-bypass
4534 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4535 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4536 enable dumping after jump bypassing and control flow optimizations, to
4537 @file{@var{file}.115r.bypass}.
4539 @item -fdump-rtl-eh
4540 @opindex fdump-rtl-eh
4541 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4543 @item -fdump-rtl-sibling
4544 @opindex fdump-rtl-sibling
4545 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4547 @item -fdump-rtl-jump
4548 @opindex fdump-rtl-jump
4549 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4551 @item -fdump-rtl-stack
4552 @opindex fdump-rtl-stack
4553 Dump after conversion from GCC's "flat register file" registers to the
4554 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4556 @item -fdump-rtl-lreg
4557 @opindex fdump-rtl-lreg
4558 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4560 @item -fdump-rtl-loop2
4561 @opindex fdump-rtl-loop2
4562 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4563 loop optimization pass, to @file{@var{file}.119r.loop2},
4564 @file{@var{file}.120r.loop2_init},
4565 @file{@var{file}.121r.loop2_invariant}, and
4566 @file{@var{file}.125r.loop2_done}.
4568 @item -fdump-rtl-sms
4569 @opindex fdump-rtl-sms
4570 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4572 @item -fdump-rtl-mach
4573 @opindex fdump-rtl-mach
4574 Dump after performing the machine dependent reorganization pass, to
4575 @file{@var{file}.155r.mach} if that pass exists.
4577 @item -fdump-rtl-rnreg
4578 @opindex fdump-rtl-rnreg
4579 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4581 @item -fdump-rtl-regmove
4582 @opindex fdump-rtl-regmove
4583 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4585 @item -fdump-rtl-postreload
4586 @opindex fdump-rtl-postreload
4587 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4589 @item -fdump-rtl-expand
4590 @opindex fdump-rtl-expand
4591 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4593 @item -fdump-rtl-sched2
4594 @opindex fdump-rtl-sched2
4595 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4597 @item -fdump-rtl-cse
4598 @opindex fdump-rtl-cse
4599 Dump after CSE (including the jump optimization that sometimes follows
4600 CSE), to @file{@var{file}.113r.cse}.
4602 @item -fdump-rtl-sched1
4603 @opindex fdump-rtl-sched1
4604 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4606 @item -fdump-rtl-cse2
4607 @opindex fdump-rtl-cse2
4608 Dump after the second CSE pass (including the jump optimization that
4609 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4611 @item -fdump-rtl-tracer
4612 @opindex fdump-rtl-tracer
4613 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4615 @item -fdump-rtl-vpt
4616 @itemx -fdump-rtl-vartrack
4617 @opindex fdump-rtl-vpt
4618 @opindex fdump-rtl-vartrack
4619 @option{-fdump-rtl-vpt} enable dumping after the value
4620 profile transformations, to @file{@var{file}.10.vpt}.
4621 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4622 to @file{@var{file}.154r.vartrack}.
4624 @item -fdump-rtl-flow2
4625 @opindex fdump-rtl-flow2
4626 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4628 @item -fdump-rtl-peephole2
4629 @opindex fdump-rtl-peephole2
4630 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4632 @item -fdump-rtl-web
4633 @opindex fdump-rtl-web
4634 Dump after live range splitting, to @file{@var{file}.126r.web}.
4636 @item -fdump-rtl-all
4637 @opindex fdump-rtl-all
4638 Produce all the dumps listed above.
4640 @item -dH
4641 @opindex dH
4642 Produce a core dump whenever an error occurs.
4644 @item -dm
4645 @opindex dm
4646 Print statistics on memory usage, at the end of the run, to
4647 standard error.
4649 @item -dp
4650 @opindex dp
4651 Annotate the assembler output with a comment indicating which
4652 pattern and alternative was used.  The length of each instruction is
4653 also printed.
4655 @item -dP
4656 @opindex dP
4657 Dump the RTL in the assembler output as a comment before each instruction.
4658 Also turns on @option{-dp} annotation.
4660 @item -dv
4661 @opindex dv
4662 For each of the other indicated dump files (either with @option{-d} or
4663 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4664 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4666 @item -dx
4667 @opindex dx
4668 Just generate RTL for a function instead of compiling it.  Usually used
4669 with @samp{r} (@option{-fdump-rtl-expand}).
4671 @item -dy
4672 @opindex dy
4673 Dump debugging information during parsing, to standard error.
4674 @end table
4676 @item -fdump-noaddr
4677 @opindex fdump-noaddr
4678 When doing debugging dumps (see @option{-d} option above), suppress
4679 address output.  This makes it more feasible to use diff on debugging
4680 dumps for compiler invocations with different compiler binaries and/or
4681 different text / bss / data / heap / stack / dso start locations.
4683 @item -fdump-unnumbered
4684 @opindex fdump-unnumbered
4685 When doing debugging dumps (see @option{-d} option above), suppress instruction
4686 numbers and address output.  This makes it more feasible to
4687 use diff on debugging dumps for compiler invocations with different
4688 options, in particular with and without @option{-g}.
4690 @item -fdump-translation-unit @r{(C++ only)}
4691 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4692 @opindex fdump-translation-unit
4693 Dump a representation of the tree structure for the entire translation
4694 unit to a file.  The file name is made by appending @file{.tu} to the
4695 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4696 controls the details of the dump as described for the
4697 @option{-fdump-tree} options.
4699 @item -fdump-class-hierarchy @r{(C++ only)}
4700 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4701 @opindex fdump-class-hierarchy
4702 Dump a representation of each class's hierarchy and virtual function
4703 table layout to a file.  The file name is made by appending @file{.class}
4704 to the source file name.  If the @samp{-@var{options}} form is used,
4705 @var{options} controls the details of the dump as described for the
4706 @option{-fdump-tree} options.
4708 @item -fdump-ipa-@var{switch}
4709 @opindex fdump-ipa
4710 Control the dumping at various stages of inter-procedural analysis
4711 language tree to a file.  The file name is generated by appending a switch
4712 specific suffix to the source file name.  The following dumps are possible:
4714 @table @samp
4715 @item all
4716 Enables all inter-procedural analysis dumps.
4718 @item cgraph
4719 Dumps information about call-graph optimization, unused function removal,
4720 and inlining decisions.
4722 @item inline
4723 Dump after function inlining.
4725 @end table
4727 @item -fdump-statistics-@var{option}
4728 @opindex -fdump-statistics
4729 Enable and control dumping of pass statistics in a separate file.  The
4730 file name is generated by appending a suffix ending in @samp{.statistics}
4731 to the source file name.  If the @samp{-@var{option}} form is used,
4732 @samp{-stats} will cause counters to be summed over the whole compilation unit
4733 while @samp{-details} will dump every event as the passes generate them.
4734 The default with no option is to sum counters for each function compiled.
4736 @item -fdump-tree-@var{switch}
4737 @itemx -fdump-tree-@var{switch}-@var{options}
4738 @opindex fdump-tree
4739 Control the dumping at various stages of processing the intermediate
4740 language tree to a file.  The file name is generated by appending a switch
4741 specific suffix to the source file name.  If the @samp{-@var{options}}
4742 form is used, @var{options} is a list of @samp{-} separated options that
4743 control the details of the dump.  Not all options are applicable to all
4744 dumps, those which are not meaningful will be ignored.  The following
4745 options are available
4747 @table @samp
4748 @item address
4749 Print the address of each node.  Usually this is not meaningful as it
4750 changes according to the environment and source file.  Its primary use
4751 is for tying up a dump file with a debug environment.
4752 @item slim
4753 Inhibit dumping of members of a scope or body of a function merely
4754 because that scope has been reached.  Only dump such items when they
4755 are directly reachable by some other path.  When dumping pretty-printed
4756 trees, this option inhibits dumping the bodies of control structures.
4757 @item raw
4758 Print a raw representation of the tree.  By default, trees are
4759 pretty-printed into a C-like representation.
4760 @item details
4761 Enable more detailed dumps (not honored by every dump option).
4762 @item stats
4763 Enable dumping various statistics about the pass (not honored by every dump
4764 option).
4765 @item blocks
4766 Enable showing basic block boundaries (disabled in raw dumps).
4767 @item vops
4768 Enable showing virtual operands for every statement.
4769 @item lineno
4770 Enable showing line numbers for statements.
4771 @item uid
4772 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4773 @item verbose
4774 Enable showing the tree dump for each statement.
4775 @item all
4776 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4777 and @option{lineno}.
4778 @end table
4780 The following tree dumps are possible:
4781 @table @samp
4783 @item original
4784 Dump before any tree based optimization, to @file{@var{file}.original}.
4786 @item optimized
4787 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4789 @item gimple
4790 @opindex fdump-tree-gimple
4791 Dump each function before and after the gimplification pass to a file.  The
4792 file name is made by appending @file{.gimple} to the source file name.
4794 @item cfg
4795 @opindex fdump-tree-cfg
4796 Dump the control flow graph of each function to a file.  The file name is
4797 made by appending @file{.cfg} to the source file name.
4799 @item vcg
4800 @opindex fdump-tree-vcg
4801 Dump the control flow graph of each function to a file in VCG format.  The
4802 file name is made by appending @file{.vcg} to the source file name.  Note
4803 that if the file contains more than one function, the generated file cannot
4804 be used directly by VCG@.  You will need to cut and paste each function's
4805 graph into its own separate file first.
4807 @item ch
4808 @opindex fdump-tree-ch
4809 Dump each function after copying loop headers.  The file name is made by
4810 appending @file{.ch} to the source file name.
4812 @item ssa
4813 @opindex fdump-tree-ssa
4814 Dump SSA related information to a file.  The file name is made by appending
4815 @file{.ssa} to the source file name.
4817 @item alias
4818 @opindex fdump-tree-alias
4819 Dump aliasing information for each function.  The file name is made by
4820 appending @file{.alias} to the source file name.
4822 @item ccp
4823 @opindex fdump-tree-ccp
4824 Dump each function after CCP@.  The file name is made by appending
4825 @file{.ccp} to the source file name.
4827 @item storeccp
4828 @opindex fdump-tree-storeccp
4829 Dump each function after STORE-CCP@.  The file name is made by appending
4830 @file{.storeccp} to the source file name.
4832 @item pre
4833 @opindex fdump-tree-pre
4834 Dump trees after partial redundancy elimination.  The file name is made
4835 by appending @file{.pre} to the source file name.
4837 @item fre
4838 @opindex fdump-tree-fre
4839 Dump trees after full redundancy elimination.  The file name is made
4840 by appending @file{.fre} to the source file name.
4842 @item copyprop
4843 @opindex fdump-tree-copyprop
4844 Dump trees after copy propagation.  The file name is made
4845 by appending @file{.copyprop} to the source file name.
4847 @item store_copyprop
4848 @opindex fdump-tree-store_copyprop
4849 Dump trees after store copy-propagation.  The file name is made
4850 by appending @file{.store_copyprop} to the source file name.
4852 @item dce
4853 @opindex fdump-tree-dce
4854 Dump each function after dead code elimination.  The file name is made by
4855 appending @file{.dce} to the source file name.
4857 @item mudflap
4858 @opindex fdump-tree-mudflap
4859 Dump each function after adding mudflap instrumentation.  The file name is
4860 made by appending @file{.mudflap} to the source file name.
4862 @item sra
4863 @opindex fdump-tree-sra
4864 Dump each function after performing scalar replacement of aggregates.  The
4865 file name is made by appending @file{.sra} to the source file name.
4867 @item sink
4868 @opindex fdump-tree-sink
4869 Dump each function after performing code sinking.  The file name is made
4870 by appending @file{.sink} to the source file name.
4872 @item dom
4873 @opindex fdump-tree-dom
4874 Dump each function after applying dominator tree optimizations.  The file
4875 name is made by appending @file{.dom} to the source file name.
4877 @item dse
4878 @opindex fdump-tree-dse
4879 Dump each function after applying dead store elimination.  The file
4880 name is made by appending @file{.dse} to the source file name.
4882 @item phiopt
4883 @opindex fdump-tree-phiopt
4884 Dump each function after optimizing PHI nodes into straightline code.  The file
4885 name is made by appending @file{.phiopt} to the source file name.
4887 @item forwprop
4888 @opindex fdump-tree-forwprop
4889 Dump each function after forward propagating single use variables.  The file
4890 name is made by appending @file{.forwprop} to the source file name.
4892 @item copyrename
4893 @opindex fdump-tree-copyrename
4894 Dump each function after applying the copy rename optimization.  The file
4895 name is made by appending @file{.copyrename} to the source file name.
4897 @item nrv
4898 @opindex fdump-tree-nrv
4899 Dump each function after applying the named return value optimization on
4900 generic trees.  The file name is made by appending @file{.nrv} to the source
4901 file name.
4903 @item vect
4904 @opindex fdump-tree-vect
4905 Dump each function after applying vectorization of loops.  The file name is
4906 made by appending @file{.vect} to the source file name.
4908 @item vrp
4909 @opindex fdump-tree-vrp
4910 Dump each function after Value Range Propagation (VRP).  The file name
4911 is made by appending @file{.vrp} to the source file name.
4913 @item all
4914 @opindex fdump-tree-all
4915 Enable all the available tree dumps with the flags provided in this option.
4916 @end table
4918 @item -ftree-vectorizer-verbose=@var{n}
4919 @opindex ftree-vectorizer-verbose
4920 This option controls the amount of debugging output the vectorizer prints.
4921 This information is written to standard error, unless
4922 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4923 in which case it is output to the usual dump listing file, @file{.vect}.
4924 For @var{n}=0 no diagnostic information is reported.
4925 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4926 and the total number of loops that got vectorized.
4927 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4928 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4929 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4930 level that @option{-fdump-tree-vect-stats} uses.
4931 Higher verbosity levels mean either more information dumped for each
4932 reported loop, or same amount of information reported for more loops:
4933 If @var{n}=3, alignment related information is added to the reports.
4934 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4935 memory access-patterns) is added to the reports.
4936 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4937 that did not pass the first analysis phase (i.e., may not be countable, or
4938 may have complicated control-flow).
4939 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4940 For @var{n}=7, all the information the vectorizer generates during its
4941 analysis and transformation is reported.  This is the same verbosity level
4942 that @option{-fdump-tree-vect-details} uses.
4944 @item -frandom-seed=@var{string}
4945 @opindex frandom-string
4946 This option provides a seed that GCC uses when it would otherwise use
4947 random numbers.  It is used to generate certain symbol names
4948 that have to be different in every compiled file.  It is also used to
4949 place unique stamps in coverage data files and the object files that
4950 produce them.  You can use the @option{-frandom-seed} option to produce
4951 reproducibly identical object files.
4953 The @var{string} should be different for every file you compile.
4955 @item -fsched-verbose=@var{n}
4956 @opindex fsched-verbose
4957 On targets that use instruction scheduling, this option controls the
4958 amount of debugging output the scheduler prints.  This information is
4959 written to standard error, unless @option{-dS} or @option{-dR} is
4960 specified, in which case it is output to the usual dump
4961 listing file, @file{.sched} or @file{.sched2} respectively.  However
4962 for @var{n} greater than nine, the output is always printed to standard
4963 error.
4965 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4966 same information as @option{-dRS}.  For @var{n} greater than one, it
4967 also output basic block probabilities, detailed ready list information
4968 and unit/insn info.  For @var{n} greater than two, it includes RTL
4969 at abort point, control-flow and regions info.  And for @var{n} over
4970 four, @option{-fsched-verbose} also includes dependence info.
4972 @item -save-temps
4973 @opindex save-temps
4974 Store the usual ``temporary'' intermediate files permanently; place them
4975 in the current directory and name them based on the source file.  Thus,
4976 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4977 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4978 preprocessed @file{foo.i} output file even though the compiler now
4979 normally uses an integrated preprocessor.
4981 When used in combination with the @option{-x} command line option,
4982 @option{-save-temps} is sensible enough to avoid over writing an
4983 input source file with the same extension as an intermediate file.
4984 The corresponding intermediate file may be obtained by renaming the
4985 source file before using @option{-save-temps}.
4987 @item -time
4988 @opindex time
4989 Report the CPU time taken by each subprocess in the compilation
4990 sequence.  For C source files, this is the compiler proper and assembler
4991 (plus the linker if linking is done).  The output looks like this:
4993 @smallexample
4994 # cc1 0.12 0.01
4995 # as 0.00 0.01
4996 @end smallexample
4998 The first number on each line is the ``user time'', that is time spent
4999 executing the program itself.  The second number is ``system time'',
5000 time spent executing operating system routines on behalf of the program.
5001 Both numbers are in seconds.
5003 @item -fvar-tracking
5004 @opindex fvar-tracking
5005 Run variable tracking pass.  It computes where variables are stored at each
5006 position in code.  Better debugging information is then generated
5007 (if the debugging information format supports this information).
5009 It is enabled by default when compiling with optimization (@option{-Os},
5010 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5011 the debug info format supports it.
5013 @item -print-file-name=@var{library}
5014 @opindex print-file-name
5015 Print the full absolute name of the library file @var{library} that
5016 would be used when linking---and don't do anything else.  With this
5017 option, GCC does not compile or link anything; it just prints the
5018 file name.
5020 @item -print-multi-directory
5021 @opindex print-multi-directory
5022 Print the directory name corresponding to the multilib selected by any
5023 other switches present in the command line.  This directory is supposed
5024 to exist in @env{GCC_EXEC_PREFIX}.
5026 @item -print-multi-lib
5027 @opindex print-multi-lib
5028 Print the mapping from multilib directory names to compiler switches
5029 that enable them.  The directory name is separated from the switches by
5030 @samp{;}, and each switch starts with an @samp{@@} instead of the
5031 @samp{-}, without spaces between multiple switches.  This is supposed to
5032 ease shell-processing.
5034 @item -print-prog-name=@var{program}
5035 @opindex print-prog-name
5036 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5038 @item -print-libgcc-file-name
5039 @opindex print-libgcc-file-name
5040 Same as @option{-print-file-name=libgcc.a}.
5042 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5043 but you do want to link with @file{libgcc.a}.  You can do
5045 @smallexample
5046 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5047 @end smallexample
5049 @item -print-search-dirs
5050 @opindex print-search-dirs
5051 Print the name of the configured installation directory and a list of
5052 program and library directories @command{gcc} will search---and don't do anything else.
5054 This is useful when @command{gcc} prints the error message
5055 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5056 To resolve this you either need to put @file{cpp0} and the other compiler
5057 components where @command{gcc} expects to find them, or you can set the environment
5058 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5059 Don't forget the trailing @samp{/}.
5060 @xref{Environment Variables}.
5062 @item -print-sysroot-headers-suffix
5063 @opindex print-sysroot-headers-suffix
5064 Print the suffix added to the target sysroot when searching for
5065 headers, or give an error if the compiler is not configured with such
5066 a suffix---and don't do anything else.
5068 @item -dumpmachine
5069 @opindex dumpmachine
5070 Print the compiler's target machine (for example,
5071 @samp{i686-pc-linux-gnu})---and don't do anything else.
5073 @item -dumpversion
5074 @opindex dumpversion
5075 Print the compiler version (for example, @samp{3.0})---and don't do
5076 anything else.
5078 @item -dumpspecs
5079 @opindex dumpspecs
5080 Print the compiler's built-in specs---and don't do anything else.  (This
5081 is used when GCC itself is being built.)  @xref{Spec Files}.
5083 @item -feliminate-unused-debug-types
5084 @opindex feliminate-unused-debug-types
5085 Normally, when producing DWARF2 output, GCC will emit debugging
5086 information for all types declared in a compilation
5087 unit, regardless of whether or not they are actually used
5088 in that compilation unit.  Sometimes this is useful, such as
5089 if, in the debugger, you want to cast a value to a type that is
5090 not actually used in your program (but is declared).  More often,
5091 however, this results in a significant amount of wasted space.
5092 With this option, GCC will avoid producing debug symbol output
5093 for types that are nowhere used in the source file being compiled.
5094 @end table
5096 @node Optimize Options
5097 @section Options That Control Optimization
5098 @cindex optimize options
5099 @cindex options, optimization
5101 These options control various sorts of optimizations.
5103 Without any optimization option, the compiler's goal is to reduce the
5104 cost of compilation and to make debugging produce the expected
5105 results.  Statements are independent: if you stop the program with a
5106 breakpoint between statements, you can then assign a new value to any
5107 variable or change the program counter to any other statement in the
5108 function and get exactly the results you would expect from the source
5109 code.
5111 Turning on optimization flags makes the compiler attempt to improve
5112 the performance and/or code size at the expense of compilation time
5113 and possibly the ability to debug the program.
5115 The compiler performs optimization based on the knowledge it has of
5116 the program.  Optimization levels @option{-O} and above, in
5117 particular, enable @emph{unit-at-a-time} mode, which allows the
5118 compiler to consider information gained from later functions in
5119 the file when compiling a function.  Compiling multiple files at
5120 once to a single output file in @emph{unit-at-a-time} mode allows
5121 the compiler to use information gained from all of the files when
5122 compiling each of them.
5124 Not all optimizations are controlled directly by a flag.  Only
5125 optimizations that have a flag are listed.
5127 @table @gcctabopt
5128 @item -O
5129 @itemx -O1
5130 @opindex O
5131 @opindex O1
5132 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5133 more memory for a large function.
5135 With @option{-O}, the compiler tries to reduce code size and execution
5136 time, without performing any optimizations that take a great deal of
5137 compilation time.
5139 @option{-O} turns on the following optimization flags:
5140 @gccoptlist{
5141 -fauto-inc-dec @gol
5142 -fcprop-registers @gol
5143 -fdce @gol
5144 -fdefer-pop @gol
5145 -fdelayed-branch @gol
5146 -fdse @gol
5147 -fguess-branch-probability @gol
5148 -fif-conversion2 @gol
5149 -fif-conversion @gol
5150 -finline-small-functions @gol
5151 -fipa-pure-const @gol
5152 -fipa-reference @gol
5153 -fmerge-constants
5154 -fsplit-wide-types @gol
5155 -ftree-builtin-call-dce @gol
5156 -ftree-ccp @gol
5157 -ftree-ch @gol
5158 -ftree-copyrename @gol
5159 -ftree-dce @gol
5160 -ftree-dominator-opts @gol
5161 -ftree-dse @gol
5162 -ftree-fre @gol
5163 -ftree-sra @gol
5164 -ftree-ter @gol
5165 -funit-at-a-time}
5167 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5168 where doing so does not interfere with debugging.
5170 @item -O2
5171 @opindex O2
5172 Optimize even more.  GCC performs nearly all supported optimizations
5173 that do not involve a space-speed tradeoff.  The compiler does not
5174 perform loop unrolling or function inlining when you specify @option{-O2}.
5175 As compared to @option{-O}, this option increases both compilation time
5176 and the performance of the generated code.
5178 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5179 also turns on the following optimization flags:
5180 @gccoptlist{-fthread-jumps @gol
5181 -falign-functions  -falign-jumps @gol
5182 -falign-loops  -falign-labels @gol
5183 -fcaller-saves @gol
5184 -fcrossjumping @gol
5185 -fcse-follow-jumps  -fcse-skip-blocks @gol
5186 -fdelete-null-pointer-checks @gol
5187 -fexpensive-optimizations @gol
5188 -fgcse  -fgcse-lm  @gol
5189 -foptimize-sibling-calls @gol
5190 -fpeephole2 @gol
5191 -fregmove @gol
5192 -freorder-blocks  -freorder-functions @gol
5193 -frerun-cse-after-loop  @gol
5194 -fsched-interblock  -fsched-spec @gol
5195 -fschedule-insns  -fschedule-insns2 @gol
5196 -fstrict-aliasing -fstrict-overflow @gol
5197 -ftree-pre @gol
5198 -ftree-vrp}
5200 Please note the warning under @option{-fgcse} about
5201 invoking @option{-O2} on programs that use computed gotos.
5203 @item -O3
5204 @opindex O3
5205 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5206 @option{-O2} and also turns on the @option{-finline-functions},
5207 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5208 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5210 @item -O0
5211 @opindex O0
5212 Reduce compilation time and make debugging produce the expected
5213 results.  This is the default.
5215 @item -Os
5216 @opindex Os
5217 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5218 do not typically increase code size.  It also performs further
5219 optimizations designed to reduce code size.
5221 @option{-Os} disables the following optimization flags:
5222 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5223 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5224 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5226 If you use multiple @option{-O} options, with or without level numbers,
5227 the last such option is the one that is effective.
5228 @end table
5230 Options of the form @option{-f@var{flag}} specify machine-independent
5231 flags.  Most flags have both positive and negative forms; the negative
5232 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5233 below, only one of the forms is listed---the one you typically will
5234 use.  You can figure out the other form by either removing @samp{no-}
5235 or adding it.
5237 The following options control specific optimizations.  They are either
5238 activated by @option{-O} options or are related to ones that are.  You
5239 can use the following flags in the rare cases when ``fine-tuning'' of
5240 optimizations to be performed is desired.
5242 @table @gcctabopt
5243 @item -fno-default-inline
5244 @opindex fno-default-inline
5245 Do not make member functions inline by default merely because they are
5246 defined inside the class scope (C++ only).  Otherwise, when you specify
5247 @w{@option{-O}}, member functions defined inside class scope are compiled
5248 inline by default; i.e., you don't need to add @samp{inline} in front of
5249 the member function name.
5251 @item -fno-defer-pop
5252 @opindex fno-defer-pop
5253 Always pop the arguments to each function call as soon as that function
5254 returns.  For machines which must pop arguments after a function call,
5255 the compiler normally lets arguments accumulate on the stack for several
5256 function calls and pops them all at once.
5258 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5260 @item -fforward-propagate
5261 @opindex fforward-propagate
5262 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5263 instructions and checks if the result can be simplified.  If loop unrolling
5264 is active, two passes are performed and the second is scheduled after
5265 loop unrolling.
5267 This option is enabled by default at optimization levels @option{-O2},
5268 @option{-O3}, @option{-Os}.
5270 @item -fomit-frame-pointer
5271 @opindex fomit-frame-pointer
5272 Don't keep the frame pointer in a register for functions that
5273 don't need one.  This avoids the instructions to save, set up and
5274 restore frame pointers; it also makes an extra register available
5275 in many functions.  @strong{It also makes debugging impossible on
5276 some machines.}
5278 On some machines, such as the VAX, this flag has no effect, because
5279 the standard calling sequence automatically handles the frame pointer
5280 and nothing is saved by pretending it doesn't exist.  The
5281 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5282 whether a target machine supports this flag.  @xref{Registers,,Register
5283 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5285 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5287 @item -foptimize-sibling-calls
5288 @opindex foptimize-sibling-calls
5289 Optimize sibling and tail recursive calls.
5291 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5293 @item -fno-inline
5294 @opindex fno-inline
5295 Don't pay attention to the @code{inline} keyword.  Normally this option
5296 is used to keep the compiler from expanding any functions inline.
5297 Note that if you are not optimizing, no functions can be expanded inline.
5299 @item -finline-small-functions
5300 @opindex finline-small-functions
5301 Integrate functions into their callers when their body is smaller than expected
5302 function call code (so overall size of program gets smaller).  The compiler
5303 heuristically decides which functions are simple enough to be worth integrating
5304 in this way.
5306 Enabled at level @option{-O2}.
5308 @item -finline-functions
5309 @opindex finline-functions
5310 Integrate all simple functions into their callers.  The compiler
5311 heuristically decides which functions are simple enough to be worth
5312 integrating in this way.
5314 If all calls to a given function are integrated, and the function is
5315 declared @code{static}, then the function is normally not output as
5316 assembler code in its own right.
5318 Enabled at level @option{-O3}.
5320 @item -finline-functions-called-once
5321 @opindex finline-functions-called-once
5322 Consider all @code{static} functions called once for inlining into their
5323 caller even if they are not marked @code{inline}.  If a call to a given
5324 function is integrated, then the function is not output as assembler code
5325 in its own right.
5327 Enabled if @option{-funit-at-a-time} is enabled.
5329 @item -fearly-inlining
5330 @opindex fearly-inlining
5331 Inline functions marked by @code{always_inline} and functions whose body seems
5332 smaller than the function call overhead early before doing
5333 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5334 makes profiling significantly cheaper and usually inlining faster on programs
5335 having large chains of nested wrapper functions.
5337 Enabled by default.
5339 @item -finline-limit=@var{n}
5340 @opindex finline-limit
5341 By default, GCC limits the size of functions that can be inlined.  This flag
5342 allows coarse control of this limit.  @var{n} is the size of functions that
5343 can be inlined in number of pseudo instructions.
5345 Inlining is actually controlled by a number of parameters, which may be
5346 specified individually by using @option{--param @var{name}=@var{value}}.
5347 The @option{-finline-limit=@var{n}} option sets some of these parameters
5348 as follows:
5350 @table @gcctabopt
5351 @item max-inline-insns-single
5352  is set to @var{n}/2.
5353 @item max-inline-insns-auto
5354  is set to @var{n}/2.
5355 @end table
5357 See below for a documentation of the individual
5358 parameters controlling inlining and for the defaults of these parameters.
5360 @emph{Note:} there may be no value to @option{-finline-limit} that results
5361 in default behavior.
5363 @emph{Note:} pseudo instruction represents, in this particular context, an
5364 abstract measurement of function's size.  In no way does it represent a count
5365 of assembly instructions and as such its exact meaning might change from one
5366 release to an another.
5368 @item -fkeep-inline-functions
5369 @opindex fkeep-inline-functions
5370 In C, emit @code{static} functions that are declared @code{inline}
5371 into the object file, even if the function has been inlined into all
5372 of its callers.  This switch does not affect functions using the
5373 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5374 inline functions into the object file.
5376 @item -fkeep-static-consts
5377 @opindex fkeep-static-consts
5378 Emit variables declared @code{static const} when optimization isn't turned
5379 on, even if the variables aren't referenced.
5381 GCC enables this option by default.  If you want to force the compiler to
5382 check if the variable was referenced, regardless of whether or not
5383 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5385 @item -fmerge-constants
5386 @opindex fmerge-constants
5387 Attempt to merge identical constants (string constants and floating point
5388 constants) across compilation units.
5390 This option is the default for optimized compilation if the assembler and
5391 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5392 behavior.
5394 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5396 @item -fmerge-all-constants
5397 @opindex fmerge-all-constants
5398 Attempt to merge identical constants and identical variables.
5400 This option implies @option{-fmerge-constants}.  In addition to
5401 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5402 arrays or initialized constant variables with integral or floating point
5403 types.  Languages like C or C++ require each non-automatic variable to
5404 have distinct location, so using this option will result in non-conforming
5405 behavior.
5407 @item -fmodulo-sched
5408 @opindex fmodulo-sched
5409 Perform swing modulo scheduling immediately before the first scheduling
5410 pass.  This pass looks at innermost loops and reorders their
5411 instructions by overlapping different iterations.
5413 @item -fmodulo-sched-allow-regmoves
5414 @opindex fmodulo-sched-allow-regmoves
5415 Perform more aggressive SMS based modulo scheduling with register moves
5416 allowed.  By setting this flag certain anti-dependences edges will be
5417 deleted which will trigger the generation of reg-moves based on the
5418 life-range analysis.  This option is effective only with
5419 @option{-fmodulo-sched} enabled.
5421 @item -fno-branch-count-reg
5422 @opindex fno-branch-count-reg
5423 Do not use ``decrement and branch'' instructions on a count register,
5424 but instead generate a sequence of instructions that decrement a
5425 register, compare it against zero, then branch based upon the result.
5426 This option is only meaningful on architectures that support such
5427 instructions, which include x86, PowerPC, IA-64 and S/390.
5429 The default is @option{-fbranch-count-reg}.
5431 @item -fno-function-cse
5432 @opindex fno-function-cse
5433 Do not put function addresses in registers; make each instruction that
5434 calls a constant function contain the function's address explicitly.
5436 This option results in less efficient code, but some strange hacks
5437 that alter the assembler output may be confused by the optimizations
5438 performed when this option is not used.
5440 The default is @option{-ffunction-cse}
5442 @item -fno-zero-initialized-in-bss
5443 @opindex fno-zero-initialized-in-bss
5444 If the target supports a BSS section, GCC by default puts variables that
5445 are initialized to zero into BSS@.  This can save space in the resulting
5446 code.
5448 This option turns off this behavior because some programs explicitly
5449 rely on variables going to the data section.  E.g., so that the
5450 resulting executable can find the beginning of that section and/or make
5451 assumptions based on that.
5453 The default is @option{-fzero-initialized-in-bss}.
5455 @item -fmudflap -fmudflapth -fmudflapir
5456 @opindex fmudflap
5457 @opindex fmudflapth
5458 @opindex fmudflapir
5459 @cindex bounds checking
5460 @cindex mudflap
5461 For front-ends that support it (C and C++), instrument all risky
5462 pointer/array dereferencing operations, some standard library
5463 string/heap functions, and some other associated constructs with
5464 range/validity tests.  Modules so instrumented should be immune to
5465 buffer overflows, invalid heap use, and some other classes of C/C++
5466 programming errors.  The instrumentation relies on a separate runtime
5467 library (@file{libmudflap}), which will be linked into a program if
5468 @option{-fmudflap} is given at link time.  Run-time behavior of the
5469 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5470 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5471 for its options.
5473 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5474 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5475 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5476 instrumentation should ignore pointer reads.  This produces less
5477 instrumentation (and therefore faster execution) and still provides
5478 some protection against outright memory corrupting writes, but allows
5479 erroneously read data to propagate within a program.
5481 @item -fthread-jumps
5482 @opindex fthread-jumps
5483 Perform optimizations where we check to see if a jump branches to a
5484 location where another comparison subsumed by the first is found.  If
5485 so, the first branch is redirected to either the destination of the
5486 second branch or a point immediately following it, depending on whether
5487 the condition is known to be true or false.
5489 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5491 @item -fsplit-wide-types
5492 @opindex fsplit-wide-types
5493 When using a type that occupies multiple registers, such as @code{long
5494 long} on a 32-bit system, split the registers apart and allocate them
5495 independently.  This normally generates better code for those types,
5496 but may make debugging more difficult.
5498 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5499 @option{-Os}.
5501 @item -fcse-follow-jumps
5502 @opindex fcse-follow-jumps
5503 In common subexpression elimination (CSE), scan through jump instructions
5504 when the target of the jump is not reached by any other path.  For
5505 example, when CSE encounters an @code{if} statement with an
5506 @code{else} clause, CSE will follow the jump when the condition
5507 tested is false.
5509 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5511 @item -fcse-skip-blocks
5512 @opindex fcse-skip-blocks
5513 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5514 follow jumps which conditionally skip over blocks.  When CSE
5515 encounters a simple @code{if} statement with no else clause,
5516 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5517 body of the @code{if}.
5519 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5521 @item -frerun-cse-after-loop
5522 @opindex frerun-cse-after-loop
5523 Re-run common subexpression elimination after loop optimizations has been
5524 performed.
5526 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5528 @item -fgcse
5529 @opindex fgcse
5530 Perform a global common subexpression elimination pass.
5531 This pass also performs global constant and copy propagation.
5533 @emph{Note:} When compiling a program using computed gotos, a GCC
5534 extension, you may get better runtime performance if you disable
5535 the global common subexpression elimination pass by adding
5536 @option{-fno-gcse} to the command line.
5538 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5540 @item -fgcse-lm
5541 @opindex fgcse-lm
5542 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5543 attempt to move loads which are only killed by stores into themselves.  This
5544 allows a loop containing a load/store sequence to be changed to a load outside
5545 the loop, and a copy/store within the loop.
5547 Enabled by default when gcse is enabled.
5549 @item -fgcse-sm
5550 @opindex fgcse-sm
5551 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5552 global common subexpression elimination.  This pass will attempt to move
5553 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5554 loops containing a load/store sequence can be changed to a load before
5555 the loop and a store after the loop.
5557 Not enabled at any optimization level.
5559 @item -fgcse-las
5560 @opindex fgcse-las
5561 When @option{-fgcse-las} is enabled, the global common subexpression
5562 elimination pass eliminates redundant loads that come after stores to the
5563 same memory location (both partial and full redundancies).
5565 Not enabled at any optimization level.
5567 @item -fgcse-after-reload
5568 @opindex fgcse-after-reload
5569 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5570 pass is performed after reload.  The purpose of this pass is to cleanup
5571 redundant spilling.
5573 @item -funsafe-loop-optimizations
5574 @opindex funsafe-loop-optimizations
5575 If given, the loop optimizer will assume that loop indices do not
5576 overflow, and that the loops with nontrivial exit condition are not
5577 infinite.  This enables a wider range of loop optimizations even if
5578 the loop optimizer itself cannot prove that these assumptions are valid.
5579 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5580 if it finds this kind of loop.
5582 @item -fcrossjumping
5583 @opindex fcrossjumping
5584 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5585 resulting code may or may not perform better than without cross-jumping.
5587 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5589 @item -fauto-inc-dec
5590 @opindex fauto-inc-dec
5591 Combine increments or decrements of addresses with memory accesses.
5592 This pass is always skipped on architectures that do not have
5593 instructions to support this.  Enabled by default at @option{-O} and
5594 higher on architectures that support this.
5596 @item -fdce
5597 @opindex fdce
5598 Perform dead code elimination (DCE) on RTL@.
5599 Enabled by default at @option{-O} and higher.
5601 @item -fdse
5602 @opindex fdse
5603 Perform dead store elimination (DSE) on RTL@.
5604 Enabled by default at @option{-O} and higher.
5606 @item -fif-conversion
5607 @opindex fif-conversion
5608 Attempt to transform conditional jumps into branch-less equivalents.  This
5609 include use of conditional moves, min, max, set flags and abs instructions, and
5610 some tricks doable by standard arithmetics.  The use of conditional execution
5611 on chips where it is available is controlled by @code{if-conversion2}.
5613 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5615 @item -fif-conversion2
5616 @opindex fif-conversion2
5617 Use conditional execution (where available) to transform conditional jumps into
5618 branch-less equivalents.
5620 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5622 @item -fdelete-null-pointer-checks
5623 @opindex fdelete-null-pointer-checks
5624 Use global dataflow analysis to identify and eliminate useless checks
5625 for null pointers.  The compiler assumes that dereferencing a null
5626 pointer would have halted the program.  If a pointer is checked after
5627 it has already been dereferenced, it cannot be null.
5629 In some environments, this assumption is not true, and programs can
5630 safely dereference null pointers.  Use
5631 @option{-fno-delete-null-pointer-checks} to disable this optimization
5632 for programs which depend on that behavior.
5634 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5636 @item -fexpensive-optimizations
5637 @opindex fexpensive-optimizations
5638 Perform a number of minor optimizations that are relatively expensive.
5640 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5642 @item -foptimize-register-move
5643 @itemx -fregmove
5644 @opindex foptimize-register-move
5645 @opindex fregmove
5646 Attempt to reassign register numbers in move instructions and as
5647 operands of other simple instructions in order to maximize the amount of
5648 register tying.  This is especially helpful on machines with two-operand
5649 instructions.
5651 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5652 optimization.
5654 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5656 @item -fdelayed-branch
5657 @opindex fdelayed-branch
5658 If supported for the target machine, attempt to reorder instructions
5659 to exploit instruction slots available after delayed branch
5660 instructions.
5662 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5664 @item -fschedule-insns
5665 @opindex fschedule-insns
5666 If supported for the target machine, attempt to reorder instructions to
5667 eliminate execution stalls due to required data being unavailable.  This
5668 helps machines that have slow floating point or memory load instructions
5669 by allowing other instructions to be issued until the result of the load
5670 or floating point instruction is required.
5672 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5674 @item -fschedule-insns2
5675 @opindex fschedule-insns2
5676 Similar to @option{-fschedule-insns}, but requests an additional pass of
5677 instruction scheduling after register allocation has been done.  This is
5678 especially useful on machines with a relatively small number of
5679 registers and where memory load instructions take more than one cycle.
5681 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5683 @item -fno-sched-interblock
5684 @opindex fno-sched-interblock
5685 Don't schedule instructions across basic blocks.  This is normally
5686 enabled by default when scheduling before register allocation, i.e.@:
5687 with @option{-fschedule-insns} or at @option{-O2} or higher.
5689 @item -fno-sched-spec
5690 @opindex fno-sched-spec
5691 Don't allow speculative motion of non-load instructions.  This is normally
5692 enabled by default when scheduling before register allocation, i.e.@:
5693 with @option{-fschedule-insns} or at @option{-O2} or higher.
5695 @item -fsched-spec-load
5696 @opindex fsched-spec-load
5697 Allow speculative motion of some load instructions.  This only makes
5698 sense when scheduling before register allocation, i.e.@: with
5699 @option{-fschedule-insns} or at @option{-O2} or higher.
5701 @item -fsched-spec-load-dangerous
5702 @opindex fsched-spec-load-dangerous
5703 Allow speculative motion of more load instructions.  This only makes
5704 sense when scheduling before register allocation, i.e.@: with
5705 @option{-fschedule-insns} or at @option{-O2} or higher.
5707 @item -fsched-stalled-insns
5708 @itemx -fsched-stalled-insns=@var{n}
5709 @opindex fsched-stalled-insns
5710 Define how many insns (if any) can be moved prematurely from the queue
5711 of stalled insns into the ready list, during the second scheduling pass.
5712 @option{-fno-sched-stalled-insns} means that no insns will be moved
5713 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5714 on how many queued insns can be moved prematurely.
5715 @option{-fsched-stalled-insns} without a value is equivalent to
5716 @option{-fsched-stalled-insns=1}.
5718 @item -fsched-stalled-insns-dep
5719 @itemx -fsched-stalled-insns-dep=@var{n}
5720 @opindex fsched-stalled-insns-dep
5721 Define how many insn groups (cycles) will be examined for a dependency
5722 on a stalled insn that is candidate for premature removal from the queue
5723 of stalled insns.  This has an effect only during the second scheduling pass,
5724 and only if @option{-fsched-stalled-insns} is used.
5725 @option{-fno-sched-stalled-insns-dep} is equivalent to
5726 @option{-fsched-stalled-insns-dep=0}.
5727 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5728 @option{-fsched-stalled-insns-dep=1}.
5730 @item -fsched2-use-superblocks
5731 @opindex fsched2-use-superblocks
5732 When scheduling after register allocation, do use superblock scheduling
5733 algorithm.  Superblock scheduling allows motion across basic block boundaries
5734 resulting on faster schedules.  This option is experimental, as not all machine
5735 descriptions used by GCC model the CPU closely enough to avoid unreliable
5736 results from the algorithm.
5738 This only makes sense when scheduling after register allocation, i.e.@: with
5739 @option{-fschedule-insns2} or at @option{-O2} or higher.
5741 @item -fsched2-use-traces
5742 @opindex fsched2-use-traces
5743 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5744 allocation and additionally perform code duplication in order to increase the
5745 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5746 trace formation.
5748 This mode should produce faster but significantly longer programs.  Also
5749 without @option{-fbranch-probabilities} the traces constructed may not
5750 match the reality and hurt the performance.  This only makes
5751 sense when scheduling after register allocation, i.e.@: with
5752 @option{-fschedule-insns2} or at @option{-O2} or higher.
5754 @item -fsee
5755 @opindex fsee
5756 Eliminate redundant sign extension instructions and move the non-redundant
5757 ones to optimal placement using lazy code motion (LCM).
5759 @item -freschedule-modulo-scheduled-loops
5760 @opindex freschedule-modulo-scheduled-loops
5761 The modulo scheduling comes before the traditional scheduling, if a loop
5762 was modulo scheduled we may want to prevent the later scheduling passes
5763 from changing its schedule, we use this option to control that.
5765 @item -fcaller-saves
5766 @opindex fcaller-saves
5767 Enable values to be allocated in registers that will be clobbered by
5768 function calls, by emitting extra instructions to save and restore the
5769 registers around such calls.  Such allocation is done only when it
5770 seems to result in better code than would otherwise be produced.
5772 This option is always enabled by default on certain machines, usually
5773 those which have no call-preserved registers to use instead.
5775 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5777 @item -ftree-reassoc
5778 @opindex ftree-reassoc
5779 Perform reassociation on trees.  This flag is enabled by default
5780 at @option{-O} and higher.
5782 @item -ftree-pre
5783 @opindex ftree-pre
5784 Perform partial redundancy elimination (PRE) on trees.  This flag is
5785 enabled by default at @option{-O2} and @option{-O3}.
5787 @item -ftree-fre
5788 @opindex ftree-fre
5789 Perform full redundancy elimination (FRE) on trees.  The difference
5790 between FRE and PRE is that FRE only considers expressions
5791 that are computed on all paths leading to the redundant computation.
5792 This analysis is faster than PRE, though it exposes fewer redundancies.
5793 This flag is enabled by default at @option{-O} and higher.
5795 @item -ftree-copy-prop
5796 @opindex ftree-copy-prop
5797 Perform copy propagation on trees.  This pass eliminates unnecessary
5798 copy operations.  This flag is enabled by default at @option{-O} and
5799 higher.
5801 @item -fipa-pure-const
5802 @opindex fipa-pure-const
5803 Discover which functions are pure or constant.
5804 Enabled by default at @option{-O} and higher.
5806 @item -fipa-reference
5807 @opindex fipa-reference
5808 Discover which static variables do not escape cannot escape the
5809 compilation unit.
5810 Enabled by default at @option{-O} and higher.
5812 @item -fipa-struct-reorg
5813 @opindex fipa-struct-reorg
5814 Perform structure reorganization optimization, that change C-like structures 
5815 layout in order to better utilize spatial locality.  This transformation is 
5816 affective for programs containing arrays of structures.  Available in two 
5817 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5818 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5819 to provide the safety of this transformation.  It works only in whole program
5820 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5821 enabled.  Structures considered @samp{cold} by this transformation are not
5822 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5824 With this flag, the program debug info reflects a new structure layout.
5826 @item -fipa-pta
5827 @opindex fipa-pta
5828 Perform interprocedural pointer analysis.
5830 @item -fipa-cp
5831 @opindex fipa-cp
5832 Perform interprocedural constant propagation.
5833 This optimization analyzes the program to determine when values passed
5834 to functions are constants and then optimizes accordingly.  
5835 This optimization can substantially increase performance
5836 if the application has constants passed to functions, but
5837 because this optimization can create multiple copies of functions,
5838 it may significantly increase code size.
5840 @item -fipa-matrix-reorg
5841 @opindex fipa-matrix-reorg
5842 Perform matrix flattening and transposing.
5843 Matrix flattening tries to replace a m-dimensional matrix 
5844 with its equivalent n-dimensional matrix, where n < m.
5845 This reduces the level of indirection needed for accessing the elements
5846 of the matrix. The second optimization is matrix transposing that
5847 attemps to change the order of the matrix's dimensions in order to 
5848 improve cache locality.
5849 Both optimizations need fwhole-program flag. 
5850 Transposing is enabled only if profiling information is avaliable.
5853 @item -ftree-sink
5854 @opindex ftree-sink
5855 Perform forward store motion  on trees.  This flag is
5856 enabled by default at @option{-O} and higher.
5858 @item -ftree-ccp
5859 @opindex ftree-ccp
5860 Perform sparse conditional constant propagation (CCP) on trees.  This
5861 pass only operates on local scalar variables and is enabled by default
5862 at @option{-O} and higher.
5864 @item -ftree-store-ccp
5865 @opindex ftree-store-ccp
5866 Perform sparse conditional constant propagation (CCP) on trees.  This
5867 pass operates on both local scalar variables and memory stores and
5868 loads (global variables, structures, arrays, etc).  This flag is
5869 enabled by default at @option{-O2} and higher.
5871 @item -ftree-dce
5872 @opindex ftree-dce
5873 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5874 default at @option{-O} and higher.
5876 @item -ftree-builtin-call-dce
5877 @opindex ftree-builtin-call-dce
5878 Perform conditional dead code elimination (DCE) for calls to builtin functions 
5879 that may set @code{errno} but are otherwise side-effect free.  This flag is 
5880 enabled by default at @option{-O2} and higher if @option{-Os} is not also 
5881 specified.
5883 @item -ftree-dominator-opts
5884 @opindex ftree-dominator-opts
5885 Perform a variety of simple scalar cleanups (constant/copy
5886 propagation, redundancy elimination, range propagation and expression
5887 simplification) based on a dominator tree traversal.  This also
5888 performs jump threading (to reduce jumps to jumps). This flag is
5889 enabled by default at @option{-O} and higher.
5891 @item -ftree-dse
5892 @opindex ftree-dse
5893 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5894 a memory location which will later be overwritten by another store without
5895 any intervening loads.  In this case the earlier store can be deleted.  This
5896 flag is enabled by default at @option{-O} and higher.
5898 @item -ftree-ch
5899 @opindex ftree-ch
5900 Perform loop header copying on trees.  This is beneficial since it increases
5901 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5902 is enabled by default at @option{-O} and higher.  It is not enabled
5903 for @option{-Os}, since it usually increases code size.
5905 @item -ftree-loop-optimize
5906 @opindex ftree-loop-optimize
5907 Perform loop optimizations on trees.  This flag is enabled by default
5908 at @option{-O} and higher.
5910 @item -ftree-loop-linear
5911 @opindex ftree-loop-linear
5912 Perform linear loop transformations on tree.  This flag can improve cache
5913 performance and allow further loop optimizations to take place.
5915 @item -fcheck-data-deps
5916 @opindex fcheck-data-deps
5917 Compare the results of several data dependence analyzers.  This option
5918 is used for debugging the data dependence analyzers.
5920 @item -ftree-loop-distribution
5921 Perform loop distribution.  This flag can improve cache performance on
5922 big loop bodies and allow further loop optimizations, like
5923 parallelization or vectorization, to take place.  For example, the loop
5924 @smallexample
5925 DO I = 1, N
5926   A(I) = B(I) + C
5927   D(I) = E(I) * F
5928 ENDDO
5929 @end smallexample
5930 is transformed to
5931 @smallexample
5932 DO I = 1, N
5933    A(I) = B(I) + C
5934 ENDDO
5935 DO I = 1, N
5936    D(I) = E(I) * F
5937 ENDDO
5938 @end smallexample
5940 @item -ftree-loop-im
5941 @opindex ftree-loop-im
5942 Perform loop invariant motion on trees.  This pass moves only invariants that
5943 would be hard to handle at RTL level (function calls, operations that expand to
5944 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5945 operands of conditions that are invariant out of the loop, so that we can use
5946 just trivial invariantness analysis in loop unswitching.  The pass also includes
5947 store motion.
5949 @item -ftree-loop-ivcanon
5950 @opindex ftree-loop-ivcanon
5951 Create a canonical counter for number of iterations in the loop for that
5952 determining number of iterations requires complicated analysis.  Later
5953 optimizations then may determine the number easily.  Useful especially
5954 in connection with unrolling.
5956 @item -fivopts
5957 @opindex fivopts
5958 Perform induction variable optimizations (strength reduction, induction
5959 variable merging and induction variable elimination) on trees.
5961 @item -ftree-parallelize-loops=n
5962 @opindex ftree-parallelize-loops
5963 Parallelize loops, i.e., split their iteration space to run in n threads.
5964 This is only possible for loops whose iterations are independent
5965 and can be arbitrarily reordered.  The optimization is only
5966 profitable on multiprocessor machines, for loops that are CPU-intensive,
5967 rather than constrained e.g.@: by memory bandwidth.  This option
5968 implies @option{-pthread}, and thus is only supported on targets
5969 that have support for @option{-pthread}.
5971 @item -ftree-sra
5972 @opindex ftree-sra
5973 Perform scalar replacement of aggregates.  This pass replaces structure
5974 references with scalars to prevent committing structures to memory too
5975 early.  This flag is enabled by default at @option{-O} and higher.
5977 @item -ftree-copyrename
5978 @opindex ftree-copyrename
5979 Perform copy renaming on trees.  This pass attempts to rename compiler
5980 temporaries to other variables at copy locations, usually resulting in
5981 variable names which more closely resemble the original variables.  This flag
5982 is enabled by default at @option{-O} and higher.
5984 @item -ftree-ter
5985 @opindex ftree-ter
5986 Perform temporary expression replacement during the SSA->normal phase.  Single
5987 use/single def temporaries are replaced at their use location with their
5988 defining expression.  This results in non-GIMPLE code, but gives the expanders
5989 much more complex trees to work on resulting in better RTL generation.  This is
5990 enabled by default at @option{-O} and higher.
5992 @item -ftree-vectorize
5993 @opindex ftree-vectorize
5994 Perform loop vectorization on trees. This flag is enabled by default at
5995 @option{-O3}.
5997 @item -ftree-vect-loop-version
5998 @opindex ftree-vect-loop-version
5999 Perform loop versioning when doing loop vectorization on trees.  When a loop
6000 appears to be vectorizable except that data alignment or data dependence cannot
6001 be determined at compile time then vectorized and non-vectorized versions of
6002 the loop are generated along with runtime checks for alignment or dependence
6003 to control which version is executed.  This option is enabled by default
6004 except at level @option{-Os} where it is disabled.
6006 @item -fvect-cost-model
6007 @opindex fvect-cost-model
6008 Enable cost model for vectorization.
6010 @item -ftree-vrp
6011 @opindex ftree-vrp
6012 Perform Value Range Propagation on trees.  This is similar to the
6013 constant propagation pass, but instead of values, ranges of values are
6014 propagated.  This allows the optimizers to remove unnecessary range
6015 checks like array bound checks and null pointer checks.  This is
6016 enabled by default at @option{-O2} and higher.  Null pointer check
6017 elimination is only done if @option{-fdelete-null-pointer-checks} is
6018 enabled.
6020 @item -ftracer
6021 @opindex ftracer
6022 Perform tail duplication to enlarge superblock size.  This transformation
6023 simplifies the control flow of the function allowing other optimizations to do
6024 better job.
6026 @item -funroll-loops
6027 @opindex funroll-loops
6028 Unroll loops whose number of iterations can be determined at compile
6029 time or upon entry to the loop.  @option{-funroll-loops} implies
6030 @option{-frerun-cse-after-loop}.  This option makes code larger,
6031 and may or may not make it run faster.
6033 @item -funroll-all-loops
6034 @opindex funroll-all-loops
6035 Unroll all loops, even if their number of iterations is uncertain when
6036 the loop is entered.  This usually makes programs run more slowly.
6037 @option{-funroll-all-loops} implies the same options as
6038 @option{-funroll-loops},
6040 @item -fsplit-ivs-in-unroller
6041 @opindex fsplit-ivs-in-unroller
6042 Enables expressing of values of induction variables in later iterations
6043 of the unrolled loop using the value in the first iteration.  This breaks
6044 long dependency chains, thus improving efficiency of the scheduling passes.
6046 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6047 same effect.  However in cases the loop body is more complicated than
6048 a single basic block, this is not reliable.  It also does not work at all
6049 on some of the architectures due to restrictions in the CSE pass.
6051 This optimization is enabled by default.
6053 @item -fvariable-expansion-in-unroller
6054 @opindex fvariable-expansion-in-unroller
6055 With this option, the compiler will create multiple copies of some
6056 local variables when unrolling a loop which can result in superior code.
6058 @item -fpredictive-commoning
6059 @opindex fpredictive-commoning
6060 Perform predictive commoning optimization, i.e., reusing computations
6061 (especially memory loads and stores) performed in previous
6062 iterations of loops.
6064 This option is enabled at level @option{-O3}.
6066 @item -fprefetch-loop-arrays
6067 @opindex fprefetch-loop-arrays
6068 If supported by the target machine, generate instructions to prefetch
6069 memory to improve the performance of loops that access large arrays.
6071 This option may generate better or worse code; results are highly
6072 dependent on the structure of loops within the source code.
6074 Disabled at level @option{-Os}.
6076 @item -fno-peephole
6077 @itemx -fno-peephole2
6078 @opindex fno-peephole
6079 @opindex fno-peephole2
6080 Disable any machine-specific peephole optimizations.  The difference
6081 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6082 are implemented in the compiler; some targets use one, some use the
6083 other, a few use both.
6085 @option{-fpeephole} is enabled by default.
6086 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6088 @item -fno-guess-branch-probability
6089 @opindex fno-guess-branch-probability
6090 Do not guess branch probabilities using heuristics.
6092 GCC will use heuristics to guess branch probabilities if they are
6093 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6094 heuristics are based on the control flow graph.  If some branch probabilities
6095 are specified by @samp{__builtin_expect}, then the heuristics will be
6096 used to guess branch probabilities for the rest of the control flow graph,
6097 taking the @samp{__builtin_expect} info into account.  The interactions
6098 between the heuristics and @samp{__builtin_expect} can be complex, and in
6099 some cases, it may be useful to disable the heuristics so that the effects
6100 of @samp{__builtin_expect} are easier to understand.
6102 The default is @option{-fguess-branch-probability} at levels
6103 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6105 @item -freorder-blocks
6106 @opindex freorder-blocks
6107 Reorder basic blocks in the compiled function in order to reduce number of
6108 taken branches and improve code locality.
6110 Enabled at levels @option{-O2}, @option{-O3}.
6112 @item -freorder-blocks-and-partition
6113 @opindex freorder-blocks-and-partition
6114 In addition to reordering basic blocks in the compiled function, in order
6115 to reduce number of taken branches, partitions hot and cold basic blocks
6116 into separate sections of the assembly and .o files, to improve
6117 paging and cache locality performance.
6119 This optimization is automatically turned off in the presence of
6120 exception handling, for linkonce sections, for functions with a user-defined
6121 section attribute and on any architecture that does not support named
6122 sections.
6124 @item -freorder-functions
6125 @opindex freorder-functions
6126 Reorder functions in the object file in order to
6127 improve code locality.  This is implemented by using special
6128 subsections @code{.text.hot} for most frequently executed functions and
6129 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6130 the linker so object file format must support named sections and linker must
6131 place them in a reasonable way.
6133 Also profile feedback must be available in to make this option effective.  See
6134 @option{-fprofile-arcs} for details.
6136 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6138 @item -fstrict-aliasing
6139 @opindex fstrict-aliasing
6140 Allows the compiler to assume the strictest aliasing rules applicable to
6141 the language being compiled.  For C (and C++), this activates
6142 optimizations based on the type of expressions.  In particular, an
6143 object of one type is assumed never to reside at the same address as an
6144 object of a different type, unless the types are almost the same.  For
6145 example, an @code{unsigned int} can alias an @code{int}, but not a
6146 @code{void*} or a @code{double}.  A character type may alias any other
6147 type.
6149 Pay special attention to code like this:
6150 @smallexample
6151 union a_union @{
6152   int i;
6153   double d;
6156 int f() @{
6157   a_union t;
6158   t.d = 3.0;
6159   return t.i;
6161 @end smallexample
6162 The practice of reading from a different union member than the one most
6163 recently written to (called ``type-punning'') is common.  Even with
6164 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6165 is accessed through the union type.  So, the code above will work as
6166 expected.  However, this code might not:
6167 @smallexample
6168 int f() @{
6169   a_union t;
6170   int* ip;
6171   t.d = 3.0;
6172   ip = &t.i;
6173   return *ip;
6175 @end smallexample
6177 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6179 @item -fstrict-overflow
6180 @opindex fstrict-overflow
6181 Allow the compiler to assume strict signed overflow rules, depending
6182 on the language being compiled.  For C (and C++) this means that
6183 overflow when doing arithmetic with signed numbers is undefined, which
6184 means that the compiler may assume that it will not happen.  This
6185 permits various optimizations.  For example, the compiler will assume
6186 that an expression like @code{i + 10 > i} will always be true for
6187 signed @code{i}.  This assumption is only valid if signed overflow is
6188 undefined, as the expression is false if @code{i + 10} overflows when
6189 using twos complement arithmetic.  When this option is in effect any
6190 attempt to determine whether an operation on signed numbers will
6191 overflow must be written carefully to not actually involve overflow.
6193 This option also allows the compiler to assume strict pointer
6194 semantics: given a pointer to an object, if adding an offset to that
6195 pointer does not produce a pointer to the same object, the addition is
6196 undefined.  This permits the compiler to conclude that @code{p + u >
6197 p} is always true for a pointer @code{p} and unsigned integer
6198 @code{u}.  This assumption is only valid because pointer wraparound is
6199 undefined, as the expression is false if @code{p + u} overflows using
6200 twos complement arithmetic.
6202 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6203 that integer signed overflow is fully defined: it wraps.  When
6204 @option{-fwrapv} is used, there is no difference between
6205 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6206 integers.  With @option{-fwrapv} certain types of overflow are
6207 permitted.  For example, if the compiler gets an overflow when doing
6208 arithmetic on constants, the overflowed value can still be used with
6209 @option{-fwrapv}, but not otherwise.
6211 The @option{-fstrict-overflow} option is enabled at levels
6212 @option{-O2}, @option{-O3}, @option{-Os}.
6214 @item -falign-functions
6215 @itemx -falign-functions=@var{n}
6216 @opindex falign-functions
6217 Align the start of functions to the next power-of-two greater than
6218 @var{n}, skipping up to @var{n} bytes.  For instance,
6219 @option{-falign-functions=32} aligns functions to the next 32-byte
6220 boundary, but @option{-falign-functions=24} would align to the next
6221 32-byte boundary only if this can be done by skipping 23 bytes or less.
6223 @option{-fno-align-functions} and @option{-falign-functions=1} are
6224 equivalent and mean that functions will not be aligned.
6226 Some assemblers only support this flag when @var{n} is a power of two;
6227 in that case, it is rounded up.
6229 If @var{n} is not specified or is zero, use a machine-dependent default.
6231 Enabled at levels @option{-O2}, @option{-O3}.
6233 @item -falign-labels
6234 @itemx -falign-labels=@var{n}
6235 @opindex falign-labels
6236 Align all branch targets to a power-of-two boundary, skipping up to
6237 @var{n} bytes like @option{-falign-functions}.  This option can easily
6238 make code slower, because it must insert dummy operations for when the
6239 branch target is reached in the usual flow of the code.
6241 @option{-fno-align-labels} and @option{-falign-labels=1} are
6242 equivalent and mean that labels will not be aligned.
6244 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6245 are greater than this value, then their values are used instead.
6247 If @var{n} is not specified or is zero, use a machine-dependent default
6248 which is very likely to be @samp{1}, meaning no alignment.
6250 Enabled at levels @option{-O2}, @option{-O3}.
6252 @item -falign-loops
6253 @itemx -falign-loops=@var{n}
6254 @opindex falign-loops
6255 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6256 like @option{-falign-functions}.  The hope is that the loop will be
6257 executed many times, which will make up for any execution of the dummy
6258 operations.
6260 @option{-fno-align-loops} and @option{-falign-loops=1} are
6261 equivalent and mean that loops will not be aligned.
6263 If @var{n} is not specified or is zero, use a machine-dependent default.
6265 Enabled at levels @option{-O2}, @option{-O3}.
6267 @item -falign-jumps
6268 @itemx -falign-jumps=@var{n}
6269 @opindex falign-jumps
6270 Align branch targets to a power-of-two boundary, for branch targets
6271 where the targets can only be reached by jumping, skipping up to @var{n}
6272 bytes like @option{-falign-functions}.  In this case, no dummy operations
6273 need be executed.
6275 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6276 equivalent and mean that loops will not be aligned.
6278 If @var{n} is not specified or is zero, use a machine-dependent default.
6280 Enabled at levels @option{-O2}, @option{-O3}.
6282 @item -funit-at-a-time
6283 @opindex funit-at-a-time
6284 Parse the whole compilation unit before starting to produce code.
6285 This allows some extra optimizations to take place but consumes
6286 more memory (in general).  There are some compatibility issues
6287 with @emph{unit-at-a-time} mode:
6288 @itemize @bullet
6289 @item
6290 enabling @emph{unit-at-a-time} mode may change the order
6291 in which functions, variables, and top-level @code{asm} statements
6292 are emitted, and will likely break code relying on some particular
6293 ordering.  The majority of such top-level @code{asm} statements,
6294 though, can be replaced by @code{section} attributes.  The
6295 @option{fno-toplevel-reorder} option may be used to keep the ordering
6296 used in the input file, at the cost of some optimizations.
6298 @item
6299 @emph{unit-at-a-time} mode removes unreferenced static variables
6300 and functions.  This may result in undefined references
6301 when an @code{asm} statement refers directly to variables or functions
6302 that are otherwise unused.  In that case either the variable/function
6303 shall be listed as an operand of the @code{asm} statement operand or,
6304 in the case of top-level @code{asm} statements the attribute @code{used}
6305 shall be used on the declaration.
6307 @item
6308 Static functions now can use non-standard passing conventions that
6309 may break @code{asm} statements calling functions directly.  Again,
6310 attribute @code{used} will prevent this behavior.
6311 @end itemize
6313 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6314 but this scheme may not be supported by future releases of GCC@.
6316 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6318 @item -fno-toplevel-reorder
6319 @opindex fno-toplevel-reorder
6320 Do not reorder top-level functions, variables, and @code{asm}
6321 statements.  Output them in the same order that they appear in the
6322 input file.  When this option is used, unreferenced static variables
6323 will not be removed.  This option is intended to support existing code
6324 which relies on a particular ordering.  For new code, it is better to
6325 use attributes.
6327 @item -fweb
6328 @opindex fweb
6329 Constructs webs as commonly used for register allocation purposes and assign
6330 each web individual pseudo register.  This allows the register allocation pass
6331 to operate on pseudos directly, but also strengthens several other optimization
6332 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6333 however, make debugging impossible, since variables will no longer stay in a
6334 ``home register''.
6336 Enabled by default with @option{-funroll-loops}.
6338 @item -fwhole-program
6339 @opindex fwhole-program
6340 Assume that the current compilation unit represents whole program being
6341 compiled.  All public functions and variables with the exception of @code{main}
6342 and those merged by attribute @code{externally_visible} become static functions
6343 and in a affect gets more aggressively optimized by interprocedural optimizers.
6344 While this option is equivalent to proper use of @code{static} keyword for
6345 programs consisting of single file, in combination with option
6346 @option{--combine} this flag can be used to compile most of smaller scale C
6347 programs since the functions and variables become local for the whole combined
6348 compilation unit, not for the single source file itself.
6350 This option is not supported for Fortran programs.
6352 @item -fcprop-registers
6353 @opindex fcprop-registers
6354 After register allocation and post-register allocation instruction splitting,
6355 we perform a copy-propagation pass to try to reduce scheduling dependencies
6356 and occasionally eliminate the copy.
6358 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6360 @item -fprofile-dir=@var{path}
6361 @opindex fprofile-dir
6363 Set the directory to search the profile data files in to @var{path}.
6364 This option affects only the profile data generated by
6365 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6366 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6367 and its related options.
6368 By default, GCC will use the current directory as @var{path}
6369 thus the profile data file will appear in the same directory as the object file.
6371 @item -fprofile-generate
6372 @itemx -fprofile-generate=@var{path}
6373 @opindex fprofile-generate
6375 Enable options usually used for instrumenting application to produce
6376 profile useful for later recompilation with profile feedback based
6377 optimization.  You must use @option{-fprofile-generate} both when
6378 compiling and when linking your program.
6380 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6382 If @var{path} is specified, GCC will look at the @var{path} to find
6383 the profile feeedback data files. See @option{-fprofile-dir}.
6385 @item -fprofile-use
6386 @itemx -fprofile-use=@var{path}
6387 @opindex fprofile-use
6388 Enable profile feedback directed optimizations, and optimizations
6389 generally profitable only with profile feedback available.
6391 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6392 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6394 By default, GCC emits an error message if the feedback profiles do not
6395 match the source code.  This error can be turned into a warning by using
6396 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6397 code.
6399 If @var{path} is specified, GCC will look at the @var{path} to find
6400 the profile feedback data files. See @option{-fprofile-dir}.
6401 @end table
6403 The following options control compiler behavior regarding floating
6404 point arithmetic.  These options trade off between speed and
6405 correctness.  All must be specifically enabled.
6407 @table @gcctabopt
6408 @item -ffloat-store
6409 @opindex ffloat-store
6410 Do not store floating point variables in registers, and inhibit other
6411 options that might change whether a floating point value is taken from a
6412 register or memory.
6414 @cindex floating point precision
6415 This option prevents undesirable excess precision on machines such as
6416 the 68000 where the floating registers (of the 68881) keep more
6417 precision than a @code{double} is supposed to have.  Similarly for the
6418 x86 architecture.  For most programs, the excess precision does only
6419 good, but a few programs rely on the precise definition of IEEE floating
6420 point.  Use @option{-ffloat-store} for such programs, after modifying
6421 them to store all pertinent intermediate computations into variables.
6423 @item -ffast-math
6424 @opindex ffast-math
6425 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6426 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6427 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6429 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6431 This option is not turned on by any @option{-O} option since
6432 it can result in incorrect output for programs which depend on
6433 an exact implementation of IEEE or ISO rules/specifications for
6434 math functions. It may, however, yield faster code for programs
6435 that do not require the guarantees of these specifications.
6437 @item -fno-math-errno
6438 @opindex fno-math-errno
6439 Do not set ERRNO after calling math functions that are executed
6440 with a single instruction, e.g., sqrt.  A program that relies on
6441 IEEE exceptions for math error handling may want to use this flag
6442 for speed while maintaining IEEE arithmetic compatibility.
6444 This option is not turned on by any @option{-O} option since
6445 it can result in incorrect output for programs which depend on
6446 an exact implementation of IEEE or ISO rules/specifications for
6447 math functions. It may, however, yield faster code for programs
6448 that do not require the guarantees of these specifications.
6450 The default is @option{-fmath-errno}.
6452 On Darwin systems, the math library never sets @code{errno}.  There is
6453 therefore no reason for the compiler to consider the possibility that
6454 it might, and @option{-fno-math-errno} is the default.
6456 @item -funsafe-math-optimizations
6457 @opindex funsafe-math-optimizations
6459 Allow optimizations for floating-point arithmetic that (a) assume
6460 that arguments and results are valid and (b) may violate IEEE or
6461 ANSI standards.  When used at link-time, it may include libraries
6462 or startup files that change the default FPU control word or other
6463 similar optimizations.
6465 This option is not turned on by any @option{-O} option since
6466 it can result in incorrect output for programs which depend on
6467 an exact implementation of IEEE or ISO rules/specifications for
6468 math functions. It may, however, yield faster code for programs
6469 that do not require the guarantees of these specifications.
6470 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6471 @option{-fassociative-math} and @option{-freciprocal-math}.
6473 The default is @option{-fno-unsafe-math-optimizations}.
6475 @item -fassociative-math
6476 @opindex fassociative-math
6478 Allow re-association of operands in series of floating-point operations.
6479 This violates the ISO C and C++ language standard by possibly changing
6480 computation result.  NOTE: re-ordering may change the sign of zero as
6481 well as ignore NaNs and inhibit or create underflow or overflow (and
6482 thus cannot be used on a code which relies on rounding behavior like
6483 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6484 and thus may not be used when ordered comparisons are required.
6485 This option requires that both @option{-fno-signed-zeros} and
6486 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6487 much sense with @option{-frounding-math}.
6489 The default is @option{-fno-associative-math}.
6491 @item -freciprocal-math
6492 @opindex freciprocal-math
6494 Allow the reciprocal of a value to be used instead of dividing by
6495 the value if this enables optimizations.  For example @code{x / y}
6496 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6497 is subject to common subexpression elimination.  Note that this loses
6498 precision and increases the number of flops operating on the value.
6500 The default is @option{-fno-reciprocal-math}.
6502 @item -ffinite-math-only
6503 @opindex ffinite-math-only
6504 Allow optimizations for floating-point arithmetic that assume
6505 that arguments and results are not NaNs or +-Infs.
6507 This option is not turned on by any @option{-O} option since
6508 it can result in incorrect output for programs which depend on
6509 an exact implementation of IEEE or ISO rules/specifications for
6510 math functions. It may, however, yield faster code for programs
6511 that do not require the guarantees of these specifications.
6513 The default is @option{-fno-finite-math-only}.
6515 @item -fno-signed-zeros
6516 @opindex fno-signed-zeros
6517 Allow optimizations for floating point arithmetic that ignore the
6518 signedness of zero.  IEEE arithmetic specifies the behavior of
6519 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6520 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6521 This option implies that the sign of a zero result isn't significant.
6523 The default is @option{-fsigned-zeros}.
6525 @item -fno-trapping-math
6526 @opindex fno-trapping-math
6527 Compile code assuming that floating-point operations cannot generate
6528 user-visible traps.  These traps include division by zero, overflow,
6529 underflow, inexact result and invalid operation.  This option requires
6530 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6531 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6533 This option should never be turned on by any @option{-O} option since
6534 it can result in incorrect output for programs which depend on
6535 an exact implementation of IEEE or ISO rules/specifications for
6536 math functions.
6538 The default is @option{-ftrapping-math}.
6540 @item -frounding-math
6541 @opindex frounding-math
6542 Disable transformations and optimizations that assume default floating
6543 point rounding behavior.  This is round-to-zero for all floating point
6544 to integer conversions, and round-to-nearest for all other arithmetic
6545 truncations.  This option should be specified for programs that change
6546 the FP rounding mode dynamically, or that may be executed with a
6547 non-default rounding mode.  This option disables constant folding of
6548 floating point expressions at compile-time (which may be affected by
6549 rounding mode) and arithmetic transformations that are unsafe in the
6550 presence of sign-dependent rounding modes.
6552 The default is @option{-fno-rounding-math}.
6554 This option is experimental and does not currently guarantee to
6555 disable all GCC optimizations that are affected by rounding mode.
6556 Future versions of GCC may provide finer control of this setting
6557 using C99's @code{FENV_ACCESS} pragma.  This command line option
6558 will be used to specify the default state for @code{FENV_ACCESS}.
6560 @item -frtl-abstract-sequences
6561 @opindex frtl-abstract-sequences
6562 It is a size optimization method. This option is to find identical
6563 sequences of code, which can be turned into pseudo-procedures  and
6564 then  replace  all  occurrences with  calls to  the  newly created
6565 subroutine. It is kind of an opposite of @option{-finline-functions}.
6566 This optimization runs at RTL level.
6568 @item -fsignaling-nans
6569 @opindex fsignaling-nans
6570 Compile code assuming that IEEE signaling NaNs may generate user-visible
6571 traps during floating-point operations.  Setting this option disables
6572 optimizations that may change the number of exceptions visible with
6573 signaling NaNs.  This option implies @option{-ftrapping-math}.
6575 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6576 be defined.
6578 The default is @option{-fno-signaling-nans}.
6580 This option is experimental and does not currently guarantee to
6581 disable all GCC optimizations that affect signaling NaN behavior.
6583 @item -fsingle-precision-constant
6584 @opindex fsingle-precision-constant
6585 Treat floating point constant as single precision constant instead of
6586 implicitly converting it to double precision constant.
6588 @item -fcx-limited-range
6589 @opindex fcx-limited-range
6590 When enabled, this option states that a range reduction step is not
6591 needed when performing complex division.  Also, there is no checking
6592 whether the result of a complex multiplication or division is @code{NaN
6593 + I*NaN}, with an attempt to rescue the situation in that case.  The
6594 default is @option{-fno-cx-limited-range}, but is enabled by
6595 @option{-ffast-math}.
6597 This option controls the default setting of the ISO C99
6598 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6599 all languages.
6601 @item -fcx-fortran-rules
6602 @opindex fcx-fortran-rules
6603 Complex multiplication and division follow Fortran rules.  Range
6604 reduction is done as part of complex division, but there is no checking
6605 whether the result of a complex multiplication or division is @code{NaN
6606 + I*NaN}, with an attempt to rescue the situation in that case.
6608 The default is @option{-fno-cx-fortran-rules}.
6610 @end table
6612 The following options control optimizations that may improve
6613 performance, but are not enabled by any @option{-O} options.  This
6614 section includes experimental options that may produce broken code.
6616 @table @gcctabopt
6617 @item -fbranch-probabilities
6618 @opindex fbranch-probabilities
6619 After running a program compiled with @option{-fprofile-arcs}
6620 (@pxref{Debugging Options,, Options for Debugging Your Program or
6621 @command{gcc}}), you can compile it a second time using
6622 @option{-fbranch-probabilities}, to improve optimizations based on
6623 the number of times each branch was taken.  When the program
6624 compiled with @option{-fprofile-arcs} exits it saves arc execution
6625 counts to a file called @file{@var{sourcename}.gcda} for each source
6626 file.  The information in this data file is very dependent on the
6627 structure of the generated code, so you must use the same source code
6628 and the same optimization options for both compilations.
6630 With @option{-fbranch-probabilities}, GCC puts a
6631 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6632 These can be used to improve optimization.  Currently, they are only
6633 used in one place: in @file{reorg.c}, instead of guessing which path a
6634 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6635 exactly determine which path is taken more often.
6637 @item -fprofile-values
6638 @opindex fprofile-values
6639 If combined with @option{-fprofile-arcs}, it adds code so that some
6640 data about values of expressions in the program is gathered.
6642 With @option{-fbranch-probabilities}, it reads back the data gathered
6643 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6644 notes to instructions for their later usage in optimizations.
6646 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6648 @item -fvpt
6649 @opindex fvpt
6650 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6651 a code to gather information about values of expressions.
6653 With @option{-fbranch-probabilities}, it reads back the data gathered
6654 and actually performs the optimizations based on them.
6655 Currently the optimizations include specialization of division operation
6656 using the knowledge about the value of the denominator.
6658 @item -frename-registers
6659 @opindex frename-registers
6660 Attempt to avoid false dependencies in scheduled code by making use
6661 of registers left over after register allocation.  This optimization
6662 will most benefit processors with lots of registers.  Depending on the
6663 debug information format adopted by the target, however, it can
6664 make debugging impossible, since variables will no longer stay in
6665 a ``home register''.
6667 Enabled by default with @option{-funroll-loops}.
6669 @item -ftracer
6670 @opindex ftracer
6671 Perform tail duplication to enlarge superblock size.  This transformation
6672 simplifies the control flow of the function allowing other optimizations to do
6673 better job.
6675 Enabled with @option{-fprofile-use}.
6677 @item -funroll-loops
6678 @opindex funroll-loops
6679 Unroll loops whose number of iterations can be determined at compile time or
6680 upon entry to the loop.  @option{-funroll-loops} implies
6681 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6682 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6683 small constant number of iterations).  This option makes code larger, and may
6684 or may not make it run faster.
6686 Enabled with @option{-fprofile-use}.
6688 @item -funroll-all-loops
6689 @opindex funroll-all-loops
6690 Unroll all loops, even if their number of iterations is uncertain when
6691 the loop is entered.  This usually makes programs run more slowly.
6692 @option{-funroll-all-loops} implies the same options as
6693 @option{-funroll-loops}.
6695 @item -fpeel-loops
6696 @opindex fpeel-loops
6697 Peels the loops for that there is enough information that they do not
6698 roll much (from profile feedback).  It also turns on complete loop peeling
6699 (i.e.@: complete removal of loops with small constant number of iterations).
6701 Enabled with @option{-fprofile-use}.
6703 @item -fmove-loop-invariants
6704 @opindex fmove-loop-invariants
6705 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6706 at level @option{-O1}
6708 @item -funswitch-loops
6709 @opindex funswitch-loops
6710 Move branches with loop invariant conditions out of the loop, with duplicates
6711 of the loop on both branches (modified according to result of the condition).
6713 @item -ffunction-sections
6714 @itemx -fdata-sections
6715 @opindex ffunction-sections
6716 @opindex fdata-sections
6717 Place each function or data item into its own section in the output
6718 file if the target supports arbitrary sections.  The name of the
6719 function or the name of the data item determines the section's name
6720 in the output file.
6722 Use these options on systems where the linker can perform optimizations
6723 to improve locality of reference in the instruction space.  Most systems
6724 using the ELF object format and SPARC processors running Solaris 2 have
6725 linkers with such optimizations.  AIX may have these optimizations in
6726 the future.
6728 Only use these options when there are significant benefits from doing
6729 so.  When you specify these options, the assembler and linker will
6730 create larger object and executable files and will also be slower.
6731 You will not be able to use @code{gprof} on all systems if you
6732 specify this option and you may have problems with debugging if
6733 you specify both this option and @option{-g}.
6735 @item -fbranch-target-load-optimize
6736 @opindex fbranch-target-load-optimize
6737 Perform branch target register load optimization before prologue / epilogue
6738 threading.
6739 The use of target registers can typically be exposed only during reload,
6740 thus hoisting loads out of loops and doing inter-block scheduling needs
6741 a separate optimization pass.
6743 @item -fbranch-target-load-optimize2
6744 @opindex fbranch-target-load-optimize2
6745 Perform branch target register load optimization after prologue / epilogue
6746 threading.
6748 @item -fbtr-bb-exclusive
6749 @opindex fbtr-bb-exclusive
6750 When performing branch target register load optimization, don't reuse
6751 branch target registers in within any basic block.
6753 @item -fstack-protector
6754 @opindex fstack-protector
6755 Emit extra code to check for buffer overflows, such as stack smashing
6756 attacks.  This is done by adding a guard variable to functions with
6757 vulnerable objects.  This includes functions that call alloca, and
6758 functions with buffers larger than 8 bytes.  The guards are initialized
6759 when a function is entered and then checked when the function exits.
6760 If a guard check fails, an error message is printed and the program exits.
6762 @item -fstack-protector-all
6763 @opindex fstack-protector-all
6764 Like @option{-fstack-protector} except that all functions are protected.
6766 @item -fsection-anchors
6767 @opindex fsection-anchors
6768 Try to reduce the number of symbolic address calculations by using
6769 shared ``anchor'' symbols to address nearby objects.  This transformation
6770 can help to reduce the number of GOT entries and GOT accesses on some
6771 targets.
6773 For example, the implementation of the following function @code{foo}:
6775 @smallexample
6776 static int a, b, c;
6777 int foo (void) @{ return a + b + c; @}
6778 @end smallexample
6780 would usually calculate the addresses of all three variables, but if you
6781 compile it with @option{-fsection-anchors}, it will access the variables
6782 from a common anchor point instead.  The effect is similar to the
6783 following pseudocode (which isn't valid C):
6785 @smallexample
6786 int foo (void)
6788   register int *xr = &x;
6789   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6791 @end smallexample
6793 Not all targets support this option.
6795 @item --param @var{name}=@var{value}
6796 @opindex param
6797 In some places, GCC uses various constants to control the amount of
6798 optimization that is done.  For example, GCC will not inline functions
6799 that contain more that a certain number of instructions.  You can
6800 control some of these constants on the command-line using the
6801 @option{--param} option.
6803 The names of specific parameters, and the meaning of the values, are
6804 tied to the internals of the compiler, and are subject to change
6805 without notice in future releases.
6807 In each case, the @var{value} is an integer.  The allowable choices for
6808 @var{name} are given in the following table:
6810 @table @gcctabopt
6811 @item sra-max-structure-size
6812 The maximum structure size, in bytes, at which the scalar replacement
6813 of aggregates (SRA) optimization will perform block copies.  The
6814 default value, 0, implies that GCC will select the most appropriate
6815 size itself.
6817 @item sra-field-structure-ratio
6818 The threshold ratio (as a percentage) between instantiated fields and
6819 the complete structure size.  We say that if the ratio of the number
6820 of bytes in instantiated fields to the number of bytes in the complete
6821 structure exceeds this parameter, then block copies are not used.  The
6822 default is 75.
6824 @item struct-reorg-cold-struct-ratio
6825 The threshold ratio (as a percentage) between a structure frequency
6826 and the frequency of the hottest structure in the program.  This parameter
6827 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6828 We say that if the ratio of a structure frequency, calculated by profiling, 
6829 to the hottest structure frequency in the program is less than this 
6830 parameter, then structure reorganization is not applied to this structure.
6831 The default is 10.
6833 @item max-crossjump-edges
6834 The maximum number of incoming edges to consider for crossjumping.
6835 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6836 the number of edges incoming to each block.  Increasing values mean
6837 more aggressive optimization, making the compile time increase with
6838 probably small improvement in executable size.
6840 @item min-crossjump-insns
6841 The minimum number of instructions which must be matched at the end
6842 of two blocks before crossjumping will be performed on them.  This
6843 value is ignored in the case where all instructions in the block being
6844 crossjumped from are matched.  The default value is 5.
6846 @item max-grow-copy-bb-insns
6847 The maximum code size expansion factor when copying basic blocks
6848 instead of jumping.  The expansion is relative to a jump instruction.
6849 The default value is 8.
6851 @item max-goto-duplication-insns
6852 The maximum number of instructions to duplicate to a block that jumps
6853 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6854 passes, GCC factors computed gotos early in the compilation process,
6855 and unfactors them as late as possible.  Only computed jumps at the
6856 end of a basic blocks with no more than max-goto-duplication-insns are
6857 unfactored.  The default value is 8.
6859 @item max-delay-slot-insn-search
6860 The maximum number of instructions to consider when looking for an
6861 instruction to fill a delay slot.  If more than this arbitrary number of
6862 instructions is searched, the time savings from filling the delay slot
6863 will be minimal so stop searching.  Increasing values mean more
6864 aggressive optimization, making the compile time increase with probably
6865 small improvement in executable run time.
6867 @item max-delay-slot-live-search
6868 When trying to fill delay slots, the maximum number of instructions to
6869 consider when searching for a block with valid live register
6870 information.  Increasing this arbitrarily chosen value means more
6871 aggressive optimization, increasing the compile time.  This parameter
6872 should be removed when the delay slot code is rewritten to maintain the
6873 control-flow graph.
6875 @item max-gcse-memory
6876 The approximate maximum amount of memory that will be allocated in
6877 order to perform the global common subexpression elimination
6878 optimization.  If more memory than specified is required, the
6879 optimization will not be done.
6881 @item max-gcse-passes
6882 The maximum number of passes of GCSE to run.  The default is 1.
6884 @item max-pending-list-length
6885 The maximum number of pending dependencies scheduling will allow
6886 before flushing the current state and starting over.  Large functions
6887 with few branches or calls can create excessively large lists which
6888 needlessly consume memory and resources.
6890 @item max-inline-insns-single
6891 Several parameters control the tree inliner used in gcc.
6892 This number sets the maximum number of instructions (counted in GCC's
6893 internal representation) in a single function that the tree inliner
6894 will consider for inlining.  This only affects functions declared
6895 inline and methods implemented in a class declaration (C++).
6896 The default value is 450.
6898 @item max-inline-insns-auto
6899 When you use @option{-finline-functions} (included in @option{-O3}),
6900 a lot of functions that would otherwise not be considered for inlining
6901 by the compiler will be investigated.  To those functions, a different
6902 (more restrictive) limit compared to functions declared inline can
6903 be applied.
6904 The default value is 90.
6906 @item large-function-insns
6907 The limit specifying really large functions.  For functions larger than this
6908 limit after inlining inlining is constrained by
6909 @option{--param large-function-growth}.  This parameter is useful primarily
6910 to avoid extreme compilation time caused by non-linear algorithms used by the
6911 backend.
6912 This parameter is ignored when @option{-funit-at-a-time} is not used.
6913 The default value is 2700.
6915 @item large-function-growth
6916 Specifies maximal growth of large function caused by inlining in percents.
6917 This parameter is ignored when @option{-funit-at-a-time} is not used.
6918 The default value is 100 which limits large function growth to 2.0 times
6919 the original size.
6921 @item large-unit-insns
6922 The limit specifying large translation unit.  Growth caused by inlining of
6923 units larger than this limit is limited by @option{--param inline-unit-growth}.
6924 For small units this might be too tight (consider unit consisting of function A
6925 that is inline and B that just calls A three time.  If B is small relative to
6926 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6927 large units consisting of small inlineable functions however the overall unit
6928 growth limit is needed to avoid exponential explosion of code size.  Thus for
6929 smaller units, the size is increased to @option{--param large-unit-insns}
6930 before applying @option{--param inline-unit-growth}.  The default is 10000
6932 @item inline-unit-growth
6933 Specifies maximal overall growth of the compilation unit caused by inlining.
6934 This parameter is ignored when @option{-funit-at-a-time} is not used.
6935 The default value is 30 which limits unit growth to 1.3 times the original
6936 size.
6938 @item large-stack-frame
6939 The limit specifying large stack frames.  While inlining the algorithm is trying
6940 to not grow past this limit too much.  Default value is 256 bytes.
6942 @item large-stack-frame-growth
6943 Specifies maximal growth of large stack frames caused by inlining in percents.
6944 The default value is 1000 which limits large stack frame growth to 11 times
6945 the original size.
6947 @item max-inline-insns-recursive
6948 @itemx max-inline-insns-recursive-auto
6949 Specifies maximum number of instructions out-of-line copy of self recursive inline
6950 function can grow into by performing recursive inlining.
6952 For functions declared inline @option{--param max-inline-insns-recursive} is
6953 taken into account.  For function not declared inline, recursive inlining
6954 happens only when @option{-finline-functions} (included in @option{-O3}) is
6955 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6956 default value is 450.
6958 @item max-inline-recursive-depth
6959 @itemx max-inline-recursive-depth-auto
6960 Specifies maximum recursion depth used by the recursive inlining.
6962 For functions declared inline @option{--param max-inline-recursive-depth} is
6963 taken into account.  For function not declared inline, recursive inlining
6964 happens only when @option{-finline-functions} (included in @option{-O3}) is
6965 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6966 default value is 8.
6968 @item min-inline-recursive-probability
6969 Recursive inlining is profitable only for function having deep recursion
6970 in average and can hurt for function having little recursion depth by
6971 increasing the prologue size or complexity of function body to other
6972 optimizers.
6974 When profile feedback is available (see @option{-fprofile-generate}) the actual
6975 recursion depth can be guessed from probability that function will recurse via
6976 given call expression.  This parameter limits inlining only to call expression
6977 whose probability exceeds given threshold (in percents).  The default value is
6980 @item inline-call-cost
6981 Specify cost of call instruction relative to simple arithmetics operations
6982 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6983 functions and at the same time increases size of leaf function that is believed to
6984 reduce function size by being inlined.  In effect it increases amount of
6985 inlining for code having large abstraction penalty (many functions that just
6986 pass the arguments to other functions) and decrease inlining for code with low
6987 abstraction penalty.  The default value is 12.
6989 @item min-vect-loop-bound
6990 The minimum number of iterations under which a loop will not get vectorized
6991 when @option{-ftree-vectorize} is used.  The number of iterations after
6992 vectorization needs to be greater than the value specified by this option
6993 to allow vectorization.  The default value is 0.
6995 @item max-unrolled-insns
6996 The maximum number of instructions that a loop should have if that loop
6997 is unrolled, and if the loop is unrolled, it determines how many times
6998 the loop code is unrolled.
7000 @item max-average-unrolled-insns
7001 The maximum number of instructions biased by probabilities of their execution
7002 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7003 it determines how many times the loop code is unrolled.
7005 @item max-unroll-times
7006 The maximum number of unrollings of a single loop.
7008 @item max-peeled-insns
7009 The maximum number of instructions that a loop should have if that loop
7010 is peeled, and if the loop is peeled, it determines how many times
7011 the loop code is peeled.
7013 @item max-peel-times
7014 The maximum number of peelings of a single loop.
7016 @item max-completely-peeled-insns
7017 The maximum number of insns of a completely peeled loop.
7019 @item max-completely-peel-times
7020 The maximum number of iterations of a loop to be suitable for complete peeling.
7022 @item max-unswitch-insns
7023 The maximum number of insns of an unswitched loop.
7025 @item max-unswitch-level
7026 The maximum number of branches unswitched in a single loop.
7028 @item lim-expensive
7029 The minimum cost of an expensive expression in the loop invariant motion.
7031 @item iv-consider-all-candidates-bound
7032 Bound on number of candidates for induction variables below that
7033 all candidates are considered for each use in induction variable
7034 optimizations.  Only the most relevant candidates are considered
7035 if there are more candidates, to avoid quadratic time complexity.
7037 @item iv-max-considered-uses
7038 The induction variable optimizations give up on loops that contain more
7039 induction variable uses.
7041 @item iv-always-prune-cand-set-bound
7042 If number of candidates in the set is smaller than this value,
7043 we always try to remove unnecessary ivs from the set during its
7044 optimization when a new iv is added to the set.
7046 @item scev-max-expr-size
7047 Bound on size of expressions used in the scalar evolutions analyzer.
7048 Large expressions slow the analyzer.
7050 @item omega-max-vars
7051 The maximum number of variables in an Omega constraint system.
7052 The default value is 128.
7054 @item omega-max-geqs
7055 The maximum number of inequalities in an Omega constraint system.
7056 The default value is 256.
7058 @item omega-max-eqs
7059 The maximum number of equalities in an Omega constraint system.
7060 The default value is 128.
7062 @item omega-max-wild-cards
7063 The maximum number of wildcard variables that the Omega solver will
7064 be able to insert.  The default value is 18.
7066 @item omega-hash-table-size
7067 The size of the hash table in the Omega solver.  The default value is
7068 550.
7070 @item omega-max-keys
7071 The maximal number of keys used by the Omega solver.  The default
7072 value is 500.
7074 @item omega-eliminate-redundant-constraints
7075 When set to 1, use expensive methods to eliminate all redundant
7076 constraints.  The default value is 0.
7078 @item vect-max-version-for-alignment-checks
7079 The maximum number of runtime checks that can be performed when
7080 doing loop versioning for alignment in the vectorizer.  See option
7081 ftree-vect-loop-version for more information.
7083 @item vect-max-version-for-alias-checks
7084 The maximum number of runtime checks that can be performed when
7085 doing loop versioning for alias in the vectorizer.  See option
7086 ftree-vect-loop-version for more information.
7088 @item max-iterations-to-track
7090 The maximum number of iterations of a loop the brute force algorithm
7091 for analysis of # of iterations of the loop tries to evaluate.
7093 @item hot-bb-count-fraction
7094 Select fraction of the maximal count of repetitions of basic block in program
7095 given basic block needs to have to be considered hot.
7097 @item hot-bb-frequency-fraction
7098 Select fraction of the maximal frequency of executions of basic block in
7099 function given basic block needs to have to be considered hot
7101 @item max-predicted-iterations
7102 The maximum number of loop iterations we predict statically.  This is useful
7103 in cases where function contain single loop with known bound and other loop
7104 with unknown.  We predict the known number of iterations correctly, while
7105 the unknown number of iterations average to roughly 10.  This means that the
7106 loop without bounds would appear artificially cold relative to the other one.
7108 @item align-threshold
7110 Select fraction of the maximal frequency of executions of basic block in
7111 function given basic block will get aligned.
7113 @item align-loop-iterations
7115 A loop expected to iterate at lest the selected number of iterations will get
7116 aligned.
7118 @item tracer-dynamic-coverage
7119 @itemx tracer-dynamic-coverage-feedback
7121 This value is used to limit superblock formation once the given percentage of
7122 executed instructions is covered.  This limits unnecessary code size
7123 expansion.
7125 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7126 feedback is available.  The real profiles (as opposed to statically estimated
7127 ones) are much less balanced allowing the threshold to be larger value.
7129 @item tracer-max-code-growth
7130 Stop tail duplication once code growth has reached given percentage.  This is
7131 rather hokey argument, as most of the duplicates will be eliminated later in
7132 cross jumping, so it may be set to much higher values than is the desired code
7133 growth.
7135 @item tracer-min-branch-ratio
7137 Stop reverse growth when the reverse probability of best edge is less than this
7138 threshold (in percent).
7140 @item tracer-min-branch-ratio
7141 @itemx tracer-min-branch-ratio-feedback
7143 Stop forward growth if the best edge do have probability lower than this
7144 threshold.
7146 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7147 compilation for profile feedback and one for compilation without.  The value
7148 for compilation with profile feedback needs to be more conservative (higher) in
7149 order to make tracer effective.
7151 @item max-cse-path-length
7153 Maximum number of basic blocks on path that cse considers.  The default is 10.
7155 @item max-cse-insns
7156 The maximum instructions CSE process before flushing. The default is 1000.
7158 @item max-aliased-vops
7160 Maximum number of virtual operands per function allowed to represent
7161 aliases before triggering the alias partitioning heuristic.  Alias
7162 partitioning reduces compile times and memory consumption needed for
7163 aliasing at the expense of precision loss in alias information.  The
7164 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7165 for -O3.
7167 Notice that if a function contains more memory statements than the
7168 value of this parameter, it is not really possible to achieve this
7169 reduction.  In this case, the compiler will use the number of memory
7170 statements as the value for @option{max-aliased-vops}.
7172 @item avg-aliased-vops
7174 Average number of virtual operands per statement allowed to represent
7175 aliases before triggering the alias partitioning heuristic.  This
7176 works in conjunction with @option{max-aliased-vops}.  If a function
7177 contains more than @option{max-aliased-vops} virtual operators, then
7178 memory symbols will be grouped into memory partitions until either the
7179 total number of virtual operators is below @option{max-aliased-vops}
7180 or the average number of virtual operators per memory statement is
7181 below @option{avg-aliased-vops}.  The default value for this parameter
7182 is 1 for -O1 and -O2, and 3 for -O3.
7184 @item ggc-min-expand
7186 GCC uses a garbage collector to manage its own memory allocation.  This
7187 parameter specifies the minimum percentage by which the garbage
7188 collector's heap should be allowed to expand between collections.
7189 Tuning this may improve compilation speed; it has no effect on code
7190 generation.
7192 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7193 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7194 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7195 GCC is not able to calculate RAM on a particular platform, the lower
7196 bound of 30% is used.  Setting this parameter and
7197 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7198 every opportunity.  This is extremely slow, but can be useful for
7199 debugging.
7201 @item ggc-min-heapsize
7203 Minimum size of the garbage collector's heap before it begins bothering
7204 to collect garbage.  The first collection occurs after the heap expands
7205 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7206 tuning this may improve compilation speed, and has no effect on code
7207 generation.
7209 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7210 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7211 with a lower bound of 4096 (four megabytes) and an upper bound of
7212 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7213 particular platform, the lower bound is used.  Setting this parameter
7214 very large effectively disables garbage collection.  Setting this
7215 parameter and @option{ggc-min-expand} to zero causes a full collection
7216 to occur at every opportunity.
7218 @item max-reload-search-insns
7219 The maximum number of instruction reload should look backward for equivalent
7220 register.  Increasing values mean more aggressive optimization, making the
7221 compile time increase with probably slightly better performance.  The default
7222 value is 100.
7224 @item max-cselib-memory-locations
7225 The maximum number of memory locations cselib should take into account.
7226 Increasing values mean more aggressive optimization, making the compile time
7227 increase with probably slightly better performance.  The default value is 500.
7229 @item reorder-blocks-duplicate
7230 @itemx reorder-blocks-duplicate-feedback
7232 Used by basic block reordering pass to decide whether to use unconditional
7233 branch or duplicate the code on its destination.  Code is duplicated when its
7234 estimated size is smaller than this value multiplied by the estimated size of
7235 unconditional jump in the hot spots of the program.
7237 The @option{reorder-block-duplicate-feedback} is used only when profile
7238 feedback is available and may be set to higher values than
7239 @option{reorder-block-duplicate} since information about the hot spots is more
7240 accurate.
7242 @item max-sched-ready-insns
7243 The maximum number of instructions ready to be issued the scheduler should
7244 consider at any given time during the first scheduling pass.  Increasing
7245 values mean more thorough searches, making the compilation time increase
7246 with probably little benefit.  The default value is 100.
7248 @item max-sched-region-blocks
7249 The maximum number of blocks in a region to be considered for
7250 interblock scheduling.  The default value is 10.
7252 @item max-sched-region-insns
7253 The maximum number of insns in a region to be considered for
7254 interblock scheduling.  The default value is 100.
7256 @item min-spec-prob
7257 The minimum probability (in percents) of reaching a source block
7258 for interblock speculative scheduling.  The default value is 40.
7260 @item max-sched-extend-regions-iters
7261 The maximum number of iterations through CFG to extend regions.
7262 0 - disable region extension,
7263 N - do at most N iterations.
7264 The default value is 0.
7266 @item max-sched-insn-conflict-delay
7267 The maximum conflict delay for an insn to be considered for speculative motion.
7268 The default value is 3.
7270 @item sched-spec-prob-cutoff
7271 The minimal probability of speculation success (in percents), so that
7272 speculative insn will be scheduled.
7273 The default value is 40.
7275 @item max-last-value-rtl
7277 The maximum size measured as number of RTLs that can be recorded in an expression
7278 in combiner for a pseudo register as last known value of that register.  The default
7279 is 10000.
7281 @item integer-share-limit
7282 Small integer constants can use a shared data structure, reducing the
7283 compiler's memory usage and increasing its speed.  This sets the maximum
7284 value of a shared integer constant.  The default value is 256.
7286 @item min-virtual-mappings
7287 Specifies the minimum number of virtual mappings in the incremental
7288 SSA updater that should be registered to trigger the virtual mappings
7289 heuristic defined by virtual-mappings-ratio.  The default value is
7290 100.
7292 @item virtual-mappings-ratio
7293 If the number of virtual mappings is virtual-mappings-ratio bigger
7294 than the number of virtual symbols to be updated, then the incremental
7295 SSA updater switches to a full update for those symbols.  The default
7296 ratio is 3.
7298 @item ssp-buffer-size
7299 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7300 protection when @option{-fstack-protection} is used.
7302 @item max-jump-thread-duplication-stmts
7303 Maximum number of statements allowed in a block that needs to be
7304 duplicated when threading jumps.
7306 @item max-fields-for-field-sensitive
7307 Maximum number of fields in a structure we will treat in
7308 a field sensitive manner during pointer analysis.
7310 @item prefetch-latency
7311 Estimate on average number of instructions that are executed before
7312 prefetch finishes.  The distance we prefetch ahead is proportional
7313 to this constant.  Increasing this number may also lead to less
7314 streams being prefetched (see @option{simultaneous-prefetches}).
7316 @item simultaneous-prefetches
7317 Maximum number of prefetches that can run at the same time.
7319 @item l1-cache-line-size
7320 The size of cache line in L1 cache, in bytes.
7322 @item l1-cache-size
7323 The size of L1 cache, in kilobytes.
7325 @item l2-cache-size
7326 The size of L2 cache, in kilobytes.
7328 @item use-canonical-types
7329 Whether the compiler should use the ``canonical'' type system.  By
7330 default, this should always be 1, which uses a more efficient internal
7331 mechanism for comparing types in C++ and Objective-C++.  However, if
7332 bugs in the canonical type system are causing compilation failures,
7333 set this value to 0 to disable canonical types.
7335 @item max-partial-antic-length
7336 Maximum length of the partial antic set computed during the tree
7337 partial redundancy elimination optimization (@option{-ftree-pre}) when
7338 optimizing at @option{-O3} and above.  For some sorts of source code
7339 the enhanced partial redundancy elimination optimization can run away,
7340 consuming all of the memory available on the host machine.  This
7341 parameter sets a limit on the length of the sets that are computed,
7342 which prevents the runaway behaviour.  Setting a value of 0 for
7343 this paramter will allow an unlimited set length.
7345 @item sccvn-max-scc-size
7346 Maximum size of a strongly connected component (SCC) during SCCVN
7347 processing.  If this limit is hit, SCCVN processing for the whole
7348 function will not be done and optimizations depending on it will
7349 be disabled.  The default maximum SCC size is 10000.
7351 @end table
7352 @end table
7354 @node Preprocessor Options
7355 @section Options Controlling the Preprocessor
7356 @cindex preprocessor options
7357 @cindex options, preprocessor
7359 These options control the C preprocessor, which is run on each C source
7360 file before actual compilation.
7362 If you use the @option{-E} option, nothing is done except preprocessing.
7363 Some of these options make sense only together with @option{-E} because
7364 they cause the preprocessor output to be unsuitable for actual
7365 compilation.
7367 @table @gcctabopt
7368 @opindex Wp
7369 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7370 and pass @var{option} directly through to the preprocessor.  If
7371 @var{option} contains commas, it is split into multiple options at the
7372 commas.  However, many options are modified, translated or interpreted
7373 by the compiler driver before being passed to the preprocessor, and
7374 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7375 interface is undocumented and subject to change, so whenever possible
7376 you should avoid using @option{-Wp} and let the driver handle the
7377 options instead.
7379 @item -Xpreprocessor @var{option}
7380 @opindex preprocessor
7381 Pass @var{option} as an option to the preprocessor.  You can use this to
7382 supply system-specific preprocessor options which GCC does not know how to
7383 recognize.
7385 If you want to pass an option that takes an argument, you must use
7386 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7387 @end table
7389 @include cppopts.texi
7391 @node Assembler Options
7392 @section Passing Options to the Assembler
7394 @c prevent bad page break with this line
7395 You can pass options to the assembler.
7397 @table @gcctabopt
7398 @item -Wa,@var{option}
7399 @opindex Wa
7400 Pass @var{option} as an option to the assembler.  If @var{option}
7401 contains commas, it is split into multiple options at the commas.
7403 @item -Xassembler @var{option}
7404 @opindex Xassembler
7405 Pass @var{option} as an option to the assembler.  You can use this to
7406 supply system-specific assembler options which GCC does not know how to
7407 recognize.
7409 If you want to pass an option that takes an argument, you must use
7410 @option{-Xassembler} twice, once for the option and once for the argument.
7412 @end table
7414 @node Link Options
7415 @section Options for Linking
7416 @cindex link options
7417 @cindex options, linking
7419 These options come into play when the compiler links object files into
7420 an executable output file.  They are meaningless if the compiler is
7421 not doing a link step.
7423 @table @gcctabopt
7424 @cindex file names
7425 @item @var{object-file-name}
7426 A file name that does not end in a special recognized suffix is
7427 considered to name an object file or library.  (Object files are
7428 distinguished from libraries by the linker according to the file
7429 contents.)  If linking is done, these object files are used as input
7430 to the linker.
7432 @item -c
7433 @itemx -S
7434 @itemx -E
7435 @opindex c
7436 @opindex S
7437 @opindex E
7438 If any of these options is used, then the linker is not run, and
7439 object file names should not be used as arguments.  @xref{Overall
7440 Options}.
7442 @cindex Libraries
7443 @item -l@var{library}
7444 @itemx -l @var{library}
7445 @opindex l
7446 Search the library named @var{library} when linking.  (The second
7447 alternative with the library as a separate argument is only for
7448 POSIX compliance and is not recommended.)
7450 It makes a difference where in the command you write this option; the
7451 linker searches and processes libraries and object files in the order they
7452 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7453 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7454 to functions in @samp{z}, those functions may not be loaded.
7456 The linker searches a standard list of directories for the library,
7457 which is actually a file named @file{lib@var{library}.a}.  The linker
7458 then uses this file as if it had been specified precisely by name.
7460 The directories searched include several standard system directories
7461 plus any that you specify with @option{-L}.
7463 Normally the files found this way are library files---archive files
7464 whose members are object files.  The linker handles an archive file by
7465 scanning through it for members which define symbols that have so far
7466 been referenced but not defined.  But if the file that is found is an
7467 ordinary object file, it is linked in the usual fashion.  The only
7468 difference between using an @option{-l} option and specifying a file name
7469 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7470 and searches several directories.
7472 @item -lobjc
7473 @opindex lobjc
7474 You need this special case of the @option{-l} option in order to
7475 link an Objective-C or Objective-C++ program.
7477 @item -nostartfiles
7478 @opindex nostartfiles
7479 Do not use the standard system startup files when linking.
7480 The standard system libraries are used normally, unless @option{-nostdlib}
7481 or @option{-nodefaultlibs} is used.
7483 @item -nodefaultlibs
7484 @opindex nodefaultlibs
7485 Do not use the standard system libraries when linking.
7486 Only the libraries you specify will be passed to the linker.
7487 The standard startup files are used normally, unless @option{-nostartfiles}
7488 is used.  The compiler may generate calls to @code{memcmp},
7489 @code{memset}, @code{memcpy} and @code{memmove}.
7490 These entries are usually resolved by entries in
7491 libc.  These entry points should be supplied through some other
7492 mechanism when this option is specified.
7494 @item -nostdlib
7495 @opindex nostdlib
7496 Do not use the standard system startup files or libraries when linking.
7497 No startup files and only the libraries you specify will be passed to
7498 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7499 @code{memcpy} and @code{memmove}.
7500 These entries are usually resolved by entries in
7501 libc.  These entry points should be supplied through some other
7502 mechanism when this option is specified.
7504 @cindex @option{-lgcc}, use with @option{-nostdlib}
7505 @cindex @option{-nostdlib} and unresolved references
7506 @cindex unresolved references and @option{-nostdlib}
7507 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7508 @cindex @option{-nodefaultlibs} and unresolved references
7509 @cindex unresolved references and @option{-nodefaultlibs}
7510 One of the standard libraries bypassed by @option{-nostdlib} and
7511 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7512 that GCC uses to overcome shortcomings of particular machines, or special
7513 needs for some languages.
7514 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7515 Collection (GCC) Internals},
7516 for more discussion of @file{libgcc.a}.)
7517 In most cases, you need @file{libgcc.a} even when you want to avoid
7518 other standard libraries.  In other words, when you specify @option{-nostdlib}
7519 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7520 This ensures that you have no unresolved references to internal GCC
7521 library subroutines.  (For example, @samp{__main}, used to ensure C++
7522 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7523 GNU Compiler Collection (GCC) Internals}.)
7525 @item -pie
7526 @opindex pie
7527 Produce a position independent executable on targets which support it.
7528 For predictable results, you must also specify the same set of options
7529 that were used to generate code (@option{-fpie}, @option{-fPIE},
7530 or model suboptions) when you specify this option.
7532 @item -rdynamic
7533 @opindex rdynamic
7534 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7535 that support it. This instructs the linker to add all symbols, not
7536 only used ones, to the dynamic symbol table. This option is needed
7537 for some uses of @code{dlopen} or to allow obtaining backtraces
7538 from within a program.
7540 @item -s
7541 @opindex s
7542 Remove all symbol table and relocation information from the executable.
7544 @item -static
7545 @opindex static
7546 On systems that support dynamic linking, this prevents linking with the shared
7547 libraries.  On other systems, this option has no effect.
7549 @item -shared
7550 @opindex shared
7551 Produce a shared object which can then be linked with other objects to
7552 form an executable.  Not all systems support this option.  For predictable
7553 results, you must also specify the same set of options that were used to
7554 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7555 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7556 needs to build supplementary stub code for constructors to work.  On
7557 multi-libbed systems, @samp{gcc -shared} must select the correct support
7558 libraries to link against.  Failing to supply the correct flags may lead
7559 to subtle defects.  Supplying them in cases where they are not necessary
7560 is innocuous.}
7562 @item -shared-libgcc
7563 @itemx -static-libgcc
7564 @opindex shared-libgcc
7565 @opindex static-libgcc
7566 On systems that provide @file{libgcc} as a shared library, these options
7567 force the use of either the shared or static version respectively.
7568 If no shared version of @file{libgcc} was built when the compiler was
7569 configured, these options have no effect.
7571 There are several situations in which an application should use the
7572 shared @file{libgcc} instead of the static version.  The most common
7573 of these is when the application wishes to throw and catch exceptions
7574 across different shared libraries.  In that case, each of the libraries
7575 as well as the application itself should use the shared @file{libgcc}.
7577 Therefore, the G++ and GCJ drivers automatically add
7578 @option{-shared-libgcc} whenever you build a shared library or a main
7579 executable, because C++ and Java programs typically use exceptions, so
7580 this is the right thing to do.
7582 If, instead, you use the GCC driver to create shared libraries, you may
7583 find that they will not always be linked with the shared @file{libgcc}.
7584 If GCC finds, at its configuration time, that you have a non-GNU linker
7585 or a GNU linker that does not support option @option{--eh-frame-hdr},
7586 it will link the shared version of @file{libgcc} into shared libraries
7587 by default.  Otherwise, it will take advantage of the linker and optimize
7588 away the linking with the shared version of @file{libgcc}, linking with
7589 the static version of libgcc by default.  This allows exceptions to
7590 propagate through such shared libraries, without incurring relocation
7591 costs at library load time.
7593 However, if a library or main executable is supposed to throw or catch
7594 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7595 for the languages used in the program, or using the option
7596 @option{-shared-libgcc}, such that it is linked with the shared
7597 @file{libgcc}.
7599 @item -symbolic
7600 @opindex symbolic
7601 Bind references to global symbols when building a shared object.  Warn
7602 about any unresolved references (unless overridden by the link editor
7603 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7604 this option.
7606 @item -Xlinker @var{option}
7607 @opindex Xlinker
7608 Pass @var{option} as an option to the linker.  You can use this to
7609 supply system-specific linker options which GCC does not know how to
7610 recognize.
7612 If you want to pass an option that takes an argument, you must use
7613 @option{-Xlinker} twice, once for the option and once for the argument.
7614 For example, to pass @option{-assert definitions}, you must write
7615 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7616 @option{-Xlinker "-assert definitions"}, because this passes the entire
7617 string as a single argument, which is not what the linker expects.
7619 @item -Wl,@var{option}
7620 @opindex Wl
7621 Pass @var{option} as an option to the linker.  If @var{option} contains
7622 commas, it is split into multiple options at the commas.
7624 @item -u @var{symbol}
7625 @opindex u
7626 Pretend the symbol @var{symbol} is undefined, to force linking of
7627 library modules to define it.  You can use @option{-u} multiple times with
7628 different symbols to force loading of additional library modules.
7629 @end table
7631 @node Directory Options
7632 @section Options for Directory Search
7633 @cindex directory options
7634 @cindex options, directory search
7635 @cindex search path
7637 These options specify directories to search for header files, for
7638 libraries and for parts of the compiler:
7640 @table @gcctabopt
7641 @item -I@var{dir}
7642 @opindex I
7643 Add the directory @var{dir} to the head of the list of directories to be
7644 searched for header files.  This can be used to override a system header
7645 file, substituting your own version, since these directories are
7646 searched before the system header file directories.  However, you should
7647 not use this option to add directories that contain vendor-supplied
7648 system header files (use @option{-isystem} for that).  If you use more than
7649 one @option{-I} option, the directories are scanned in left-to-right
7650 order; the standard system directories come after.
7652 If a standard system include directory, or a directory specified with
7653 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7654 option will be ignored.  The directory will still be searched but as a
7655 system directory at its normal position in the system include chain.
7656 This is to ensure that GCC's procedure to fix buggy system headers and
7657 the ordering for the include_next directive are not inadvertently changed.
7658 If you really need to change the search order for system directories,
7659 use the @option{-nostdinc} and/or @option{-isystem} options.
7661 @item -iquote@var{dir}
7662 @opindex iquote
7663 Add the directory @var{dir} to the head of the list of directories to
7664 be searched for header files only for the case of @samp{#include
7665 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7666 otherwise just like @option{-I}.
7668 @item -L@var{dir}
7669 @opindex L
7670 Add directory @var{dir} to the list of directories to be searched
7671 for @option{-l}.
7673 @item -B@var{prefix}
7674 @opindex B
7675 This option specifies where to find the executables, libraries,
7676 include files, and data files of the compiler itself.
7678 The compiler driver program runs one or more of the subprograms
7679 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7680 @var{prefix} as a prefix for each program it tries to run, both with and
7681 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7683 For each subprogram to be run, the compiler driver first tries the
7684 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7685 was not specified, the driver tries two standard prefixes, which are
7686 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7687 those results in a file name that is found, the unmodified program
7688 name is searched for using the directories specified in your
7689 @env{PATH} environment variable.
7691 The compiler will check to see if the path provided by the @option{-B}
7692 refers to a directory, and if necessary it will add a directory
7693 separator character at the end of the path.
7695 @option{-B} prefixes that effectively specify directory names also apply
7696 to libraries in the linker, because the compiler translates these
7697 options into @option{-L} options for the linker.  They also apply to
7698 includes files in the preprocessor, because the compiler translates these
7699 options into @option{-isystem} options for the preprocessor.  In this case,
7700 the compiler appends @samp{include} to the prefix.
7702 The run-time support file @file{libgcc.a} can also be searched for using
7703 the @option{-B} prefix, if needed.  If it is not found there, the two
7704 standard prefixes above are tried, and that is all.  The file is left
7705 out of the link if it is not found by those means.
7707 Another way to specify a prefix much like the @option{-B} prefix is to use
7708 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7709 Variables}.
7711 As a special kludge, if the path provided by @option{-B} is
7712 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7713 9, then it will be replaced by @file{[dir/]include}.  This is to help
7714 with boot-strapping the compiler.
7716 @item -specs=@var{file}
7717 @opindex specs
7718 Process @var{file} after the compiler reads in the standard @file{specs}
7719 file, in order to override the defaults that the @file{gcc} driver
7720 program uses when determining what switches to pass to @file{cc1},
7721 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7722 @option{-specs=@var{file}} can be specified on the command line, and they
7723 are processed in order, from left to right.
7725 @item --sysroot=@var{dir}
7726 @opindex sysroot
7727 Use @var{dir} as the logical root directory for headers and libraries.
7728 For example, if the compiler would normally search for headers in
7729 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7730 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7732 If you use both this option and the @option{-isysroot} option, then
7733 the @option{--sysroot} option will apply to libraries, but the
7734 @option{-isysroot} option will apply to header files.
7736 The GNU linker (beginning with version 2.16) has the necessary support
7737 for this option.  If your linker does not support this option, the
7738 header file aspect of @option{--sysroot} will still work, but the
7739 library aspect will not.
7741 @item -I-
7742 @opindex I-
7743 This option has been deprecated.  Please use @option{-iquote} instead for
7744 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7745 Any directories you specify with @option{-I} options before the @option{-I-}
7746 option are searched only for the case of @samp{#include "@var{file}"};
7747 they are not searched for @samp{#include <@var{file}>}.
7749 If additional directories are specified with @option{-I} options after
7750 the @option{-I-}, these directories are searched for all @samp{#include}
7751 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7752 this way.)
7754 In addition, the @option{-I-} option inhibits the use of the current
7755 directory (where the current input file came from) as the first search
7756 directory for @samp{#include "@var{file}"}.  There is no way to
7757 override this effect of @option{-I-}.  With @option{-I.} you can specify
7758 searching the directory which was current when the compiler was
7759 invoked.  That is not exactly the same as what the preprocessor does
7760 by default, but it is often satisfactory.
7762 @option{-I-} does not inhibit the use of the standard system directories
7763 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7764 independent.
7765 @end table
7767 @c man end
7769 @node Spec Files
7770 @section Specifying subprocesses and the switches to pass to them
7771 @cindex Spec Files
7773 @command{gcc} is a driver program.  It performs its job by invoking a
7774 sequence of other programs to do the work of compiling, assembling and
7775 linking.  GCC interprets its command-line parameters and uses these to
7776 deduce which programs it should invoke, and which command-line options
7777 it ought to place on their command lines.  This behavior is controlled
7778 by @dfn{spec strings}.  In most cases there is one spec string for each
7779 program that GCC can invoke, but a few programs have multiple spec
7780 strings to control their behavior.  The spec strings built into GCC can
7781 be overridden by using the @option{-specs=} command-line switch to specify
7782 a spec file.
7784 @dfn{Spec files} are plaintext files that are used to construct spec
7785 strings.  They consist of a sequence of directives separated by blank
7786 lines.  The type of directive is determined by the first non-whitespace
7787 character on the line and it can be one of the following:
7789 @table @code
7790 @item %@var{command}
7791 Issues a @var{command} to the spec file processor.  The commands that can
7792 appear here are:
7794 @table @code
7795 @item %include <@var{file}>
7796 @cindex %include
7797 Search for @var{file} and insert its text at the current point in the
7798 specs file.
7800 @item %include_noerr <@var{file}>
7801 @cindex %include_noerr
7802 Just like @samp{%include}, but do not generate an error message if the include
7803 file cannot be found.
7805 @item %rename @var{old_name} @var{new_name}
7806 @cindex %rename
7807 Rename the spec string @var{old_name} to @var{new_name}.
7809 @end table
7811 @item *[@var{spec_name}]:
7812 This tells the compiler to create, override or delete the named spec
7813 string.  All lines after this directive up to the next directive or
7814 blank line are considered to be the text for the spec string.  If this
7815 results in an empty string then the spec will be deleted.  (Or, if the
7816 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7817 does not currently exist a new spec will be created.  If the spec does
7818 exist then its contents will be overridden by the text of this
7819 directive, unless the first character of that text is the @samp{+}
7820 character, in which case the text will be appended to the spec.
7822 @item [@var{suffix}]:
7823 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7824 and up to the next directive or blank line are considered to make up the
7825 spec string for the indicated suffix.  When the compiler encounters an
7826 input file with the named suffix, it will processes the spec string in
7827 order to work out how to compile that file.  For example:
7829 @smallexample
7830 .ZZ:
7831 z-compile -input %i
7832 @end smallexample
7834 This says that any input file whose name ends in @samp{.ZZ} should be
7835 passed to the program @samp{z-compile}, which should be invoked with the
7836 command-line switch @option{-input} and with the result of performing the
7837 @samp{%i} substitution.  (See below.)
7839 As an alternative to providing a spec string, the text that follows a
7840 suffix directive can be one of the following:
7842 @table @code
7843 @item @@@var{language}
7844 This says that the suffix is an alias for a known @var{language}.  This is
7845 similar to using the @option{-x} command-line switch to GCC to specify a
7846 language explicitly.  For example:
7848 @smallexample
7849 .ZZ:
7850 @@c++
7851 @end smallexample
7853 Says that .ZZ files are, in fact, C++ source files.
7855 @item #@var{name}
7856 This causes an error messages saying:
7858 @smallexample
7859 @var{name} compiler not installed on this system.
7860 @end smallexample
7861 @end table
7863 GCC already has an extensive list of suffixes built into it.
7864 This directive will add an entry to the end of the list of suffixes, but
7865 since the list is searched from the end backwards, it is effectively
7866 possible to override earlier entries using this technique.
7868 @end table
7870 GCC has the following spec strings built into it.  Spec files can
7871 override these strings or create their own.  Note that individual
7872 targets can also add their own spec strings to this list.
7874 @smallexample
7875 asm          Options to pass to the assembler
7876 asm_final    Options to pass to the assembler post-processor
7877 cpp          Options to pass to the C preprocessor
7878 cc1          Options to pass to the C compiler
7879 cc1plus      Options to pass to the C++ compiler
7880 endfile      Object files to include at the end of the link
7881 link         Options to pass to the linker
7882 lib          Libraries to include on the command line to the linker
7883 libgcc       Decides which GCC support library to pass to the linker
7884 linker       Sets the name of the linker
7885 predefines   Defines to be passed to the C preprocessor
7886 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7887              by default
7888 startfile    Object files to include at the start of the link
7889 @end smallexample
7891 Here is a small example of a spec file:
7893 @smallexample
7894 %rename lib                 old_lib
7896 *lib:
7897 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7898 @end smallexample
7900 This example renames the spec called @samp{lib} to @samp{old_lib} and
7901 then overrides the previous definition of @samp{lib} with a new one.
7902 The new definition adds in some extra command-line options before
7903 including the text of the old definition.
7905 @dfn{Spec strings} are a list of command-line options to be passed to their
7906 corresponding program.  In addition, the spec strings can contain
7907 @samp{%}-prefixed sequences to substitute variable text or to
7908 conditionally insert text into the command line.  Using these constructs
7909 it is possible to generate quite complex command lines.
7911 Here is a table of all defined @samp{%}-sequences for spec
7912 strings.  Note that spaces are not generated automatically around the
7913 results of expanding these sequences.  Therefore you can concatenate them
7914 together or combine them with constant text in a single argument.
7916 @table @code
7917 @item %%
7918 Substitute one @samp{%} into the program name or argument.
7920 @item %i
7921 Substitute the name of the input file being processed.
7923 @item %b
7924 Substitute the basename of the input file being processed.
7925 This is the substring up to (and not including) the last period
7926 and not including the directory.
7928 @item %B
7929 This is the same as @samp{%b}, but include the file suffix (text after
7930 the last period).
7932 @item %d
7933 Marks the argument containing or following the @samp{%d} as a
7934 temporary file name, so that that file will be deleted if GCC exits
7935 successfully.  Unlike @samp{%g}, this contributes no text to the
7936 argument.
7938 @item %g@var{suffix}
7939 Substitute a file name that has suffix @var{suffix} and is chosen
7940 once per compilation, and mark the argument in the same way as
7941 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7942 name is now chosen in a way that is hard to predict even when previously
7943 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7944 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7945 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7946 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7947 was simply substituted with a file name chosen once per compilation,
7948 without regard to any appended suffix (which was therefore treated
7949 just like ordinary text), making such attacks more likely to succeed.
7951 @item %u@var{suffix}
7952 Like @samp{%g}, but generates a new temporary file name even if
7953 @samp{%u@var{suffix}} was already seen.
7955 @item %U@var{suffix}
7956 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7957 new one if there is no such last file name.  In the absence of any
7958 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7959 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7960 would involve the generation of two distinct file names, one
7961 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7962 simply substituted with a file name chosen for the previous @samp{%u},
7963 without regard to any appended suffix.
7965 @item %j@var{suffix}
7966 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7967 writable, and if save-temps is off; otherwise, substitute the name
7968 of a temporary file, just like @samp{%u}.  This temporary file is not
7969 meant for communication between processes, but rather as a junk
7970 disposal mechanism.
7972 @item %|@var{suffix}
7973 @itemx %m@var{suffix}
7974 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7975 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7976 all.  These are the two most common ways to instruct a program that it
7977 should read from standard input or write to standard output.  If you
7978 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7979 construct: see for example @file{f/lang-specs.h}.
7981 @item %.@var{SUFFIX}
7982 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7983 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7984 terminated by the next space or %.
7986 @item %w
7987 Marks the argument containing or following the @samp{%w} as the
7988 designated output file of this compilation.  This puts the argument
7989 into the sequence of arguments that @samp{%o} will substitute later.
7991 @item %o
7992 Substitutes the names of all the output files, with spaces
7993 automatically placed around them.  You should write spaces
7994 around the @samp{%o} as well or the results are undefined.
7995 @samp{%o} is for use in the specs for running the linker.
7996 Input files whose names have no recognized suffix are not compiled
7997 at all, but they are included among the output files, so they will
7998 be linked.
8000 @item %O
8001 Substitutes the suffix for object files.  Note that this is
8002 handled specially when it immediately follows @samp{%g, %u, or %U},
8003 because of the need for those to form complete file names.  The
8004 handling is such that @samp{%O} is treated exactly as if it had already
8005 been substituted, except that @samp{%g, %u, and %U} do not currently
8006 support additional @var{suffix} characters following @samp{%O} as they would
8007 following, for example, @samp{.o}.
8009 @item %p
8010 Substitutes the standard macro predefinitions for the
8011 current target machine.  Use this when running @code{cpp}.
8013 @item %P
8014 Like @samp{%p}, but puts @samp{__} before and after the name of each
8015 predefined macro, except for macros that start with @samp{__} or with
8016 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8019 @item %I
8020 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8021 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8022 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8023 and @option{-imultilib} as necessary.
8025 @item %s
8026 Current argument is the name of a library or startup file of some sort.
8027 Search for that file in a standard list of directories and substitute
8028 the full name found.
8030 @item %e@var{str}
8031 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8032 Use this when inconsistent options are detected.
8034 @item %(@var{name})
8035 Substitute the contents of spec string @var{name} at this point.
8037 @item %[@var{name}]
8038 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8040 @item %x@{@var{option}@}
8041 Accumulate an option for @samp{%X}.
8043 @item %X
8044 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8045 spec string.
8047 @item %Y
8048 Output the accumulated assembler options specified by @option{-Wa}.
8050 @item %Z
8051 Output the accumulated preprocessor options specified by @option{-Wp}.
8053 @item %a
8054 Process the @code{asm} spec.  This is used to compute the
8055 switches to be passed to the assembler.
8057 @item %A
8058 Process the @code{asm_final} spec.  This is a spec string for
8059 passing switches to an assembler post-processor, if such a program is
8060 needed.
8062 @item %l
8063 Process the @code{link} spec.  This is the spec for computing the
8064 command line passed to the linker.  Typically it will make use of the
8065 @samp{%L %G %S %D and %E} sequences.
8067 @item %D
8068 Dump out a @option{-L} option for each directory that GCC believes might
8069 contain startup files.  If the target supports multilibs then the
8070 current multilib directory will be prepended to each of these paths.
8072 @item %L
8073 Process the @code{lib} spec.  This is a spec string for deciding which
8074 libraries should be included on the command line to the linker.
8076 @item %G
8077 Process the @code{libgcc} spec.  This is a spec string for deciding
8078 which GCC support library should be included on the command line to the linker.
8080 @item %S
8081 Process the @code{startfile} spec.  This is a spec for deciding which
8082 object files should be the first ones passed to the linker.  Typically
8083 this might be a file named @file{crt0.o}.
8085 @item %E
8086 Process the @code{endfile} spec.  This is a spec string that specifies
8087 the last object files that will be passed to the linker.
8089 @item %C
8090 Process the @code{cpp} spec.  This is used to construct the arguments
8091 to be passed to the C preprocessor.
8093 @item %1
8094 Process the @code{cc1} spec.  This is used to construct the options to be
8095 passed to the actual C compiler (@samp{cc1}).
8097 @item %2
8098 Process the @code{cc1plus} spec.  This is used to construct the options to be
8099 passed to the actual C++ compiler (@samp{cc1plus}).
8101 @item %*
8102 Substitute the variable part of a matched option.  See below.
8103 Note that each comma in the substituted string is replaced by
8104 a single space.
8106 @item %<@code{S}
8107 Remove all occurrences of @code{-S} from the command line.  Note---this
8108 command is position dependent.  @samp{%} commands in the spec string
8109 before this one will see @code{-S}, @samp{%} commands in the spec string
8110 after this one will not.
8112 @item %:@var{function}(@var{args})
8113 Call the named function @var{function}, passing it @var{args}.
8114 @var{args} is first processed as a nested spec string, then split
8115 into an argument vector in the usual fashion.  The function returns
8116 a string which is processed as if it had appeared literally as part
8117 of the current spec.
8119 The following built-in spec functions are provided:
8121 @table @code
8122 @item @code{getenv}
8123 The @code{getenv} spec function takes two arguments: an environment
8124 variable name and a string.  If the environment variable is not
8125 defined, a fatal error is issued.  Otherwise, the return value is the
8126 value of the environment variable concatenated with the string.  For
8127 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8129 @smallexample
8130 %:getenv(TOPDIR /include)
8131 @end smallexample
8133 expands to @file{/path/to/top/include}.
8135 @item @code{if-exists}
8136 The @code{if-exists} spec function takes one argument, an absolute
8137 pathname to a file.  If the file exists, @code{if-exists} returns the
8138 pathname.  Here is a small example of its usage:
8140 @smallexample
8141 *startfile:
8142 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8143 @end smallexample
8145 @item @code{if-exists-else}
8146 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8147 spec function, except that it takes two arguments.  The first argument is
8148 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8149 returns the pathname.  If it does not exist, it returns the second argument.
8150 This way, @code{if-exists-else} can be used to select one file or another,
8151 based on the existence of the first.  Here is a small example of its usage:
8153 @smallexample
8154 *startfile:
8155 crt0%O%s %:if-exists(crti%O%s) \
8156 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8157 @end smallexample
8159 @item @code{replace-outfile}
8160 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8161 first argument in the outfiles array and replaces it with the second argument.  Here
8162 is a small example of its usage:
8164 @smallexample
8165 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8166 @end smallexample
8168 @item @code{print-asm-header}
8169 The @code{print-asm-header} function takes no arguments and simply
8170 prints a banner like:
8172 @smallexample
8173 Assembler options
8174 =================
8176 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8177 @end smallexample
8179 It is used to separate compiler options from assembler options
8180 in the @option{--target-help} output.
8181 @end table
8183 @item %@{@code{S}@}
8184 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8185 If that switch was not specified, this substitutes nothing.  Note that
8186 the leading dash is omitted when specifying this option, and it is
8187 automatically inserted if the substitution is performed.  Thus the spec
8188 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8189 and would output the command line option @option{-foo}.
8191 @item %W@{@code{S}@}
8192 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8193 deleted on failure.
8195 @item %@{@code{S}*@}
8196 Substitutes all the switches specified to GCC whose names start
8197 with @code{-S}, but which also take an argument.  This is used for
8198 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8199 GCC considers @option{-o foo} as being
8200 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8201 text, including the space.  Thus two arguments would be generated.
8203 @item %@{@code{S}*&@code{T}*@}
8204 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8205 (the order of @code{S} and @code{T} in the spec is not significant).
8206 There can be any number of ampersand-separated variables; for each the
8207 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8209 @item %@{@code{S}:@code{X}@}
8210 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8212 @item %@{!@code{S}:@code{X}@}
8213 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8215 @item %@{@code{S}*:@code{X}@}
8216 Substitutes @code{X} if one or more switches whose names start with
8217 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8218 once, no matter how many such switches appeared.  However, if @code{%*}
8219 appears somewhere in @code{X}, then @code{X} will be substituted once
8220 for each matching switch, with the @code{%*} replaced by the part of
8221 that switch that matched the @code{*}.
8223 @item %@{.@code{S}:@code{X}@}
8224 Substitutes @code{X}, if processing a file with suffix @code{S}.
8226 @item %@{!.@code{S}:@code{X}@}
8227 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8229 @item %@{,@code{S}:@code{X}@}
8230 Substitutes @code{X}, if processing a file for language @code{S}.
8232 @item %@{!,@code{S}:@code{X}@}
8233 Substitutes @code{X}, if not processing a file for language @code{S}.
8235 @item %@{@code{S}|@code{P}:@code{X}@}
8236 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8237 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8238 @code{*} sequences as well, although they have a stronger binding than
8239 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8240 alternatives must be starred, and only the first matching alternative
8241 is substituted.
8243 For example, a spec string like this:
8245 @smallexample
8246 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8247 @end smallexample
8249 will output the following command-line options from the following input
8250 command-line options:
8252 @smallexample
8253 fred.c        -foo -baz
8254 jim.d         -bar -boggle
8255 -d fred.c     -foo -baz -boggle
8256 -d jim.d      -bar -baz -boggle
8257 @end smallexample
8259 @item %@{S:X; T:Y; :D@}
8261 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8262 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8263 be as many clauses as you need.  This may be combined with @code{.},
8264 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8267 @end table
8269 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8270 construct may contain other nested @samp{%} constructs or spaces, or
8271 even newlines.  They are processed as usual, as described above.
8272 Trailing white space in @code{X} is ignored.  White space may also
8273 appear anywhere on the left side of the colon in these constructs,
8274 except between @code{.} or @code{*} and the corresponding word.
8276 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8277 handled specifically in these constructs.  If another value of
8278 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8279 @option{-W} switch is found later in the command line, the earlier
8280 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8281 just one letter, which passes all matching options.
8283 The character @samp{|} at the beginning of the predicate text is used to
8284 indicate that a command should be piped to the following command, but
8285 only if @option{-pipe} is specified.
8287 It is built into GCC which switches take arguments and which do not.
8288 (You might think it would be useful to generalize this to allow each
8289 compiler's spec to say which switches take arguments.  But this cannot
8290 be done in a consistent fashion.  GCC cannot even decide which input
8291 files have been specified without knowing which switches take arguments,
8292 and it must know which input files to compile in order to tell which
8293 compilers to run).
8295 GCC also knows implicitly that arguments starting in @option{-l} are to be
8296 treated as compiler output files, and passed to the linker in their
8297 proper position among the other output files.
8299 @c man begin OPTIONS
8301 @node Target Options
8302 @section Specifying Target Machine and Compiler Version
8303 @cindex target options
8304 @cindex cross compiling
8305 @cindex specifying machine version
8306 @cindex specifying compiler version and target machine
8307 @cindex compiler version, specifying
8308 @cindex target machine, specifying
8310 The usual way to run GCC is to run the executable called @file{gcc}, or
8311 @file{<machine>-gcc} when cross-compiling, or
8312 @file{<machine>-gcc-<version>} to run a version other than the one that
8313 was installed last.  Sometimes this is inconvenient, so GCC provides
8314 options that will switch to another cross-compiler or version.
8316 @table @gcctabopt
8317 @item -b @var{machine}
8318 @opindex b
8319 The argument @var{machine} specifies the target machine for compilation.
8321 The value to use for @var{machine} is the same as was specified as the
8322 machine type when configuring GCC as a cross-compiler.  For
8323 example, if a cross-compiler was configured with @samp{configure
8324 arm-elf}, meaning to compile for an arm processor with elf binaries,
8325 then you would specify @option{-b arm-elf} to run that cross compiler.
8326 Because there are other options beginning with @option{-b}, the
8327 configuration must contain a hyphen.
8329 @item -V @var{version}
8330 @opindex V
8331 The argument @var{version} specifies which version of GCC to run.
8332 This is useful when multiple versions are installed.  For example,
8333 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8334 @end table
8336 The @option{-V} and @option{-b} options work by running the
8337 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8338 use them if you can just run that directly.
8340 @node Submodel Options
8341 @section Hardware Models and Configurations
8342 @cindex submodel options
8343 @cindex specifying hardware config
8344 @cindex hardware models and configurations, specifying
8345 @cindex machine dependent options
8347 Earlier we discussed the standard option @option{-b} which chooses among
8348 different installed compilers for completely different target
8349 machines, such as VAX vs.@: 68000 vs.@: 80386.
8351 In addition, each of these target machine types can have its own
8352 special options, starting with @samp{-m}, to choose among various
8353 hardware models or configurations---for example, 68010 vs 68020,
8354 floating coprocessor or none.  A single installed version of the
8355 compiler can compile for any model or configuration, according to the
8356 options specified.
8358 Some configurations of the compiler also support additional special
8359 options, usually for compatibility with other compilers on the same
8360 platform.
8362 @c This list is ordered alphanumerically by subsection name.
8363 @c It should be the same order and spelling as these options are listed
8364 @c in Machine Dependent Options
8366 @menu
8367 * ARC Options::
8368 * ARM Options::
8369 * AVR Options::
8370 * Blackfin Options::
8371 * CRIS Options::
8372 * CRX Options::
8373 * Darwin Options::
8374 * DEC Alpha Options::
8375 * DEC Alpha/VMS Options::
8376 * FRV Options::
8377 * GNU/Linux Options::
8378 * H8/300 Options::
8379 * HPPA Options::
8380 * i386 and x86-64 Options::
8381 * IA-64 Options::
8382 * M32C Options::
8383 * M32R/D Options::
8384 * M680x0 Options::
8385 * M68hc1x Options::
8386 * MCore Options::
8387 * MIPS Options::
8388 * MMIX Options::
8389 * MN10300 Options::
8390 * PDP-11 Options::
8391 * PowerPC Options::
8392 * RS/6000 and PowerPC Options::
8393 * S/390 and zSeries Options::
8394 * Score Options::
8395 * SH Options::
8396 * SPARC Options::
8397 * SPU Options::
8398 * System V Options::
8399 * V850 Options::
8400 * VAX Options::
8401 * VxWorks Options::
8402 * x86-64 Options::
8403 * Xstormy16 Options::
8404 * Xtensa Options::
8405 * zSeries Options::
8406 @end menu
8408 @node ARC Options
8409 @subsection ARC Options
8410 @cindex ARC Options
8412 These options are defined for ARC implementations:
8414 @table @gcctabopt
8415 @item -EL
8416 @opindex EL
8417 Compile code for little endian mode.  This is the default.
8419 @item -EB
8420 @opindex EB
8421 Compile code for big endian mode.
8423 @item -mmangle-cpu
8424 @opindex mmangle-cpu
8425 Prepend the name of the cpu to all public symbol names.
8426 In multiple-processor systems, there are many ARC variants with different
8427 instruction and register set characteristics.  This flag prevents code
8428 compiled for one cpu to be linked with code compiled for another.
8429 No facility exists for handling variants that are ``almost identical''.
8430 This is an all or nothing option.
8432 @item -mcpu=@var{cpu}
8433 @opindex mcpu
8434 Compile code for ARC variant @var{cpu}.
8435 Which variants are supported depend on the configuration.
8436 All variants support @option{-mcpu=base}, this is the default.
8438 @item -mtext=@var{text-section}
8439 @itemx -mdata=@var{data-section}
8440 @itemx -mrodata=@var{readonly-data-section}
8441 @opindex mtext
8442 @opindex mdata
8443 @opindex mrodata
8444 Put functions, data, and readonly data in @var{text-section},
8445 @var{data-section}, and @var{readonly-data-section} respectively
8446 by default.  This can be overridden with the @code{section} attribute.
8447 @xref{Variable Attributes}.
8449 @end table
8451 @node ARM Options
8452 @subsection ARM Options
8453 @cindex ARM options
8455 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8456 architectures:
8458 @table @gcctabopt
8459 @item -mabi=@var{name}
8460 @opindex mabi
8461 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8462 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8464 @item -mapcs-frame
8465 @opindex mapcs-frame
8466 Generate a stack frame that is compliant with the ARM Procedure Call
8467 Standard for all functions, even if this is not strictly necessary for
8468 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8469 with this option will cause the stack frames not to be generated for
8470 leaf functions.  The default is @option{-mno-apcs-frame}.
8472 @item -mapcs
8473 @opindex mapcs
8474 This is a synonym for @option{-mapcs-frame}.
8476 @ignore
8477 @c not currently implemented
8478 @item -mapcs-stack-check
8479 @opindex mapcs-stack-check
8480 Generate code to check the amount of stack space available upon entry to
8481 every function (that actually uses some stack space).  If there is
8482 insufficient space available then either the function
8483 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8484 called, depending upon the amount of stack space required.  The run time
8485 system is required to provide these functions.  The default is
8486 @option{-mno-apcs-stack-check}, since this produces smaller code.
8488 @c not currently implemented
8489 @item -mapcs-float
8490 @opindex mapcs-float
8491 Pass floating point arguments using the float point registers.  This is
8492 one of the variants of the APCS@.  This option is recommended if the
8493 target hardware has a floating point unit or if a lot of floating point
8494 arithmetic is going to be performed by the code.  The default is
8495 @option{-mno-apcs-float}, since integer only code is slightly increased in
8496 size if @option{-mapcs-float} is used.
8498 @c not currently implemented
8499 @item -mapcs-reentrant
8500 @opindex mapcs-reentrant
8501 Generate reentrant, position independent code.  The default is
8502 @option{-mno-apcs-reentrant}.
8503 @end ignore
8505 @item -mthumb-interwork
8506 @opindex mthumb-interwork
8507 Generate code which supports calling between the ARM and Thumb
8508 instruction sets.  Without this option the two instruction sets cannot
8509 be reliably used inside one program.  The default is
8510 @option{-mno-thumb-interwork}, since slightly larger code is generated
8511 when @option{-mthumb-interwork} is specified.
8513 @item -mno-sched-prolog
8514 @opindex mno-sched-prolog
8515 Prevent the reordering of instructions in the function prolog, or the
8516 merging of those instruction with the instructions in the function's
8517 body.  This means that all functions will start with a recognizable set
8518 of instructions (or in fact one of a choice from a small set of
8519 different function prologues), and this information can be used to
8520 locate the start if functions inside an executable piece of code.  The
8521 default is @option{-msched-prolog}.
8523 @item -mhard-float
8524 @opindex mhard-float
8525 Generate output containing floating point instructions.  This is the
8526 default.
8528 @item -msoft-float
8529 @opindex msoft-float
8530 Generate output containing library calls for floating point.
8531 @strong{Warning:} the requisite libraries are not available for all ARM
8532 targets.  Normally the facilities of the machine's usual C compiler are
8533 used, but this cannot be done directly in cross-compilation.  You must make
8534 your own arrangements to provide suitable library functions for
8535 cross-compilation.
8537 @option{-msoft-float} changes the calling convention in the output file;
8538 therefore, it is only useful if you compile @emph{all} of a program with
8539 this option.  In particular, you need to compile @file{libgcc.a}, the
8540 library that comes with GCC, with @option{-msoft-float} in order for
8541 this to work.
8543 @item -mfloat-abi=@var{name}
8544 @opindex mfloat-abi
8545 Specifies which ABI to use for floating point values.  Permissible values
8546 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8548 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8549 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8550 of floating point instructions, but still uses the soft-float calling
8551 conventions.
8553 @item -mlittle-endian
8554 @opindex mlittle-endian
8555 Generate code for a processor running in little-endian mode.  This is
8556 the default for all standard configurations.
8558 @item -mbig-endian
8559 @opindex mbig-endian
8560 Generate code for a processor running in big-endian mode; the default is
8561 to compile code for a little-endian processor.
8563 @item -mwords-little-endian
8564 @opindex mwords-little-endian
8565 This option only applies when generating code for big-endian processors.
8566 Generate code for a little-endian word order but a big-endian byte
8567 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8568 option should only be used if you require compatibility with code for
8569 big-endian ARM processors generated by versions of the compiler prior to
8570 2.8.
8572 @item -mcpu=@var{name}
8573 @opindex mcpu
8574 This specifies the name of the target ARM processor.  GCC uses this name
8575 to determine what kind of instructions it can emit when generating
8576 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8577 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8578 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8579 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8580 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8581 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8582 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8583 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8584 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8585 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8586 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8587 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8588 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8589 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8590 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8591 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8593 @item -mtune=@var{name}
8594 @opindex mtune
8595 This option is very similar to the @option{-mcpu=} option, except that
8596 instead of specifying the actual target processor type, and hence
8597 restricting which instructions can be used, it specifies that GCC should
8598 tune the performance of the code as if the target were of the type
8599 specified in this option, but still choosing the instructions that it
8600 will generate based on the cpu specified by a @option{-mcpu=} option.
8601 For some ARM implementations better performance can be obtained by using
8602 this option.
8604 @item -march=@var{name}
8605 @opindex march
8606 This specifies the name of the target ARM architecture.  GCC uses this
8607 name to determine what kind of instructions it can emit when generating
8608 assembly code.  This option can be used in conjunction with or instead
8609 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8610 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8611 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8612 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8613 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8614 @samp{iwmmxt}, @samp{ep9312}.
8616 @item -mfpu=@var{name}
8617 @itemx -mfpe=@var{number}
8618 @itemx -mfp=@var{number}
8619 @opindex mfpu
8620 @opindex mfpe
8621 @opindex mfp
8622 This specifies what floating point hardware (or hardware emulation) is
8623 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8624 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8625 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8626 with older versions of GCC@.
8628 If @option{-msoft-float} is specified this specifies the format of
8629 floating point values.
8631 @item -mstructure-size-boundary=@var{n}
8632 @opindex mstructure-size-boundary
8633 The size of all structures and unions will be rounded up to a multiple
8634 of the number of bits set by this option.  Permissible values are 8, 32
8635 and 64.  The default value varies for different toolchains.  For the COFF
8636 targeted toolchain the default value is 8.  A value of 64 is only allowed
8637 if the underlying ABI supports it.
8639 Specifying the larger number can produce faster, more efficient code, but
8640 can also increase the size of the program.  Different values are potentially
8641 incompatible.  Code compiled with one value cannot necessarily expect to
8642 work with code or libraries compiled with another value, if they exchange
8643 information using structures or unions.
8645 @item -mabort-on-noreturn
8646 @opindex mabort-on-noreturn
8647 Generate a call to the function @code{abort} at the end of a
8648 @code{noreturn} function.  It will be executed if the function tries to
8649 return.
8651 @item -mlong-calls
8652 @itemx -mno-long-calls
8653 @opindex mlong-calls
8654 @opindex mno-long-calls
8655 Tells the compiler to perform function calls by first loading the
8656 address of the function into a register and then performing a subroutine
8657 call on this register.  This switch is needed if the target function
8658 will lie outside of the 64 megabyte addressing range of the offset based
8659 version of subroutine call instruction.
8661 Even if this switch is enabled, not all function calls will be turned
8662 into long calls.  The heuristic is that static functions, functions
8663 which have the @samp{short-call} attribute, functions that are inside
8664 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8665 definitions have already been compiled within the current compilation
8666 unit, will not be turned into long calls.  The exception to this rule is
8667 that weak function definitions, functions with the @samp{long-call}
8668 attribute or the @samp{section} attribute, and functions that are within
8669 the scope of a @samp{#pragma long_calls} directive, will always be
8670 turned into long calls.
8672 This feature is not enabled by default.  Specifying
8673 @option{-mno-long-calls} will restore the default behavior, as will
8674 placing the function calls within the scope of a @samp{#pragma
8675 long_calls_off} directive.  Note these switches have no effect on how
8676 the compiler generates code to handle function calls via function
8677 pointers.
8679 @item -mnop-fun-dllimport
8680 @opindex mnop-fun-dllimport
8681 Disable support for the @code{dllimport} attribute.
8683 @item -msingle-pic-base
8684 @opindex msingle-pic-base
8685 Treat the register used for PIC addressing as read-only, rather than
8686 loading it in the prologue for each function.  The run-time system is
8687 responsible for initializing this register with an appropriate value
8688 before execution begins.
8690 @item -mpic-register=@var{reg}
8691 @opindex mpic-register
8692 Specify the register to be used for PIC addressing.  The default is R10
8693 unless stack-checking is enabled, when R9 is used.
8695 @item -mcirrus-fix-invalid-insns
8696 @opindex mcirrus-fix-invalid-insns
8697 @opindex mno-cirrus-fix-invalid-insns
8698 Insert NOPs into the instruction stream to in order to work around
8699 problems with invalid Maverick instruction combinations.  This option
8700 is only valid if the @option{-mcpu=ep9312} option has been used to
8701 enable generation of instructions for the Cirrus Maverick floating
8702 point co-processor.  This option is not enabled by default, since the
8703 problem is only present in older Maverick implementations.  The default
8704 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8705 switch.
8707 @item -mpoke-function-name
8708 @opindex mpoke-function-name
8709 Write the name of each function into the text section, directly
8710 preceding the function prologue.  The generated code is similar to this:
8712 @smallexample
8713      t0
8714          .ascii "arm_poke_function_name", 0
8715          .align
8716      t1
8717          .word 0xff000000 + (t1 - t0)
8718      arm_poke_function_name
8719          mov     ip, sp
8720          stmfd   sp!, @{fp, ip, lr, pc@}
8721          sub     fp, ip, #4
8722 @end smallexample
8724 When performing a stack backtrace, code can inspect the value of
8725 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8726 location @code{pc - 12} and the top 8 bits are set, then we know that
8727 there is a function name embedded immediately preceding this location
8728 and has length @code{((pc[-3]) & 0xff000000)}.
8730 @item -mthumb
8731 @opindex mthumb
8732 Generate code for the Thumb instruction set.  The default is to
8733 use the 32-bit ARM instruction set.
8734 This option automatically enables either 16-bit Thumb-1 or
8735 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8736 and @option{-march=@var{name}} options.
8738 @item -mtpcs-frame
8739 @opindex mtpcs-frame
8740 Generate a stack frame that is compliant with the Thumb Procedure Call
8741 Standard for all non-leaf functions.  (A leaf function is one that does
8742 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8744 @item -mtpcs-leaf-frame
8745 @opindex mtpcs-leaf-frame
8746 Generate a stack frame that is compliant with the Thumb Procedure Call
8747 Standard for all leaf functions.  (A leaf function is one that does
8748 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8750 @item -mcallee-super-interworking
8751 @opindex mcallee-super-interworking
8752 Gives all externally visible functions in the file being compiled an ARM
8753 instruction set header which switches to Thumb mode before executing the
8754 rest of the function.  This allows these functions to be called from
8755 non-interworking code.
8757 @item -mcaller-super-interworking
8758 @opindex mcaller-super-interworking
8759 Allows calls via function pointers (including virtual functions) to
8760 execute correctly regardless of whether the target code has been
8761 compiled for interworking or not.  There is a small overhead in the cost
8762 of executing a function pointer if this option is enabled.
8764 @item -mtp=@var{name}
8765 @opindex mtp
8766 Specify the access model for the thread local storage pointer.  The valid
8767 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8768 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8769 (supported in the arm6k architecture), and @option{auto}, which uses the
8770 best available method for the selected processor.  The default setting is
8771 @option{auto}.
8773 @end table
8775 @node AVR Options
8776 @subsection AVR Options
8777 @cindex AVR Options
8779 These options are defined for AVR implementations:
8781 @table @gcctabopt
8782 @item -mmcu=@var{mcu}
8783 @opindex mmcu
8784 Specify ATMEL AVR instruction set or MCU type.
8786 Instruction set avr1 is for the minimal AVR core, not supported by the C
8787 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8788 attiny11, attiny12, attiny15, attiny28).
8790 Instruction set avr2 (default) is for the classic AVR core with up to
8791 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8792 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8793 at90c8534, at90s8535).
8795 Instruction set avr3 is for the classic AVR core with up to 128K program
8796 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8798 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8799 memory space (MCU types: atmega8, atmega83, atmega85).
8801 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8802 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8803 atmega64, atmega128, at43usb355, at94k).
8805 @item -msize
8806 @opindex msize
8807 Output instruction sizes to the asm file.
8809 @item -minit-stack=@var{N}
8810 @opindex minit-stack
8811 Specify the initial stack address, which may be a symbol or numeric value,
8812 @samp{__stack} is the default.
8814 @item -mno-interrupts
8815 @opindex mno-interrupts
8816 Generated code is not compatible with hardware interrupts.
8817 Code size will be smaller.
8819 @item -mcall-prologues
8820 @opindex mcall-prologues
8821 Functions prologues/epilogues expanded as call to appropriate
8822 subroutines.  Code size will be smaller.
8824 @item -mno-tablejump
8825 @opindex mno-tablejump
8826 Do not generate tablejump insns which sometimes increase code size.
8828 @item -mtiny-stack
8829 @opindex mtiny-stack
8830 Change only the low 8 bits of the stack pointer.
8832 @item -mint8
8833 @opindex mint8
8834 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8835 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8836 and long long will be 4 bytes.  Please note that this option does not
8837 comply to the C standards, but it will provide you with smaller code
8838 size.
8839 @end table
8841 @node Blackfin Options
8842 @subsection Blackfin Options
8843 @cindex Blackfin Options
8845 @table @gcctabopt
8846 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8847 @opindex mcpu=
8848 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8849 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8850 @samp{bf525}, @samp{bf526}, @samp{bf527},
8851 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8852 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8853 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8854 @samp{bf561}.
8855 The optional @var{sirevision} specifies the silicon revision of the target
8856 Blackfin processor.  Any workarounds available for the targeted silicon revision
8857 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8858 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8859 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8860 hexadecimal digits representing the major and minor numbers in the silicon
8861 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8862 is not defined.  If @var{sirevision} is @samp{any}, the
8863 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8864 If this optional @var{sirevision} is not used, GCC assumes the latest known
8865 silicon revision of the targeted Blackfin processor.
8867 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8868 Only the processor macro is defined.
8869 Without this option, @samp{bf532} is used as the processor by default.
8870 The corresponding predefined processor macros for @var{cpu} is to
8871 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8872 provided by libgloss to be linked in if @option{-msim} is not given.
8874 @item -msim
8875 @opindex msim
8876 Specifies that the program will be run on the simulator.  This causes
8877 the simulator BSP provided by libgloss to be linked in.  This option
8878 has effect only for @samp{bfin-elf} toolchain.
8879 Certain other options, such as @option{-mid-shared-library} and
8880 @option{-mfdpic}, imply @option{-msim}.
8882 @item -momit-leaf-frame-pointer
8883 @opindex momit-leaf-frame-pointer
8884 Don't keep the frame pointer in a register for leaf functions.  This
8885 avoids the instructions to save, set up and restore frame pointers and
8886 makes an extra register available in leaf functions.  The option
8887 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8888 which might make debugging harder.
8890 @item -mspecld-anomaly
8891 @opindex mspecld-anomaly
8892 When enabled, the compiler will ensure that the generated code does not
8893 contain speculative loads after jump instructions. If this option is used,
8894 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8896 @item -mno-specld-anomaly
8897 @opindex mno-specld-anomaly
8898 Don't generate extra code to prevent speculative loads from occurring.
8900 @item -mcsync-anomaly
8901 @opindex mcsync-anomaly
8902 When enabled, the compiler will ensure that the generated code does not
8903 contain CSYNC or SSYNC instructions too soon after conditional branches.
8904 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8906 @item -mno-csync-anomaly
8907 @opindex mno-csync-anomaly
8908 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8909 occurring too soon after a conditional branch.
8911 @item -mlow-64k
8912 @opindex mlow-64k
8913 When enabled, the compiler is free to take advantage of the knowledge that
8914 the entire program fits into the low 64k of memory.
8916 @item -mno-low-64k
8917 @opindex mno-low-64k
8918 Assume that the program is arbitrarily large.  This is the default.
8920 @item -mstack-check-l1
8921 @opindex mstack-check-l1
8922 Do stack checking using information placed into L1 scratchpad memory by the
8923 uClinux kernel.
8925 @item -mid-shared-library
8926 @opindex mid-shared-library
8927 Generate code that supports shared libraries via the library ID method.
8928 This allows for execute in place and shared libraries in an environment
8929 without virtual memory management.  This option implies @option{-fPIC}.
8930 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8932 @item -mno-id-shared-library
8933 @opindex mno-id-shared-library
8934 Generate code that doesn't assume ID based shared libraries are being used.
8935 This is the default.
8937 @item -mleaf-id-shared-library
8938 @opindex mleaf-id-shared-library
8939 Generate code that supports shared libraries via the library ID method,
8940 but assumes that this library or executable won't link against any other
8941 ID shared libraries.  That allows the compiler to use faster code for jumps
8942 and calls.
8944 @item -mno-leaf-id-shared-library
8945 @opindex mno-leaf-id-shared-library
8946 Do not assume that the code being compiled won't link against any ID shared
8947 libraries.  Slower code will be generated for jump and call insns.
8949 @item -mshared-library-id=n
8950 @opindex mshared-library-id
8951 Specified the identification number of the ID based shared library being
8952 compiled.  Specifying a value of 0 will generate more compact code, specifying
8953 other values will force the allocation of that number to the current
8954 library but is no more space or time efficient than omitting this option.
8956 @item -msep-data
8957 @opindex msep-data
8958 Generate code that allows the data segment to be located in a different
8959 area of memory from the text segment.  This allows for execute in place in
8960 an environment without virtual memory management by eliminating relocations
8961 against the text section.
8963 @item -mno-sep-data
8964 @opindex mno-sep-data
8965 Generate code that assumes that the data segment follows the text segment.
8966 This is the default.
8968 @item -mlong-calls
8969 @itemx -mno-long-calls
8970 @opindex mlong-calls
8971 @opindex mno-long-calls
8972 Tells the compiler to perform function calls by first loading the
8973 address of the function into a register and then performing a subroutine
8974 call on this register.  This switch is needed if the target function
8975 will lie outside of the 24 bit addressing range of the offset based
8976 version of subroutine call instruction.
8978 This feature is not enabled by default.  Specifying
8979 @option{-mno-long-calls} will restore the default behavior.  Note these
8980 switches have no effect on how the compiler generates code to handle
8981 function calls via function pointers.
8983 @item -mfast-fp
8984 @opindex mfast-fp
8985 Link with the fast floating-point library. This library relaxes some of
8986 the IEEE floating-point standard's rules for checking inputs against
8987 Not-a-Number (NAN), in the interest of performance.
8989 @item -minline-plt
8990 @opindex minline-plt
8991 Enable inlining of PLT entries in function calls to functions that are
8992 not known to bind locally.  It has no effect without @option{-mfdpic}.
8994 @item -mmulticore
8995 @opindex mmulticore
8996 Build standalone application for multicore Blackfin processor. Proper
8997 start files and link scripts will be used to support multicore.
8998 This option defines @code{__BFIN_MULTICORE}. It can only be used with
8999 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9000 @option{-mcorea} or @option{-mcoreb}. If it's used without
9001 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9002 programming model is used. In this model, the main function of Core B
9003 should be named as coreb_main. If it's used with @option{-mcorea} or
9004 @option{-mcoreb}, one application per core programming model is used.
9005 If this option is not used, single core application programming
9006 model is used.
9008 @item -mcorea
9009 @opindex mcorea
9010 Build standalone application for Core A of BF561 when using
9011 one application per core programming model. Proper start files
9012 and link scripts will be used to support Core A. This option
9013 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9015 @item -mcoreb
9016 @opindex mcoreb
9017 Build standalone application for Core B of BF561 when using
9018 one application per core programming model. Proper start files
9019 and link scripts will be used to support Core B. This option
9020 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9021 should be used instead of main. It must be used with
9022 @option{-mmulticore}. 
9024 @item -msdram
9025 @opindex msdram
9026 Build standalone application for SDRAM. Proper start files and
9027 link scripts will be used to put the application into SDRAM.
9028 Loader should initialize SDRAM before loading the application
9029 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9030 @end table
9031   
9032 @node CRIS Options
9033 @subsection CRIS Options
9034 @cindex CRIS Options
9036 These options are defined specifically for the CRIS ports.
9038 @table @gcctabopt
9039 @item -march=@var{architecture-type}
9040 @itemx -mcpu=@var{architecture-type}
9041 @opindex march
9042 @opindex mcpu
9043 Generate code for the specified architecture.  The choices for
9044 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9045 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9046 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9047 @samp{v10}.
9049 @item -mtune=@var{architecture-type}
9050 @opindex mtune
9051 Tune to @var{architecture-type} everything applicable about the generated
9052 code, except for the ABI and the set of available instructions.  The
9053 choices for @var{architecture-type} are the same as for
9054 @option{-march=@var{architecture-type}}.
9056 @item -mmax-stack-frame=@var{n}
9057 @opindex mmax-stack-frame
9058 Warn when the stack frame of a function exceeds @var{n} bytes.
9060 @item -metrax4
9061 @itemx -metrax100
9062 @opindex metrax4
9063 @opindex metrax100
9064 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9065 @option{-march=v3} and @option{-march=v8} respectively.
9067 @item -mmul-bug-workaround
9068 @itemx -mno-mul-bug-workaround
9069 @opindex mmul-bug-workaround
9070 @opindex mno-mul-bug-workaround
9071 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9072 models where it applies.  This option is active by default.
9074 @item -mpdebug
9075 @opindex mpdebug
9076 Enable CRIS-specific verbose debug-related information in the assembly
9077 code.  This option also has the effect to turn off the @samp{#NO_APP}
9078 formatted-code indicator to the assembler at the beginning of the
9079 assembly file.
9081 @item -mcc-init
9082 @opindex mcc-init
9083 Do not use condition-code results from previous instruction; always emit
9084 compare and test instructions before use of condition codes.
9086 @item -mno-side-effects
9087 @opindex mno-side-effects
9088 Do not emit instructions with side-effects in addressing modes other than
9089 post-increment.
9091 @item -mstack-align
9092 @itemx -mno-stack-align
9093 @itemx -mdata-align
9094 @itemx -mno-data-align
9095 @itemx -mconst-align
9096 @itemx -mno-const-align
9097 @opindex mstack-align
9098 @opindex mno-stack-align
9099 @opindex mdata-align
9100 @opindex mno-data-align
9101 @opindex mconst-align
9102 @opindex mno-const-align
9103 These options (no-options) arranges (eliminate arrangements) for the
9104 stack-frame, individual data and constants to be aligned for the maximum
9105 single data access size for the chosen CPU model.  The default is to
9106 arrange for 32-bit alignment.  ABI details such as structure layout are
9107 not affected by these options.
9109 @item -m32-bit
9110 @itemx -m16-bit
9111 @itemx -m8-bit
9112 @opindex m32-bit
9113 @opindex m16-bit
9114 @opindex m8-bit
9115 Similar to the stack- data- and const-align options above, these options
9116 arrange for stack-frame, writable data and constants to all be 32-bit,
9117 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9119 @item -mno-prologue-epilogue
9120 @itemx -mprologue-epilogue
9121 @opindex mno-prologue-epilogue
9122 @opindex mprologue-epilogue
9123 With @option{-mno-prologue-epilogue}, the normal function prologue and
9124 epilogue that sets up the stack-frame are omitted and no return
9125 instructions or return sequences are generated in the code.  Use this
9126 option only together with visual inspection of the compiled code: no
9127 warnings or errors are generated when call-saved registers must be saved,
9128 or storage for local variable needs to be allocated.
9130 @item -mno-gotplt
9131 @itemx -mgotplt
9132 @opindex mno-gotplt
9133 @opindex mgotplt
9134 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9135 instruction sequences that load addresses for functions from the PLT part
9136 of the GOT rather than (traditional on other architectures) calls to the
9137 PLT@.  The default is @option{-mgotplt}.
9139 @item -melf
9140 @opindex melf
9141 Legacy no-op option only recognized with the cris-axis-elf and
9142 cris-axis-linux-gnu targets.
9144 @item -mlinux
9145 @opindex mlinux
9146 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9148 @item -sim
9149 @opindex sim
9150 This option, recognized for the cris-axis-elf arranges
9151 to link with input-output functions from a simulator library.  Code,
9152 initialized data and zero-initialized data are allocated consecutively.
9154 @item -sim2
9155 @opindex sim2
9156 Like @option{-sim}, but pass linker options to locate initialized data at
9157 0x40000000 and zero-initialized data at 0x80000000.
9158 @end table
9160 @node CRX Options
9161 @subsection CRX Options
9162 @cindex CRX Options
9164 These options are defined specifically for the CRX ports.
9166 @table @gcctabopt
9168 @item -mmac
9169 @opindex mmac
9170 Enable the use of multiply-accumulate instructions. Disabled by default.
9172 @item -mpush-args
9173 @opindex mpush-args
9174 Push instructions will be used to pass outgoing arguments when functions
9175 are called. Enabled by default.
9176 @end table
9178 @node Darwin Options
9179 @subsection Darwin Options
9180 @cindex Darwin options
9182 These options are defined for all architectures running the Darwin operating
9183 system.
9185 FSF GCC on Darwin does not create ``fat'' object files; it will create
9186 an object file for the single architecture that it was built to
9187 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9188 @option{-arch} options are used; it does so by running the compiler or
9189 linker multiple times and joining the results together with
9190 @file{lipo}.
9192 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9193 @samp{i686}) is determined by the flags that specify the ISA
9194 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9195 @option{-force_cpusubtype_ALL} option can be used to override this.
9197 The Darwin tools vary in their behavior when presented with an ISA
9198 mismatch.  The assembler, @file{as}, will only permit instructions to
9199 be used that are valid for the subtype of the file it is generating,
9200 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9201 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9202 and print an error if asked to create a shared library with a less
9203 restrictive subtype than its input files (for instance, trying to put
9204 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9205 for executables, @file{ld}, will quietly give the executable the most
9206 restrictive subtype of any of its input files.
9208 @table @gcctabopt
9209 @item -F@var{dir}
9210 @opindex F
9211 Add the framework directory @var{dir} to the head of the list of
9212 directories to be searched for header files.  These directories are
9213 interleaved with those specified by @option{-I} options and are
9214 scanned in a left-to-right order.
9216 A framework directory is a directory with frameworks in it.  A
9217 framework is a directory with a @samp{"Headers"} and/or
9218 @samp{"PrivateHeaders"} directory contained directly in it that ends
9219 in @samp{".framework"}.  The name of a framework is the name of this
9220 directory excluding the @samp{".framework"}.  Headers associated with
9221 the framework are found in one of those two directories, with
9222 @samp{"Headers"} being searched first.  A subframework is a framework
9223 directory that is in a framework's @samp{"Frameworks"} directory.
9224 Includes of subframework headers can only appear in a header of a
9225 framework that contains the subframework, or in a sibling subframework
9226 header.  Two subframeworks are siblings if they occur in the same
9227 framework.  A subframework should not have the same name as a
9228 framework, a warning will be issued if this is violated.  Currently a
9229 subframework cannot have subframeworks, in the future, the mechanism
9230 may be extended to support this.  The standard frameworks can be found
9231 in @samp{"/System/Library/Frameworks"} and
9232 @samp{"/Library/Frameworks"}.  An example include looks like
9233 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9234 the name of the framework and header.h is found in the
9235 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9237 @item -iframework@var{dir}
9238 @opindex iframework
9239 Like @option{-F} except the directory is a treated as a system
9240 directory.  The main difference between this @option{-iframework} and
9241 @option{-F} is that with @option{-iframework} the compiler does not
9242 warn about constructs contained within header files found via
9243 @var{dir}.  This option is valid only for the C family of languages.
9245 @item -gused
9246 @opindex gused
9247 Emit debugging information for symbols that are used.  For STABS
9248 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9249 This is by default ON@.
9251 @item -gfull
9252 @opindex gfull
9253 Emit debugging information for all symbols and types.
9255 @item -mmacosx-version-min=@var{version}
9256 The earliest version of MacOS X that this executable will run on
9257 is @var{version}.  Typical values of @var{version} include @code{10.1},
9258 @code{10.2}, and @code{10.3.9}.
9260 If the compiler was built to use the system's headers by default,
9261 then the default for this option is the system version on which the
9262 compiler is running, otherwise the default is to make choices which
9263 are compatible with as many systems and code bases as possible.
9265 @item -mkernel
9266 @opindex mkernel
9267 Enable kernel development mode.  The @option{-mkernel} option sets
9268 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9269 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9270 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9271 applicable.  This mode also sets @option{-mno-altivec},
9272 @option{-msoft-float}, @option{-fno-builtin} and
9273 @option{-mlong-branch} for PowerPC targets.
9275 @item -mone-byte-bool
9276 @opindex mone-byte-bool
9277 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9278 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9279 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9280 option has no effect on x86.
9282 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9283 to generate code that is not binary compatible with code generated
9284 without that switch.  Using this switch may require recompiling all
9285 other modules in a program, including system libraries.  Use this
9286 switch to conform to a non-default data model.
9288 @item -mfix-and-continue
9289 @itemx -ffix-and-continue
9290 @itemx -findirect-data
9291 @opindex mfix-and-continue
9292 @opindex ffix-and-continue
9293 @opindex findirect-data
9294 Generate code suitable for fast turn around development.  Needed to
9295 enable gdb to dynamically load @code{.o} files into already running
9296 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9297 are provided for backwards compatibility.
9299 @item -all_load
9300 @opindex all_load
9301 Loads all members of static archive libraries.
9302 See man ld(1) for more information.
9304 @item -arch_errors_fatal
9305 @opindex arch_errors_fatal
9306 Cause the errors having to do with files that have the wrong architecture
9307 to be fatal.
9309 @item -bind_at_load
9310 @opindex bind_at_load
9311 Causes the output file to be marked such that the dynamic linker will
9312 bind all undefined references when the file is loaded or launched.
9314 @item -bundle
9315 @opindex bundle
9316 Produce a Mach-o bundle format file.
9317 See man ld(1) for more information.
9319 @item -bundle_loader @var{executable}
9320 @opindex bundle_loader
9321 This option specifies the @var{executable} that will be loading the build
9322 output file being linked.  See man ld(1) for more information.
9324 @item -dynamiclib
9325 @opindex dynamiclib
9326 When passed this option, GCC will produce a dynamic library instead of
9327 an executable when linking, using the Darwin @file{libtool} command.
9329 @item -force_cpusubtype_ALL
9330 @opindex force_cpusubtype_ALL
9331 This causes GCC's output file to have the @var{ALL} subtype, instead of
9332 one controlled by the @option{-mcpu} or @option{-march} option.
9334 @item -allowable_client  @var{client_name}
9335 @itemx -client_name
9336 @itemx -compatibility_version
9337 @itemx -current_version
9338 @itemx -dead_strip
9339 @itemx -dependency-file
9340 @itemx -dylib_file
9341 @itemx -dylinker_install_name
9342 @itemx -dynamic
9343 @itemx -exported_symbols_list
9344 @itemx -filelist
9345 @itemx -flat_namespace
9346 @itemx -force_flat_namespace
9347 @itemx -headerpad_max_install_names
9348 @itemx -image_base
9349 @itemx -init
9350 @itemx -install_name
9351 @itemx -keep_private_externs
9352 @itemx -multi_module
9353 @itemx -multiply_defined
9354 @itemx -multiply_defined_unused
9355 @itemx -noall_load
9356 @itemx -no_dead_strip_inits_and_terms
9357 @itemx -nofixprebinding
9358 @itemx -nomultidefs
9359 @itemx -noprebind
9360 @itemx -noseglinkedit
9361 @itemx -pagezero_size
9362 @itemx -prebind
9363 @itemx -prebind_all_twolevel_modules
9364 @itemx -private_bundle
9365 @itemx -read_only_relocs
9366 @itemx -sectalign
9367 @itemx -sectobjectsymbols
9368 @itemx -whyload
9369 @itemx -seg1addr
9370 @itemx -sectcreate
9371 @itemx -sectobjectsymbols
9372 @itemx -sectorder
9373 @itemx -segaddr
9374 @itemx -segs_read_only_addr
9375 @itemx -segs_read_write_addr
9376 @itemx -seg_addr_table
9377 @itemx -seg_addr_table_filename
9378 @itemx -seglinkedit
9379 @itemx -segprot
9380 @itemx -segs_read_only_addr
9381 @itemx -segs_read_write_addr
9382 @itemx -single_module
9383 @itemx -static
9384 @itemx -sub_library
9385 @itemx -sub_umbrella
9386 @itemx -twolevel_namespace
9387 @itemx -umbrella
9388 @itemx -undefined
9389 @itemx -unexported_symbols_list
9390 @itemx -weak_reference_mismatches
9391 @itemx -whatsloaded
9392 @opindex allowable_client
9393 @opindex client_name
9394 @opindex compatibility_version
9395 @opindex current_version
9396 @opindex dead_strip
9397 @opindex dependency-file
9398 @opindex dylib_file
9399 @opindex dylinker_install_name
9400 @opindex dynamic
9401 @opindex exported_symbols_list
9402 @opindex filelist
9403 @opindex flat_namespace
9404 @opindex force_flat_namespace
9405 @opindex headerpad_max_install_names
9406 @opindex image_base
9407 @opindex init
9408 @opindex install_name
9409 @opindex keep_private_externs
9410 @opindex multi_module
9411 @opindex multiply_defined
9412 @opindex multiply_defined_unused
9413 @opindex noall_load
9414 @opindex no_dead_strip_inits_and_terms
9415 @opindex nofixprebinding
9416 @opindex nomultidefs
9417 @opindex noprebind
9418 @opindex noseglinkedit
9419 @opindex pagezero_size
9420 @opindex prebind
9421 @opindex prebind_all_twolevel_modules
9422 @opindex private_bundle
9423 @opindex read_only_relocs
9424 @opindex sectalign
9425 @opindex sectobjectsymbols
9426 @opindex whyload
9427 @opindex seg1addr
9428 @opindex sectcreate
9429 @opindex sectobjectsymbols
9430 @opindex sectorder
9431 @opindex segaddr
9432 @opindex segs_read_only_addr
9433 @opindex segs_read_write_addr
9434 @opindex seg_addr_table
9435 @opindex seg_addr_table_filename
9436 @opindex seglinkedit
9437 @opindex segprot
9438 @opindex segs_read_only_addr
9439 @opindex segs_read_write_addr
9440 @opindex single_module
9441 @opindex static
9442 @opindex sub_library
9443 @opindex sub_umbrella
9444 @opindex twolevel_namespace
9445 @opindex umbrella
9446 @opindex undefined
9447 @opindex unexported_symbols_list
9448 @opindex weak_reference_mismatches
9449 @opindex whatsloaded
9450 These options are passed to the Darwin linker.  The Darwin linker man page
9451 describes them in detail.
9452 @end table
9454 @node DEC Alpha Options
9455 @subsection DEC Alpha Options
9457 These @samp{-m} options are defined for the DEC Alpha implementations:
9459 @table @gcctabopt
9460 @item -mno-soft-float
9461 @itemx -msoft-float
9462 @opindex mno-soft-float
9463 @opindex msoft-float
9464 Use (do not use) the hardware floating-point instructions for
9465 floating-point operations.  When @option{-msoft-float} is specified,
9466 functions in @file{libgcc.a} will be used to perform floating-point
9467 operations.  Unless they are replaced by routines that emulate the
9468 floating-point operations, or compiled in such a way as to call such
9469 emulations routines, these routines will issue floating-point
9470 operations.   If you are compiling for an Alpha without floating-point
9471 operations, you must ensure that the library is built so as not to call
9472 them.
9474 Note that Alpha implementations without floating-point operations are
9475 required to have floating-point registers.
9477 @item -mfp-reg
9478 @itemx -mno-fp-regs
9479 @opindex mfp-reg
9480 @opindex mno-fp-regs
9481 Generate code that uses (does not use) the floating-point register set.
9482 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9483 register set is not used, floating point operands are passed in integer
9484 registers as if they were integers and floating-point results are passed
9485 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9486 so any function with a floating-point argument or return value called by code
9487 compiled with @option{-mno-fp-regs} must also be compiled with that
9488 option.
9490 A typical use of this option is building a kernel that does not use,
9491 and hence need not save and restore, any floating-point registers.
9493 @item -mieee
9494 @opindex mieee
9495 The Alpha architecture implements floating-point hardware optimized for
9496 maximum performance.  It is mostly compliant with the IEEE floating
9497 point standard.  However, for full compliance, software assistance is
9498 required.  This option generates code fully IEEE compliant code
9499 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9500 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9501 defined during compilation.  The resulting code is less efficient but is
9502 able to correctly support denormalized numbers and exceptional IEEE
9503 values such as not-a-number and plus/minus infinity.  Other Alpha
9504 compilers call this option @option{-ieee_with_no_inexact}.
9506 @item -mieee-with-inexact
9507 @opindex mieee-with-inexact
9508 This is like @option{-mieee} except the generated code also maintains
9509 the IEEE @var{inexact-flag}.  Turning on this option causes the
9510 generated code to implement fully-compliant IEEE math.  In addition to
9511 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9512 macro.  On some Alpha implementations the resulting code may execute
9513 significantly slower than the code generated by default.  Since there is
9514 very little code that depends on the @var{inexact-flag}, you should
9515 normally not specify this option.  Other Alpha compilers call this
9516 option @option{-ieee_with_inexact}.
9518 @item -mfp-trap-mode=@var{trap-mode}
9519 @opindex mfp-trap-mode
9520 This option controls what floating-point related traps are enabled.
9521 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9522 The trap mode can be set to one of four values:
9524 @table @samp
9525 @item n
9526 This is the default (normal) setting.  The only traps that are enabled
9527 are the ones that cannot be disabled in software (e.g., division by zero
9528 trap).
9530 @item u
9531 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9532 as well.
9534 @item su
9535 Like @samp{u}, but the instructions are marked to be safe for software
9536 completion (see Alpha architecture manual for details).
9538 @item sui
9539 Like @samp{su}, but inexact traps are enabled as well.
9540 @end table
9542 @item -mfp-rounding-mode=@var{rounding-mode}
9543 @opindex mfp-rounding-mode
9544 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9545 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9548 @table @samp
9549 @item n
9550 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9551 the nearest machine number or towards the even machine number in case
9552 of a tie.
9554 @item m
9555 Round towards minus infinity.
9557 @item c
9558 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9560 @item d
9561 Dynamic rounding mode.  A field in the floating point control register
9562 (@var{fpcr}, see Alpha architecture reference manual) controls the
9563 rounding mode in effect.  The C library initializes this register for
9564 rounding towards plus infinity.  Thus, unless your program modifies the
9565 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9566 @end table
9568 @item -mtrap-precision=@var{trap-precision}
9569 @opindex mtrap-precision
9570 In the Alpha architecture, floating point traps are imprecise.  This
9571 means without software assistance it is impossible to recover from a
9572 floating trap and program execution normally needs to be terminated.
9573 GCC can generate code that can assist operating system trap handlers
9574 in determining the exact location that caused a floating point trap.
9575 Depending on the requirements of an application, different levels of
9576 precisions can be selected:
9578 @table @samp
9579 @item p
9580 Program precision.  This option is the default and means a trap handler
9581 can only identify which program caused a floating point exception.
9583 @item f
9584 Function precision.  The trap handler can determine the function that
9585 caused a floating point exception.
9587 @item i
9588 Instruction precision.  The trap handler can determine the exact
9589 instruction that caused a floating point exception.
9590 @end table
9592 Other Alpha compilers provide the equivalent options called
9593 @option{-scope_safe} and @option{-resumption_safe}.
9595 @item -mieee-conformant
9596 @opindex mieee-conformant
9597 This option marks the generated code as IEEE conformant.  You must not
9598 use this option unless you also specify @option{-mtrap-precision=i} and either
9599 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9600 is to emit the line @samp{.eflag 48} in the function prologue of the
9601 generated assembly file.  Under DEC Unix, this has the effect that
9602 IEEE-conformant math library routines will be linked in.
9604 @item -mbuild-constants
9605 @opindex mbuild-constants
9606 Normally GCC examines a 32- or 64-bit integer constant to
9607 see if it can construct it from smaller constants in two or three
9608 instructions.  If it cannot, it will output the constant as a literal and
9609 generate code to load it from the data segment at runtime.
9611 Use this option to require GCC to construct @emph{all} integer constants
9612 using code, even if it takes more instructions (the maximum is six).
9614 You would typically use this option to build a shared library dynamic
9615 loader.  Itself a shared library, it must relocate itself in memory
9616 before it can find the variables and constants in its own data segment.
9618 @item -malpha-as
9619 @itemx -mgas
9620 @opindex malpha-as
9621 @opindex mgas
9622 Select whether to generate code to be assembled by the vendor-supplied
9623 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9625 @item -mbwx
9626 @itemx -mno-bwx
9627 @itemx -mcix
9628 @itemx -mno-cix
9629 @itemx -mfix
9630 @itemx -mno-fix
9631 @itemx -mmax
9632 @itemx -mno-max
9633 @opindex mbwx
9634 @opindex mno-bwx
9635 @opindex mcix
9636 @opindex mno-cix
9637 @opindex mfix
9638 @opindex mno-fix
9639 @opindex mmax
9640 @opindex mno-max
9641 Indicate whether GCC should generate code to use the optional BWX,
9642 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9643 sets supported by the CPU type specified via @option{-mcpu=} option or that
9644 of the CPU on which GCC was built if none was specified.
9646 @item -mfloat-vax
9647 @itemx -mfloat-ieee
9648 @opindex mfloat-vax
9649 @opindex mfloat-ieee
9650 Generate code that uses (does not use) VAX F and G floating point
9651 arithmetic instead of IEEE single and double precision.
9653 @item -mexplicit-relocs
9654 @itemx -mno-explicit-relocs
9655 @opindex mexplicit-relocs
9656 @opindex mno-explicit-relocs
9657 Older Alpha assemblers provided no way to generate symbol relocations
9658 except via assembler macros.  Use of these macros does not allow
9659 optimal instruction scheduling.  GNU binutils as of version 2.12
9660 supports a new syntax that allows the compiler to explicitly mark
9661 which relocations should apply to which instructions.  This option
9662 is mostly useful for debugging, as GCC detects the capabilities of
9663 the assembler when it is built and sets the default accordingly.
9665 @item -msmall-data
9666 @itemx -mlarge-data
9667 @opindex msmall-data
9668 @opindex mlarge-data
9669 When @option{-mexplicit-relocs} is in effect, static data is
9670 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9671 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9672 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9673 16-bit relocations off of the @code{$gp} register.  This limits the
9674 size of the small data area to 64KB, but allows the variables to be
9675 directly accessed via a single instruction.
9677 The default is @option{-mlarge-data}.  With this option the data area
9678 is limited to just below 2GB@.  Programs that require more than 2GB of
9679 data must use @code{malloc} or @code{mmap} to allocate the data in the
9680 heap instead of in the program's data segment.
9682 When generating code for shared libraries, @option{-fpic} implies
9683 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9685 @item -msmall-text
9686 @itemx -mlarge-text
9687 @opindex msmall-text
9688 @opindex mlarge-text
9689 When @option{-msmall-text} is used, the compiler assumes that the
9690 code of the entire program (or shared library) fits in 4MB, and is
9691 thus reachable with a branch instruction.  When @option{-msmall-data}
9692 is used, the compiler can assume that all local symbols share the
9693 same @code{$gp} value, and thus reduce the number of instructions
9694 required for a function call from 4 to 1.
9696 The default is @option{-mlarge-text}.
9698 @item -mcpu=@var{cpu_type}
9699 @opindex mcpu
9700 Set the instruction set and instruction scheduling parameters for
9701 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9702 style name or the corresponding chip number.  GCC supports scheduling
9703 parameters for the EV4, EV5 and EV6 family of processors and will
9704 choose the default values for the instruction set from the processor
9705 you specify.  If you do not specify a processor type, GCC will default
9706 to the processor on which the compiler was built.
9708 Supported values for @var{cpu_type} are
9710 @table @samp
9711 @item ev4
9712 @itemx ev45
9713 @itemx 21064
9714 Schedules as an EV4 and has no instruction set extensions.
9716 @item ev5
9717 @itemx 21164
9718 Schedules as an EV5 and has no instruction set extensions.
9720 @item ev56
9721 @itemx 21164a
9722 Schedules as an EV5 and supports the BWX extension.
9724 @item pca56
9725 @itemx 21164pc
9726 @itemx 21164PC
9727 Schedules as an EV5 and supports the BWX and MAX extensions.
9729 @item ev6
9730 @itemx 21264
9731 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9733 @item ev67
9734 @itemx 21264a
9735 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9736 @end table
9738 @item -mtune=@var{cpu_type}
9739 @opindex mtune
9740 Set only the instruction scheduling parameters for machine type
9741 @var{cpu_type}.  The instruction set is not changed.
9743 @item -mmemory-latency=@var{time}
9744 @opindex mmemory-latency
9745 Sets the latency the scheduler should assume for typical memory
9746 references as seen by the application.  This number is highly
9747 dependent on the memory access patterns used by the application
9748 and the size of the external cache on the machine.
9750 Valid options for @var{time} are
9752 @table @samp
9753 @item @var{number}
9754 A decimal number representing clock cycles.
9756 @item L1
9757 @itemx L2
9758 @itemx L3
9759 @itemx main
9760 The compiler contains estimates of the number of clock cycles for
9761 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9762 (also called Dcache, Scache, and Bcache), as well as to main memory.
9763 Note that L3 is only valid for EV5.
9765 @end table
9766 @end table
9768 @node DEC Alpha/VMS Options
9769 @subsection DEC Alpha/VMS Options
9771 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9773 @table @gcctabopt
9774 @item -mvms-return-codes
9775 @opindex mvms-return-codes
9776 Return VMS condition codes from main.  The default is to return POSIX
9777 style condition (e.g.@: error) codes.
9778 @end table
9780 @node FRV Options
9781 @subsection FRV Options
9782 @cindex FRV Options
9784 @table @gcctabopt
9785 @item -mgpr-32
9786 @opindex mgpr-32
9788 Only use the first 32 general purpose registers.
9790 @item -mgpr-64
9791 @opindex mgpr-64
9793 Use all 64 general purpose registers.
9795 @item -mfpr-32
9796 @opindex mfpr-32
9798 Use only the first 32 floating point registers.
9800 @item -mfpr-64
9801 @opindex mfpr-64
9803 Use all 64 floating point registers
9805 @item -mhard-float
9806 @opindex mhard-float
9808 Use hardware instructions for floating point operations.
9810 @item -msoft-float
9811 @opindex msoft-float
9813 Use library routines for floating point operations.
9815 @item -malloc-cc
9816 @opindex malloc-cc
9818 Dynamically allocate condition code registers.
9820 @item -mfixed-cc
9821 @opindex mfixed-cc
9823 Do not try to dynamically allocate condition code registers, only
9824 use @code{icc0} and @code{fcc0}.
9826 @item -mdword
9827 @opindex mdword
9829 Change ABI to use double word insns.
9831 @item -mno-dword
9832 @opindex mno-dword
9834 Do not use double word instructions.
9836 @item -mdouble
9837 @opindex mdouble
9839 Use floating point double instructions.
9841 @item -mno-double
9842 @opindex mno-double
9844 Do not use floating point double instructions.
9846 @item -mmedia
9847 @opindex mmedia
9849 Use media instructions.
9851 @item -mno-media
9852 @opindex mno-media
9854 Do not use media instructions.
9856 @item -mmuladd
9857 @opindex mmuladd
9859 Use multiply and add/subtract instructions.
9861 @item -mno-muladd
9862 @opindex mno-muladd
9864 Do not use multiply and add/subtract instructions.
9866 @item -mfdpic
9867 @opindex mfdpic
9869 Select the FDPIC ABI, that uses function descriptors to represent
9870 pointers to functions.  Without any PIC/PIE-related options, it
9871 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9872 assumes GOT entries and small data are within a 12-bit range from the
9873 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9874 are computed with 32 bits.
9875 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9877 @item -minline-plt
9878 @opindex minline-plt
9880 Enable inlining of PLT entries in function calls to functions that are
9881 not known to bind locally.  It has no effect without @option{-mfdpic}.
9882 It's enabled by default if optimizing for speed and compiling for
9883 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9884 optimization option such as @option{-O3} or above is present in the
9885 command line.
9887 @item -mTLS
9888 @opindex TLS
9890 Assume a large TLS segment when generating thread-local code.
9892 @item -mtls
9893 @opindex tls
9895 Do not assume a large TLS segment when generating thread-local code.
9897 @item -mgprel-ro
9898 @opindex mgprel-ro
9900 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9901 that is known to be in read-only sections.  It's enabled by default,
9902 except for @option{-fpic} or @option{-fpie}: even though it may help
9903 make the global offset table smaller, it trades 1 instruction for 4.
9904 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9905 one of which may be shared by multiple symbols, and it avoids the need
9906 for a GOT entry for the referenced symbol, so it's more likely to be a
9907 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9909 @item -multilib-library-pic
9910 @opindex multilib-library-pic
9912 Link with the (library, not FD) pic libraries.  It's implied by
9913 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9914 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9915 it explicitly.
9917 @item -mlinked-fp
9918 @opindex mlinked-fp
9920 Follow the EABI requirement of always creating a frame pointer whenever
9921 a stack frame is allocated.  This option is enabled by default and can
9922 be disabled with @option{-mno-linked-fp}.
9924 @item -mlong-calls
9925 @opindex mlong-calls
9927 Use indirect addressing to call functions outside the current
9928 compilation unit.  This allows the functions to be placed anywhere
9929 within the 32-bit address space.
9931 @item -malign-labels
9932 @opindex malign-labels
9934 Try to align labels to an 8-byte boundary by inserting nops into the
9935 previous packet.  This option only has an effect when VLIW packing
9936 is enabled.  It doesn't create new packets; it merely adds nops to
9937 existing ones.
9939 @item -mlibrary-pic
9940 @opindex mlibrary-pic
9942 Generate position-independent EABI code.
9944 @item -macc-4
9945 @opindex macc-4
9947 Use only the first four media accumulator registers.
9949 @item -macc-8
9950 @opindex macc-8
9952 Use all eight media accumulator registers.
9954 @item -mpack
9955 @opindex mpack
9957 Pack VLIW instructions.
9959 @item -mno-pack
9960 @opindex mno-pack
9962 Do not pack VLIW instructions.
9964 @item -mno-eflags
9965 @opindex mno-eflags
9967 Do not mark ABI switches in e_flags.
9969 @item -mcond-move
9970 @opindex mcond-move
9972 Enable the use of conditional-move instructions (default).
9974 This switch is mainly for debugging the compiler and will likely be removed
9975 in a future version.
9977 @item -mno-cond-move
9978 @opindex mno-cond-move
9980 Disable the use of conditional-move instructions.
9982 This switch is mainly for debugging the compiler and will likely be removed
9983 in a future version.
9985 @item -mscc
9986 @opindex mscc
9988 Enable the use of conditional set instructions (default).
9990 This switch is mainly for debugging the compiler and will likely be removed
9991 in a future version.
9993 @item -mno-scc
9994 @opindex mno-scc
9996 Disable the use of conditional set instructions.
9998 This switch is mainly for debugging the compiler and will likely be removed
9999 in a future version.
10001 @item -mcond-exec
10002 @opindex mcond-exec
10004 Enable the use of conditional execution (default).
10006 This switch is mainly for debugging the compiler and will likely be removed
10007 in a future version.
10009 @item -mno-cond-exec
10010 @opindex mno-cond-exec
10012 Disable the use of conditional execution.
10014 This switch is mainly for debugging the compiler and will likely be removed
10015 in a future version.
10017 @item -mvliw-branch
10018 @opindex mvliw-branch
10020 Run a pass to pack branches into VLIW instructions (default).
10022 This switch is mainly for debugging the compiler and will likely be removed
10023 in a future version.
10025 @item -mno-vliw-branch
10026 @opindex mno-vliw-branch
10028 Do not run a pass to pack branches into VLIW instructions.
10030 This switch is mainly for debugging the compiler and will likely be removed
10031 in a future version.
10033 @item -mmulti-cond-exec
10034 @opindex mmulti-cond-exec
10036 Enable optimization of @code{&&} and @code{||} in conditional execution
10037 (default).
10039 This switch is mainly for debugging the compiler and will likely be removed
10040 in a future version.
10042 @item -mno-multi-cond-exec
10043 @opindex mno-multi-cond-exec
10045 Disable optimization of @code{&&} and @code{||} in conditional execution.
10047 This switch is mainly for debugging the compiler and will likely be removed
10048 in a future version.
10050 @item -mnested-cond-exec
10051 @opindex mnested-cond-exec
10053 Enable nested conditional execution optimizations (default).
10055 This switch is mainly for debugging the compiler and will likely be removed
10056 in a future version.
10058 @item -mno-nested-cond-exec
10059 @opindex mno-nested-cond-exec
10061 Disable nested conditional execution optimizations.
10063 This switch is mainly for debugging the compiler and will likely be removed
10064 in a future version.
10066 @item -moptimize-membar
10067 @opindex moptimize-membar
10069 This switch removes redundant @code{membar} instructions from the
10070 compiler generated code.  It is enabled by default.
10072 @item -mno-optimize-membar
10073 @opindex mno-optimize-membar
10075 This switch disables the automatic removal of redundant @code{membar}
10076 instructions from the generated code.
10078 @item -mtomcat-stats
10079 @opindex mtomcat-stats
10081 Cause gas to print out tomcat statistics.
10083 @item -mcpu=@var{cpu}
10084 @opindex mcpu
10086 Select the processor type for which to generate code.  Possible values are
10087 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10088 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10090 @end table
10092 @node GNU/Linux Options
10093 @subsection GNU/Linux Options
10095 These @samp{-m} options are defined for GNU/Linux targets:
10097 @table @gcctabopt
10098 @item -mglibc
10099 @opindex mglibc
10100 Use the GNU C library instead of uClibc.  This is the default except
10101 on @samp{*-*-linux-*uclibc*} targets.
10103 @item -muclibc
10104 @opindex muclibc
10105 Use uClibc instead of the GNU C library.  This is the default on
10106 @samp{*-*-linux-*uclibc*} targets.
10107 @end table
10109 @node H8/300 Options
10110 @subsection H8/300 Options
10112 These @samp{-m} options are defined for the H8/300 implementations:
10114 @table @gcctabopt
10115 @item -mrelax
10116 @opindex mrelax
10117 Shorten some address references at link time, when possible; uses the
10118 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10119 ld, Using ld}, for a fuller description.
10121 @item -mh
10122 @opindex mh
10123 Generate code for the H8/300H@.
10125 @item -ms
10126 @opindex ms
10127 Generate code for the H8S@.
10129 @item -mn
10130 @opindex mn
10131 Generate code for the H8S and H8/300H in the normal mode.  This switch
10132 must be used either with @option{-mh} or @option{-ms}.
10134 @item -ms2600
10135 @opindex ms2600
10136 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10138 @item -mint32
10139 @opindex mint32
10140 Make @code{int} data 32 bits by default.
10142 @item -malign-300
10143 @opindex malign-300
10144 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10145 The default for the H8/300H and H8S is to align longs and floats on 4
10146 byte boundaries.
10147 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10148 This option has no effect on the H8/300.
10149 @end table
10151 @node HPPA Options
10152 @subsection HPPA Options
10153 @cindex HPPA Options
10155 These @samp{-m} options are defined for the HPPA family of computers:
10157 @table @gcctabopt
10158 @item -march=@var{architecture-type}
10159 @opindex march
10160 Generate code for the specified architecture.  The choices for
10161 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10162 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10163 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10164 architecture option for your machine.  Code compiled for lower numbered
10165 architectures will run on higher numbered architectures, but not the
10166 other way around.
10168 @item -mpa-risc-1-0
10169 @itemx -mpa-risc-1-1
10170 @itemx -mpa-risc-2-0
10171 @opindex mpa-risc-1-0
10172 @opindex mpa-risc-1-1
10173 @opindex mpa-risc-2-0
10174 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10176 @item -mbig-switch
10177 @opindex mbig-switch
10178 Generate code suitable for big switch tables.  Use this option only if
10179 the assembler/linker complain about out of range branches within a switch
10180 table.
10182 @item -mjump-in-delay
10183 @opindex mjump-in-delay
10184 Fill delay slots of function calls with unconditional jump instructions
10185 by modifying the return pointer for the function call to be the target
10186 of the conditional jump.
10188 @item -mdisable-fpregs
10189 @opindex mdisable-fpregs
10190 Prevent floating point registers from being used in any manner.  This is
10191 necessary for compiling kernels which perform lazy context switching of
10192 floating point registers.  If you use this option and attempt to perform
10193 floating point operations, the compiler will abort.
10195 @item -mdisable-indexing
10196 @opindex mdisable-indexing
10197 Prevent the compiler from using indexing address modes.  This avoids some
10198 rather obscure problems when compiling MIG generated code under MACH@.
10200 @item -mno-space-regs
10201 @opindex mno-space-regs
10202 Generate code that assumes the target has no space registers.  This allows
10203 GCC to generate faster indirect calls and use unscaled index address modes.
10205 Such code is suitable for level 0 PA systems and kernels.
10207 @item -mfast-indirect-calls
10208 @opindex mfast-indirect-calls
10209 Generate code that assumes calls never cross space boundaries.  This
10210 allows GCC to emit code which performs faster indirect calls.
10212 This option will not work in the presence of shared libraries or nested
10213 functions.
10215 @item -mfixed-range=@var{register-range}
10216 @opindex mfixed-range
10217 Generate code treating the given register range as fixed registers.
10218 A fixed register is one that the register allocator can not use.  This is
10219 useful when compiling kernel code.  A register range is specified as
10220 two registers separated by a dash.  Multiple register ranges can be
10221 specified separated by a comma.
10223 @item -mlong-load-store
10224 @opindex mlong-load-store
10225 Generate 3-instruction load and store sequences as sometimes required by
10226 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10227 the HP compilers.
10229 @item -mportable-runtime
10230 @opindex mportable-runtime
10231 Use the portable calling conventions proposed by HP for ELF systems.
10233 @item -mgas
10234 @opindex mgas
10235 Enable the use of assembler directives only GAS understands.
10237 @item -mschedule=@var{cpu-type}
10238 @opindex mschedule
10239 Schedule code according to the constraints for the machine type
10240 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10241 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10242 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10243 proper scheduling option for your machine.  The default scheduling is
10244 @samp{8000}.
10246 @item -mlinker-opt
10247 @opindex mlinker-opt
10248 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10249 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10250 linkers in which they give bogus error messages when linking some programs.
10252 @item -msoft-float
10253 @opindex msoft-float
10254 Generate output containing library calls for floating point.
10255 @strong{Warning:} the requisite libraries are not available for all HPPA
10256 targets.  Normally the facilities of the machine's usual C compiler are
10257 used, but this cannot be done directly in cross-compilation.  You must make
10258 your own arrangements to provide suitable library functions for
10259 cross-compilation.
10261 @option{-msoft-float} changes the calling convention in the output file;
10262 therefore, it is only useful if you compile @emph{all} of a program with
10263 this option.  In particular, you need to compile @file{libgcc.a}, the
10264 library that comes with GCC, with @option{-msoft-float} in order for
10265 this to work.
10267 @item -msio
10268 @opindex msio
10269 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10270 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10271 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10272 options are available under HP-UX and HI-UX@.
10274 @item -mgnu-ld
10275 @opindex gnu-ld
10276 Use GNU ld specific options.  This passes @option{-shared} to ld when
10277 building a shared library.  It is the default when GCC is configured,
10278 explicitly or implicitly, with the GNU linker.  This option does not
10279 have any affect on which ld is called, it only changes what parameters
10280 are passed to that ld.  The ld that is called is determined by the
10281 @option{--with-ld} configure option, GCC's program search path, and
10282 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10283 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10284 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10286 @item -mhp-ld
10287 @opindex hp-ld
10288 Use HP ld specific options.  This passes @option{-b} to ld when building
10289 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10290 links.  It is the default when GCC is configured, explicitly or
10291 implicitly, with the HP linker.  This option does not have any affect on
10292 which ld is called, it only changes what parameters are passed to that
10293 ld.  The ld that is called is determined by the @option{--with-ld}
10294 configure option, GCC's program search path, and finally by the user's
10295 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10296 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10297 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10299 @item -mlong-calls
10300 @opindex mno-long-calls
10301 Generate code that uses long call sequences.  This ensures that a call
10302 is always able to reach linker generated stubs.  The default is to generate
10303 long calls only when the distance from the call site to the beginning
10304 of the function or translation unit, as the case may be, exceeds a
10305 predefined limit set by the branch type being used.  The limits for
10306 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10307 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10308 240,000 bytes.
10310 Distances are measured from the beginning of functions when using the
10311 @option{-ffunction-sections} option, or when using the @option{-mgas}
10312 and @option{-mno-portable-runtime} options together under HP-UX with
10313 the SOM linker.
10315 It is normally not desirable to use this option as it will degrade
10316 performance.  However, it may be useful in large applications,
10317 particularly when partial linking is used to build the application.
10319 The types of long calls used depends on the capabilities of the
10320 assembler and linker, and the type of code being generated.  The
10321 impact on systems that support long absolute calls, and long pic
10322 symbol-difference or pc-relative calls should be relatively small.
10323 However, an indirect call is used on 32-bit ELF systems in pic code
10324 and it is quite long.
10326 @item -munix=@var{unix-std}
10327 @opindex march
10328 Generate compiler predefines and select a startfile for the specified
10329 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10330 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10331 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10332 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10333 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10334 and later.
10336 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10337 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10338 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10339 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10340 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10341 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10343 It is @emph{important} to note that this option changes the interfaces
10344 for various library routines.  It also affects the operational behavior
10345 of the C library.  Thus, @emph{extreme} care is needed in using this
10346 option.
10348 Library code that is intended to operate with more than one UNIX
10349 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10350 as appropriate.  Most GNU software doesn't provide this capability.
10352 @item -nolibdld
10353 @opindex nolibdld
10354 Suppress the generation of link options to search libdld.sl when the
10355 @option{-static} option is specified on HP-UX 10 and later.
10357 @item -static
10358 @opindex static
10359 The HP-UX implementation of setlocale in libc has a dependency on
10360 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10361 when the @option{-static} option is specified, special link options
10362 are needed to resolve this dependency.
10364 On HP-UX 10 and later, the GCC driver adds the necessary options to
10365 link with libdld.sl when the @option{-static} option is specified.
10366 This causes the resulting binary to be dynamic.  On the 64-bit port,
10367 the linkers generate dynamic binaries by default in any case.  The
10368 @option{-nolibdld} option can be used to prevent the GCC driver from
10369 adding these link options.
10371 @item -threads
10372 @opindex threads
10373 Add support for multithreading with the @dfn{dce thread} library
10374 under HP-UX@.  This option sets flags for both the preprocessor and
10375 linker.
10376 @end table
10378 @node i386 and x86-64 Options
10379 @subsection Intel 386 and AMD x86-64 Options
10380 @cindex i386 Options
10381 @cindex x86-64 Options
10382 @cindex Intel 386 Options
10383 @cindex AMD x86-64 Options
10385 These @samp{-m} options are defined for the i386 and x86-64 family of
10386 computers:
10388 @table @gcctabopt
10389 @item -mtune=@var{cpu-type}
10390 @opindex mtune
10391 Tune to @var{cpu-type} everything applicable about the generated code, except
10392 for the ABI and the set of available instructions.  The choices for
10393 @var{cpu-type} are:
10394 @table @emph
10395 @item generic
10396 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10397 If you know the CPU on which your code will run, then you should use
10398 the corresponding @option{-mtune} option instead of
10399 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10400 of your application will have, then you should use this option.
10402 As new processors are deployed in the marketplace, the behavior of this
10403 option will change.  Therefore, if you upgrade to a newer version of
10404 GCC, the code generated option will change to reflect the processors
10405 that were most common when that version of GCC was released.
10407 There is no @option{-march=generic} option because @option{-march}
10408 indicates the instruction set the compiler can use, and there is no
10409 generic instruction set applicable to all processors.  In contrast,
10410 @option{-mtune} indicates the processor (or, in this case, collection of
10411 processors) for which the code is optimized.
10412 @item native
10413 This selects the CPU to tune for at compilation time by determining
10414 the processor type of the compiling machine.  Using @option{-mtune=native}
10415 will produce code optimized for the local machine under the constraints
10416 of the selected instruction set.  Using @option{-march=native} will
10417 enable all instruction subsets supported by the local machine (hence
10418 the result might not run on different machines).
10419 @item i386
10420 Original Intel's i386 CPU@.
10421 @item i486
10422 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10423 @item i586, pentium
10424 Intel Pentium CPU with no MMX support.
10425 @item pentium-mmx
10426 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10427 @item pentiumpro
10428 Intel PentiumPro CPU@.
10429 @item i686
10430 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10431 instruction set will be used, so the code will run on all i686 family chips.
10432 @item pentium2
10433 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10434 @item pentium3, pentium3m
10435 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10436 support.
10437 @item pentium-m
10438 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10439 support.  Used by Centrino notebooks.
10440 @item pentium4, pentium4m
10441 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10442 @item prescott
10443 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10444 set support.
10445 @item nocona
10446 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10447 SSE2 and SSE3 instruction set support.
10448 @item core2
10449 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10450 instruction set support.
10451 @item k6
10452 AMD K6 CPU with MMX instruction set support.
10453 @item k6-2, k6-3
10454 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10455 @item athlon, athlon-tbird
10456 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10457 support.
10458 @item athlon-4, athlon-xp, athlon-mp
10459 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10460 instruction set support.
10461 @item k8, opteron, athlon64, athlon-fx
10462 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10463 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10464 @item k8-sse3, opteron-sse3, athlon64-sse3
10465 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10466 @item amdfam10, barcelona
10467 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10468 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10469 instruction set extensions.)
10470 @item winchip-c6
10471 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10472 set support.
10473 @item winchip2
10474 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10475 instruction set support.
10476 @item c3
10477 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10478 implemented for this chip.)
10479 @item c3-2
10480 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10481 implemented for this chip.)
10482 @item geode
10483 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10484 @end table
10486 While picking a specific @var{cpu-type} will schedule things appropriately
10487 for that particular chip, the compiler will not generate any code that
10488 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10489 being used.
10491 @item -march=@var{cpu-type}
10492 @opindex march
10493 Generate instructions for the machine type @var{cpu-type}.  The choices
10494 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10495 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10497 @item -mcpu=@var{cpu-type}
10498 @opindex mcpu
10499 A deprecated synonym for @option{-mtune}.
10501 @item -mfpmath=@var{unit}
10502 @opindex march
10503 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10504 for @var{unit} are:
10506 @table @samp
10507 @item 387
10508 Use the standard 387 floating point coprocessor present majority of chips and
10509 emulated otherwise.  Code compiled with this option will run almost everywhere.
10510 The temporary results are computed in 80bit precision instead of precision
10511 specified by the type resulting in slightly different results compared to most
10512 of other chips.  See @option{-ffloat-store} for more detailed description.
10514 This is the default choice for i386 compiler.
10516 @item sse
10517 Use scalar floating point instructions present in the SSE instruction set.
10518 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10519 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10520 instruction set supports only single precision arithmetics, thus the double and
10521 extended precision arithmetics is still done using 387.  Later version, present
10522 only in Pentium4 and the future AMD x86-64 chips supports double precision
10523 arithmetics too.
10525 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10526 or @option{-msse2} switches to enable SSE extensions and make this option
10527 effective.  For the x86-64 compiler, these extensions are enabled by default.
10529 The resulting code should be considerably faster in the majority of cases and avoid
10530 the numerical instability problems of 387 code, but may break some existing
10531 code that expects temporaries to be 80bit.
10533 This is the default choice for the x86-64 compiler.
10535 @item sse,387
10536 Attempt to utilize both instruction sets at once.  This effectively double the
10537 amount of available registers and on chips with separate execution units for
10538 387 and SSE the execution resources too.  Use this option with care, as it is
10539 still experimental, because the GCC register allocator does not model separate
10540 functional units well resulting in instable performance.
10541 @end table
10543 @item -masm=@var{dialect}
10544 @opindex masm=@var{dialect}
10545 Output asm instructions using selected @var{dialect}.  Supported
10546 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10547 not support @samp{intel}.
10549 @item -mieee-fp
10550 @itemx -mno-ieee-fp
10551 @opindex mieee-fp
10552 @opindex mno-ieee-fp
10553 Control whether or not the compiler uses IEEE floating point
10554 comparisons.  These handle correctly the case where the result of a
10555 comparison is unordered.
10557 @item -msoft-float
10558 @opindex msoft-float
10559 Generate output containing library calls for floating point.
10560 @strong{Warning:} the requisite libraries are not part of GCC@.
10561 Normally the facilities of the machine's usual C compiler are used, but
10562 this can't be done directly in cross-compilation.  You must make your
10563 own arrangements to provide suitable library functions for
10564 cross-compilation.
10566 On machines where a function returns floating point results in the 80387
10567 register stack, some floating point opcodes may be emitted even if
10568 @option{-msoft-float} is used.
10570 @item -mno-fp-ret-in-387
10571 @opindex mno-fp-ret-in-387
10572 Do not use the FPU registers for return values of functions.
10574 The usual calling convention has functions return values of types
10575 @code{float} and @code{double} in an FPU register, even if there
10576 is no FPU@.  The idea is that the operating system should emulate
10577 an FPU@.
10579 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10580 in ordinary CPU registers instead.
10582 @item -mno-fancy-math-387
10583 @opindex mno-fancy-math-387
10584 Some 387 emulators do not support the @code{sin}, @code{cos} and
10585 @code{sqrt} instructions for the 387.  Specify this option to avoid
10586 generating those instructions.  This option is the default on FreeBSD,
10587 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10588 indicates that the target cpu will always have an FPU and so the
10589 instruction will not need emulation.  As of revision 2.6.1, these
10590 instructions are not generated unless you also use the
10591 @option{-funsafe-math-optimizations} switch.
10593 @item -malign-double
10594 @itemx -mno-align-double
10595 @opindex malign-double
10596 @opindex mno-align-double
10597 Control whether GCC aligns @code{double}, @code{long double}, and
10598 @code{long long} variables on a two word boundary or a one word
10599 boundary.  Aligning @code{double} variables on a two word boundary will
10600 produce code that runs somewhat faster on a @samp{Pentium} at the
10601 expense of more memory.
10603 On x86-64, @option{-malign-double} is enabled by default.
10605 @strong{Warning:} if you use the @option{-malign-double} switch,
10606 structures containing the above types will be aligned differently than
10607 the published application binary interface specifications for the 386
10608 and will not be binary compatible with structures in code compiled
10609 without that switch.
10611 @item -m96bit-long-double
10612 @itemx -m128bit-long-double
10613 @opindex m96bit-long-double
10614 @opindex m128bit-long-double
10615 These switches control the size of @code{long double} type.  The i386
10616 application binary interface specifies the size to be 96 bits,
10617 so @option{-m96bit-long-double} is the default in 32 bit mode.
10619 Modern architectures (Pentium and newer) would prefer @code{long double}
10620 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10621 conforming to the ABI, this would not be possible.  So specifying a
10622 @option{-m128bit-long-double} will align @code{long double}
10623 to a 16 byte boundary by padding the @code{long double} with an additional
10624 32 bit zero.
10626 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10627 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10629 Notice that neither of these options enable any extra precision over the x87
10630 standard of 80 bits for a @code{long double}.
10632 @strong{Warning:} if you override the default value for your target ABI, the
10633 structures and arrays containing @code{long double} variables will change
10634 their size as well as function calling convention for function taking
10635 @code{long double} will be modified.  Hence they will not be binary
10636 compatible with arrays or structures in code compiled without that switch.
10638 @item -mmlarge-data-threshold=@var{number}
10639 @opindex mlarge-data-threshold=@var{number}
10640 When @option{-mcmodel=medium} is specified, the data greater than
10641 @var{threshold} are placed in large data section.  This value must be the
10642 same across all object linked into the binary and defaults to 65535.
10644 @item -mrtd
10645 @opindex mrtd
10646 Use a different function-calling convention, in which functions that
10647 take a fixed number of arguments return with the @code{ret} @var{num}
10648 instruction, which pops their arguments while returning.  This saves one
10649 instruction in the caller since there is no need to pop the arguments
10650 there.
10652 You can specify that an individual function is called with this calling
10653 sequence with the function attribute @samp{stdcall}.  You can also
10654 override the @option{-mrtd} option by using the function attribute
10655 @samp{cdecl}.  @xref{Function Attributes}.
10657 @strong{Warning:} this calling convention is incompatible with the one
10658 normally used on Unix, so you cannot use it if you need to call
10659 libraries compiled with the Unix compiler.
10661 Also, you must provide function prototypes for all functions that
10662 take variable numbers of arguments (including @code{printf});
10663 otherwise incorrect code will be generated for calls to those
10664 functions.
10666 In addition, seriously incorrect code will result if you call a
10667 function with too many arguments.  (Normally, extra arguments are
10668 harmlessly ignored.)
10670 @item -mregparm=@var{num}
10671 @opindex mregparm
10672 Control how many registers are used to pass integer arguments.  By
10673 default, no registers are used to pass arguments, and at most 3
10674 registers can be used.  You can control this behavior for a specific
10675 function by using the function attribute @samp{regparm}.
10676 @xref{Function Attributes}.
10678 @strong{Warning:} if you use this switch, and
10679 @var{num} is nonzero, then you must build all modules with the same
10680 value, including any libraries.  This includes the system libraries and
10681 startup modules.
10683 @item -msseregparm
10684 @opindex msseregparm
10685 Use SSE register passing conventions for float and double arguments
10686 and return values.  You can control this behavior for a specific
10687 function by using the function attribute @samp{sseregparm}.
10688 @xref{Function Attributes}.
10690 @strong{Warning:} if you use this switch then you must build all
10691 modules with the same value, including any libraries.  This includes
10692 the system libraries and startup modules.
10694 @item -mpc32
10695 @itemx -mpc64
10696 @itemx -mpc80
10697 @opindex mpc32
10698 @opindex mpc64
10699 @opindex mpc80
10701 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10702 is specified, the significands of results of floating-point operations are
10703 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10704 significands of results of floating-point operations to 53 bits (double
10705 precision) and @option{-mpc80} rounds the significands of results of
10706 floating-point operations to 64 bits (extended double precision), which is
10707 the default.  When this option is used, floating-point operations in higher
10708 precisions are not available to the programmer without setting the FPU
10709 control word explicitly.
10711 Setting the rounding of floating-point operations to less than the default
10712 80 bits can speed some programs by 2% or more.  Note that some mathematical
10713 libraries assume that extended precision (80 bit) floating-point operations
10714 are enabled by default; routines in such libraries could suffer significant
10715 loss of accuracy, typically through so-called "catastrophic cancellation",
10716 when this option is used to set the precision to less than extended precision. 
10718 @item -mstackrealign
10719 @opindex mstackrealign
10720 Realign the stack at entry.  On the Intel x86, the
10721 @option{-mstackrealign} option will generate an alternate prologue and
10722 epilogue that realigns the runtime stack.  This supports mixing legacy
10723 codes that keep a 4-byte aligned stack with modern codes that keep a
10724 16-byte stack for SSE compatibility.  The alternate prologue and
10725 epilogue are slower and bigger than the regular ones, and the
10726 alternate prologue requires an extra scratch register; this lowers the
10727 number of registers available if used in conjunction with the
10728 @code{regparm} attribute.  The @option{-mstackrealign} option is
10729 incompatible with the nested function prologue; this is considered a
10730 hard error.  See also the attribute @code{force_align_arg_pointer},
10731 applicable to individual functions.
10733 @item -mpreferred-stack-boundary=@var{num}
10734 @opindex mpreferred-stack-boundary
10735 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10736 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10737 the default is 4 (16 bytes or 128 bits).
10739 On Pentium and PentiumPro, @code{double} and @code{long double} values
10740 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10741 suffer significant run time performance penalties.  On Pentium III, the
10742 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10743 properly if it is not 16 byte aligned.
10745 To ensure proper alignment of this values on the stack, the stack boundary
10746 must be as aligned as that required by any value stored on the stack.
10747 Further, every function must be generated such that it keeps the stack
10748 aligned.  Thus calling a function compiled with a higher preferred
10749 stack boundary from a function compiled with a lower preferred stack
10750 boundary will most likely misalign the stack.  It is recommended that
10751 libraries that use callbacks always use the default setting.
10753 This extra alignment does consume extra stack space, and generally
10754 increases code size.  Code that is sensitive to stack space usage, such
10755 as embedded systems and operating system kernels, may want to reduce the
10756 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10758 @item -mmmx
10759 @itemx -mno-mmx
10760 @itemx -msse
10761 @itemx -mno-sse
10762 @itemx -msse2
10763 @itemx -mno-sse2
10764 @itemx -msse3
10765 @itemx -mno-sse3
10766 @itemx -mssse3
10767 @itemx -mno-ssse3
10768 @itemx -msse4.1
10769 @itemx -mno-sse4.1
10770 @itemx -msse4.2
10771 @itemx -mno-sse4.2
10772 @itemx -msse4
10773 @itemx -mno-sse4
10774 @itemx -maes
10775 @itemx -mno-aes
10776 @itemx -mpclmul
10777 @itemx -mno-pclmul
10778 @itemx -msse4a
10779 @itemx -mno-sse4a
10780 @itemx -msse5
10781 @itemx -mno-sse5
10782 @itemx -m3dnow
10783 @itemx -mno-3dnow
10784 @itemx -mpopcnt
10785 @itemx -mno-popcnt
10786 @itemx -mabm
10787 @itemx -mno-abm
10788 @opindex mmmx
10789 @opindex mno-mmx
10790 @opindex msse
10791 @opindex mno-sse
10792 @opindex m3dnow
10793 @opindex mno-3dnow
10794 These switches enable or disable the use of instructions in the MMX,
10795 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10796 3DNow!@: extended instruction sets.
10797 These extensions are also available as built-in functions: see
10798 @ref{X86 Built-in Functions}, for details of the functions enabled and
10799 disabled by these switches.
10801 To have SSE/SSE2 instructions generated automatically from floating-point
10802 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10804 These options will enable GCC to use these extended instructions in
10805 generated code, even without @option{-mfpmath=sse}.  Applications which
10806 perform runtime CPU detection must compile separate files for each
10807 supported architecture, using the appropriate flags.  In particular,
10808 the file containing the CPU detection code should be compiled without
10809 these options.
10811 @item -mcld
10812 @opindex mcld
10813 This option instructs GCC to emit a @code{cld} instruction in the prologue
10814 of functions that use string instructions.  String instructions depend on
10815 the DF flag to select between autoincrement or autodecrement mode.  While the
10816 ABI specifies the DF flag to be cleared on function entry, some operating
10817 systems violate this specification by not clearing the DF flag in their
10818 exception dispatchers.  The exception handler can be invoked with the DF flag
10819 set which leads to wrong direction mode, when string instructions are used.
10820 This option can be enabled by default on 32-bit x86 targets by configuring
10821 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
10822 instructions can be suppressed with the @option{-mno-cld} compiler option
10823 in this case.
10825 @item -mcx16
10826 @opindex mcx16
10827 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10828 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10829 data types.  This is useful for high resolution counters that could be updated
10830 by multiple processors (or cores).  This instruction is generated as part of
10831 atomic built-in functions: see @ref{Atomic Builtins} for details.
10833 @item -msahf
10834 @opindex msahf
10835 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10836 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10837 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10838 SAHF are load and store instructions, respectively, for certain status flags.
10839 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10840 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10842 @item -mrecip
10843 @opindex mrecip
10844 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10845 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10846 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10847 variants) for single precision floating point arguments.  These instructions
10848 are generated only when @option{-funsafe-math-optimizations} is enabled
10849 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10850 Note that while the throughput of the sequence is higher than the throughput
10851 of the non-reciprocal instruction, the precision of the sequence can be
10852 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10854 @item -mveclibabi=@var{type}
10855 @opindex mveclibabi
10856 Specifies the ABI type to use for vectorizing intrinsics using an
10857 external library.  Supported types are @code{svml} for the Intel short
10858 vector math library and @code{acml} for the AMD math core library style
10859 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10860 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10861 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10862 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10863 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10864 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10865 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10866 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10867 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10868 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10869 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10870 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10871 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10872 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10873 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10874 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10875 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10876 compatible library will have to be specified at link time.
10878 @item -mpush-args
10879 @itemx -mno-push-args
10880 @opindex mpush-args
10881 @opindex mno-push-args
10882 Use PUSH operations to store outgoing parameters.  This method is shorter
10883 and usually equally fast as method using SUB/MOV operations and is enabled
10884 by default.  In some cases disabling it may improve performance because of
10885 improved scheduling and reduced dependencies.
10887 @item -maccumulate-outgoing-args
10888 @opindex maccumulate-outgoing-args
10889 If enabled, the maximum amount of space required for outgoing arguments will be
10890 computed in the function prologue.  This is faster on most modern CPUs
10891 because of reduced dependencies, improved scheduling and reduced stack usage
10892 when preferred stack boundary is not equal to 2.  The drawback is a notable
10893 increase in code size.  This switch implies @option{-mno-push-args}.
10895 @item -mthreads
10896 @opindex mthreads
10897 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10898 on thread-safe exception handling must compile and link all code with the
10899 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10900 @option{-D_MT}; when linking, it links in a special thread helper library
10901 @option{-lmingwthrd} which cleans up per thread exception handling data.
10903 @item -mno-align-stringops
10904 @opindex mno-align-stringops
10905 Do not align destination of inlined string operations.  This switch reduces
10906 code size and improves performance in case the destination is already aligned,
10907 but GCC doesn't know about it.
10909 @item -minline-all-stringops
10910 @opindex minline-all-stringops
10911 By default GCC inlines string operations only when destination is known to be
10912 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10913 size, but may improve performance of code that depends on fast memcpy, strlen
10914 and memset for short lengths.
10916 @item -minline-stringops-dynamically
10917 @opindex minline-stringops-dynamically
10918 For string operation of unknown size, inline runtime checks so for small
10919 blocks inline code is used, while for large blocks library call is used.
10921 @item -mstringop-strategy=@var{alg}
10922 @opindex mstringop-strategy=@var{alg}
10923 Overwrite internal decision heuristic about particular algorithm to inline
10924 string operation with.  The allowed values are @code{rep_byte},
10925 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10926 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10927 expanding inline loop, @code{libcall} for always expanding library call.
10929 @item -momit-leaf-frame-pointer
10930 @opindex momit-leaf-frame-pointer
10931 Don't keep the frame pointer in a register for leaf functions.  This
10932 avoids the instructions to save, set up and restore frame pointers and
10933 makes an extra register available in leaf functions.  The option
10934 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10935 which might make debugging harder.
10937 @item -mtls-direct-seg-refs
10938 @itemx -mno-tls-direct-seg-refs
10939 @opindex mtls-direct-seg-refs
10940 Controls whether TLS variables may be accessed with offsets from the
10941 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10942 or whether the thread base pointer must be added.  Whether or not this
10943 is legal depends on the operating system, and whether it maps the
10944 segment to cover the entire TLS area.
10946 For systems that use GNU libc, the default is on.
10948 @item -mfused-madd
10949 @itemx -mno-fused-madd
10950 @opindex mfused-madd
10951 Enable automatic generation of fused floating point multiply-add instructions
10952 if the ISA supports such instructions.  The -mfused-madd option is on by
10953 default.  The fused multiply-add instructions have a different
10954 rounding behavior compared to executing a multiply followed by an add.
10955 @end table
10957 These @samp{-m} switches are supported in addition to the above
10958 on AMD x86-64 processors in 64-bit environments.
10960 @table @gcctabopt
10961 @item -m32
10962 @itemx -m64
10963 @opindex m32
10964 @opindex m64
10965 Generate code for a 32-bit or 64-bit environment.
10966 The 32-bit environment sets int, long and pointer to 32 bits and
10967 generates code that runs on any i386 system.
10968 The 64-bit environment sets int to 32 bits and long and pointer
10969 to 64 bits and generates code for AMD's x86-64 architecture. For
10970 darwin only the -m64 option turns off the @option{-fno-pic} and
10971 @option{-mdynamic-no-pic} options.
10973 @item -mno-red-zone
10974 @opindex no-red-zone
10975 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10976 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10977 stack pointer that will not be modified by signal or interrupt handlers
10978 and therefore can be used for temporary data without adjusting the stack
10979 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10981 @item -mcmodel=small
10982 @opindex mcmodel=small
10983 Generate code for the small code model: the program and its symbols must
10984 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10985 Programs can be statically or dynamically linked.  This is the default
10986 code model.
10988 @item -mcmodel=kernel
10989 @opindex mcmodel=kernel
10990 Generate code for the kernel code model.  The kernel runs in the
10991 negative 2 GB of the address space.
10992 This model has to be used for Linux kernel code.
10994 @item -mcmodel=medium
10995 @opindex mcmodel=medium
10996 Generate code for the medium model: The program is linked in the lower 2
10997 GB of the address space but symbols can be located anywhere in the
10998 address space.  Programs can be statically or dynamically linked, but
10999 building of shared libraries are not supported with the medium model.
11001 @item -mcmodel=large
11002 @opindex mcmodel=large
11003 Generate code for the large model: This model makes no assumptions
11004 about addresses and sizes of sections.
11005 @end table
11007 @node IA-64 Options
11008 @subsection IA-64 Options
11009 @cindex IA-64 Options
11011 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11013 @table @gcctabopt
11014 @item -mbig-endian
11015 @opindex mbig-endian
11016 Generate code for a big endian target.  This is the default for HP-UX@.
11018 @item -mlittle-endian
11019 @opindex mlittle-endian
11020 Generate code for a little endian target.  This is the default for AIX5
11021 and GNU/Linux.
11023 @item -mgnu-as
11024 @itemx -mno-gnu-as
11025 @opindex mgnu-as
11026 @opindex mno-gnu-as
11027 Generate (or don't) code for the GNU assembler.  This is the default.
11028 @c Also, this is the default if the configure option @option{--with-gnu-as}
11029 @c is used.
11031 @item -mgnu-ld
11032 @itemx -mno-gnu-ld
11033 @opindex mgnu-ld
11034 @opindex mno-gnu-ld
11035 Generate (or don't) code for the GNU linker.  This is the default.
11036 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11037 @c is used.
11039 @item -mno-pic
11040 @opindex mno-pic
11041 Generate code that does not use a global pointer register.  The result
11042 is not position independent code, and violates the IA-64 ABI@.
11044 @item -mvolatile-asm-stop
11045 @itemx -mno-volatile-asm-stop
11046 @opindex mvolatile-asm-stop
11047 @opindex mno-volatile-asm-stop
11048 Generate (or don't) a stop bit immediately before and after volatile asm
11049 statements.
11051 @item -mregister-names
11052 @itemx -mno-register-names
11053 @opindex mregister-names
11054 @opindex mno-register-names
11055 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11056 the stacked registers.  This may make assembler output more readable.
11058 @item -mno-sdata
11059 @itemx -msdata
11060 @opindex mno-sdata
11061 @opindex msdata
11062 Disable (or enable) optimizations that use the small data section.  This may
11063 be useful for working around optimizer bugs.
11065 @item -mconstant-gp
11066 @opindex mconstant-gp
11067 Generate code that uses a single constant global pointer value.  This is
11068 useful when compiling kernel code.
11070 @item -mauto-pic
11071 @opindex mauto-pic
11072 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11073 This is useful when compiling firmware code.
11075 @item -minline-float-divide-min-latency
11076 @opindex minline-float-divide-min-latency
11077 Generate code for inline divides of floating point values
11078 using the minimum latency algorithm.
11080 @item -minline-float-divide-max-throughput
11081 @opindex minline-float-divide-max-throughput
11082 Generate code for inline divides of floating point values
11083 using the maximum throughput algorithm.
11085 @item -minline-int-divide-min-latency
11086 @opindex minline-int-divide-min-latency
11087 Generate code for inline divides of integer values
11088 using the minimum latency algorithm.
11090 @item -minline-int-divide-max-throughput
11091 @opindex minline-int-divide-max-throughput
11092 Generate code for inline divides of integer values
11093 using the maximum throughput algorithm.
11095 @item -minline-sqrt-min-latency
11096 @opindex minline-sqrt-min-latency
11097 Generate code for inline square roots
11098 using the minimum latency algorithm.
11100 @item -minline-sqrt-max-throughput
11101 @opindex minline-sqrt-max-throughput
11102 Generate code for inline square roots
11103 using the maximum throughput algorithm.
11105 @item -mno-dwarf2-asm
11106 @itemx -mdwarf2-asm
11107 @opindex mno-dwarf2-asm
11108 @opindex mdwarf2-asm
11109 Don't (or do) generate assembler code for the DWARF2 line number debugging
11110 info.  This may be useful when not using the GNU assembler.
11112 @item -mearly-stop-bits
11113 @itemx -mno-early-stop-bits
11114 @opindex mearly-stop-bits
11115 @opindex mno-early-stop-bits
11116 Allow stop bits to be placed earlier than immediately preceding the
11117 instruction that triggered the stop bit.  This can improve instruction
11118 scheduling, but does not always do so.
11120 @item -mfixed-range=@var{register-range}
11121 @opindex mfixed-range
11122 Generate code treating the given register range as fixed registers.
11123 A fixed register is one that the register allocator can not use.  This is
11124 useful when compiling kernel code.  A register range is specified as
11125 two registers separated by a dash.  Multiple register ranges can be
11126 specified separated by a comma.
11128 @item -mtls-size=@var{tls-size}
11129 @opindex mtls-size
11130 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11133 @item -mtune=@var{cpu-type}
11134 @opindex mtune
11135 Tune the instruction scheduling for a particular CPU, Valid values are
11136 itanium, itanium1, merced, itanium2, and mckinley.
11138 @item -mt
11139 @itemx -pthread
11140 @opindex mt
11141 @opindex pthread
11142 Add support for multithreading using the POSIX threads library.  This
11143 option sets flags for both the preprocessor and linker.  It does
11144 not affect the thread safety of object code produced by the compiler or
11145 that of libraries supplied with it.  These are HP-UX specific flags.
11147 @item -milp32
11148 @itemx -mlp64
11149 @opindex milp32
11150 @opindex mlp64
11151 Generate code for a 32-bit or 64-bit environment.
11152 The 32-bit environment sets int, long and pointer to 32 bits.
11153 The 64-bit environment sets int to 32 bits and long and pointer
11154 to 64 bits.  These are HP-UX specific flags.
11156 @item -mno-sched-br-data-spec
11157 @itemx -msched-br-data-spec
11158 @opindex mno-sched-br-data-spec
11159 @opindex msched-br-data-spec
11160 (Dis/En)able data speculative scheduling before reload.
11161 This will result in generation of the ld.a instructions and
11162 the corresponding check instructions (ld.c / chk.a).
11163 The default is 'disable'.
11165 @item -msched-ar-data-spec
11166 @itemx -mno-sched-ar-data-spec
11167 @opindex msched-ar-data-spec
11168 @opindex mno-sched-ar-data-spec
11169 (En/Dis)able data speculative scheduling after reload.
11170 This will result in generation of the ld.a instructions and
11171 the corresponding check instructions (ld.c / chk.a).
11172 The default is 'enable'.
11174 @item -mno-sched-control-spec
11175 @itemx -msched-control-spec
11176 @opindex mno-sched-control-spec
11177 @opindex msched-control-spec
11178 (Dis/En)able control speculative scheduling.  This feature is
11179 available only during region scheduling (i.e.@: before reload).
11180 This will result in generation of the ld.s instructions and
11181 the corresponding check instructions chk.s .
11182 The default is 'disable'.
11184 @item -msched-br-in-data-spec
11185 @itemx -mno-sched-br-in-data-spec
11186 @opindex msched-br-in-data-spec
11187 @opindex mno-sched-br-in-data-spec
11188 (En/Dis)able speculative scheduling of the instructions that
11189 are dependent on the data speculative loads before reload.
11190 This is effective only with @option{-msched-br-data-spec} enabled.
11191 The default is 'enable'.
11193 @item -msched-ar-in-data-spec
11194 @itemx -mno-sched-ar-in-data-spec
11195 @opindex msched-ar-in-data-spec
11196 @opindex mno-sched-ar-in-data-spec
11197 (En/Dis)able speculative scheduling of the instructions that
11198 are dependent on the data speculative loads after reload.
11199 This is effective only with @option{-msched-ar-data-spec} enabled.
11200 The default is 'enable'.
11202 @item -msched-in-control-spec
11203 @itemx -mno-sched-in-control-spec
11204 @opindex msched-in-control-spec
11205 @opindex mno-sched-in-control-spec
11206 (En/Dis)able speculative scheduling of the instructions that
11207 are dependent on the control speculative loads.
11208 This is effective only with @option{-msched-control-spec} enabled.
11209 The default is 'enable'.
11211 @item -msched-ldc
11212 @itemx -mno-sched-ldc
11213 @opindex msched-ldc
11214 @opindex mno-sched-ldc
11215 (En/Dis)able use of simple data speculation checks ld.c .
11216 If disabled, only chk.a instructions will be emitted to check
11217 data speculative loads.
11218 The default is 'enable'.
11220 @item -mno-sched-control-ldc
11221 @itemx -msched-control-ldc
11222 @opindex mno-sched-control-ldc
11223 @opindex msched-control-ldc
11224 (Dis/En)able use of ld.c instructions to check control speculative loads.
11225 If enabled, in case of control speculative load with no speculatively
11226 scheduled dependent instructions this load will be emitted as ld.sa and
11227 ld.c will be used to check it.
11228 The default is 'disable'.
11230 @item -mno-sched-spec-verbose
11231 @itemx -msched-spec-verbose
11232 @opindex mno-sched-spec-verbose
11233 @opindex msched-spec-verbose
11234 (Dis/En)able printing of the information about speculative motions.
11236 @item -mno-sched-prefer-non-data-spec-insns
11237 @itemx -msched-prefer-non-data-spec-insns
11238 @opindex mno-sched-prefer-non-data-spec-insns
11239 @opindex msched-prefer-non-data-spec-insns
11240 If enabled, data speculative instructions will be chosen for schedule
11241 only if there are no other choices at the moment.  This will make
11242 the use of the data speculation much more conservative.
11243 The default is 'disable'.
11245 @item -mno-sched-prefer-non-control-spec-insns
11246 @itemx -msched-prefer-non-control-spec-insns
11247 @opindex mno-sched-prefer-non-control-spec-insns
11248 @opindex msched-prefer-non-control-spec-insns
11249 If enabled, control speculative instructions will be chosen for schedule
11250 only if there are no other choices at the moment.  This will make
11251 the use of the control speculation much more conservative.
11252 The default is 'disable'.
11254 @item -mno-sched-count-spec-in-critical-path
11255 @itemx -msched-count-spec-in-critical-path
11256 @opindex mno-sched-count-spec-in-critical-path
11257 @opindex msched-count-spec-in-critical-path
11258 If enabled, speculative dependencies will be considered during
11259 computation of the instructions priorities.  This will make the use of the
11260 speculation a bit more conservative.
11261 The default is 'disable'.
11263 @end table
11265 @node M32C Options
11266 @subsection M32C Options
11267 @cindex M32C options
11269 @table @gcctabopt
11270 @item -mcpu=@var{name}
11271 @opindex mcpu=
11272 Select the CPU for which code is generated.  @var{name} may be one of
11273 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11274 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11275 the M32C/80 series.
11277 @item -msim
11278 @opindex msim
11279 Specifies that the program will be run on the simulator.  This causes
11280 an alternate runtime library to be linked in which supports, for
11281 example, file I/O@.  You must not use this option when generating
11282 programs that will run on real hardware; you must provide your own
11283 runtime library for whatever I/O functions are needed.
11285 @item -memregs=@var{number}
11286 @opindex memregs=
11287 Specifies the number of memory-based pseudo-registers GCC will use
11288 during code generation.  These pseudo-registers will be used like real
11289 registers, so there is a tradeoff between GCC's ability to fit the
11290 code into available registers, and the performance penalty of using
11291 memory instead of registers.  Note that all modules in a program must
11292 be compiled with the same value for this option.  Because of that, you
11293 must not use this option with the default runtime libraries gcc
11294 builds.
11296 @end table
11298 @node M32R/D Options
11299 @subsection M32R/D Options
11300 @cindex M32R/D options
11302 These @option{-m} options are defined for Renesas M32R/D architectures:
11304 @table @gcctabopt
11305 @item -m32r2
11306 @opindex m32r2
11307 Generate code for the M32R/2@.
11309 @item -m32rx
11310 @opindex m32rx
11311 Generate code for the M32R/X@.
11313 @item -m32r
11314 @opindex m32r
11315 Generate code for the M32R@.  This is the default.
11317 @item -mmodel=small
11318 @opindex mmodel=small
11319 Assume all objects live in the lower 16MB of memory (so that their addresses
11320 can be loaded with the @code{ld24} instruction), and assume all subroutines
11321 are reachable with the @code{bl} instruction.
11322 This is the default.
11324 The addressability of a particular object can be set with the
11325 @code{model} attribute.
11327 @item -mmodel=medium
11328 @opindex mmodel=medium
11329 Assume objects may be anywhere in the 32-bit address space (the compiler
11330 will generate @code{seth/add3} instructions to load their addresses), and
11331 assume all subroutines are reachable with the @code{bl} instruction.
11333 @item -mmodel=large
11334 @opindex mmodel=large
11335 Assume objects may be anywhere in the 32-bit address space (the compiler
11336 will generate @code{seth/add3} instructions to load their addresses), and
11337 assume subroutines may not be reachable with the @code{bl} instruction
11338 (the compiler will generate the much slower @code{seth/add3/jl}
11339 instruction sequence).
11341 @item -msdata=none
11342 @opindex msdata=none
11343 Disable use of the small data area.  Variables will be put into
11344 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11345 @code{section} attribute has been specified).
11346 This is the default.
11348 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11349 Objects may be explicitly put in the small data area with the
11350 @code{section} attribute using one of these sections.
11352 @item -msdata=sdata
11353 @opindex msdata=sdata
11354 Put small global and static data in the small data area, but do not
11355 generate special code to reference them.
11357 @item -msdata=use
11358 @opindex msdata=use
11359 Put small global and static data in the small data area, and generate
11360 special instructions to reference them.
11362 @item -G @var{num}
11363 @opindex G
11364 @cindex smaller data references
11365 Put global and static objects less than or equal to @var{num} bytes
11366 into the small data or bss sections instead of the normal data or bss
11367 sections.  The default value of @var{num} is 8.
11368 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11369 for this option to have any effect.
11371 All modules should be compiled with the same @option{-G @var{num}} value.
11372 Compiling with different values of @var{num} may or may not work; if it
11373 doesn't the linker will give an error message---incorrect code will not be
11374 generated.
11376 @item -mdebug
11377 @opindex mdebug
11378 Makes the M32R specific code in the compiler display some statistics
11379 that might help in debugging programs.
11381 @item -malign-loops
11382 @opindex malign-loops
11383 Align all loops to a 32-byte boundary.
11385 @item -mno-align-loops
11386 @opindex mno-align-loops
11387 Do not enforce a 32-byte alignment for loops.  This is the default.
11389 @item -missue-rate=@var{number}
11390 @opindex missue-rate=@var{number}
11391 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11392 or 2.
11394 @item -mbranch-cost=@var{number}
11395 @opindex mbranch-cost=@var{number}
11396 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11397 preferred over conditional code, if it is 2, then the opposite will
11398 apply.
11400 @item -mflush-trap=@var{number}
11401 @opindex mflush-trap=@var{number}
11402 Specifies the trap number to use to flush the cache.  The default is
11403 12.  Valid numbers are between 0 and 15 inclusive.
11405 @item -mno-flush-trap
11406 @opindex mno-flush-trap
11407 Specifies that the cache cannot be flushed by using a trap.
11409 @item -mflush-func=@var{name}
11410 @opindex mflush-func=@var{name}
11411 Specifies the name of the operating system function to call to flush
11412 the cache.  The default is @emph{_flush_cache}, but a function call
11413 will only be used if a trap is not available.
11415 @item -mno-flush-func
11416 @opindex mno-flush-func
11417 Indicates that there is no OS function for flushing the cache.
11419 @end table
11421 @node M680x0 Options
11422 @subsection M680x0 Options
11423 @cindex M680x0 options
11425 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11426 The default settings depend on which architecture was selected when
11427 the compiler was configured; the defaults for the most common choices
11428 are given below.
11430 @table @gcctabopt
11431 @item -march=@var{arch}
11432 @opindex march
11433 Generate code for a specific M680x0 or ColdFire instruction set
11434 architecture.  Permissible values of @var{arch} for M680x0
11435 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11436 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11437 architectures are selected according to Freescale's ISA classification
11438 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11439 @samp{isab} and @samp{isac}.
11441 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11442 code for a ColdFire target.  The @var{arch} in this macro is one of the
11443 @option{-march} arguments given above.
11445 When used together, @option{-march} and @option{-mtune} select code
11446 that runs on a family of similar processors but that is optimized
11447 for a particular microarchitecture.
11449 @item -mcpu=@var{cpu}
11450 @opindex mcpu
11451 Generate code for a specific M680x0 or ColdFire processor.
11452 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11453 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11454 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11455 below, which also classifies the CPUs into families:
11457 @multitable @columnfractions 0.20 0.80
11458 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11459 @item @samp{51qe} @tab @samp{51qe}
11460 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11461 @item @samp{5206e} @tab @samp{5206e}
11462 @item @samp{5208} @tab @samp{5207} @samp{5208}
11463 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11464 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11465 @item @samp{5216} @tab @samp{5214} @samp{5216}
11466 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11467 @item @samp{5225} @tab @samp{5224} @samp{5225}
11468 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11469 @item @samp{5249} @tab @samp{5249}
11470 @item @samp{5250} @tab @samp{5250}
11471 @item @samp{5271} @tab @samp{5270} @samp{5271}
11472 @item @samp{5272} @tab @samp{5272}
11473 @item @samp{5275} @tab @samp{5274} @samp{5275}
11474 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11475 @item @samp{5307} @tab @samp{5307}
11476 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11477 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11478 @item @samp{5407} @tab @samp{5407}
11479 @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}
11480 @end multitable
11482 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11483 @var{arch} is compatible with @var{cpu}.  Other combinations of
11484 @option{-mcpu} and @option{-march} are rejected.
11486 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11487 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11488 where the value of @var{family} is given by the table above.
11490 @item -mtune=@var{tune}
11491 @opindex mtune
11492 Tune the code for a particular microarchitecture, within the
11493 constraints set by @option{-march} and @option{-mcpu}.
11494 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11495 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11496 and @samp{cpu32}.  The ColdFire microarchitectures
11497 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11499 You can also use @option{-mtune=68020-40} for code that needs
11500 to run relatively well on 68020, 68030 and 68040 targets.
11501 @option{-mtune=68020-60} is similar but includes 68060 targets
11502 as well.  These two options select the same tuning decisions as
11503 @option{-m68020-40} and @option{-m68020-60} respectively.
11505 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11506 when tuning for 680x0 architecture @var{arch}.  It also defines
11507 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11508 option is used.  If gcc is tuning for a range of architectures,
11509 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11510 it defines the macros for every architecture in the range.
11512 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11513 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11514 of the arguments given above.
11516 @item -m68000
11517 @itemx -mc68000
11518 @opindex m68000
11519 @opindex mc68000
11520 Generate output for a 68000.  This is the default
11521 when the compiler is configured for 68000-based systems.
11522 It is equivalent to @option{-march=68000}.
11524 Use this option for microcontrollers with a 68000 or EC000 core,
11525 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11527 @item -m68010
11528 @opindex m68010
11529 Generate output for a 68010.  This is the default
11530 when the compiler is configured for 68010-based systems.
11531 It is equivalent to @option{-march=68010}.
11533 @item -m68020
11534 @itemx -mc68020
11535 @opindex m68020
11536 @opindex mc68020
11537 Generate output for a 68020.  This is the default
11538 when the compiler is configured for 68020-based systems.
11539 It is equivalent to @option{-march=68020}.
11541 @item -m68030
11542 @opindex m68030
11543 Generate output for a 68030.  This is the default when the compiler is
11544 configured for 68030-based systems.  It is equivalent to
11545 @option{-march=68030}.
11547 @item -m68040
11548 @opindex m68040
11549 Generate output for a 68040.  This is the default when the compiler is
11550 configured for 68040-based systems.  It is equivalent to
11551 @option{-march=68040}.
11553 This option inhibits the use of 68881/68882 instructions that have to be
11554 emulated by software on the 68040.  Use this option if your 68040 does not
11555 have code to emulate those instructions.
11557 @item -m68060
11558 @opindex m68060
11559 Generate output for a 68060.  This is the default when the compiler is
11560 configured for 68060-based systems.  It is equivalent to
11561 @option{-march=68060}.
11563 This option inhibits the use of 68020 and 68881/68882 instructions that
11564 have to be emulated by software on the 68060.  Use this option if your 68060
11565 does not have code to emulate those instructions.
11567 @item -mcpu32
11568 @opindex mcpu32
11569 Generate output for a CPU32.  This is the default
11570 when the compiler is configured for CPU32-based systems.
11571 It is equivalent to @option{-march=cpu32}.
11573 Use this option for microcontrollers with a
11574 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11575 68336, 68340, 68341, 68349 and 68360.
11577 @item -m5200
11578 @opindex m5200
11579 Generate output for a 520X ColdFire CPU@.  This is the default
11580 when the compiler is configured for 520X-based systems.
11581 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11582 in favor of that option.
11584 Use this option for microcontroller with a 5200 core, including
11585 the MCF5202, MCF5203, MCF5204 and MCF5206.
11587 @item -m5206e
11588 @opindex m5206e
11589 Generate output for a 5206e ColdFire CPU@.  The option is now
11590 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11592 @item -m528x
11593 @opindex m528x
11594 Generate output for a member of the ColdFire 528X family.
11595 The option is now deprecated in favor of the equivalent
11596 @option{-mcpu=528x}.
11598 @item -m5307
11599 @opindex m5307
11600 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11601 in favor of the equivalent @option{-mcpu=5307}.
11603 @item -m5407
11604 @opindex m5407
11605 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11606 in favor of the equivalent @option{-mcpu=5407}.
11608 @item -mcfv4e
11609 @opindex mcfv4e
11610 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11611 This includes use of hardware floating point instructions.
11612 The option is equivalent to @option{-mcpu=547x}, and is now
11613 deprecated in favor of that option.
11615 @item -m68020-40
11616 @opindex m68020-40
11617 Generate output for a 68040, without using any of the new instructions.
11618 This results in code which can run relatively efficiently on either a
11619 68020/68881 or a 68030 or a 68040.  The generated code does use the
11620 68881 instructions that are emulated on the 68040.
11622 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11624 @item -m68020-60
11625 @opindex m68020-60
11626 Generate output for a 68060, without using any of the new instructions.
11627 This results in code which can run relatively efficiently on either a
11628 68020/68881 or a 68030 or a 68040.  The generated code does use the
11629 68881 instructions that are emulated on the 68060.
11631 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11633 @item -mhard-float
11634 @itemx -m68881
11635 @opindex mhard-float
11636 @opindex m68881
11637 Generate floating-point instructions.  This is the default for 68020
11638 and above, and for ColdFire devices that have an FPU@.  It defines the
11639 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11640 on ColdFire targets.
11642 @item -msoft-float
11643 @opindex msoft-float
11644 Do not generate floating-point instructions; use library calls instead.
11645 This is the default for 68000, 68010, and 68832 targets.  It is also
11646 the default for ColdFire devices that have no FPU.
11648 @item -mdiv
11649 @itemx -mno-div
11650 @opindex mdiv
11651 @opindex mno-div
11652 Generate (do not generate) ColdFire hardware divide and remainder
11653 instructions.  If @option{-march} is used without @option{-mcpu},
11654 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11655 architectures.  Otherwise, the default is taken from the target CPU
11656 (either the default CPU, or the one specified by @option{-mcpu}).  For
11657 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11658 @option{-mcpu=5206e}.
11660 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11662 @item -mshort
11663 @opindex mshort
11664 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11665 Additionally, parameters passed on the stack are also aligned to a
11666 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11668 @item -mno-short
11669 @opindex mno-short
11670 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11672 @item -mnobitfield
11673 @itemx -mno-bitfield
11674 @opindex mnobitfield
11675 @opindex mno-bitfield
11676 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11677 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11679 @item -mbitfield
11680 @opindex mbitfield
11681 Do use the bit-field instructions.  The @option{-m68020} option implies
11682 @option{-mbitfield}.  This is the default if you use a configuration
11683 designed for a 68020.
11685 @item -mrtd
11686 @opindex mrtd
11687 Use a different function-calling convention, in which functions
11688 that take a fixed number of arguments return with the @code{rtd}
11689 instruction, which pops their arguments while returning.  This
11690 saves one instruction in the caller since there is no need to pop
11691 the arguments there.
11693 This calling convention is incompatible with the one normally
11694 used on Unix, so you cannot use it if you need to call libraries
11695 compiled with the Unix compiler.
11697 Also, you must provide function prototypes for all functions that
11698 take variable numbers of arguments (including @code{printf});
11699 otherwise incorrect code will be generated for calls to those
11700 functions.
11702 In addition, seriously incorrect code will result if you call a
11703 function with too many arguments.  (Normally, extra arguments are
11704 harmlessly ignored.)
11706 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11707 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11709 @item -mno-rtd
11710 @opindex mno-rtd
11711 Do not use the calling conventions selected by @option{-mrtd}.
11712 This is the default.
11714 @item -malign-int
11715 @itemx -mno-align-int
11716 @opindex malign-int
11717 @opindex mno-align-int
11718 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11719 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11720 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11721 Aligning variables on 32-bit boundaries produces code that runs somewhat
11722 faster on processors with 32-bit busses at the expense of more memory.
11724 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11725 align structures containing the above types  differently than
11726 most published application binary interface specifications for the m68k.
11728 @item -mpcrel
11729 @opindex mpcrel
11730 Use the pc-relative addressing mode of the 68000 directly, instead of
11731 using a global offset table.  At present, this option implies @option{-fpic},
11732 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11733 not presently supported with @option{-mpcrel}, though this could be supported for
11734 68020 and higher processors.
11736 @item -mno-strict-align
11737 @itemx -mstrict-align
11738 @opindex mno-strict-align
11739 @opindex mstrict-align
11740 Do not (do) assume that unaligned memory references will be handled by
11741 the system.
11743 @item -msep-data
11744 Generate code that allows the data segment to be located in a different
11745 area of memory from the text segment.  This allows for execute in place in
11746 an environment without virtual memory management.  This option implies
11747 @option{-fPIC}.
11749 @item -mno-sep-data
11750 Generate code that assumes that the data segment follows the text segment.
11751 This is the default.
11753 @item -mid-shared-library
11754 Generate code that supports shared libraries via the library ID method.
11755 This allows for execute in place and shared libraries in an environment
11756 without virtual memory management.  This option implies @option{-fPIC}.
11758 @item -mno-id-shared-library
11759 Generate code that doesn't assume ID based shared libraries are being used.
11760 This is the default.
11762 @item -mshared-library-id=n
11763 Specified the identification number of the ID based shared library being
11764 compiled.  Specifying a value of 0 will generate more compact code, specifying
11765 other values will force the allocation of that number to the current
11766 library but is no more space or time efficient than omitting this option.
11768 @item -mxgot
11769 @itemx -mno-xgot
11770 @opindex mxgot
11771 @opindex mno-xgot
11772 When generating position-independent code for ColdFire, generate code
11773 that works if the GOT has more than 8192 entries.  This code is
11774 larger and slower than code generated without this option.  On M680x0
11775 processors, this option is not needed; @option{-fPIC} suffices.
11777 GCC normally uses a single instruction to load values from the GOT@.
11778 While this is relatively efficient, it only works if the GOT
11779 is smaller than about 64k.  Anything larger causes the linker
11780 to report an error such as:
11782 @cindex relocation truncated to fit (ColdFire)
11783 @smallexample
11784 relocation truncated to fit: R_68K_GOT16O foobar
11785 @end smallexample
11787 If this happens, you should recompile your code with @option{-mxgot}.
11788 It should then work with very large GOTs.  However, code generated with
11789 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
11790 the value of a global symbol.
11792 Note that some linkers, including newer versions of the GNU linker,
11793 can create multiple GOTs and sort GOT entries.  If you have such a linker,
11794 you should only need to use @option{-mxgot} when compiling a single
11795 object file that accesses more than 8192 GOT entries.  Very few do.
11797 These options have no effect unless GCC is generating
11798 position-independent code.
11800 @end table
11802 @node M68hc1x Options
11803 @subsection M68hc1x Options
11804 @cindex M68hc1x options
11806 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11807 microcontrollers.  The default values for these options depends on
11808 which style of microcontroller was selected when the compiler was configured;
11809 the defaults for the most common choices are given below.
11811 @table @gcctabopt
11812 @item -m6811
11813 @itemx -m68hc11
11814 @opindex m6811
11815 @opindex m68hc11
11816 Generate output for a 68HC11.  This is the default
11817 when the compiler is configured for 68HC11-based systems.
11819 @item -m6812
11820 @itemx -m68hc12
11821 @opindex m6812
11822 @opindex m68hc12
11823 Generate output for a 68HC12.  This is the default
11824 when the compiler is configured for 68HC12-based systems.
11826 @item -m68S12
11827 @itemx -m68hcs12
11828 @opindex m68S12
11829 @opindex m68hcs12
11830 Generate output for a 68HCS12.
11832 @item -mauto-incdec
11833 @opindex mauto-incdec
11834 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11835 addressing modes.
11837 @item -minmax
11838 @itemx -nominmax
11839 @opindex minmax
11840 @opindex mnominmax
11841 Enable the use of 68HC12 min and max instructions.
11843 @item -mlong-calls
11844 @itemx -mno-long-calls
11845 @opindex mlong-calls
11846 @opindex mno-long-calls
11847 Treat all calls as being far away (near).  If calls are assumed to be
11848 far away, the compiler will use the @code{call} instruction to
11849 call a function and the @code{rtc} instruction for returning.
11851 @item -mshort
11852 @opindex mshort
11853 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11855 @item -msoft-reg-count=@var{count}
11856 @opindex msoft-reg-count
11857 Specify the number of pseudo-soft registers which are used for the
11858 code generation.  The maximum number is 32.  Using more pseudo-soft
11859 register may or may not result in better code depending on the program.
11860 The default is 4 for 68HC11 and 2 for 68HC12.
11862 @end table
11864 @node MCore Options
11865 @subsection MCore Options
11866 @cindex MCore options
11868 These are the @samp{-m} options defined for the Motorola M*Core
11869 processors.
11871 @table @gcctabopt
11873 @item -mhardlit
11874 @itemx -mno-hardlit
11875 @opindex mhardlit
11876 @opindex mno-hardlit
11877 Inline constants into the code stream if it can be done in two
11878 instructions or less.
11880 @item -mdiv
11881 @itemx -mno-div
11882 @opindex mdiv
11883 @opindex mno-div
11884 Use the divide instruction.  (Enabled by default).
11886 @item -mrelax-immediate
11887 @itemx -mno-relax-immediate
11888 @opindex mrelax-immediate
11889 @opindex mno-relax-immediate
11890 Allow arbitrary sized immediates in bit operations.
11892 @item -mwide-bitfields
11893 @itemx -mno-wide-bitfields
11894 @opindex mwide-bitfields
11895 @opindex mno-wide-bitfields
11896 Always treat bit-fields as int-sized.
11898 @item -m4byte-functions
11899 @itemx -mno-4byte-functions
11900 @opindex m4byte-functions
11901 @opindex mno-4byte-functions
11902 Force all functions to be aligned to a four byte boundary.
11904 @item -mcallgraph-data
11905 @itemx -mno-callgraph-data
11906 @opindex mcallgraph-data
11907 @opindex mno-callgraph-data
11908 Emit callgraph information.
11910 @item -mslow-bytes
11911 @itemx -mno-slow-bytes
11912 @opindex mslow-bytes
11913 @opindex mno-slow-bytes
11914 Prefer word access when reading byte quantities.
11916 @item -mlittle-endian
11917 @itemx -mbig-endian
11918 @opindex mlittle-endian
11919 @opindex mbig-endian
11920 Generate code for a little endian target.
11922 @item -m210
11923 @itemx -m340
11924 @opindex m210
11925 @opindex m340
11926 Generate code for the 210 processor.
11927 @end table
11929 @node MIPS Options
11930 @subsection MIPS Options
11931 @cindex MIPS options
11933 @table @gcctabopt
11935 @item -EB
11936 @opindex EB
11937 Generate big-endian code.
11939 @item -EL
11940 @opindex EL
11941 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11942 configurations.
11944 @item -march=@var{arch}
11945 @opindex march
11946 Generate code that will run on @var{arch}, which can be the name of a
11947 generic MIPS ISA, or the name of a particular processor.
11948 The ISA names are:
11949 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11950 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11951 The processor names are:
11952 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11953 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11954 @samp{5kc}, @samp{5kf},
11955 @samp{20kc},
11956 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11957 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11958 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11959 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11960 @samp{loongson2e}, @samp{loongson2f},
11961 @samp{m4k},
11962 @samp{orion},
11963 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11964 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11965 @samp{rm7000}, @samp{rm9000},
11966 @samp{sb1},
11967 @samp{sr71000},
11968 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11969 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
11970 and @samp{xlr}.
11971 The special value @samp{from-abi} selects the
11972 most compatible architecture for the selected ABI (that is,
11973 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11975 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11976 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11977 @samp{vr} may be written @samp{r}.
11979 Names of the form @samp{@var{n}f2_1} refer to processors with
11980 FPUs clocked at half the rate of the core, names of the form
11981 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11982 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11983 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11984 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11985 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11986 accepted as synonyms for @samp{@var{n}f1_1}.
11988 GCC defines two macros based on the value of this option.  The first
11989 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11990 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11991 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11992 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11993 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11995 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11996 above.  In other words, it will have the full prefix and will not
11997 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11998 the macro names the resolved architecture (either @samp{"mips1"} or
11999 @samp{"mips3"}).  It names the default architecture when no
12000 @option{-march} option is given.
12002 @item -mtune=@var{arch}
12003 @opindex mtune
12004 Optimize for @var{arch}.  Among other things, this option controls
12005 the way instructions are scheduled, and the perceived cost of arithmetic
12006 operations.  The list of @var{arch} values is the same as for
12007 @option{-march}.
12009 When this option is not used, GCC will optimize for the processor
12010 specified by @option{-march}.  By using @option{-march} and
12011 @option{-mtune} together, it is possible to generate code that will
12012 run on a family of processors, but optimize the code for one
12013 particular member of that family.
12015 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
12016 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
12017 @samp{-march} ones described above.
12019 @item -mips1
12020 @opindex mips1
12021 Equivalent to @samp{-march=mips1}.
12023 @item -mips2
12024 @opindex mips2
12025 Equivalent to @samp{-march=mips2}.
12027 @item -mips3
12028 @opindex mips3
12029 Equivalent to @samp{-march=mips3}.
12031 @item -mips4
12032 @opindex mips4
12033 Equivalent to @samp{-march=mips4}.
12035 @item -mips32
12036 @opindex mips32
12037 Equivalent to @samp{-march=mips32}.
12039 @item -mips32r2
12040 @opindex mips32r2
12041 Equivalent to @samp{-march=mips32r2}.
12043 @item -mips64
12044 @opindex mips64
12045 Equivalent to @samp{-march=mips64}.
12047 @item -mips16
12048 @itemx -mno-mips16
12049 @opindex mips16
12050 @opindex mno-mips16
12051 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12052 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12054 MIPS16 code generation can also be controlled on a per-function basis
12055 by means of @code{mips16} and @code{nomips16} attributes.  
12056 @xref{Function Attributes}, for more information.
12058 @item -mflip-mips16
12059 @opindex mflip-mips16
12060 Generate MIPS16 code on alternating functions.  This option is provided
12061 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12062 not intended for ordinary use in compiling user code.
12064 @item -minterlink-mips16
12065 @itemx -mno-interlink-mips16
12066 @opindex minterlink-mips16
12067 @opindex mno-interlink-mips16
12068 Require (do not require) that non-MIPS16 code be link-compatible with
12069 MIPS16 code.
12071 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12072 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12073 therefore disables direct jumps unless GCC knows that the target of the
12074 jump is not MIPS16.
12076 @item -mabi=32
12077 @itemx -mabi=o64
12078 @itemx -mabi=n32
12079 @itemx -mabi=64
12080 @itemx -mabi=eabi
12081 @opindex mabi=32
12082 @opindex mabi=o64
12083 @opindex mabi=n32
12084 @opindex mabi=64
12085 @opindex mabi=eabi
12086 Generate code for the given ABI@.
12088 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12089 generates 64-bit code when you select a 64-bit architecture, but you
12090 can use @option{-mgp32} to get 32-bit code instead.
12092 For information about the O64 ABI, see
12093 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12095 GCC supports a variant of the o32 ABI in which floating-point registers
12096 are 64 rather than 32 bits wide.  You can select this combination with
12097 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12098 and @samp{mfhc1} instructions and is therefore only supported for
12099 MIPS32R2 processors.
12101 The register assignments for arguments and return values remain the
12102 same, but each scalar value is passed in a single 64-bit register
12103 rather than a pair of 32-bit registers.  For example, scalar
12104 floating-point values are returned in @samp{$f0} only, not a
12105 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12106 remains the same, but all 64 bits are saved.
12108 @item -mabicalls
12109 @itemx -mno-abicalls
12110 @opindex mabicalls
12111 @opindex mno-abicalls
12112 Generate (do not generate) code that is suitable for SVR4-style
12113 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12114 systems.
12116 @item -mshared
12117 @itemx -mno-shared
12118 Generate (do not generate) code that is fully position-independent,
12119 and that can therefore be linked into shared libraries.  This option
12120 only affects @option{-mabicalls}.
12122 All @option{-mabicalls} code has traditionally been position-independent,
12123 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12124 as an extension, the GNU toolchain allows executables to use absolute
12125 accesses for locally-binding symbols.  It can also use shorter GP
12126 initialization sequences and generate direct calls to locally-defined
12127 functions.  This mode is selected by @option{-mno-shared}.
12129 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12130 objects that can only be linked by the GNU linker.  However, the option
12131 does not affect the ABI of the final executable; it only affects the ABI
12132 of relocatable objects.  Using @option{-mno-shared} will generally make
12133 executables both smaller and quicker.
12135 @option{-mshared} is the default.
12137 @item -mxgot
12138 @itemx -mno-xgot
12139 @opindex mxgot
12140 @opindex mno-xgot
12141 Lift (do not lift) the usual restrictions on the size of the global
12142 offset table.
12144 GCC normally uses a single instruction to load values from the GOT@.
12145 While this is relatively efficient, it will only work if the GOT
12146 is smaller than about 64k.  Anything larger will cause the linker
12147 to report an error such as:
12149 @cindex relocation truncated to fit (MIPS)
12150 @smallexample
12151 relocation truncated to fit: R_MIPS_GOT16 foobar
12152 @end smallexample
12154 If this happens, you should recompile your code with @option{-mxgot}.
12155 It should then work with very large GOTs, although it will also be
12156 less efficient, since it will take three instructions to fetch the
12157 value of a global symbol.
12159 Note that some linkers can create multiple GOTs.  If you have such a
12160 linker, you should only need to use @option{-mxgot} when a single object
12161 file accesses more than 64k's worth of GOT entries.  Very few do.
12163 These options have no effect unless GCC is generating position
12164 independent code.
12166 @item -mgp32
12167 @opindex mgp32
12168 Assume that general-purpose registers are 32 bits wide.
12170 @item -mgp64
12171 @opindex mgp64
12172 Assume that general-purpose registers are 64 bits wide.
12174 @item -mfp32
12175 @opindex mfp32
12176 Assume that floating-point registers are 32 bits wide.
12178 @item -mfp64
12179 @opindex mfp64
12180 Assume that floating-point registers are 64 bits wide.
12182 @item -mhard-float
12183 @opindex mhard-float
12184 Use floating-point coprocessor instructions.
12186 @item -msoft-float
12187 @opindex msoft-float
12188 Do not use floating-point coprocessor instructions.  Implement
12189 floating-point calculations using library calls instead.
12191 @item -msingle-float
12192 @opindex msingle-float
12193 Assume that the floating-point coprocessor only supports single-precision
12194 operations.
12196 @item -mdouble-float
12197 @opindex mdouble-float
12198 Assume that the floating-point coprocessor supports double-precision
12199 operations.  This is the default.
12201 @item -mllsc
12202 @itemx -mno-llsc
12203 @opindex mllsc
12204 @opindex mno-llsc
12205 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12206 implement atomic memory built-in functions.  When neither option is
12207 specified, GCC will use the instructions if the target architecture
12208 supports them.
12210 @option{-mllsc} is useful if the runtime environment can emulate the
12211 instructions and @option{-mno-llsc} can be useful when compiling for
12212 nonstandard ISAs.  You can make either option the default by
12213 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12214 respectively.  @option{--with-llsc} is the default for some
12215 configurations; see the installation documentation for details.
12217 @item -mdsp
12218 @itemx -mno-dsp
12219 @opindex mdsp
12220 @opindex mno-dsp
12221 Use (do not use) revision 1 of the MIPS DSP ASE@.
12222 @xref{MIPS DSP Built-in Functions}.  This option defines the
12223 preprocessor macro @samp{__mips_dsp}.  It also defines
12224 @samp{__mips_dsp_rev} to 1.
12226 @item -mdspr2
12227 @itemx -mno-dspr2
12228 @opindex mdspr2
12229 @opindex mno-dspr2
12230 Use (do not use) revision 2 of the MIPS DSP ASE@.
12231 @xref{MIPS DSP Built-in Functions}.  This option defines the
12232 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12233 It also defines @samp{__mips_dsp_rev} to 2.
12235 @item -msmartmips
12236 @itemx -mno-smartmips
12237 @opindex msmartmips
12238 @opindex mno-smartmips
12239 Use (do not use) the MIPS SmartMIPS ASE.
12241 @item -mpaired-single
12242 @itemx -mno-paired-single
12243 @opindex mpaired-single
12244 @opindex mno-paired-single
12245 Use (do not use) paired-single floating-point instructions.
12246 @xref{MIPS Paired-Single Support}.  This option requires
12247 hardware floating-point support to be enabled.
12249 @item -mdmx
12250 @itemx -mno-mdmx
12251 @opindex mdmx
12252 @opindex mno-mdmx
12253 Use (do not use) MIPS Digital Media Extension instructions.
12254 This option can only be used when generating 64-bit code and requires
12255 hardware floating-point support to be enabled.
12257 @item -mips3d
12258 @itemx -mno-mips3d
12259 @opindex mips3d
12260 @opindex mno-mips3d
12261 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12262 The option @option{-mips3d} implies @option{-mpaired-single}.
12264 @item -mmt
12265 @itemx -mno-mt
12266 @opindex mmt
12267 @opindex mno-mt
12268 Use (do not use) MT Multithreading instructions.
12270 @item -mlong64
12271 @opindex mlong64
12272 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12273 an explanation of the default and the way that the pointer size is
12274 determined.
12276 @item -mlong32
12277 @opindex mlong32
12278 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12280 The default size of @code{int}s, @code{long}s and pointers depends on
12281 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12282 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12283 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12284 or the same size as integer registers, whichever is smaller.
12286 @item -msym32
12287 @itemx -mno-sym32
12288 @opindex msym32
12289 @opindex mno-sym32
12290 Assume (do not assume) that all symbols have 32-bit values, regardless
12291 of the selected ABI@.  This option is useful in combination with
12292 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12293 to generate shorter and faster references to symbolic addresses.
12295 @item -G @var{num}
12296 @opindex G
12297 Put definitions of externally-visible data in a small data section
12298 if that data is no bigger than @var{num} bytes.  GCC can then access
12299 the data more efficiently; see @option{-mgpopt} for details.
12301 The default @option{-G} option depends on the configuration.
12303 @item -mlocal-sdata
12304 @itemx -mno-local-sdata
12305 @opindex mlocal-sdata
12306 @opindex mno-local-sdata
12307 Extend (do not extend) the @option{-G} behavior to local data too,
12308 such as to static variables in C@.  @option{-mlocal-sdata} is the
12309 default for all configurations.
12311 If the linker complains that an application is using too much small data,
12312 you might want to try rebuilding the less performance-critical parts with
12313 @option{-mno-local-sdata}.  You might also want to build large
12314 libraries with @option{-mno-local-sdata}, so that the libraries leave
12315 more room for the main program.
12317 @item -mextern-sdata
12318 @itemx -mno-extern-sdata
12319 @opindex mextern-sdata
12320 @opindex mno-extern-sdata
12321 Assume (do not assume) that externally-defined data will be in
12322 a small data section if that data is within the @option{-G} limit.
12323 @option{-mextern-sdata} is the default for all configurations.
12325 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12326 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12327 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12328 is placed in a small data section.  If @var{Var} is defined by another
12329 module, you must either compile that module with a high-enough
12330 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12331 definition.  If @var{Var} is common, you must link the application
12332 with a high-enough @option{-G} setting.
12334 The easiest way of satisfying these restrictions is to compile
12335 and link every module with the same @option{-G} option.  However,
12336 you may wish to build a library that supports several different
12337 small data limits.  You can do this by compiling the library with
12338 the highest supported @option{-G} setting and additionally using
12339 @option{-mno-extern-sdata} to stop the library from making assumptions
12340 about externally-defined data.
12342 @item -mgpopt
12343 @itemx -mno-gpopt
12344 @opindex mgpopt
12345 @opindex mno-gpopt
12346 Use (do not use) GP-relative accesses for symbols that are known to be
12347 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12348 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12349 configurations.
12351 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12352 might not hold the value of @code{_gp}.  For example, if the code is
12353 part of a library that might be used in a boot monitor, programs that
12354 call boot monitor routines will pass an unknown value in @code{$gp}.
12355 (In such situations, the boot monitor itself would usually be compiled
12356 with @option{-G0}.)
12358 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12359 @option{-mno-extern-sdata}.
12361 @item -membedded-data
12362 @itemx -mno-embedded-data
12363 @opindex membedded-data
12364 @opindex mno-embedded-data
12365 Allocate variables to the read-only data section first if possible, then
12366 next in the small data section if possible, otherwise in data.  This gives
12367 slightly slower code than the default, but reduces the amount of RAM required
12368 when executing, and thus may be preferred for some embedded systems.
12370 @item -muninit-const-in-rodata
12371 @itemx -mno-uninit-const-in-rodata
12372 @opindex muninit-const-in-rodata
12373 @opindex mno-uninit-const-in-rodata
12374 Put uninitialized @code{const} variables in the read-only data section.
12375 This option is only meaningful in conjunction with @option{-membedded-data}.
12377 @item -mcode-readable=@var{setting}
12378 @opindex mcode-readable
12379 Specify whether GCC may generate code that reads from executable sections.
12380 There are three possible settings:
12382 @table @gcctabopt
12383 @item -mcode-readable=yes
12384 Instructions may freely access executable sections.  This is the
12385 default setting.
12387 @item -mcode-readable=pcrel
12388 MIPS16 PC-relative load instructions can access executable sections,
12389 but other instructions must not do so.  This option is useful on 4KSc
12390 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12391 It is also useful on processors that can be configured to have a dual
12392 instruction/data SRAM interface and that, like the M4K, automatically
12393 redirect PC-relative loads to the instruction RAM.
12395 @item -mcode-readable=no
12396 Instructions must not access executable sections.  This option can be
12397 useful on targets that are configured to have a dual instruction/data
12398 SRAM interface but that (unlike the M4K) do not automatically redirect
12399 PC-relative loads to the instruction RAM.
12400 @end table
12402 @item -msplit-addresses
12403 @itemx -mno-split-addresses
12404 @opindex msplit-addresses
12405 @opindex mno-split-addresses
12406 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12407 relocation operators.  This option has been superseded by
12408 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12410 @item -mexplicit-relocs
12411 @itemx -mno-explicit-relocs
12412 @opindex mexplicit-relocs
12413 @opindex mno-explicit-relocs
12414 Use (do not use) assembler relocation operators when dealing with symbolic
12415 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12416 is to use assembler macros instead.
12418 @option{-mexplicit-relocs} is the default if GCC was configured
12419 to use an assembler that supports relocation operators.
12421 @item -mcheck-zero-division
12422 @itemx -mno-check-zero-division
12423 @opindex mcheck-zero-division
12424 @opindex mno-check-zero-division
12425 Trap (do not trap) on integer division by zero.
12427 The default is @option{-mcheck-zero-division}.
12429 @item -mdivide-traps
12430 @itemx -mdivide-breaks
12431 @opindex mdivide-traps
12432 @opindex mdivide-breaks
12433 MIPS systems check for division by zero by generating either a
12434 conditional trap or a break instruction.  Using traps results in
12435 smaller code, but is only supported on MIPS II and later.  Also, some
12436 versions of the Linux kernel have a bug that prevents trap from
12437 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12438 allow conditional traps on architectures that support them and
12439 @option{-mdivide-breaks} to force the use of breaks.
12441 The default is usually @option{-mdivide-traps}, but this can be
12442 overridden at configure time using @option{--with-divide=breaks}.
12443 Divide-by-zero checks can be completely disabled using
12444 @option{-mno-check-zero-division}.
12446 @item -mmemcpy
12447 @itemx -mno-memcpy
12448 @opindex mmemcpy
12449 @opindex mno-memcpy
12450 Force (do not force) the use of @code{memcpy()} for non-trivial block
12451 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12452 most constant-sized copies.
12454 @item -mlong-calls
12455 @itemx -mno-long-calls
12456 @opindex mlong-calls
12457 @opindex mno-long-calls
12458 Disable (do not disable) use of the @code{jal} instruction.  Calling
12459 functions using @code{jal} is more efficient but requires the caller
12460 and callee to be in the same 256 megabyte segment.
12462 This option has no effect on abicalls code.  The default is
12463 @option{-mno-long-calls}.
12465 @item -mmad
12466 @itemx -mno-mad
12467 @opindex mmad
12468 @opindex mno-mad
12469 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12470 instructions, as provided by the R4650 ISA@.
12472 @item -mfused-madd
12473 @itemx -mno-fused-madd
12474 @opindex mfused-madd
12475 @opindex mno-fused-madd
12476 Enable (disable) use of the floating point multiply-accumulate
12477 instructions, when they are available.  The default is
12478 @option{-mfused-madd}.
12480 When multiply-accumulate instructions are used, the intermediate
12481 product is calculated to infinite precision and is not subject to
12482 the FCSR Flush to Zero bit.  This may be undesirable in some
12483 circumstances.
12485 @item -nocpp
12486 @opindex nocpp
12487 Tell the MIPS assembler to not run its preprocessor over user
12488 assembler files (with a @samp{.s} suffix) when assembling them.
12490 @item -mfix-r4000
12491 @itemx -mno-fix-r4000
12492 @opindex mfix-r4000
12493 @opindex mno-fix-r4000
12494 Work around certain R4000 CPU errata:
12495 @itemize @minus
12496 @item
12497 A double-word or a variable shift may give an incorrect result if executed
12498 immediately after starting an integer division.
12499 @item
12500 A double-word or a variable shift may give an incorrect result if executed
12501 while an integer multiplication is in progress.
12502 @item
12503 An integer division may give an incorrect result if started in a delay slot
12504 of a taken branch or a jump.
12505 @end itemize
12507 @item -mfix-r4400
12508 @itemx -mno-fix-r4400
12509 @opindex mfix-r4400
12510 @opindex mno-fix-r4400
12511 Work around certain R4400 CPU errata:
12512 @itemize @minus
12513 @item
12514 A double-word or a variable shift may give an incorrect result if executed
12515 immediately after starting an integer division.
12516 @end itemize
12518 @item -mfix-vr4120
12519 @itemx -mno-fix-vr4120
12520 @opindex mfix-vr4120
12521 Work around certain VR4120 errata:
12522 @itemize @minus
12523 @item
12524 @code{dmultu} does not always produce the correct result.
12525 @item
12526 @code{div} and @code{ddiv} do not always produce the correct result if one
12527 of the operands is negative.
12528 @end itemize
12529 The workarounds for the division errata rely on special functions in
12530 @file{libgcc.a}.  At present, these functions are only provided by
12531 the @code{mips64vr*-elf} configurations.
12533 Other VR4120 errata require a nop to be inserted between certain pairs of
12534 instructions.  These errata are handled by the assembler, not by GCC itself.
12536 @item -mfix-vr4130
12537 @opindex mfix-vr4130
12538 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12539 workarounds are implemented by the assembler rather than by GCC,
12540 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12541 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12542 instructions are available instead.
12544 @item -mfix-sb1
12545 @itemx -mno-fix-sb1
12546 @opindex mfix-sb1
12547 Work around certain SB-1 CPU core errata.
12548 (This flag currently works around the SB-1 revision 2
12549 ``F1'' and ``F2'' floating point errata.)
12551 @item -mflush-func=@var{func}
12552 @itemx -mno-flush-func
12553 @opindex mflush-func
12554 Specifies the function to call to flush the I and D caches, or to not
12555 call any such function.  If called, the function must take the same
12556 arguments as the common @code{_flush_func()}, that is, the address of the
12557 memory range for which the cache is being flushed, the size of the
12558 memory range, and the number 3 (to flush both caches).  The default
12559 depends on the target GCC was configured for, but commonly is either
12560 @samp{_flush_func} or @samp{__cpu_flush}.
12562 @item mbranch-cost=@var{num}
12563 @opindex mbranch-cost
12564 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12565 This cost is only a heuristic and is not guaranteed to produce
12566 consistent results across releases.  A zero cost redundantly selects
12567 the default, which is based on the @option{-mtune} setting.
12569 @item -mbranch-likely
12570 @itemx -mno-branch-likely
12571 @opindex mbranch-likely
12572 @opindex mno-branch-likely
12573 Enable or disable use of Branch Likely instructions, regardless of the
12574 default for the selected architecture.  By default, Branch Likely
12575 instructions may be generated if they are supported by the selected
12576 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12577 and processors which implement those architectures; for those, Branch
12578 Likely instructions will not be generated by default because the MIPS32
12579 and MIPS64 architectures specifically deprecate their use.
12581 @item -mfp-exceptions
12582 @itemx -mno-fp-exceptions
12583 @opindex mfp-exceptions
12584 Specifies whether FP exceptions are enabled.  This affects how we schedule
12585 FP instructions for some processors.  The default is that FP exceptions are
12586 enabled.
12588 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12589 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12590 FP pipe.
12592 @item -mvr4130-align
12593 @itemx -mno-vr4130-align
12594 @opindex mvr4130-align
12595 The VR4130 pipeline is two-way superscalar, but can only issue two
12596 instructions together if the first one is 8-byte aligned.  When this
12597 option is enabled, GCC will align pairs of instructions that it
12598 thinks should execute in parallel.
12600 This option only has an effect when optimizing for the VR4130.
12601 It normally makes code faster, but at the expense of making it bigger.
12602 It is enabled by default at optimization level @option{-O3}.
12603 @end table
12605 @node MMIX Options
12606 @subsection MMIX Options
12607 @cindex MMIX Options
12609 These options are defined for the MMIX:
12611 @table @gcctabopt
12612 @item -mlibfuncs
12613 @itemx -mno-libfuncs
12614 @opindex mlibfuncs
12615 @opindex mno-libfuncs
12616 Specify that intrinsic library functions are being compiled, passing all
12617 values in registers, no matter the size.
12619 @item -mepsilon
12620 @itemx -mno-epsilon
12621 @opindex mepsilon
12622 @opindex mno-epsilon
12623 Generate floating-point comparison instructions that compare with respect
12624 to the @code{rE} epsilon register.
12626 @item -mabi=mmixware
12627 @itemx -mabi=gnu
12628 @opindex mabi-mmixware
12629 @opindex mabi=gnu
12630 Generate code that passes function parameters and return values that (in
12631 the called function) are seen as registers @code{$0} and up, as opposed to
12632 the GNU ABI which uses global registers @code{$231} and up.
12634 @item -mzero-extend
12635 @itemx -mno-zero-extend
12636 @opindex mzero-extend
12637 @opindex mno-zero-extend
12638 When reading data from memory in sizes shorter than 64 bits, use (do not
12639 use) zero-extending load instructions by default, rather than
12640 sign-extending ones.
12642 @item -mknuthdiv
12643 @itemx -mno-knuthdiv
12644 @opindex mknuthdiv
12645 @opindex mno-knuthdiv
12646 Make the result of a division yielding a remainder have the same sign as
12647 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12648 remainder follows the sign of the dividend.  Both methods are
12649 arithmetically valid, the latter being almost exclusively used.
12651 @item -mtoplevel-symbols
12652 @itemx -mno-toplevel-symbols
12653 @opindex mtoplevel-symbols
12654 @opindex mno-toplevel-symbols
12655 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12656 code can be used with the @code{PREFIX} assembly directive.
12658 @item -melf
12659 @opindex melf
12660 Generate an executable in the ELF format, rather than the default
12661 @samp{mmo} format used by the @command{mmix} simulator.
12663 @item -mbranch-predict
12664 @itemx -mno-branch-predict
12665 @opindex mbranch-predict
12666 @opindex mno-branch-predict
12667 Use (do not use) the probable-branch instructions, when static branch
12668 prediction indicates a probable branch.
12670 @item -mbase-addresses
12671 @itemx -mno-base-addresses
12672 @opindex mbase-addresses
12673 @opindex mno-base-addresses
12674 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12675 base address automatically generates a request (handled by the assembler
12676 and the linker) for a constant to be set up in a global register.  The
12677 register is used for one or more base address requests within the range 0
12678 to 255 from the value held in the register.  The generally leads to short
12679 and fast code, but the number of different data items that can be
12680 addressed is limited.  This means that a program that uses lots of static
12681 data may require @option{-mno-base-addresses}.
12683 @item -msingle-exit
12684 @itemx -mno-single-exit
12685 @opindex msingle-exit
12686 @opindex mno-single-exit
12687 Force (do not force) generated code to have a single exit point in each
12688 function.
12689 @end table
12691 @node MN10300 Options
12692 @subsection MN10300 Options
12693 @cindex MN10300 options
12695 These @option{-m} options are defined for Matsushita MN10300 architectures:
12697 @table @gcctabopt
12698 @item -mmult-bug
12699 @opindex mmult-bug
12700 Generate code to avoid bugs in the multiply instructions for the MN10300
12701 processors.  This is the default.
12703 @item -mno-mult-bug
12704 @opindex mno-mult-bug
12705 Do not generate code to avoid bugs in the multiply instructions for the
12706 MN10300 processors.
12708 @item -mam33
12709 @opindex mam33
12710 Generate code which uses features specific to the AM33 processor.
12712 @item -mno-am33
12713 @opindex mno-am33
12714 Do not generate code which uses features specific to the AM33 processor.  This
12715 is the default.
12717 @item -mreturn-pointer-on-d0
12718 @opindex mreturn-pointer-on-d0
12719 When generating a function which returns a pointer, return the pointer
12720 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12721 only in a0, and attempts to call such functions without a prototype
12722 would result in errors.  Note that this option is on by default; use
12723 @option{-mno-return-pointer-on-d0} to disable it.
12725 @item -mno-crt0
12726 @opindex mno-crt0
12727 Do not link in the C run-time initialization object file.
12729 @item -mrelax
12730 @opindex mrelax
12731 Indicate to the linker that it should perform a relaxation optimization pass
12732 to shorten branches, calls and absolute memory addresses.  This option only
12733 has an effect when used on the command line for the final link step.
12735 This option makes symbolic debugging impossible.
12736 @end table
12738 @node PDP-11 Options
12739 @subsection PDP-11 Options
12740 @cindex PDP-11 Options
12742 These options are defined for the PDP-11:
12744 @table @gcctabopt
12745 @item -mfpu
12746 @opindex mfpu
12747 Use hardware FPP floating point.  This is the default.  (FIS floating
12748 point on the PDP-11/40 is not supported.)
12750 @item -msoft-float
12751 @opindex msoft-float
12752 Do not use hardware floating point.
12754 @item -mac0
12755 @opindex mac0
12756 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12758 @item -mno-ac0
12759 @opindex mno-ac0
12760 Return floating-point results in memory.  This is the default.
12762 @item -m40
12763 @opindex m40
12764 Generate code for a PDP-11/40.
12766 @item -m45
12767 @opindex m45
12768 Generate code for a PDP-11/45.  This is the default.
12770 @item -m10
12771 @opindex m10
12772 Generate code for a PDP-11/10.
12774 @item -mbcopy-builtin
12775 @opindex bcopy-builtin
12776 Use inline @code{movmemhi} patterns for copying memory.  This is the
12777 default.
12779 @item -mbcopy
12780 @opindex mbcopy
12781 Do not use inline @code{movmemhi} patterns for copying memory.
12783 @item -mint16
12784 @itemx -mno-int32
12785 @opindex mint16
12786 @opindex mno-int32
12787 Use 16-bit @code{int}.  This is the default.
12789 @item -mint32
12790 @itemx -mno-int16
12791 @opindex mint32
12792 @opindex mno-int16
12793 Use 32-bit @code{int}.
12795 @item -mfloat64
12796 @itemx -mno-float32
12797 @opindex mfloat64
12798 @opindex mno-float32
12799 Use 64-bit @code{float}.  This is the default.
12801 @item -mfloat32
12802 @itemx -mno-float64
12803 @opindex mfloat32
12804 @opindex mno-float64
12805 Use 32-bit @code{float}.
12807 @item -mabshi
12808 @opindex mabshi
12809 Use @code{abshi2} pattern.  This is the default.
12811 @item -mno-abshi
12812 @opindex mno-abshi
12813 Do not use @code{abshi2} pattern.
12815 @item -mbranch-expensive
12816 @opindex mbranch-expensive
12817 Pretend that branches are expensive.  This is for experimenting with
12818 code generation only.
12820 @item -mbranch-cheap
12821 @opindex mbranch-cheap
12822 Do not pretend that branches are expensive.  This is the default.
12824 @item -msplit
12825 @opindex msplit
12826 Generate code for a system with split I&D@.
12828 @item -mno-split
12829 @opindex mno-split
12830 Generate code for a system without split I&D@.  This is the default.
12832 @item -munix-asm
12833 @opindex munix-asm
12834 Use Unix assembler syntax.  This is the default when configured for
12835 @samp{pdp11-*-bsd}.
12837 @item -mdec-asm
12838 @opindex mdec-asm
12839 Use DEC assembler syntax.  This is the default when configured for any
12840 PDP-11 target other than @samp{pdp11-*-bsd}.
12841 @end table
12843 @node PowerPC Options
12844 @subsection PowerPC Options
12845 @cindex PowerPC options
12847 These are listed under @xref{RS/6000 and PowerPC Options}.
12849 @node RS/6000 and PowerPC Options
12850 @subsection IBM RS/6000 and PowerPC Options
12851 @cindex RS/6000 and PowerPC Options
12852 @cindex IBM RS/6000 and PowerPC Options
12854 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12855 @table @gcctabopt
12856 @item -mpower
12857 @itemx -mno-power
12858 @itemx -mpower2
12859 @itemx -mno-power2
12860 @itemx -mpowerpc
12861 @itemx -mno-powerpc
12862 @itemx -mpowerpc-gpopt
12863 @itemx -mno-powerpc-gpopt
12864 @itemx -mpowerpc-gfxopt
12865 @itemx -mno-powerpc-gfxopt
12866 @itemx -mpowerpc64
12867 @itemx -mno-powerpc64
12868 @itemx -mmfcrf
12869 @itemx -mno-mfcrf
12870 @itemx -mpopcntb
12871 @itemx -mno-popcntb
12872 @itemx -mfprnd
12873 @itemx -mno-fprnd
12874 @itemx -mcmpb
12875 @itemx -mno-cmpb
12876 @itemx -mmfpgpr
12877 @itemx -mno-mfpgpr
12878 @itemx -mhard-dfp
12879 @itemx -mno-hard-dfp
12880 @opindex mpower
12881 @opindex mno-power
12882 @opindex mpower2
12883 @opindex mno-power2
12884 @opindex mpowerpc
12885 @opindex mno-powerpc
12886 @opindex mpowerpc-gpopt
12887 @opindex mno-powerpc-gpopt
12888 @opindex mpowerpc-gfxopt
12889 @opindex mno-powerpc-gfxopt
12890 @opindex mpowerpc64
12891 @opindex mno-powerpc64
12892 @opindex mmfcrf
12893 @opindex mno-mfcrf
12894 @opindex mpopcntb
12895 @opindex mno-popcntb
12896 @opindex mfprnd
12897 @opindex mno-fprnd
12898 @opindex mcmpb
12899 @opindex mno-cmpb
12900 @opindex mmfpgpr
12901 @opindex mno-mfpgpr
12902 @opindex mhard-dfp
12903 @opindex mno-hard-dfp
12904 GCC supports two related instruction set architectures for the
12905 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12906 instructions supported by the @samp{rios} chip set used in the original
12907 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12908 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12909 the IBM 4xx, 6xx, and follow-on microprocessors.
12911 Neither architecture is a subset of the other.  However there is a
12912 large common subset of instructions supported by both.  An MQ
12913 register is included in processors supporting the POWER architecture.
12915 You use these options to specify which instructions are available on the
12916 processor you are using.  The default value of these options is
12917 determined when configuring GCC@.  Specifying the
12918 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12919 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12920 rather than the options listed above.
12922 The @option{-mpower} option allows GCC to generate instructions that
12923 are found only in the POWER architecture and to use the MQ register.
12924 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12925 to generate instructions that are present in the POWER2 architecture but
12926 not the original POWER architecture.
12928 The @option{-mpowerpc} option allows GCC to generate instructions that
12929 are found only in the 32-bit subset of the PowerPC architecture.
12930 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12931 GCC to use the optional PowerPC architecture instructions in the
12932 General Purpose group, including floating-point square root.  Specifying
12933 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12934 use the optional PowerPC architecture instructions in the Graphics
12935 group, including floating-point select.
12937 The @option{-mmfcrf} option allows GCC to generate the move from
12938 condition register field instruction implemented on the POWER4
12939 processor and other processors that support the PowerPC V2.01
12940 architecture.
12941 The @option{-mpopcntb} option allows GCC to generate the popcount and
12942 double precision FP reciprocal estimate instruction implemented on the
12943 POWER5 processor and other processors that support the PowerPC V2.02
12944 architecture.
12945 The @option{-mfprnd} option allows GCC to generate the FP round to
12946 integer instructions implemented on the POWER5+ processor and other
12947 processors that support the PowerPC V2.03 architecture.
12948 The @option{-mcmpb} option allows GCC to generate the compare bytes
12949 instruction implemented on the POWER6 processor and other processors
12950 that support the PowerPC V2.05 architecture.
12951 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12952 general purpose register instructions implemented on the POWER6X
12953 processor and other processors that support the extended PowerPC V2.05
12954 architecture.
12955 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12956 point instructions implemented on some POWER processors.
12958 The @option{-mpowerpc64} option allows GCC to generate the additional
12959 64-bit instructions that are found in the full PowerPC64 architecture
12960 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12961 @option{-mno-powerpc64}.
12963 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12964 will use only the instructions in the common subset of both
12965 architectures plus some special AIX common-mode calls, and will not use
12966 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12967 permits GCC to use any instruction from either architecture and to
12968 allow use of the MQ register; specify this for the Motorola MPC601.
12970 @item -mnew-mnemonics
12971 @itemx -mold-mnemonics
12972 @opindex mnew-mnemonics
12973 @opindex mold-mnemonics
12974 Select which mnemonics to use in the generated assembler code.  With
12975 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12976 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12977 assembler mnemonics defined for the POWER architecture.  Instructions
12978 defined in only one architecture have only one mnemonic; GCC uses that
12979 mnemonic irrespective of which of these options is specified.
12981 GCC defaults to the mnemonics appropriate for the architecture in
12982 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12983 value of these option.  Unless you are building a cross-compiler, you
12984 should normally not specify either @option{-mnew-mnemonics} or
12985 @option{-mold-mnemonics}, but should instead accept the default.
12987 @item -mcpu=@var{cpu_type}
12988 @opindex mcpu
12989 Set architecture type, register usage, choice of mnemonics, and
12990 instruction scheduling parameters for machine type @var{cpu_type}.
12991 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12992 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
12993 @samp{505}, @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12994 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12995 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12996 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
12997 @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, @samp{power},
12998 @samp{power2}, @samp{power3}, @samp{power4}, @samp{power5},
12999 @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{common},
13000 @samp{powerpc}, @samp{powerpc64}, @samp{rios}, @samp{rios1},
13001 @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13003 @option{-mcpu=common} selects a completely generic processor.  Code
13004 generated under this option will run on any POWER or PowerPC processor.
13005 GCC will use only the instructions in the common subset of both
13006 architectures, and will not use the MQ register.  GCC assumes a generic
13007 processor model for scheduling purposes.
13009 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13010 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13011 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13012 types, with an appropriate, generic processor model assumed for
13013 scheduling purposes.
13015 The other options specify a specific processor.  Code generated under
13016 those options will run best on that processor, and may not run at all on
13017 others.
13019 The @option{-mcpu} options automatically enable or disable the
13020 following options:
13022 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13023 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13024 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13026 The particular options set for any particular CPU will vary between
13027 compiler versions, depending on what setting seems to produce optimal
13028 code for that CPU; it doesn't necessarily reflect the actual hardware's
13029 capabilities.  If you wish to set an individual option to a particular
13030 value, you may specify it after the @option{-mcpu} option, like
13031 @samp{-mcpu=970 -mno-altivec}.
13033 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13034 not enabled or disabled by the @option{-mcpu} option at present because
13035 AIX does not have full support for these options.  You may still
13036 enable or disable them individually if you're sure it'll work in your
13037 environment.
13039 @item -mtune=@var{cpu_type}
13040 @opindex mtune
13041 Set the instruction scheduling parameters for machine type
13042 @var{cpu_type}, but do not set the architecture type, register usage, or
13043 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13044 values for @var{cpu_type} are used for @option{-mtune} as for
13045 @option{-mcpu}.  If both are specified, the code generated will use the
13046 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13047 scheduling parameters set by @option{-mtune}.
13049 @item -mswdiv
13050 @itemx -mno-swdiv
13051 @opindex mswdiv
13052 @opindex mno-swdiv
13053 Generate code to compute division as reciprocal estimate and iterative
13054 refinement, creating opportunities for increased throughput.  This
13055 feature requires: optional PowerPC Graphics instruction set for single
13056 precision and FRE instruction for double precision, assuming divides
13057 cannot generate user-visible traps, and the domain values not include
13058 Infinities, denormals or zero denominator.
13060 @item -maltivec
13061 @itemx -mno-altivec
13062 @opindex maltivec
13063 @opindex mno-altivec
13064 Generate code that uses (does not use) AltiVec instructions, and also
13065 enable the use of built-in functions that allow more direct access to
13066 the AltiVec instruction set.  You may also need to set
13067 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13068 enhancements.
13070 @item -mvrsave
13071 @itemx -mno-vrsave
13072 @opindex mvrsave
13073 @opindex mno-vrsave
13074 Generate VRSAVE instructions when generating AltiVec code.
13076 @item -msecure-plt
13077 @opindex msecure-plt
13078 Generate code that allows ld and ld.so to build executables and shared
13079 libraries with non-exec .plt and .got sections.  This is a PowerPC
13080 32-bit SYSV ABI option.
13082 @item -mbss-plt
13083 @opindex mbss-plt
13084 Generate code that uses a BSS .plt section that ld.so fills in, and
13085 requires .plt and .got sections that are both writable and executable.
13086 This is a PowerPC 32-bit SYSV ABI option.
13088 @item -misel
13089 @itemx -mno-isel
13090 @opindex misel
13091 @opindex mno-isel
13092 This switch enables or disables the generation of ISEL instructions.
13094 @item -misel=@var{yes/no}
13095 This switch has been deprecated.  Use @option{-misel} and
13096 @option{-mno-isel} instead.
13098 @item -mspe
13099 @itemx -mno-spe
13100 @opindex mspe
13101 @opindex mno-spe
13102 This switch enables or disables the generation of SPE simd
13103 instructions.
13105 @item -mpaired
13106 @itemx -mno-paired
13107 @opindex mpaired
13108 @opindex mno-paired
13109 This switch enables or disables the generation of PAIRED simd
13110 instructions.
13112 @item -mspe=@var{yes/no}
13113 This option has been deprecated.  Use @option{-mspe} and
13114 @option{-mno-spe} instead.
13116 @item -mfloat-gprs=@var{yes/single/double/no}
13117 @itemx -mfloat-gprs
13118 @opindex mfloat-gprs
13119 This switch enables or disables the generation of floating point
13120 operations on the general purpose registers for architectures that
13121 support it.
13123 The argument @var{yes} or @var{single} enables the use of
13124 single-precision floating point operations.
13126 The argument @var{double} enables the use of single and
13127 double-precision floating point operations.
13129 The argument @var{no} disables floating point operations on the
13130 general purpose registers.
13132 This option is currently only available on the MPC854x.
13134 @item -m32
13135 @itemx -m64
13136 @opindex m32
13137 @opindex m64
13138 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13139 targets (including GNU/Linux).  The 32-bit environment sets int, long
13140 and pointer to 32 bits and generates code that runs on any PowerPC
13141 variant.  The 64-bit environment sets int to 32 bits and long and
13142 pointer to 64 bits, and generates code for PowerPC64, as for
13143 @option{-mpowerpc64}.
13145 @item -mfull-toc
13146 @itemx -mno-fp-in-toc
13147 @itemx -mno-sum-in-toc
13148 @itemx -mminimal-toc
13149 @opindex mfull-toc
13150 @opindex mno-fp-in-toc
13151 @opindex mno-sum-in-toc
13152 @opindex mminimal-toc
13153 Modify generation of the TOC (Table Of Contents), which is created for
13154 every executable file.  The @option{-mfull-toc} option is selected by
13155 default.  In that case, GCC will allocate at least one TOC entry for
13156 each unique non-automatic variable reference in your program.  GCC
13157 will also place floating-point constants in the TOC@.  However, only
13158 16,384 entries are available in the TOC@.
13160 If you receive a linker error message that saying you have overflowed
13161 the available TOC space, you can reduce the amount of TOC space used
13162 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13163 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13164 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13165 generate code to calculate the sum of an address and a constant at
13166 run-time instead of putting that sum into the TOC@.  You may specify one
13167 or both of these options.  Each causes GCC to produce very slightly
13168 slower and larger code at the expense of conserving TOC space.
13170 If you still run out of space in the TOC even when you specify both of
13171 these options, specify @option{-mminimal-toc} instead.  This option causes
13172 GCC to make only one TOC entry for every file.  When you specify this
13173 option, GCC will produce code that is slower and larger but which
13174 uses extremely little TOC space.  You may wish to use this option
13175 only on files that contain less frequently executed code.
13177 @item -maix64
13178 @itemx -maix32
13179 @opindex maix64
13180 @opindex maix32
13181 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13182 @code{long} type, and the infrastructure needed to support them.
13183 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13184 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13185 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13187 @item -mxl-compat
13188 @itemx -mno-xl-compat
13189 @opindex mxl-compat
13190 @opindex mno-xl-compat
13191 Produce code that conforms more closely to IBM XL compiler semantics
13192 when using AIX-compatible ABI@.  Pass floating-point arguments to
13193 prototyped functions beyond the register save area (RSA) on the stack
13194 in addition to argument FPRs.  Do not assume that most significant
13195 double in 128-bit long double value is properly rounded when comparing
13196 values and converting to double.  Use XL symbol names for long double
13197 support routines.
13199 The AIX calling convention was extended but not initially documented to
13200 handle an obscure K&R C case of calling a function that takes the
13201 address of its arguments with fewer arguments than declared.  IBM XL
13202 compilers access floating point arguments which do not fit in the
13203 RSA from the stack when a subroutine is compiled without
13204 optimization.  Because always storing floating-point arguments on the
13205 stack is inefficient and rarely needed, this option is not enabled by
13206 default and only is necessary when calling subroutines compiled by IBM
13207 XL compilers without optimization.
13209 @item -mpe
13210 @opindex mpe
13211 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13212 application written to use message passing with special startup code to
13213 enable the application to run.  The system must have PE installed in the
13214 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13215 must be overridden with the @option{-specs=} option to specify the
13216 appropriate directory location.  The Parallel Environment does not
13217 support threads, so the @option{-mpe} option and the @option{-pthread}
13218 option are incompatible.
13220 @item -malign-natural
13221 @itemx -malign-power
13222 @opindex malign-natural
13223 @opindex malign-power
13224 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13225 @option{-malign-natural} overrides the ABI-defined alignment of larger
13226 types, such as floating-point doubles, on their natural size-based boundary.
13227 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13228 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13230 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13231 is not supported.
13233 @item -msoft-float
13234 @itemx -mhard-float
13235 @opindex msoft-float
13236 @opindex mhard-float
13237 Generate code that does not use (uses) the floating-point register set.
13238 Software floating point emulation is provided if you use the
13239 @option{-msoft-float} option, and pass the option to GCC when linking.
13241 @item -mmultiple
13242 @itemx -mno-multiple
13243 @opindex mmultiple
13244 @opindex mno-multiple
13245 Generate code that uses (does not use) the load multiple word
13246 instructions and the store multiple word instructions.  These
13247 instructions are generated by default on POWER systems, and not
13248 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13249 endian PowerPC systems, since those instructions do not work when the
13250 processor is in little endian mode.  The exceptions are PPC740 and
13251 PPC750 which permit the instructions usage in little endian mode.
13253 @item -mstring
13254 @itemx -mno-string
13255 @opindex mstring
13256 @opindex mno-string
13257 Generate code that uses (does not use) the load string instructions
13258 and the store string word instructions to save multiple registers and
13259 do small block moves.  These instructions are generated by default on
13260 POWER systems, and not generated on PowerPC systems.  Do not use
13261 @option{-mstring} on little endian PowerPC systems, since those
13262 instructions do not work when the processor is in little endian mode.
13263 The exceptions are PPC740 and PPC750 which permit the instructions
13264 usage in little endian mode.
13266 @item -mupdate
13267 @itemx -mno-update
13268 @opindex mupdate
13269 @opindex mno-update
13270 Generate code that uses (does not use) the load or store instructions
13271 that update the base register to the address of the calculated memory
13272 location.  These instructions are generated by default.  If you use
13273 @option{-mno-update}, there is a small window between the time that the
13274 stack pointer is updated and the address of the previous frame is
13275 stored, which means code that walks the stack frame across interrupts or
13276 signals may get corrupted data.
13278 @item -mfused-madd
13279 @itemx -mno-fused-madd
13280 @opindex mfused-madd
13281 @opindex mno-fused-madd
13282 Generate code that uses (does not use) the floating point multiply and
13283 accumulate instructions.  These instructions are generated by default if
13284 hardware floating is used.
13286 @item -mmulhw
13287 @itemx -mno-mulhw
13288 @opindex mmulhw
13289 @opindex mno-mulhw
13290 Generate code that uses (does not use) the half-word multiply and
13291 multiply-accumulate instructions on the IBM 405, 440 and 464 processors.
13292 These instructions are generated by default when targetting those
13293 processors.
13295 @item -mdlmzb
13296 @itemx -mno-dlmzb
13297 @opindex mdlmzb
13298 @opindex mno-dlmzb
13299 Generate code that uses (does not use) the string-search @samp{dlmzb}
13300 instruction on the IBM 405, 440 and 464 processors.  This instruction is
13301 generated by default when targetting those processors.
13303 @item -mno-bit-align
13304 @itemx -mbit-align
13305 @opindex mno-bit-align
13306 @opindex mbit-align
13307 On System V.4 and embedded PowerPC systems do not (do) force structures
13308 and unions that contain bit-fields to be aligned to the base type of the
13309 bit-field.
13311 For example, by default a structure containing nothing but 8
13312 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13313 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13314 the structure would be aligned to a 1 byte boundary and be one byte in
13315 size.
13317 @item -mno-strict-align
13318 @itemx -mstrict-align
13319 @opindex mno-strict-align
13320 @opindex mstrict-align
13321 On System V.4 and embedded PowerPC systems do not (do) assume that
13322 unaligned memory references will be handled by the system.
13324 @item -mrelocatable
13325 @itemx -mno-relocatable
13326 @opindex mrelocatable
13327 @opindex mno-relocatable
13328 On embedded PowerPC systems generate code that allows (does not allow)
13329 the program to be relocated to a different address at runtime.  If you
13330 use @option{-mrelocatable} on any module, all objects linked together must
13331 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13333 @item -mrelocatable-lib
13334 @itemx -mno-relocatable-lib
13335 @opindex mrelocatable-lib
13336 @opindex mno-relocatable-lib
13337 On embedded PowerPC systems generate code that allows (does not allow)
13338 the program to be relocated to a different address at runtime.  Modules
13339 compiled with @option{-mrelocatable-lib} can be linked with either modules
13340 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13341 with modules compiled with the @option{-mrelocatable} options.
13343 @item -mno-toc
13344 @itemx -mtoc
13345 @opindex mno-toc
13346 @opindex mtoc
13347 On System V.4 and embedded PowerPC systems do not (do) assume that
13348 register 2 contains a pointer to a global area pointing to the addresses
13349 used in the program.
13351 @item -mlittle
13352 @itemx -mlittle-endian
13353 @opindex mlittle
13354 @opindex mlittle-endian
13355 On System V.4 and embedded PowerPC systems compile code for the
13356 processor in little endian mode.  The @option{-mlittle-endian} option is
13357 the same as @option{-mlittle}.
13359 @item -mbig
13360 @itemx -mbig-endian
13361 @opindex mbig
13362 @opindex mbig-endian
13363 On System V.4 and embedded PowerPC systems compile code for the
13364 processor in big endian mode.  The @option{-mbig-endian} option is
13365 the same as @option{-mbig}.
13367 @item -mdynamic-no-pic
13368 @opindex mdynamic-no-pic
13369 On Darwin and Mac OS X systems, compile code so that it is not
13370 relocatable, but that its external references are relocatable.  The
13371 resulting code is suitable for applications, but not shared
13372 libraries.
13374 @item -mprioritize-restricted-insns=@var{priority}
13375 @opindex mprioritize-restricted-insns
13376 This option controls the priority that is assigned to
13377 dispatch-slot restricted instructions during the second scheduling
13378 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13379 @var{no/highest/second-highest} priority to dispatch slot restricted
13380 instructions.
13382 @item -msched-costly-dep=@var{dependence_type}
13383 @opindex msched-costly-dep
13384 This option controls which dependences are considered costly
13385 by the target during instruction scheduling.  The argument
13386 @var{dependence_type} takes one of the following values:
13387 @var{no}: no dependence is costly,
13388 @var{all}: all dependences are costly,
13389 @var{true_store_to_load}: a true dependence from store to load is costly,
13390 @var{store_to_load}: any dependence from store to load is costly,
13391 @var{number}: any dependence which latency >= @var{number} is costly.
13393 @item -minsert-sched-nops=@var{scheme}
13394 @opindex minsert-sched-nops
13395 This option controls which nop insertion scheme will be used during
13396 the second scheduling pass.  The argument @var{scheme} takes one of the
13397 following values:
13398 @var{no}: Don't insert nops.
13399 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13400 according to the scheduler's grouping.
13401 @var{regroup_exact}: Insert nops to force costly dependent insns into
13402 separate groups.  Insert exactly as many nops as needed to force an insn
13403 to a new group, according to the estimated processor grouping.
13404 @var{number}: Insert nops to force costly dependent insns into
13405 separate groups.  Insert @var{number} nops to force an insn to a new group.
13407 @item -mcall-sysv
13408 @opindex mcall-sysv
13409 On System V.4 and embedded PowerPC systems compile code using calling
13410 conventions that adheres to the March 1995 draft of the System V
13411 Application Binary Interface, PowerPC processor supplement.  This is the
13412 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13414 @item -mcall-sysv-eabi
13415 @opindex mcall-sysv-eabi
13416 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13418 @item -mcall-sysv-noeabi
13419 @opindex mcall-sysv-noeabi
13420 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13422 @item -mcall-solaris
13423 @opindex mcall-solaris
13424 On System V.4 and embedded PowerPC systems compile code for the Solaris
13425 operating system.
13427 @item -mcall-linux
13428 @opindex mcall-linux
13429 On System V.4 and embedded PowerPC systems compile code for the
13430 Linux-based GNU system.
13432 @item -mcall-gnu
13433 @opindex mcall-gnu
13434 On System V.4 and embedded PowerPC systems compile code for the
13435 Hurd-based GNU system.
13437 @item -mcall-netbsd
13438 @opindex mcall-netbsd
13439 On System V.4 and embedded PowerPC systems compile code for the
13440 NetBSD operating system.
13442 @item -maix-struct-return
13443 @opindex maix-struct-return
13444 Return all structures in memory (as specified by the AIX ABI)@.
13446 @item -msvr4-struct-return
13447 @opindex msvr4-struct-return
13448 Return structures smaller than 8 bytes in registers (as specified by the
13449 SVR4 ABI)@.
13451 @item -mabi=@var{abi-type}
13452 @opindex mabi
13453 Extend the current ABI with a particular extension, or remove such extension.
13454 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13455 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13457 @item -mabi=spe
13458 @opindex mabi=spe
13459 Extend the current ABI with SPE ABI extensions.  This does not change
13460 the default ABI, instead it adds the SPE ABI extensions to the current
13461 ABI@.
13463 @item -mabi=no-spe
13464 @opindex mabi=no-spe
13465 Disable Booke SPE ABI extensions for the current ABI@.
13467 @item -mabi=ibmlongdouble
13468 @opindex mabi=ibmlongdouble
13469 Change the current ABI to use IBM extended precision long double.
13470 This is a PowerPC 32-bit SYSV ABI option.
13472 @item -mabi=ieeelongdouble
13473 @opindex mabi=ieeelongdouble
13474 Change the current ABI to use IEEE extended precision long double.
13475 This is a PowerPC 32-bit Linux ABI option.
13477 @item -mprototype
13478 @itemx -mno-prototype
13479 @opindex mprototype
13480 @opindex mno-prototype
13481 On System V.4 and embedded PowerPC systems assume that all calls to
13482 variable argument functions are properly prototyped.  Otherwise, the
13483 compiler must insert an instruction before every non prototyped call to
13484 set or clear bit 6 of the condition code register (@var{CR}) to
13485 indicate whether floating point values were passed in the floating point
13486 registers in case the function takes a variable arguments.  With
13487 @option{-mprototype}, only calls to prototyped variable argument functions
13488 will set or clear the bit.
13490 @item -msim
13491 @opindex msim
13492 On embedded PowerPC systems, assume that the startup module is called
13493 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13494 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13495 configurations.
13497 @item -mmvme
13498 @opindex mmvme
13499 On embedded PowerPC systems, assume that the startup module is called
13500 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13501 @file{libc.a}.
13503 @item -mads
13504 @opindex mads
13505 On embedded PowerPC systems, assume that the startup module is called
13506 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13507 @file{libc.a}.
13509 @item -myellowknife
13510 @opindex myellowknife
13511 On embedded PowerPC systems, assume that the startup module is called
13512 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13513 @file{libc.a}.
13515 @item -mvxworks
13516 @opindex mvxworks
13517 On System V.4 and embedded PowerPC systems, specify that you are
13518 compiling for a VxWorks system.
13520 @item -memb
13521 @opindex memb
13522 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13523 header to indicate that @samp{eabi} extended relocations are used.
13525 @item -meabi
13526 @itemx -mno-eabi
13527 @opindex meabi
13528 @opindex mno-eabi
13529 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13530 Embedded Applications Binary Interface (eabi) which is a set of
13531 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13532 means that the stack is aligned to an 8 byte boundary, a function
13533 @code{__eabi} is called to from @code{main} to set up the eabi
13534 environment, and the @option{-msdata} option can use both @code{r2} and
13535 @code{r13} to point to two separate small data areas.  Selecting
13536 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13537 do not call an initialization function from @code{main}, and the
13538 @option{-msdata} option will only use @code{r13} to point to a single
13539 small data area.  The @option{-meabi} option is on by default if you
13540 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13542 @item -msdata=eabi
13543 @opindex msdata=eabi
13544 On System V.4 and embedded PowerPC systems, put small initialized
13545 @code{const} global and static data in the @samp{.sdata2} section, which
13546 is pointed to by register @code{r2}.  Put small initialized
13547 non-@code{const} global and static data in the @samp{.sdata} section,
13548 which is pointed to by register @code{r13}.  Put small uninitialized
13549 global and static data in the @samp{.sbss} section, which is adjacent to
13550 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13551 incompatible with the @option{-mrelocatable} option.  The
13552 @option{-msdata=eabi} option also sets the @option{-memb} option.
13554 @item -msdata=sysv
13555 @opindex msdata=sysv
13556 On System V.4 and embedded PowerPC systems, put small global and static
13557 data in the @samp{.sdata} section, which is pointed to by register
13558 @code{r13}.  Put small uninitialized global and static data in the
13559 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13560 The @option{-msdata=sysv} option is incompatible with the
13561 @option{-mrelocatable} option.
13563 @item -msdata=default
13564 @itemx -msdata
13565 @opindex msdata=default
13566 @opindex msdata
13567 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13568 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13569 same as @option{-msdata=sysv}.
13571 @item -msdata-data
13572 @opindex msdata-data
13573 On System V.4 and embedded PowerPC systems, put small global
13574 data in the @samp{.sdata} section.  Put small uninitialized global
13575 data in the @samp{.sbss} section.  Do not use register @code{r13}
13576 to address small data however.  This is the default behavior unless
13577 other @option{-msdata} options are used.
13579 @item -msdata=none
13580 @itemx -mno-sdata
13581 @opindex msdata=none
13582 @opindex mno-sdata
13583 On embedded PowerPC systems, put all initialized global and static data
13584 in the @samp{.data} section, and all uninitialized data in the
13585 @samp{.bss} section.
13587 @item -G @var{num}
13588 @opindex G
13589 @cindex smaller data references (PowerPC)
13590 @cindex .sdata/.sdata2 references (PowerPC)
13591 On embedded PowerPC systems, put global and static items less than or
13592 equal to @var{num} bytes into the small data or bss sections instead of
13593 the normal data or bss section.  By default, @var{num} is 8.  The
13594 @option{-G @var{num}} switch is also passed to the linker.
13595 All modules should be compiled with the same @option{-G @var{num}} value.
13597 @item -mregnames
13598 @itemx -mno-regnames
13599 @opindex mregnames
13600 @opindex mno-regnames
13601 On System V.4 and embedded PowerPC systems do (do not) emit register
13602 names in the assembly language output using symbolic forms.
13604 @item -mlongcall
13605 @itemx -mno-longcall
13606 @opindex mlongcall
13607 @opindex mno-longcall
13608 By default assume that all calls are far away so that a longer more
13609 expensive calling sequence is required.  This is required for calls
13610 further than 32 megabytes (33,554,432 bytes) from the current location.
13611 A short call will be generated if the compiler knows
13612 the call cannot be that far away.  This setting can be overridden by
13613 the @code{shortcall} function attribute, or by @code{#pragma
13614 longcall(0)}.
13616 Some linkers are capable of detecting out-of-range calls and generating
13617 glue code on the fly.  On these systems, long calls are unnecessary and
13618 generate slower code.  As of this writing, the AIX linker can do this,
13619 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13620 to the GNU linker for 32-bit PowerPC systems as well.
13622 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13623 callee, L42'', plus a ``branch island'' (glue code).  The two target
13624 addresses represent the callee and the ``branch island''.  The
13625 Darwin/PPC linker will prefer the first address and generate a ``bl
13626 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13627 otherwise, the linker will generate ``bl L42'' to call the ``branch
13628 island''.  The ``branch island'' is appended to the body of the
13629 calling function; it computes the full 32-bit address of the callee
13630 and jumps to it.
13632 On Mach-O (Darwin) systems, this option directs the compiler emit to
13633 the glue for every direct call, and the Darwin linker decides whether
13634 to use or discard it.
13636 In the future, we may cause GCC to ignore all longcall specifications
13637 when the linker is known to generate glue.
13639 @item -pthread
13640 @opindex pthread
13641 Adds support for multithreading with the @dfn{pthreads} library.
13642 This option sets flags for both the preprocessor and linker.
13644 @end table
13646 @node S/390 and zSeries Options
13647 @subsection S/390 and zSeries Options
13648 @cindex S/390 and zSeries Options
13650 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13652 @table @gcctabopt
13653 @item -mhard-float
13654 @itemx -msoft-float
13655 @opindex mhard-float
13656 @opindex msoft-float
13657 Use (do not use) the hardware floating-point instructions and registers
13658 for floating-point operations.  When @option{-msoft-float} is specified,
13659 functions in @file{libgcc.a} will be used to perform floating-point
13660 operations.  When @option{-mhard-float} is specified, the compiler
13661 generates IEEE floating-point instructions.  This is the default.
13663 @item -mlong-double-64
13664 @itemx -mlong-double-128
13665 @opindex mlong-double-64
13666 @opindex mlong-double-128
13667 These switches control the size of @code{long double} type. A size
13668 of 64bit makes the @code{long double} type equivalent to the @code{double}
13669 type. This is the default.
13671 @item -mbackchain
13672 @itemx -mno-backchain
13673 @opindex mbackchain
13674 @opindex mno-backchain
13675 Store (do not store) the address of the caller's frame as backchain pointer
13676 into the callee's stack frame.
13677 A backchain may be needed to allow debugging using tools that do not understand
13678 DWARF-2 call frame information.
13679 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13680 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13681 the backchain is placed into the topmost word of the 96/160 byte register
13682 save area.
13684 In general, code compiled with @option{-mbackchain} is call-compatible with
13685 code compiled with @option{-mmo-backchain}; however, use of the backchain
13686 for debugging purposes usually requires that the whole binary is built with
13687 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13688 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13689 to build a linux kernel use @option{-msoft-float}.
13691 The default is to not maintain the backchain.
13693 @item -mpacked-stack
13694 @itemx -mno-packed-stack
13695 @opindex mpacked-stack
13696 @opindex mno-packed-stack
13697 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13698 specified, the compiler uses the all fields of the 96/160 byte register save
13699 area only for their default purpose; unused fields still take up stack space.
13700 When @option{-mpacked-stack} is specified, register save slots are densely
13701 packed at the top of the register save area; unused space is reused for other
13702 purposes, allowing for more efficient use of the available stack space.
13703 However, when @option{-mbackchain} is also in effect, the topmost word of
13704 the save area is always used to store the backchain, and the return address
13705 register is always saved two words below the backchain.
13707 As long as the stack frame backchain is not used, code generated with
13708 @option{-mpacked-stack} is call-compatible with code generated with
13709 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13710 S/390 or zSeries generated code that uses the stack frame backchain at run
13711 time, not just for debugging purposes.  Such code is not call-compatible
13712 with code compiled with @option{-mpacked-stack}.  Also, note that the
13713 combination of @option{-mbackchain},
13714 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13715 to build a linux kernel use @option{-msoft-float}.
13717 The default is to not use the packed stack layout.
13719 @item -msmall-exec
13720 @itemx -mno-small-exec
13721 @opindex msmall-exec
13722 @opindex mno-small-exec
13723 Generate (or do not generate) code using the @code{bras} instruction
13724 to do subroutine calls.
13725 This only works reliably if the total executable size does not
13726 exceed 64k.  The default is to use the @code{basr} instruction instead,
13727 which does not have this limitation.
13729 @item -m64
13730 @itemx -m31
13731 @opindex m64
13732 @opindex m31
13733 When @option{-m31} is specified, generate code compliant to the
13734 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13735 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13736 particular to generate 64-bit instructions.  For the @samp{s390}
13737 targets, the default is @option{-m31}, while the @samp{s390x}
13738 targets default to @option{-m64}.
13740 @item -mzarch
13741 @itemx -mesa
13742 @opindex mzarch
13743 @opindex mesa
13744 When @option{-mzarch} is specified, generate code using the
13745 instructions available on z/Architecture.
13746 When @option{-mesa} is specified, generate code using the
13747 instructions available on ESA/390.  Note that @option{-mesa} is
13748 not possible with @option{-m64}.
13749 When generating code compliant to the GNU/Linux for S/390 ABI,
13750 the default is @option{-mesa}.  When generating code compliant
13751 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13753 @item -mmvcle
13754 @itemx -mno-mvcle
13755 @opindex mmvcle
13756 @opindex mno-mvcle
13757 Generate (or do not generate) code using the @code{mvcle} instruction
13758 to perform block moves.  When @option{-mno-mvcle} is specified,
13759 use a @code{mvc} loop instead.  This is the default unless optimizing for
13760 size.
13762 @item -mdebug
13763 @itemx -mno-debug
13764 @opindex mdebug
13765 @opindex mno-debug
13766 Print (or do not print) additional debug information when compiling.
13767 The default is to not print debug information.
13769 @item -march=@var{cpu-type}
13770 @opindex march
13771 Generate code that will run on @var{cpu-type}, which is the name of a system
13772 representing a certain processor type.  Possible values for
13773 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13774 When generating code using the instructions available on z/Architecture,
13775 the default is @option{-march=z900}.  Otherwise, the default is
13776 @option{-march=g5}.
13778 @item -mtune=@var{cpu-type}
13779 @opindex mtune
13780 Tune to @var{cpu-type} everything applicable about the generated code,
13781 except for the ABI and the set of available instructions.
13782 The list of @var{cpu-type} values is the same as for @option{-march}.
13783 The default is the value used for @option{-march}.
13785 @item -mtpf-trace
13786 @itemx -mno-tpf-trace
13787 @opindex mtpf-trace
13788 @opindex mno-tpf-trace
13789 Generate code that adds (does not add) in TPF OS specific branches to trace
13790 routines in the operating system.  This option is off by default, even
13791 when compiling for the TPF OS@.
13793 @item -mfused-madd
13794 @itemx -mno-fused-madd
13795 @opindex mfused-madd
13796 @opindex mno-fused-madd
13797 Generate code that uses (does not use) the floating point multiply and
13798 accumulate instructions.  These instructions are generated by default if
13799 hardware floating point is used.
13801 @item -mwarn-framesize=@var{framesize}
13802 @opindex mwarn-framesize
13803 Emit a warning if the current function exceeds the given frame size.  Because
13804 this is a compile time check it doesn't need to be a real problem when the program
13805 runs.  It is intended to identify functions which most probably cause
13806 a stack overflow.  It is useful to be used in an environment with limited stack
13807 size e.g.@: the linux kernel.
13809 @item -mwarn-dynamicstack
13810 @opindex mwarn-dynamicstack
13811 Emit a warning if the function calls alloca or uses dynamically
13812 sized arrays.  This is generally a bad idea with a limited stack size.
13814 @item -mstack-guard=@var{stack-guard}
13815 @itemx -mstack-size=@var{stack-size}
13816 @opindex mstack-guard
13817 @opindex mstack-size
13818 If these options are provided the s390 back end emits additional instructions in
13819 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13820 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13821 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13822 the frame size of the compiled function is chosen.
13823 These options are intended to be used to help debugging stack overflow problems.
13824 The additionally emitted code causes only little overhead and hence can also be
13825 used in production like systems without greater performance degradation.  The given
13826 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13827 @var{stack-guard} without exceeding 64k.
13828 In order to be efficient the extra code makes the assumption that the stack starts
13829 at an address aligned to the value given by @var{stack-size}.
13830 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13831 @end table
13833 @node Score Options
13834 @subsection Score Options
13835 @cindex Score Options
13837 These options are defined for Score implementations:
13839 @table @gcctabopt
13840 @item -meb
13841 @opindex meb
13842 Compile code for big endian mode.  This is the default.
13844 @item -mel
13845 @opindex mel
13846 Compile code for little endian mode. 
13848 @item -mnhwloop
13849 @opindex mnhwloop
13850 Disable generate bcnz instruction.
13852 @item -muls
13853 @opindex muls
13854 Enable generate unaligned load and store instruction.
13856 @item -mmac
13857 @opindex mmac
13858 Enable the use of multiply-accumulate instructions. Disabled by default. 
13860 @item -mscore5
13861 @opindex mscore5
13862 Specify the SCORE5 as the target architecture.
13864 @item -mscore5u
13865 @opindex mscore5u
13866 Specify the SCORE5U of the target architecture.
13868 @item -mscore7
13869 @opindex mscore7
13870 Specify the SCORE7 as the target architecture. This is the default.
13872 @item -mscore7d
13873 @opindex mscore7d
13874 Specify the SCORE7D as the target architecture.
13875 @end table
13877 @node SH Options
13878 @subsection SH Options
13880 These @samp{-m} options are defined for the SH implementations:
13882 @table @gcctabopt
13883 @item -m1
13884 @opindex m1
13885 Generate code for the SH1.
13887 @item -m2
13888 @opindex m2
13889 Generate code for the SH2.
13891 @item -m2e
13892 Generate code for the SH2e.
13894 @item -m3
13895 @opindex m3
13896 Generate code for the SH3.
13898 @item -m3e
13899 @opindex m3e
13900 Generate code for the SH3e.
13902 @item -m4-nofpu
13903 @opindex m4-nofpu
13904 Generate code for the SH4 without a floating-point unit.
13906 @item -m4-single-only
13907 @opindex m4-single-only
13908 Generate code for the SH4 with a floating-point unit that only
13909 supports single-precision arithmetic.
13911 @item -m4-single
13912 @opindex m4-single
13913 Generate code for the SH4 assuming the floating-point unit is in
13914 single-precision mode by default.
13916 @item -m4
13917 @opindex m4
13918 Generate code for the SH4.
13920 @item -m4a-nofpu
13921 @opindex m4a-nofpu
13922 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13923 floating-point unit is not used.
13925 @item -m4a-single-only
13926 @opindex m4a-single-only
13927 Generate code for the SH4a, in such a way that no double-precision
13928 floating point operations are used.
13930 @item -m4a-single
13931 @opindex m4a-single
13932 Generate code for the SH4a assuming the floating-point unit is in
13933 single-precision mode by default.
13935 @item -m4a
13936 @opindex m4a
13937 Generate code for the SH4a.
13939 @item -m4al
13940 @opindex m4al
13941 Same as @option{-m4a-nofpu}, except that it implicitly passes
13942 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13943 instructions at the moment.
13945 @item -mb
13946 @opindex mb
13947 Compile code for the processor in big endian mode.
13949 @item -ml
13950 @opindex ml
13951 Compile code for the processor in little endian mode.
13953 @item -mdalign
13954 @opindex mdalign
13955 Align doubles at 64-bit boundaries.  Note that this changes the calling
13956 conventions, and thus some functions from the standard C library will
13957 not work unless you recompile it first with @option{-mdalign}.
13959 @item -mrelax
13960 @opindex mrelax
13961 Shorten some address references at link time, when possible; uses the
13962 linker option @option{-relax}.
13964 @item -mbigtable
13965 @opindex mbigtable
13966 Use 32-bit offsets in @code{switch} tables.  The default is to use
13967 16-bit offsets.
13969 @item -mbitops
13970 @opindex mbitops
13971 Enable the use of bit manipulation instructions on SH2A.
13973 @item -mfmovd
13974 @opindex mfmovd
13975 Enable the use of the instruction @code{fmovd}.
13977 @item -mhitachi
13978 @opindex mhitachi
13979 Comply with the calling conventions defined by Renesas.
13981 @item -mrenesas
13982 @opindex mhitachi
13983 Comply with the calling conventions defined by Renesas.
13985 @item -mno-renesas
13986 @opindex mhitachi
13987 Comply with the calling conventions defined for GCC before the Renesas
13988 conventions were available.  This option is the default for all
13989 targets of the SH toolchain except for @samp{sh-symbianelf}.
13991 @item -mnomacsave
13992 @opindex mnomacsave
13993 Mark the @code{MAC} register as call-clobbered, even if
13994 @option{-mhitachi} is given.
13996 @item -mieee
13997 @opindex mieee
13998 Increase IEEE-compliance of floating-point code.
13999 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14000 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14001 comparisons of NANs / infinities incurs extra overhead in every
14002 floating point comparison, therefore the default is set to
14003 @option{-ffinite-math-only}.
14005 @item -minline-ic_invalidate
14006 @opindex minline-ic_invalidate
14007 Inline code to invalidate instruction cache entries after setting up
14008 nested function trampolines.
14009 This option has no effect if -musermode is in effect and the selected
14010 code generation option (e.g. -m4) does not allow the use of the icbi
14011 instruction.
14012 If the selected code generation option does not allow the use of the icbi
14013 instruction, and -musermode is not in effect, the inlined code will
14014 manipulate the instruction cache address array directly with an associative
14015 write.  This not only requires privileged mode, but it will also
14016 fail if the cache line had been mapped via the TLB and has become unmapped.
14018 @item -misize
14019 @opindex misize
14020 Dump instruction size and location in the assembly code.
14022 @item -mpadstruct
14023 @opindex mpadstruct
14024 This option is deprecated.  It pads structures to multiple of 4 bytes,
14025 which is incompatible with the SH ABI@.
14027 @item -mspace
14028 @opindex mspace
14029 Optimize for space instead of speed.  Implied by @option{-Os}.
14031 @item -mprefergot
14032 @opindex mprefergot
14033 When generating position-independent code, emit function calls using
14034 the Global Offset Table instead of the Procedure Linkage Table.
14036 @item -musermode
14037 @opindex musermode
14038 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14039 if the inlined code would not work in user mode.
14040 This is the default when the target is @code{sh-*-linux*}.
14042 @item -multcost=@var{number}
14043 @opindex multcost=@var{number}
14044 Set the cost to assume for a multiply insn.
14046 @item -mdiv=@var{strategy}
14047 @opindex mdiv=@var{strategy}
14048 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14049 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14050 inv:call2, inv:fp .
14051 "fp" performs the operation in floating point.  This has a very high latency,
14052 but needs only a few instructions, so it might be a good choice if
14053 your code has enough easily exploitable ILP to allow the compiler to
14054 schedule the floating point instructions together with other instructions.
14055 Division by zero causes a floating point exception.
14056 "inv" uses integer operations to calculate the inverse of the divisor,
14057 and then multiplies the dividend with the inverse.  This strategy allows
14058 cse and hoisting of the inverse calculation.  Division by zero calculates
14059 an unspecified result, but does not trap.
14060 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14061 have been found, or if the entire operation has been hoisted to the same
14062 place, the last stages of the inverse calculation are intertwined with the
14063 final multiply to reduce the overall latency, at the expense of using a few
14064 more instructions, and thus offering fewer scheduling opportunities with
14065 other code.
14066 "call" calls a library function that usually implements the inv:minlat
14067 strategy.
14068 This gives high code density for m5-*media-nofpu compilations.
14069 "call2" uses a different entry point of the same library function, where it
14070 assumes that a pointer to a lookup table has already been set up, which
14071 exposes the pointer load to cse / code hoisting optimizations.
14072 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14073 code generation, but if the code stays unoptimized, revert to the "call",
14074 "call2", or "fp" strategies, respectively.  Note that the
14075 potentially-trapping side effect of division by zero is carried by a
14076 separate instruction, so it is possible that all the integer instructions
14077 are hoisted out, but the marker for the side effect stays where it is.
14078 A recombination to fp operations or a call is not possible in that case.
14079 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14080 that the inverse calculation was nor separated from the multiply, they speed
14081 up division where the dividend fits into 20 bits (plus sign where applicable),
14082 by inserting a test to skip a number of operations in this case; this test
14083 slows down the case of larger dividends.  inv20u assumes the case of a such
14084 a small dividend to be unlikely, and inv20l assumes it to be likely.
14086 @item -mdivsi3_libfunc=@var{name}
14087 @opindex mdivsi3_libfunc=@var{name}
14088 Set the name of the library function used for 32 bit signed division to
14089 @var{name}.  This only affect the name used in the call and inv:call
14090 division strategies, and the compiler will still expect the same
14091 sets of input/output/clobbered registers as if this option was not present.
14093 @item -mfixed-range=@var{register-range}
14094 @opindex mfixed-range
14095 Generate code treating the given register range as fixed registers.
14096 A fixed register is one that the register allocator can not use.  This is
14097 useful when compiling kernel code.  A register range is specified as
14098 two registers separated by a dash.  Multiple register ranges can be
14099 specified separated by a comma.
14101 @item -madjust-unroll
14102 @opindex madjust-unroll
14103 Throttle unrolling to avoid thrashing target registers.
14104 This option only has an effect if the gcc code base supports the
14105 TARGET_ADJUST_UNROLL_MAX target hook.
14107 @item -mindexed-addressing
14108 @opindex mindexed-addressing
14109 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14110 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14111 semantics for the indexed addressing mode.  The architecture allows the
14112 implementation of processors with 64 bit MMU, which the OS could use to
14113 get 32 bit addressing, but since no current hardware implementation supports
14114 this or any other way to make the indexed addressing mode safe to use in
14115 the 32 bit ABI, the default is -mno-indexed-addressing.
14117 @item -mgettrcost=@var{number}
14118 @opindex mgettrcost=@var{number}
14119 Set the cost assumed for the gettr instruction to @var{number}.
14120 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14122 @item -mpt-fixed
14123 @opindex mpt-fixed
14124 Assume pt* instructions won't trap.  This will generally generate better
14125 scheduled code, but is unsafe on current hardware.  The current architecture
14126 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14127 This has the unintentional effect of making it unsafe to schedule ptabs /
14128 ptrel before a branch, or hoist it out of a loop.  For example,
14129 __do_global_ctors, a part of libgcc that runs constructors at program
14130 startup, calls functions in a list which is delimited by @minus{}1.  With the
14131 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14132 That means that all the constructors will be run a bit quicker, but when
14133 the loop comes to the end of the list, the program crashes because ptabs
14134 loads @minus{}1 into a target register.  Since this option is unsafe for any
14135 hardware implementing the current architecture specification, the default
14136 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14137 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14138 this deters register allocation using target registers for storing
14139 ordinary integers.
14141 @item -minvalid-symbols
14142 @opindex minvalid-symbols
14143 Assume symbols might be invalid.  Ordinary function symbols generated by
14144 the compiler will always be valid to load with movi/shori/ptabs or
14145 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14146 to generate symbols that will cause ptabs / ptrel to trap.
14147 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14148 It will then prevent cross-basic-block cse, hoisting and most scheduling
14149 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14150 @end table
14152 @node SPARC Options
14153 @subsection SPARC Options
14154 @cindex SPARC options
14156 These @samp{-m} options are supported on the SPARC:
14158 @table @gcctabopt
14159 @item -mno-app-regs
14160 @itemx -mapp-regs
14161 @opindex mno-app-regs
14162 @opindex mapp-regs
14163 Specify @option{-mapp-regs} to generate output using the global registers
14164 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14165 is the default.
14167 To be fully SVR4 ABI compliant at the cost of some performance loss,
14168 specify @option{-mno-app-regs}.  You should compile libraries and system
14169 software with this option.
14171 @item -mfpu
14172 @itemx -mhard-float
14173 @opindex mfpu
14174 @opindex mhard-float
14175 Generate output containing floating point instructions.  This is the
14176 default.
14178 @item -mno-fpu
14179 @itemx -msoft-float
14180 @opindex mno-fpu
14181 @opindex msoft-float
14182 Generate output containing library calls for floating point.
14183 @strong{Warning:} the requisite libraries are not available for all SPARC
14184 targets.  Normally the facilities of the machine's usual C compiler are
14185 used, but this cannot be done directly in cross-compilation.  You must make
14186 your own arrangements to provide suitable library functions for
14187 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14188 @samp{sparclite-*-*} do provide software floating point support.
14190 @option{-msoft-float} changes the calling convention in the output file;
14191 therefore, it is only useful if you compile @emph{all} of a program with
14192 this option.  In particular, you need to compile @file{libgcc.a}, the
14193 library that comes with GCC, with @option{-msoft-float} in order for
14194 this to work.
14196 @item -mhard-quad-float
14197 @opindex mhard-quad-float
14198 Generate output containing quad-word (long double) floating point
14199 instructions.
14201 @item -msoft-quad-float
14202 @opindex msoft-quad-float
14203 Generate output containing library calls for quad-word (long double)
14204 floating point instructions.  The functions called are those specified
14205 in the SPARC ABI@.  This is the default.
14207 As of this writing, there are no SPARC implementations that have hardware
14208 support for the quad-word floating point instructions.  They all invoke
14209 a trap handler for one of these instructions, and then the trap handler
14210 emulates the effect of the instruction.  Because of the trap handler overhead,
14211 this is much slower than calling the ABI library routines.  Thus the
14212 @option{-msoft-quad-float} option is the default.
14214 @item -mno-unaligned-doubles
14215 @itemx -munaligned-doubles
14216 @opindex mno-unaligned-doubles
14217 @opindex munaligned-doubles
14218 Assume that doubles have 8 byte alignment.  This is the default.
14220 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14221 alignment only if they are contained in another type, or if they have an
14222 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14223 Specifying this option avoids some rare compatibility problems with code
14224 generated by other compilers.  It is not the default because it results
14225 in a performance loss, especially for floating point code.
14227 @item -mno-faster-structs
14228 @itemx -mfaster-structs
14229 @opindex mno-faster-structs
14230 @opindex mfaster-structs
14231 With @option{-mfaster-structs}, the compiler assumes that structures
14232 should have 8 byte alignment.  This enables the use of pairs of
14233 @code{ldd} and @code{std} instructions for copies in structure
14234 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14235 However, the use of this changed alignment directly violates the SPARC
14236 ABI@.  Thus, it's intended only for use on targets where the developer
14237 acknowledges that their resulting code will not be directly in line with
14238 the rules of the ABI@.
14240 @item -mimpure-text
14241 @opindex mimpure-text
14242 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14243 the compiler to not pass @option{-z text} to the linker when linking a
14244 shared object.  Using this option, you can link position-dependent
14245 code into a shared object.
14247 @option{-mimpure-text} suppresses the ``relocations remain against
14248 allocatable but non-writable sections'' linker error message.
14249 However, the necessary relocations will trigger copy-on-write, and the
14250 shared object is not actually shared across processes.  Instead of
14251 using @option{-mimpure-text}, you should compile all source code with
14252 @option{-fpic} or @option{-fPIC}.
14254 This option is only available on SunOS and Solaris.
14256 @item -mcpu=@var{cpu_type}
14257 @opindex mcpu
14258 Set the instruction set, register set, and instruction scheduling parameters
14259 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14260 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14261 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14262 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14263 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14265 Default instruction scheduling parameters are used for values that select
14266 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14267 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14269 Here is a list of each supported architecture and their supported
14270 implementations.
14272 @smallexample
14273     v7:             cypress
14274     v8:             supersparc, hypersparc
14275     sparclite:      f930, f934, sparclite86x
14276     sparclet:       tsc701
14277     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14278 @end smallexample
14280 By default (unless configured otherwise), GCC generates code for the V7
14281 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14282 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14283 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14284 SPARCStation 1, 2, IPX etc.
14286 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14287 architecture.  The only difference from V7 code is that the compiler emits
14288 the integer multiply and integer divide instructions which exist in SPARC-V8
14289 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14290 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14291 2000 series.
14293 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14294 the SPARC architecture.  This adds the integer multiply, integer divide step
14295 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14296 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14297 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14298 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14299 MB86934 chip, which is the more recent SPARClite with FPU@.
14301 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14302 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14303 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14304 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14305 optimizes it for the TEMIC SPARClet chip.
14307 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14308 architecture.  This adds 64-bit integer and floating-point move instructions,
14309 3 additional floating-point condition code registers and conditional move
14310 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14311 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14312 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14313 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14314 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14315 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14316 additionally optimizes it for Sun UltraSPARC T2 chips.
14318 @item -mtune=@var{cpu_type}
14319 @opindex mtune
14320 Set the instruction scheduling parameters for machine type
14321 @var{cpu_type}, but do not set the instruction set or register set that the
14322 option @option{-mcpu=@var{cpu_type}} would.
14324 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14325 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14326 that select a particular cpu implementation.  Those are @samp{cypress},
14327 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14328 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14329 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14331 @item -mv8plus
14332 @itemx -mno-v8plus
14333 @opindex mv8plus
14334 @opindex mno-v8plus
14335 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14336 difference from the V8 ABI is that the global and out registers are
14337 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14338 mode for all SPARC-V9 processors.
14340 @item -mvis
14341 @itemx -mno-vis
14342 @opindex mvis
14343 @opindex mno-vis
14344 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14345 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14346 @end table
14348 These @samp{-m} options are supported in addition to the above
14349 on SPARC-V9 processors in 64-bit environments:
14351 @table @gcctabopt
14352 @item -mlittle-endian
14353 @opindex mlittle-endian
14354 Generate code for a processor running in little-endian mode.  It is only
14355 available for a few configurations and most notably not on Solaris and Linux.
14357 @item -m32
14358 @itemx -m64
14359 @opindex m32
14360 @opindex m64
14361 Generate code for a 32-bit or 64-bit environment.
14362 The 32-bit environment sets int, long and pointer to 32 bits.
14363 The 64-bit environment sets int to 32 bits and long and pointer
14364 to 64 bits.
14366 @item -mcmodel=medlow
14367 @opindex mcmodel=medlow
14368 Generate code for the Medium/Low code model: 64-bit addresses, programs
14369 must be linked in the low 32 bits of memory.  Programs can be statically
14370 or dynamically linked.
14372 @item -mcmodel=medmid
14373 @opindex mcmodel=medmid
14374 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14375 must be linked in the low 44 bits of memory, the text and data segments must
14376 be less than 2GB in size and the data segment must be located within 2GB of
14377 the text segment.
14379 @item -mcmodel=medany
14380 @opindex mcmodel=medany
14381 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14382 may be linked anywhere in memory, the text and data segments must be less
14383 than 2GB in size and the data segment must be located within 2GB of the
14384 text segment.
14386 @item -mcmodel=embmedany
14387 @opindex mcmodel=embmedany
14388 Generate code for the Medium/Anywhere code model for embedded systems:
14389 64-bit addresses, the text and data segments must be less than 2GB in
14390 size, both starting anywhere in memory (determined at link time).  The
14391 global register %g4 points to the base of the data segment.  Programs
14392 are statically linked and PIC is not supported.
14394 @item -mstack-bias
14395 @itemx -mno-stack-bias
14396 @opindex mstack-bias
14397 @opindex mno-stack-bias
14398 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14399 frame pointer if present, are offset by @minus{}2047 which must be added back
14400 when making stack frame references.  This is the default in 64-bit mode.
14401 Otherwise, assume no such offset is present.
14402 @end table
14404 These switches are supported in addition to the above on Solaris:
14406 @table @gcctabopt
14407 @item -threads
14408 @opindex threads
14409 Add support for multithreading using the Solaris threads library.  This
14410 option sets flags for both the preprocessor and linker.  This option does
14411 not affect the thread safety of object code produced by the compiler or
14412 that of libraries supplied with it.
14414 @item -pthreads
14415 @opindex pthreads
14416 Add support for multithreading using the POSIX threads library.  This
14417 option sets flags for both the preprocessor and linker.  This option does
14418 not affect the thread safety of object code produced  by the compiler or
14419 that of libraries supplied with it.
14421 @item -pthread
14422 @opindex pthread
14423 This is a synonym for @option{-pthreads}.
14424 @end table
14426 @node SPU Options
14427 @subsection SPU Options
14428 @cindex SPU options
14430 These @samp{-m} options are supported on the SPU:
14432 @table @gcctabopt
14433 @item -mwarn-reloc
14434 @itemx -merror-reloc
14435 @opindex mwarn-reloc
14436 @opindex merror-reloc
14438 The loader for SPU does not handle dynamic relocations.  By default, GCC
14439 will give an error when it generates code that requires a dynamic
14440 relocation.  @option{-mno-error-reloc} disables the error,
14441 @option{-mwarn-reloc} will generate a warning instead.
14443 @item -msafe-dma
14444 @itemx -munsafe-dma
14445 @opindex msafe-dma
14446 @opindex munsafe-dma
14448 Instructions which initiate or test completion of DMA must not be
14449 reordered with respect to loads and stores of the memory which is being
14450 accessed.  Users typically address this problem using the volatile
14451 keyword, but that can lead to inefficient code in places where the
14452 memory is known to not change.  Rather than mark the memory as volatile
14453 we treat the DMA instructions as potentially effecting all memory.  With
14454 @option{-munsafe-dma} users must use the volatile keyword to protect
14455 memory accesses.
14457 @item -mbranch-hints
14458 @opindex mbranch-hints
14460 By default, GCC will generate a branch hint instruction to avoid
14461 pipeline stalls for always taken or probably taken branches.  A hint
14462 will not be generated closer than 8 instructions away from its branch.
14463 There is little reason to disable them, except for debugging purposes,
14464 or to make an object a little bit smaller.
14466 @item -msmall-mem
14467 @itemx -mlarge-mem
14468 @opindex msmall-mem
14469 @opindex mlarge-mem
14471 By default, GCC generates code assuming that addresses are never larger
14472 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14473 a full 32 bit address.
14475 @item -mstdmain
14476 @opindex mstdmain
14478 By default, GCC links against startup code that assumes the SPU-style
14479 main function interface (which has an unconventional parameter list).
14480 With @option{-mstdmain}, GCC will link your program against startup
14481 code that assumes a C99-style interface to @code{main}, including a
14482 local copy of @code{argv} strings.
14484 @item -mfixed-range=@var{register-range}
14485 @opindex mfixed-range
14486 Generate code treating the given register range as fixed registers.
14487 A fixed register is one that the register allocator can not use.  This is
14488 useful when compiling kernel code.  A register range is specified as
14489 two registers separated by a dash.  Multiple register ranges can be
14490 specified separated by a comma.
14492 @end table
14494 @node System V Options
14495 @subsection Options for System V
14497 These additional options are available on System V Release 4 for
14498 compatibility with other compilers on those systems:
14500 @table @gcctabopt
14501 @item -G
14502 @opindex G
14503 Create a shared object.
14504 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14506 @item -Qy
14507 @opindex Qy
14508 Identify the versions of each tool used by the compiler, in a
14509 @code{.ident} assembler directive in the output.
14511 @item -Qn
14512 @opindex Qn
14513 Refrain from adding @code{.ident} directives to the output file (this is
14514 the default).
14516 @item -YP,@var{dirs}
14517 @opindex YP
14518 Search the directories @var{dirs}, and no others, for libraries
14519 specified with @option{-l}.
14521 @item -Ym,@var{dir}
14522 @opindex Ym
14523 Look in the directory @var{dir} to find the M4 preprocessor.
14524 The assembler uses this option.
14525 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14526 @c the generic assembler that comes with Solaris takes just -Ym.
14527 @end table
14529 @node V850 Options
14530 @subsection V850 Options
14531 @cindex V850 Options
14533 These @samp{-m} options are defined for V850 implementations:
14535 @table @gcctabopt
14536 @item -mlong-calls
14537 @itemx -mno-long-calls
14538 @opindex mlong-calls
14539 @opindex mno-long-calls
14540 Treat all calls as being far away (near).  If calls are assumed to be
14541 far away, the compiler will always load the functions address up into a
14542 register, and call indirect through the pointer.
14544 @item -mno-ep
14545 @itemx -mep
14546 @opindex mno-ep
14547 @opindex mep
14548 Do not optimize (do optimize) basic blocks that use the same index
14549 pointer 4 or more times to copy pointer into the @code{ep} register, and
14550 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14551 option is on by default if you optimize.
14553 @item -mno-prolog-function
14554 @itemx -mprolog-function
14555 @opindex mno-prolog-function
14556 @opindex mprolog-function
14557 Do not use (do use) external functions to save and restore registers
14558 at the prologue and epilogue of a function.  The external functions
14559 are slower, but use less code space if more than one function saves
14560 the same number of registers.  The @option{-mprolog-function} option
14561 is on by default if you optimize.
14563 @item -mspace
14564 @opindex mspace
14565 Try to make the code as small as possible.  At present, this just turns
14566 on the @option{-mep} and @option{-mprolog-function} options.
14568 @item -mtda=@var{n}
14569 @opindex mtda
14570 Put static or global variables whose size is @var{n} bytes or less into
14571 the tiny data area that register @code{ep} points to.  The tiny data
14572 area can hold up to 256 bytes in total (128 bytes for byte references).
14574 @item -msda=@var{n}
14575 @opindex msda
14576 Put static or global variables whose size is @var{n} bytes or less into
14577 the small data area that register @code{gp} points to.  The small data
14578 area can hold up to 64 kilobytes.
14580 @item -mzda=@var{n}
14581 @opindex mzda
14582 Put static or global variables whose size is @var{n} bytes or less into
14583 the first 32 kilobytes of memory.
14585 @item -mv850
14586 @opindex mv850
14587 Specify that the target processor is the V850.
14589 @item -mbig-switch
14590 @opindex mbig-switch
14591 Generate code suitable for big switch tables.  Use this option only if
14592 the assembler/linker complain about out of range branches within a switch
14593 table.
14595 @item -mapp-regs
14596 @opindex mapp-regs
14597 This option will cause r2 and r5 to be used in the code generated by
14598 the compiler.  This setting is the default.
14600 @item -mno-app-regs
14601 @opindex mno-app-regs
14602 This option will cause r2 and r5 to be treated as fixed registers.
14604 @item -mv850e1
14605 @opindex mv850e1
14606 Specify that the target processor is the V850E1.  The preprocessor
14607 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14608 this option is used.
14610 @item -mv850e
14611 @opindex mv850e
14612 Specify that the target processor is the V850E@.  The preprocessor
14613 constant @samp{__v850e__} will be defined if this option is used.
14615 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14616 are defined then a default target processor will be chosen and the
14617 relevant @samp{__v850*__} preprocessor constant will be defined.
14619 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14620 defined, regardless of which processor variant is the target.
14622 @item -mdisable-callt
14623 @opindex mdisable-callt
14624 This option will suppress generation of the CALLT instruction for the
14625 v850e and v850e1 flavors of the v850 architecture.  The default is
14626 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14628 @end table
14630 @node VAX Options
14631 @subsection VAX Options
14632 @cindex VAX options
14634 These @samp{-m} options are defined for the VAX:
14636 @table @gcctabopt
14637 @item -munix
14638 @opindex munix
14639 Do not output certain jump instructions (@code{aobleq} and so on)
14640 that the Unix assembler for the VAX cannot handle across long
14641 ranges.
14643 @item -mgnu
14644 @opindex mgnu
14645 Do output those jump instructions, on the assumption that you
14646 will assemble with the GNU assembler.
14648 @item -mg
14649 @opindex mg
14650 Output code for g-format floating point numbers instead of d-format.
14651 @end table
14653 @node VxWorks Options
14654 @subsection VxWorks Options
14655 @cindex VxWorks Options
14657 The options in this section are defined for all VxWorks targets.
14658 Options specific to the target hardware are listed with the other
14659 options for that target.
14661 @table @gcctabopt
14662 @item -mrtp
14663 @opindex mrtp
14664 GCC can generate code for both VxWorks kernels and real time processes
14665 (RTPs).  This option switches from the former to the latter.  It also
14666 defines the preprocessor macro @code{__RTP__}.
14668 @item -non-static
14669 @opindex non-static
14670 Link an RTP executable against shared libraries rather than static
14671 libraries.  The options @option{-static} and @option{-shared} can
14672 also be used for RTPs (@pxref{Link Options}); @option{-static}
14673 is the default.
14675 @item -Bstatic
14676 @itemx -Bdynamic
14677 @opindex Bstatic
14678 @opindex Bdynamic
14679 These options are passed down to the linker.  They are defined for
14680 compatibility with Diab.
14682 @item -Xbind-lazy
14683 @opindex Xbind-lazy
14684 Enable lazy binding of function calls.  This option is equivalent to
14685 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14687 @item -Xbind-now
14688 @opindex Xbind-now
14689 Disable lazy binding of function calls.  This option is the default and
14690 is defined for compatibility with Diab.
14691 @end table
14693 @node x86-64 Options
14694 @subsection x86-64 Options
14695 @cindex x86-64 options
14697 These are listed under @xref{i386 and x86-64 Options}.
14699 @node Xstormy16 Options
14700 @subsection Xstormy16 Options
14701 @cindex Xstormy16 Options
14703 These options are defined for Xstormy16:
14705 @table @gcctabopt
14706 @item -msim
14707 @opindex msim
14708 Choose startup files and linker script suitable for the simulator.
14709 @end table
14711 @node Xtensa Options
14712 @subsection Xtensa Options
14713 @cindex Xtensa Options
14715 These options are supported for Xtensa targets:
14717 @table @gcctabopt
14718 @item -mconst16
14719 @itemx -mno-const16
14720 @opindex mconst16
14721 @opindex mno-const16
14722 Enable or disable use of @code{CONST16} instructions for loading
14723 constant values.  The @code{CONST16} instruction is currently not a
14724 standard option from Tensilica.  When enabled, @code{CONST16}
14725 instructions are always used in place of the standard @code{L32R}
14726 instructions.  The use of @code{CONST16} is enabled by default only if
14727 the @code{L32R} instruction is not available.
14729 @item -mfused-madd
14730 @itemx -mno-fused-madd
14731 @opindex mfused-madd
14732 @opindex mno-fused-madd
14733 Enable or disable use of fused multiply/add and multiply/subtract
14734 instructions in the floating-point option.  This has no effect if the
14735 floating-point option is not also enabled.  Disabling fused multiply/add
14736 and multiply/subtract instructions forces the compiler to use separate
14737 instructions for the multiply and add/subtract operations.  This may be
14738 desirable in some cases where strict IEEE 754-compliant results are
14739 required: the fused multiply add/subtract instructions do not round the
14740 intermediate result, thereby producing results with @emph{more} bits of
14741 precision than specified by the IEEE standard.  Disabling fused multiply
14742 add/subtract instructions also ensures that the program output is not
14743 sensitive to the compiler's ability to combine multiply and add/subtract
14744 operations.
14746 @item -mserialize-volatile
14747 @itemx -mno-serialize-volatile
14748 @opindex mserialize-volatile
14749 @opindex mno-serialize-volatile
14750 When this option is enabled, GCC inserts @code{MEMW} instructions before
14751 @code{volatile} memory references to guarantee sequential consistency.
14752 The default is @option{-mserialize-volatile}.  Use
14753 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14755 @item -mtext-section-literals
14756 @itemx -mno-text-section-literals
14757 @opindex mtext-section-literals
14758 @opindex mno-text-section-literals
14759 Control the treatment of literal pools.  The default is
14760 @option{-mno-text-section-literals}, which places literals in a separate
14761 section in the output file.  This allows the literal pool to be placed
14762 in a data RAM/ROM, and it also allows the linker to combine literal
14763 pools from separate object files to remove redundant literals and
14764 improve code size.  With @option{-mtext-section-literals}, the literals
14765 are interspersed in the text section in order to keep them as close as
14766 possible to their references.  This may be necessary for large assembly
14767 files.
14769 @item -mtarget-align
14770 @itemx -mno-target-align
14771 @opindex mtarget-align
14772 @opindex mno-target-align
14773 When this option is enabled, GCC instructs the assembler to
14774 automatically align instructions to reduce branch penalties at the
14775 expense of some code density.  The assembler attempts to widen density
14776 instructions to align branch targets and the instructions following call
14777 instructions.  If there are not enough preceding safe density
14778 instructions to align a target, no widening will be performed.  The
14779 default is @option{-mtarget-align}.  These options do not affect the
14780 treatment of auto-aligned instructions like @code{LOOP}, which the
14781 assembler will always align, either by widening density instructions or
14782 by inserting no-op instructions.
14784 @item -mlongcalls
14785 @itemx -mno-longcalls
14786 @opindex mlongcalls
14787 @opindex mno-longcalls
14788 When this option is enabled, GCC instructs the assembler to translate
14789 direct calls to indirect calls unless it can determine that the target
14790 of a direct call is in the range allowed by the call instruction.  This
14791 translation typically occurs for calls to functions in other source
14792 files.  Specifically, the assembler translates a direct @code{CALL}
14793 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14794 The default is @option{-mno-longcalls}.  This option should be used in
14795 programs where the call target can potentially be out of range.  This
14796 option is implemented in the assembler, not the compiler, so the
14797 assembly code generated by GCC will still show direct call
14798 instructions---look at the disassembled object code to see the actual
14799 instructions.  Note that the assembler will use an indirect call for
14800 every cross-file call, not just those that really will be out of range.
14801 @end table
14803 @node zSeries Options
14804 @subsection zSeries Options
14805 @cindex zSeries options
14807 These are listed under @xref{S/390 and zSeries Options}.
14809 @node Code Gen Options
14810 @section Options for Code Generation Conventions
14811 @cindex code generation conventions
14812 @cindex options, code generation
14813 @cindex run-time options
14815 These machine-independent options control the interface conventions
14816 used in code generation.
14818 Most of them have both positive and negative forms; the negative form
14819 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14820 one of the forms is listed---the one which is not the default.  You
14821 can figure out the other form by either removing @samp{no-} or adding
14824 @table @gcctabopt
14825 @item -fbounds-check
14826 @opindex fbounds-check
14827 For front-ends that support it, generate additional code to check that
14828 indices used to access arrays are within the declared range.  This is
14829 currently only supported by the Java and Fortran front-ends, where
14830 this option defaults to true and false respectively.
14832 @item -ftrapv
14833 @opindex ftrapv
14834 This option generates traps for signed overflow on addition, subtraction,
14835 multiplication operations.
14837 @item -fwrapv
14838 @opindex fwrapv
14839 This option instructs the compiler to assume that signed arithmetic
14840 overflow of addition, subtraction and multiplication wraps around
14841 using twos-complement representation.  This flag enables some optimizations
14842 and disables others.  This option is enabled by default for the Java
14843 front-end, as required by the Java language specification.
14845 @item -fexceptions
14846 @opindex fexceptions
14847 Enable exception handling.  Generates extra code needed to propagate
14848 exceptions.  For some targets, this implies GCC will generate frame
14849 unwind information for all functions, which can produce significant data
14850 size overhead, although it does not affect execution.  If you do not
14851 specify this option, GCC will enable it by default for languages like
14852 C++ which normally require exception handling, and disable it for
14853 languages like C that do not normally require it.  However, you may need
14854 to enable this option when compiling C code that needs to interoperate
14855 properly with exception handlers written in C++.  You may also wish to
14856 disable this option if you are compiling older C++ programs that don't
14857 use exception handling.
14859 @item -fnon-call-exceptions
14860 @opindex fnon-call-exceptions
14861 Generate code that allows trapping instructions to throw exceptions.
14862 Note that this requires platform-specific runtime support that does
14863 not exist everywhere.  Moreover, it only allows @emph{trapping}
14864 instructions to throw exceptions, i.e.@: memory references or floating
14865 point instructions.  It does not allow exceptions to be thrown from
14866 arbitrary signal handlers such as @code{SIGALRM}.
14868 @item -funwind-tables
14869 @opindex funwind-tables
14870 Similar to @option{-fexceptions}, except that it will just generate any needed
14871 static data, but will not affect the generated code in any other way.
14872 You will normally not enable this option; instead, a language processor
14873 that needs this handling would enable it on your behalf.
14875 @item -fasynchronous-unwind-tables
14876 @opindex fasynchronous-unwind-tables
14877 Generate unwind table in dwarf2 format, if supported by target machine.  The
14878 table is exact at each instruction boundary, so it can be used for stack
14879 unwinding from asynchronous events (such as debugger or garbage collector).
14881 @item -fpcc-struct-return
14882 @opindex fpcc-struct-return
14883 Return ``short'' @code{struct} and @code{union} values in memory like
14884 longer ones, rather than in registers.  This convention is less
14885 efficient, but it has the advantage of allowing intercallability between
14886 GCC-compiled files and files compiled with other compilers, particularly
14887 the Portable C Compiler (pcc).
14889 The precise convention for returning structures in memory depends
14890 on the target configuration macros.
14892 Short structures and unions are those whose size and alignment match
14893 that of some integer type.
14895 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14896 switch is not binary compatible with code compiled with the
14897 @option{-freg-struct-return} switch.
14898 Use it to conform to a non-default application binary interface.
14900 @item -freg-struct-return
14901 @opindex freg-struct-return
14902 Return @code{struct} and @code{union} values in registers when possible.
14903 This is more efficient for small structures than
14904 @option{-fpcc-struct-return}.
14906 If you specify neither @option{-fpcc-struct-return} nor
14907 @option{-freg-struct-return}, GCC defaults to whichever convention is
14908 standard for the target.  If there is no standard convention, GCC
14909 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14910 the principal compiler.  In those cases, we can choose the standard, and
14911 we chose the more efficient register return alternative.
14913 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14914 switch is not binary compatible with code compiled with the
14915 @option{-fpcc-struct-return} switch.
14916 Use it to conform to a non-default application binary interface.
14918 @item -fshort-enums
14919 @opindex fshort-enums
14920 Allocate to an @code{enum} type only as many bytes as it needs for the
14921 declared range of possible values.  Specifically, the @code{enum} type
14922 will be equivalent to the smallest integer type which has enough room.
14924 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14925 code that is not binary compatible with code generated without that switch.
14926 Use it to conform to a non-default application binary interface.
14928 @item -fshort-double
14929 @opindex fshort-double
14930 Use the same size for @code{double} as for @code{float}.
14932 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14933 code that is not binary compatible with code generated without that switch.
14934 Use it to conform to a non-default application binary interface.
14936 @item -fshort-wchar
14937 @opindex fshort-wchar
14938 Override the underlying type for @samp{wchar_t} to be @samp{short
14939 unsigned int} instead of the default for the target.  This option is
14940 useful for building programs to run under WINE@.
14942 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14943 code that is not binary compatible with code generated without that switch.
14944 Use it to conform to a non-default application binary interface.
14946 @item -fno-common
14947 @opindex fno-common
14948 In C, allocate even uninitialized global variables in the data section of the
14949 object file, rather than generating them as common blocks.  This has the
14950 effect that if the same variable is declared (without @code{extern}) in
14951 two different compilations, you will get an error when you link them.
14952 The only reason this might be useful is if you wish to verify that the
14953 program will work on other systems which always work this way.
14955 @item -fno-ident
14956 @opindex fno-ident
14957 Ignore the @samp{#ident} directive.
14959 @item -finhibit-size-directive
14960 @opindex finhibit-size-directive
14961 Don't output a @code{.size} assembler directive, or anything else that
14962 would cause trouble if the function is split in the middle, and the
14963 two halves are placed at locations far apart in memory.  This option is
14964 used when compiling @file{crtstuff.c}; you should not need to use it
14965 for anything else.
14967 @item -fverbose-asm
14968 @opindex fverbose-asm
14969 Put extra commentary information in the generated assembly code to
14970 make it more readable.  This option is generally only of use to those
14971 who actually need to read the generated assembly code (perhaps while
14972 debugging the compiler itself).
14974 @option{-fno-verbose-asm}, the default, causes the
14975 extra information to be omitted and is useful when comparing two assembler
14976 files.
14978 @item -frecord-gcc-switches
14979 @opindex frecord-gcc-switches
14980 This switch causes the command line that was used to invoke the
14981 compiler to be recorded into the object file that is being created.
14982 This switch is only implemented on some targets and the exact format
14983 of the recording is target and binary file format dependent, but it
14984 usually takes the form of a section containing ASCII text.  This
14985 switch is related to the @option{-fverbose-asm} switch, but that
14986 switch only records information in the assembler output file as
14987 comments, so it never reaches the object file.
14989 @item -fpic
14990 @opindex fpic
14991 @cindex global offset table
14992 @cindex PIC
14993 Generate position-independent code (PIC) suitable for use in a shared
14994 library, if supported for the target machine.  Such code accesses all
14995 constant addresses through a global offset table (GOT)@.  The dynamic
14996 loader resolves the GOT entries when the program starts (the dynamic
14997 loader is not part of GCC; it is part of the operating system).  If
14998 the GOT size for the linked executable exceeds a machine-specific
14999 maximum size, you get an error message from the linker indicating that
15000 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15001 instead.  (These maximums are 8k on the SPARC and 32k
15002 on the m68k and RS/6000.  The 386 has no such limit.)
15004 Position-independent code requires special support, and therefore works
15005 only on certain machines.  For the 386, GCC supports PIC for System V
15006 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15007 position-independent.
15009 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15010 are defined to 1.
15012 @item -fPIC
15013 @opindex fPIC
15014 If supported for the target machine, emit position-independent code,
15015 suitable for dynamic linking and avoiding any limit on the size of the
15016 global offset table.  This option makes a difference on the m68k,
15017 PowerPC and SPARC@.
15019 Position-independent code requires special support, and therefore works
15020 only on certain machines.
15022 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15023 are defined to 2.
15025 @item -fpie
15026 @itemx -fPIE
15027 @opindex fpie
15028 @opindex fPIE
15029 These options are similar to @option{-fpic} and @option{-fPIC}, but
15030 generated position independent code can be only linked into executables.
15031 Usually these options are used when @option{-pie} GCC option will be
15032 used during linking.
15034 @option{-fpie} and @option{-fPIE} both define the macros
15035 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15036 for @option{-fpie} and 2 for @option{-fPIE}.
15038 @item -fno-jump-tables
15039 @opindex fno-jump-tables
15040 Do not use jump tables for switch statements even where it would be
15041 more efficient than other code generation strategies.  This option is
15042 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15043 building code which forms part of a dynamic linker and cannot
15044 reference the address of a jump table.  On some targets, jump tables
15045 do not require a GOT and this option is not needed.
15047 @item -ffixed-@var{reg}
15048 @opindex ffixed
15049 Treat the register named @var{reg} as a fixed register; generated code
15050 should never refer to it (except perhaps as a stack pointer, frame
15051 pointer or in some other fixed role).
15053 @var{reg} must be the name of a register.  The register names accepted
15054 are machine-specific and are defined in the @code{REGISTER_NAMES}
15055 macro in the machine description macro file.
15057 This flag does not have a negative form, because it specifies a
15058 three-way choice.
15060 @item -fcall-used-@var{reg}
15061 @opindex fcall-used
15062 Treat the register named @var{reg} as an allocable register that is
15063 clobbered by function calls.  It may be allocated for temporaries or
15064 variables that do not live across a call.  Functions compiled this way
15065 will not save and restore the register @var{reg}.
15067 It is an error to used this flag with the frame pointer or stack pointer.
15068 Use of this flag for other registers that have fixed pervasive roles in
15069 the machine's execution model will produce disastrous results.
15071 This flag does not have a negative form, because it specifies a
15072 three-way choice.
15074 @item -fcall-saved-@var{reg}
15075 @opindex fcall-saved
15076 Treat the register named @var{reg} as an allocable register saved by
15077 functions.  It may be allocated even for temporaries or variables that
15078 live across a call.  Functions compiled this way will save and restore
15079 the register @var{reg} if they use it.
15081 It is an error to used this flag with the frame pointer or stack pointer.
15082 Use of this flag for other registers that have fixed pervasive roles in
15083 the machine's execution model will produce disastrous results.
15085 A different sort of disaster will result from the use of this flag for
15086 a register in which function values may be returned.
15088 This flag does not have a negative form, because it specifies a
15089 three-way choice.
15091 @item -fpack-struct[=@var{n}]
15092 @opindex fpack-struct
15093 Without a value specified, pack all structure members together without
15094 holes.  When a value is specified (which must be a small power of two), pack
15095 structure members according to this value, representing the maximum
15096 alignment (that is, objects with default alignment requirements larger than
15097 this will be output potentially unaligned at the next fitting location.
15099 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15100 code that is not binary compatible with code generated without that switch.
15101 Additionally, it makes the code suboptimal.
15102 Use it to conform to a non-default application binary interface.
15104 @item -finstrument-functions
15105 @opindex finstrument-functions
15106 Generate instrumentation calls for entry and exit to functions.  Just
15107 after function entry and just before function exit, the following
15108 profiling functions will be called with the address of the current
15109 function and its call site.  (On some platforms,
15110 @code{__builtin_return_address} does not work beyond the current
15111 function, so the call site information may not be available to the
15112 profiling functions otherwise.)
15114 @smallexample
15115 void __cyg_profile_func_enter (void *this_fn,
15116                                void *call_site);
15117 void __cyg_profile_func_exit  (void *this_fn,
15118                                void *call_site);
15119 @end smallexample
15121 The first argument is the address of the start of the current function,
15122 which may be looked up exactly in the symbol table.
15124 This instrumentation is also done for functions expanded inline in other
15125 functions.  The profiling calls will indicate where, conceptually, the
15126 inline function is entered and exited.  This means that addressable
15127 versions of such functions must be available.  If all your uses of a
15128 function are expanded inline, this may mean an additional expansion of
15129 code size.  If you use @samp{extern inline} in your C code, an
15130 addressable version of such functions must be provided.  (This is
15131 normally the case anyways, but if you get lucky and the optimizer always
15132 expands the functions inline, you might have gotten away without
15133 providing static copies.)
15135 A function may be given the attribute @code{no_instrument_function}, in
15136 which case this instrumentation will not be done.  This can be used, for
15137 example, for the profiling functions listed above, high-priority
15138 interrupt routines, and any functions from which the profiling functions
15139 cannot safely be called (perhaps signal handlers, if the profiling
15140 routines generate output or allocate memory).
15142 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15143 @opindex finstrument-functions-exclude-file-list
15145 Set the list of functions that are excluded from instrumentation (see
15146 the description of @code{-finstrument-functions}).  If the file that
15147 contains a function definition matches with one of @var{file}, then
15148 that function is not instrumented.  The match is done on substrings:
15149 if the @var{file} parameter is a substring of the file name, it is
15150 considered to be a match.
15152 For example,
15153 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15154 will exclude any inline function defined in files whose pathnames
15155 contain @code{/bits/stl} or @code{include/sys}.
15157 If, for some reason, you want to include letter @code{','} in one of
15158 @var{sym}, write @code{'\,'}. For example,
15159 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15160 (note the single quote surrounding the option).
15162 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15163 @opindex finstrument-functions-exclude-function-list
15165 This is similar to @code{-finstrument-functions-exclude-file-list},
15166 but this option sets the list of function names to be excluded from
15167 instrumentation.  The function name to be matched is its user-visible
15168 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15169 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15170 match is done on substrings: if the @var{sym} parameter is a substring
15171 of the function name, it is considered to be a match.
15173 @item -fstack-check
15174 @opindex fstack-check
15175 Generate code to verify that you do not go beyond the boundary of the
15176 stack.  You should specify this flag if you are running in an
15177 environment with multiple threads, but only rarely need to specify it in
15178 a single-threaded environment since stack overflow is automatically
15179 detected on nearly all systems if there is only one stack.
15181 Note that this switch does not actually cause checking to be done; the
15182 operating system must do that.  The switch causes generation of code
15183 to ensure that the operating system sees the stack being extended.
15185 @item -fstack-limit-register=@var{reg}
15186 @itemx -fstack-limit-symbol=@var{sym}
15187 @itemx -fno-stack-limit
15188 @opindex fstack-limit-register
15189 @opindex fstack-limit-symbol
15190 @opindex fno-stack-limit
15191 Generate code to ensure that the stack does not grow beyond a certain value,
15192 either the value of a register or the address of a symbol.  If the stack
15193 would grow beyond the value, a signal is raised.  For most targets,
15194 the signal is raised before the stack overruns the boundary, so
15195 it is possible to catch the signal without taking special precautions.
15197 For instance, if the stack starts at absolute address @samp{0x80000000}
15198 and grows downwards, you can use the flags
15199 @option{-fstack-limit-symbol=__stack_limit} and
15200 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15201 of 128KB@.  Note that this may only work with the GNU linker.
15203 @cindex aliasing of parameters
15204 @cindex parameters, aliased
15205 @item -fargument-alias
15206 @itemx -fargument-noalias
15207 @itemx -fargument-noalias-global
15208 @itemx -fargument-noalias-anything
15209 @opindex fargument-alias
15210 @opindex fargument-noalias
15211 @opindex fargument-noalias-global
15212 @opindex fargument-noalias-anything
15213 Specify the possible relationships among parameters and between
15214 parameters and global data.
15216 @option{-fargument-alias} specifies that arguments (parameters) may
15217 alias each other and may alias global storage.@*
15218 @option{-fargument-noalias} specifies that arguments do not alias
15219 each other, but may alias global storage.@*
15220 @option{-fargument-noalias-global} specifies that arguments do not
15221 alias each other and do not alias global storage.
15222 @option{-fargument-noalias-anything} specifies that arguments do not
15223 alias any other storage.
15225 Each language will automatically use whatever option is required by
15226 the language standard.  You should not need to use these options yourself.
15228 @item -fleading-underscore
15229 @opindex fleading-underscore
15230 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15231 change the way C symbols are represented in the object file.  One use
15232 is to help link with legacy assembly code.
15234 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15235 generate code that is not binary compatible with code generated without that
15236 switch.  Use it to conform to a non-default application binary interface.
15237 Not all targets provide complete support for this switch.
15239 @item -ftls-model=@var{model}
15240 @opindex ftls-model
15241 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15242 The @var{model} argument should be one of @code{global-dynamic},
15243 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15245 The default without @option{-fpic} is @code{initial-exec}; with
15246 @option{-fpic} the default is @code{global-dynamic}.
15248 @item -fvisibility=@var{default|internal|hidden|protected}
15249 @opindex fvisibility
15250 Set the default ELF image symbol visibility to the specified option---all
15251 symbols will be marked with this unless overridden within the code.
15252 Using this feature can very substantially improve linking and
15253 load times of shared object libraries, produce more optimized
15254 code, provide near-perfect API export and prevent symbol clashes.
15255 It is @strong{strongly} recommended that you use this in any shared objects
15256 you distribute.
15258 Despite the nomenclature, @code{default} always means public ie;
15259 available to be linked against from outside the shared object.
15260 @code{protected} and @code{internal} are pretty useless in real-world
15261 usage so the only other commonly used option will be @code{hidden}.
15262 The default if @option{-fvisibility} isn't specified is
15263 @code{default}, i.e., make every
15264 symbol public---this causes the same behavior as previous versions of
15265 GCC@.
15267 A good explanation of the benefits offered by ensuring ELF
15268 symbols have the correct visibility is given by ``How To Write
15269 Shared Libraries'' by Ulrich Drepper (which can be found at
15270 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15271 solution made possible by this option to marking things hidden when
15272 the default is public is to make the default hidden and mark things
15273 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15274 and @code{__attribute__ ((visibility("default")))} instead of
15275 @code{__declspec(dllexport)} you get almost identical semantics with
15276 identical syntax.  This is a great boon to those working with
15277 cross-platform projects.
15279 For those adding visibility support to existing code, you may find
15280 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15281 the declarations you wish to set visibility for with (for example)
15282 @samp{#pragma GCC visibility push(hidden)} and
15283 @samp{#pragma GCC visibility pop}.
15284 Bear in mind that symbol visibility should be viewed @strong{as
15285 part of the API interface contract} and thus all new code should
15286 always specify visibility when it is not the default ie; declarations
15287 only for use within the local DSO should @strong{always} be marked explicitly
15288 as hidden as so to avoid PLT indirection overheads---making this
15289 abundantly clear also aids readability and self-documentation of the code.
15290 Note that due to ISO C++ specification requirements, operator new and
15291 operator delete must always be of default visibility.
15293 Be aware that headers from outside your project, in particular system
15294 headers and headers from any other library you use, may not be
15295 expecting to be compiled with visibility other than the default.  You
15296 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15297 before including any such headers.
15299 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15300 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15301 no modifications.  However, this means that calls to @samp{extern}
15302 functions with no explicit visibility will use the PLT, so it is more
15303 effective to use @samp{__attribute ((visibility))} and/or
15304 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15305 declarations should be treated as hidden.
15307 Note that @samp{-fvisibility} does affect C++ vague linkage
15308 entities. This means that, for instance, an exception class that will
15309 be thrown between DSOs must be explicitly marked with default
15310 visibility so that the @samp{type_info} nodes will be unified between
15311 the DSOs.
15313 An overview of these techniques, their benefits and how to use them
15314 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15316 @end table
15318 @c man end
15320 @node Environment Variables
15321 @section Environment Variables Affecting GCC
15322 @cindex environment variables
15324 @c man begin ENVIRONMENT
15325 This section describes several environment variables that affect how GCC
15326 operates.  Some of them work by specifying directories or prefixes to use
15327 when searching for various kinds of files.  Some are used to specify other
15328 aspects of the compilation environment.
15330 Note that you can also specify places to search using options such as
15331 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15332 take precedence over places specified using environment variables, which
15333 in turn take precedence over those specified by the configuration of GCC@.
15334 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15335 GNU Compiler Collection (GCC) Internals}.
15337 @table @env
15338 @item LANG
15339 @itemx LC_CTYPE
15340 @c @itemx LC_COLLATE
15341 @itemx LC_MESSAGES
15342 @c @itemx LC_MONETARY
15343 @c @itemx LC_NUMERIC
15344 @c @itemx LC_TIME
15345 @itemx LC_ALL
15346 @findex LANG
15347 @findex LC_CTYPE
15348 @c @findex LC_COLLATE
15349 @findex LC_MESSAGES
15350 @c @findex LC_MONETARY
15351 @c @findex LC_NUMERIC
15352 @c @findex LC_TIME
15353 @findex LC_ALL
15354 @cindex locale
15355 These environment variables control the way that GCC uses
15356 localization information that allow GCC to work with different
15357 national conventions.  GCC inspects the locale categories
15358 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15359 so.  These locale categories can be set to any value supported by your
15360 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15361 Kingdom encoded in UTF-8.
15363 The @env{LC_CTYPE} environment variable specifies character
15364 classification.  GCC uses it to determine the character boundaries in
15365 a string; this is needed for some multibyte encodings that contain quote
15366 and escape characters that would otherwise be interpreted as a string
15367 end or escape.
15369 The @env{LC_MESSAGES} environment variable specifies the language to
15370 use in diagnostic messages.
15372 If the @env{LC_ALL} environment variable is set, it overrides the value
15373 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15374 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15375 environment variable.  If none of these variables are set, GCC
15376 defaults to traditional C English behavior.
15378 @item TMPDIR
15379 @findex TMPDIR
15380 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15381 files.  GCC uses temporary files to hold the output of one stage of
15382 compilation which is to be used as input to the next stage: for example,
15383 the output of the preprocessor, which is the input to the compiler
15384 proper.
15386 @item GCC_EXEC_PREFIX
15387 @findex GCC_EXEC_PREFIX
15388 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15389 names of the subprograms executed by the compiler.  No slash is added
15390 when this prefix is combined with the name of a subprogram, but you can
15391 specify a prefix that ends with a slash if you wish.
15393 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15394 an appropriate prefix to use based on the pathname it was invoked with.
15396 If GCC cannot find the subprogram using the specified prefix, it
15397 tries looking in the usual places for the subprogram.
15399 The default value of @env{GCC_EXEC_PREFIX} is
15400 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15401 the installed compiler. In many cases @var{prefix} is the value
15402 of @code{prefix} when you ran the @file{configure} script.
15404 Other prefixes specified with @option{-B} take precedence over this prefix.
15406 This prefix is also used for finding files such as @file{crt0.o} that are
15407 used for linking.
15409 In addition, the prefix is used in an unusual way in finding the
15410 directories to search for header files.  For each of the standard
15411 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15412 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15413 replacing that beginning with the specified prefix to produce an
15414 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15415 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15416 These alternate directories are searched first; the standard directories
15417 come next. If a standard directory begins with the configured
15418 @var{prefix} then the value of @var{prefix} is replaced by
15419 @env{GCC_EXEC_PREFIX} when looking for header files.
15421 @item COMPILER_PATH
15422 @findex COMPILER_PATH
15423 The value of @env{COMPILER_PATH} is a colon-separated list of
15424 directories, much like @env{PATH}.  GCC tries the directories thus
15425 specified when searching for subprograms, if it can't find the
15426 subprograms using @env{GCC_EXEC_PREFIX}.
15428 @item LIBRARY_PATH
15429 @findex LIBRARY_PATH
15430 The value of @env{LIBRARY_PATH} is a colon-separated list of
15431 directories, much like @env{PATH}.  When configured as a native compiler,
15432 GCC tries the directories thus specified when searching for special
15433 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15434 using GCC also uses these directories when searching for ordinary
15435 libraries for the @option{-l} option (but directories specified with
15436 @option{-L} come first).
15438 @item LANG
15439 @findex LANG
15440 @cindex locale definition
15441 This variable is used to pass locale information to the compiler.  One way in
15442 which this information is used is to determine the character set to be used
15443 when character literals, string literals and comments are parsed in C and C++.
15444 When the compiler is configured to allow multibyte characters,
15445 the following values for @env{LANG} are recognized:
15447 @table @samp
15448 @item C-JIS
15449 Recognize JIS characters.
15450 @item C-SJIS
15451 Recognize SJIS characters.
15452 @item C-EUCJP
15453 Recognize EUCJP characters.
15454 @end table
15456 If @env{LANG} is not defined, or if it has some other value, then the
15457 compiler will use mblen and mbtowc as defined by the default locale to
15458 recognize and translate multibyte characters.
15459 @end table
15461 @noindent
15462 Some additional environments variables affect the behavior of the
15463 preprocessor.
15465 @include cppenv.texi
15467 @c man end
15469 @node Precompiled Headers
15470 @section Using Precompiled Headers
15471 @cindex precompiled headers
15472 @cindex speed of compilation
15474 Often large projects have many header files that are included in every
15475 source file.  The time the compiler takes to process these header files
15476 over and over again can account for nearly all of the time required to
15477 build the project.  To make builds faster, GCC allows users to
15478 `precompile' a header file; then, if builds can use the precompiled
15479 header file they will be much faster.
15481 To create a precompiled header file, simply compile it as you would any
15482 other file, if necessary using the @option{-x} option to make the driver
15483 treat it as a C or C++ header file.  You will probably want to use a
15484 tool like @command{make} to keep the precompiled header up-to-date when
15485 the headers it contains change.
15487 A precompiled header file will be searched for when @code{#include} is
15488 seen in the compilation.  As it searches for the included file
15489 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15490 compiler looks for a precompiled header in each directory just before it
15491 looks for the include file in that directory.  The name searched for is
15492 the name specified in the @code{#include} with @samp{.gch} appended.  If
15493 the precompiled header file can't be used, it is ignored.
15495 For instance, if you have @code{#include "all.h"}, and you have
15496 @file{all.h.gch} in the same directory as @file{all.h}, then the
15497 precompiled header file will be used if possible, and the original
15498 header will be used otherwise.
15500 Alternatively, you might decide to put the precompiled header file in a
15501 directory and use @option{-I} to ensure that directory is searched
15502 before (or instead of) the directory containing the original header.
15503 Then, if you want to check that the precompiled header file is always
15504 used, you can put a file of the same name as the original header in this
15505 directory containing an @code{#error} command.
15507 This also works with @option{-include}.  So yet another way to use
15508 precompiled headers, good for projects not designed with precompiled
15509 header files in mind, is to simply take most of the header files used by
15510 a project, include them from another header file, precompile that header
15511 file, and @option{-include} the precompiled header.  If the header files
15512 have guards against multiple inclusion, they will be skipped because
15513 they've already been included (in the precompiled header).
15515 If you need to precompile the same header file for different
15516 languages, targets, or compiler options, you can instead make a
15517 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15518 header in the directory, perhaps using @option{-o}.  It doesn't matter
15519 what you call the files in the directory, every precompiled header in
15520 the directory will be considered.  The first precompiled header
15521 encountered in the directory that is valid for this compilation will
15522 be used; they're searched in no particular order.
15524 There are many other possibilities, limited only by your imagination,
15525 good sense, and the constraints of your build system.
15527 A precompiled header file can be used only when these conditions apply:
15529 @itemize
15530 @item
15531 Only one precompiled header can be used in a particular compilation.
15533 @item
15534 A precompiled header can't be used once the first C token is seen.  You
15535 can have preprocessor directives before a precompiled header; you can
15536 even include a precompiled header from inside another header, so long as
15537 there are no C tokens before the @code{#include}.
15539 @item
15540 The precompiled header file must be produced for the same language as
15541 the current compilation.  You can't use a C precompiled header for a C++
15542 compilation.
15544 @item
15545 The precompiled header file must have been produced by the same compiler
15546 binary as the current compilation is using.
15548 @item
15549 Any macros defined before the precompiled header is included must
15550 either be defined in the same way as when the precompiled header was
15551 generated, or must not affect the precompiled header, which usually
15552 means that they don't appear in the precompiled header at all.
15554 The @option{-D} option is one way to define a macro before a
15555 precompiled header is included; using a @code{#define} can also do it.
15556 There are also some options that define macros implicitly, like
15557 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15558 defined this way.
15560 @item If debugging information is output when using the precompiled
15561 header, using @option{-g} or similar, the same kind of debugging information
15562 must have been output when building the precompiled header.  However,
15563 a precompiled header built using @option{-g} can be used in a compilation
15564 when no debugging information is being output.
15566 @item The same @option{-m} options must generally be used when building
15567 and using the precompiled header.  @xref{Submodel Options},
15568 for any cases where this rule is relaxed.
15570 @item Each of the following options must be the same when building and using
15571 the precompiled header:
15573 @gccoptlist{-fexceptions -funit-at-a-time}
15575 @item
15576 Some other command-line options starting with @option{-f},
15577 @option{-p}, or @option{-O} must be defined in the same way as when
15578 the precompiled header was generated.  At present, it's not clear
15579 which options are safe to change and which are not; the safest choice
15580 is to use exactly the same options when generating and using the
15581 precompiled header.  The following are known to be safe:
15583 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15584 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15585 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15586 -pedantic-errors}
15588 @end itemize
15590 For all of these except the last, the compiler will automatically
15591 ignore the precompiled header if the conditions aren't met.  If you
15592 find an option combination that doesn't work and doesn't cause the
15593 precompiled header to be ignored, please consider filing a bug report,
15594 see @ref{Bugs}.
15596 If you do use differing options when generating and using the
15597 precompiled header, the actual behavior will be a mixture of the
15598 behavior for the options.  For instance, if you use @option{-g} to
15599 generate the precompiled header but not when using it, you may or may
15600 not get debugging information for routines in the precompiled header.
15602 @node Running Protoize
15603 @section Running Protoize
15605 The program @code{protoize} is an optional part of GCC@.  You can use
15606 it to add prototypes to a program, thus converting the program to ISO
15607 C in one respect.  The companion program @code{unprotoize} does the
15608 reverse: it removes argument types from any prototypes that are found.
15610 When you run these programs, you must specify a set of source files as
15611 command line arguments.  The conversion programs start out by compiling
15612 these files to see what functions they define.  The information gathered
15613 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15615 After scanning comes actual conversion.  The specified files are all
15616 eligible to be converted; any files they include (whether sources or
15617 just headers) are eligible as well.
15619 But not all the eligible files are converted.  By default,
15620 @code{protoize} and @code{unprotoize} convert only source and header
15621 files in the current directory.  You can specify additional directories
15622 whose files should be converted with the @option{-d @var{directory}}
15623 option.  You can also specify particular files to exclude with the
15624 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15625 directory name matches one of the specified directory names, and its
15626 name within the directory has not been excluded.
15628 Basic conversion with @code{protoize} consists of rewriting most
15629 function definitions and function declarations to specify the types of
15630 the arguments.  The only ones not rewritten are those for varargs
15631 functions.
15633 @code{protoize} optionally inserts prototype declarations at the
15634 beginning of the source file, to make them available for any calls that
15635 precede the function's definition.  Or it can insert prototype
15636 declarations with block scope in the blocks where undeclared functions
15637 are called.
15639 Basic conversion with @code{unprotoize} consists of rewriting most
15640 function declarations to remove any argument types, and rewriting
15641 function definitions to the old-style pre-ISO form.
15643 Both conversion programs print a warning for any function declaration or
15644 definition that they can't convert.  You can suppress these warnings
15645 with @option{-q}.
15647 The output from @code{protoize} or @code{unprotoize} replaces the
15648 original source file.  The original file is renamed to a name ending
15649 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15650 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15651 for DOS) file already exists, then the source file is simply discarded.
15653 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15654 scan the program and collect information about the functions it uses.
15655 So neither of these programs will work until GCC is installed.
15657 Here is a table of the options you can use with @code{protoize} and
15658 @code{unprotoize}.  Each option works with both programs unless
15659 otherwise stated.
15661 @table @code
15662 @item -B @var{directory}
15663 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15664 usual directory (normally @file{/usr/local/lib}).  This file contains
15665 prototype information about standard system functions.  This option
15666 applies only to @code{protoize}.
15668 @item -c @var{compilation-options}
15669 Use @var{compilation-options} as the options when running @command{gcc} to
15670 produce the @samp{.X} files.  The special option @option{-aux-info} is
15671 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15673 Note that the compilation options must be given as a single argument to
15674 @code{protoize} or @code{unprotoize}.  If you want to specify several
15675 @command{gcc} options, you must quote the entire set of compilation options
15676 to make them a single word in the shell.
15678 There are certain @command{gcc} arguments that you cannot use, because they
15679 would produce the wrong kind of output.  These include @option{-g},
15680 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15681 the @var{compilation-options}, they are ignored.
15683 @item -C
15684 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15685 systems) instead of @samp{.c}.  This is convenient if you are converting
15686 a C program to C++.  This option applies only to @code{protoize}.
15688 @item -g
15689 Add explicit global declarations.  This means inserting explicit
15690 declarations at the beginning of each source file for each function
15691 that is called in the file and was not declared.  These declarations
15692 precede the first function definition that contains a call to an
15693 undeclared function.  This option applies only to @code{protoize}.
15695 @item -i @var{string}
15696 Indent old-style parameter declarations with the string @var{string}.
15697 This option applies only to @code{protoize}.
15699 @code{unprotoize} converts prototyped function definitions to old-style
15700 function definitions, where the arguments are declared between the
15701 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15702 uses five spaces as the indentation.  If you want to indent with just
15703 one space instead, use @option{-i " "}.
15705 @item -k
15706 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15707 is finished.
15709 @item -l
15710 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15711 a prototype declaration for each function in each block which calls the
15712 function without any declaration.  This option applies only to
15713 @code{protoize}.
15715 @item -n
15716 Make no real changes.  This mode just prints information about the conversions
15717 that would have been done without @option{-n}.
15719 @item -N
15720 Make no @samp{.save} files.  The original files are simply deleted.
15721 Use this option with caution.
15723 @item -p @var{program}
15724 Use the program @var{program} as the compiler.  Normally, the name
15725 @file{gcc} is used.
15727 @item -q
15728 Work quietly.  Most warnings are suppressed.
15730 @item -v
15731 Print the version number, just like @option{-v} for @command{gcc}.
15732 @end table
15734 If you need special compiler options to compile one of your program's
15735 source files, then you should generate that file's @samp{.X} file
15736 specially, by running @command{gcc} on that source file with the
15737 appropriate options and the option @option{-aux-info}.  Then run
15738 @code{protoize} on the entire set of files.  @code{protoize} will use
15739 the existing @samp{.X} file because it is newer than the source file.
15740 For example:
15742 @smallexample
15743 gcc -Dfoo=bar file1.c -aux-info file1.X
15744 protoize *.c
15745 @end smallexample
15747 @noindent
15748 You need to include the special files along with the rest in the
15749 @code{protoize} command, even though their @samp{.X} files already
15750 exist, because otherwise they won't get converted.
15752 @xref{Protoize Caveats}, for more information on how to use
15753 @code{protoize} successfully.