Revert r135493 & r135463
[official-gcc.git] / gcc / doc / invoke.texi
blobe515a0f191b23e446f56e2b47988381dd7ec4b21
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  -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 -Wimport  -Wno-import  -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 -ftree-ccp @gol
356 -ftree-ch -ftree-copy-prop -ftree-copyrename -ftree-dce @gol
357 -ftree-dominator-opts -ftree-dse -ftree-fre -ftree-loop-im @gol
358 -ftree-loop-distribution @gol
359 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
360 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-reassoc @gol
361 -ftree-sink -ftree-sra -ftree-store-ccp -ftree-ter @gol
362 -ftree-vect-loop-version -ftree-vectorize -ftree-vrp -funit-at-a-time @gol
363 -funroll-all-loops -funroll-loops -funsafe-loop-optimizations @gol
364 -funsafe-math-optimizations -funswitch-loops @gol
365 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
366 -fwhole-program @gol
367 --param @var{name}=@var{value}
368 -O  -O0  -O1  -O2  -O3  -Os}
370 @item Preprocessor Options
371 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
372 @gccoptlist{-A@var{question}=@var{answer} @gol
373 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
374 -C  -dD  -dI  -dM  -dN @gol
375 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
376 -idirafter @var{dir} @gol
377 -include @var{file}  -imacros @var{file} @gol
378 -iprefix @var{file}  -iwithprefix @var{dir} @gol
379 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
380 -imultilib @var{dir} -isysroot @var{dir} @gol
381 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
382 -P  -fworking-directory  -remap @gol
383 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
384 -Xpreprocessor @var{option}}
386 @item Assembler Option
387 @xref{Assembler Options,,Passing Options to the Assembler}.
388 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
390 @item Linker Options
391 @xref{Link Options,,Options for Linking}.
392 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
393 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
394 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
395 -Wl,@var{option}  -Xlinker @var{option} @gol
396 -u @var{symbol}}
398 @item Directory Options
399 @xref{Directory Options,,Options for Directory Search}.
400 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
401 -specs=@var{file}  -I- --sysroot=@var{dir}}
403 @item Target Options
404 @c I wrote this xref this way to avoid overfull hbox. -- rms
405 @xref{Target Options}.
406 @gccoptlist{-V @var{version}  -b @var{machine}}
408 @item Machine Dependent Options
409 @xref{Submodel Options,,Hardware Models and Configurations}.
410 @c This list is ordered alphanumerically by subsection name.
411 @c Try and put the significant identifier (CPU or system) first,
412 @c so users have a clue at guessing where the ones they want will be.
414 @emph{ARC Options}
415 @gccoptlist{-EB  -EL @gol
416 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
417 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
419 @emph{ARM Options}
420 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
421 -mabi=@var{name} @gol
422 -mapcs-stack-check  -mno-apcs-stack-check @gol
423 -mapcs-float  -mno-apcs-float @gol
424 -mapcs-reentrant  -mno-apcs-reentrant @gol
425 -msched-prolog  -mno-sched-prolog @gol
426 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
427 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
428 -mthumb-interwork  -mno-thumb-interwork @gol
429 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
430 -mstructure-size-boundary=@var{n} @gol
431 -mabort-on-noreturn @gol
432 -mlong-calls  -mno-long-calls @gol
433 -msingle-pic-base  -mno-single-pic-base @gol
434 -mpic-register=@var{reg} @gol
435 -mnop-fun-dllimport @gol
436 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
437 -mpoke-function-name @gol
438 -mthumb  -marm @gol
439 -mtpcs-frame  -mtpcs-leaf-frame @gol
440 -mcaller-super-interworking  -mcallee-super-interworking @gol
441 -mtp=@var{name}}
443 @emph{AVR Options}
444 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
445 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
447 @emph{Blackfin Options}
448 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
449 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
450 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
451 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
452 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
453 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
454 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
455 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram}
457 @emph{CRIS Options}
458 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
459 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
460 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
461 -mstack-align  -mdata-align  -mconst-align @gol
462 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
463 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
464 -mmul-bug-workaround  -mno-mul-bug-workaround}
466 @emph{CRX Options}
467 @gccoptlist{-mmac -mpush-args}
469 @emph{Darwin Options}
470 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
471 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
472 -client_name  -compatibility_version  -current_version @gol
473 -dead_strip @gol
474 -dependency-file  -dylib_file  -dylinker_install_name @gol
475 -dynamic  -dynamiclib  -exported_symbols_list @gol
476 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
477 -force_flat_namespace  -headerpad_max_install_names @gol
478 -iframework @gol
479 -image_base  -init  -install_name  -keep_private_externs @gol
480 -multi_module  -multiply_defined  -multiply_defined_unused @gol
481 -noall_load   -no_dead_strip_inits_and_terms @gol
482 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
483 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
484 -private_bundle  -read_only_relocs  -sectalign @gol
485 -sectobjectsymbols  -whyload  -seg1addr @gol
486 -sectcreate  -sectobjectsymbols  -sectorder @gol
487 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
488 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
489 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
490 -single_module  -static  -sub_library  -sub_umbrella @gol
491 -twolevel_namespace  -umbrella  -undefined @gol
492 -unexported_symbols_list  -weak_reference_mismatches @gol
493 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
494 -mkernel -mone-byte-bool}
496 @emph{DEC Alpha Options}
497 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
498 -mieee  -mieee-with-inexact  -mieee-conformant @gol
499 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
500 -mtrap-precision=@var{mode}  -mbuild-constants @gol
501 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
502 -mbwx  -mmax  -mfix  -mcix @gol
503 -mfloat-vax  -mfloat-ieee @gol
504 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
505 -msmall-text  -mlarge-text @gol
506 -mmemory-latency=@var{time}}
508 @emph{DEC Alpha/VMS Options}
509 @gccoptlist{-mvms-return-codes}
511 @emph{FRV Options}
512 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
513 -mhard-float  -msoft-float @gol
514 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
515 -mdouble  -mno-double @gol
516 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
517 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
518 -mlinked-fp  -mlong-calls  -malign-labels @gol
519 -mlibrary-pic  -macc-4  -macc-8 @gol
520 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
521 -moptimize-membar -mno-optimize-membar @gol
522 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
523 -mvliw-branch  -mno-vliw-branch @gol
524 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
525 -mno-nested-cond-exec  -mtomcat-stats @gol
526 -mTLS -mtls @gol
527 -mcpu=@var{cpu}}
529 @emph{GNU/Linux Options}
530 @gccoptlist{-muclibc}
532 @emph{H8/300 Options}
533 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
535 @emph{HPPA Options}
536 @gccoptlist{-march=@var{architecture-type} @gol
537 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
538 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
539 -mfixed-range=@var{register-range} @gol
540 -mjump-in-delay -mlinker-opt -mlong-calls @gol
541 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
542 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
543 -mno-jump-in-delay  -mno-long-load-store @gol
544 -mno-portable-runtime  -mno-soft-float @gol
545 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
546 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
547 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
548 -munix=@var{unix-std}  -nolibdld  -static  -threads}
550 @emph{i386 and x86-64 Options}
551 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
552 -mfpmath=@var{unit} @gol
553 -masm=@var{dialect}  -mno-fancy-math-387 @gol
554 -mno-fp-ret-in-387  -msoft-float @gol
555 -mno-wide-multiply  -mrtd  -malign-double @gol
556 -mpreferred-stack-boundary=@var{num} -mcx16 -msahf -mrecip @gol
557 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
558 -maes -mpclmul @gol
559 -msse4a -m3dnow -mpopcnt -mabm -msse5 @gol
560 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
561 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
562 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
563 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
564 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
565 -mcmodel=@var{code-model} @gol
566 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
567 -mfused-madd -mno-fused-madd}
569 @emph{IA-64 Options}
570 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
571 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
572 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
573 -minline-float-divide-max-throughput @gol
574 -minline-int-divide-min-latency @gol
575 -minline-int-divide-max-throughput  @gol
576 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
577 -mno-dwarf2-asm -mearly-stop-bits @gol
578 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
579 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
580 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
581 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
582 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
583 -mno-sched-prefer-non-data-spec-insns @gol
584 -mno-sched-prefer-non-control-spec-insns @gol
585 -mno-sched-count-spec-in-critical-path}
587 @emph{M32R/D Options}
588 @gccoptlist{-m32r2 -m32rx -m32r @gol
589 -mdebug @gol
590 -malign-loops -mno-align-loops @gol
591 -missue-rate=@var{number} @gol
592 -mbranch-cost=@var{number} @gol
593 -mmodel=@var{code-size-model-type} @gol
594 -msdata=@var{sdata-type} @gol
595 -mno-flush-func -mflush-func=@var{name} @gol
596 -mno-flush-trap -mflush-trap=@var{number} @gol
597 -G @var{num}}
599 @emph{M32C Options}
600 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
602 @emph{M680x0 Options}
603 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
604 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
605 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
606 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
607 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
608 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
609 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
610 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
612 @emph{M68hc1x Options}
613 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
614 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
615 -msoft-reg-count=@var{count}}
617 @emph{MCore Options}
618 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
619 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
620 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
621 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
622 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
624 @emph{MIPS Options}
625 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
626 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
627 -mips16  -mno-mips16  -mflip-mips16 @gol
628 -minterlink-mips16  -mno-interlink-mips16 @gol
629 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
630 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64 @gol
631 -mfp32  -mfp64  -mhard-float  -msoft-float @gol
632 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
633 -msmartmips  -mno-smartmips @gol
634 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
635 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
636 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
637 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
638 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
639 -membedded-data  -mno-embedded-data @gol
640 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
641 -mcode-readable=@var{setting} @gol
642 -msplit-addresses  -mno-split-addresses @gol
643 -mexplicit-relocs  -mno-explicit-relocs @gol
644 -mcheck-zero-division  -mno-check-zero-division @gol
645 -mdivide-traps  -mdivide-breaks @gol
646 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
647 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
648 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
649 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
650 -mfix-sb1  -mno-fix-sb1 @gol
651 -mflush-func=@var{func}  -mno-flush-func @gol
652 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
653 -mfp-exceptions -mno-fp-exceptions @gol
654 -mvr4130-align -mno-vr4130-align}
656 @emph{MMIX Options}
657 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
658 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
659 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
660 -mno-base-addresses  -msingle-exit  -mno-single-exit}
662 @emph{MN10300 Options}
663 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
664 -mam33  -mno-am33 @gol
665 -mam33-2  -mno-am33-2 @gol
666 -mreturn-pointer-on-d0 @gol
667 -mno-crt0  -mrelax}
669 @emph{MT Options}
670 @gccoptlist{-mno-crt0 -mbacc -msim @gol
671 -march=@var{cpu-type} }
673 @emph{PDP-11 Options}
674 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
675 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
676 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
677 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
678 -mbranch-expensive  -mbranch-cheap @gol
679 -msplit  -mno-split  -munix-asm  -mdec-asm}
681 @emph{PowerPC Options}
682 See RS/6000 and PowerPC Options.
684 @emph{RS/6000 and PowerPC Options}
685 @gccoptlist{-mcpu=@var{cpu-type} @gol
686 -mtune=@var{cpu-type} @gol
687 -mpower  -mno-power  -mpower2  -mno-power2 @gol
688 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
689 -maltivec  -mno-altivec @gol
690 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
691 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
692 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
693 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
694 -mnew-mnemonics  -mold-mnemonics @gol
695 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
696 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
697 -malign-power  -malign-natural @gol
698 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
699 -mstring  -mno-string  -mupdate  -mno-update @gol
700 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
701 -mstrict-align  -mno-strict-align  -mrelocatable @gol
702 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
703 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
704 -mdynamic-no-pic  -maltivec  -mswdiv @gol
705 -mprioritize-restricted-insns=@var{priority} @gol
706 -msched-costly-dep=@var{dependence_type} @gol
707 -minsert-sched-nops=@var{scheme} @gol
708 -mcall-sysv  -mcall-netbsd @gol
709 -maix-struct-return  -msvr4-struct-return @gol
710 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
711 -misel -mno-isel @gol
712 -misel=yes  -misel=no @gol
713 -mspe -mno-spe @gol
714 -mspe=yes  -mspe=no @gol
715 -mpaired @gol
716 -mvrsave -mno-vrsave @gol
717 -mmulhw -mno-mulhw @gol
718 -mdlmzb -mno-dlmzb @gol
719 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
720 -mprototype  -mno-prototype @gol
721 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
722 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
724 @emph{S/390 and zSeries Options}
725 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
726 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
727 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
728 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
729 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
730 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
731 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
733 @emph{Score Options}
734 @gccoptlist{-meb -mel @gol
735 -mnhwloop @gol
736 -muls @gol
737 -mmac @gol
738 -mscore5 -mscore5u -mscore7 -mscore7d}
740 @emph{SH Options}
741 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
742 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
743 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
744 -m5-64media  -m5-64media-nofpu @gol
745 -m5-32media  -m5-32media-nofpu @gol
746 -m5-compact  -m5-compact-nofpu @gol
747 -mb  -ml  -mdalign  -mrelax @gol
748 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
749 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
750 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
751 -mdivsi3_libfunc=@var{name}  @gol
752 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
753  -minvalid-symbols}
755 @emph{SPARC Options}
756 @gccoptlist{-mcpu=@var{cpu-type} @gol
757 -mtune=@var{cpu-type} @gol
758 -mcmodel=@var{code-model} @gol
759 -m32  -m64  -mapp-regs  -mno-app-regs @gol
760 -mfaster-structs  -mno-faster-structs @gol
761 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
762 -mhard-quad-float  -msoft-quad-float @gol
763 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
764 -mstack-bias  -mno-stack-bias @gol
765 -munaligned-doubles  -mno-unaligned-doubles @gol
766 -mv8plus  -mno-v8plus  -mvis  -mno-vis
767 -threads -pthreads -pthread}
769 @emph{SPU Options}
770 @gccoptlist{-mwarn-reloc -merror-reloc @gol
771 -msafe-dma -munsafe-dma @gol
772 -mbranch-hints @gol
773 -msmall-mem -mlarge-mem -mstdmain @gol
774 -mfixed-range=@var{register-range}}
776 @emph{System V Options}
777 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
779 @emph{V850 Options}
780 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
781 -mprolog-function  -mno-prolog-function  -mspace @gol
782 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
783 -mapp-regs  -mno-app-regs @gol
784 -mdisable-callt  -mno-disable-callt @gol
785 -mv850e1 @gol
786 -mv850e @gol
787 -mv850  -mbig-switch}
789 @emph{VAX Options}
790 @gccoptlist{-mg  -mgnu  -munix}
792 @emph{VxWorks Options}
793 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
794 -Xbind-lazy  -Xbind-now}
796 @emph{x86-64 Options}
797 See i386 and x86-64 Options.
799 @emph{Xstormy16 Options}
800 @gccoptlist{-msim}
802 @emph{Xtensa Options}
803 @gccoptlist{-mconst16 -mno-const16 @gol
804 -mfused-madd  -mno-fused-madd @gol
805 -mserialize-volatile  -mno-serialize-volatile @gol
806 -mtext-section-literals  -mno-text-section-literals @gol
807 -mtarget-align  -mno-target-align @gol
808 -mlongcalls  -mno-longcalls}
810 @emph{zSeries Options}
811 See S/390 and zSeries Options.
813 @item Code Generation Options
814 @xref{Code Gen Options,,Options for Code Generation Conventions}.
815 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
816 -ffixed-@var{reg}  -fexceptions @gol
817 -fnon-call-exceptions  -funwind-tables @gol
818 -fasynchronous-unwind-tables @gol
819 -finhibit-size-directive  -finstrument-functions @gol
820 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
821 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
822 -fno-common  -fno-ident @gol
823 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
824 -fno-jump-tables @gol
825 -frecord-gcc-switches @gol
826 -freg-struct-return  -fshort-enums @gol
827 -fshort-double  -fshort-wchar @gol
828 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
829 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
830 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
831 -fargument-noalias-global  -fargument-noalias-anything @gol
832 -fleading-underscore  -ftls-model=@var{model} @gol
833 -ftrapv  -fwrapv  -fbounds-check @gol
834 -fvisibility}
835 @end table
837 @menu
838 * Overall Options::     Controlling the kind of output:
839                         an executable, object files, assembler files,
840                         or preprocessed source.
841 * C Dialect Options::   Controlling the variant of C language compiled.
842 * C++ Dialect Options:: Variations on C++.
843 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
844                         and Objective-C++.
845 * Language Independent Options:: Controlling how diagnostics should be
846                         formatted.
847 * Warning Options::     How picky should the compiler be?
848 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
849 * Optimize Options::    How much optimization?
850 * Preprocessor Options:: Controlling header files and macro definitions.
851                          Also, getting dependency information for Make.
852 * Assembler Options::   Passing options to the assembler.
853 * Link Options::        Specifying libraries and so on.
854 * Directory Options::   Where to find header files and libraries.
855                         Where to find the compiler executable files.
856 * Spec Files::          How to pass switches to sub-processes.
857 * Target Options::      Running a cross-compiler, or an old version of GCC.
858 @end menu
860 @node Overall Options
861 @section Options Controlling the Kind of Output
863 Compilation can involve up to four stages: preprocessing, compilation
864 proper, assembly and linking, always in that order.  GCC is capable of
865 preprocessing and compiling several files either into several
866 assembler input files, or into one assembler input file; then each
867 assembler input file produces an object file, and linking combines all
868 the object files (those newly compiled, and those specified as input)
869 into an executable file.
871 @cindex file name suffix
872 For any given input file, the file name suffix determines what kind of
873 compilation is done:
875 @table @gcctabopt
876 @item @var{file}.c
877 C source code which must be preprocessed.
879 @item @var{file}.i
880 C source code which should not be preprocessed.
882 @item @var{file}.ii
883 C++ source code which should not be preprocessed.
885 @item @var{file}.m
886 Objective-C source code.  Note that you must link with the @file{libobjc}
887 library to make an Objective-C program work.
889 @item @var{file}.mi
890 Objective-C source code which should not be preprocessed.
892 @item @var{file}.mm
893 @itemx @var{file}.M
894 Objective-C++ source code.  Note that you must link with the @file{libobjc}
895 library to make an Objective-C++ program work.  Note that @samp{.M} refers
896 to a literal capital M@.
898 @item @var{file}.mii
899 Objective-C++ source code which should not be preprocessed.
901 @item @var{file}.h
902 C, C++, Objective-C or Objective-C++ header file to be turned into a
903 precompiled header.
905 @item @var{file}.cc
906 @itemx @var{file}.cp
907 @itemx @var{file}.cxx
908 @itemx @var{file}.cpp
909 @itemx @var{file}.CPP
910 @itemx @var{file}.c++
911 @itemx @var{file}.C
912 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
913 the last two letters must both be literally @samp{x}.  Likewise,
914 @samp{.C} refers to a literal capital C@.
916 @item @var{file}.mm
917 @itemx @var{file}.M
918 Objective-C++ source code which must be preprocessed.
920 @item @var{file}.mii
921 Objective-C++ source code which should not be preprocessed.
923 @item @var{file}.hh
924 @itemx @var{file}.H
925 @itemx @var{file}.hp
926 @itemx @var{file}.hxx
927 @itemx @var{file}.hpp
928 @itemx @var{file}.HPP
929 @itemx @var{file}.h++
930 @itemx @var{file}.tcc
931 C++ header file to be turned into a precompiled header.
933 @item @var{file}.f
934 @itemx @var{file}.for
935 @itemx @var{file}.ftn
936 Fixed form Fortran source code which should not be preprocessed.
938 @item @var{file}.F
939 @itemx @var{file}.FOR
940 @itemx @var{file}.fpp
941 @itemx @var{file}.FPP
942 @itemx @var{file}.FTN
943 Fixed form Fortran source code which must be preprocessed (with the traditional
944 preprocessor).
946 @item @var{file}.f90
947 @itemx @var{file}.f95
948 @itemx @var{file}.f03
949 @itemx @var{file}.f08
950 Free form Fortran source code which should not be preprocessed.
952 @item @var{file}.F90
953 @itemx @var{file}.F95
954 @itemx @var{file}.F03
955 @itemx @var{file}.F08
956 Free form Fortran source code which must be preprocessed (with the
957 traditional preprocessor).
959 @c FIXME: Descriptions of Java file types.
960 @c @var{file}.java
961 @c @var{file}.class
962 @c @var{file}.zip
963 @c @var{file}.jar
965 @item @var{file}.ads
966 Ada source code file which contains a library unit declaration (a
967 declaration of a package, subprogram, or generic, or a generic
968 instantiation), or a library unit renaming declaration (a package,
969 generic, or subprogram renaming declaration).  Such files are also
970 called @dfn{specs}.
972 @item @var{file}.adb
973 Ada source code file containing a library unit body (a subprogram or
974 package body).  Such files are also called @dfn{bodies}.
976 @c GCC also knows about some suffixes for languages not yet included:
977 @c Pascal:
978 @c @var{file}.p
979 @c @var{file}.pas
980 @c Ratfor:
981 @c @var{file}.r
983 @item @var{file}.s
984 Assembler code.
986 @item @var{file}.S
987 @itemx @var{file}.sx
988 Assembler code which must be preprocessed.
990 @item @var{other}
991 An object file to be fed straight into linking.
992 Any file name with no recognized suffix is treated this way.
993 @end table
995 @opindex x
996 You can specify the input language explicitly with the @option{-x} option:
998 @table @gcctabopt
999 @item -x @var{language}
1000 Specify explicitly the @var{language} for the following input files
1001 (rather than letting the compiler choose a default based on the file
1002 name suffix).  This option applies to all following input files until
1003 the next @option{-x} option.  Possible values for @var{language} are:
1004 @smallexample
1005 c  c-header  c-cpp-output
1006 c++  c++-header  c++-cpp-output
1007 objective-c  objective-c-header  objective-c-cpp-output
1008 objective-c++ objective-c++-header objective-c++-cpp-output
1009 assembler  assembler-with-cpp
1011 f95  f95-cpp-input
1012 java
1013 @end smallexample
1015 @item -x none
1016 Turn off any specification of a language, so that subsequent files are
1017 handled according to their file name suffixes (as they are if @option{-x}
1018 has not been used at all).
1020 @item -pass-exit-codes
1021 @opindex pass-exit-codes
1022 Normally the @command{gcc} program will exit with the code of 1 if any
1023 phase of the compiler returns a non-success return code.  If you specify
1024 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1025 numerically highest error produced by any phase that returned an error
1026 indication.  The C, C++, and Fortran frontends return 4, if an internal
1027 compiler error is encountered.
1028 @end table
1030 If you only want some of the stages of compilation, you can use
1031 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1032 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1033 @command{gcc} is to stop.  Note that some combinations (for example,
1034 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1036 @table @gcctabopt
1037 @item -c
1038 @opindex c
1039 Compile or assemble the source files, but do not link.  The linking
1040 stage simply is not done.  The ultimate output is in the form of an
1041 object file for each source file.
1043 By default, the object file name for a source file is made by replacing
1044 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1046 Unrecognized input files, not requiring compilation or assembly, are
1047 ignored.
1049 @item -S
1050 @opindex S
1051 Stop after the stage of compilation proper; do not assemble.  The output
1052 is in the form of an assembler code file for each non-assembler input
1053 file specified.
1055 By default, the assembler file name for a source file is made by
1056 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1058 Input files that don't require compilation are ignored.
1060 @item -E
1061 @opindex E
1062 Stop after the preprocessing stage; do not run the compiler proper.  The
1063 output is in the form of preprocessed source code, which is sent to the
1064 standard output.
1066 Input files which don't require preprocessing are ignored.
1068 @cindex output file option
1069 @item -o @var{file}
1070 @opindex o
1071 Place output in file @var{file}.  This applies regardless to whatever
1072 sort of output is being produced, whether it be an executable file,
1073 an object file, an assembler file or preprocessed C code.
1075 If @option{-o} is not specified, the default is to put an executable
1076 file in @file{a.out}, the object file for
1077 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1078 assembler file in @file{@var{source}.s}, a precompiled header file in
1079 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1080 standard output.
1082 @item -v
1083 @opindex v
1084 Print (on standard error output) the commands executed to run the stages
1085 of compilation.  Also print the version number of the compiler driver
1086 program and of the preprocessor and the compiler proper.
1088 @item -###
1089 @opindex ###
1090 Like @option{-v} except the commands are not executed and all command
1091 arguments are quoted.  This is useful for shell scripts to capture the
1092 driver-generated command lines.
1094 @item -pipe
1095 @opindex pipe
1096 Use pipes rather than temporary files for communication between the
1097 various stages of compilation.  This fails to work on some systems where
1098 the assembler is unable to read from a pipe; but the GNU assembler has
1099 no trouble.
1101 @item -combine
1102 @opindex combine
1103 If you are compiling multiple source files, this option tells the driver
1104 to pass all the source files to the compiler at once (for those
1105 languages for which the compiler can handle this).  This will allow
1106 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1107 language for which this is supported is C@.  If you pass source files for
1108 multiple languages to the driver, using this option, the driver will invoke
1109 the compiler(s) that support IMA once each, passing each compiler all the
1110 source files appropriate for it.  For those languages that do not support
1111 IMA this option will be ignored, and the compiler will be invoked once for
1112 each source file in that language.  If you use this option in conjunction
1113 with @option{-save-temps}, the compiler will generate multiple
1114 pre-processed files
1115 (one for each source file), but only one (combined) @file{.o} or
1116 @file{.s} file.
1118 @item --help
1119 @opindex help
1120 Print (on the standard output) a description of the command line options
1121 understood by @command{gcc}.  If the @option{-v} option is also specified
1122 then @option{--help} will also be passed on to the various processes
1123 invoked by @command{gcc}, so that they can display the command line options
1124 they accept.  If the @option{-Wextra} option has also been specified
1125 (prior to the @option{--help} option), then command line options which
1126 have no documentation associated with them will also be displayed.
1128 @item --target-help
1129 @opindex target-help
1130 Print (on the standard output) a description of target-specific command
1131 line options for each tool.  For some targets extra target-specific
1132 information may also be printed.
1134 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1135 Print (on the standard output) a description of the command line
1136 options understood by the compiler that fit into a specific class.
1137 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1138 @samp{params}, or @var{language}:
1140 @table @asis
1141 @item @samp{optimizers}
1142 This will display all of the optimization options supported by the
1143 compiler.
1145 @item @samp{warnings}
1146 This will display all of the options controlling warning messages
1147 produced by the compiler.
1149 @item @samp{target}
1150 This will display target-specific options.  Unlike the
1151 @option{--target-help} option however, target-specific options of the
1152 linker and assembler will not be displayed.  This is because those
1153 tools do not currently support the extended @option{--help=} syntax.
1155 @item @samp{params}
1156 This will display the values recognized by the @option{--param}
1157 option.
1159 @item @var{language}
1160 This will display the options supported for @var{language}, where 
1161 @var{language} is the name of one of the languages supported in this 
1162 version of GCC.
1164 @item @samp{common}
1165 This will display the options that are common to all languages.
1166 @end table
1168 It is possible to further refine the output of the @option{--help=}
1169 option by adding a comma separated list of qualifiers after the
1170 class.  These can be any from the following list:
1172 @table @asis
1173 @item @samp{undocumented}
1174 Display only those options which are undocumented.
1176 @item @samp{joined}
1177 Display options which take an argument that appears after an equal
1178 sign in the same continuous piece of text, such as:
1179 @samp{--help=target}.
1181 @item @samp{separate}
1182 Display options which take an argument that appears as a separate word
1183 following the original option, such as: @samp{-o output-file}.
1184 @end table
1186 Thus for example to display all the undocumented target-specific
1187 switches supported by the compiler the following can be used:
1189 @smallexample
1190 --help=target,undocumented
1191 @end smallexample
1193 The sense of a qualifier can be inverted by prefixing it with the
1194 @var{^} character, so for example to display all binary warning
1195 options (i.e., ones that are either on or off and that do not take an
1196 argument), which have a description the following can be used:
1198 @smallexample
1199 --help=warnings,^joined,^undocumented
1200 @end smallexample
1202 A class can also be used as a qualifier, although this usually
1203 restricts the output by so much that there is nothing to display.  One
1204 case where it does work however is when one of the classes is
1205 @var{target}.  So for example to display all the target-specific
1206 optimization options the following can be used:
1208 @smallexample
1209 --help=target,optimizers
1210 @end smallexample
1212 The @option{--help=} option can be repeated on the command line.  Each
1213 successive use will display its requested class of options, skipping
1214 those that have already been displayed.
1216 If the @option{-Q} option appears on the command line before the
1217 @option{--help=} option, then the descriptive text displayed by
1218 @option{--help=} is changed.  Instead of describing the displayed
1219 options, an indication is given as to whether the option is enabled,
1220 disabled or set to a specific value (assuming that the compiler
1221 knows this at the point where the @option{--help=} option is used).
1223 Here is a truncated example from the ARM port of @command{gcc}:
1225 @smallexample
1226   % gcc -Q -mabi=2 --help=target -c
1227   The following options are target specific:
1228   -mabi=                                2
1229   -mabort-on-noreturn                   [disabled]
1230   -mapcs                                [disabled]
1231 @end smallexample
1233 The output is sensitive to the effects of previous command line
1234 options, so for example it is possible to find out which optimizations
1235 are enabled at @option{-O2} by using:
1237 @smallexample
1238 -O2 --help=optimizers
1239 @end smallexample
1241 Alternatively you can discover which binary optimizations are enabled
1242 by @option{-O3} by using:
1244 @smallexample
1245 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1246 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1247 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1248 @end smallexample
1250 @item --version
1251 @opindex version
1252 Display the version number and copyrights of the invoked GCC@.
1254 @item -wrapper
1255 @opindex wrapper
1256 Invoke all subcommands under a wrapper program. It takes a single
1257 comma separated list as an argument, which will be used to invoke
1258 the wrapper:
1260 @smallexample
1261 gcc -c t.c -wrapper gdb,--args
1262 @end smallexample
1264 This will invoke all subprograms of gcc under "gdb --args",
1265 thus cc1 invocation will be "gdb --args cc1 ...".
1267 @include @value{srcdir}/../libiberty/at-file.texi
1268 @end table
1270 @node Invoking G++
1271 @section Compiling C++ Programs
1273 @cindex suffixes for C++ source
1274 @cindex C++ source file suffixes
1275 C++ source files conventionally use one of the suffixes @samp{.C},
1276 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1277 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1278 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1279 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1280 files with these names and compiles them as C++ programs even if you
1281 call the compiler the same way as for compiling C programs (usually
1282 with the name @command{gcc}).
1284 @findex g++
1285 @findex c++
1286 However, the use of @command{gcc} does not add the C++ library.
1287 @command{g++} is a program that calls GCC and treats @samp{.c},
1288 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1289 files unless @option{-x} is used, and automatically specifies linking
1290 against the C++ library.  This program is also useful when
1291 precompiling a C header file with a @samp{.h} extension for use in C++
1292 compilations.  On many systems, @command{g++} is also installed with
1293 the name @command{c++}.
1295 @cindex invoking @command{g++}
1296 When you compile C++ programs, you may specify many of the same
1297 command-line options that you use for compiling programs in any
1298 language; or command-line options meaningful for C and related
1299 languages; or options that are meaningful only for C++ programs.
1300 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1301 explanations of options for languages related to C@.
1302 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1303 explanations of options that are meaningful only for C++ programs.
1305 @node C Dialect Options
1306 @section Options Controlling C Dialect
1307 @cindex dialect options
1308 @cindex language dialect options
1309 @cindex options, dialect
1311 The following options control the dialect of C (or languages derived
1312 from C, such as C++, Objective-C and Objective-C++) that the compiler
1313 accepts:
1315 @table @gcctabopt
1316 @cindex ANSI support
1317 @cindex ISO support
1318 @item -ansi
1319 @opindex ansi
1320 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1321 equivalent to @samp{-std=c++98}.
1323 This turns off certain features of GCC that are incompatible with ISO
1324 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1325 such as the @code{asm} and @code{typeof} keywords, and
1326 predefined macros such as @code{unix} and @code{vax} that identify the
1327 type of system you are using.  It also enables the undesirable and
1328 rarely used ISO trigraph feature.  For the C compiler,
1329 it disables recognition of C++ style @samp{//} comments as well as
1330 the @code{inline} keyword.
1332 The alternate keywords @code{__asm__}, @code{__extension__},
1333 @code{__inline__} and @code{__typeof__} continue to work despite
1334 @option{-ansi}.  You would not want to use them in an ISO C program, of
1335 course, but it is useful to put them in header files that might be included
1336 in compilations done with @option{-ansi}.  Alternate predefined macros
1337 such as @code{__unix__} and @code{__vax__} are also available, with or
1338 without @option{-ansi}.
1340 The @option{-ansi} option does not cause non-ISO programs to be
1341 rejected gratuitously.  For that, @option{-pedantic} is required in
1342 addition to @option{-ansi}.  @xref{Warning Options}.
1344 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1345 option is used.  Some header files may notice this macro and refrain
1346 from declaring certain functions or defining certain macros that the
1347 ISO standard doesn't call for; this is to avoid interfering with any
1348 programs that might use these names for other things.
1350 Functions that would normally be built in but do not have semantics
1351 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1352 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1353 built-in functions provided by GCC}, for details of the functions
1354 affected.
1356 @item -std=
1357 @opindex std
1358 Determine the language standard. @xref{Standards,,Language Standards
1359 Supported by GCC}, for details of these standard versions.  This option
1360 is currently only supported when compiling C or C++. 
1362 The compiler can accept several base standards, such as @samp{c89} or
1363 @samp{c++98}, and GNU dialects of those standards, such as
1364 @samp{gnu89} or @samp{gnu++98}.  By specifing a base standard, the
1365 compiler will accept all programs following that standard and those
1366 using GNU extensions that do not contradict it.  For example,
1367 @samp{-std=c89} turns off certain features of GCC that are
1368 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1369 keywords, but not other GNU extensions that do not have a meaning in
1370 ISO C90, such as omitting the middle term of a @code{?:}
1371 expression. On the other hand, by specifing a GNU dialect of a
1372 standard, all features the compiler support are enabled, even when
1373 those features change the meaning of the base standard and some
1374 strict-conforming programs may be rejected.  The particular standard
1375 is used by @option{-pedantic} to identify which features are GNU
1376 extensions given that version of the standard. For example
1377 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1378 comments, while @samp{-std=gnu99 -pedantic} would not.
1380 A value for this option must be provided; possible values are
1382 @table @samp
1383 @item c89
1384 @itemx iso9899:1990
1385 Support all ISO C90 programs (certain GNU extensions that conflict
1386 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1388 @item iso9899:199409
1389 ISO C90 as modified in amendment 1.
1391 @item c99
1392 @itemx c9x
1393 @itemx iso9899:1999
1394 @itemx iso9899:199x
1395 ISO C99.  Note that this standard is not yet fully supported; see
1396 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1397 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1399 @item gnu89
1400 GNU dialect of ISO C90 (including some C99 features). This
1401 is the default for C code.
1403 @item gnu99
1404 @itemx gnu9x
1405 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1406 this will become the default.  The name @samp{gnu9x} is deprecated.
1408 @item c++98
1409 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1410 C++ code.
1412 @item gnu++98
1413 GNU dialect of @option{-std=c++98}.  This is the default for
1414 C++ code.
1416 @item c++0x
1417 The working draft of the upcoming ISO C++0x standard. This option
1418 enables experimental features that are likely to be included in
1419 C++0x. The working draft is constantly changing, and any feature that is
1420 enabled by this flag may be removed from future versions of GCC if it is
1421 not part of the C++0x standard.
1423 @item gnu++0x
1424 GNU dialect of @option{-std=c++0x}. This option enables
1425 experimental features that may be removed in future versions of GCC.
1426 @end table
1428 @item -fgnu89-inline
1429 @opindex fgnu89-inline
1430 The option @option{-fgnu89-inline} tells GCC to use the traditional
1431 GNU semantics for @code{inline} functions when in C99 mode.
1432 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1433 is accepted and ignored by GCC versions 4.1.3 up to but not including
1434 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1435 C99 mode.  Using this option is roughly equivalent to adding the
1436 @code{gnu_inline} function attribute to all inline functions
1437 (@pxref{Function Attributes}).
1439 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1440 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1441 specifies the default behavior).  This option was first supported in
1442 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1444 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1445 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1446 in effect for @code{inline} functions.  @xref{Common Predefined
1447 Macros,,,cpp,The C Preprocessor}.
1449 @item -aux-info @var{filename}
1450 @opindex aux-info
1451 Output to the given filename prototyped declarations for all functions
1452 declared and/or defined in a translation unit, including those in header
1453 files.  This option is silently ignored in any language other than C@.
1455 Besides declarations, the file indicates, in comments, the origin of
1456 each declaration (source file and line), whether the declaration was
1457 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1458 @samp{O} for old, respectively, in the first character after the line
1459 number and the colon), and whether it came from a declaration or a
1460 definition (@samp{C} or @samp{F}, respectively, in the following
1461 character).  In the case of function definitions, a K&R-style list of
1462 arguments followed by their declarations is also provided, inside
1463 comments, after the declaration.
1465 @item -fno-asm
1466 @opindex fno-asm
1467 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1468 keyword, so that code can use these words as identifiers.  You can use
1469 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1470 instead.  @option{-ansi} implies @option{-fno-asm}.
1472 In C++, this switch only affects the @code{typeof} keyword, since
1473 @code{asm} and @code{inline} are standard keywords.  You may want to
1474 use the @option{-fno-gnu-keywords} flag instead, which has the same
1475 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1476 switch only affects the @code{asm} and @code{typeof} keywords, since
1477 @code{inline} is a standard keyword in ISO C99.
1479 @item -fno-builtin
1480 @itemx -fno-builtin-@var{function}
1481 @opindex fno-builtin
1482 @cindex built-in functions
1483 Don't recognize built-in functions that do not begin with
1484 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1485 functions provided by GCC}, for details of the functions affected,
1486 including those which are not built-in functions when @option{-ansi} or
1487 @option{-std} options for strict ISO C conformance are used because they
1488 do not have an ISO standard meaning.
1490 GCC normally generates special code to handle certain built-in functions
1491 more efficiently; for instance, calls to @code{alloca} may become single
1492 instructions that adjust the stack directly, and calls to @code{memcpy}
1493 may become inline copy loops.  The resulting code is often both smaller
1494 and faster, but since the function calls no longer appear as such, you
1495 cannot set a breakpoint on those calls, nor can you change the behavior
1496 of the functions by linking with a different library.  In addition,
1497 when a function is recognized as a built-in function, GCC may use
1498 information about that function to warn about problems with calls to
1499 that function, or to generate more efficient code, even if the
1500 resulting code still contains calls to that function.  For example,
1501 warnings are given with @option{-Wformat} for bad calls to
1502 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1503 known not to modify global memory.
1505 With the @option{-fno-builtin-@var{function}} option
1506 only the built-in function @var{function} is
1507 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1508 function is named this is not built-in in this version of GCC, this
1509 option is ignored.  There is no corresponding
1510 @option{-fbuiltin-@var{function}} option; if you wish to enable
1511 built-in functions selectively when using @option{-fno-builtin} or
1512 @option{-ffreestanding}, you may define macros such as:
1514 @smallexample
1515 #define abs(n)          __builtin_abs ((n))
1516 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1517 @end smallexample
1519 @item -fhosted
1520 @opindex fhosted
1521 @cindex hosted environment
1523 Assert that compilation takes place in a hosted environment.  This implies
1524 @option{-fbuiltin}.  A hosted environment is one in which the
1525 entire standard library is available, and in which @code{main} has a return
1526 type of @code{int}.  Examples are nearly everything except a kernel.
1527 This is equivalent to @option{-fno-freestanding}.
1529 @item -ffreestanding
1530 @opindex ffreestanding
1531 @cindex hosted environment
1533 Assert that compilation takes place in a freestanding environment.  This
1534 implies @option{-fno-builtin}.  A freestanding environment
1535 is one in which the standard library may not exist, and program startup may
1536 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1537 This is equivalent to @option{-fno-hosted}.
1539 @xref{Standards,,Language Standards Supported by GCC}, for details of
1540 freestanding and hosted environments.
1542 @item -fopenmp
1543 @opindex fopenmp
1544 @cindex openmp parallel
1545 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1546 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1547 compiler generates parallel code according to the OpenMP Application
1548 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.  This option
1549 implies @option{-pthread}, and thus is only supported on targets that
1550 have support for @option{-pthread}.
1552 @item -fms-extensions
1553 @opindex fms-extensions
1554 Accept some non-standard constructs used in Microsoft header files.
1556 Some cases of unnamed fields in structures and unions are only
1557 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1558 fields within structs/unions}, for details.
1560 @item -trigraphs
1561 @opindex trigraphs
1562 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1563 options for strict ISO C conformance) implies @option{-trigraphs}.
1565 @item -no-integrated-cpp
1566 @opindex no-integrated-cpp
1567 Performs a compilation in two passes: preprocessing and compiling.  This
1568 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1569 @option{-B} option.  The user supplied compilation step can then add in
1570 an additional preprocessing step after normal preprocessing but before
1571 compiling.  The default is to use the integrated cpp (internal cpp)
1573 The semantics of this option will change if "cc1", "cc1plus", and
1574 "cc1obj" are merged.
1576 @cindex traditional C language
1577 @cindex C language, traditional
1578 @item -traditional
1579 @itemx -traditional-cpp
1580 @opindex traditional-cpp
1581 @opindex traditional
1582 Formerly, these options caused GCC to attempt to emulate a pre-standard
1583 C compiler.  They are now only supported with the @option{-E} switch.
1584 The preprocessor continues to support a pre-standard mode.  See the GNU
1585 CPP manual for details.
1587 @item -fcond-mismatch
1588 @opindex fcond-mismatch
1589 Allow conditional expressions with mismatched types in the second and
1590 third arguments.  The value of such an expression is void.  This option
1591 is not supported for C++.
1593 @item -flax-vector-conversions
1594 @opindex flax-vector-conversions
1595 Allow implicit conversions between vectors with differing numbers of
1596 elements and/or incompatible element types.  This option should not be
1597 used for new code.
1599 @item -funsigned-char
1600 @opindex funsigned-char
1601 Let the type @code{char} be unsigned, like @code{unsigned char}.
1603 Each kind of machine has a default for what @code{char} should
1604 be.  It is either like @code{unsigned char} by default or like
1605 @code{signed char} by default.
1607 Ideally, a portable program should always use @code{signed char} or
1608 @code{unsigned char} when it depends on the signedness of an object.
1609 But many programs have been written to use plain @code{char} and
1610 expect it to be signed, or expect it to be unsigned, depending on the
1611 machines they were written for.  This option, and its inverse, let you
1612 make such a program work with the opposite default.
1614 The type @code{char} is always a distinct type from each of
1615 @code{signed char} or @code{unsigned char}, even though its behavior
1616 is always just like one of those two.
1618 @item -fsigned-char
1619 @opindex fsigned-char
1620 Let the type @code{char} be signed, like @code{signed char}.
1622 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1623 the negative form of @option{-funsigned-char}.  Likewise, the option
1624 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1626 @item -fsigned-bitfields
1627 @itemx -funsigned-bitfields
1628 @itemx -fno-signed-bitfields
1629 @itemx -fno-unsigned-bitfields
1630 @opindex fsigned-bitfields
1631 @opindex funsigned-bitfields
1632 @opindex fno-signed-bitfields
1633 @opindex fno-unsigned-bitfields
1634 These options control whether a bit-field is signed or unsigned, when the
1635 declaration does not use either @code{signed} or @code{unsigned}.  By
1636 default, such a bit-field is signed, because this is consistent: the
1637 basic integer types such as @code{int} are signed types.
1638 @end table
1640 @node C++ Dialect Options
1641 @section Options Controlling C++ Dialect
1643 @cindex compiler options, C++
1644 @cindex C++ options, command line
1645 @cindex options, C++
1646 This section describes the command-line options that are only meaningful
1647 for C++ programs; but you can also use most of the GNU compiler options
1648 regardless of what language your program is in.  For example, you
1649 might compile a file @code{firstClass.C} like this:
1651 @smallexample
1652 g++ -g -frepo -O -c firstClass.C
1653 @end smallexample
1655 @noindent
1656 In this example, only @option{-frepo} is an option meant
1657 only for C++ programs; you can use the other options with any
1658 language supported by GCC@.
1660 Here is a list of options that are @emph{only} for compiling C++ programs:
1662 @table @gcctabopt
1664 @item -fabi-version=@var{n}
1665 @opindex fabi-version
1666 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1667 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1668 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1669 the version that conforms most closely to the C++ ABI specification.
1670 Therefore, the ABI obtained using version 0 will change as ABI bugs
1671 are fixed.
1673 The default is version 2.
1675 @item -fno-access-control
1676 @opindex fno-access-control
1677 Turn off all access checking.  This switch is mainly useful for working
1678 around bugs in the access control code.
1680 @item -fcheck-new
1681 @opindex fcheck-new
1682 Check that the pointer returned by @code{operator new} is non-null
1683 before attempting to modify the storage allocated.  This check is
1684 normally unnecessary because the C++ standard specifies that
1685 @code{operator new} will only return @code{0} if it is declared
1686 @samp{throw()}, in which case the compiler will always check the
1687 return value even without this option.  In all other cases, when
1688 @code{operator new} has a non-empty exception specification, memory
1689 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1690 @samp{new (nothrow)}.
1692 @item -fconserve-space
1693 @opindex fconserve-space
1694 Put uninitialized or runtime-initialized global variables into the
1695 common segment, as C does.  This saves space in the executable at the
1696 cost of not diagnosing duplicate definitions.  If you compile with this
1697 flag and your program mysteriously crashes after @code{main()} has
1698 completed, you may have an object that is being destroyed twice because
1699 two definitions were merged.
1701 This option is no longer useful on most targets, now that support has
1702 been added for putting variables into BSS without making them common.
1704 @item -ffriend-injection
1705 @opindex ffriend-injection
1706 Inject friend functions into the enclosing namespace, so that they are
1707 visible outside the scope of the class in which they are declared.
1708 Friend functions were documented to work this way in the old Annotated
1709 C++ Reference Manual, and versions of G++ before 4.1 always worked
1710 that way.  However, in ISO C++ a friend function which is not declared
1711 in an enclosing scope can only be found using argument dependent
1712 lookup.  This option causes friends to be injected as they were in
1713 earlier releases.
1715 This option is for compatibility, and may be removed in a future
1716 release of G++.
1718 @item -fno-elide-constructors
1719 @opindex fno-elide-constructors
1720 The C++ standard allows an implementation to omit creating a temporary
1721 which is only used to initialize another object of the same type.
1722 Specifying this option disables that optimization, and forces G++ to
1723 call the copy constructor in all cases.
1725 @item -fno-enforce-eh-specs
1726 @opindex fno-enforce-eh-specs
1727 Don't generate code to check for violation of exception specifications
1728 at runtime.  This option violates the C++ standard, but may be useful
1729 for reducing code size in production builds, much like defining
1730 @samp{NDEBUG}.  This does not give user code permission to throw
1731 exceptions in violation of the exception specifications; the compiler
1732 will still optimize based on the specifications, so throwing an
1733 unexpected exception will result in undefined behavior.
1735 @item -ffor-scope
1736 @itemx -fno-for-scope
1737 @opindex ffor-scope
1738 @opindex fno-for-scope
1739 If @option{-ffor-scope} is specified, the scope of variables declared in
1740 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1741 as specified by the C++ standard.
1742 If @option{-fno-for-scope} is specified, the scope of variables declared in
1743 a @i{for-init-statement} extends to the end of the enclosing scope,
1744 as was the case in old versions of G++, and other (traditional)
1745 implementations of C++.
1747 The default if neither flag is given to follow the standard,
1748 but to allow and give a warning for old-style code that would
1749 otherwise be invalid, or have different behavior.
1751 @item -fno-gnu-keywords
1752 @opindex fno-gnu-keywords
1753 Do not recognize @code{typeof} as a keyword, so that code can use this
1754 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1755 @option{-ansi} implies @option{-fno-gnu-keywords}.
1757 @item -fno-implicit-templates
1758 @opindex fno-implicit-templates
1759 Never emit code for non-inline templates which are instantiated
1760 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1761 @xref{Template Instantiation}, for more information.
1763 @item -fno-implicit-inline-templates
1764 @opindex fno-implicit-inline-templates
1765 Don't emit code for implicit instantiations of inline templates, either.
1766 The default is to handle inlines differently so that compiles with and
1767 without optimization will need the same set of explicit instantiations.
1769 @item -fno-implement-inlines
1770 @opindex fno-implement-inlines
1771 To save space, do not emit out-of-line copies of inline functions
1772 controlled by @samp{#pragma implementation}.  This will cause linker
1773 errors if these functions are not inlined everywhere they are called.
1775 @item -fms-extensions
1776 @opindex fms-extensions
1777 Disable pedantic warnings about constructs used in MFC, such as implicit
1778 int and getting a pointer to member function via non-standard syntax.
1780 @item -fno-nonansi-builtins
1781 @opindex fno-nonansi-builtins
1782 Disable built-in declarations of functions that are not mandated by
1783 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1784 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1786 @item -fno-operator-names
1787 @opindex fno-operator-names
1788 Do not treat the operator name keywords @code{and}, @code{bitand},
1789 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1790 synonyms as keywords.
1792 @item -fno-optional-diags
1793 @opindex fno-optional-diags
1794 Disable diagnostics that the standard says a compiler does not need to
1795 issue.  Currently, the only such diagnostic issued by G++ is the one for
1796 a name having multiple meanings within a class.
1798 @item -fpermissive
1799 @opindex fpermissive
1800 Downgrade some diagnostics about nonconformant code from errors to
1801 warnings.  Thus, using @option{-fpermissive} will allow some
1802 nonconforming code to compile.
1804 @item -frepo
1805 @opindex frepo
1806 Enable automatic template instantiation at link time.  This option also
1807 implies @option{-fno-implicit-templates}.  @xref{Template
1808 Instantiation}, for more information.
1810 @item -fno-rtti
1811 @opindex fno-rtti
1812 Disable generation of information about every class with virtual
1813 functions for use by the C++ runtime type identification features
1814 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1815 of the language, you can save some space by using this flag.  Note that
1816 exception handling uses the same information, but it will generate it as
1817 needed. The @samp{dynamic_cast} operator can still be used for casts that
1818 do not require runtime type information, i.e.@: casts to @code{void *} or to
1819 unambiguous base classes.
1821 @item -fstats
1822 @opindex fstats
1823 Emit statistics about front-end processing at the end of the compilation.
1824 This information is generally only useful to the G++ development team.
1826 @item -ftemplate-depth-@var{n}
1827 @opindex ftemplate-depth
1828 Set the maximum instantiation depth for template classes to @var{n}.
1829 A limit on the template instantiation depth is needed to detect
1830 endless recursions during template class instantiation.  ANSI/ISO C++
1831 conforming programs must not rely on a maximum depth greater than 17.
1833 @item -fno-threadsafe-statics
1834 @opindex fno-threadsafe-statics
1835 Do not emit the extra code to use the routines specified in the C++
1836 ABI for thread-safe initialization of local statics.  You can use this
1837 option to reduce code size slightly in code that doesn't need to be
1838 thread-safe.
1840 @item -fuse-cxa-atexit
1841 @opindex fuse-cxa-atexit
1842 Register destructors for objects with static storage duration with the
1843 @code{__cxa_atexit} function rather than the @code{atexit} function.
1844 This option is required for fully standards-compliant handling of static
1845 destructors, but will only work if your C library supports
1846 @code{__cxa_atexit}.
1848 @item -fno-use-cxa-get-exception-ptr
1849 @opindex fno-use-cxa-get-exception-ptr
1850 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1851 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1852 if the runtime routine is not available.
1854 @item -fvisibility-inlines-hidden
1855 @opindex fvisibility-inlines-hidden
1856 This switch declares that the user does not attempt to compare
1857 pointers to inline methods where the addresses of the two functions
1858 were taken in different shared objects.
1860 The effect of this is that GCC may, effectively, mark inline methods with
1861 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1862 appear in the export table of a DSO and do not require a PLT indirection
1863 when used within the DSO@.  Enabling this option can have a dramatic effect
1864 on load and link times of a DSO as it massively reduces the size of the
1865 dynamic export table when the library makes heavy use of templates.
1867 The behavior of this switch is not quite the same as marking the
1868 methods as hidden directly, because it does not affect static variables
1869 local to the function or cause the compiler to deduce that
1870 the function is defined in only one shared object.
1872 You may mark a method as having a visibility explicitly to negate the
1873 effect of the switch for that method.  For example, if you do want to
1874 compare pointers to a particular inline method, you might mark it as
1875 having default visibility.  Marking the enclosing class with explicit
1876 visibility will have no effect.
1878 Explicitly instantiated inline methods are unaffected by this option
1879 as their linkage might otherwise cross a shared library boundary.
1880 @xref{Template Instantiation}.
1882 @item -fvisibility-ms-compat
1883 @opindex fvisibility-ms-compat
1884 This flag attempts to use visibility settings to make GCC's C++
1885 linkage model compatible with that of Microsoft Visual Studio.
1887 The flag makes these changes to GCC's linkage model:
1889 @enumerate
1890 @item
1891 It sets the default visibility to @code{hidden}, like
1892 @option{-fvisibility=hidden}.
1894 @item
1895 Types, but not their members, are not hidden by default.
1897 @item
1898 The One Definition Rule is relaxed for types without explicit
1899 visibility specifications which are defined in more than one different
1900 shared object: those declarations are permitted if they would have
1901 been permitted when this option was not used.
1902 @end enumerate
1904 In new code it is better to use @option{-fvisibility=hidden} and
1905 export those classes which are intended to be externally visible.
1906 Unfortunately it is possible for code to rely, perhaps accidentally,
1907 on the Visual Studio behavior.
1909 Among the consequences of these changes are that static data members
1910 of the same type with the same name but defined in different shared
1911 objects will be different, so changing one will not change the other;
1912 and that pointers to function members defined in different shared
1913 objects may not compare equal.  When this flag is given, it is a
1914 violation of the ODR to define types with the same name differently.
1916 @item -fno-weak
1917 @opindex fno-weak
1918 Do not use weak symbol support, even if it is provided by the linker.
1919 By default, G++ will use weak symbols if they are available.  This
1920 option exists only for testing, and should not be used by end-users;
1921 it will result in inferior code and has no benefits.  This option may
1922 be removed in a future release of G++.
1924 @item -nostdinc++
1925 @opindex nostdinc++
1926 Do not search for header files in the standard directories specific to
1927 C++, but do still search the other standard directories.  (This option
1928 is used when building the C++ library.)
1929 @end table
1931 In addition, these optimization, warning, and code generation options
1932 have meanings only for C++ programs:
1934 @table @gcctabopt
1935 @item -fno-default-inline
1936 @opindex fno-default-inline
1937 Do not assume @samp{inline} for functions defined inside a class scope.
1938 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1939 functions will have linkage like inline functions; they just won't be
1940 inlined by default.
1942 @item -Wabi @r{(C++ and Objective-C++ only)}
1943 @opindex Wabi
1944 @opindex Wno-abi
1945 Warn when G++ generates code that is probably not compatible with the
1946 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1947 all such cases, there are probably some cases that are not warned about,
1948 even though G++ is generating incompatible code.  There may also be
1949 cases where warnings are emitted even though the code that is generated
1950 will be compatible.
1952 You should rewrite your code to avoid these warnings if you are
1953 concerned about the fact that code generated by G++ may not be binary
1954 compatible with code generated by other compilers.
1956 The known incompatibilities at this point include:
1958 @itemize @bullet
1960 @item
1961 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1962 pack data into the same byte as a base class.  For example:
1964 @smallexample
1965 struct A @{ virtual void f(); int f1 : 1; @};
1966 struct B : public A @{ int f2 : 1; @};
1967 @end smallexample
1969 @noindent
1970 In this case, G++ will place @code{B::f2} into the same byte
1971 as@code{A::f1}; other compilers will not.  You can avoid this problem
1972 by explicitly padding @code{A} so that its size is a multiple of the
1973 byte size on your platform; that will cause G++ and other compilers to
1974 layout @code{B} identically.
1976 @item
1977 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1978 tail padding when laying out virtual bases.  For example:
1980 @smallexample
1981 struct A @{ virtual void f(); char c1; @};
1982 struct B @{ B(); char c2; @};
1983 struct C : public A, public virtual B @{@};
1984 @end smallexample
1986 @noindent
1987 In this case, G++ will not place @code{B} into the tail-padding for
1988 @code{A}; other compilers will.  You can avoid this problem by
1989 explicitly padding @code{A} so that its size is a multiple of its
1990 alignment (ignoring virtual base classes); that will cause G++ and other
1991 compilers to layout @code{C} identically.
1993 @item
1994 Incorrect handling of bit-fields with declared widths greater than that
1995 of their underlying types, when the bit-fields appear in a union.  For
1996 example:
1998 @smallexample
1999 union U @{ int i : 4096; @};
2000 @end smallexample
2002 @noindent
2003 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2004 union too small by the number of bits in an @code{int}.
2006 @item
2007 Empty classes can be placed at incorrect offsets.  For example:
2009 @smallexample
2010 struct A @{@};
2012 struct B @{
2013   A a;
2014   virtual void f ();
2017 struct C : public B, public A @{@};
2018 @end smallexample
2020 @noindent
2021 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2022 it should be placed at offset zero.  G++ mistakenly believes that the
2023 @code{A} data member of @code{B} is already at offset zero.
2025 @item
2026 Names of template functions whose types involve @code{typename} or
2027 template template parameters can be mangled incorrectly.
2029 @smallexample
2030 template <typename Q>
2031 void f(typename Q::X) @{@}
2033 template <template <typename> class Q>
2034 void f(typename Q<int>::X) @{@}
2035 @end smallexample
2037 @noindent
2038 Instantiations of these templates may be mangled incorrectly.
2040 @end itemize
2042 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2043 @opindex Wctor-dtor-privacy
2044 @opindex Wno-ctor-dtor-privacy
2045 Warn when a class seems unusable because all the constructors or
2046 destructors in that class are private, and it has neither friends nor
2047 public static member functions.
2049 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2050 @opindex Wnon-virtual-dtor
2051 @opindex Wno-non-virtual-dtor
2052 Warn when a class has virtual functions and accessible non-virtual
2053 destructor, in which case it would be possible but unsafe to delete
2054 an instance of a derived class through a pointer to the base class.
2055 This warning is also enabled if -Weffc++ is specified.
2057 @item -Wreorder @r{(C++ and Objective-C++ only)}
2058 @opindex Wreorder
2059 @opindex Wno-reorder
2060 @cindex reordering, warning
2061 @cindex warning for reordering of member initializers
2062 Warn when the order of member initializers given in the code does not
2063 match the order in which they must be executed.  For instance:
2065 @smallexample
2066 struct A @{
2067   int i;
2068   int j;
2069   A(): j (0), i (1) @{ @}
2071 @end smallexample
2073 The compiler will rearrange the member initializers for @samp{i}
2074 and @samp{j} to match the declaration order of the members, emitting
2075 a warning to that effect.  This warning is enabled by @option{-Wall}.
2076 @end table
2078 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2080 @table @gcctabopt
2081 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2082 @opindex Weffc++
2083 @opindex Wno-effc++
2084 Warn about violations of the following style guidelines from Scott Meyers'
2085 @cite{Effective C++} book:
2087 @itemize @bullet
2088 @item
2089 Item 11:  Define a copy constructor and an assignment operator for classes
2090 with dynamically allocated memory.
2092 @item
2093 Item 12:  Prefer initialization to assignment in constructors.
2095 @item
2096 Item 14:  Make destructors virtual in base classes.
2098 @item
2099 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2101 @item
2102 Item 23:  Don't try to return a reference when you must return an object.
2104 @end itemize
2106 Also warn about violations of the following style guidelines from
2107 Scott Meyers' @cite{More Effective C++} book:
2109 @itemize @bullet
2110 @item
2111 Item 6:  Distinguish between prefix and postfix forms of increment and
2112 decrement operators.
2114 @item
2115 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2117 @end itemize
2119 When selecting this option, be aware that the standard library
2120 headers do not obey all of these guidelines; use @samp{grep -v}
2121 to filter out those warnings.
2123 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2124 @opindex Wstrict-null-sentinel
2125 @opindex Wno-strict-null-sentinel
2126 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2127 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2128 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2129 it is guaranteed to of the same size as a pointer.  But this use is
2130 not portable across different compilers.
2132 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2133 @opindex Wno-non-template-friend
2134 @opindex Wnon-template-friend
2135 Disable warnings when non-templatized friend functions are declared
2136 within a template.  Since the advent of explicit template specification
2137 support in G++, if the name of the friend is an unqualified-id (i.e.,
2138 @samp{friend foo(int)}), the C++ language specification demands that the
2139 friend declare or define an ordinary, nontemplate function.  (Section
2140 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2141 could be interpreted as a particular specialization of a templatized
2142 function.  Because this non-conforming behavior is no longer the default
2143 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2144 check existing code for potential trouble spots and is on by default.
2145 This new compiler behavior can be turned off with
2146 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2147 but disables the helpful warning.
2149 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2150 @opindex Wold-style-cast
2151 @opindex Wno-old-style-cast
2152 Warn if an old-style (C-style) cast to a non-void type is used within
2153 a C++ program.  The new-style casts (@samp{dynamic_cast},
2154 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2155 less vulnerable to unintended effects and much easier to search for.
2157 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2158 @opindex Woverloaded-virtual
2159 @opindex Wno-overloaded-virtual
2160 @cindex overloaded virtual fn, warning
2161 @cindex warning for overloaded virtual fn
2162 Warn when a function declaration hides virtual functions from a
2163 base class.  For example, in:
2165 @smallexample
2166 struct A @{
2167   virtual void f();
2170 struct B: public A @{
2171   void f(int);
2173 @end smallexample
2175 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2176 like:
2178 @smallexample
2179 B* b;
2180 b->f();
2181 @end smallexample
2183 will fail to compile.
2185 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2186 @opindex Wno-pmf-conversions
2187 @opindex Wpmf-conversions
2188 Disable the diagnostic for converting a bound pointer to member function
2189 to a plain pointer.
2191 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2192 @opindex Wsign-promo
2193 @opindex Wno-sign-promo
2194 Warn when overload resolution chooses a promotion from unsigned or
2195 enumerated type to a signed type, over a conversion to an unsigned type of
2196 the same size.  Previous versions of G++ would try to preserve
2197 unsignedness, but the standard mandates the current behavior.
2199 @smallexample
2200 struct A @{
2201   operator int ();
2202   A& operator = (int);
2205 main ()
2207   A a,b;
2208   a = b;
2210 @end smallexample
2212 In this example, G++ will synthesize a default @samp{A& operator =
2213 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2214 @end table
2216 @node Objective-C and Objective-C++ Dialect Options
2217 @section Options Controlling Objective-C and Objective-C++ Dialects
2219 @cindex compiler options, Objective-C and Objective-C++
2220 @cindex Objective-C and Objective-C++ options, command line
2221 @cindex options, Objective-C and Objective-C++
2222 (NOTE: This manual does not describe the Objective-C and Objective-C++
2223 languages themselves.  See @xref{Standards,,Language Standards
2224 Supported by GCC}, for references.)
2226 This section describes the command-line options that are only meaningful
2227 for Objective-C and Objective-C++ programs, but you can also use most of
2228 the language-independent GNU compiler options.
2229 For example, you might compile a file @code{some_class.m} like this:
2231 @smallexample
2232 gcc -g -fgnu-runtime -O -c some_class.m
2233 @end smallexample
2235 @noindent
2236 In this example, @option{-fgnu-runtime} is an option meant only for
2237 Objective-C and Objective-C++ programs; you can use the other options with
2238 any language supported by GCC@.
2240 Note that since Objective-C is an extension of the C language, Objective-C
2241 compilations may also use options specific to the C front-end (e.g.,
2242 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2243 C++-specific options (e.g., @option{-Wabi}).
2245 Here is a list of options that are @emph{only} for compiling Objective-C
2246 and Objective-C++ programs:
2248 @table @gcctabopt
2249 @item -fconstant-string-class=@var{class-name}
2250 @opindex fconstant-string-class
2251 Use @var{class-name} as the name of the class to instantiate for each
2252 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2253 class name is @code{NXConstantString} if the GNU runtime is being used, and
2254 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2255 @option{-fconstant-cfstrings} option, if also present, will override the
2256 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2257 to be laid out as constant CoreFoundation strings.
2259 @item -fgnu-runtime
2260 @opindex fgnu-runtime
2261 Generate object code compatible with the standard GNU Objective-C
2262 runtime.  This is the default for most types of systems.
2264 @item -fnext-runtime
2265 @opindex fnext-runtime
2266 Generate output compatible with the NeXT runtime.  This is the default
2267 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2268 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2269 used.
2271 @item -fno-nil-receivers
2272 @opindex fno-nil-receivers
2273 Assume that all Objective-C message dispatches (e.g.,
2274 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2275 is not @code{nil}.  This allows for more efficient entry points in the runtime
2276 to be used.  Currently, this option is only available in conjunction with
2277 the NeXT runtime on Mac OS X 10.3 and later.
2279 @item -fobjc-call-cxx-cdtors
2280 @opindex fobjc-call-cxx-cdtors
2281 For each Objective-C class, check if any of its instance variables is a
2282 C++ object with a non-trivial default constructor.  If so, synthesize a
2283 special @code{- (id) .cxx_construct} instance method that will run
2284 non-trivial default constructors on any such instance variables, in order,
2285 and then return @code{self}.  Similarly, check if any instance variable
2286 is a C++ object with a non-trivial destructor, and if so, synthesize a
2287 special @code{- (void) .cxx_destruct} method that will run
2288 all such default destructors, in reverse order.
2290 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2291 thusly generated will only operate on instance variables declared in the
2292 current Objective-C class, and not those inherited from superclasses.  It
2293 is the responsibility of the Objective-C runtime to invoke all such methods
2294 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2295 will be invoked by the runtime immediately after a new object
2296 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2297 be invoked immediately before the runtime deallocates an object instance.
2299 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2300 support for invoking the @code{- (id) .cxx_construct} and
2301 @code{- (void) .cxx_destruct} methods.
2303 @item -fobjc-direct-dispatch
2304 @opindex fobjc-direct-dispatch
2305 Allow fast jumps to the message dispatcher.  On Darwin this is
2306 accomplished via the comm page.
2308 @item -fobjc-exceptions
2309 @opindex fobjc-exceptions
2310 Enable syntactic support for structured exception handling in Objective-C,
2311 similar to what is offered by C++ and Java.  This option is
2312 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2313 earlier.
2315 @smallexample
2316   @@try @{
2317     @dots{}
2318        @@throw expr;
2319     @dots{}
2320   @}
2321   @@catch (AnObjCClass *exc) @{
2322     @dots{}
2323       @@throw expr;
2324     @dots{}
2325       @@throw;
2326     @dots{}
2327   @}
2328   @@catch (AnotherClass *exc) @{
2329     @dots{}
2330   @}
2331   @@catch (id allOthers) @{
2332     @dots{}
2333   @}
2334   @@finally @{
2335     @dots{}
2336       @@throw expr;
2337     @dots{}
2338   @}
2339 @end smallexample
2341 The @code{@@throw} statement may appear anywhere in an Objective-C or
2342 Objective-C++ program; when used inside of a @code{@@catch} block, the
2343 @code{@@throw} may appear without an argument (as shown above), in which case
2344 the object caught by the @code{@@catch} will be rethrown.
2346 Note that only (pointers to) Objective-C objects may be thrown and
2347 caught using this scheme.  When an object is thrown, it will be caught
2348 by the nearest @code{@@catch} clause capable of handling objects of that type,
2349 analogously to how @code{catch} blocks work in C++ and Java.  A
2350 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2351 any and all Objective-C exceptions not caught by previous @code{@@catch}
2352 clauses (if any).
2354 The @code{@@finally} clause, if present, will be executed upon exit from the
2355 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2356 regardless of whether any exceptions are thrown, caught or rethrown
2357 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2358 of the @code{finally} clause in Java.
2360 There are several caveats to using the new exception mechanism:
2362 @itemize @bullet
2363 @item
2364 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2365 idioms provided by the @code{NSException} class, the new
2366 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2367 systems, due to additional functionality needed in the (NeXT) Objective-C
2368 runtime.
2370 @item
2371 As mentioned above, the new exceptions do not support handling
2372 types other than Objective-C objects.   Furthermore, when used from
2373 Objective-C++, the Objective-C exception model does not interoperate with C++
2374 exceptions at this time.  This means you cannot @code{@@throw} an exception
2375 from Objective-C and @code{catch} it in C++, or vice versa
2376 (i.e., @code{throw @dots{} @@catch}).
2377 @end itemize
2379 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2380 blocks for thread-safe execution:
2382 @smallexample
2383   @@synchronized (ObjCClass *guard) @{
2384     @dots{}
2385   @}
2386 @end smallexample
2388 Upon entering the @code{@@synchronized} block, a thread of execution shall
2389 first check whether a lock has been placed on the corresponding @code{guard}
2390 object by another thread.  If it has, the current thread shall wait until
2391 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2392 the current thread will place its own lock on it, execute the code contained in
2393 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2394 making @code{guard} available to other threads).
2396 Unlike Java, Objective-C does not allow for entire methods to be marked
2397 @code{@@synchronized}.  Note that throwing exceptions out of
2398 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2399 to be unlocked properly.
2401 @item -fobjc-gc
2402 @opindex fobjc-gc
2403 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2405 @item -freplace-objc-classes
2406 @opindex freplace-objc-classes
2407 Emit a special marker instructing @command{ld(1)} not to statically link in
2408 the resulting object file, and allow @command{dyld(1)} to load it in at
2409 run time instead.  This is used in conjunction with the Fix-and-Continue
2410 debugging mode, where the object file in question may be recompiled and
2411 dynamically reloaded in the course of program execution, without the need
2412 to restart the program itself.  Currently, Fix-and-Continue functionality
2413 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2414 and later.
2416 @item -fzero-link
2417 @opindex fzero-link
2418 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2419 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2420 compile time) with static class references that get initialized at load time,
2421 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2422 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2423 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2424 for individual class implementations to be modified during program execution.
2426 @item -gen-decls
2427 @opindex gen-decls
2428 Dump interface declarations for all classes seen in the source file to a
2429 file named @file{@var{sourcename}.decl}.
2431 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2432 @opindex Wassign-intercept
2433 @opindex Wno-assign-intercept
2434 Warn whenever an Objective-C assignment is being intercepted by the
2435 garbage collector.
2437 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2438 @opindex Wno-protocol
2439 @opindex Wprotocol
2440 If a class is declared to implement a protocol, a warning is issued for
2441 every method in the protocol that is not implemented by the class.  The
2442 default behavior is to issue a warning for every method not explicitly
2443 implemented in the class, even if a method implementation is inherited
2444 from the superclass.  If you use the @option{-Wno-protocol} option, then
2445 methods inherited from the superclass are considered to be implemented,
2446 and no warning is issued for them.
2448 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2449 @opindex Wselector
2450 @opindex Wno-selector
2451 Warn if multiple methods of different types for the same selector are
2452 found during compilation.  The check is performed on the list of methods
2453 in the final stage of compilation.  Additionally, a check is performed
2454 for each selector appearing in a @code{@@selector(@dots{})}
2455 expression, and a corresponding method for that selector has been found
2456 during compilation.  Because these checks scan the method table only at
2457 the end of compilation, these warnings are not produced if the final
2458 stage of compilation is not reached, for example because an error is
2459 found during compilation, or because the @option{-fsyntax-only} option is
2460 being used.
2462 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2463 @opindex Wstrict-selector-match
2464 @opindex Wno-strict-selector-match
2465 Warn if multiple methods with differing argument and/or return types are
2466 found for a given selector when attempting to send a message using this
2467 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2468 is off (which is the default behavior), the compiler will omit such warnings
2469 if any differences found are confined to types which share the same size
2470 and alignment.
2472 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2473 @opindex Wundeclared-selector
2474 @opindex Wno-undeclared-selector
2475 Warn if a @code{@@selector(@dots{})} expression referring to an
2476 undeclared selector is found.  A selector is considered undeclared if no
2477 method with that name has been declared before the
2478 @code{@@selector(@dots{})} expression, either explicitly in an
2479 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2480 an @code{@@implementation} section.  This option always performs its
2481 checks as soon as a @code{@@selector(@dots{})} expression is found,
2482 while @option{-Wselector} only performs its checks in the final stage of
2483 compilation.  This also enforces the coding style convention
2484 that methods and selectors must be declared before being used.
2486 @item -print-objc-runtime-info
2487 @opindex print-objc-runtime-info
2488 Generate C header describing the largest structure that is passed by
2489 value, if any.
2491 @end table
2493 @node Language Independent Options
2494 @section Options to Control Diagnostic Messages Formatting
2495 @cindex options to control diagnostics formatting
2496 @cindex diagnostic messages
2497 @cindex message formatting
2499 Traditionally, diagnostic messages have been formatted irrespective of
2500 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2501 below can be used to control the diagnostic messages formatting
2502 algorithm, e.g.@: how many characters per line, how often source location
2503 information should be reported.  Right now, only the C++ front end can
2504 honor these options.  However it is expected, in the near future, that
2505 the remaining front ends would be able to digest them correctly.
2507 @table @gcctabopt
2508 @item -fmessage-length=@var{n}
2509 @opindex fmessage-length
2510 Try to format error messages so that they fit on lines of about @var{n}
2511 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2512 the front ends supported by GCC@.  If @var{n} is zero, then no
2513 line-wrapping will be done; each error message will appear on a single
2514 line.
2516 @opindex fdiagnostics-show-location
2517 @item -fdiagnostics-show-location=once
2518 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2519 reporter to emit @emph{once} source location information; that is, in
2520 case the message is too long to fit on a single physical line and has to
2521 be wrapped, the source location won't be emitted (as prefix) again,
2522 over and over, in subsequent continuation lines.  This is the default
2523 behavior.
2525 @item -fdiagnostics-show-location=every-line
2526 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2527 messages reporter to emit the same source location information (as
2528 prefix) for physical lines that result from the process of breaking
2529 a message which is too long to fit on a single line.
2531 @item -fdiagnostics-show-option
2532 @opindex fdiagnostics-show-option
2533 This option instructs the diagnostic machinery to add text to each
2534 diagnostic emitted, which indicates which command line option directly
2535 controls that diagnostic, when such an option is known to the
2536 diagnostic machinery.
2538 @item -Wcoverage-mismatch
2539 @opindex Wcoverage-mismatch
2540 Warn if feedback profiles do not match when using the
2541 @option{-fprofile-use} option.
2542 If a source file was changed between @option{-fprofile-gen} and
2543 @option{-fprofile-use}, the files with the profile feedback can fail
2544 to match the source file and GCC can not use the profile feedback
2545 information.  By default, GCC emits an error message in this case.
2546 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2547 error.  GCC does not use appropriate feedback profiles, so using this
2548 option can result in poorly optimized code.  This option is useful
2549 only in the case of very minor changes such as bug fixes to an
2550 existing code-base.
2552 @end table
2554 @node Warning Options
2555 @section Options to Request or Suppress Warnings
2556 @cindex options to control warnings
2557 @cindex warning messages
2558 @cindex messages, warning
2559 @cindex suppressing warnings
2561 Warnings are diagnostic messages that report constructions which
2562 are not inherently erroneous but which are risky or suggest there
2563 may have been an error.
2565 The following language-independent options do not enable specific
2566 warnings but control the kinds of diagnostics produced by GCC.
2568 @table @gcctabopt
2569 @cindex syntax checking
2570 @item -fsyntax-only
2571 @opindex fsyntax-only
2572 Check the code for syntax errors, but don't do anything beyond that.
2574 @item -w
2575 @opindex w
2576 Inhibit all warning messages.
2578 @item -Werror
2579 @opindex Werror
2580 @opindex Wno-error
2581 Make all warnings into errors.
2583 @item -Werror=
2584 @opindex Werror=
2585 @opindex Wno-error=
2586 Make the specified warning into an error.  The specifier for a warning
2587 is appended, for example @option{-Werror=switch} turns the warnings
2588 controlled by @option{-Wswitch} into errors.  This switch takes a
2589 negative form, to be used to negate @option{-Werror} for specific
2590 warnings, for example @option{-Wno-error=switch} makes
2591 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2592 is in effect.  You can use the @option{-fdiagnostics-show-option}
2593 option to have each controllable warning amended with the option which
2594 controls it, to determine what to use with this option.
2596 Note that specifying @option{-Werror=}@var{foo} automatically implies
2597 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2598 imply anything.
2600 @item -Wfatal-errors
2601 @opindex Wfatal-errors
2602 @opindex Wno-fatal-errors
2603 This option causes the compiler to abort compilation on the first error
2604 occurred rather than trying to keep going and printing further error
2605 messages.
2607 @end table
2609 You can request many specific warnings with options beginning
2610 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2611 implicit declarations.  Each of these specific warning options also
2612 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2613 example, @option{-Wno-implicit}.  This manual lists only one of the
2614 two forms, whichever is not the default.  For further,
2615 language-specific options also refer to @ref{C++ Dialect Options} and
2616 @ref{Objective-C and Objective-C++ Dialect Options}.
2618 @table @gcctabopt
2619 @item -pedantic
2620 @opindex pedantic
2621 Issue all the warnings demanded by strict ISO C and ISO C++;
2622 reject all programs that use forbidden extensions, and some other
2623 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2624 version of the ISO C standard specified by any @option{-std} option used.
2626 Valid ISO C and ISO C++ programs should compile properly with or without
2627 this option (though a rare few will require @option{-ansi} or a
2628 @option{-std} option specifying the required version of ISO C)@.  However,
2629 without this option, certain GNU extensions and traditional C and C++
2630 features are supported as well.  With this option, they are rejected.
2632 @option{-pedantic} does not cause warning messages for use of the
2633 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2634 warnings are also disabled in the expression that follows
2635 @code{__extension__}.  However, only system header files should use
2636 these escape routes; application programs should avoid them.
2637 @xref{Alternate Keywords}.
2639 Some users try to use @option{-pedantic} to check programs for strict ISO
2640 C conformance.  They soon find that it does not do quite what they want:
2641 it finds some non-ISO practices, but not all---only those for which
2642 ISO C @emph{requires} a diagnostic, and some others for which
2643 diagnostics have been added.
2645 A feature to report any failure to conform to ISO C might be useful in
2646 some instances, but would require considerable additional work and would
2647 be quite different from @option{-pedantic}.  We don't have plans to
2648 support such a feature in the near future.
2650 Where the standard specified with @option{-std} represents a GNU
2651 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2652 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2653 extended dialect is based.  Warnings from @option{-pedantic} are given
2654 where they are required by the base standard.  (It would not make sense
2655 for such warnings to be given only for features not in the specified GNU
2656 C dialect, since by definition the GNU dialects of C include all
2657 features the compiler supports with the given option, and there would be
2658 nothing to warn about.)
2660 @item -pedantic-errors
2661 @opindex pedantic-errors
2662 Like @option{-pedantic}, except that errors are produced rather than
2663 warnings.
2665 @item -Wall
2666 @opindex Wall
2667 @opindex Wno-all
2668 This enables all the warnings about constructions that some users
2669 consider questionable, and that are easy to avoid (or modify to
2670 prevent the warning), even in conjunction with macros.  This also
2671 enables some language-specific warnings described in @ref{C++ Dialect
2672 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2674 @option{-Wall} turns on the following warning flags:
2676 @gccoptlist{-Waddress   @gol
2677 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2678 -Wc++0x-compat  @gol
2679 -Wchar-subscripts  @gol
2680 -Wimplicit-int  @gol
2681 -Wimplicit-function-declaration  @gol
2682 -Wcomment  @gol
2683 -Wformat   @gol
2684 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2685 -Wmissing-braces  @gol
2686 -Wnonnull  @gol
2687 -Wparentheses  @gol
2688 -Wpointer-sign  @gol
2689 -Wreorder   @gol
2690 -Wreturn-type  @gol
2691 -Wsequence-point  @gol
2692 -Wsign-compare @r{(only in C++)}  @gol
2693 -Wstrict-aliasing  @gol
2694 -Wstrict-overflow=1  @gol
2695 -Wswitch  @gol
2696 -Wtrigraphs  @gol
2697 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2698 -Wunknown-pragmas  @gol
2699 -Wunused-function  @gol
2700 -Wunused-label     @gol
2701 -Wunused-value     @gol
2702 -Wunused-variable  @gol
2703 -Wvolatile-register-var @gol
2706 Note that some warning flags are not implied by @option{-Wall}.  Some of
2707 them warn about constructions that users generally do not consider
2708 questionable, but which occasionally you might wish to check for;
2709 others warn about constructions that are necessary or hard to avoid in
2710 some cases, and there is no simple way to modify the code to suppress
2711 the warning. Some of them are enabled by @option{-Wextra} but many of
2712 them must be enabled individually.
2714 @item -Wextra
2715 @opindex W
2716 @opindex Wextra
2717 @opindex Wno-extra
2718 This enables some extra warning flags that are not enabled by
2719 @option{-Wall}. (This option used to be called @option{-W}.  The older
2720 name is still supported, but the newer name is more descriptive.)
2722 @gccoptlist{-Wclobbered  @gol
2723 -Wempty-body  @gol
2724 -Wignored-qualifiers @gol
2725 -Wmissing-field-initializers  @gol
2726 -Wmissing-parameter-type @r{(C only)}  @gol
2727 -Wold-style-declaration @r{(C only)}  @gol
2728 -Woverride-init  @gol
2729 -Wsign-compare  @gol
2730 -Wtype-limits  @gol
2731 -Wuninitialized @r{(only with} @option{-O1} @r{and above)}  @gol
2732 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2735 The option @option{-Wextra} also prints warning messages for the
2736 following cases:
2738 @itemize @bullet
2740 @item
2741 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2742 @samp{>}, or @samp{>=}.
2744 @item 
2745 (C++ only) An enumerator and a non-enumerator both appear in a
2746 conditional expression.
2748 @item 
2749 (C++ only) A non-static reference or non-static @samp{const} member
2750 appears in a class without constructors.
2752 @item 
2753 (C++ only) Ambiguous virtual bases.
2755 @item 
2756 (C++ only) Subscripting an array which has been declared @samp{register}.
2758 @item 
2759 (C++ only) Taking the address of a variable which has been declared
2760 @samp{register}.
2762 @item 
2763 (C++ only) A base class is not initialized in a derived class' copy
2764 constructor.
2766 @end itemize
2768 @item -Wno-import
2769 @opindex Wno-import
2770 @opindex Wimport
2771 Inhibit warning messages about the use of @samp{#import}.
2773 @item -Wchar-subscripts
2774 @opindex Wchar-subscripts
2775 @opindex Wno-char-subscripts
2776 Warn if an array subscript has type @code{char}.  This is a common cause
2777 of error, as programmers often forget that this type is signed on some
2778 machines.
2779 This warning is enabled by @option{-Wall}.
2781 @item -Wcomment
2782 @opindex Wcomment
2783 @opindex Wno-comment
2784 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2785 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2786 This warning is enabled by @option{-Wall}.
2788 @item -Wformat
2789 @opindex Wformat
2790 @opindex Wno-format
2791 @opindex ffreestanding
2792 @opindex fno-builtin
2793 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2794 the arguments supplied have types appropriate to the format string
2795 specified, and that the conversions specified in the format string make
2796 sense.  This includes standard functions, and others specified by format
2797 attributes (@pxref{Function Attributes}), in the @code{printf},
2798 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2799 not in the C standard) families (or other target-specific families).
2800 Which functions are checked without format attributes having been
2801 specified depends on the standard version selected, and such checks of
2802 functions without the attribute specified are disabled by
2803 @option{-ffreestanding} or @option{-fno-builtin}.
2805 The formats are checked against the format features supported by GNU
2806 libc version 2.2.  These include all ISO C90 and C99 features, as well
2807 as features from the Single Unix Specification and some BSD and GNU
2808 extensions.  Other library implementations may not support all these
2809 features; GCC does not support warning about features that go beyond a
2810 particular library's limitations.  However, if @option{-pedantic} is used
2811 with @option{-Wformat}, warnings will be given about format features not
2812 in the selected standard version (but not for @code{strfmon} formats,
2813 since those are not in any version of the C standard).  @xref{C Dialect
2814 Options,,Options Controlling C Dialect}.
2816 Since @option{-Wformat} also checks for null format arguments for
2817 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2819 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2820 aspects of format checking, the options @option{-Wformat-y2k},
2821 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2822 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2823 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2825 @item -Wformat-y2k
2826 @opindex Wformat-y2k
2827 @opindex Wno-format-y2k
2828 If @option{-Wformat} is specified, also warn about @code{strftime}
2829 formats which may yield only a two-digit year.
2831 @item -Wno-format-contains-nul
2832 @opindex Wno-format-contains-nul
2833 @opindex Wformat-contains-nul
2834 If @option{-Wformat} is specified, do not warn about format strings that
2835 contain NUL bytes.
2837 @item -Wno-format-extra-args
2838 @opindex Wno-format-extra-args
2839 @opindex Wformat-extra-args
2840 If @option{-Wformat} is specified, do not warn about excess arguments to a
2841 @code{printf} or @code{scanf} format function.  The C standard specifies
2842 that such arguments are ignored.
2844 Where the unused arguments lie between used arguments that are
2845 specified with @samp{$} operand number specifications, normally
2846 warnings are still given, since the implementation could not know what
2847 type to pass to @code{va_arg} to skip the unused arguments.  However,
2848 in the case of @code{scanf} formats, this option will suppress the
2849 warning if the unused arguments are all pointers, since the Single
2850 Unix Specification says that such unused arguments are allowed.
2852 @item -Wno-format-zero-length @r{(C and Objective-C only)}
2853 @opindex Wno-format-zero-length
2854 @opindex Wformat-zero-length
2855 If @option{-Wformat} is specified, do not warn about zero-length formats.
2856 The C standard specifies that zero-length formats are allowed.
2858 @item -Wformat-nonliteral
2859 @opindex Wformat-nonliteral
2860 @opindex Wno-format-nonliteral
2861 If @option{-Wformat} is specified, also warn if the format string is not a
2862 string literal and so cannot be checked, unless the format function
2863 takes its format arguments as a @code{va_list}.
2865 @item -Wformat-security
2866 @opindex Wformat-security
2867 @opindex Wno-format-security
2868 If @option{-Wformat} is specified, also warn about uses of format
2869 functions that represent possible security problems.  At present, this
2870 warns about calls to @code{printf} and @code{scanf} functions where the
2871 format string is not a string literal and there are no format arguments,
2872 as in @code{printf (foo);}.  This may be a security hole if the format
2873 string came from untrusted input and contains @samp{%n}.  (This is
2874 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2875 in future warnings may be added to @option{-Wformat-security} that are not
2876 included in @option{-Wformat-nonliteral}.)
2878 @item -Wformat=2
2879 @opindex Wformat=2
2880 @opindex Wno-format=2
2881 Enable @option{-Wformat} plus format checks not included in
2882 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2883 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2885 @item -Wnonnull @r{(C and Objective-C only)}
2886 @opindex Wnonnull
2887 @opindex Wno-nonnull
2888 Warn about passing a null pointer for arguments marked as
2889 requiring a non-null value by the @code{nonnull} function attribute.
2891 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2892 can be disabled with the @option{-Wno-nonnull} option.
2894 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2895 @opindex Winit-self
2896 @opindex Wno-init-self
2897 Warn about uninitialized variables which are initialized with themselves.
2898 Note this option can only be used with the @option{-Wuninitialized} option,
2899 which in turn only works with @option{-O1} and above.
2901 For example, GCC will warn about @code{i} being uninitialized in the
2902 following snippet only when @option{-Winit-self} has been specified:
2903 @smallexample
2904 @group
2905 int f()
2907   int i = i;
2908   return i;
2910 @end group
2911 @end smallexample
2913 @item -Wimplicit-int @r{(C and Objective-C only)}
2914 @opindex Wimplicit-int
2915 @opindex Wno-implicit-int
2916 Warn when a declaration does not specify a type.
2917 This warning is enabled by @option{-Wall}.
2919 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
2920 @opindex Wimplicit-function-declaration
2921 @opindex Wno-implicit-function-declaration
2922 Give a warning whenever a function is used before being declared. In
2923 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2924 enabled by default and it is made into an error by
2925 @option{-pedantic-errors}. This warning is also enabled by
2926 @option{-Wall}.
2928 @item -Wimplicit
2929 @opindex Wimplicit
2930 @opindex Wno-implicit
2931 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2932 This warning is enabled by @option{-Wall}.
2934 @item -Wignored-qualifiers @r{(C and C++ only)}
2935 @opindex Wignored-qualifiers
2936 @opindex Wno-ignored-qualifiers
2937 Warn if the return type of a function has a type qualifier
2938 such as @code{const}.  For ISO C such a type qualifier has no effect,
2939 since the value returned by a function is not an lvalue.
2940 For C++, the warning is only emitted for scalar types or @code{void}.
2941 ISO C prohibits qualified @code{void} return types on function
2942 definitions, so such return types always receive a warning
2943 even without this option.
2945 This warning is also enabled by @option{-Wextra}.
2947 @item -Wmain
2948 @opindex Wmain
2949 @opindex Wno-main
2950 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2951 function with external linkage, returning int, taking either zero
2952 arguments, two, or three arguments of appropriate types.
2953 This warning is enabled by @option{-Wall}.
2955 @item -Wmissing-braces
2956 @opindex Wmissing-braces
2957 @opindex Wno-missing-braces
2958 Warn if an aggregate or union initializer is not fully bracketed.  In
2959 the following example, the initializer for @samp{a} is not fully
2960 bracketed, but that for @samp{b} is fully bracketed.
2962 @smallexample
2963 int a[2][2] = @{ 0, 1, 2, 3 @};
2964 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2965 @end smallexample
2967 This warning is enabled by @option{-Wall}.
2969 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2970 @opindex Wmissing-include-dirs
2971 @opindex Wno-missing-include-dirs
2972 Warn if a user-supplied include directory does not exist.
2974 @item -Wparentheses
2975 @opindex Wparentheses
2976 @opindex Wno-parentheses
2977 Warn if parentheses are omitted in certain contexts, such
2978 as when there is an assignment in a context where a truth value
2979 is expected, or when operators are nested whose precedence people
2980 often get confused about.
2982 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2983 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2984 interpretation from that of ordinary mathematical notation.
2986 Also warn about constructions where there may be confusion to which
2987 @code{if} statement an @code{else} branch belongs.  Here is an example of
2988 such a case:
2990 @smallexample
2991 @group
2993   if (a)
2994     if (b)
2995       foo ();
2996   else
2997     bar ();
2999 @end group
3000 @end smallexample
3002 In C/C++, every @code{else} branch belongs to the innermost possible
3003 @code{if} statement, which in this example is @code{if (b)}.  This is
3004 often not what the programmer expected, as illustrated in the above
3005 example by indentation the programmer chose.  When there is the
3006 potential for this confusion, GCC will issue a warning when this flag
3007 is specified.  To eliminate the warning, add explicit braces around
3008 the innermost @code{if} statement so there is no way the @code{else}
3009 could belong to the enclosing @code{if}.  The resulting code would
3010 look like this:
3012 @smallexample
3013 @group
3015   if (a)
3016     @{
3017       if (b)
3018         foo ();
3019       else
3020         bar ();
3021     @}
3023 @end group
3024 @end smallexample
3026 This warning is enabled by @option{-Wall}.
3028 @item -Wsequence-point
3029 @opindex Wsequence-point
3030 @opindex Wno-sequence-point
3031 Warn about code that may have undefined semantics because of violations
3032 of sequence point rules in the C and C++ standards.
3034 The C and C++ standards defines the order in which expressions in a C/C++
3035 program are evaluated in terms of @dfn{sequence points}, which represent
3036 a partial ordering between the execution of parts of the program: those
3037 executed before the sequence point, and those executed after it.  These
3038 occur after the evaluation of a full expression (one which is not part
3039 of a larger expression), after the evaluation of the first operand of a
3040 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3041 function is called (but after the evaluation of its arguments and the
3042 expression denoting the called function), and in certain other places.
3043 Other than as expressed by the sequence point rules, the order of
3044 evaluation of subexpressions of an expression is not specified.  All
3045 these rules describe only a partial order rather than a total order,
3046 since, for example, if two functions are called within one expression
3047 with no sequence point between them, the order in which the functions
3048 are called is not specified.  However, the standards committee have
3049 ruled that function calls do not overlap.
3051 It is not specified when between sequence points modifications to the
3052 values of objects take effect.  Programs whose behavior depends on this
3053 have undefined behavior; the C and C++ standards specify that ``Between
3054 the previous and next sequence point an object shall have its stored
3055 value modified at most once by the evaluation of an expression.
3056 Furthermore, the prior value shall be read only to determine the value
3057 to be stored.''.  If a program breaks these rules, the results on any
3058 particular implementation are entirely unpredictable.
3060 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3061 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3062 diagnosed by this option, and it may give an occasional false positive
3063 result, but in general it has been found fairly effective at detecting
3064 this sort of problem in programs.
3066 The standard is worded confusingly, therefore there is some debate
3067 over the precise meaning of the sequence point rules in subtle cases.
3068 Links to discussions of the problem, including proposed formal
3069 definitions, may be found on the GCC readings page, at
3070 @w{@uref{http://gcc.gnu.org/readings.html}}.
3072 This warning is enabled by @option{-Wall} for C and C++.
3074 @item -Wreturn-type
3075 @opindex Wreturn-type
3076 @opindex Wno-return-type
3077 Warn whenever a function is defined with a return-type that defaults
3078 to @code{int}.  Also warn about any @code{return} statement with no
3079 return-value in a function whose return-type is not @code{void}
3080 (falling off the end of the function body is considered returning
3081 without a value), and about a @code{return} statement with a
3082 expression in a function whose return-type is @code{void}.
3084 For C++, a function without return type always produces a diagnostic
3085 message, even when @option{-Wno-return-type} is specified.  The only
3086 exceptions are @samp{main} and functions defined in system headers.
3088 This warning is enabled by @option{-Wall}.
3090 @item -Wswitch
3091 @opindex Wswitch
3092 @opindex Wno-switch
3093 Warn whenever a @code{switch} statement has an index of enumerated type
3094 and lacks a @code{case} for one or more of the named codes of that
3095 enumeration.  (The presence of a @code{default} label prevents this
3096 warning.)  @code{case} labels outside the enumeration range also
3097 provoke warnings when this option is used.
3098 This warning is enabled by @option{-Wall}.
3100 @item -Wswitch-default
3101 @opindex Wswitch-default
3102 @opindex Wno-switch-default
3103 Warn whenever a @code{switch} statement does not have a @code{default}
3104 case.
3106 @item -Wswitch-enum
3107 @opindex Wswitch-enum
3108 @opindex Wno-switch-enum
3109 Warn whenever a @code{switch} statement has an index of enumerated type
3110 and lacks a @code{case} for one or more of the named codes of that
3111 enumeration.  @code{case} labels outside the enumeration range also
3112 provoke warnings when this option is used.
3114 @item -Wtrigraphs
3115 @opindex Wtrigraphs
3116 @opindex Wno-trigraphs
3117 Warn if any trigraphs are encountered that might change the meaning of
3118 the program (trigraphs within comments are not warned about).
3119 This warning is enabled by @option{-Wall}.
3121 @item -Wunused-function
3122 @opindex Wunused-function
3123 @opindex Wno-unused-function
3124 Warn whenever a static function is declared but not defined or a
3125 non-inline static function is unused.
3126 This warning is enabled by @option{-Wall}.
3128 @item -Wunused-label
3129 @opindex Wunused-label
3130 @opindex Wno-unused-label
3131 Warn whenever a label is declared but not used.
3132 This warning is enabled by @option{-Wall}.
3134 To suppress this warning use the @samp{unused} attribute
3135 (@pxref{Variable Attributes}).
3137 @item -Wunused-parameter
3138 @opindex Wunused-parameter
3139 @opindex Wno-unused-parameter
3140 Warn whenever a function parameter is unused aside from its declaration.
3142 To suppress this warning use the @samp{unused} attribute
3143 (@pxref{Variable Attributes}).
3145 @item -Wunused-variable
3146 @opindex Wunused-variable
3147 @opindex Wno-unused-variable
3148 Warn whenever a local variable or non-constant static variable is unused
3149 aside from its declaration.
3150 This warning is enabled by @option{-Wall}.
3152 To suppress this warning use the @samp{unused} attribute
3153 (@pxref{Variable Attributes}).
3155 @item -Wunused-value
3156 @opindex Wunused-value
3157 @opindex Wno-unused-value
3158 Warn whenever a statement computes a result that is explicitly not
3159 used. To suppress this warning cast the unused expression to
3160 @samp{void}. This includes an expression-statement or the left-hand
3161 side of a comma expression that contains no side effects. For example,
3162 an expression such as @samp{x[i,j]} will cause a warning, while
3163 @samp{x[(void)i,j]} will not.
3165 This warning is enabled by @option{-Wall}.
3167 @item -Wunused
3168 @opindex Wunused
3169 @opindex Wno-unused
3170 All the above @option{-Wunused} options combined.
3172 In order to get a warning about an unused function parameter, you must
3173 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3174 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3176 @item -Wuninitialized
3177 @opindex Wuninitialized
3178 @opindex Wno-uninitialized
3179 Warn if an automatic variable is used without first being initialized or
3180 if a variable may be clobbered by a @code{setjmp} call.
3182 These warnings are possible only in optimizing compilation,
3183 because they require data flow information that is computed only
3184 when optimizing.  If you do not specify @option{-O}, you will not get
3185 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
3186 requiring @option{-O}.
3188 If you want to warn about code which uses the uninitialized value of the
3189 variable in its own initializer, use the @option{-Winit-self} option.
3191 These warnings occur for individual uninitialized or clobbered
3192 elements of structure, union or array variables as well as for
3193 variables which are uninitialized or clobbered as a whole.  They do
3194 not occur for variables or elements declared @code{volatile}.  Because
3195 these warnings depend on optimization, the exact variables or elements
3196 for which there are warnings will depend on the precise optimization
3197 options and version of GCC used.
3199 Note that there may be no warning about a variable that is used only
3200 to compute a value that itself is never used, because such
3201 computations may be deleted by data flow analysis before the warnings
3202 are printed.
3204 These warnings are made optional because GCC is not smart
3205 enough to see all the reasons why the code might be correct
3206 despite appearing to have an error.  Here is one example of how
3207 this can happen:
3209 @smallexample
3210 @group
3212   int x;
3213   switch (y)
3214     @{
3215     case 1: x = 1;
3216       break;
3217     case 2: x = 4;
3218       break;
3219     case 3: x = 5;
3220     @}
3221   foo (x);
3223 @end group
3224 @end smallexample
3226 @noindent
3227 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3228 always initialized, but GCC doesn't know this.  Here is
3229 another common case:
3231 @smallexample
3233   int save_y;
3234   if (change_y) save_y = y, y = new_y;
3235   @dots{}
3236   if (change_y) y = save_y;
3238 @end smallexample
3240 @noindent
3241 This has no bug because @code{save_y} is used only if it is set.
3243 @cindex @code{longjmp} warnings
3244 This option also warns when a non-volatile automatic variable might be
3245 changed by a call to @code{longjmp}.  These warnings as well are possible
3246 only in optimizing compilation.
3248 The compiler sees only the calls to @code{setjmp}.  It cannot know
3249 where @code{longjmp} will be called; in fact, a signal handler could
3250 call it at any point in the code.  As a result, you may get a warning
3251 even when there is in fact no problem because @code{longjmp} cannot
3252 in fact be called at the place which would cause a problem.
3254 Some spurious warnings can be avoided if you declare all the functions
3255 you use that never return as @code{noreturn}.  @xref{Function
3256 Attributes}.
3258 This warning is enabled by @option{-Wall} or @option{-Wextra} in
3259 optimizing compilations (@option{-O1} and above).
3261 @item -Wunknown-pragmas
3262 @opindex Wunknown-pragmas
3263 @opindex Wno-unknown-pragmas
3264 @cindex warning for unknown pragmas
3265 @cindex unknown pragmas, warning
3266 @cindex pragmas, warning of unknown
3267 Warn when a #pragma directive is encountered which is not understood by
3268 GCC@.  If this command line option is used, warnings will even be issued
3269 for unknown pragmas in system header files.  This is not the case if
3270 the warnings were only enabled by the @option{-Wall} command line option.
3272 @item -Wno-pragmas
3273 @opindex Wno-pragmas
3274 @opindex Wpragmas
3275 Do not warn about misuses of pragmas, such as incorrect parameters,
3276 invalid syntax, or conflicts between pragmas.  See also
3277 @samp{-Wunknown-pragmas}.
3279 @item -Wstrict-aliasing
3280 @opindex Wstrict-aliasing
3281 @opindex Wno-strict-aliasing
3282 This option is only active when @option{-fstrict-aliasing} is active.
3283 It warns about code which might break the strict aliasing rules that the
3284 compiler is using for optimization.  The warning does not catch all
3285 cases, but does attempt to catch the more common pitfalls.  It is
3286 included in @option{-Wall}.
3287 It is equivalent to @option{-Wstrict-aliasing=3}
3289 @item -Wstrict-aliasing=n
3290 @opindex Wstrict-aliasing=n
3291 @opindex Wno-strict-aliasing=n
3292 This option is only active when @option{-fstrict-aliasing} is active.
3293 It warns about code which might break the strict aliasing rules that the
3294 compiler is using for optimization.
3295 Higher levels correspond to higher accuracy (fewer false positives).
3296 Higher levels also correspond to more effort, similar to the way -O works.
3297 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3298 with n=3.
3300 Level 1: Most aggressive, quick, least accurate.
3301 Possibly useful when higher levels
3302 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3303 false negatives.  However, it has many false positives.
3304 Warns for all pointer conversions between possibly incompatible types, 
3305 even if never dereferenced.  Runs in the frontend only.
3307 Level 2: Aggressive, quick, not too precise.
3308 May still have many false positives (not as many as level 1 though),
3309 and few false negatives (but possibly more than level 1).
3310 Unlike level 1, it only warns when an address is taken.  Warns about
3311 incomplete types.  Runs in the frontend only.
3313 Level 3 (default for @option{-Wstrict-aliasing}): 
3314 Should have very few false positives and few false 
3315 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3316 Takes care of the common punn+dereference pattern in the frontend:
3317 @code{*(int*)&some_float}.
3318 If optimization is enabled, it also runs in the backend, where it deals 
3319 with multiple statement cases using flow-sensitive points-to information.
3320 Only warns when the converted pointer is dereferenced.
3321 Does not warn about incomplete types.
3323 @item -Wstrict-overflow
3324 @itemx -Wstrict-overflow=@var{n}
3325 @opindex Wstrict-overflow
3326 @opindex Wno-strict-overflow
3327 This option is only active when @option{-fstrict-overflow} is active.
3328 It warns about cases where the compiler optimizes based on the
3329 assumption that signed overflow does not occur.  Note that it does not
3330 warn about all cases where the code might overflow: it only warns
3331 about cases where the compiler implements some optimization.  Thus
3332 this warning depends on the optimization level.
3334 An optimization which assumes that signed overflow does not occur is
3335 perfectly safe if the values of the variables involved are such that
3336 overflow never does, in fact, occur.  Therefore this warning can
3337 easily give a false positive: a warning about code which is not
3338 actually a problem.  To help focus on important issues, several
3339 warning levels are defined.  No warnings are issued for the use of
3340 undefined signed overflow when estimating how many iterations a loop
3341 will require, in particular when determining whether a loop will be
3342 executed at all.
3344 @table @gcctabopt
3345 @item -Wstrict-overflow=1
3346 Warn about cases which are both questionable and easy to avoid.  For
3347 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3348 compiler will simplify this to @code{1}.  This level of
3349 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3350 are not, and must be explicitly requested.
3352 @item -Wstrict-overflow=2
3353 Also warn about other cases where a comparison is simplified to a
3354 constant.  For example: @code{abs (x) >= 0}.  This can only be
3355 simplified when @option{-fstrict-overflow} is in effect, because
3356 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3357 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3358 @option{-Wstrict-overflow=2}.
3360 @item -Wstrict-overflow=3
3361 Also warn about other cases where a comparison is simplified.  For
3362 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3364 @item -Wstrict-overflow=4
3365 Also warn about other simplifications not covered by the above cases.
3366 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3368 @item -Wstrict-overflow=5
3369 Also warn about cases where the compiler reduces the magnitude of a
3370 constant involved in a comparison.  For example: @code{x + 2 > y} will
3371 be simplified to @code{x + 1 >= y}.  This is reported only at the
3372 highest warning level because this simplification applies to many
3373 comparisons, so this warning level will give a very large number of
3374 false positives.
3375 @end table
3377 @item -Warray-bounds
3378 @opindex Wno-array-bounds
3379 @opindex Warray-bounds
3380 This option is only active when @option{-ftree-vrp} is active
3381 (default for -O2 and above). It warns about subscripts to arrays
3382 that are always out of bounds. This warning is enabled by @option{-Wall}.
3384 @item -Wno-div-by-zero
3385 @opindex Wno-div-by-zero
3386 @opindex Wdiv-by-zero
3387 Do not warn about compile-time integer division by zero.  Floating point
3388 division by zero is not warned about, as it can be a legitimate way of
3389 obtaining infinities and NaNs.
3391 @item -Wsystem-headers
3392 @opindex Wsystem-headers
3393 @opindex Wno-system-headers
3394 @cindex warnings from system headers
3395 @cindex system headers, warnings from
3396 Print warning messages for constructs found in system header files.
3397 Warnings from system headers are normally suppressed, on the assumption
3398 that they usually do not indicate real problems and would only make the
3399 compiler output harder to read.  Using this command line option tells
3400 GCC to emit warnings from system headers as if they occurred in user
3401 code.  However, note that using @option{-Wall} in conjunction with this
3402 option will @emph{not} warn about unknown pragmas in system
3403 headers---for that, @option{-Wunknown-pragmas} must also be used.
3405 @item -Wfloat-equal
3406 @opindex Wfloat-equal
3407 @opindex Wno-float-equal
3408 Warn if floating point values are used in equality comparisons.
3410 The idea behind this is that sometimes it is convenient (for the
3411 programmer) to consider floating-point values as approximations to
3412 infinitely precise real numbers.  If you are doing this, then you need
3413 to compute (by analyzing the code, or in some other way) the maximum or
3414 likely maximum error that the computation introduces, and allow for it
3415 when performing comparisons (and when producing output, but that's a
3416 different problem).  In particular, instead of testing for equality, you
3417 would check to see whether the two values have ranges that overlap; and
3418 this is done with the relational operators, so equality comparisons are
3419 probably mistaken.
3421 @item -Wtraditional @r{(C and Objective-C only)}
3422 @opindex Wtraditional
3423 @opindex Wno-traditional
3424 Warn about certain constructs that behave differently in traditional and
3425 ISO C@.  Also warn about ISO C constructs that have no traditional C
3426 equivalent, and/or problematic constructs which should be avoided.
3428 @itemize @bullet
3429 @item
3430 Macro parameters that appear within string literals in the macro body.
3431 In traditional C macro replacement takes place within string literals,
3432 but does not in ISO C@.
3434 @item
3435 In traditional C, some preprocessor directives did not exist.
3436 Traditional preprocessors would only consider a line to be a directive
3437 if the @samp{#} appeared in column 1 on the line.  Therefore
3438 @option{-Wtraditional} warns about directives that traditional C
3439 understands but would ignore because the @samp{#} does not appear as the
3440 first character on the line.  It also suggests you hide directives like
3441 @samp{#pragma} not understood by traditional C by indenting them.  Some
3442 traditional implementations would not recognize @samp{#elif}, so it
3443 suggests avoiding it altogether.
3445 @item
3446 A function-like macro that appears without arguments.
3448 @item
3449 The unary plus operator.
3451 @item
3452 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3453 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3454 constants.)  Note, these suffixes appear in macros defined in the system
3455 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3456 Use of these macros in user code might normally lead to spurious
3457 warnings, however GCC's integrated preprocessor has enough context to
3458 avoid warning in these cases.
3460 @item
3461 A function declared external in one block and then used after the end of
3462 the block.
3464 @item
3465 A @code{switch} statement has an operand of type @code{long}.
3467 @item
3468 A non-@code{static} function declaration follows a @code{static} one.
3469 This construct is not accepted by some traditional C compilers.
3471 @item
3472 The ISO type of an integer constant has a different width or
3473 signedness from its traditional type.  This warning is only issued if
3474 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3475 typically represent bit patterns, are not warned about.
3477 @item
3478 Usage of ISO string concatenation is detected.
3480 @item
3481 Initialization of automatic aggregates.
3483 @item
3484 Identifier conflicts with labels.  Traditional C lacks a separate
3485 namespace for labels.
3487 @item
3488 Initialization of unions.  If the initializer is zero, the warning is
3489 omitted.  This is done under the assumption that the zero initializer in
3490 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3491 initializer warnings and relies on default initialization to zero in the
3492 traditional C case.
3494 @item
3495 Conversions by prototypes between fixed/floating point values and vice
3496 versa.  The absence of these prototypes when compiling with traditional
3497 C would cause serious problems.  This is a subset of the possible
3498 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3500 @item
3501 Use of ISO C style function definitions.  This warning intentionally is
3502 @emph{not} issued for prototype declarations or variadic functions
3503 because these ISO C features will appear in your code when using
3504 libiberty's traditional C compatibility macros, @code{PARAMS} and
3505 @code{VPARAMS}.  This warning is also bypassed for nested functions
3506 because that feature is already a GCC extension and thus not relevant to
3507 traditional C compatibility.
3508 @end itemize
3510 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3511 @opindex Wtraditional-conversion
3512 @opindex Wno-traditional-conversion
3513 Warn if a prototype causes a type conversion that is different from what
3514 would happen to the same argument in the absence of a prototype.  This
3515 includes conversions of fixed point to floating and vice versa, and
3516 conversions changing the width or signedness of a fixed point argument
3517 except when the same as the default promotion.
3519 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3520 @opindex Wdeclaration-after-statement
3521 @opindex Wno-declaration-after-statement
3522 Warn when a declaration is found after a statement in a block.  This
3523 construct, known from C++, was introduced with ISO C99 and is by default
3524 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3525 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3527 @item -Wundef
3528 @opindex Wundef
3529 @opindex Wno-undef
3530 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3532 @item -Wno-endif-labels
3533 @opindex Wno-endif-labels
3534 @opindex Wendif-labels
3535 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3537 @item -Wshadow
3538 @opindex Wshadow
3539 @opindex Wno-shadow
3540 Warn whenever a local variable shadows another local variable, parameter or
3541 global variable or whenever a built-in function is shadowed.
3543 @item -Wlarger-than=@var{len}
3544 @opindex Wlarger-than=@var{len}
3545 @opindex Wlarger-than-@var{len}
3546 Warn whenever an object of larger than @var{len} bytes is defined.
3548 @item -Wframe-larger-than=@var{len}
3549 @opindex Wframe-larger-than
3550 Warn if the size of a function frame is larger than @var{len} bytes.
3551 The computation done to determine the stack frame size is approximate
3552 and not conservative.
3553 The actual requirements may be somewhat greater than @var{len}
3554 even if you do not get a warning.  In addition, any space allocated
3555 via @code{alloca}, variable-length arrays, or related constructs
3556 is not included by the compiler when determining
3557 whether or not to issue a warning.
3559 @item -Wunsafe-loop-optimizations
3560 @opindex Wunsafe-loop-optimizations
3561 @opindex Wno-unsafe-loop-optimizations
3562 Warn if the loop cannot be optimized because the compiler could not
3563 assume anything on the bounds of the loop indices.  With
3564 @option{-funsafe-loop-optimizations} warn if the compiler made
3565 such assumptions.
3567 @item -Wpointer-arith
3568 @opindex Wpointer-arith
3569 @opindex Wno-pointer-arith
3570 Warn about anything that depends on the ``size of'' a function type or
3571 of @code{void}.  GNU C assigns these types a size of 1, for
3572 convenience in calculations with @code{void *} pointers and pointers
3573 to functions.  In C++, warn also when an arithmetic operation involves
3574 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3576 @item -Wtype-limits
3577 @opindex Wtype-limits
3578 @opindex Wno-type-limits
3579 Warn if a comparison is always true or always false due to the limited
3580 range of the data type, but do not warn for constant expressions.  For
3581 example, warn if an unsigned variable is compared against zero with
3582 @samp{<} or @samp{>=}.  This warning is also enabled by
3583 @option{-Wextra}.
3585 @item -Wbad-function-cast @r{(C and Objective-C only)}
3586 @opindex Wbad-function-cast
3587 @opindex Wno-bad-function-cast
3588 Warn whenever a function call is cast to a non-matching type.
3589 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3591 @item -Wc++-compat @r{(C and Objective-C only)}
3592 Warn about ISO C constructs that are outside of the common subset of
3593 ISO C and ISO C++, e.g.@: request for implicit conversion from
3594 @code{void *} to a pointer to non-@code{void} type.
3596 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3597 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3598 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3599 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3601 @item -Wcast-qual
3602 @opindex Wcast-qual
3603 @opindex Wno-cast-qual
3604 Warn whenever a pointer is cast so as to remove a type qualifier from
3605 the target type.  For example, warn if a @code{const char *} is cast
3606 to an ordinary @code{char *}.
3608 @item -Wcast-align
3609 @opindex Wcast-align
3610 @opindex Wno-cast-align
3611 Warn whenever a pointer is cast such that the required alignment of the
3612 target is increased.  For example, warn if a @code{char *} is cast to
3613 an @code{int *} on machines where integers can only be accessed at
3614 two- or four-byte boundaries.
3616 @item -Wwrite-strings
3617 @opindex Wwrite-strings
3618 @opindex Wno-write-strings
3619 When compiling C, give string constants the type @code{const
3620 char[@var{length}]} so that
3621 copying the address of one into a non-@code{const} @code{char *}
3622 pointer will get a warning; when compiling C++, warn about the
3623 deprecated conversion from string literals to @code{char *}.  This
3624 warning, by default, is enabled for C++ programs.
3625 These warnings will help you find at
3626 compile time code that can try to write into a string constant, but
3627 only if you have been very careful about using @code{const} in
3628 declarations and prototypes.  Otherwise, it will just be a nuisance;
3629 this is why we did not make @option{-Wall} request these warnings.
3631 @item -Wclobbered
3632 @opindex Wclobbered
3633 @opindex Wno-clobbered
3634 Warn for variables that might be changed by @samp{longjmp} or
3635 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3637 @item -Wconversion
3638 @opindex Wconversion
3639 @opindex Wno-conversion
3640 Warn for implicit conversions that may alter a value. This includes
3641 conversions between real and integer, like @code{abs (x)} when
3642 @code{x} is @code{double}; conversions between signed and unsigned,
3643 like @code{unsigned ui = -1}; and conversions to smaller types, like
3644 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3645 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3646 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3647 conversions between signed and unsigned integers can be disabled by
3648 using @option{-Wno-sign-conversion}.
3650 For C++, also warn for conversions between @code{NULL} and non-pointer
3651 types; confusing overload resolution for user-defined conversions; and
3652 conversions that will never use a type conversion operator:
3653 conversions to @code{void}, the same type, a base class or a reference
3654 to them. Warnings about conversions between signed and unsigned
3655 integers are disabled by default in C++ unless
3656 @option{-Wsign-conversion} is explicitly enabled.
3658 @item -Wempty-body
3659 @opindex Wempty-body
3660 @opindex Wno-empty-body
3661 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3662 while} statement.  Additionally, in C++, warn when an empty body occurs
3663 in a @samp{while} or @samp{for} statement with no whitespacing before
3664 the semicolon.  This warning is also enabled by @option{-Wextra}.
3666 @item -Wsign-compare
3667 @opindex Wsign-compare
3668 @opindex Wno-sign-compare
3669 @cindex warning for comparison of signed and unsigned values
3670 @cindex comparison of signed and unsigned values, warning
3671 @cindex signed and unsigned values, comparison warning
3672 Warn when a comparison between signed and unsigned values could produce
3673 an incorrect result when the signed value is converted to unsigned.
3674 This warning is also enabled by @option{-Wextra}; to get the other warnings
3675 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3677 @item -Wsign-conversion
3678 @opindex Wsign-conversion
3679 @opindex Wno-sign-conversion
3680 Warn for implicit conversions that may change the sign of an integer
3681 value, like assigning a signed integer expression to an unsigned
3682 integer variable. An explicit cast silences the warning. In C, this
3683 option is enabled also by @option{-Wconversion}.
3685 @item -Waddress
3686 @opindex Waddress
3687 @opindex Wno-address
3688 Warn about suspicious uses of memory addresses. These include using
3689 the address of a function in a conditional expression, such as
3690 @code{void func(void); if (func)}, and comparisons against the memory
3691 address of a string literal, such as @code{if (x == "abc")}.  Such
3692 uses typically indicate a programmer error: the address of a function
3693 always evaluates to true, so their use in a conditional usually
3694 indicate that the programmer forgot the parentheses in a function
3695 call; and comparisons against string literals result in unspecified
3696 behavior and are not portable in C, so they usually indicate that the
3697 programmer intended to use @code{strcmp}.  This warning is enabled by
3698 @option{-Wall}.
3700 @item -Wlogical-op
3701 @opindex Wlogical-op
3702 @opindex Wno-logical-op
3703 Warn about suspicious uses of logical operators in expressions.
3704 This includes using logical operators in contexts where a
3705 bit-wise operator is likely to be expected.
3707 @item -Waggregate-return
3708 @opindex Waggregate-return
3709 @opindex Wno-aggregate-return
3710 Warn if any functions that return structures or unions are defined or
3711 called.  (In languages where you can return an array, this also elicits
3712 a warning.)
3714 @item -Wno-attributes
3715 @opindex Wno-attributes
3716 @opindex Wattributes
3717 Do not warn if an unexpected @code{__attribute__} is used, such as
3718 unrecognized attributes, function attributes applied to variables,
3719 etc.  This will not stop errors for incorrect use of supported
3720 attributes.
3722 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3723 @opindex Wstrict-prototypes
3724 @opindex Wno-strict-prototypes
3725 Warn if a function is declared or defined without specifying the
3726 argument types.  (An old-style function definition is permitted without
3727 a warning if preceded by a declaration which specifies the argument
3728 types.)
3730 @item -Wold-style-declaration @r{(C and Objective-C only)}
3731 @opindex Wold-style-declaration
3732 @opindex Wno-old-style-declaration
3733 Warn for obsolescent usages, according to the C Standard, in a
3734 declaration. For example, warn if storage-class specifiers like
3735 @code{static} are not the first things in a declaration.  This warning
3736 is also enabled by @option{-Wextra}.
3738 @item -Wold-style-definition @r{(C and Objective-C only)}
3739 @opindex Wold-style-definition
3740 @opindex Wno-old-style-definition
3741 Warn if an old-style function definition is used.  A warning is given
3742 even if there is a previous prototype.
3744 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3745 @opindex Wmissing-parameter-type
3746 @opindex Wno-missing-parameter-type
3747 A function parameter is declared without a type specifier in K&R-style
3748 functions:
3750 @smallexample
3751 void foo(bar) @{ @}
3752 @end smallexample
3754 This warning is also enabled by @option{-Wextra}.
3756 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3757 @opindex Wmissing-prototypes
3758 @opindex Wno-missing-prototypes
3759 Warn if a global function is defined without a previous prototype
3760 declaration.  This warning is issued even if the definition itself
3761 provides a prototype.  The aim is to detect global functions that fail
3762 to be declared in header files.
3764 @item -Wmissing-declarations
3765 @opindex Wmissing-declarations
3766 @opindex Wno-missing-declarations
3767 Warn if a global function is defined without a previous declaration.
3768 Do so even if the definition itself provides a prototype.
3769 Use this option to detect global functions that are not declared in
3770 header files.  In C++, no warnings are issued for function templates,
3771 or for inline functions, or for functions in anonymous namespaces.
3773 @item -Wmissing-field-initializers
3774 @opindex Wmissing-field-initializers
3775 @opindex Wno-missing-field-initializers
3776 @opindex W
3777 @opindex Wextra
3778 @opindex Wno-extra
3779 Warn if a structure's initializer has some fields missing.  For
3780 example, the following code would cause such a warning, because
3781 @code{x.h} is implicitly zero:
3783 @smallexample
3784 struct s @{ int f, g, h; @};
3785 struct s x = @{ 3, 4 @};
3786 @end smallexample
3788 This option does not warn about designated initializers, so the following
3789 modification would not trigger a warning:
3791 @smallexample
3792 struct s @{ int f, g, h; @};
3793 struct s x = @{ .f = 3, .g = 4 @};
3794 @end smallexample
3796 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3797 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3799 @item -Wmissing-noreturn
3800 @opindex Wmissing-noreturn
3801 @opindex Wno-missing-noreturn
3802 Warn about functions which might be candidates for attribute @code{noreturn}.
3803 Note these are only possible candidates, not absolute ones.  Care should
3804 be taken to manually verify functions actually do not ever return before
3805 adding the @code{noreturn} attribute, otherwise subtle code generation
3806 bugs could be introduced.  You will not get a warning for @code{main} in
3807 hosted C environments.
3809 @item -Wmissing-format-attribute
3810 @opindex Wmissing-format-attribute
3811 @opindex Wno-missing-format-attribute
3812 @opindex Wformat
3813 @opindex Wno-format
3814 Warn about function pointers which might be candidates for @code{format}
3815 attributes.  Note these are only possible candidates, not absolute ones.
3816 GCC will guess that function pointers with @code{format} attributes that
3817 are used in assignment, initialization, parameter passing or return
3818 statements should have a corresponding @code{format} attribute in the
3819 resulting type.  I.e.@: the left-hand side of the assignment or
3820 initialization, the type of the parameter variable, or the return type
3821 of the containing function respectively should also have a @code{format}
3822 attribute to avoid the warning.
3824 GCC will also warn about function definitions which might be
3825 candidates for @code{format} attributes.  Again, these are only
3826 possible candidates.  GCC will guess that @code{format} attributes
3827 might be appropriate for any function that calls a function like
3828 @code{vprintf} or @code{vscanf}, but this might not always be the
3829 case, and some functions for which @code{format} attributes are
3830 appropriate may not be detected.
3832 @item -Wno-multichar
3833 @opindex Wno-multichar
3834 @opindex Wmultichar
3835 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3836 Usually they indicate a typo in the user's code, as they have
3837 implementation-defined values, and should not be used in portable code.
3839 @item -Wnormalized=<none|id|nfc|nfkc>
3840 @opindex Wnormalized=
3841 @cindex NFC
3842 @cindex NFKC
3843 @cindex character set, input normalization
3844 In ISO C and ISO C++, two identifiers are different if they are
3845 different sequences of characters.  However, sometimes when characters
3846 outside the basic ASCII character set are used, you can have two
3847 different character sequences that look the same.  To avoid confusion,
3848 the ISO 10646 standard sets out some @dfn{normalization rules} which
3849 when applied ensure that two sequences that look the same are turned into
3850 the same sequence.  GCC can warn you if you are using identifiers which
3851 have not been normalized; this option controls that warning.
3853 There are four levels of warning that GCC supports.  The default is
3854 @option{-Wnormalized=nfc}, which warns about any identifier which is
3855 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3856 recommended form for most uses.
3858 Unfortunately, there are some characters which ISO C and ISO C++ allow
3859 in identifiers that when turned into NFC aren't allowable as
3860 identifiers.  That is, there's no way to use these symbols in portable
3861 ISO C or C++ and have all your identifiers in NFC@.
3862 @option{-Wnormalized=id} suppresses the warning for these characters.
3863 It is hoped that future versions of the standards involved will correct
3864 this, which is why this option is not the default.
3866 You can switch the warning off for all characters by writing
3867 @option{-Wnormalized=none}.  You would only want to do this if you
3868 were using some other normalization scheme (like ``D''), because
3869 otherwise you can easily create bugs that are literally impossible to see.
3871 Some characters in ISO 10646 have distinct meanings but look identical
3872 in some fonts or display methodologies, especially once formatting has
3873 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3874 LETTER N'', will display just like a regular @code{n} which has been
3875 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3876 normalization scheme to convert all these into a standard form as
3877 well, and GCC will warn if your code is not in NFKC if you use
3878 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3879 about every identifier that contains the letter O because it might be
3880 confused with the digit 0, and so is not the default, but may be
3881 useful as a local coding convention if the programming environment is
3882 unable to be fixed to display these characters distinctly.
3884 @item -Wno-deprecated
3885 @opindex Wno-deprecated
3886 @opindex Wdeprecated
3887 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
3889 @item -Wno-deprecated-declarations
3890 @opindex Wno-deprecated-declarations
3891 @opindex Wdeprecated-declarations
3892 Do not warn about uses of functions (@pxref{Function Attributes}),
3893 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3894 Attributes}) marked as deprecated by using the @code{deprecated}
3895 attribute.
3897 @item -Wno-overflow
3898 @opindex Wno-overflow
3899 @opindex Woverflow
3900 Do not warn about compile-time overflow in constant expressions.
3902 @item -Woverride-init @r{(C and Objective-C only)}
3903 @opindex Woverride-init
3904 @opindex Wno-override-init
3905 @opindex W
3906 @opindex Wextra
3907 @opindex Wno-extra
3908 Warn if an initialized field without side effects is overridden when
3909 using designated initializers (@pxref{Designated Inits, , Designated
3910 Initializers}).
3912 This warning is included in @option{-Wextra}.  To get other
3913 @option{-Wextra} warnings without this one, use @samp{-Wextra
3914 -Wno-override-init}.
3916 @item -Wpacked
3917 @opindex Wpacked
3918 @opindex Wno-packed
3919 Warn if a structure is given the packed attribute, but the packed
3920 attribute has no effect on the layout or size of the structure.
3921 Such structures may be mis-aligned for little benefit.  For
3922 instance, in this code, the variable @code{f.x} in @code{struct bar}
3923 will be misaligned even though @code{struct bar} does not itself
3924 have the packed attribute:
3926 @smallexample
3927 @group
3928 struct foo @{
3929   int x;
3930   char a, b, c, d;
3931 @} __attribute__((packed));
3932 struct bar @{
3933   char z;
3934   struct foo f;
3936 @end group
3937 @end smallexample
3939 @item -Wpadded
3940 @opindex Wpadded
3941 @opindex Wno-padded
3942 Warn if padding is included in a structure, either to align an element
3943 of the structure or to align the whole structure.  Sometimes when this
3944 happens it is possible to rearrange the fields of the structure to
3945 reduce the padding and so make the structure smaller.
3947 @item -Wredundant-decls
3948 @opindex Wredundant-decls
3949 @opindex Wno-redundant-decls
3950 Warn if anything is declared more than once in the same scope, even in
3951 cases where multiple declaration is valid and changes nothing.
3953 @item -Wnested-externs @r{(C and Objective-C only)}
3954 @opindex Wnested-externs
3955 @opindex Wno-nested-externs
3956 Warn if an @code{extern} declaration is encountered within a function.
3958 @item -Wunreachable-code
3959 @opindex Wunreachable-code
3960 @opindex Wno-unreachable-code
3961 Warn if the compiler detects that code will never be executed.
3963 This option is intended to warn when the compiler detects that at
3964 least a whole line of source code will never be executed, because
3965 some condition is never satisfied or because it is after a
3966 procedure that never returns.
3968 It is possible for this option to produce a warning even though there
3969 are circumstances under which part of the affected line can be executed,
3970 so care should be taken when removing apparently-unreachable code.
3972 For instance, when a function is inlined, a warning may mean that the
3973 line is unreachable in only one inlined copy of the function.
3975 This option is not made part of @option{-Wall} because in a debugging
3976 version of a program there is often substantial code which checks
3977 correct functioning of the program and is, hopefully, unreachable
3978 because the program does work.  Another common use of unreachable
3979 code is to provide behavior which is selectable at compile-time.
3981 @item -Winline
3982 @opindex Winline
3983 @opindex Wno-inline
3984 Warn if a function can not be inlined and it was declared as inline.
3985 Even with this option, the compiler will not warn about failures to
3986 inline functions declared in system headers.
3988 The compiler uses a variety of heuristics to determine whether or not
3989 to inline a function.  For example, the compiler takes into account
3990 the size of the function being inlined and the amount of inlining
3991 that has already been done in the current function.  Therefore,
3992 seemingly insignificant changes in the source program can cause the
3993 warnings produced by @option{-Winline} to appear or disappear.
3995 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
3996 @opindex Wno-invalid-offsetof
3997 @opindex Winvalid-offsetof
3998 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3999 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4000 to a non-POD type is undefined.  In existing C++ implementations,
4001 however, @samp{offsetof} typically gives meaningful results even when
4002 applied to certain kinds of non-POD types. (Such as a simple
4003 @samp{struct} that fails to be a POD type only by virtue of having a
4004 constructor.)  This flag is for users who are aware that they are
4005 writing nonportable code and who have deliberately chosen to ignore the
4006 warning about it.
4008 The restrictions on @samp{offsetof} may be relaxed in a future version
4009 of the C++ standard.
4011 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4012 @opindex Wno-int-to-pointer-cast
4013 @opindex Wint-to-pointer-cast
4014 Suppress warnings from casts to pointer type of an integer of a
4015 different size.
4017 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4018 @opindex Wno-pointer-to-int-cast
4019 @opindex Wpointer-to-int-cast
4020 Suppress warnings from casts from a pointer to an integer type of a
4021 different size.
4023 @item -Winvalid-pch
4024 @opindex Winvalid-pch
4025 @opindex Wno-invalid-pch
4026 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4027 the search path but can't be used.
4029 @item -Wlong-long
4030 @opindex Wlong-long
4031 @opindex Wno-long-long
4032 Warn if @samp{long long} type is used.  This is default.  To inhibit
4033 the warning messages, use @option{-Wno-long-long}.  Flags
4034 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
4035 only when @option{-pedantic} flag is used.
4037 @item -Wvariadic-macros
4038 @opindex Wvariadic-macros
4039 @opindex Wno-variadic-macros
4040 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4041 alternate syntax when in pedantic ISO C99 mode.  This is default.
4042 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4044 @item -Wvla
4045 @opindex Wvla
4046 @opindex Wno-vla
4047 Warn if variable length array is used in the code.
4048 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4049 the variable length array.
4051 @item -Wvolatile-register-var
4052 @opindex Wvolatile-register-var
4053 @opindex Wno-volatile-register-var
4054 Warn if a register variable is declared volatile.  The volatile
4055 modifier does not inhibit all optimizations that may eliminate reads
4056 and/or writes to register variables.  This warning is enabled by
4057 @option{-Wall}.
4059 @item -Wdisabled-optimization
4060 @opindex Wdisabled-optimization
4061 @opindex Wno-disabled-optimization
4062 Warn if a requested optimization pass is disabled.  This warning does
4063 not generally indicate that there is anything wrong with your code; it
4064 merely indicates that GCC's optimizers were unable to handle the code
4065 effectively.  Often, the problem is that your code is too big or too
4066 complex; GCC will refuse to optimize programs when the optimization
4067 itself is likely to take inordinate amounts of time.
4069 @item -Wpointer-sign @r{(C and Objective-C only)}
4070 @opindex Wpointer-sign
4071 @opindex Wno-pointer-sign
4072 Warn for pointer argument passing or assignment with different signedness.
4073 This option is only supported for C and Objective-C@.  It is implied by
4074 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4075 @option{-Wno-pointer-sign}.
4077 @item -Wstack-protector
4078 @opindex Wstack-protector
4079 @opindex Wno-stack-protector
4080 This option is only active when @option{-fstack-protector} is active.  It
4081 warns about functions that will not be protected against stack smashing.
4083 @item -Wno-mudflap
4084 @opindex Wno-mudflap
4085 Suppress warnings about constructs that cannot be instrumented by
4086 @option{-fmudflap}.
4088 @item -Woverlength-strings
4089 @opindex Woverlength-strings
4090 @opindex Wno-overlength-strings
4091 Warn about string constants which are longer than the ``minimum
4092 maximum'' length specified in the C standard.  Modern compilers
4093 generally allow string constants which are much longer than the
4094 standard's minimum limit, but very portable programs should avoid
4095 using longer strings.
4097 The limit applies @emph{after} string constant concatenation, and does
4098 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4099 C99, it was raised to 4095.  C++98 does not specify a normative
4100 minimum maximum, so we do not diagnose overlength strings in C++@.
4102 This option is implied by @option{-pedantic}, and can be disabled with
4103 @option{-Wno-overlength-strings}.
4104 @end table
4106 @node Debugging Options
4107 @section Options for Debugging Your Program or GCC
4108 @cindex options, debugging
4109 @cindex debugging information options
4111 GCC has various special options that are used for debugging
4112 either your program or GCC:
4114 @table @gcctabopt
4115 @item -g
4116 @opindex g
4117 Produce debugging information in the operating system's native format
4118 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4119 information.
4121 On most systems that use stabs format, @option{-g} enables use of extra
4122 debugging information that only GDB can use; this extra information
4123 makes debugging work better in GDB but will probably make other debuggers
4124 crash or
4125 refuse to read the program.  If you want to control for certain whether
4126 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4127 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4129 GCC allows you to use @option{-g} with
4130 @option{-O}.  The shortcuts taken by optimized code may occasionally
4131 produce surprising results: some variables you declared may not exist
4132 at all; flow of control may briefly move where you did not expect it;
4133 some statements may not be executed because they compute constant
4134 results or their values were already at hand; some statements may
4135 execute in different places because they were moved out of loops.
4137 Nevertheless it proves possible to debug optimized output.  This makes
4138 it reasonable to use the optimizer for programs that might have bugs.
4140 The following options are useful when GCC is generated with the
4141 capability for more than one debugging format.
4143 @item -ggdb
4144 @opindex ggdb
4145 Produce debugging information for use by GDB@.  This means to use the
4146 most expressive format available (DWARF 2, stabs, or the native format
4147 if neither of those are supported), including GDB extensions if at all
4148 possible.
4150 @item -gstabs
4151 @opindex gstabs
4152 Produce debugging information in stabs format (if that is supported),
4153 without GDB extensions.  This is the format used by DBX on most BSD
4154 systems.  On MIPS, Alpha and System V Release 4 systems this option
4155 produces stabs debugging output which is not understood by DBX or SDB@.
4156 On System V Release 4 systems this option requires the GNU assembler.
4158 @item -feliminate-unused-debug-symbols
4159 @opindex feliminate-unused-debug-symbols
4160 Produce debugging information in stabs format (if that is supported),
4161 for only symbols that are actually used.
4163 @item -femit-class-debug-always
4164 Instead of emitting debugging information for a C++ class in only one
4165 object file, emit it in all object files using the class.  This option
4166 should be used only with debuggers that are unable to handle the way GCC
4167 normally emits debugging information for classes because using this
4168 option will increase the size of debugging information by as much as a
4169 factor of two.
4171 @item -gstabs+
4172 @opindex gstabs+
4173 Produce debugging information in stabs format (if that is supported),
4174 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4175 use of these extensions is likely to make other debuggers crash or
4176 refuse to read the program.
4178 @item -gcoff
4179 @opindex gcoff
4180 Produce debugging information in COFF format (if that is supported).
4181 This is the format used by SDB on most System V systems prior to
4182 System V Release 4.
4184 @item -gxcoff
4185 @opindex gxcoff
4186 Produce debugging information in XCOFF format (if that is supported).
4187 This is the format used by the DBX debugger on IBM RS/6000 systems.
4189 @item -gxcoff+
4190 @opindex gxcoff+
4191 Produce debugging information in XCOFF format (if that is supported),
4192 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4193 use of these extensions is likely to make other debuggers crash or
4194 refuse to read the program, and may cause assemblers other than the GNU
4195 assembler (GAS) to fail with an error.
4197 @item -gdwarf-2
4198 @opindex gdwarf-2
4199 Produce debugging information in DWARF version 2 format (if that is
4200 supported).  This is the format used by DBX on IRIX 6.  With this
4201 option, GCC uses features of DWARF version 3 when they are useful;
4202 version 3 is upward compatible with version 2, but may still cause
4203 problems for older debuggers.
4205 @item -gvms
4206 @opindex gvms
4207 Produce debugging information in VMS debug format (if that is
4208 supported).  This is the format used by DEBUG on VMS systems.
4210 @item -g@var{level}
4211 @itemx -ggdb@var{level}
4212 @itemx -gstabs@var{level}
4213 @itemx -gcoff@var{level}
4214 @itemx -gxcoff@var{level}
4215 @itemx -gvms@var{level}
4216 Request debugging information and also use @var{level} to specify how
4217 much information.  The default level is 2.
4219 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4220 @option{-g}.
4222 Level 1 produces minimal information, enough for making backtraces in
4223 parts of the program that you don't plan to debug.  This includes
4224 descriptions of functions and external variables, but no information
4225 about local variables and no line numbers.
4227 Level 3 includes extra information, such as all the macro definitions
4228 present in the program.  Some debuggers support macro expansion when
4229 you use @option{-g3}.
4231 @option{-gdwarf-2} does not accept a concatenated debug level, because
4232 GCC used to support an option @option{-gdwarf} that meant to generate
4233 debug information in version 1 of the DWARF format (which is very
4234 different from version 2), and it would have been too confusing.  That
4235 debug format is long obsolete, but the option cannot be changed now.
4236 Instead use an additional @option{-g@var{level}} option to change the
4237 debug level for DWARF2.
4239 @item -feliminate-dwarf2-dups
4240 @opindex feliminate-dwarf2-dups
4241 Compress DWARF2 debugging information by eliminating duplicated
4242 information about each symbol.  This option only makes sense when
4243 generating DWARF2 debugging information with @option{-gdwarf-2}.
4245 @item -femit-struct-debug-baseonly
4246 Emit debug information for struct-like types
4247 only when the base name of the compilation source file
4248 matches the base name of file in which the struct was defined.
4250 This option substantially reduces the size of debugging information,
4251 but at significant potential loss in type information to the debugger.
4252 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4253 See @option{-femit-struct-debug-detailed} for more detailed control.
4255 This option works only with DWARF 2.
4257 @item -femit-struct-debug-reduced
4258 Emit debug information for struct-like types
4259 only when the base name of the compilation source file
4260 matches the base name of file in which the type was defined,
4261 unless the struct is a template or defined in a system header.
4263 This option significantly reduces the size of debugging information,
4264 with some potential loss in type information to the debugger.
4265 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4266 See @option{-femit-struct-debug-detailed} for more detailed control.
4268 This option works only with DWARF 2.
4270 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4271 Specify the struct-like types
4272 for which the compiler will generate debug information.
4273 The intent is to reduce duplicate struct debug information
4274 between different object files within the same program.
4276 This option is a detailed version of
4277 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4278 which will serve for most needs.
4280 A specification has the syntax
4281 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4283 The optional first word limits the specification to
4284 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4285 A struct type is used directly when it is the type of a variable, member.
4286 Indirect uses arise through pointers to structs.
4287 That is, when use of an incomplete struct would be legal, the use is indirect.
4288 An example is
4289 @samp{struct one direct; struct two * indirect;}.
4291 The optional second word limits the specification to
4292 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4293 Generic structs are a bit complicated to explain.
4294 For C++, these are non-explicit specializations of template classes,
4295 or non-template classes within the above.
4296 Other programming languages have generics,
4297 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4299 The third word specifies the source files for those
4300 structs for which the compiler will emit debug information.
4301 The values @samp{none} and @samp{any} have the normal meaning.
4302 The value @samp{base} means that
4303 the base of name of the file in which the type declaration appears
4304 must match the base of the name of the main compilation file.
4305 In practice, this means that
4306 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4307 but types declared in other header will not.
4308 The value @samp{sys} means those types satisfying @samp{base}
4309 or declared in system or compiler headers.
4311 You may need to experiment to determine the best settings for your application.
4313 The default is @samp{-femit-struct-debug-detailed=all}.
4315 This option works only with DWARF 2.
4317 @item -fno-merge-debug-strings
4318 @opindex fmerge-debug-strings
4319 @opindex fno-merge-debug-strings
4320 Direct the linker to merge together strings which are identical in
4321 different object files.  This is not supported by all assemblers or
4322 linker.  This decreases the size of the debug information in the
4323 output file at the cost of increasing link processing time.  This is
4324 on by default.
4326 @item -fdebug-prefix-map=@var{old}=@var{new}
4327 @opindex fdebug-prefix-map
4328 When compiling files in directory @file{@var{old}}, record debugging
4329 information describing them as in @file{@var{new}} instead.
4331 @cindex @command{prof}
4332 @item -p
4333 @opindex p
4334 Generate extra code to write profile information suitable for the
4335 analysis program @command{prof}.  You must use this option when compiling
4336 the source files you want data about, and you must also use it when
4337 linking.
4339 @cindex @command{gprof}
4340 @item -pg
4341 @opindex pg
4342 Generate extra code to write profile information suitable for the
4343 analysis program @command{gprof}.  You must use this option when compiling
4344 the source files you want data about, and you must also use it when
4345 linking.
4347 @item -Q
4348 @opindex Q
4349 Makes the compiler print out each function name as it is compiled, and
4350 print some statistics about each pass when it finishes.
4352 @item -ftime-report
4353 @opindex ftime-report
4354 Makes the compiler print some statistics about the time consumed by each
4355 pass when it finishes.
4357 @item -fmem-report
4358 @opindex fmem-report
4359 Makes the compiler print some statistics about permanent memory
4360 allocation when it finishes.
4362 @item -fpre-ipa-mem-report
4363 @opindex fpre-ipa-mem-report
4364 @item -fpost-ipa-mem-report
4365 @opindex fpost-ipa-mem-report
4366 Makes the compiler print some statistics about permanent memory
4367 allocation before or after interprocedural optimization.
4369 @item -fprofile-arcs
4370 @opindex fprofile-arcs
4371 Add code so that program flow @dfn{arcs} are instrumented.  During
4372 execution the program records how many times each branch and call is
4373 executed and how many times it is taken or returns.  When the compiled
4374 program exits it saves this data to a file called
4375 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4376 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4377 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4378 @var{auxname} is generated from the name of the output file, if
4379 explicitly specified and it is not the final executable, otherwise it is
4380 the basename of the source file.  In both cases any suffix is removed
4381 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4382 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4383 @xref{Cross-profiling}.
4385 @cindex @command{gcov}
4386 @item --coverage
4387 @opindex coverage
4389 This option is used to compile and link code instrumented for coverage
4390 analysis.  The option is a synonym for @option{-fprofile-arcs}
4391 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4392 linking).  See the documentation for those options for more details.
4394 @itemize
4396 @item
4397 Compile the source files with @option{-fprofile-arcs} plus optimization
4398 and code generation options.  For test coverage analysis, use the
4399 additional @option{-ftest-coverage} option.  You do not need to profile
4400 every source file in a program.
4402 @item
4403 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4404 (the latter implies the former).
4406 @item
4407 Run the program on a representative workload to generate the arc profile
4408 information.  This may be repeated any number of times.  You can run
4409 concurrent instances of your program, and provided that the file system
4410 supports locking, the data files will be correctly updated.  Also
4411 @code{fork} calls are detected and correctly handled (double counting
4412 will not happen).
4414 @item
4415 For profile-directed optimizations, compile the source files again with
4416 the same optimization and code generation options plus
4417 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4418 Control Optimization}).
4420 @item
4421 For test coverage analysis, use @command{gcov} to produce human readable
4422 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4423 @command{gcov} documentation for further information.
4425 @end itemize
4427 With @option{-fprofile-arcs}, for each function of your program GCC
4428 creates a program flow graph, then finds a spanning tree for the graph.
4429 Only arcs that are not on the spanning tree have to be instrumented: the
4430 compiler adds code to count the number of times that these arcs are
4431 executed.  When an arc is the only exit or only entrance to a block, the
4432 instrumentation code can be added to the block; otherwise, a new basic
4433 block must be created to hold the instrumentation code.
4435 @need 2000
4436 @item -ftest-coverage
4437 @opindex ftest-coverage
4438 Produce a notes file that the @command{gcov} code-coverage utility
4439 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4440 show program coverage.  Each source file's note file is called
4441 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4442 above for a description of @var{auxname} and instructions on how to
4443 generate test coverage data.  Coverage data will match the source files
4444 more closely, if you do not optimize.
4446 @item -fdbg-cnt-list
4447 @opindex fdbg-cnt-list
4448 Print the name and the counter upperbound for all debug counters.
4450 @item -fdbg-cnt=@var{counter-value-list}
4451 @opindex fdbg-cnt
4452 Set the internal debug counter upperbound. @var{counter-value-list} 
4453 is a comma-separated list of @var{name}:@var{value} pairs
4454 which sets the upperbound of each debug counter @var{name} to @var{value}.
4455 All debug counters have the initial upperbound of @var{UINT_MAX},
4456 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4457 e.g. With -fdbg-cnt=dce:10,tail_call:0
4458 dbg_cnt(dce) will return true only for first 10 invocations
4459 and dbg_cnt(tail_call) will return false always.
4461 @item -d@var{letters}
4462 @itemx -fdump-rtl-@var{pass}
4463 @opindex d
4464 Says to make debugging dumps during compilation at times specified by
4465 @var{letters}.    This is used for debugging the RTL-based passes of the
4466 compiler.  The file names for most of the dumps are made by appending a
4467 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4468 from the name of the output file, if explicitly specified and it is not
4469 an executable, otherwise it is the basename of the source file. These
4470 switches may have different effects when @option{-E} is used for
4471 preprocessing.
4473 Most debug dumps can be enabled either passing a letter to the @option{-d}
4474 option, or with a long @option{-fdump-rtl} switch; here are the possible
4475 letters for use in @var{letters} and @var{pass}, and their meanings:
4477 @table @gcctabopt
4478 @item -dA
4479 @opindex dA
4480 Annotate the assembler output with miscellaneous debugging information.
4482 @item -fdump-rtl-bbro
4483 @opindex fdump-rtl-bbro
4484 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4486 @item -fdump-rtl-combine
4487 @opindex fdump-rtl-combine
4488 Dump after the RTL instruction combination pass, to the file
4489 @file{@var{file}.129r.combine}.
4491 @item -fdump-rtl-ce1
4492 @itemx -fdump-rtl-ce2
4493 @opindex fdump-rtl-ce1
4494 @opindex fdump-rtl-ce2
4495 @option{-fdump-rtl-ce1} enable dumping after the
4496 first if conversion, to the file @file{@var{file}.117r.ce1}. 
4497 @option{-fdump-rtl-ce2} enable dumping after the second if
4498 conversion, to the file @file{@var{file}.130r.ce2}.
4500 @item -fdump-rtl-btl
4501 @itemx -fdump-rtl-dbr
4502 @opindex fdump-rtl-btl
4503 @opindex fdump-rtl-dbr
4504 @option{-fdump-rtl-btl} enable dumping after branch
4505 target load optimization, to @file{@var{file}.31.btl}.  
4506 @option{-fdump-rtl-dbr} enable dumping after delayed branch
4507 scheduling, to @file{@var{file}.36.dbr}.
4509 @item -dD
4510 @opindex dD
4511 Dump all macro definitions, at the end of preprocessing, in addition to
4512 normal output.
4514 @item -fdump-rtl-ce3
4515 @opindex fdump-rtl-ce3
4516 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4518 @item -fdump-rtl-cfg
4519 @itemx -fdump-rtl-life
4520 @opindex fdump-rtl-cfg
4521 @opindex fdump-rtl-life
4522 @option{-fdump-rtl-cfg} enable dumping after control
4523 and data flow analysis, to @file{@var{file}.116r.cfg}.  
4524 @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4525 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4527 @item -fdump-rtl-greg
4528 @opindex fdump-rtl-greg
4529 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4531 @item -fdump-rtl-gcse
4532 @itemx -fdump-rtl-bypass
4533 @opindex fdump-rtl-gcse
4534 @opindex fdump-rtl-bypass
4535 @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4536 @file{@var{file}.114r.gcse}.  @option{-fdump-rtl-bypass}
4537 enable dumping after jump bypassing and control flow optimizations, to
4538 @file{@var{file}.115r.bypass}.
4540 @item -fdump-rtl-eh
4541 @opindex fdump-rtl-eh
4542 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4544 @item -fdump-rtl-sibling
4545 @opindex fdump-rtl-sibling
4546 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4548 @item -fdump-rtl-jump
4549 @opindex fdump-rtl-jump
4550 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4552 @item -fdump-rtl-stack
4553 @opindex fdump-rtl-stack
4554 Dump after conversion from GCC's "flat register file" registers to the
4555 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4557 @item -fdump-rtl-lreg
4558 @opindex fdump-rtl-lreg
4559 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4561 @item -fdump-rtl-loop2
4562 @opindex fdump-rtl-loop2
4563 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4564 loop optimization pass, to @file{@var{file}.119r.loop2},
4565 @file{@var{file}.120r.loop2_init},
4566 @file{@var{file}.121r.loop2_invariant}, and
4567 @file{@var{file}.125r.loop2_done}.
4569 @item -fdump-rtl-sms
4570 @opindex fdump-rtl-sms
4571 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4573 @item -fdump-rtl-mach
4574 @opindex fdump-rtl-mach
4575 Dump after performing the machine dependent reorganization pass, to
4576 @file{@var{file}.155r.mach} if that pass exists.
4578 @item -fdump-rtl-rnreg
4579 @opindex fdump-rtl-rnreg
4580 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4582 @item -fdump-rtl-regmove
4583 @opindex fdump-rtl-regmove
4584 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4586 @item -fdump-rtl-postreload
4587 @opindex fdump-rtl-postreload
4588 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4590 @item -fdump-rtl-expand
4591 @opindex fdump-rtl-expand
4592 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4594 @item -fdump-rtl-sched2
4595 @opindex fdump-rtl-sched2
4596 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4598 @item -fdump-rtl-cse
4599 @opindex fdump-rtl-cse
4600 Dump after CSE (including the jump optimization that sometimes follows
4601 CSE), to @file{@var{file}.113r.cse}.
4603 @item -fdump-rtl-sched1
4604 @opindex fdump-rtl-sched1
4605 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4607 @item -fdump-rtl-cse2
4608 @opindex fdump-rtl-cse2
4609 Dump after the second CSE pass (including the jump optimization that
4610 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4612 @item -fdump-rtl-tracer
4613 @opindex fdump-rtl-tracer
4614 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4616 @item -fdump-rtl-vpt
4617 @itemx -fdump-rtl-vartrack
4618 @opindex fdump-rtl-vpt
4619 @opindex fdump-rtl-vartrack
4620 @option{-fdump-rtl-vpt} enable dumping after the value
4621 profile transformations, to @file{@var{file}.10.vpt}.
4622 @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4623 to @file{@var{file}.154r.vartrack}.
4625 @item -fdump-rtl-flow2
4626 @opindex fdump-rtl-flow2
4627 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4629 @item -fdump-rtl-peephole2
4630 @opindex fdump-rtl-peephole2
4631 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4633 @item -fdump-rtl-web
4634 @opindex fdump-rtl-web
4635 Dump after live range splitting, to @file{@var{file}.126r.web}.
4637 @item -fdump-rtl-all
4638 @opindex fdump-rtl-all
4639 Produce all the dumps listed above.
4641 @item -dH
4642 @opindex dH
4643 Produce a core dump whenever an error occurs.
4645 @item -dm
4646 @opindex dm
4647 Print statistics on memory usage, at the end of the run, to
4648 standard error.
4650 @item -dp
4651 @opindex dp
4652 Annotate the assembler output with a comment indicating which
4653 pattern and alternative was used.  The length of each instruction is
4654 also printed.
4656 @item -dP
4657 @opindex dP
4658 Dump the RTL in the assembler output as a comment before each instruction.
4659 Also turns on @option{-dp} annotation.
4661 @item -dv
4662 @opindex dv
4663 For each of the other indicated dump files (either with @option{-d} or
4664 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4665 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4667 @item -dx
4668 @opindex dx
4669 Just generate RTL for a function instead of compiling it.  Usually used
4670 with @samp{r} (@option{-fdump-rtl-expand}).
4672 @item -dy
4673 @opindex dy
4674 Dump debugging information during parsing, to standard error.
4675 @end table
4677 @item -fdump-noaddr
4678 @opindex fdump-noaddr
4679 When doing debugging dumps (see @option{-d} option above), suppress
4680 address output.  This makes it more feasible to use diff on debugging
4681 dumps for compiler invocations with different compiler binaries and/or
4682 different text / bss / data / heap / stack / dso start locations.
4684 @item -fdump-unnumbered
4685 @opindex fdump-unnumbered
4686 When doing debugging dumps (see @option{-d} option above), suppress instruction
4687 numbers and address output.  This makes it more feasible to
4688 use diff on debugging dumps for compiler invocations with different
4689 options, in particular with and without @option{-g}.
4691 @item -fdump-translation-unit @r{(C++ only)}
4692 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4693 @opindex fdump-translation-unit
4694 Dump a representation of the tree structure for the entire translation
4695 unit to a file.  The file name is made by appending @file{.tu} to the
4696 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4697 controls the details of the dump as described for the
4698 @option{-fdump-tree} options.
4700 @item -fdump-class-hierarchy @r{(C++ only)}
4701 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4702 @opindex fdump-class-hierarchy
4703 Dump a representation of each class's hierarchy and virtual function
4704 table layout to a file.  The file name is made by appending @file{.class}
4705 to the source file name.  If the @samp{-@var{options}} form is used,
4706 @var{options} controls the details of the dump as described for the
4707 @option{-fdump-tree} options.
4709 @item -fdump-ipa-@var{switch}
4710 @opindex fdump-ipa
4711 Control the dumping at various stages of inter-procedural analysis
4712 language tree to a file.  The file name is generated by appending a switch
4713 specific suffix to the source file name.  The following dumps are possible:
4715 @table @samp
4716 @item all
4717 Enables all inter-procedural analysis dumps.
4719 @item cgraph
4720 Dumps information about call-graph optimization, unused function removal,
4721 and inlining decisions.
4723 @item inline
4724 Dump after function inlining.
4726 @end table
4728 @item -fdump-statistics-@var{option}
4729 @opindex -fdump-statistics
4730 Enable and control dumping of pass statistics in a separate file.  The
4731 file name is generated by appending a suffix ending in @samp{.statistics}
4732 to the source file name.  If the @samp{-@var{option}} form is used,
4733 @samp{-stats} will cause counters to be summed over the whole compilation unit
4734 while @samp{-details} will dump every event as the passes generate them.
4735 The default with no option is to sum counters for each function compiled.
4737 @item -fdump-tree-@var{switch}
4738 @itemx -fdump-tree-@var{switch}-@var{options}
4739 @opindex fdump-tree
4740 Control the dumping at various stages of processing the intermediate
4741 language tree to a file.  The file name is generated by appending a switch
4742 specific suffix to the source file name.  If the @samp{-@var{options}}
4743 form is used, @var{options} is a list of @samp{-} separated options that
4744 control the details of the dump.  Not all options are applicable to all
4745 dumps, those which are not meaningful will be ignored.  The following
4746 options are available
4748 @table @samp
4749 @item address
4750 Print the address of each node.  Usually this is not meaningful as it
4751 changes according to the environment and source file.  Its primary use
4752 is for tying up a dump file with a debug environment.
4753 @item slim
4754 Inhibit dumping of members of a scope or body of a function merely
4755 because that scope has been reached.  Only dump such items when they
4756 are directly reachable by some other path.  When dumping pretty-printed
4757 trees, this option inhibits dumping the bodies of control structures.
4758 @item raw
4759 Print a raw representation of the tree.  By default, trees are
4760 pretty-printed into a C-like representation.
4761 @item details
4762 Enable more detailed dumps (not honored by every dump option).
4763 @item stats
4764 Enable dumping various statistics about the pass (not honored by every dump
4765 option).
4766 @item blocks
4767 Enable showing basic block boundaries (disabled in raw dumps).
4768 @item vops
4769 Enable showing virtual operands for every statement.
4770 @item lineno
4771 Enable showing line numbers for statements.
4772 @item uid
4773 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4774 @item verbose
4775 Enable showing the tree dump for each statement.
4776 @item all
4777 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
4778 and @option{lineno}.
4779 @end table
4781 The following tree dumps are possible:
4782 @table @samp
4784 @item original
4785 Dump before any tree based optimization, to @file{@var{file}.original}.
4787 @item optimized
4788 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4790 @item gimple
4791 @opindex fdump-tree-gimple
4792 Dump each function before and after the gimplification pass to a file.  The
4793 file name is made by appending @file{.gimple} to the source file name.
4795 @item cfg
4796 @opindex fdump-tree-cfg
4797 Dump the control flow graph of each function to a file.  The file name is
4798 made by appending @file{.cfg} to the source file name.
4800 @item vcg
4801 @opindex fdump-tree-vcg
4802 Dump the control flow graph of each function to a file in VCG format.  The
4803 file name is made by appending @file{.vcg} to the source file name.  Note
4804 that if the file contains more than one function, the generated file cannot
4805 be used directly by VCG@.  You will need to cut and paste each function's
4806 graph into its own separate file first.
4808 @item ch
4809 @opindex fdump-tree-ch
4810 Dump each function after copying loop headers.  The file name is made by
4811 appending @file{.ch} to the source file name.
4813 @item ssa
4814 @opindex fdump-tree-ssa
4815 Dump SSA related information to a file.  The file name is made by appending
4816 @file{.ssa} to the source file name.
4818 @item alias
4819 @opindex fdump-tree-alias
4820 Dump aliasing information for each function.  The file name is made by
4821 appending @file{.alias} to the source file name.
4823 @item ccp
4824 @opindex fdump-tree-ccp
4825 Dump each function after CCP@.  The file name is made by appending
4826 @file{.ccp} to the source file name.
4828 @item storeccp
4829 @opindex fdump-tree-storeccp
4830 Dump each function after STORE-CCP@.  The file name is made by appending
4831 @file{.storeccp} to the source file name.
4833 @item pre
4834 @opindex fdump-tree-pre
4835 Dump trees after partial redundancy elimination.  The file name is made
4836 by appending @file{.pre} to the source file name.
4838 @item fre
4839 @opindex fdump-tree-fre
4840 Dump trees after full redundancy elimination.  The file name is made
4841 by appending @file{.fre} to the source file name.
4843 @item copyprop
4844 @opindex fdump-tree-copyprop
4845 Dump trees after copy propagation.  The file name is made
4846 by appending @file{.copyprop} to the source file name.
4848 @item store_copyprop
4849 @opindex fdump-tree-store_copyprop
4850 Dump trees after store copy-propagation.  The file name is made
4851 by appending @file{.store_copyprop} to the source file name.
4853 @item dce
4854 @opindex fdump-tree-dce
4855 Dump each function after dead code elimination.  The file name is made by
4856 appending @file{.dce} to the source file name.
4858 @item mudflap
4859 @opindex fdump-tree-mudflap
4860 Dump each function after adding mudflap instrumentation.  The file name is
4861 made by appending @file{.mudflap} to the source file name.
4863 @item sra
4864 @opindex fdump-tree-sra
4865 Dump each function after performing scalar replacement of aggregates.  The
4866 file name is made by appending @file{.sra} to the source file name.
4868 @item sink
4869 @opindex fdump-tree-sink
4870 Dump each function after performing code sinking.  The file name is made
4871 by appending @file{.sink} to the source file name.
4873 @item dom
4874 @opindex fdump-tree-dom
4875 Dump each function after applying dominator tree optimizations.  The file
4876 name is made by appending @file{.dom} to the source file name.
4878 @item dse
4879 @opindex fdump-tree-dse
4880 Dump each function after applying dead store elimination.  The file
4881 name is made by appending @file{.dse} to the source file name.
4883 @item phiopt
4884 @opindex fdump-tree-phiopt
4885 Dump each function after optimizing PHI nodes into straightline code.  The file
4886 name is made by appending @file{.phiopt} to the source file name.
4888 @item forwprop
4889 @opindex fdump-tree-forwprop
4890 Dump each function after forward propagating single use variables.  The file
4891 name is made by appending @file{.forwprop} to the source file name.
4893 @item copyrename
4894 @opindex fdump-tree-copyrename
4895 Dump each function after applying the copy rename optimization.  The file
4896 name is made by appending @file{.copyrename} to the source file name.
4898 @item nrv
4899 @opindex fdump-tree-nrv
4900 Dump each function after applying the named return value optimization on
4901 generic trees.  The file name is made by appending @file{.nrv} to the source
4902 file name.
4904 @item vect
4905 @opindex fdump-tree-vect
4906 Dump each function after applying vectorization of loops.  The file name is
4907 made by appending @file{.vect} to the source file name.
4909 @item vrp
4910 @opindex fdump-tree-vrp
4911 Dump each function after Value Range Propagation (VRP).  The file name
4912 is made by appending @file{.vrp} to the source file name.
4914 @item all
4915 @opindex fdump-tree-all
4916 Enable all the available tree dumps with the flags provided in this option.
4917 @end table
4919 @item -ftree-vectorizer-verbose=@var{n}
4920 @opindex ftree-vectorizer-verbose
4921 This option controls the amount of debugging output the vectorizer prints.
4922 This information is written to standard error, unless
4923 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4924 in which case it is output to the usual dump listing file, @file{.vect}.
4925 For @var{n}=0 no diagnostic information is reported.
4926 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4927 and the total number of loops that got vectorized.
4928 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4929 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
4930 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4931 level that @option{-fdump-tree-vect-stats} uses.
4932 Higher verbosity levels mean either more information dumped for each
4933 reported loop, or same amount of information reported for more loops:
4934 If @var{n}=3, alignment related information is added to the reports.
4935 If @var{n}=4, data-references related information (e.g.@: memory dependences,
4936 memory access-patterns) is added to the reports.
4937 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4938 that did not pass the first analysis phase (i.e., may not be countable, or
4939 may have complicated control-flow).
4940 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4941 For @var{n}=7, all the information the vectorizer generates during its
4942 analysis and transformation is reported.  This is the same verbosity level
4943 that @option{-fdump-tree-vect-details} uses.
4945 @item -frandom-seed=@var{string}
4946 @opindex frandom-string
4947 This option provides a seed that GCC uses when it would otherwise use
4948 random numbers.  It is used to generate certain symbol names
4949 that have to be different in every compiled file.  It is also used to
4950 place unique stamps in coverage data files and the object files that
4951 produce them.  You can use the @option{-frandom-seed} option to produce
4952 reproducibly identical object files.
4954 The @var{string} should be different for every file you compile.
4956 @item -fsched-verbose=@var{n}
4957 @opindex fsched-verbose
4958 On targets that use instruction scheduling, this option controls the
4959 amount of debugging output the scheduler prints.  This information is
4960 written to standard error, unless @option{-dS} or @option{-dR} is
4961 specified, in which case it is output to the usual dump
4962 listing file, @file{.sched} or @file{.sched2} respectively.  However
4963 for @var{n} greater than nine, the output is always printed to standard
4964 error.
4966 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4967 same information as @option{-dRS}.  For @var{n} greater than one, it
4968 also output basic block probabilities, detailed ready list information
4969 and unit/insn info.  For @var{n} greater than two, it includes RTL
4970 at abort point, control-flow and regions info.  And for @var{n} over
4971 four, @option{-fsched-verbose} also includes dependence info.
4973 @item -save-temps
4974 @opindex save-temps
4975 Store the usual ``temporary'' intermediate files permanently; place them
4976 in the current directory and name them based on the source file.  Thus,
4977 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4978 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4979 preprocessed @file{foo.i} output file even though the compiler now
4980 normally uses an integrated preprocessor.
4982 When used in combination with the @option{-x} command line option,
4983 @option{-save-temps} is sensible enough to avoid over writing an
4984 input source file with the same extension as an intermediate file.
4985 The corresponding intermediate file may be obtained by renaming the
4986 source file before using @option{-save-temps}.
4988 @item -time
4989 @opindex time
4990 Report the CPU time taken by each subprocess in the compilation
4991 sequence.  For C source files, this is the compiler proper and assembler
4992 (plus the linker if linking is done).  The output looks like this:
4994 @smallexample
4995 # cc1 0.12 0.01
4996 # as 0.00 0.01
4997 @end smallexample
4999 The first number on each line is the ``user time'', that is time spent
5000 executing the program itself.  The second number is ``system time'',
5001 time spent executing operating system routines on behalf of the program.
5002 Both numbers are in seconds.
5004 @item -fvar-tracking
5005 @opindex fvar-tracking
5006 Run variable tracking pass.  It computes where variables are stored at each
5007 position in code.  Better debugging information is then generated
5008 (if the debugging information format supports this information).
5010 It is enabled by default when compiling with optimization (@option{-Os},
5011 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5012 the debug info format supports it.
5014 @item -print-file-name=@var{library}
5015 @opindex print-file-name
5016 Print the full absolute name of the library file @var{library} that
5017 would be used when linking---and don't do anything else.  With this
5018 option, GCC does not compile or link anything; it just prints the
5019 file name.
5021 @item -print-multi-directory
5022 @opindex print-multi-directory
5023 Print the directory name corresponding to the multilib selected by any
5024 other switches present in the command line.  This directory is supposed
5025 to exist in @env{GCC_EXEC_PREFIX}.
5027 @item -print-multi-lib
5028 @opindex print-multi-lib
5029 Print the mapping from multilib directory names to compiler switches
5030 that enable them.  The directory name is separated from the switches by
5031 @samp{;}, and each switch starts with an @samp{@@} instead of the
5032 @samp{-}, without spaces between multiple switches.  This is supposed to
5033 ease shell-processing.
5035 @item -print-prog-name=@var{program}
5036 @opindex print-prog-name
5037 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5039 @item -print-libgcc-file-name
5040 @opindex print-libgcc-file-name
5041 Same as @option{-print-file-name=libgcc.a}.
5043 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5044 but you do want to link with @file{libgcc.a}.  You can do
5046 @smallexample
5047 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5048 @end smallexample
5050 @item -print-search-dirs
5051 @opindex print-search-dirs
5052 Print the name of the configured installation directory and a list of
5053 program and library directories @command{gcc} will search---and don't do anything else.
5055 This is useful when @command{gcc} prints the error message
5056 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5057 To resolve this you either need to put @file{cpp0} and the other compiler
5058 components where @command{gcc} expects to find them, or you can set the environment
5059 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5060 Don't forget the trailing @samp{/}.
5061 @xref{Environment Variables}.
5063 @item -print-sysroot-headers-suffix
5064 @opindex print-sysroot-headers-suffix
5065 Print the suffix added to the target sysroot when searching for
5066 headers, or give an error if the compiler is not configured with such
5067 a suffix---and don't do anything else.
5069 @item -dumpmachine
5070 @opindex dumpmachine
5071 Print the compiler's target machine (for example,
5072 @samp{i686-pc-linux-gnu})---and don't do anything else.
5074 @item -dumpversion
5075 @opindex dumpversion
5076 Print the compiler version (for example, @samp{3.0})---and don't do
5077 anything else.
5079 @item -dumpspecs
5080 @opindex dumpspecs
5081 Print the compiler's built-in specs---and don't do anything else.  (This
5082 is used when GCC itself is being built.)  @xref{Spec Files}.
5084 @item -feliminate-unused-debug-types
5085 @opindex feliminate-unused-debug-types
5086 Normally, when producing DWARF2 output, GCC will emit debugging
5087 information for all types declared in a compilation
5088 unit, regardless of whether or not they are actually used
5089 in that compilation unit.  Sometimes this is useful, such as
5090 if, in the debugger, you want to cast a value to a type that is
5091 not actually used in your program (but is declared).  More often,
5092 however, this results in a significant amount of wasted space.
5093 With this option, GCC will avoid producing debug symbol output
5094 for types that are nowhere used in the source file being compiled.
5095 @end table
5097 @node Optimize Options
5098 @section Options That Control Optimization
5099 @cindex optimize options
5100 @cindex options, optimization
5102 These options control various sorts of optimizations.
5104 Without any optimization option, the compiler's goal is to reduce the
5105 cost of compilation and to make debugging produce the expected
5106 results.  Statements are independent: if you stop the program with a
5107 breakpoint between statements, you can then assign a new value to any
5108 variable or change the program counter to any other statement in the
5109 function and get exactly the results you would expect from the source
5110 code.
5112 Turning on optimization flags makes the compiler attempt to improve
5113 the performance and/or code size at the expense of compilation time
5114 and possibly the ability to debug the program.
5116 The compiler performs optimization based on the knowledge it has of
5117 the program.  Optimization levels @option{-O} and above, in
5118 particular, enable @emph{unit-at-a-time} mode, which allows the
5119 compiler to consider information gained from later functions in
5120 the file when compiling a function.  Compiling multiple files at
5121 once to a single output file in @emph{unit-at-a-time} mode allows
5122 the compiler to use information gained from all of the files when
5123 compiling each of them.
5125 Not all optimizations are controlled directly by a flag.  Only
5126 optimizations that have a flag are listed.
5128 @table @gcctabopt
5129 @item -O
5130 @itemx -O1
5131 @opindex O
5132 @opindex O1
5133 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5134 more memory for a large function.
5136 With @option{-O}, the compiler tries to reduce code size and execution
5137 time, without performing any optimizations that take a great deal of
5138 compilation time.
5140 @option{-O} turns on the following optimization flags:
5141 @gccoptlist{
5142 -fauto-inc-dec @gol
5143 -fcprop-registers @gol
5144 -fdce @gol
5145 -fdefer-pop @gol
5146 -fdelayed-branch @gol
5147 -fdse @gol
5148 -fguess-branch-probability @gol
5149 -fif-conversion2 @gol
5150 -fif-conversion @gol
5151 -finline-small-functions @gol
5152 -fipa-pure-const @gol
5153 -fipa-reference @gol
5154 -fmerge-constants
5155 -fsplit-wide-types @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-dominator-opts
5877 @opindex ftree-dominator-opts
5878 Perform a variety of simple scalar cleanups (constant/copy
5879 propagation, redundancy elimination, range propagation and expression
5880 simplification) based on a dominator tree traversal.  This also
5881 performs jump threading (to reduce jumps to jumps). This flag is
5882 enabled by default at @option{-O} and higher.
5884 @item -ftree-dse
5885 @opindex ftree-dse
5886 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5887 a memory location which will later be overwritten by another store without
5888 any intervening loads.  In this case the earlier store can be deleted.  This
5889 flag is enabled by default at @option{-O} and higher.
5891 @item -ftree-ch
5892 @opindex ftree-ch
5893 Perform loop header copying on trees.  This is beneficial since it increases
5894 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5895 is enabled by default at @option{-O} and higher.  It is not enabled
5896 for @option{-Os}, since it usually increases code size.
5898 @item -ftree-loop-optimize
5899 @opindex ftree-loop-optimize
5900 Perform loop optimizations on trees.  This flag is enabled by default
5901 at @option{-O} and higher.
5903 @item -ftree-loop-linear
5904 @opindex ftree-loop-linear
5905 Perform linear loop transformations on tree.  This flag can improve cache
5906 performance and allow further loop optimizations to take place.
5908 @item -fcheck-data-deps
5909 @opindex fcheck-data-deps
5910 Compare the results of several data dependence analyzers.  This option
5911 is used for debugging the data dependence analyzers.
5913 @item -ftree-loop-distribution
5914 Perform loop distribution.  This flag can improve cache performance on
5915 big loop bodies and allow further loop optimizations, like
5916 parallelization or vectorization, to take place.  For example, the loop
5917 @smallexample
5918 DO I = 1, N
5919   A(I) = B(I) + C
5920   D(I) = E(I) * F
5921 ENDDO
5922 @end smallexample
5923 is transformed to
5924 @smallexample
5925 DO I = 1, N
5926    A(I) = B(I) + C
5927 ENDDO
5928 DO I = 1, N
5929    D(I) = E(I) * F
5930 ENDDO
5931 @end smallexample
5933 @item -ftree-loop-im
5934 @opindex ftree-loop-im
5935 Perform loop invariant motion on trees.  This pass moves only invariants that
5936 would be hard to handle at RTL level (function calls, operations that expand to
5937 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5938 operands of conditions that are invariant out of the loop, so that we can use
5939 just trivial invariantness analysis in loop unswitching.  The pass also includes
5940 store motion.
5942 @item -ftree-loop-ivcanon
5943 @opindex ftree-loop-ivcanon
5944 Create a canonical counter for number of iterations in the loop for that
5945 determining number of iterations requires complicated analysis.  Later
5946 optimizations then may determine the number easily.  Useful especially
5947 in connection with unrolling.
5949 @item -fivopts
5950 @opindex fivopts
5951 Perform induction variable optimizations (strength reduction, induction
5952 variable merging and induction variable elimination) on trees.
5954 @item -ftree-parallelize-loops=n
5955 @opindex ftree-parallelize-loops
5956 Parallelize loops, i.e., split their iteration space to run in n threads.
5957 This is only possible for loops whose iterations are independent
5958 and can be arbitrarily reordered.  The optimization is only
5959 profitable on multiprocessor machines, for loops that are CPU-intensive,
5960 rather than constrained e.g.@: by memory bandwidth.  This option
5961 implies @option{-pthread}, and thus is only supported on targets
5962 that have support for @option{-pthread}.
5964 @item -ftree-sra
5965 @opindex ftree-sra
5966 Perform scalar replacement of aggregates.  This pass replaces structure
5967 references with scalars to prevent committing structures to memory too
5968 early.  This flag is enabled by default at @option{-O} and higher.
5970 @item -ftree-copyrename
5971 @opindex ftree-copyrename
5972 Perform copy renaming on trees.  This pass attempts to rename compiler
5973 temporaries to other variables at copy locations, usually resulting in
5974 variable names which more closely resemble the original variables.  This flag
5975 is enabled by default at @option{-O} and higher.
5977 @item -ftree-ter
5978 @opindex ftree-ter
5979 Perform temporary expression replacement during the SSA->normal phase.  Single
5980 use/single def temporaries are replaced at their use location with their
5981 defining expression.  This results in non-GIMPLE code, but gives the expanders
5982 much more complex trees to work on resulting in better RTL generation.  This is
5983 enabled by default at @option{-O} and higher.
5985 @item -ftree-vectorize
5986 @opindex ftree-vectorize
5987 Perform loop vectorization on trees. This flag is enabled by default at
5988 @option{-O3}.
5990 @item -ftree-vect-loop-version
5991 @opindex ftree-vect-loop-version
5992 Perform loop versioning when doing loop vectorization on trees.  When a loop
5993 appears to be vectorizable except that data alignment or data dependence cannot
5994 be determined at compile time then vectorized and non-vectorized versions of
5995 the loop are generated along with runtime checks for alignment or dependence
5996 to control which version is executed.  This option is enabled by default
5997 except at level @option{-Os} where it is disabled.
5999 @item -fvect-cost-model
6000 @opindex fvect-cost-model
6001 Enable cost model for vectorization.
6003 @item -ftree-vrp
6004 @opindex ftree-vrp
6005 Perform Value Range Propagation on trees.  This is similar to the
6006 constant propagation pass, but instead of values, ranges of values are
6007 propagated.  This allows the optimizers to remove unnecessary range
6008 checks like array bound checks and null pointer checks.  This is
6009 enabled by default at @option{-O2} and higher.  Null pointer check
6010 elimination is only done if @option{-fdelete-null-pointer-checks} is
6011 enabled.
6013 @item -ftracer
6014 @opindex ftracer
6015 Perform tail duplication to enlarge superblock size.  This transformation
6016 simplifies the control flow of the function allowing other optimizations to do
6017 better job.
6019 @item -funroll-loops
6020 @opindex funroll-loops
6021 Unroll loops whose number of iterations can be determined at compile
6022 time or upon entry to the loop.  @option{-funroll-loops} implies
6023 @option{-frerun-cse-after-loop}.  This option makes code larger,
6024 and may or may not make it run faster.
6026 @item -funroll-all-loops
6027 @opindex funroll-all-loops
6028 Unroll all loops, even if their number of iterations is uncertain when
6029 the loop is entered.  This usually makes programs run more slowly.
6030 @option{-funroll-all-loops} implies the same options as
6031 @option{-funroll-loops},
6033 @item -fsplit-ivs-in-unroller
6034 @opindex fsplit-ivs-in-unroller
6035 Enables expressing of values of induction variables in later iterations
6036 of the unrolled loop using the value in the first iteration.  This breaks
6037 long dependency chains, thus improving efficiency of the scheduling passes.
6039 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6040 same effect.  However in cases the loop body is more complicated than
6041 a single basic block, this is not reliable.  It also does not work at all
6042 on some of the architectures due to restrictions in the CSE pass.
6044 This optimization is enabled by default.
6046 @item -fvariable-expansion-in-unroller
6047 @opindex fvariable-expansion-in-unroller
6048 With this option, the compiler will create multiple copies of some
6049 local variables when unrolling a loop which can result in superior code.
6051 @item -fpredictive-commoning
6052 @opindex fpredictive-commoning
6053 Perform predictive commoning optimization, i.e., reusing computations
6054 (especially memory loads and stores) performed in previous
6055 iterations of loops.
6057 This option is enabled at level @option{-O3}.
6059 @item -fprefetch-loop-arrays
6060 @opindex fprefetch-loop-arrays
6061 If supported by the target machine, generate instructions to prefetch
6062 memory to improve the performance of loops that access large arrays.
6064 This option may generate better or worse code; results are highly
6065 dependent on the structure of loops within the source code.
6067 Disabled at level @option{-Os}.
6069 @item -fno-peephole
6070 @itemx -fno-peephole2
6071 @opindex fno-peephole
6072 @opindex fno-peephole2
6073 Disable any machine-specific peephole optimizations.  The difference
6074 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6075 are implemented in the compiler; some targets use one, some use the
6076 other, a few use both.
6078 @option{-fpeephole} is enabled by default.
6079 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6081 @item -fno-guess-branch-probability
6082 @opindex fno-guess-branch-probability
6083 Do not guess branch probabilities using heuristics.
6085 GCC will use heuristics to guess branch probabilities if they are
6086 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6087 heuristics are based on the control flow graph.  If some branch probabilities
6088 are specified by @samp{__builtin_expect}, then the heuristics will be
6089 used to guess branch probabilities for the rest of the control flow graph,
6090 taking the @samp{__builtin_expect} info into account.  The interactions
6091 between the heuristics and @samp{__builtin_expect} can be complex, and in
6092 some cases, it may be useful to disable the heuristics so that the effects
6093 of @samp{__builtin_expect} are easier to understand.
6095 The default is @option{-fguess-branch-probability} at levels
6096 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6098 @item -freorder-blocks
6099 @opindex freorder-blocks
6100 Reorder basic blocks in the compiled function in order to reduce number of
6101 taken branches and improve code locality.
6103 Enabled at levels @option{-O2}, @option{-O3}.
6105 @item -freorder-blocks-and-partition
6106 @opindex freorder-blocks-and-partition
6107 In addition to reordering basic blocks in the compiled function, in order
6108 to reduce number of taken branches, partitions hot and cold basic blocks
6109 into separate sections of the assembly and .o files, to improve
6110 paging and cache locality performance.
6112 This optimization is automatically turned off in the presence of
6113 exception handling, for linkonce sections, for functions with a user-defined
6114 section attribute and on any architecture that does not support named
6115 sections.
6117 @item -freorder-functions
6118 @opindex freorder-functions
6119 Reorder functions in the object file in order to
6120 improve code locality.  This is implemented by using special
6121 subsections @code{.text.hot} for most frequently executed functions and
6122 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6123 the linker so object file format must support named sections and linker must
6124 place them in a reasonable way.
6126 Also profile feedback must be available in to make this option effective.  See
6127 @option{-fprofile-arcs} for details.
6129 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6131 @item -fstrict-aliasing
6132 @opindex fstrict-aliasing
6133 Allows the compiler to assume the strictest aliasing rules applicable to
6134 the language being compiled.  For C (and C++), this activates
6135 optimizations based on the type of expressions.  In particular, an
6136 object of one type is assumed never to reside at the same address as an
6137 object of a different type, unless the types are almost the same.  For
6138 example, an @code{unsigned int} can alias an @code{int}, but not a
6139 @code{void*} or a @code{double}.  A character type may alias any other
6140 type.
6142 Pay special attention to code like this:
6143 @smallexample
6144 union a_union @{
6145   int i;
6146   double d;
6149 int f() @{
6150   a_union t;
6151   t.d = 3.0;
6152   return t.i;
6154 @end smallexample
6155 The practice of reading from a different union member than the one most
6156 recently written to (called ``type-punning'') is common.  Even with
6157 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6158 is accessed through the union type.  So, the code above will work as
6159 expected.  However, this code might not:
6160 @smallexample
6161 int f() @{
6162   a_union t;
6163   int* ip;
6164   t.d = 3.0;
6165   ip = &t.i;
6166   return *ip;
6168 @end smallexample
6170 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6172 @item -fstrict-overflow
6173 @opindex fstrict-overflow
6174 Allow the compiler to assume strict signed overflow rules, depending
6175 on the language being compiled.  For C (and C++) this means that
6176 overflow when doing arithmetic with signed numbers is undefined, which
6177 means that the compiler may assume that it will not happen.  This
6178 permits various optimizations.  For example, the compiler will assume
6179 that an expression like @code{i + 10 > i} will always be true for
6180 signed @code{i}.  This assumption is only valid if signed overflow is
6181 undefined, as the expression is false if @code{i + 10} overflows when
6182 using twos complement arithmetic.  When this option is in effect any
6183 attempt to determine whether an operation on signed numbers will
6184 overflow must be written carefully to not actually involve overflow.
6186 This option also allows the compiler to assume strict pointer
6187 semantics: given a pointer to an object, if adding an offset to that
6188 pointer does not produce a pointer to the same object, the addition is
6189 undefined.  This permits the compiler to conclude that @code{p + u >
6190 p} is always true for a pointer @code{p} and unsigned integer
6191 @code{u}.  This assumption is only valid because pointer wraparound is
6192 undefined, as the expression is false if @code{p + u} overflows using
6193 twos complement arithmetic.
6195 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6196 that integer signed overflow is fully defined: it wraps.  When
6197 @option{-fwrapv} is used, there is no difference between
6198 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6199 integers.  With @option{-fwrapv} certain types of overflow are
6200 permitted.  For example, if the compiler gets an overflow when doing
6201 arithmetic on constants, the overflowed value can still be used with
6202 @option{-fwrapv}, but not otherwise.
6204 The @option{-fstrict-overflow} option is enabled at levels
6205 @option{-O2}, @option{-O3}, @option{-Os}.
6207 @item -falign-functions
6208 @itemx -falign-functions=@var{n}
6209 @opindex falign-functions
6210 Align the start of functions to the next power-of-two greater than
6211 @var{n}, skipping up to @var{n} bytes.  For instance,
6212 @option{-falign-functions=32} aligns functions to the next 32-byte
6213 boundary, but @option{-falign-functions=24} would align to the next
6214 32-byte boundary only if this can be done by skipping 23 bytes or less.
6216 @option{-fno-align-functions} and @option{-falign-functions=1} are
6217 equivalent and mean that functions will not be aligned.
6219 Some assemblers only support this flag when @var{n} is a power of two;
6220 in that case, it is rounded up.
6222 If @var{n} is not specified or is zero, use a machine-dependent default.
6224 Enabled at levels @option{-O2}, @option{-O3}.
6226 @item -falign-labels
6227 @itemx -falign-labels=@var{n}
6228 @opindex falign-labels
6229 Align all branch targets to a power-of-two boundary, skipping up to
6230 @var{n} bytes like @option{-falign-functions}.  This option can easily
6231 make code slower, because it must insert dummy operations for when the
6232 branch target is reached in the usual flow of the code.
6234 @option{-fno-align-labels} and @option{-falign-labels=1} are
6235 equivalent and mean that labels will not be aligned.
6237 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6238 are greater than this value, then their values are used instead.
6240 If @var{n} is not specified or is zero, use a machine-dependent default
6241 which is very likely to be @samp{1}, meaning no alignment.
6243 Enabled at levels @option{-O2}, @option{-O3}.
6245 @item -falign-loops
6246 @itemx -falign-loops=@var{n}
6247 @opindex falign-loops
6248 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6249 like @option{-falign-functions}.  The hope is that the loop will be
6250 executed many times, which will make up for any execution of the dummy
6251 operations.
6253 @option{-fno-align-loops} and @option{-falign-loops=1} are
6254 equivalent and mean that loops will not be aligned.
6256 If @var{n} is not specified or is zero, use a machine-dependent default.
6258 Enabled at levels @option{-O2}, @option{-O3}.
6260 @item -falign-jumps
6261 @itemx -falign-jumps=@var{n}
6262 @opindex falign-jumps
6263 Align branch targets to a power-of-two boundary, for branch targets
6264 where the targets can only be reached by jumping, skipping up to @var{n}
6265 bytes like @option{-falign-functions}.  In this case, no dummy operations
6266 need be executed.
6268 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6269 equivalent and mean that loops will not be aligned.
6271 If @var{n} is not specified or is zero, use a machine-dependent default.
6273 Enabled at levels @option{-O2}, @option{-O3}.
6275 @item -funit-at-a-time
6276 @opindex funit-at-a-time
6277 Parse the whole compilation unit before starting to produce code.
6278 This allows some extra optimizations to take place but consumes
6279 more memory (in general).  There are some compatibility issues
6280 with @emph{unit-at-a-time} mode:
6281 @itemize @bullet
6282 @item
6283 enabling @emph{unit-at-a-time} mode may change the order
6284 in which functions, variables, and top-level @code{asm} statements
6285 are emitted, and will likely break code relying on some particular
6286 ordering.  The majority of such top-level @code{asm} statements,
6287 though, can be replaced by @code{section} attributes.  The
6288 @option{fno-toplevel-reorder} option may be used to keep the ordering
6289 used in the input file, at the cost of some optimizations.
6291 @item
6292 @emph{unit-at-a-time} mode removes unreferenced static variables
6293 and functions.  This may result in undefined references
6294 when an @code{asm} statement refers directly to variables or functions
6295 that are otherwise unused.  In that case either the variable/function
6296 shall be listed as an operand of the @code{asm} statement operand or,
6297 in the case of top-level @code{asm} statements the attribute @code{used}
6298 shall be used on the declaration.
6300 @item
6301 Static functions now can use non-standard passing conventions that
6302 may break @code{asm} statements calling functions directly.  Again,
6303 attribute @code{used} will prevent this behavior.
6304 @end itemize
6306 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6307 but this scheme may not be supported by future releases of GCC@.
6309 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6311 @item -fno-toplevel-reorder
6312 @opindex fno-toplevel-reorder
6313 Do not reorder top-level functions, variables, and @code{asm}
6314 statements.  Output them in the same order that they appear in the
6315 input file.  When this option is used, unreferenced static variables
6316 will not be removed.  This option is intended to support existing code
6317 which relies on a particular ordering.  For new code, it is better to
6318 use attributes.
6320 @item -fweb
6321 @opindex fweb
6322 Constructs webs as commonly used for register allocation purposes and assign
6323 each web individual pseudo register.  This allows the register allocation pass
6324 to operate on pseudos directly, but also strengthens several other optimization
6325 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6326 however, make debugging impossible, since variables will no longer stay in a
6327 ``home register''.
6329 Enabled by default with @option{-funroll-loops}.
6331 @item -fwhole-program
6332 @opindex fwhole-program
6333 Assume that the current compilation unit represents whole program being
6334 compiled.  All public functions and variables with the exception of @code{main}
6335 and those merged by attribute @code{externally_visible} become static functions
6336 and in a affect gets more aggressively optimized by interprocedural optimizers.
6337 While this option is equivalent to proper use of @code{static} keyword for
6338 programs consisting of single file, in combination with option
6339 @option{--combine} this flag can be used to compile most of smaller scale C
6340 programs since the functions and variables become local for the whole combined
6341 compilation unit, not for the single source file itself.
6343 This option is not supported for Fortran programs.
6345 @item -fcprop-registers
6346 @opindex fcprop-registers
6347 After register allocation and post-register allocation instruction splitting,
6348 we perform a copy-propagation pass to try to reduce scheduling dependencies
6349 and occasionally eliminate the copy.
6351 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6353 @item -fprofile-dir=@var{path}
6354 @opindex fprofile-dir
6356 Set the directory to search the profile data files in to @var{path}.
6357 This option affects only the profile data generated by
6358 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6359 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6360 and its related options.
6361 By default, GCC will use the current directory as @var{path}
6362 thus the profile data file will appear in the same directory as the object file.
6364 @item -fprofile-generate
6365 @itemx -fprofile-generate=@var{path}
6366 @opindex fprofile-generate
6368 Enable options usually used for instrumenting application to produce
6369 profile useful for later recompilation with profile feedback based
6370 optimization.  You must use @option{-fprofile-generate} both when
6371 compiling and when linking your program.
6373 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6375 If @var{path} is specified, GCC will look at the @var{path} to find
6376 the profile feeedback data files. See @option{-fprofile-dir}.
6378 @item -fprofile-use
6379 @itemx -fprofile-use=@var{path}
6380 @opindex fprofile-use
6381 Enable profile feedback directed optimizations, and optimizations
6382 generally profitable only with profile feedback available.
6384 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6385 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6387 By default, GCC emits an error message if the feedback profiles do not
6388 match the source code.  This error can be turned into a warning by using
6389 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6390 code.
6392 If @var{path} is specified, GCC will look at the @var{path} to find
6393 the profile feedback data files. See @option{-fprofile-dir}.
6394 @end table
6396 The following options control compiler behavior regarding floating
6397 point arithmetic.  These options trade off between speed and
6398 correctness.  All must be specifically enabled.
6400 @table @gcctabopt
6401 @item -ffloat-store
6402 @opindex ffloat-store
6403 Do not store floating point variables in registers, and inhibit other
6404 options that might change whether a floating point value is taken from a
6405 register or memory.
6407 @cindex floating point precision
6408 This option prevents undesirable excess precision on machines such as
6409 the 68000 where the floating registers (of the 68881) keep more
6410 precision than a @code{double} is supposed to have.  Similarly for the
6411 x86 architecture.  For most programs, the excess precision does only
6412 good, but a few programs rely on the precise definition of IEEE floating
6413 point.  Use @option{-ffloat-store} for such programs, after modifying
6414 them to store all pertinent intermediate computations into variables.
6416 @item -ffast-math
6417 @opindex ffast-math
6418 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6419 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6420 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6422 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6424 This option is not turned on by any @option{-O} option since
6425 it can result in incorrect output for programs which depend on
6426 an exact implementation of IEEE or ISO rules/specifications for
6427 math functions. It may, however, yield faster code for programs
6428 that do not require the guarantees of these specifications.
6430 @item -fno-math-errno
6431 @opindex fno-math-errno
6432 Do not set ERRNO after calling math functions that are executed
6433 with a single instruction, e.g., sqrt.  A program that relies on
6434 IEEE exceptions for math error handling may want to use this flag
6435 for speed while maintaining IEEE arithmetic compatibility.
6437 This option is not turned on by any @option{-O} option since
6438 it can result in incorrect output for programs which depend on
6439 an exact implementation of IEEE or ISO rules/specifications for
6440 math functions. It may, however, yield faster code for programs
6441 that do not require the guarantees of these specifications.
6443 The default is @option{-fmath-errno}.
6445 On Darwin systems, the math library never sets @code{errno}.  There is
6446 therefore no reason for the compiler to consider the possibility that
6447 it might, and @option{-fno-math-errno} is the default.
6449 @item -funsafe-math-optimizations
6450 @opindex funsafe-math-optimizations
6452 Allow optimizations for floating-point arithmetic that (a) assume
6453 that arguments and results are valid and (b) may violate IEEE or
6454 ANSI standards.  When used at link-time, it may include libraries
6455 or startup files that change the default FPU control word or other
6456 similar optimizations.
6458 This option is not turned on by any @option{-O} option since
6459 it can result in incorrect output for programs which depend on
6460 an exact implementation of IEEE or ISO rules/specifications for
6461 math functions. It may, however, yield faster code for programs
6462 that do not require the guarantees of these specifications.
6463 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6464 @option{-fassociative-math} and @option{-freciprocal-math}.
6466 The default is @option{-fno-unsafe-math-optimizations}.
6468 @item -fassociative-math
6469 @opindex fassociative-math
6471 Allow re-association of operands in series of floating-point operations.
6472 This violates the ISO C and C++ language standard by possibly changing
6473 computation result.  NOTE: re-ordering may change the sign of zero as
6474 well as ignore NaNs and inhibit or create underflow or overflow (and
6475 thus cannot be used on a code which relies on rounding behavior like
6476 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6477 and thus may not be used when ordered comparisons are required.
6478 This option requires that both @option{-fno-signed-zeros} and
6479 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6480 much sense with @option{-frounding-math}.
6482 The default is @option{-fno-associative-math}.
6484 @item -freciprocal-math
6485 @opindex freciprocal-math
6487 Allow the reciprocal of a value to be used instead of dividing by
6488 the value if this enables optimizations.  For example @code{x / y}
6489 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6490 is subject to common subexpression elimination.  Note that this loses
6491 precision and increases the number of flops operating on the value.
6493 The default is @option{-fno-reciprocal-math}.
6495 @item -ffinite-math-only
6496 @opindex ffinite-math-only
6497 Allow optimizations for floating-point arithmetic that assume
6498 that arguments and results are not NaNs or +-Infs.
6500 This option is not turned on by any @option{-O} option since
6501 it can result in incorrect output for programs which depend on
6502 an exact implementation of IEEE or ISO rules/specifications for
6503 math functions. It may, however, yield faster code for programs
6504 that do not require the guarantees of these specifications.
6506 The default is @option{-fno-finite-math-only}.
6508 @item -fno-signed-zeros
6509 @opindex fno-signed-zeros
6510 Allow optimizations for floating point arithmetic that ignore the
6511 signedness of zero.  IEEE arithmetic specifies the behavior of
6512 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6513 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6514 This option implies that the sign of a zero result isn't significant.
6516 The default is @option{-fsigned-zeros}.
6518 @item -fno-trapping-math
6519 @opindex fno-trapping-math
6520 Compile code assuming that floating-point operations cannot generate
6521 user-visible traps.  These traps include division by zero, overflow,
6522 underflow, inexact result and invalid operation.  This option requires
6523 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6524 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6526 This option should never be turned on by any @option{-O} option since
6527 it can result in incorrect output for programs which depend on
6528 an exact implementation of IEEE or ISO rules/specifications for
6529 math functions.
6531 The default is @option{-ftrapping-math}.
6533 @item -frounding-math
6534 @opindex frounding-math
6535 Disable transformations and optimizations that assume default floating
6536 point rounding behavior.  This is round-to-zero for all floating point
6537 to integer conversions, and round-to-nearest for all other arithmetic
6538 truncations.  This option should be specified for programs that change
6539 the FP rounding mode dynamically, or that may be executed with a
6540 non-default rounding mode.  This option disables constant folding of
6541 floating point expressions at compile-time (which may be affected by
6542 rounding mode) and arithmetic transformations that are unsafe in the
6543 presence of sign-dependent rounding modes.
6545 The default is @option{-fno-rounding-math}.
6547 This option is experimental and does not currently guarantee to
6548 disable all GCC optimizations that are affected by rounding mode.
6549 Future versions of GCC may provide finer control of this setting
6550 using C99's @code{FENV_ACCESS} pragma.  This command line option
6551 will be used to specify the default state for @code{FENV_ACCESS}.
6553 @item -frtl-abstract-sequences
6554 @opindex frtl-abstract-sequences
6555 It is a size optimization method. This option is to find identical
6556 sequences of code, which can be turned into pseudo-procedures  and
6557 then  replace  all  occurrences with  calls to  the  newly created
6558 subroutine. It is kind of an opposite of @option{-finline-functions}.
6559 This optimization runs at RTL level.
6561 @item -fsignaling-nans
6562 @opindex fsignaling-nans
6563 Compile code assuming that IEEE signaling NaNs may generate user-visible
6564 traps during floating-point operations.  Setting this option disables
6565 optimizations that may change the number of exceptions visible with
6566 signaling NaNs.  This option implies @option{-ftrapping-math}.
6568 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6569 be defined.
6571 The default is @option{-fno-signaling-nans}.
6573 This option is experimental and does not currently guarantee to
6574 disable all GCC optimizations that affect signaling NaN behavior.
6576 @item -fsingle-precision-constant
6577 @opindex fsingle-precision-constant
6578 Treat floating point constant as single precision constant instead of
6579 implicitly converting it to double precision constant.
6581 @item -fcx-limited-range
6582 @opindex fcx-limited-range
6583 When enabled, this option states that a range reduction step is not
6584 needed when performing complex division.  Also, there is no checking
6585 whether the result of a complex multiplication or division is @code{NaN
6586 + I*NaN}, with an attempt to rescue the situation in that case.  The
6587 default is @option{-fno-cx-limited-range}, but is enabled by
6588 @option{-ffast-math}.
6590 This option controls the default setting of the ISO C99
6591 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6592 all languages.
6594 @item -fcx-fortran-rules
6595 @opindex fcx-fortran-rules
6596 Complex multiplication and division follow Fortran rules.  Range
6597 reduction is done as part of complex division, but there is no checking
6598 whether the result of a complex multiplication or division is @code{NaN
6599 + I*NaN}, with an attempt to rescue the situation in that case.
6601 The default is @option{-fno-cx-fortran-rules}.
6603 @end table
6605 The following options control optimizations that may improve
6606 performance, but are not enabled by any @option{-O} options.  This
6607 section includes experimental options that may produce broken code.
6609 @table @gcctabopt
6610 @item -fbranch-probabilities
6611 @opindex fbranch-probabilities
6612 After running a program compiled with @option{-fprofile-arcs}
6613 (@pxref{Debugging Options,, Options for Debugging Your Program or
6614 @command{gcc}}), you can compile it a second time using
6615 @option{-fbranch-probabilities}, to improve optimizations based on
6616 the number of times each branch was taken.  When the program
6617 compiled with @option{-fprofile-arcs} exits it saves arc execution
6618 counts to a file called @file{@var{sourcename}.gcda} for each source
6619 file.  The information in this data file is very dependent on the
6620 structure of the generated code, so you must use the same source code
6621 and the same optimization options for both compilations.
6623 With @option{-fbranch-probabilities}, GCC puts a
6624 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6625 These can be used to improve optimization.  Currently, they are only
6626 used in one place: in @file{reorg.c}, instead of guessing which path a
6627 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6628 exactly determine which path is taken more often.
6630 @item -fprofile-values
6631 @opindex fprofile-values
6632 If combined with @option{-fprofile-arcs}, it adds code so that some
6633 data about values of expressions in the program is gathered.
6635 With @option{-fbranch-probabilities}, it reads back the data gathered
6636 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6637 notes to instructions for their later usage in optimizations.
6639 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6641 @item -fvpt
6642 @opindex fvpt
6643 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6644 a code to gather information about values of expressions.
6646 With @option{-fbranch-probabilities}, it reads back the data gathered
6647 and actually performs the optimizations based on them.
6648 Currently the optimizations include specialization of division operation
6649 using the knowledge about the value of the denominator.
6651 @item -frename-registers
6652 @opindex frename-registers
6653 Attempt to avoid false dependencies in scheduled code by making use
6654 of registers left over after register allocation.  This optimization
6655 will most benefit processors with lots of registers.  Depending on the
6656 debug information format adopted by the target, however, it can
6657 make debugging impossible, since variables will no longer stay in
6658 a ``home register''.
6660 Enabled by default with @option{-funroll-loops}.
6662 @item -ftracer
6663 @opindex ftracer
6664 Perform tail duplication to enlarge superblock size.  This transformation
6665 simplifies the control flow of the function allowing other optimizations to do
6666 better job.
6668 Enabled with @option{-fprofile-use}.
6670 @item -funroll-loops
6671 @opindex funroll-loops
6672 Unroll loops whose number of iterations can be determined at compile time or
6673 upon entry to the loop.  @option{-funroll-loops} implies
6674 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6675 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6676 small constant number of iterations).  This option makes code larger, and may
6677 or may not make it run faster.
6679 Enabled with @option{-fprofile-use}.
6681 @item -funroll-all-loops
6682 @opindex funroll-all-loops
6683 Unroll all loops, even if their number of iterations is uncertain when
6684 the loop is entered.  This usually makes programs run more slowly.
6685 @option{-funroll-all-loops} implies the same options as
6686 @option{-funroll-loops}.
6688 @item -fpeel-loops
6689 @opindex fpeel-loops
6690 Peels the loops for that there is enough information that they do not
6691 roll much (from profile feedback).  It also turns on complete loop peeling
6692 (i.e.@: complete removal of loops with small constant number of iterations).
6694 Enabled with @option{-fprofile-use}.
6696 @item -fmove-loop-invariants
6697 @opindex fmove-loop-invariants
6698 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6699 at level @option{-O1}
6701 @item -funswitch-loops
6702 @opindex funswitch-loops
6703 Move branches with loop invariant conditions out of the loop, with duplicates
6704 of the loop on both branches (modified according to result of the condition).
6706 @item -ffunction-sections
6707 @itemx -fdata-sections
6708 @opindex ffunction-sections
6709 @opindex fdata-sections
6710 Place each function or data item into its own section in the output
6711 file if the target supports arbitrary sections.  The name of the
6712 function or the name of the data item determines the section's name
6713 in the output file.
6715 Use these options on systems where the linker can perform optimizations
6716 to improve locality of reference in the instruction space.  Most systems
6717 using the ELF object format and SPARC processors running Solaris 2 have
6718 linkers with such optimizations.  AIX may have these optimizations in
6719 the future.
6721 Only use these options when there are significant benefits from doing
6722 so.  When you specify these options, the assembler and linker will
6723 create larger object and executable files and will also be slower.
6724 You will not be able to use @code{gprof} on all systems if you
6725 specify this option and you may have problems with debugging if
6726 you specify both this option and @option{-g}.
6728 @item -fbranch-target-load-optimize
6729 @opindex fbranch-target-load-optimize
6730 Perform branch target register load optimization before prologue / epilogue
6731 threading.
6732 The use of target registers can typically be exposed only during reload,
6733 thus hoisting loads out of loops and doing inter-block scheduling needs
6734 a separate optimization pass.
6736 @item -fbranch-target-load-optimize2
6737 @opindex fbranch-target-load-optimize2
6738 Perform branch target register load optimization after prologue / epilogue
6739 threading.
6741 @item -fbtr-bb-exclusive
6742 @opindex fbtr-bb-exclusive
6743 When performing branch target register load optimization, don't reuse
6744 branch target registers in within any basic block.
6746 @item -fstack-protector
6747 @opindex fstack-protector
6748 Emit extra code to check for buffer overflows, such as stack smashing
6749 attacks.  This is done by adding a guard variable to functions with
6750 vulnerable objects.  This includes functions that call alloca, and
6751 functions with buffers larger than 8 bytes.  The guards are initialized
6752 when a function is entered and then checked when the function exits.
6753 If a guard check fails, an error message is printed and the program exits.
6755 @item -fstack-protector-all
6756 @opindex fstack-protector-all
6757 Like @option{-fstack-protector} except that all functions are protected.
6759 @item -fsection-anchors
6760 @opindex fsection-anchors
6761 Try to reduce the number of symbolic address calculations by using
6762 shared ``anchor'' symbols to address nearby objects.  This transformation
6763 can help to reduce the number of GOT entries and GOT accesses on some
6764 targets.
6766 For example, the implementation of the following function @code{foo}:
6768 @smallexample
6769 static int a, b, c;
6770 int foo (void) @{ return a + b + c; @}
6771 @end smallexample
6773 would usually calculate the addresses of all three variables, but if you
6774 compile it with @option{-fsection-anchors}, it will access the variables
6775 from a common anchor point instead.  The effect is similar to the
6776 following pseudocode (which isn't valid C):
6778 @smallexample
6779 int foo (void)
6781   register int *xr = &x;
6782   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6784 @end smallexample
6786 Not all targets support this option.
6788 @item --param @var{name}=@var{value}
6789 @opindex param
6790 In some places, GCC uses various constants to control the amount of
6791 optimization that is done.  For example, GCC will not inline functions
6792 that contain more that a certain number of instructions.  You can
6793 control some of these constants on the command-line using the
6794 @option{--param} option.
6796 The names of specific parameters, and the meaning of the values, are
6797 tied to the internals of the compiler, and are subject to change
6798 without notice in future releases.
6800 In each case, the @var{value} is an integer.  The allowable choices for
6801 @var{name} are given in the following table:
6803 @table @gcctabopt
6804 @item sra-max-structure-size
6805 The maximum structure size, in bytes, at which the scalar replacement
6806 of aggregates (SRA) optimization will perform block copies.  The
6807 default value, 0, implies that GCC will select the most appropriate
6808 size itself.
6810 @item sra-field-structure-ratio
6811 The threshold ratio (as a percentage) between instantiated fields and
6812 the complete structure size.  We say that if the ratio of the number
6813 of bytes in instantiated fields to the number of bytes in the complete
6814 structure exceeds this parameter, then block copies are not used.  The
6815 default is 75.
6817 @item struct-reorg-cold-struct-ratio
6818 The threshold ratio (as a percentage) between a structure frequency
6819 and the frequency of the hottest structure in the program.  This parameter
6820 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6821 We say that if the ratio of a structure frequency, calculated by profiling, 
6822 to the hottest structure frequency in the program is less than this 
6823 parameter, then structure reorganization is not applied to this structure.
6824 The default is 10.
6826 @item max-crossjump-edges
6827 The maximum number of incoming edges to consider for crossjumping.
6828 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6829 the number of edges incoming to each block.  Increasing values mean
6830 more aggressive optimization, making the compile time increase with
6831 probably small improvement in executable size.
6833 @item min-crossjump-insns
6834 The minimum number of instructions which must be matched at the end
6835 of two blocks before crossjumping will be performed on them.  This
6836 value is ignored in the case where all instructions in the block being
6837 crossjumped from are matched.  The default value is 5.
6839 @item max-grow-copy-bb-insns
6840 The maximum code size expansion factor when copying basic blocks
6841 instead of jumping.  The expansion is relative to a jump instruction.
6842 The default value is 8.
6844 @item max-goto-duplication-insns
6845 The maximum number of instructions to duplicate to a block that jumps
6846 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6847 passes, GCC factors computed gotos early in the compilation process,
6848 and unfactors them as late as possible.  Only computed jumps at the
6849 end of a basic blocks with no more than max-goto-duplication-insns are
6850 unfactored.  The default value is 8.
6852 @item max-delay-slot-insn-search
6853 The maximum number of instructions to consider when looking for an
6854 instruction to fill a delay slot.  If more than this arbitrary number of
6855 instructions is searched, the time savings from filling the delay slot
6856 will be minimal so stop searching.  Increasing values mean more
6857 aggressive optimization, making the compile time increase with probably
6858 small improvement in executable run time.
6860 @item max-delay-slot-live-search
6861 When trying to fill delay slots, the maximum number of instructions to
6862 consider when searching for a block with valid live register
6863 information.  Increasing this arbitrarily chosen value means more
6864 aggressive optimization, increasing the compile time.  This parameter
6865 should be removed when the delay slot code is rewritten to maintain the
6866 control-flow graph.
6868 @item max-gcse-memory
6869 The approximate maximum amount of memory that will be allocated in
6870 order to perform the global common subexpression elimination
6871 optimization.  If more memory than specified is required, the
6872 optimization will not be done.
6874 @item max-gcse-passes
6875 The maximum number of passes of GCSE to run.  The default is 1.
6877 @item max-pending-list-length
6878 The maximum number of pending dependencies scheduling will allow
6879 before flushing the current state and starting over.  Large functions
6880 with few branches or calls can create excessively large lists which
6881 needlessly consume memory and resources.
6883 @item max-inline-insns-single
6884 Several parameters control the tree inliner used in gcc.
6885 This number sets the maximum number of instructions (counted in GCC's
6886 internal representation) in a single function that the tree inliner
6887 will consider for inlining.  This only affects functions declared
6888 inline and methods implemented in a class declaration (C++).
6889 The default value is 450.
6891 @item max-inline-insns-auto
6892 When you use @option{-finline-functions} (included in @option{-O3}),
6893 a lot of functions that would otherwise not be considered for inlining
6894 by the compiler will be investigated.  To those functions, a different
6895 (more restrictive) limit compared to functions declared inline can
6896 be applied.
6897 The default value is 90.
6899 @item large-function-insns
6900 The limit specifying really large functions.  For functions larger than this
6901 limit after inlining inlining is constrained by
6902 @option{--param large-function-growth}.  This parameter is useful primarily
6903 to avoid extreme compilation time caused by non-linear algorithms used by the
6904 backend.
6905 This parameter is ignored when @option{-funit-at-a-time} is not used.
6906 The default value is 2700.
6908 @item large-function-growth
6909 Specifies maximal growth of large function caused by inlining in percents.
6910 This parameter is ignored when @option{-funit-at-a-time} is not used.
6911 The default value is 100 which limits large function growth to 2.0 times
6912 the original size.
6914 @item large-unit-insns
6915 The limit specifying large translation unit.  Growth caused by inlining of
6916 units larger than this limit is limited by @option{--param inline-unit-growth}.
6917 For small units this might be too tight (consider unit consisting of function A
6918 that is inline and B that just calls A three time.  If B is small relative to
6919 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6920 large units consisting of small inlineable functions however the overall unit
6921 growth limit is needed to avoid exponential explosion of code size.  Thus for
6922 smaller units, the size is increased to @option{--param large-unit-insns}
6923 before applying @option{--param inline-unit-growth}.  The default is 10000
6925 @item inline-unit-growth
6926 Specifies maximal overall growth of the compilation unit caused by inlining.
6927 This parameter is ignored when @option{-funit-at-a-time} is not used.
6928 The default value is 30 which limits unit growth to 1.3 times the original
6929 size.
6931 @item large-stack-frame
6932 The limit specifying large stack frames.  While inlining the algorithm is trying
6933 to not grow past this limit too much.  Default value is 256 bytes.
6935 @item large-stack-frame-growth
6936 Specifies maximal growth of large stack frames caused by inlining in percents.
6937 The default value is 1000 which limits large stack frame growth to 11 times
6938 the original size.
6940 @item max-inline-insns-recursive
6941 @itemx max-inline-insns-recursive-auto
6942 Specifies maximum number of instructions out-of-line copy of self recursive inline
6943 function can grow into by performing recursive inlining.
6945 For functions declared inline @option{--param max-inline-insns-recursive} is
6946 taken into account.  For function not declared inline, recursive inlining
6947 happens only when @option{-finline-functions} (included in @option{-O3}) is
6948 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6949 default value is 450.
6951 @item max-inline-recursive-depth
6952 @itemx max-inline-recursive-depth-auto
6953 Specifies maximum recursion depth used by the recursive inlining.
6955 For functions declared inline @option{--param max-inline-recursive-depth} is
6956 taken into account.  For function not declared inline, recursive inlining
6957 happens only when @option{-finline-functions} (included in @option{-O3}) is
6958 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6959 default value is 8.
6961 @item min-inline-recursive-probability
6962 Recursive inlining is profitable only for function having deep recursion
6963 in average and can hurt for function having little recursion depth by
6964 increasing the prologue size or complexity of function body to other
6965 optimizers.
6967 When profile feedback is available (see @option{-fprofile-generate}) the actual
6968 recursion depth can be guessed from probability that function will recurse via
6969 given call expression.  This parameter limits inlining only to call expression
6970 whose probability exceeds given threshold (in percents).  The default value is
6973 @item inline-call-cost
6974 Specify cost of call instruction relative to simple arithmetics operations
6975 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6976 functions and at the same time increases size of leaf function that is believed to
6977 reduce function size by being inlined.  In effect it increases amount of
6978 inlining for code having large abstraction penalty (many functions that just
6979 pass the arguments to other functions) and decrease inlining for code with low
6980 abstraction penalty.  The default value is 12.
6982 @item min-vect-loop-bound
6983 The minimum number of iterations under which a loop will not get vectorized
6984 when @option{-ftree-vectorize} is used.  The number of iterations after
6985 vectorization needs to be greater than the value specified by this option
6986 to allow vectorization.  The default value is 0.
6988 @item max-unrolled-insns
6989 The maximum number of instructions that a loop should have if that loop
6990 is unrolled, and if the loop is unrolled, it determines how many times
6991 the loop code is unrolled.
6993 @item max-average-unrolled-insns
6994 The maximum number of instructions biased by probabilities of their execution
6995 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6996 it determines how many times the loop code is unrolled.
6998 @item max-unroll-times
6999 The maximum number of unrollings of a single loop.
7001 @item max-peeled-insns
7002 The maximum number of instructions that a loop should have if that loop
7003 is peeled, and if the loop is peeled, it determines how many times
7004 the loop code is peeled.
7006 @item max-peel-times
7007 The maximum number of peelings of a single loop.
7009 @item max-completely-peeled-insns
7010 The maximum number of insns of a completely peeled loop.
7012 @item max-completely-peel-times
7013 The maximum number of iterations of a loop to be suitable for complete peeling.
7015 @item max-unswitch-insns
7016 The maximum number of insns of an unswitched loop.
7018 @item max-unswitch-level
7019 The maximum number of branches unswitched in a single loop.
7021 @item lim-expensive
7022 The minimum cost of an expensive expression in the loop invariant motion.
7024 @item iv-consider-all-candidates-bound
7025 Bound on number of candidates for induction variables below that
7026 all candidates are considered for each use in induction variable
7027 optimizations.  Only the most relevant candidates are considered
7028 if there are more candidates, to avoid quadratic time complexity.
7030 @item iv-max-considered-uses
7031 The induction variable optimizations give up on loops that contain more
7032 induction variable uses.
7034 @item iv-always-prune-cand-set-bound
7035 If number of candidates in the set is smaller than this value,
7036 we always try to remove unnecessary ivs from the set during its
7037 optimization when a new iv is added to the set.
7039 @item scev-max-expr-size
7040 Bound on size of expressions used in the scalar evolutions analyzer.
7041 Large expressions slow the analyzer.
7043 @item omega-max-vars
7044 The maximum number of variables in an Omega constraint system.
7045 The default value is 128.
7047 @item omega-max-geqs
7048 The maximum number of inequalities in an Omega constraint system.
7049 The default value is 256.
7051 @item omega-max-eqs
7052 The maximum number of equalities in an Omega constraint system.
7053 The default value is 128.
7055 @item omega-max-wild-cards
7056 The maximum number of wildcard variables that the Omega solver will
7057 be able to insert.  The default value is 18.
7059 @item omega-hash-table-size
7060 The size of the hash table in the Omega solver.  The default value is
7061 550.
7063 @item omega-max-keys
7064 The maximal number of keys used by the Omega solver.  The default
7065 value is 500.
7067 @item omega-eliminate-redundant-constraints
7068 When set to 1, use expensive methods to eliminate all redundant
7069 constraints.  The default value is 0.
7071 @item vect-max-version-for-alignment-checks
7072 The maximum number of runtime checks that can be performed when
7073 doing loop versioning for alignment in the vectorizer.  See option
7074 ftree-vect-loop-version for more information.
7076 @item vect-max-version-for-alias-checks
7077 The maximum number of runtime checks that can be performed when
7078 doing loop versioning for alias in the vectorizer.  See option
7079 ftree-vect-loop-version for more information.
7081 @item max-iterations-to-track
7083 The maximum number of iterations of a loop the brute force algorithm
7084 for analysis of # of iterations of the loop tries to evaluate.
7086 @item hot-bb-count-fraction
7087 Select fraction of the maximal count of repetitions of basic block in program
7088 given basic block needs to have to be considered hot.
7090 @item hot-bb-frequency-fraction
7091 Select fraction of the maximal frequency of executions of basic block in
7092 function given basic block needs to have to be considered hot
7094 @item max-predicted-iterations
7095 The maximum number of loop iterations we predict statically.  This is useful
7096 in cases where function contain single loop with known bound and other loop
7097 with unknown.  We predict the known number of iterations correctly, while
7098 the unknown number of iterations average to roughly 10.  This means that the
7099 loop without bounds would appear artificially cold relative to the other one.
7101 @item align-threshold
7103 Select fraction of the maximal frequency of executions of basic block in
7104 function given basic block will get aligned.
7106 @item align-loop-iterations
7108 A loop expected to iterate at lest the selected number of iterations will get
7109 aligned.
7111 @item tracer-dynamic-coverage
7112 @itemx tracer-dynamic-coverage-feedback
7114 This value is used to limit superblock formation once the given percentage of
7115 executed instructions is covered.  This limits unnecessary code size
7116 expansion.
7118 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7119 feedback is available.  The real profiles (as opposed to statically estimated
7120 ones) are much less balanced allowing the threshold to be larger value.
7122 @item tracer-max-code-growth
7123 Stop tail duplication once code growth has reached given percentage.  This is
7124 rather hokey argument, as most of the duplicates will be eliminated later in
7125 cross jumping, so it may be set to much higher values than is the desired code
7126 growth.
7128 @item tracer-min-branch-ratio
7130 Stop reverse growth when the reverse probability of best edge is less than this
7131 threshold (in percent).
7133 @item tracer-min-branch-ratio
7134 @itemx tracer-min-branch-ratio-feedback
7136 Stop forward growth if the best edge do have probability lower than this
7137 threshold.
7139 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7140 compilation for profile feedback and one for compilation without.  The value
7141 for compilation with profile feedback needs to be more conservative (higher) in
7142 order to make tracer effective.
7144 @item max-cse-path-length
7146 Maximum number of basic blocks on path that cse considers.  The default is 10.
7148 @item max-cse-insns
7149 The maximum instructions CSE process before flushing. The default is 1000.
7151 @item max-aliased-vops
7153 Maximum number of virtual operands per function allowed to represent
7154 aliases before triggering the alias partitioning heuristic.  Alias
7155 partitioning reduces compile times and memory consumption needed for
7156 aliasing at the expense of precision loss in alias information.  The
7157 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7158 for -O3.
7160 Notice that if a function contains more memory statements than the
7161 value of this parameter, it is not really possible to achieve this
7162 reduction.  In this case, the compiler will use the number of memory
7163 statements as the value for @option{max-aliased-vops}.
7165 @item avg-aliased-vops
7167 Average number of virtual operands per statement allowed to represent
7168 aliases before triggering the alias partitioning heuristic.  This
7169 works in conjunction with @option{max-aliased-vops}.  If a function
7170 contains more than @option{max-aliased-vops} virtual operators, then
7171 memory symbols will be grouped into memory partitions until either the
7172 total number of virtual operators is below @option{max-aliased-vops}
7173 or the average number of virtual operators per memory statement is
7174 below @option{avg-aliased-vops}.  The default value for this parameter
7175 is 1 for -O1 and -O2, and 3 for -O3.
7177 @item ggc-min-expand
7179 GCC uses a garbage collector to manage its own memory allocation.  This
7180 parameter specifies the minimum percentage by which the garbage
7181 collector's heap should be allowed to expand between collections.
7182 Tuning this may improve compilation speed; it has no effect on code
7183 generation.
7185 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7186 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7187 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7188 GCC is not able to calculate RAM on a particular platform, the lower
7189 bound of 30% is used.  Setting this parameter and
7190 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7191 every opportunity.  This is extremely slow, but can be useful for
7192 debugging.
7194 @item ggc-min-heapsize
7196 Minimum size of the garbage collector's heap before it begins bothering
7197 to collect garbage.  The first collection occurs after the heap expands
7198 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7199 tuning this may improve compilation speed, and has no effect on code
7200 generation.
7202 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7203 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7204 with a lower bound of 4096 (four megabytes) and an upper bound of
7205 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7206 particular platform, the lower bound is used.  Setting this parameter
7207 very large effectively disables garbage collection.  Setting this
7208 parameter and @option{ggc-min-expand} to zero causes a full collection
7209 to occur at every opportunity.
7211 @item max-reload-search-insns
7212 The maximum number of instruction reload should look backward for equivalent
7213 register.  Increasing values mean more aggressive optimization, making the
7214 compile time increase with probably slightly better performance.  The default
7215 value is 100.
7217 @item max-cselib-memory-locations
7218 The maximum number of memory locations cselib should take into account.
7219 Increasing values mean more aggressive optimization, making the compile time
7220 increase with probably slightly better performance.  The default value is 500.
7222 @item reorder-blocks-duplicate
7223 @itemx reorder-blocks-duplicate-feedback
7225 Used by basic block reordering pass to decide whether to use unconditional
7226 branch or duplicate the code on its destination.  Code is duplicated when its
7227 estimated size is smaller than this value multiplied by the estimated size of
7228 unconditional jump in the hot spots of the program.
7230 The @option{reorder-block-duplicate-feedback} is used only when profile
7231 feedback is available and may be set to higher values than
7232 @option{reorder-block-duplicate} since information about the hot spots is more
7233 accurate.
7235 @item max-sched-ready-insns
7236 The maximum number of instructions ready to be issued the scheduler should
7237 consider at any given time during the first scheduling pass.  Increasing
7238 values mean more thorough searches, making the compilation time increase
7239 with probably little benefit.  The default value is 100.
7241 @item max-sched-region-blocks
7242 The maximum number of blocks in a region to be considered for
7243 interblock scheduling.  The default value is 10.
7245 @item max-sched-region-insns
7246 The maximum number of insns in a region to be considered for
7247 interblock scheduling.  The default value is 100.
7249 @item min-spec-prob
7250 The minimum probability (in percents) of reaching a source block
7251 for interblock speculative scheduling.  The default value is 40.
7253 @item max-sched-extend-regions-iters
7254 The maximum number of iterations through CFG to extend regions.
7255 0 - disable region extension,
7256 N - do at most N iterations.
7257 The default value is 0.
7259 @item max-sched-insn-conflict-delay
7260 The maximum conflict delay for an insn to be considered for speculative motion.
7261 The default value is 3.
7263 @item sched-spec-prob-cutoff
7264 The minimal probability of speculation success (in percents), so that
7265 speculative insn will be scheduled.
7266 The default value is 40.
7268 @item max-last-value-rtl
7270 The maximum size measured as number of RTLs that can be recorded in an expression
7271 in combiner for a pseudo register as last known value of that register.  The default
7272 is 10000.
7274 @item integer-share-limit
7275 Small integer constants can use a shared data structure, reducing the
7276 compiler's memory usage and increasing its speed.  This sets the maximum
7277 value of a shared integer constant.  The default value is 256.
7279 @item min-virtual-mappings
7280 Specifies the minimum number of virtual mappings in the incremental
7281 SSA updater that should be registered to trigger the virtual mappings
7282 heuristic defined by virtual-mappings-ratio.  The default value is
7283 100.
7285 @item virtual-mappings-ratio
7286 If the number of virtual mappings is virtual-mappings-ratio bigger
7287 than the number of virtual symbols to be updated, then the incremental
7288 SSA updater switches to a full update for those symbols.  The default
7289 ratio is 3.
7291 @item ssp-buffer-size
7292 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7293 protection when @option{-fstack-protection} is used.
7295 @item max-jump-thread-duplication-stmts
7296 Maximum number of statements allowed in a block that needs to be
7297 duplicated when threading jumps.
7299 @item max-fields-for-field-sensitive
7300 Maximum number of fields in a structure we will treat in
7301 a field sensitive manner during pointer analysis.
7303 @item prefetch-latency
7304 Estimate on average number of instructions that are executed before
7305 prefetch finishes.  The distance we prefetch ahead is proportional
7306 to this constant.  Increasing this number may also lead to less
7307 streams being prefetched (see @option{simultaneous-prefetches}).
7309 @item simultaneous-prefetches
7310 Maximum number of prefetches that can run at the same time.
7312 @item l1-cache-line-size
7313 The size of cache line in L1 cache, in bytes.
7315 @item l1-cache-size
7316 The size of L1 cache, in kilobytes.
7318 @item l2-cache-size
7319 The size of L2 cache, in kilobytes.
7321 @item use-canonical-types
7322 Whether the compiler should use the ``canonical'' type system.  By
7323 default, this should always be 1, which uses a more efficient internal
7324 mechanism for comparing types in C++ and Objective-C++.  However, if
7325 bugs in the canonical type system are causing compilation failures,
7326 set this value to 0 to disable canonical types.
7328 @item max-partial-antic-length
7329 Maximum length of the partial antic set computed during the tree
7330 partial redundancy elimination optimization (@option{-ftree-pre}) when
7331 optimizing at @option{-O3} and above.  For some sorts of source code
7332 the enhanced partial redundancy elimination optimization can run away,
7333 consuming all of the memory available on the host machine.  This
7334 parameter sets a limit on the length of the sets that are computed,
7335 which prevents the runaway behaviour.  Setting a value of 0 for
7336 this paramter will allow an unlimited set length.
7338 @item sccvn-max-scc-size
7339 Maximum size of a strongly connected component (SCC) during SCCVN
7340 processing.  If this limit is hit, SCCVN processing for the whole
7341 function will not be done and optimizations depending on it will
7342 be disabled.  The default maximum SCC size is 10000.
7344 @end table
7345 @end table
7347 @node Preprocessor Options
7348 @section Options Controlling the Preprocessor
7349 @cindex preprocessor options
7350 @cindex options, preprocessor
7352 These options control the C preprocessor, which is run on each C source
7353 file before actual compilation.
7355 If you use the @option{-E} option, nothing is done except preprocessing.
7356 Some of these options make sense only together with @option{-E} because
7357 they cause the preprocessor output to be unsuitable for actual
7358 compilation.
7360 @table @gcctabopt
7361 @opindex Wp
7362 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7363 and pass @var{option} directly through to the preprocessor.  If
7364 @var{option} contains commas, it is split into multiple options at the
7365 commas.  However, many options are modified, translated or interpreted
7366 by the compiler driver before being passed to the preprocessor, and
7367 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7368 interface is undocumented and subject to change, so whenever possible
7369 you should avoid using @option{-Wp} and let the driver handle the
7370 options instead.
7372 @item -Xpreprocessor @var{option}
7373 @opindex preprocessor
7374 Pass @var{option} as an option to the preprocessor.  You can use this to
7375 supply system-specific preprocessor options which GCC does not know how to
7376 recognize.
7378 If you want to pass an option that takes an argument, you must use
7379 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7380 @end table
7382 @include cppopts.texi
7384 @node Assembler Options
7385 @section Passing Options to the Assembler
7387 @c prevent bad page break with this line
7388 You can pass options to the assembler.
7390 @table @gcctabopt
7391 @item -Wa,@var{option}
7392 @opindex Wa
7393 Pass @var{option} as an option to the assembler.  If @var{option}
7394 contains commas, it is split into multiple options at the commas.
7396 @item -Xassembler @var{option}
7397 @opindex Xassembler
7398 Pass @var{option} as an option to the assembler.  You can use this to
7399 supply system-specific assembler options which GCC does not know how to
7400 recognize.
7402 If you want to pass an option that takes an argument, you must use
7403 @option{-Xassembler} twice, once for the option and once for the argument.
7405 @end table
7407 @node Link Options
7408 @section Options for Linking
7409 @cindex link options
7410 @cindex options, linking
7412 These options come into play when the compiler links object files into
7413 an executable output file.  They are meaningless if the compiler is
7414 not doing a link step.
7416 @table @gcctabopt
7417 @cindex file names
7418 @item @var{object-file-name}
7419 A file name that does not end in a special recognized suffix is
7420 considered to name an object file or library.  (Object files are
7421 distinguished from libraries by the linker according to the file
7422 contents.)  If linking is done, these object files are used as input
7423 to the linker.
7425 @item -c
7426 @itemx -S
7427 @itemx -E
7428 @opindex c
7429 @opindex S
7430 @opindex E
7431 If any of these options is used, then the linker is not run, and
7432 object file names should not be used as arguments.  @xref{Overall
7433 Options}.
7435 @cindex Libraries
7436 @item -l@var{library}
7437 @itemx -l @var{library}
7438 @opindex l
7439 Search the library named @var{library} when linking.  (The second
7440 alternative with the library as a separate argument is only for
7441 POSIX compliance and is not recommended.)
7443 It makes a difference where in the command you write this option; the
7444 linker searches and processes libraries and object files in the order they
7445 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7446 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7447 to functions in @samp{z}, those functions may not be loaded.
7449 The linker searches a standard list of directories for the library,
7450 which is actually a file named @file{lib@var{library}.a}.  The linker
7451 then uses this file as if it had been specified precisely by name.
7453 The directories searched include several standard system directories
7454 plus any that you specify with @option{-L}.
7456 Normally the files found this way are library files---archive files
7457 whose members are object files.  The linker handles an archive file by
7458 scanning through it for members which define symbols that have so far
7459 been referenced but not defined.  But if the file that is found is an
7460 ordinary object file, it is linked in the usual fashion.  The only
7461 difference between using an @option{-l} option and specifying a file name
7462 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7463 and searches several directories.
7465 @item -lobjc
7466 @opindex lobjc
7467 You need this special case of the @option{-l} option in order to
7468 link an Objective-C or Objective-C++ program.
7470 @item -nostartfiles
7471 @opindex nostartfiles
7472 Do not use the standard system startup files when linking.
7473 The standard system libraries are used normally, unless @option{-nostdlib}
7474 or @option{-nodefaultlibs} is used.
7476 @item -nodefaultlibs
7477 @opindex nodefaultlibs
7478 Do not use the standard system libraries when linking.
7479 Only the libraries you specify will be passed to the linker.
7480 The standard startup files are used normally, unless @option{-nostartfiles}
7481 is used.  The compiler may generate calls to @code{memcmp},
7482 @code{memset}, @code{memcpy} and @code{memmove}.
7483 These entries are usually resolved by entries in
7484 libc.  These entry points should be supplied through some other
7485 mechanism when this option is specified.
7487 @item -nostdlib
7488 @opindex nostdlib
7489 Do not use the standard system startup files or libraries when linking.
7490 No startup files and only the libraries you specify will be passed to
7491 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7492 @code{memcpy} and @code{memmove}.
7493 These entries are usually resolved by entries in
7494 libc.  These entry points should be supplied through some other
7495 mechanism when this option is specified.
7497 @cindex @option{-lgcc}, use with @option{-nostdlib}
7498 @cindex @option{-nostdlib} and unresolved references
7499 @cindex unresolved references and @option{-nostdlib}
7500 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7501 @cindex @option{-nodefaultlibs} and unresolved references
7502 @cindex unresolved references and @option{-nodefaultlibs}
7503 One of the standard libraries bypassed by @option{-nostdlib} and
7504 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7505 that GCC uses to overcome shortcomings of particular machines, or special
7506 needs for some languages.
7507 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7508 Collection (GCC) Internals},
7509 for more discussion of @file{libgcc.a}.)
7510 In most cases, you need @file{libgcc.a} even when you want to avoid
7511 other standard libraries.  In other words, when you specify @option{-nostdlib}
7512 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7513 This ensures that you have no unresolved references to internal GCC
7514 library subroutines.  (For example, @samp{__main}, used to ensure C++
7515 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7516 GNU Compiler Collection (GCC) Internals}.)
7518 @item -pie
7519 @opindex pie
7520 Produce a position independent executable on targets which support it.
7521 For predictable results, you must also specify the same set of options
7522 that were used to generate code (@option{-fpie}, @option{-fPIE},
7523 or model suboptions) when you specify this option.
7525 @item -rdynamic
7526 @opindex rdynamic
7527 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7528 that support it. This instructs the linker to add all symbols, not
7529 only used ones, to the dynamic symbol table. This option is needed
7530 for some uses of @code{dlopen} or to allow obtaining backtraces
7531 from within a program.
7533 @item -s
7534 @opindex s
7535 Remove all symbol table and relocation information from the executable.
7537 @item -static
7538 @opindex static
7539 On systems that support dynamic linking, this prevents linking with the shared
7540 libraries.  On other systems, this option has no effect.
7542 @item -shared
7543 @opindex shared
7544 Produce a shared object which can then be linked with other objects to
7545 form an executable.  Not all systems support this option.  For predictable
7546 results, you must also specify the same set of options that were used to
7547 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7548 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7549 needs to build supplementary stub code for constructors to work.  On
7550 multi-libbed systems, @samp{gcc -shared} must select the correct support
7551 libraries to link against.  Failing to supply the correct flags may lead
7552 to subtle defects.  Supplying them in cases where they are not necessary
7553 is innocuous.}
7555 @item -shared-libgcc
7556 @itemx -static-libgcc
7557 @opindex shared-libgcc
7558 @opindex static-libgcc
7559 On systems that provide @file{libgcc} as a shared library, these options
7560 force the use of either the shared or static version respectively.
7561 If no shared version of @file{libgcc} was built when the compiler was
7562 configured, these options have no effect.
7564 There are several situations in which an application should use the
7565 shared @file{libgcc} instead of the static version.  The most common
7566 of these is when the application wishes to throw and catch exceptions
7567 across different shared libraries.  In that case, each of the libraries
7568 as well as the application itself should use the shared @file{libgcc}.
7570 Therefore, the G++ and GCJ drivers automatically add
7571 @option{-shared-libgcc} whenever you build a shared library or a main
7572 executable, because C++ and Java programs typically use exceptions, so
7573 this is the right thing to do.
7575 If, instead, you use the GCC driver to create shared libraries, you may
7576 find that they will not always be linked with the shared @file{libgcc}.
7577 If GCC finds, at its configuration time, that you have a non-GNU linker
7578 or a GNU linker that does not support option @option{--eh-frame-hdr},
7579 it will link the shared version of @file{libgcc} into shared libraries
7580 by default.  Otherwise, it will take advantage of the linker and optimize
7581 away the linking with the shared version of @file{libgcc}, linking with
7582 the static version of libgcc by default.  This allows exceptions to
7583 propagate through such shared libraries, without incurring relocation
7584 costs at library load time.
7586 However, if a library or main executable is supposed to throw or catch
7587 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7588 for the languages used in the program, or using the option
7589 @option{-shared-libgcc}, such that it is linked with the shared
7590 @file{libgcc}.
7592 @item -symbolic
7593 @opindex symbolic
7594 Bind references to global symbols when building a shared object.  Warn
7595 about any unresolved references (unless overridden by the link editor
7596 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7597 this option.
7599 @item -Xlinker @var{option}
7600 @opindex Xlinker
7601 Pass @var{option} as an option to the linker.  You can use this to
7602 supply system-specific linker options which GCC does not know how to
7603 recognize.
7605 If you want to pass an option that takes an argument, you must use
7606 @option{-Xlinker} twice, once for the option and once for the argument.
7607 For example, to pass @option{-assert definitions}, you must write
7608 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7609 @option{-Xlinker "-assert definitions"}, because this passes the entire
7610 string as a single argument, which is not what the linker expects.
7612 @item -Wl,@var{option}
7613 @opindex Wl
7614 Pass @var{option} as an option to the linker.  If @var{option} contains
7615 commas, it is split into multiple options at the commas.
7617 @item -u @var{symbol}
7618 @opindex u
7619 Pretend the symbol @var{symbol} is undefined, to force linking of
7620 library modules to define it.  You can use @option{-u} multiple times with
7621 different symbols to force loading of additional library modules.
7622 @end table
7624 @node Directory Options
7625 @section Options for Directory Search
7626 @cindex directory options
7627 @cindex options, directory search
7628 @cindex search path
7630 These options specify directories to search for header files, for
7631 libraries and for parts of the compiler:
7633 @table @gcctabopt
7634 @item -I@var{dir}
7635 @opindex I
7636 Add the directory @var{dir} to the head of the list of directories to be
7637 searched for header files.  This can be used to override a system header
7638 file, substituting your own version, since these directories are
7639 searched before the system header file directories.  However, you should
7640 not use this option to add directories that contain vendor-supplied
7641 system header files (use @option{-isystem} for that).  If you use more than
7642 one @option{-I} option, the directories are scanned in left-to-right
7643 order; the standard system directories come after.
7645 If a standard system include directory, or a directory specified with
7646 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7647 option will be ignored.  The directory will still be searched but as a
7648 system directory at its normal position in the system include chain.
7649 This is to ensure that GCC's procedure to fix buggy system headers and
7650 the ordering for the include_next directive are not inadvertently changed.
7651 If you really need to change the search order for system directories,
7652 use the @option{-nostdinc} and/or @option{-isystem} options.
7654 @item -iquote@var{dir}
7655 @opindex iquote
7656 Add the directory @var{dir} to the head of the list of directories to
7657 be searched for header files only for the case of @samp{#include
7658 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7659 otherwise just like @option{-I}.
7661 @item -L@var{dir}
7662 @opindex L
7663 Add directory @var{dir} to the list of directories to be searched
7664 for @option{-l}.
7666 @item -B@var{prefix}
7667 @opindex B
7668 This option specifies where to find the executables, libraries,
7669 include files, and data files of the compiler itself.
7671 The compiler driver program runs one or more of the subprograms
7672 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7673 @var{prefix} as a prefix for each program it tries to run, both with and
7674 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7676 For each subprogram to be run, the compiler driver first tries the
7677 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7678 was not specified, the driver tries two standard prefixes, which are
7679 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7680 those results in a file name that is found, the unmodified program
7681 name is searched for using the directories specified in your
7682 @env{PATH} environment variable.
7684 The compiler will check to see if the path provided by the @option{-B}
7685 refers to a directory, and if necessary it will add a directory
7686 separator character at the end of the path.
7688 @option{-B} prefixes that effectively specify directory names also apply
7689 to libraries in the linker, because the compiler translates these
7690 options into @option{-L} options for the linker.  They also apply to
7691 includes files in the preprocessor, because the compiler translates these
7692 options into @option{-isystem} options for the preprocessor.  In this case,
7693 the compiler appends @samp{include} to the prefix.
7695 The run-time support file @file{libgcc.a} can also be searched for using
7696 the @option{-B} prefix, if needed.  If it is not found there, the two
7697 standard prefixes above are tried, and that is all.  The file is left
7698 out of the link if it is not found by those means.
7700 Another way to specify a prefix much like the @option{-B} prefix is to use
7701 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7702 Variables}.
7704 As a special kludge, if the path provided by @option{-B} is
7705 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7706 9, then it will be replaced by @file{[dir/]include}.  This is to help
7707 with boot-strapping the compiler.
7709 @item -specs=@var{file}
7710 @opindex specs
7711 Process @var{file} after the compiler reads in the standard @file{specs}
7712 file, in order to override the defaults that the @file{gcc} driver
7713 program uses when determining what switches to pass to @file{cc1},
7714 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7715 @option{-specs=@var{file}} can be specified on the command line, and they
7716 are processed in order, from left to right.
7718 @item --sysroot=@var{dir}
7719 @opindex sysroot
7720 Use @var{dir} as the logical root directory for headers and libraries.
7721 For example, if the compiler would normally search for headers in
7722 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7723 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7725 If you use both this option and the @option{-isysroot} option, then
7726 the @option{--sysroot} option will apply to libraries, but the
7727 @option{-isysroot} option will apply to header files.
7729 The GNU linker (beginning with version 2.16) has the necessary support
7730 for this option.  If your linker does not support this option, the
7731 header file aspect of @option{--sysroot} will still work, but the
7732 library aspect will not.
7734 @item -I-
7735 @opindex I-
7736 This option has been deprecated.  Please use @option{-iquote} instead for
7737 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7738 Any directories you specify with @option{-I} options before the @option{-I-}
7739 option are searched only for the case of @samp{#include "@var{file}"};
7740 they are not searched for @samp{#include <@var{file}>}.
7742 If additional directories are specified with @option{-I} options after
7743 the @option{-I-}, these directories are searched for all @samp{#include}
7744 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7745 this way.)
7747 In addition, the @option{-I-} option inhibits the use of the current
7748 directory (where the current input file came from) as the first search
7749 directory for @samp{#include "@var{file}"}.  There is no way to
7750 override this effect of @option{-I-}.  With @option{-I.} you can specify
7751 searching the directory which was current when the compiler was
7752 invoked.  That is not exactly the same as what the preprocessor does
7753 by default, but it is often satisfactory.
7755 @option{-I-} does not inhibit the use of the standard system directories
7756 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7757 independent.
7758 @end table
7760 @c man end
7762 @node Spec Files
7763 @section Specifying subprocesses and the switches to pass to them
7764 @cindex Spec Files
7766 @command{gcc} is a driver program.  It performs its job by invoking a
7767 sequence of other programs to do the work of compiling, assembling and
7768 linking.  GCC interprets its command-line parameters and uses these to
7769 deduce which programs it should invoke, and which command-line options
7770 it ought to place on their command lines.  This behavior is controlled
7771 by @dfn{spec strings}.  In most cases there is one spec string for each
7772 program that GCC can invoke, but a few programs have multiple spec
7773 strings to control their behavior.  The spec strings built into GCC can
7774 be overridden by using the @option{-specs=} command-line switch to specify
7775 a spec file.
7777 @dfn{Spec files} are plaintext files that are used to construct spec
7778 strings.  They consist of a sequence of directives separated by blank
7779 lines.  The type of directive is determined by the first non-whitespace
7780 character on the line and it can be one of the following:
7782 @table @code
7783 @item %@var{command}
7784 Issues a @var{command} to the spec file processor.  The commands that can
7785 appear here are:
7787 @table @code
7788 @item %include <@var{file}>
7789 @cindex %include
7790 Search for @var{file} and insert its text at the current point in the
7791 specs file.
7793 @item %include_noerr <@var{file}>
7794 @cindex %include_noerr
7795 Just like @samp{%include}, but do not generate an error message if the include
7796 file cannot be found.
7798 @item %rename @var{old_name} @var{new_name}
7799 @cindex %rename
7800 Rename the spec string @var{old_name} to @var{new_name}.
7802 @end table
7804 @item *[@var{spec_name}]:
7805 This tells the compiler to create, override or delete the named spec
7806 string.  All lines after this directive up to the next directive or
7807 blank line are considered to be the text for the spec string.  If this
7808 results in an empty string then the spec will be deleted.  (Or, if the
7809 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7810 does not currently exist a new spec will be created.  If the spec does
7811 exist then its contents will be overridden by the text of this
7812 directive, unless the first character of that text is the @samp{+}
7813 character, in which case the text will be appended to the spec.
7815 @item [@var{suffix}]:
7816 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7817 and up to the next directive or blank line are considered to make up the
7818 spec string for the indicated suffix.  When the compiler encounters an
7819 input file with the named suffix, it will processes the spec string in
7820 order to work out how to compile that file.  For example:
7822 @smallexample
7823 .ZZ:
7824 z-compile -input %i
7825 @end smallexample
7827 This says that any input file whose name ends in @samp{.ZZ} should be
7828 passed to the program @samp{z-compile}, which should be invoked with the
7829 command-line switch @option{-input} and with the result of performing the
7830 @samp{%i} substitution.  (See below.)
7832 As an alternative to providing a spec string, the text that follows a
7833 suffix directive can be one of the following:
7835 @table @code
7836 @item @@@var{language}
7837 This says that the suffix is an alias for a known @var{language}.  This is
7838 similar to using the @option{-x} command-line switch to GCC to specify a
7839 language explicitly.  For example:
7841 @smallexample
7842 .ZZ:
7843 @@c++
7844 @end smallexample
7846 Says that .ZZ files are, in fact, C++ source files.
7848 @item #@var{name}
7849 This causes an error messages saying:
7851 @smallexample
7852 @var{name} compiler not installed on this system.
7853 @end smallexample
7854 @end table
7856 GCC already has an extensive list of suffixes built into it.
7857 This directive will add an entry to the end of the list of suffixes, but
7858 since the list is searched from the end backwards, it is effectively
7859 possible to override earlier entries using this technique.
7861 @end table
7863 GCC has the following spec strings built into it.  Spec files can
7864 override these strings or create their own.  Note that individual
7865 targets can also add their own spec strings to this list.
7867 @smallexample
7868 asm          Options to pass to the assembler
7869 asm_final    Options to pass to the assembler post-processor
7870 cpp          Options to pass to the C preprocessor
7871 cc1          Options to pass to the C compiler
7872 cc1plus      Options to pass to the C++ compiler
7873 endfile      Object files to include at the end of the link
7874 link         Options to pass to the linker
7875 lib          Libraries to include on the command line to the linker
7876 libgcc       Decides which GCC support library to pass to the linker
7877 linker       Sets the name of the linker
7878 predefines   Defines to be passed to the C preprocessor
7879 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7880              by default
7881 startfile    Object files to include at the start of the link
7882 @end smallexample
7884 Here is a small example of a spec file:
7886 @smallexample
7887 %rename lib                 old_lib
7889 *lib:
7890 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7891 @end smallexample
7893 This example renames the spec called @samp{lib} to @samp{old_lib} and
7894 then overrides the previous definition of @samp{lib} with a new one.
7895 The new definition adds in some extra command-line options before
7896 including the text of the old definition.
7898 @dfn{Spec strings} are a list of command-line options to be passed to their
7899 corresponding program.  In addition, the spec strings can contain
7900 @samp{%}-prefixed sequences to substitute variable text or to
7901 conditionally insert text into the command line.  Using these constructs
7902 it is possible to generate quite complex command lines.
7904 Here is a table of all defined @samp{%}-sequences for spec
7905 strings.  Note that spaces are not generated automatically around the
7906 results of expanding these sequences.  Therefore you can concatenate them
7907 together or combine them with constant text in a single argument.
7909 @table @code
7910 @item %%
7911 Substitute one @samp{%} into the program name or argument.
7913 @item %i
7914 Substitute the name of the input file being processed.
7916 @item %b
7917 Substitute the basename of the input file being processed.
7918 This is the substring up to (and not including) the last period
7919 and not including the directory.
7921 @item %B
7922 This is the same as @samp{%b}, but include the file suffix (text after
7923 the last period).
7925 @item %d
7926 Marks the argument containing or following the @samp{%d} as a
7927 temporary file name, so that that file will be deleted if GCC exits
7928 successfully.  Unlike @samp{%g}, this contributes no text to the
7929 argument.
7931 @item %g@var{suffix}
7932 Substitute a file name that has suffix @var{suffix} and is chosen
7933 once per compilation, and mark the argument in the same way as
7934 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7935 name is now chosen in a way that is hard to predict even when previously
7936 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7937 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7938 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7939 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7940 was simply substituted with a file name chosen once per compilation,
7941 without regard to any appended suffix (which was therefore treated
7942 just like ordinary text), making such attacks more likely to succeed.
7944 @item %u@var{suffix}
7945 Like @samp{%g}, but generates a new temporary file name even if
7946 @samp{%u@var{suffix}} was already seen.
7948 @item %U@var{suffix}
7949 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7950 new one if there is no such last file name.  In the absence of any
7951 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7952 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7953 would involve the generation of two distinct file names, one
7954 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7955 simply substituted with a file name chosen for the previous @samp{%u},
7956 without regard to any appended suffix.
7958 @item %j@var{suffix}
7959 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7960 writable, and if save-temps is off; otherwise, substitute the name
7961 of a temporary file, just like @samp{%u}.  This temporary file is not
7962 meant for communication between processes, but rather as a junk
7963 disposal mechanism.
7965 @item %|@var{suffix}
7966 @itemx %m@var{suffix}
7967 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7968 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7969 all.  These are the two most common ways to instruct a program that it
7970 should read from standard input or write to standard output.  If you
7971 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7972 construct: see for example @file{f/lang-specs.h}.
7974 @item %.@var{SUFFIX}
7975 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7976 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7977 terminated by the next space or %.
7979 @item %w
7980 Marks the argument containing or following the @samp{%w} as the
7981 designated output file of this compilation.  This puts the argument
7982 into the sequence of arguments that @samp{%o} will substitute later.
7984 @item %o
7985 Substitutes the names of all the output files, with spaces
7986 automatically placed around them.  You should write spaces
7987 around the @samp{%o} as well or the results are undefined.
7988 @samp{%o} is for use in the specs for running the linker.
7989 Input files whose names have no recognized suffix are not compiled
7990 at all, but they are included among the output files, so they will
7991 be linked.
7993 @item %O
7994 Substitutes the suffix for object files.  Note that this is
7995 handled specially when it immediately follows @samp{%g, %u, or %U},
7996 because of the need for those to form complete file names.  The
7997 handling is such that @samp{%O} is treated exactly as if it had already
7998 been substituted, except that @samp{%g, %u, and %U} do not currently
7999 support additional @var{suffix} characters following @samp{%O} as they would
8000 following, for example, @samp{.o}.
8002 @item %p
8003 Substitutes the standard macro predefinitions for the
8004 current target machine.  Use this when running @code{cpp}.
8006 @item %P
8007 Like @samp{%p}, but puts @samp{__} before and after the name of each
8008 predefined macro, except for macros that start with @samp{__} or with
8009 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8012 @item %I
8013 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8014 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8015 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8016 and @option{-imultilib} as necessary.
8018 @item %s
8019 Current argument is the name of a library or startup file of some sort.
8020 Search for that file in a standard list of directories and substitute
8021 the full name found.
8023 @item %e@var{str}
8024 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8025 Use this when inconsistent options are detected.
8027 @item %(@var{name})
8028 Substitute the contents of spec string @var{name} at this point.
8030 @item %[@var{name}]
8031 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8033 @item %x@{@var{option}@}
8034 Accumulate an option for @samp{%X}.
8036 @item %X
8037 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8038 spec string.
8040 @item %Y
8041 Output the accumulated assembler options specified by @option{-Wa}.
8043 @item %Z
8044 Output the accumulated preprocessor options specified by @option{-Wp}.
8046 @item %a
8047 Process the @code{asm} spec.  This is used to compute the
8048 switches to be passed to the assembler.
8050 @item %A
8051 Process the @code{asm_final} spec.  This is a spec string for
8052 passing switches to an assembler post-processor, if such a program is
8053 needed.
8055 @item %l
8056 Process the @code{link} spec.  This is the spec for computing the
8057 command line passed to the linker.  Typically it will make use of the
8058 @samp{%L %G %S %D and %E} sequences.
8060 @item %D
8061 Dump out a @option{-L} option for each directory that GCC believes might
8062 contain startup files.  If the target supports multilibs then the
8063 current multilib directory will be prepended to each of these paths.
8065 @item %L
8066 Process the @code{lib} spec.  This is a spec string for deciding which
8067 libraries should be included on the command line to the linker.
8069 @item %G
8070 Process the @code{libgcc} spec.  This is a spec string for deciding
8071 which GCC support library should be included on the command line to the linker.
8073 @item %S
8074 Process the @code{startfile} spec.  This is a spec for deciding which
8075 object files should be the first ones passed to the linker.  Typically
8076 this might be a file named @file{crt0.o}.
8078 @item %E
8079 Process the @code{endfile} spec.  This is a spec string that specifies
8080 the last object files that will be passed to the linker.
8082 @item %C
8083 Process the @code{cpp} spec.  This is used to construct the arguments
8084 to be passed to the C preprocessor.
8086 @item %1
8087 Process the @code{cc1} spec.  This is used to construct the options to be
8088 passed to the actual C compiler (@samp{cc1}).
8090 @item %2
8091 Process the @code{cc1plus} spec.  This is used to construct the options to be
8092 passed to the actual C++ compiler (@samp{cc1plus}).
8094 @item %*
8095 Substitute the variable part of a matched option.  See below.
8096 Note that each comma in the substituted string is replaced by
8097 a single space.
8099 @item %<@code{S}
8100 Remove all occurrences of @code{-S} from the command line.  Note---this
8101 command is position dependent.  @samp{%} commands in the spec string
8102 before this one will see @code{-S}, @samp{%} commands in the spec string
8103 after this one will not.
8105 @item %:@var{function}(@var{args})
8106 Call the named function @var{function}, passing it @var{args}.
8107 @var{args} is first processed as a nested spec string, then split
8108 into an argument vector in the usual fashion.  The function returns
8109 a string which is processed as if it had appeared literally as part
8110 of the current spec.
8112 The following built-in spec functions are provided:
8114 @table @code
8115 @item @code{getenv}
8116 The @code{getenv} spec function takes two arguments: an environment
8117 variable name and a string.  If the environment variable is not
8118 defined, a fatal error is issued.  Otherwise, the return value is the
8119 value of the environment variable concatenated with the string.  For
8120 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8122 @smallexample
8123 %:getenv(TOPDIR /include)
8124 @end smallexample
8126 expands to @file{/path/to/top/include}.
8128 @item @code{if-exists}
8129 The @code{if-exists} spec function takes one argument, an absolute
8130 pathname to a file.  If the file exists, @code{if-exists} returns the
8131 pathname.  Here is a small example of its usage:
8133 @smallexample
8134 *startfile:
8135 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8136 @end smallexample
8138 @item @code{if-exists-else}
8139 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8140 spec function, except that it takes two arguments.  The first argument is
8141 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8142 returns the pathname.  If it does not exist, it returns the second argument.
8143 This way, @code{if-exists-else} can be used to select one file or another,
8144 based on the existence of the first.  Here is a small example of its usage:
8146 @smallexample
8147 *startfile:
8148 crt0%O%s %:if-exists(crti%O%s) \
8149 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8150 @end smallexample
8152 @item @code{replace-outfile}
8153 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8154 first argument in the outfiles array and replaces it with the second argument.  Here
8155 is a small example of its usage:
8157 @smallexample
8158 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8159 @end smallexample
8161 @item @code{print-asm-header}
8162 The @code{print-asm-header} function takes no arguments and simply
8163 prints a banner like:
8165 @smallexample
8166 Assembler options
8167 =================
8169 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8170 @end smallexample
8172 It is used to separate compiler options from assembler options
8173 in the @option{--target-help} output.
8174 @end table
8176 @item %@{@code{S}@}
8177 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8178 If that switch was not specified, this substitutes nothing.  Note that
8179 the leading dash is omitted when specifying this option, and it is
8180 automatically inserted if the substitution is performed.  Thus the spec
8181 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8182 and would output the command line option @option{-foo}.
8184 @item %W@{@code{S}@}
8185 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8186 deleted on failure.
8188 @item %@{@code{S}*@}
8189 Substitutes all the switches specified to GCC whose names start
8190 with @code{-S}, but which also take an argument.  This is used for
8191 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8192 GCC considers @option{-o foo} as being
8193 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8194 text, including the space.  Thus two arguments would be generated.
8196 @item %@{@code{S}*&@code{T}*@}
8197 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8198 (the order of @code{S} and @code{T} in the spec is not significant).
8199 There can be any number of ampersand-separated variables; for each the
8200 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8202 @item %@{@code{S}:@code{X}@}
8203 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8205 @item %@{!@code{S}:@code{X}@}
8206 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8208 @item %@{@code{S}*:@code{X}@}
8209 Substitutes @code{X} if one or more switches whose names start with
8210 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8211 once, no matter how many such switches appeared.  However, if @code{%*}
8212 appears somewhere in @code{X}, then @code{X} will be substituted once
8213 for each matching switch, with the @code{%*} replaced by the part of
8214 that switch that matched the @code{*}.
8216 @item %@{.@code{S}:@code{X}@}
8217 Substitutes @code{X}, if processing a file with suffix @code{S}.
8219 @item %@{!.@code{S}:@code{X}@}
8220 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8222 @item %@{,@code{S}:@code{X}@}
8223 Substitutes @code{X}, if processing a file for language @code{S}.
8225 @item %@{!,@code{S}:@code{X}@}
8226 Substitutes @code{X}, if not processing a file for language @code{S}.
8228 @item %@{@code{S}|@code{P}:@code{X}@}
8229 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8230 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8231 @code{*} sequences as well, although they have a stronger binding than
8232 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8233 alternatives must be starred, and only the first matching alternative
8234 is substituted.
8236 For example, a spec string like this:
8238 @smallexample
8239 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8240 @end smallexample
8242 will output the following command-line options from the following input
8243 command-line options:
8245 @smallexample
8246 fred.c        -foo -baz
8247 jim.d         -bar -boggle
8248 -d fred.c     -foo -baz -boggle
8249 -d jim.d      -bar -baz -boggle
8250 @end smallexample
8252 @item %@{S:X; T:Y; :D@}
8254 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8255 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8256 be as many clauses as you need.  This may be combined with @code{.},
8257 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8260 @end table
8262 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8263 construct may contain other nested @samp{%} constructs or spaces, or
8264 even newlines.  They are processed as usual, as described above.
8265 Trailing white space in @code{X} is ignored.  White space may also
8266 appear anywhere on the left side of the colon in these constructs,
8267 except between @code{.} or @code{*} and the corresponding word.
8269 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8270 handled specifically in these constructs.  If another value of
8271 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8272 @option{-W} switch is found later in the command line, the earlier
8273 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8274 just one letter, which passes all matching options.
8276 The character @samp{|} at the beginning of the predicate text is used to
8277 indicate that a command should be piped to the following command, but
8278 only if @option{-pipe} is specified.
8280 It is built into GCC which switches take arguments and which do not.
8281 (You might think it would be useful to generalize this to allow each
8282 compiler's spec to say which switches take arguments.  But this cannot
8283 be done in a consistent fashion.  GCC cannot even decide which input
8284 files have been specified without knowing which switches take arguments,
8285 and it must know which input files to compile in order to tell which
8286 compilers to run).
8288 GCC also knows implicitly that arguments starting in @option{-l} are to be
8289 treated as compiler output files, and passed to the linker in their
8290 proper position among the other output files.
8292 @c man begin OPTIONS
8294 @node Target Options
8295 @section Specifying Target Machine and Compiler Version
8296 @cindex target options
8297 @cindex cross compiling
8298 @cindex specifying machine version
8299 @cindex specifying compiler version and target machine
8300 @cindex compiler version, specifying
8301 @cindex target machine, specifying
8303 The usual way to run GCC is to run the executable called @file{gcc}, or
8304 @file{<machine>-gcc} when cross-compiling, or
8305 @file{<machine>-gcc-<version>} to run a version other than the one that
8306 was installed last.  Sometimes this is inconvenient, so GCC provides
8307 options that will switch to another cross-compiler or version.
8309 @table @gcctabopt
8310 @item -b @var{machine}
8311 @opindex b
8312 The argument @var{machine} specifies the target machine for compilation.
8314 The value to use for @var{machine} is the same as was specified as the
8315 machine type when configuring GCC as a cross-compiler.  For
8316 example, if a cross-compiler was configured with @samp{configure
8317 arm-elf}, meaning to compile for an arm processor with elf binaries,
8318 then you would specify @option{-b arm-elf} to run that cross compiler.
8319 Because there are other options beginning with @option{-b}, the
8320 configuration must contain a hyphen.
8322 @item -V @var{version}
8323 @opindex V
8324 The argument @var{version} specifies which version of GCC to run.
8325 This is useful when multiple versions are installed.  For example,
8326 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8327 @end table
8329 The @option{-V} and @option{-b} options work by running the
8330 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8331 use them if you can just run that directly.
8333 @node Submodel Options
8334 @section Hardware Models and Configurations
8335 @cindex submodel options
8336 @cindex specifying hardware config
8337 @cindex hardware models and configurations, specifying
8338 @cindex machine dependent options
8340 Earlier we discussed the standard option @option{-b} which chooses among
8341 different installed compilers for completely different target
8342 machines, such as VAX vs.@: 68000 vs.@: 80386.
8344 In addition, each of these target machine types can have its own
8345 special options, starting with @samp{-m}, to choose among various
8346 hardware models or configurations---for example, 68010 vs 68020,
8347 floating coprocessor or none.  A single installed version of the
8348 compiler can compile for any model or configuration, according to the
8349 options specified.
8351 Some configurations of the compiler also support additional special
8352 options, usually for compatibility with other compilers on the same
8353 platform.
8355 @c This list is ordered alphanumerically by subsection name.
8356 @c It should be the same order and spelling as these options are listed
8357 @c in Machine Dependent Options
8359 @menu
8360 * ARC Options::
8361 * ARM Options::
8362 * AVR Options::
8363 * Blackfin Options::
8364 * CRIS Options::
8365 * CRX Options::
8366 * Darwin Options::
8367 * DEC Alpha Options::
8368 * DEC Alpha/VMS Options::
8369 * FRV Options::
8370 * GNU/Linux Options::
8371 * H8/300 Options::
8372 * HPPA Options::
8373 * i386 and x86-64 Options::
8374 * IA-64 Options::
8375 * M32C Options::
8376 * M32R/D Options::
8377 * M680x0 Options::
8378 * M68hc1x Options::
8379 * MCore Options::
8380 * MIPS Options::
8381 * MMIX Options::
8382 * MN10300 Options::
8383 * MT Options::
8384 * PDP-11 Options::
8385 * PowerPC Options::
8386 * RS/6000 and PowerPC Options::
8387 * S/390 and zSeries Options::
8388 * Score Options::
8389 * SH Options::
8390 * SPARC Options::
8391 * SPU Options::
8392 * System V Options::
8393 * V850 Options::
8394 * VAX Options::
8395 * VxWorks Options::
8396 * x86-64 Options::
8397 * Xstormy16 Options::
8398 * Xtensa Options::
8399 * zSeries Options::
8400 @end menu
8402 @node ARC Options
8403 @subsection ARC Options
8404 @cindex ARC Options
8406 These options are defined for ARC implementations:
8408 @table @gcctabopt
8409 @item -EL
8410 @opindex EL
8411 Compile code for little endian mode.  This is the default.
8413 @item -EB
8414 @opindex EB
8415 Compile code for big endian mode.
8417 @item -mmangle-cpu
8418 @opindex mmangle-cpu
8419 Prepend the name of the cpu to all public symbol names.
8420 In multiple-processor systems, there are many ARC variants with different
8421 instruction and register set characteristics.  This flag prevents code
8422 compiled for one cpu to be linked with code compiled for another.
8423 No facility exists for handling variants that are ``almost identical''.
8424 This is an all or nothing option.
8426 @item -mcpu=@var{cpu}
8427 @opindex mcpu
8428 Compile code for ARC variant @var{cpu}.
8429 Which variants are supported depend on the configuration.
8430 All variants support @option{-mcpu=base}, this is the default.
8432 @item -mtext=@var{text-section}
8433 @itemx -mdata=@var{data-section}
8434 @itemx -mrodata=@var{readonly-data-section}
8435 @opindex mtext
8436 @opindex mdata
8437 @opindex mrodata
8438 Put functions, data, and readonly data in @var{text-section},
8439 @var{data-section}, and @var{readonly-data-section} respectively
8440 by default.  This can be overridden with the @code{section} attribute.
8441 @xref{Variable Attributes}.
8443 @end table
8445 @node ARM Options
8446 @subsection ARM Options
8447 @cindex ARM options
8449 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8450 architectures:
8452 @table @gcctabopt
8453 @item -mabi=@var{name}
8454 @opindex mabi
8455 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8456 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8458 @item -mapcs-frame
8459 @opindex mapcs-frame
8460 Generate a stack frame that is compliant with the ARM Procedure Call
8461 Standard for all functions, even if this is not strictly necessary for
8462 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8463 with this option will cause the stack frames not to be generated for
8464 leaf functions.  The default is @option{-mno-apcs-frame}.
8466 @item -mapcs
8467 @opindex mapcs
8468 This is a synonym for @option{-mapcs-frame}.
8470 @ignore
8471 @c not currently implemented
8472 @item -mapcs-stack-check
8473 @opindex mapcs-stack-check
8474 Generate code to check the amount of stack space available upon entry to
8475 every function (that actually uses some stack space).  If there is
8476 insufficient space available then either the function
8477 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8478 called, depending upon the amount of stack space required.  The run time
8479 system is required to provide these functions.  The default is
8480 @option{-mno-apcs-stack-check}, since this produces smaller code.
8482 @c not currently implemented
8483 @item -mapcs-float
8484 @opindex mapcs-float
8485 Pass floating point arguments using the float point registers.  This is
8486 one of the variants of the APCS@.  This option is recommended if the
8487 target hardware has a floating point unit or if a lot of floating point
8488 arithmetic is going to be performed by the code.  The default is
8489 @option{-mno-apcs-float}, since integer only code is slightly increased in
8490 size if @option{-mapcs-float} is used.
8492 @c not currently implemented
8493 @item -mapcs-reentrant
8494 @opindex mapcs-reentrant
8495 Generate reentrant, position independent code.  The default is
8496 @option{-mno-apcs-reentrant}.
8497 @end ignore
8499 @item -mthumb-interwork
8500 @opindex mthumb-interwork
8501 Generate code which supports calling between the ARM and Thumb
8502 instruction sets.  Without this option the two instruction sets cannot
8503 be reliably used inside one program.  The default is
8504 @option{-mno-thumb-interwork}, since slightly larger code is generated
8505 when @option{-mthumb-interwork} is specified.
8507 @item -mno-sched-prolog
8508 @opindex mno-sched-prolog
8509 Prevent the reordering of instructions in the function prolog, or the
8510 merging of those instruction with the instructions in the function's
8511 body.  This means that all functions will start with a recognizable set
8512 of instructions (or in fact one of a choice from a small set of
8513 different function prologues), and this information can be used to
8514 locate the start if functions inside an executable piece of code.  The
8515 default is @option{-msched-prolog}.
8517 @item -mhard-float
8518 @opindex mhard-float
8519 Generate output containing floating point instructions.  This is the
8520 default.
8522 @item -msoft-float
8523 @opindex msoft-float
8524 Generate output containing library calls for floating point.
8525 @strong{Warning:} the requisite libraries are not available for all ARM
8526 targets.  Normally the facilities of the machine's usual C compiler are
8527 used, but this cannot be done directly in cross-compilation.  You must make
8528 your own arrangements to provide suitable library functions for
8529 cross-compilation.
8531 @option{-msoft-float} changes the calling convention in the output file;
8532 therefore, it is only useful if you compile @emph{all} of a program with
8533 this option.  In particular, you need to compile @file{libgcc.a}, the
8534 library that comes with GCC, with @option{-msoft-float} in order for
8535 this to work.
8537 @item -mfloat-abi=@var{name}
8538 @opindex mfloat-abi
8539 Specifies which ABI to use for floating point values.  Permissible values
8540 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8542 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8543 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8544 of floating point instructions, but still uses the soft-float calling
8545 conventions.
8547 @item -mlittle-endian
8548 @opindex mlittle-endian
8549 Generate code for a processor running in little-endian mode.  This is
8550 the default for all standard configurations.
8552 @item -mbig-endian
8553 @opindex mbig-endian
8554 Generate code for a processor running in big-endian mode; the default is
8555 to compile code for a little-endian processor.
8557 @item -mwords-little-endian
8558 @opindex mwords-little-endian
8559 This option only applies when generating code for big-endian processors.
8560 Generate code for a little-endian word order but a big-endian byte
8561 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8562 option should only be used if you require compatibility with code for
8563 big-endian ARM processors generated by versions of the compiler prior to
8564 2.8.
8566 @item -mcpu=@var{name}
8567 @opindex mcpu
8568 This specifies the name of the target ARM processor.  GCC uses this name
8569 to determine what kind of instructions it can emit when generating
8570 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8571 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8572 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8573 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8574 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8575 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8576 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8577 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8578 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8579 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8580 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8581 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8582 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8583 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8584 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8585 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8587 @item -mtune=@var{name}
8588 @opindex mtune
8589 This option is very similar to the @option{-mcpu=} option, except that
8590 instead of specifying the actual target processor type, and hence
8591 restricting which instructions can be used, it specifies that GCC should
8592 tune the performance of the code as if the target were of the type
8593 specified in this option, but still choosing the instructions that it
8594 will generate based on the cpu specified by a @option{-mcpu=} option.
8595 For some ARM implementations better performance can be obtained by using
8596 this option.
8598 @item -march=@var{name}
8599 @opindex march
8600 This specifies the name of the target ARM architecture.  GCC uses this
8601 name to determine what kind of instructions it can emit when generating
8602 assembly code.  This option can be used in conjunction with or instead
8603 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8604 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8605 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8606 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8607 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8608 @samp{iwmmxt}, @samp{ep9312}.
8610 @item -mfpu=@var{name}
8611 @itemx -mfpe=@var{number}
8612 @itemx -mfp=@var{number}
8613 @opindex mfpu
8614 @opindex mfpe
8615 @opindex mfp
8616 This specifies what floating point hardware (or hardware emulation) is
8617 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8618 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8619 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8620 with older versions of GCC@.
8622 If @option{-msoft-float} is specified this specifies the format of
8623 floating point values.
8625 @item -mstructure-size-boundary=@var{n}
8626 @opindex mstructure-size-boundary
8627 The size of all structures and unions will be rounded up to a multiple
8628 of the number of bits set by this option.  Permissible values are 8, 32
8629 and 64.  The default value varies for different toolchains.  For the COFF
8630 targeted toolchain the default value is 8.  A value of 64 is only allowed
8631 if the underlying ABI supports it.
8633 Specifying the larger number can produce faster, more efficient code, but
8634 can also increase the size of the program.  Different values are potentially
8635 incompatible.  Code compiled with one value cannot necessarily expect to
8636 work with code or libraries compiled with another value, if they exchange
8637 information using structures or unions.
8639 @item -mabort-on-noreturn
8640 @opindex mabort-on-noreturn
8641 Generate a call to the function @code{abort} at the end of a
8642 @code{noreturn} function.  It will be executed if the function tries to
8643 return.
8645 @item -mlong-calls
8646 @itemx -mno-long-calls
8647 @opindex mlong-calls
8648 @opindex mno-long-calls
8649 Tells the compiler to perform function calls by first loading the
8650 address of the function into a register and then performing a subroutine
8651 call on this register.  This switch is needed if the target function
8652 will lie outside of the 64 megabyte addressing range of the offset based
8653 version of subroutine call instruction.
8655 Even if this switch is enabled, not all function calls will be turned
8656 into long calls.  The heuristic is that static functions, functions
8657 which have the @samp{short-call} attribute, functions that are inside
8658 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8659 definitions have already been compiled within the current compilation
8660 unit, will not be turned into long calls.  The exception to this rule is
8661 that weak function definitions, functions with the @samp{long-call}
8662 attribute or the @samp{section} attribute, and functions that are within
8663 the scope of a @samp{#pragma long_calls} directive, will always be
8664 turned into long calls.
8666 This feature is not enabled by default.  Specifying
8667 @option{-mno-long-calls} will restore the default behavior, as will
8668 placing the function calls within the scope of a @samp{#pragma
8669 long_calls_off} directive.  Note these switches have no effect on how
8670 the compiler generates code to handle function calls via function
8671 pointers.
8673 @item -mnop-fun-dllimport
8674 @opindex mnop-fun-dllimport
8675 Disable support for the @code{dllimport} attribute.
8677 @item -msingle-pic-base
8678 @opindex msingle-pic-base
8679 Treat the register used for PIC addressing as read-only, rather than
8680 loading it in the prologue for each function.  The run-time system is
8681 responsible for initializing this register with an appropriate value
8682 before execution begins.
8684 @item -mpic-register=@var{reg}
8685 @opindex mpic-register
8686 Specify the register to be used for PIC addressing.  The default is R10
8687 unless stack-checking is enabled, when R9 is used.
8689 @item -mcirrus-fix-invalid-insns
8690 @opindex mcirrus-fix-invalid-insns
8691 @opindex mno-cirrus-fix-invalid-insns
8692 Insert NOPs into the instruction stream to in order to work around
8693 problems with invalid Maverick instruction combinations.  This option
8694 is only valid if the @option{-mcpu=ep9312} option has been used to
8695 enable generation of instructions for the Cirrus Maverick floating
8696 point co-processor.  This option is not enabled by default, since the
8697 problem is only present in older Maverick implementations.  The default
8698 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8699 switch.
8701 @item -mpoke-function-name
8702 @opindex mpoke-function-name
8703 Write the name of each function into the text section, directly
8704 preceding the function prologue.  The generated code is similar to this:
8706 @smallexample
8707      t0
8708          .ascii "arm_poke_function_name", 0
8709          .align
8710      t1
8711          .word 0xff000000 + (t1 - t0)
8712      arm_poke_function_name
8713          mov     ip, sp
8714          stmfd   sp!, @{fp, ip, lr, pc@}
8715          sub     fp, ip, #4
8716 @end smallexample
8718 When performing a stack backtrace, code can inspect the value of
8719 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8720 location @code{pc - 12} and the top 8 bits are set, then we know that
8721 there is a function name embedded immediately preceding this location
8722 and has length @code{((pc[-3]) & 0xff000000)}.
8724 @item -mthumb
8725 @opindex mthumb
8726 Generate code for the Thumb instruction set.  The default is to
8727 use the 32-bit ARM instruction set.
8728 This option automatically enables either 16-bit Thumb-1 or
8729 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8730 and @option{-march=@var{name}} options.
8732 @item -mtpcs-frame
8733 @opindex mtpcs-frame
8734 Generate a stack frame that is compliant with the Thumb Procedure Call
8735 Standard for all non-leaf functions.  (A leaf function is one that does
8736 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8738 @item -mtpcs-leaf-frame
8739 @opindex mtpcs-leaf-frame
8740 Generate a stack frame that is compliant with the Thumb Procedure Call
8741 Standard for all leaf functions.  (A leaf function is one that does
8742 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8744 @item -mcallee-super-interworking
8745 @opindex mcallee-super-interworking
8746 Gives all externally visible functions in the file being compiled an ARM
8747 instruction set header which switches to Thumb mode before executing the
8748 rest of the function.  This allows these functions to be called from
8749 non-interworking code.
8751 @item -mcaller-super-interworking
8752 @opindex mcaller-super-interworking
8753 Allows calls via function pointers (including virtual functions) to
8754 execute correctly regardless of whether the target code has been
8755 compiled for interworking or not.  There is a small overhead in the cost
8756 of executing a function pointer if this option is enabled.
8758 @item -mtp=@var{name}
8759 @opindex mtp
8760 Specify the access model for the thread local storage pointer.  The valid
8761 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8762 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8763 (supported in the arm6k architecture), and @option{auto}, which uses the
8764 best available method for the selected processor.  The default setting is
8765 @option{auto}.
8767 @end table
8769 @node AVR Options
8770 @subsection AVR Options
8771 @cindex AVR Options
8773 These options are defined for AVR implementations:
8775 @table @gcctabopt
8776 @item -mmcu=@var{mcu}
8777 @opindex mmcu
8778 Specify ATMEL AVR instruction set or MCU type.
8780 Instruction set avr1 is for the minimal AVR core, not supported by the C
8781 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8782 attiny11, attiny12, attiny15, attiny28).
8784 Instruction set avr2 (default) is for the classic AVR core with up to
8785 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8786 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8787 at90c8534, at90s8535).
8789 Instruction set avr3 is for the classic AVR core with up to 128K program
8790 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8792 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8793 memory space (MCU types: atmega8, atmega83, atmega85).
8795 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8796 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8797 atmega64, atmega128, at43usb355, at94k).
8799 @item -msize
8800 @opindex msize
8801 Output instruction sizes to the asm file.
8803 @item -minit-stack=@var{N}
8804 @opindex minit-stack
8805 Specify the initial stack address, which may be a symbol or numeric value,
8806 @samp{__stack} is the default.
8808 @item -mno-interrupts
8809 @opindex mno-interrupts
8810 Generated code is not compatible with hardware interrupts.
8811 Code size will be smaller.
8813 @item -mcall-prologues
8814 @opindex mcall-prologues
8815 Functions prologues/epilogues expanded as call to appropriate
8816 subroutines.  Code size will be smaller.
8818 @item -mno-tablejump
8819 @opindex mno-tablejump
8820 Do not generate tablejump insns which sometimes increase code size.
8822 @item -mtiny-stack
8823 @opindex mtiny-stack
8824 Change only the low 8 bits of the stack pointer.
8826 @item -mint8
8827 @opindex mint8
8828 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8829 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8830 and long long will be 4 bytes.  Please note that this option does not
8831 comply to the C standards, but it will provide you with smaller code
8832 size.
8833 @end table
8835 @node Blackfin Options
8836 @subsection Blackfin Options
8837 @cindex Blackfin Options
8839 @table @gcctabopt
8840 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8841 @opindex mcpu=
8842 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8843 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8844 @samp{bf525}, @samp{bf526}, @samp{bf527},
8845 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8846 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8847 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8848 @samp{bf561}.
8849 The optional @var{sirevision} specifies the silicon revision of the target
8850 Blackfin processor.  Any workarounds available for the targeted silicon revision
8851 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8852 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8853 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8854 hexadecimal digits representing the major and minor numbers in the silicon
8855 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8856 is not defined.  If @var{sirevision} is @samp{any}, the
8857 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8858 If this optional @var{sirevision} is not used, GCC assumes the latest known
8859 silicon revision of the targeted Blackfin processor.
8861 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8862 Only the processor macro is defined.
8863 Without this option, @samp{bf532} is used as the processor by default.
8864 The corresponding predefined processor macros for @var{cpu} is to
8865 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8866 provided by libgloss to be linked in if @option{-msim} is not given.
8868 @item -msim
8869 @opindex msim
8870 Specifies that the program will be run on the simulator.  This causes
8871 the simulator BSP provided by libgloss to be linked in.  This option
8872 has effect only for @samp{bfin-elf} toolchain.
8873 Certain other options, such as @option{-mid-shared-library} and
8874 @option{-mfdpic}, imply @option{-msim}.
8876 @item -momit-leaf-frame-pointer
8877 @opindex momit-leaf-frame-pointer
8878 Don't keep the frame pointer in a register for leaf functions.  This
8879 avoids the instructions to save, set up and restore frame pointers and
8880 makes an extra register available in leaf functions.  The option
8881 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8882 which might make debugging harder.
8884 @item -mspecld-anomaly
8885 @opindex mspecld-anomaly
8886 When enabled, the compiler will ensure that the generated code does not
8887 contain speculative loads after jump instructions. If this option is used,
8888 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8890 @item -mno-specld-anomaly
8891 @opindex mno-specld-anomaly
8892 Don't generate extra code to prevent speculative loads from occurring.
8894 @item -mcsync-anomaly
8895 @opindex mcsync-anomaly
8896 When enabled, the compiler will ensure that the generated code does not
8897 contain CSYNC or SSYNC instructions too soon after conditional branches.
8898 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8900 @item -mno-csync-anomaly
8901 @opindex mno-csync-anomaly
8902 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8903 occurring too soon after a conditional branch.
8905 @item -mlow-64k
8906 @opindex mlow-64k
8907 When enabled, the compiler is free to take advantage of the knowledge that
8908 the entire program fits into the low 64k of memory.
8910 @item -mno-low-64k
8911 @opindex mno-low-64k
8912 Assume that the program is arbitrarily large.  This is the default.
8914 @item -mstack-check-l1
8915 @opindex mstack-check-l1
8916 Do stack checking using information placed into L1 scratchpad memory by the
8917 uClinux kernel.
8919 @item -mid-shared-library
8920 @opindex mid-shared-library
8921 Generate code that supports shared libraries via the library ID method.
8922 This allows for execute in place and shared libraries in an environment
8923 without virtual memory management.  This option implies @option{-fPIC}.
8924 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8926 @item -mno-id-shared-library
8927 @opindex mno-id-shared-library
8928 Generate code that doesn't assume ID based shared libraries are being used.
8929 This is the default.
8931 @item -mleaf-id-shared-library
8932 @opindex mleaf-id-shared-library
8933 Generate code that supports shared libraries via the library ID method,
8934 but assumes that this library or executable won't link against any other
8935 ID shared libraries.  That allows the compiler to use faster code for jumps
8936 and calls.
8938 @item -mno-leaf-id-shared-library
8939 @opindex mno-leaf-id-shared-library
8940 Do not assume that the code being compiled won't link against any ID shared
8941 libraries.  Slower code will be generated for jump and call insns.
8943 @item -mshared-library-id=n
8944 @opindex mshared-library-id
8945 Specified the identification number of the ID based shared library being
8946 compiled.  Specifying a value of 0 will generate more compact code, specifying
8947 other values will force the allocation of that number to the current
8948 library but is no more space or time efficient than omitting this option.
8950 @item -msep-data
8951 @opindex msep-data
8952 Generate code that allows the data segment to be located in a different
8953 area of memory from the text segment.  This allows for execute in place in
8954 an environment without virtual memory management by eliminating relocations
8955 against the text section.
8957 @item -mno-sep-data
8958 @opindex mno-sep-data
8959 Generate code that assumes that the data segment follows the text segment.
8960 This is the default.
8962 @item -mlong-calls
8963 @itemx -mno-long-calls
8964 @opindex mlong-calls
8965 @opindex mno-long-calls
8966 Tells the compiler to perform function calls by first loading the
8967 address of the function into a register and then performing a subroutine
8968 call on this register.  This switch is needed if the target function
8969 will lie outside of the 24 bit addressing range of the offset based
8970 version of subroutine call instruction.
8972 This feature is not enabled by default.  Specifying
8973 @option{-mno-long-calls} will restore the default behavior.  Note these
8974 switches have no effect on how the compiler generates code to handle
8975 function calls via function pointers.
8977 @item -mfast-fp
8978 @opindex mfast-fp
8979 Link with the fast floating-point library. This library relaxes some of
8980 the IEEE floating-point standard's rules for checking inputs against
8981 Not-a-Number (NAN), in the interest of performance.
8983 @item -minline-plt
8984 @opindex minline-plt
8985 Enable inlining of PLT entries in function calls to functions that are
8986 not known to bind locally.  It has no effect without @option{-mfdpic}.
8988 @item -mmulticore
8989 @opindex mmulticore
8990 Build standalone application for multicore Blackfin processor. Proper
8991 start files and link scripts will be used to support multicore.
8992 This option defines @code{__BFIN_MULTICORE}. It can only be used with
8993 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
8994 @option{-mcorea} or @option{-mcoreb}. If it's used without
8995 @option{-mcorea} or @option{-mcoreb}, single application/dual core
8996 programming model is used. In this model, the main function of Core B
8997 should be named as coreb_main. If it's used with @option{-mcorea} or
8998 @option{-mcoreb}, one application per core programming model is used.
8999 If this option is not used, single core application programming
9000 model is used.
9002 @item -mcorea
9003 @opindex mcorea
9004 Build standalone application for Core A of BF561 when using
9005 one application per core programming model. Proper start files
9006 and link scripts will be used to support Core A. This option
9007 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9009 @item -mcoreb
9010 @opindex mcoreb
9011 Build standalone application for Core B of BF561 when using
9012 one application per core programming model. Proper start files
9013 and link scripts will be used to support Core B. This option
9014 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9015 should be used instead of main. It must be used with
9016 @option{-mmulticore}. 
9018 @item -msdram
9019 @opindex msdram
9020 Build standalone application for SDRAM. Proper start files and
9021 link scripts will be used to put the application into SDRAM.
9022 Loader should initialize SDRAM before loading the application
9023 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9024 @end table
9025   
9026 @node CRIS Options
9027 @subsection CRIS Options
9028 @cindex CRIS Options
9030 These options are defined specifically for the CRIS ports.
9032 @table @gcctabopt
9033 @item -march=@var{architecture-type}
9034 @itemx -mcpu=@var{architecture-type}
9035 @opindex march
9036 @opindex mcpu
9037 Generate code for the specified architecture.  The choices for
9038 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9039 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9040 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9041 @samp{v10}.
9043 @item -mtune=@var{architecture-type}
9044 @opindex mtune
9045 Tune to @var{architecture-type} everything applicable about the generated
9046 code, except for the ABI and the set of available instructions.  The
9047 choices for @var{architecture-type} are the same as for
9048 @option{-march=@var{architecture-type}}.
9050 @item -mmax-stack-frame=@var{n}
9051 @opindex mmax-stack-frame
9052 Warn when the stack frame of a function exceeds @var{n} bytes.
9054 @item -melinux-stacksize=@var{n}
9055 @opindex melinux-stacksize
9056 Only available with the @samp{cris-axis-aout} target.  Arranges for
9057 indications in the program to the kernel loader that the stack of the
9058 program should be set to @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 -maout
9140 @opindex maout
9141 Legacy no-op option only recognized with the cris-axis-aout target.
9143 @item -melf
9144 @opindex melf
9145 Legacy no-op option only recognized with the cris-axis-elf and
9146 cris-axis-linux-gnu targets.
9148 @item -melinux
9149 @opindex melinux
9150 Only recognized with the cris-axis-aout target, where it selects a
9151 GNU/linux-like multilib, include files and instruction set for
9152 @option{-march=v8}.
9154 @item -mlinux
9155 @opindex mlinux
9156 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9158 @item -sim
9159 @opindex sim
9160 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9161 to link with input-output functions from a simulator library.  Code,
9162 initialized data and zero-initialized data are allocated consecutively.
9164 @item -sim2
9165 @opindex sim2
9166 Like @option{-sim}, but pass linker options to locate initialized data at
9167 0x40000000 and zero-initialized data at 0x80000000.
9168 @end table
9170 @node CRX Options
9171 @subsection CRX Options
9172 @cindex CRX Options
9174 These options are defined specifically for the CRX ports.
9176 @table @gcctabopt
9178 @item -mmac
9179 @opindex mmac
9180 Enable the use of multiply-accumulate instructions. Disabled by default.
9182 @item -mpush-args
9183 @opindex mpush-args
9184 Push instructions will be used to pass outgoing arguments when functions
9185 are called. Enabled by default.
9186 @end table
9188 @node Darwin Options
9189 @subsection Darwin Options
9190 @cindex Darwin options
9192 These options are defined for all architectures running the Darwin operating
9193 system.
9195 FSF GCC on Darwin does not create ``fat'' object files; it will create
9196 an object file for the single architecture that it was built to
9197 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9198 @option{-arch} options are used; it does so by running the compiler or
9199 linker multiple times and joining the results together with
9200 @file{lipo}.
9202 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9203 @samp{i686}) is determined by the flags that specify the ISA
9204 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9205 @option{-force_cpusubtype_ALL} option can be used to override this.
9207 The Darwin tools vary in their behavior when presented with an ISA
9208 mismatch.  The assembler, @file{as}, will only permit instructions to
9209 be used that are valid for the subtype of the file it is generating,
9210 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9211 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9212 and print an error if asked to create a shared library with a less
9213 restrictive subtype than its input files (for instance, trying to put
9214 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9215 for executables, @file{ld}, will quietly give the executable the most
9216 restrictive subtype of any of its input files.
9218 @table @gcctabopt
9219 @item -F@var{dir}
9220 @opindex F
9221 Add the framework directory @var{dir} to the head of the list of
9222 directories to be searched for header files.  These directories are
9223 interleaved with those specified by @option{-I} options and are
9224 scanned in a left-to-right order.
9226 A framework directory is a directory with frameworks in it.  A
9227 framework is a directory with a @samp{"Headers"} and/or
9228 @samp{"PrivateHeaders"} directory contained directly in it that ends
9229 in @samp{".framework"}.  The name of a framework is the name of this
9230 directory excluding the @samp{".framework"}.  Headers associated with
9231 the framework are found in one of those two directories, with
9232 @samp{"Headers"} being searched first.  A subframework is a framework
9233 directory that is in a framework's @samp{"Frameworks"} directory.
9234 Includes of subframework headers can only appear in a header of a
9235 framework that contains the subframework, or in a sibling subframework
9236 header.  Two subframeworks are siblings if they occur in the same
9237 framework.  A subframework should not have the same name as a
9238 framework, a warning will be issued if this is violated.  Currently a
9239 subframework cannot have subframeworks, in the future, the mechanism
9240 may be extended to support this.  The standard frameworks can be found
9241 in @samp{"/System/Library/Frameworks"} and
9242 @samp{"/Library/Frameworks"}.  An example include looks like
9243 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9244 the name of the framework and header.h is found in the
9245 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9247 @item -iframework@var{dir}
9248 @opindex iframework
9249 Like @option{-F} except the directory is a treated as a system
9250 directory.  The main difference between this @option{-iframework} and
9251 @option{-F} is that with @option{-iframework} the compiler does not
9252 warn about constructs contained within header files found via
9253 @var{dir}.  This option is valid only for the C family of languages.
9255 @item -gused
9256 @opindex gused
9257 Emit debugging information for symbols that are used.  For STABS
9258 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9259 This is by default ON@.
9261 @item -gfull
9262 @opindex gfull
9263 Emit debugging information for all symbols and types.
9265 @item -mmacosx-version-min=@var{version}
9266 The earliest version of MacOS X that this executable will run on
9267 is @var{version}.  Typical values of @var{version} include @code{10.1},
9268 @code{10.2}, and @code{10.3.9}.
9270 If the compiler was built to use the system's headers by default,
9271 then the default for this option is the system version on which the
9272 compiler is running, otherwise the default is to make choices which
9273 are compatible with as many systems and code bases as possible.
9275 @item -mkernel
9276 @opindex mkernel
9277 Enable kernel development mode.  The @option{-mkernel} option sets
9278 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9279 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9280 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9281 applicable.  This mode also sets @option{-mno-altivec},
9282 @option{-msoft-float}, @option{-fno-builtin} and
9283 @option{-mlong-branch} for PowerPC targets.
9285 @item -mone-byte-bool
9286 @opindex mone-byte-bool
9287 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9288 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9289 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9290 option has no effect on x86.
9292 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9293 to generate code that is not binary compatible with code generated
9294 without that switch.  Using this switch may require recompiling all
9295 other modules in a program, including system libraries.  Use this
9296 switch to conform to a non-default data model.
9298 @item -mfix-and-continue
9299 @itemx -ffix-and-continue
9300 @itemx -findirect-data
9301 @opindex mfix-and-continue
9302 @opindex ffix-and-continue
9303 @opindex findirect-data
9304 Generate code suitable for fast turn around development.  Needed to
9305 enable gdb to dynamically load @code{.o} files into already running
9306 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9307 are provided for backwards compatibility.
9309 @item -all_load
9310 @opindex all_load
9311 Loads all members of static archive libraries.
9312 See man ld(1) for more information.
9314 @item -arch_errors_fatal
9315 @opindex arch_errors_fatal
9316 Cause the errors having to do with files that have the wrong architecture
9317 to be fatal.
9319 @item -bind_at_load
9320 @opindex bind_at_load
9321 Causes the output file to be marked such that the dynamic linker will
9322 bind all undefined references when the file is loaded or launched.
9324 @item -bundle
9325 @opindex bundle
9326 Produce a Mach-o bundle format file.
9327 See man ld(1) for more information.
9329 @item -bundle_loader @var{executable}
9330 @opindex bundle_loader
9331 This option specifies the @var{executable} that will be loading the build
9332 output file being linked.  See man ld(1) for more information.
9334 @item -dynamiclib
9335 @opindex dynamiclib
9336 When passed this option, GCC will produce a dynamic library instead of
9337 an executable when linking, using the Darwin @file{libtool} command.
9339 @item -force_cpusubtype_ALL
9340 @opindex force_cpusubtype_ALL
9341 This causes GCC's output file to have the @var{ALL} subtype, instead of
9342 one controlled by the @option{-mcpu} or @option{-march} option.
9344 @item -allowable_client  @var{client_name}
9345 @itemx -client_name
9346 @itemx -compatibility_version
9347 @itemx -current_version
9348 @itemx -dead_strip
9349 @itemx -dependency-file
9350 @itemx -dylib_file
9351 @itemx -dylinker_install_name
9352 @itemx -dynamic
9353 @itemx -exported_symbols_list
9354 @itemx -filelist
9355 @itemx -flat_namespace
9356 @itemx -force_flat_namespace
9357 @itemx -headerpad_max_install_names
9358 @itemx -image_base
9359 @itemx -init
9360 @itemx -install_name
9361 @itemx -keep_private_externs
9362 @itemx -multi_module
9363 @itemx -multiply_defined
9364 @itemx -multiply_defined_unused
9365 @itemx -noall_load
9366 @itemx -no_dead_strip_inits_and_terms
9367 @itemx -nofixprebinding
9368 @itemx -nomultidefs
9369 @itemx -noprebind
9370 @itemx -noseglinkedit
9371 @itemx -pagezero_size
9372 @itemx -prebind
9373 @itemx -prebind_all_twolevel_modules
9374 @itemx -private_bundle
9375 @itemx -read_only_relocs
9376 @itemx -sectalign
9377 @itemx -sectobjectsymbols
9378 @itemx -whyload
9379 @itemx -seg1addr
9380 @itemx -sectcreate
9381 @itemx -sectobjectsymbols
9382 @itemx -sectorder
9383 @itemx -segaddr
9384 @itemx -segs_read_only_addr
9385 @itemx -segs_read_write_addr
9386 @itemx -seg_addr_table
9387 @itemx -seg_addr_table_filename
9388 @itemx -seglinkedit
9389 @itemx -segprot
9390 @itemx -segs_read_only_addr
9391 @itemx -segs_read_write_addr
9392 @itemx -single_module
9393 @itemx -static
9394 @itemx -sub_library
9395 @itemx -sub_umbrella
9396 @itemx -twolevel_namespace
9397 @itemx -umbrella
9398 @itemx -undefined
9399 @itemx -unexported_symbols_list
9400 @itemx -weak_reference_mismatches
9401 @itemx -whatsloaded
9402 @opindex allowable_client
9403 @opindex client_name
9404 @opindex compatibility_version
9405 @opindex current_version
9406 @opindex dead_strip
9407 @opindex dependency-file
9408 @opindex dylib_file
9409 @opindex dylinker_install_name
9410 @opindex dynamic
9411 @opindex exported_symbols_list
9412 @opindex filelist
9413 @opindex flat_namespace
9414 @opindex force_flat_namespace
9415 @opindex headerpad_max_install_names
9416 @opindex image_base
9417 @opindex init
9418 @opindex install_name
9419 @opindex keep_private_externs
9420 @opindex multi_module
9421 @opindex multiply_defined
9422 @opindex multiply_defined_unused
9423 @opindex noall_load
9424 @opindex no_dead_strip_inits_and_terms
9425 @opindex nofixprebinding
9426 @opindex nomultidefs
9427 @opindex noprebind
9428 @opindex noseglinkedit
9429 @opindex pagezero_size
9430 @opindex prebind
9431 @opindex prebind_all_twolevel_modules
9432 @opindex private_bundle
9433 @opindex read_only_relocs
9434 @opindex sectalign
9435 @opindex sectobjectsymbols
9436 @opindex whyload
9437 @opindex seg1addr
9438 @opindex sectcreate
9439 @opindex sectobjectsymbols
9440 @opindex sectorder
9441 @opindex segaddr
9442 @opindex segs_read_only_addr
9443 @opindex segs_read_write_addr
9444 @opindex seg_addr_table
9445 @opindex seg_addr_table_filename
9446 @opindex seglinkedit
9447 @opindex segprot
9448 @opindex segs_read_only_addr
9449 @opindex segs_read_write_addr
9450 @opindex single_module
9451 @opindex static
9452 @opindex sub_library
9453 @opindex sub_umbrella
9454 @opindex twolevel_namespace
9455 @opindex umbrella
9456 @opindex undefined
9457 @opindex unexported_symbols_list
9458 @opindex weak_reference_mismatches
9459 @opindex whatsloaded
9460 These options are passed to the Darwin linker.  The Darwin linker man page
9461 describes them in detail.
9462 @end table
9464 @node DEC Alpha Options
9465 @subsection DEC Alpha Options
9467 These @samp{-m} options are defined for the DEC Alpha implementations:
9469 @table @gcctabopt
9470 @item -mno-soft-float
9471 @itemx -msoft-float
9472 @opindex mno-soft-float
9473 @opindex msoft-float
9474 Use (do not use) the hardware floating-point instructions for
9475 floating-point operations.  When @option{-msoft-float} is specified,
9476 functions in @file{libgcc.a} will be used to perform floating-point
9477 operations.  Unless they are replaced by routines that emulate the
9478 floating-point operations, or compiled in such a way as to call such
9479 emulations routines, these routines will issue floating-point
9480 operations.   If you are compiling for an Alpha without floating-point
9481 operations, you must ensure that the library is built so as not to call
9482 them.
9484 Note that Alpha implementations without floating-point operations are
9485 required to have floating-point registers.
9487 @item -mfp-reg
9488 @itemx -mno-fp-regs
9489 @opindex mfp-reg
9490 @opindex mno-fp-regs
9491 Generate code that uses (does not use) the floating-point register set.
9492 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9493 register set is not used, floating point operands are passed in integer
9494 registers as if they were integers and floating-point results are passed
9495 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9496 so any function with a floating-point argument or return value called by code
9497 compiled with @option{-mno-fp-regs} must also be compiled with that
9498 option.
9500 A typical use of this option is building a kernel that does not use,
9501 and hence need not save and restore, any floating-point registers.
9503 @item -mieee
9504 @opindex mieee
9505 The Alpha architecture implements floating-point hardware optimized for
9506 maximum performance.  It is mostly compliant with the IEEE floating
9507 point standard.  However, for full compliance, software assistance is
9508 required.  This option generates code fully IEEE compliant code
9509 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9510 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9511 defined during compilation.  The resulting code is less efficient but is
9512 able to correctly support denormalized numbers and exceptional IEEE
9513 values such as not-a-number and plus/minus infinity.  Other Alpha
9514 compilers call this option @option{-ieee_with_no_inexact}.
9516 @item -mieee-with-inexact
9517 @opindex mieee-with-inexact
9518 This is like @option{-mieee} except the generated code also maintains
9519 the IEEE @var{inexact-flag}.  Turning on this option causes the
9520 generated code to implement fully-compliant IEEE math.  In addition to
9521 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9522 macro.  On some Alpha implementations the resulting code may execute
9523 significantly slower than the code generated by default.  Since there is
9524 very little code that depends on the @var{inexact-flag}, you should
9525 normally not specify this option.  Other Alpha compilers call this
9526 option @option{-ieee_with_inexact}.
9528 @item -mfp-trap-mode=@var{trap-mode}
9529 @opindex mfp-trap-mode
9530 This option controls what floating-point related traps are enabled.
9531 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9532 The trap mode can be set to one of four values:
9534 @table @samp
9535 @item n
9536 This is the default (normal) setting.  The only traps that are enabled
9537 are the ones that cannot be disabled in software (e.g., division by zero
9538 trap).
9540 @item u
9541 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9542 as well.
9544 @item su
9545 Like @samp{u}, but the instructions are marked to be safe for software
9546 completion (see Alpha architecture manual for details).
9548 @item sui
9549 Like @samp{su}, but inexact traps are enabled as well.
9550 @end table
9552 @item -mfp-rounding-mode=@var{rounding-mode}
9553 @opindex mfp-rounding-mode
9554 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9555 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9558 @table @samp
9559 @item n
9560 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9561 the nearest machine number or towards the even machine number in case
9562 of a tie.
9564 @item m
9565 Round towards minus infinity.
9567 @item c
9568 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9570 @item d
9571 Dynamic rounding mode.  A field in the floating point control register
9572 (@var{fpcr}, see Alpha architecture reference manual) controls the
9573 rounding mode in effect.  The C library initializes this register for
9574 rounding towards plus infinity.  Thus, unless your program modifies the
9575 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9576 @end table
9578 @item -mtrap-precision=@var{trap-precision}
9579 @opindex mtrap-precision
9580 In the Alpha architecture, floating point traps are imprecise.  This
9581 means without software assistance it is impossible to recover from a
9582 floating trap and program execution normally needs to be terminated.
9583 GCC can generate code that can assist operating system trap handlers
9584 in determining the exact location that caused a floating point trap.
9585 Depending on the requirements of an application, different levels of
9586 precisions can be selected:
9588 @table @samp
9589 @item p
9590 Program precision.  This option is the default and means a trap handler
9591 can only identify which program caused a floating point exception.
9593 @item f
9594 Function precision.  The trap handler can determine the function that
9595 caused a floating point exception.
9597 @item i
9598 Instruction precision.  The trap handler can determine the exact
9599 instruction that caused a floating point exception.
9600 @end table
9602 Other Alpha compilers provide the equivalent options called
9603 @option{-scope_safe} and @option{-resumption_safe}.
9605 @item -mieee-conformant
9606 @opindex mieee-conformant
9607 This option marks the generated code as IEEE conformant.  You must not
9608 use this option unless you also specify @option{-mtrap-precision=i} and either
9609 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9610 is to emit the line @samp{.eflag 48} in the function prologue of the
9611 generated assembly file.  Under DEC Unix, this has the effect that
9612 IEEE-conformant math library routines will be linked in.
9614 @item -mbuild-constants
9615 @opindex mbuild-constants
9616 Normally GCC examines a 32- or 64-bit integer constant to
9617 see if it can construct it from smaller constants in two or three
9618 instructions.  If it cannot, it will output the constant as a literal and
9619 generate code to load it from the data segment at runtime.
9621 Use this option to require GCC to construct @emph{all} integer constants
9622 using code, even if it takes more instructions (the maximum is six).
9624 You would typically use this option to build a shared library dynamic
9625 loader.  Itself a shared library, it must relocate itself in memory
9626 before it can find the variables and constants in its own data segment.
9628 @item -malpha-as
9629 @itemx -mgas
9630 @opindex malpha-as
9631 @opindex mgas
9632 Select whether to generate code to be assembled by the vendor-supplied
9633 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9635 @item -mbwx
9636 @itemx -mno-bwx
9637 @itemx -mcix
9638 @itemx -mno-cix
9639 @itemx -mfix
9640 @itemx -mno-fix
9641 @itemx -mmax
9642 @itemx -mno-max
9643 @opindex mbwx
9644 @opindex mno-bwx
9645 @opindex mcix
9646 @opindex mno-cix
9647 @opindex mfix
9648 @opindex mno-fix
9649 @opindex mmax
9650 @opindex mno-max
9651 Indicate whether GCC should generate code to use the optional BWX,
9652 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9653 sets supported by the CPU type specified via @option{-mcpu=} option or that
9654 of the CPU on which GCC was built if none was specified.
9656 @item -mfloat-vax
9657 @itemx -mfloat-ieee
9658 @opindex mfloat-vax
9659 @opindex mfloat-ieee
9660 Generate code that uses (does not use) VAX F and G floating point
9661 arithmetic instead of IEEE single and double precision.
9663 @item -mexplicit-relocs
9664 @itemx -mno-explicit-relocs
9665 @opindex mexplicit-relocs
9666 @opindex mno-explicit-relocs
9667 Older Alpha assemblers provided no way to generate symbol relocations
9668 except via assembler macros.  Use of these macros does not allow
9669 optimal instruction scheduling.  GNU binutils as of version 2.12
9670 supports a new syntax that allows the compiler to explicitly mark
9671 which relocations should apply to which instructions.  This option
9672 is mostly useful for debugging, as GCC detects the capabilities of
9673 the assembler when it is built and sets the default accordingly.
9675 @item -msmall-data
9676 @itemx -mlarge-data
9677 @opindex msmall-data
9678 @opindex mlarge-data
9679 When @option{-mexplicit-relocs} is in effect, static data is
9680 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9681 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9682 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9683 16-bit relocations off of the @code{$gp} register.  This limits the
9684 size of the small data area to 64KB, but allows the variables to be
9685 directly accessed via a single instruction.
9687 The default is @option{-mlarge-data}.  With this option the data area
9688 is limited to just below 2GB@.  Programs that require more than 2GB of
9689 data must use @code{malloc} or @code{mmap} to allocate the data in the
9690 heap instead of in the program's data segment.
9692 When generating code for shared libraries, @option{-fpic} implies
9693 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9695 @item -msmall-text
9696 @itemx -mlarge-text
9697 @opindex msmall-text
9698 @opindex mlarge-text
9699 When @option{-msmall-text} is used, the compiler assumes that the
9700 code of the entire program (or shared library) fits in 4MB, and is
9701 thus reachable with a branch instruction.  When @option{-msmall-data}
9702 is used, the compiler can assume that all local symbols share the
9703 same @code{$gp} value, and thus reduce the number of instructions
9704 required for a function call from 4 to 1.
9706 The default is @option{-mlarge-text}.
9708 @item -mcpu=@var{cpu_type}
9709 @opindex mcpu
9710 Set the instruction set and instruction scheduling parameters for
9711 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9712 style name or the corresponding chip number.  GCC supports scheduling
9713 parameters for the EV4, EV5 and EV6 family of processors and will
9714 choose the default values for the instruction set from the processor
9715 you specify.  If you do not specify a processor type, GCC will default
9716 to the processor on which the compiler was built.
9718 Supported values for @var{cpu_type} are
9720 @table @samp
9721 @item ev4
9722 @itemx ev45
9723 @itemx 21064
9724 Schedules as an EV4 and has no instruction set extensions.
9726 @item ev5
9727 @itemx 21164
9728 Schedules as an EV5 and has no instruction set extensions.
9730 @item ev56
9731 @itemx 21164a
9732 Schedules as an EV5 and supports the BWX extension.
9734 @item pca56
9735 @itemx 21164pc
9736 @itemx 21164PC
9737 Schedules as an EV5 and supports the BWX and MAX extensions.
9739 @item ev6
9740 @itemx 21264
9741 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9743 @item ev67
9744 @itemx 21264a
9745 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9746 @end table
9748 @item -mtune=@var{cpu_type}
9749 @opindex mtune
9750 Set only the instruction scheduling parameters for machine type
9751 @var{cpu_type}.  The instruction set is not changed.
9753 @item -mmemory-latency=@var{time}
9754 @opindex mmemory-latency
9755 Sets the latency the scheduler should assume for typical memory
9756 references as seen by the application.  This number is highly
9757 dependent on the memory access patterns used by the application
9758 and the size of the external cache on the machine.
9760 Valid options for @var{time} are
9762 @table @samp
9763 @item @var{number}
9764 A decimal number representing clock cycles.
9766 @item L1
9767 @itemx L2
9768 @itemx L3
9769 @itemx main
9770 The compiler contains estimates of the number of clock cycles for
9771 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9772 (also called Dcache, Scache, and Bcache), as well as to main memory.
9773 Note that L3 is only valid for EV5.
9775 @end table
9776 @end table
9778 @node DEC Alpha/VMS Options
9779 @subsection DEC Alpha/VMS Options
9781 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9783 @table @gcctabopt
9784 @item -mvms-return-codes
9785 @opindex mvms-return-codes
9786 Return VMS condition codes from main.  The default is to return POSIX
9787 style condition (e.g.@: error) codes.
9788 @end table
9790 @node FRV Options
9791 @subsection FRV Options
9792 @cindex FRV Options
9794 @table @gcctabopt
9795 @item -mgpr-32
9796 @opindex mgpr-32
9798 Only use the first 32 general purpose registers.
9800 @item -mgpr-64
9801 @opindex mgpr-64
9803 Use all 64 general purpose registers.
9805 @item -mfpr-32
9806 @opindex mfpr-32
9808 Use only the first 32 floating point registers.
9810 @item -mfpr-64
9811 @opindex mfpr-64
9813 Use all 64 floating point registers
9815 @item -mhard-float
9816 @opindex mhard-float
9818 Use hardware instructions for floating point operations.
9820 @item -msoft-float
9821 @opindex msoft-float
9823 Use library routines for floating point operations.
9825 @item -malloc-cc
9826 @opindex malloc-cc
9828 Dynamically allocate condition code registers.
9830 @item -mfixed-cc
9831 @opindex mfixed-cc
9833 Do not try to dynamically allocate condition code registers, only
9834 use @code{icc0} and @code{fcc0}.
9836 @item -mdword
9837 @opindex mdword
9839 Change ABI to use double word insns.
9841 @item -mno-dword
9842 @opindex mno-dword
9844 Do not use double word instructions.
9846 @item -mdouble
9847 @opindex mdouble
9849 Use floating point double instructions.
9851 @item -mno-double
9852 @opindex mno-double
9854 Do not use floating point double instructions.
9856 @item -mmedia
9857 @opindex mmedia
9859 Use media instructions.
9861 @item -mno-media
9862 @opindex mno-media
9864 Do not use media instructions.
9866 @item -mmuladd
9867 @opindex mmuladd
9869 Use multiply and add/subtract instructions.
9871 @item -mno-muladd
9872 @opindex mno-muladd
9874 Do not use multiply and add/subtract instructions.
9876 @item -mfdpic
9877 @opindex mfdpic
9879 Select the FDPIC ABI, that uses function descriptors to represent
9880 pointers to functions.  Without any PIC/PIE-related options, it
9881 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9882 assumes GOT entries and small data are within a 12-bit range from the
9883 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9884 are computed with 32 bits.
9885 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9887 @item -minline-plt
9888 @opindex minline-plt
9890 Enable inlining of PLT entries in function calls to functions that are
9891 not known to bind locally.  It has no effect without @option{-mfdpic}.
9892 It's enabled by default if optimizing for speed and compiling for
9893 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9894 optimization option such as @option{-O3} or above is present in the
9895 command line.
9897 @item -mTLS
9898 @opindex TLS
9900 Assume a large TLS segment when generating thread-local code.
9902 @item -mtls
9903 @opindex tls
9905 Do not assume a large TLS segment when generating thread-local code.
9907 @item -mgprel-ro
9908 @opindex mgprel-ro
9910 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9911 that is known to be in read-only sections.  It's enabled by default,
9912 except for @option{-fpic} or @option{-fpie}: even though it may help
9913 make the global offset table smaller, it trades 1 instruction for 4.
9914 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9915 one of which may be shared by multiple symbols, and it avoids the need
9916 for a GOT entry for the referenced symbol, so it's more likely to be a
9917 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9919 @item -multilib-library-pic
9920 @opindex multilib-library-pic
9922 Link with the (library, not FD) pic libraries.  It's implied by
9923 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9924 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9925 it explicitly.
9927 @item -mlinked-fp
9928 @opindex mlinked-fp
9930 Follow the EABI requirement of always creating a frame pointer whenever
9931 a stack frame is allocated.  This option is enabled by default and can
9932 be disabled with @option{-mno-linked-fp}.
9934 @item -mlong-calls
9935 @opindex mlong-calls
9937 Use indirect addressing to call functions outside the current
9938 compilation unit.  This allows the functions to be placed anywhere
9939 within the 32-bit address space.
9941 @item -malign-labels
9942 @opindex malign-labels
9944 Try to align labels to an 8-byte boundary by inserting nops into the
9945 previous packet.  This option only has an effect when VLIW packing
9946 is enabled.  It doesn't create new packets; it merely adds nops to
9947 existing ones.
9949 @item -mlibrary-pic
9950 @opindex mlibrary-pic
9952 Generate position-independent EABI code.
9954 @item -macc-4
9955 @opindex macc-4
9957 Use only the first four media accumulator registers.
9959 @item -macc-8
9960 @opindex macc-8
9962 Use all eight media accumulator registers.
9964 @item -mpack
9965 @opindex mpack
9967 Pack VLIW instructions.
9969 @item -mno-pack
9970 @opindex mno-pack
9972 Do not pack VLIW instructions.
9974 @item -mno-eflags
9975 @opindex mno-eflags
9977 Do not mark ABI switches in e_flags.
9979 @item -mcond-move
9980 @opindex mcond-move
9982 Enable the use of conditional-move instructions (default).
9984 This switch is mainly for debugging the compiler and will likely be removed
9985 in a future version.
9987 @item -mno-cond-move
9988 @opindex mno-cond-move
9990 Disable the use of conditional-move instructions.
9992 This switch is mainly for debugging the compiler and will likely be removed
9993 in a future version.
9995 @item -mscc
9996 @opindex mscc
9998 Enable the use of conditional set instructions (default).
10000 This switch is mainly for debugging the compiler and will likely be removed
10001 in a future version.
10003 @item -mno-scc
10004 @opindex mno-scc
10006 Disable the use of conditional set instructions.
10008 This switch is mainly for debugging the compiler and will likely be removed
10009 in a future version.
10011 @item -mcond-exec
10012 @opindex mcond-exec
10014 Enable the use of conditional execution (default).
10016 This switch is mainly for debugging the compiler and will likely be removed
10017 in a future version.
10019 @item -mno-cond-exec
10020 @opindex mno-cond-exec
10022 Disable the use of conditional execution.
10024 This switch is mainly for debugging the compiler and will likely be removed
10025 in a future version.
10027 @item -mvliw-branch
10028 @opindex mvliw-branch
10030 Run a pass to pack branches into VLIW instructions (default).
10032 This switch is mainly for debugging the compiler and will likely be removed
10033 in a future version.
10035 @item -mno-vliw-branch
10036 @opindex mno-vliw-branch
10038 Do not run a pass to pack branches into VLIW instructions.
10040 This switch is mainly for debugging the compiler and will likely be removed
10041 in a future version.
10043 @item -mmulti-cond-exec
10044 @opindex mmulti-cond-exec
10046 Enable optimization of @code{&&} and @code{||} in conditional execution
10047 (default).
10049 This switch is mainly for debugging the compiler and will likely be removed
10050 in a future version.
10052 @item -mno-multi-cond-exec
10053 @opindex mno-multi-cond-exec
10055 Disable optimization of @code{&&} and @code{||} in conditional execution.
10057 This switch is mainly for debugging the compiler and will likely be removed
10058 in a future version.
10060 @item -mnested-cond-exec
10061 @opindex mnested-cond-exec
10063 Enable nested conditional execution optimizations (default).
10065 This switch is mainly for debugging the compiler and will likely be removed
10066 in a future version.
10068 @item -mno-nested-cond-exec
10069 @opindex mno-nested-cond-exec
10071 Disable nested conditional execution optimizations.
10073 This switch is mainly for debugging the compiler and will likely be removed
10074 in a future version.
10076 @item -moptimize-membar
10077 @opindex moptimize-membar
10079 This switch removes redundant @code{membar} instructions from the
10080 compiler generated code.  It is enabled by default.
10082 @item -mno-optimize-membar
10083 @opindex mno-optimize-membar
10085 This switch disables the automatic removal of redundant @code{membar}
10086 instructions from the generated code.
10088 @item -mtomcat-stats
10089 @opindex mtomcat-stats
10091 Cause gas to print out tomcat statistics.
10093 @item -mcpu=@var{cpu}
10094 @opindex mcpu
10096 Select the processor type for which to generate code.  Possible values are
10097 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10098 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10100 @end table
10102 @node GNU/Linux Options
10103 @subsection GNU/Linux Options
10105 These @samp{-m} options are defined for GNU/Linux targets:
10107 @table @gcctabopt
10108 @item -mglibc
10109 @opindex mglibc
10110 Use the GNU C library instead of uClibc.  This is the default except
10111 on @samp{*-*-linux-*uclibc*} targets.
10113 @item -muclibc
10114 @opindex muclibc
10115 Use uClibc instead of the GNU C library.  This is the default on
10116 @samp{*-*-linux-*uclibc*} targets.
10117 @end table
10119 @node H8/300 Options
10120 @subsection H8/300 Options
10122 These @samp{-m} options are defined for the H8/300 implementations:
10124 @table @gcctabopt
10125 @item -mrelax
10126 @opindex mrelax
10127 Shorten some address references at link time, when possible; uses the
10128 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10129 ld, Using ld}, for a fuller description.
10131 @item -mh
10132 @opindex mh
10133 Generate code for the H8/300H@.
10135 @item -ms
10136 @opindex ms
10137 Generate code for the H8S@.
10139 @item -mn
10140 @opindex mn
10141 Generate code for the H8S and H8/300H in the normal mode.  This switch
10142 must be used either with @option{-mh} or @option{-ms}.
10144 @item -ms2600
10145 @opindex ms2600
10146 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10148 @item -mint32
10149 @opindex mint32
10150 Make @code{int} data 32 bits by default.
10152 @item -malign-300
10153 @opindex malign-300
10154 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10155 The default for the H8/300H and H8S is to align longs and floats on 4
10156 byte boundaries.
10157 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10158 This option has no effect on the H8/300.
10159 @end table
10161 @node HPPA Options
10162 @subsection HPPA Options
10163 @cindex HPPA Options
10165 These @samp{-m} options are defined for the HPPA family of computers:
10167 @table @gcctabopt
10168 @item -march=@var{architecture-type}
10169 @opindex march
10170 Generate code for the specified architecture.  The choices for
10171 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10172 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10173 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10174 architecture option for your machine.  Code compiled for lower numbered
10175 architectures will run on higher numbered architectures, but not the
10176 other way around.
10178 @item -mpa-risc-1-0
10179 @itemx -mpa-risc-1-1
10180 @itemx -mpa-risc-2-0
10181 @opindex mpa-risc-1-0
10182 @opindex mpa-risc-1-1
10183 @opindex mpa-risc-2-0
10184 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10186 @item -mbig-switch
10187 @opindex mbig-switch
10188 Generate code suitable for big switch tables.  Use this option only if
10189 the assembler/linker complain about out of range branches within a switch
10190 table.
10192 @item -mjump-in-delay
10193 @opindex mjump-in-delay
10194 Fill delay slots of function calls with unconditional jump instructions
10195 by modifying the return pointer for the function call to be the target
10196 of the conditional jump.
10198 @item -mdisable-fpregs
10199 @opindex mdisable-fpregs
10200 Prevent floating point registers from being used in any manner.  This is
10201 necessary for compiling kernels which perform lazy context switching of
10202 floating point registers.  If you use this option and attempt to perform
10203 floating point operations, the compiler will abort.
10205 @item -mdisable-indexing
10206 @opindex mdisable-indexing
10207 Prevent the compiler from using indexing address modes.  This avoids some
10208 rather obscure problems when compiling MIG generated code under MACH@.
10210 @item -mno-space-regs
10211 @opindex mno-space-regs
10212 Generate code that assumes the target has no space registers.  This allows
10213 GCC to generate faster indirect calls and use unscaled index address modes.
10215 Such code is suitable for level 0 PA systems and kernels.
10217 @item -mfast-indirect-calls
10218 @opindex mfast-indirect-calls
10219 Generate code that assumes calls never cross space boundaries.  This
10220 allows GCC to emit code which performs faster indirect calls.
10222 This option will not work in the presence of shared libraries or nested
10223 functions.
10225 @item -mfixed-range=@var{register-range}
10226 @opindex mfixed-range
10227 Generate code treating the given register range as fixed registers.
10228 A fixed register is one that the register allocator can not use.  This is
10229 useful when compiling kernel code.  A register range is specified as
10230 two registers separated by a dash.  Multiple register ranges can be
10231 specified separated by a comma.
10233 @item -mlong-load-store
10234 @opindex mlong-load-store
10235 Generate 3-instruction load and store sequences as sometimes required by
10236 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10237 the HP compilers.
10239 @item -mportable-runtime
10240 @opindex mportable-runtime
10241 Use the portable calling conventions proposed by HP for ELF systems.
10243 @item -mgas
10244 @opindex mgas
10245 Enable the use of assembler directives only GAS understands.
10247 @item -mschedule=@var{cpu-type}
10248 @opindex mschedule
10249 Schedule code according to the constraints for the machine type
10250 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10251 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10252 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10253 proper scheduling option for your machine.  The default scheduling is
10254 @samp{8000}.
10256 @item -mlinker-opt
10257 @opindex mlinker-opt
10258 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10259 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10260 linkers in which they give bogus error messages when linking some programs.
10262 @item -msoft-float
10263 @opindex msoft-float
10264 Generate output containing library calls for floating point.
10265 @strong{Warning:} the requisite libraries are not available for all HPPA
10266 targets.  Normally the facilities of the machine's usual C compiler are
10267 used, but this cannot be done directly in cross-compilation.  You must make
10268 your own arrangements to provide suitable library functions for
10269 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
10270 does provide software floating point support.
10272 @option{-msoft-float} changes the calling convention in the output file;
10273 therefore, it is only useful if you compile @emph{all} of a program with
10274 this option.  In particular, you need to compile @file{libgcc.a}, the
10275 library that comes with GCC, with @option{-msoft-float} in order for
10276 this to work.
10278 @item -msio
10279 @opindex msio
10280 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10281 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10282 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10283 options are available under HP-UX and HI-UX@.
10285 @item -mgnu-ld
10286 @opindex gnu-ld
10287 Use GNU ld specific options.  This passes @option{-shared} to ld when
10288 building a shared library.  It is the default when GCC is configured,
10289 explicitly or implicitly, with the GNU linker.  This option does not
10290 have any affect on which ld is called, it only changes what parameters
10291 are passed to that ld.  The ld that is called is determined by the
10292 @option{--with-ld} configure option, GCC's program search path, and
10293 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10294 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10295 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10297 @item -mhp-ld
10298 @opindex hp-ld
10299 Use HP ld specific options.  This passes @option{-b} to ld when building
10300 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10301 links.  It is the default when GCC is configured, explicitly or
10302 implicitly, with the HP linker.  This option does not have any affect on
10303 which ld is called, it only changes what parameters are passed to that
10304 ld.  The ld that is called is determined by the @option{--with-ld}
10305 configure option, GCC's program search path, and finally by the user's
10306 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10307 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10308 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10310 @item -mlong-calls
10311 @opindex mno-long-calls
10312 Generate code that uses long call sequences.  This ensures that a call
10313 is always able to reach linker generated stubs.  The default is to generate
10314 long calls only when the distance from the call site to the beginning
10315 of the function or translation unit, as the case may be, exceeds a
10316 predefined limit set by the branch type being used.  The limits for
10317 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10318 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10319 240,000 bytes.
10321 Distances are measured from the beginning of functions when using the
10322 @option{-ffunction-sections} option, or when using the @option{-mgas}
10323 and @option{-mno-portable-runtime} options together under HP-UX with
10324 the SOM linker.
10326 It is normally not desirable to use this option as it will degrade
10327 performance.  However, it may be useful in large applications,
10328 particularly when partial linking is used to build the application.
10330 The types of long calls used depends on the capabilities of the
10331 assembler and linker, and the type of code being generated.  The
10332 impact on systems that support long absolute calls, and long pic
10333 symbol-difference or pc-relative calls should be relatively small.
10334 However, an indirect call is used on 32-bit ELF systems in pic code
10335 and it is quite long.
10337 @item -munix=@var{unix-std}
10338 @opindex march
10339 Generate compiler predefines and select a startfile for the specified
10340 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10341 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10342 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10343 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10344 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10345 and later.
10347 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10348 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10349 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10350 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10351 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10352 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10354 It is @emph{important} to note that this option changes the interfaces
10355 for various library routines.  It also affects the operational behavior
10356 of the C library.  Thus, @emph{extreme} care is needed in using this
10357 option.
10359 Library code that is intended to operate with more than one UNIX
10360 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10361 as appropriate.  Most GNU software doesn't provide this capability.
10363 @item -nolibdld
10364 @opindex nolibdld
10365 Suppress the generation of link options to search libdld.sl when the
10366 @option{-static} option is specified on HP-UX 10 and later.
10368 @item -static
10369 @opindex static
10370 The HP-UX implementation of setlocale in libc has a dependency on
10371 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10372 when the @option{-static} option is specified, special link options
10373 are needed to resolve this dependency.
10375 On HP-UX 10 and later, the GCC driver adds the necessary options to
10376 link with libdld.sl when the @option{-static} option is specified.
10377 This causes the resulting binary to be dynamic.  On the 64-bit port,
10378 the linkers generate dynamic binaries by default in any case.  The
10379 @option{-nolibdld} option can be used to prevent the GCC driver from
10380 adding these link options.
10382 @item -threads
10383 @opindex threads
10384 Add support for multithreading with the @dfn{dce thread} library
10385 under HP-UX@.  This option sets flags for both the preprocessor and
10386 linker.
10387 @end table
10389 @node i386 and x86-64 Options
10390 @subsection Intel 386 and AMD x86-64 Options
10391 @cindex i386 Options
10392 @cindex x86-64 Options
10393 @cindex Intel 386 Options
10394 @cindex AMD x86-64 Options
10396 These @samp{-m} options are defined for the i386 and x86-64 family of
10397 computers:
10399 @table @gcctabopt
10400 @item -mtune=@var{cpu-type}
10401 @opindex mtune
10402 Tune to @var{cpu-type} everything applicable about the generated code, except
10403 for the ABI and the set of available instructions.  The choices for
10404 @var{cpu-type} are:
10405 @table @emph
10406 @item generic
10407 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10408 If you know the CPU on which your code will run, then you should use
10409 the corresponding @option{-mtune} option instead of
10410 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10411 of your application will have, then you should use this option.
10413 As new processors are deployed in the marketplace, the behavior of this
10414 option will change.  Therefore, if you upgrade to a newer version of
10415 GCC, the code generated option will change to reflect the processors
10416 that were most common when that version of GCC was released.
10418 There is no @option{-march=generic} option because @option{-march}
10419 indicates the instruction set the compiler can use, and there is no
10420 generic instruction set applicable to all processors.  In contrast,
10421 @option{-mtune} indicates the processor (or, in this case, collection of
10422 processors) for which the code is optimized.
10423 @item native
10424 This selects the CPU to tune for at compilation time by determining
10425 the processor type of the compiling machine.  Using @option{-mtune=native}
10426 will produce code optimized for the local machine under the constraints
10427 of the selected instruction set.  Using @option{-march=native} will
10428 enable all instruction subsets supported by the local machine (hence
10429 the result might not run on different machines).
10430 @item i386
10431 Original Intel's i386 CPU@.
10432 @item i486
10433 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10434 @item i586, pentium
10435 Intel Pentium CPU with no MMX support.
10436 @item pentium-mmx
10437 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10438 @item pentiumpro
10439 Intel PentiumPro CPU@.
10440 @item i686
10441 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10442 instruction set will be used, so the code will run on all i686 family chips.
10443 @item pentium2
10444 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10445 @item pentium3, pentium3m
10446 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10447 support.
10448 @item pentium-m
10449 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10450 support.  Used by Centrino notebooks.
10451 @item pentium4, pentium4m
10452 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10453 @item prescott
10454 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10455 set support.
10456 @item nocona
10457 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10458 SSE2 and SSE3 instruction set support.
10459 @item core2
10460 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10461 instruction set support.
10462 @item k6
10463 AMD K6 CPU with MMX instruction set support.
10464 @item k6-2, k6-3
10465 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10466 @item athlon, athlon-tbird
10467 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10468 support.
10469 @item athlon-4, athlon-xp, athlon-mp
10470 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10471 instruction set support.
10472 @item k8, opteron, athlon64, athlon-fx
10473 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10474 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10475 @item k8-sse3, opteron-sse3, athlon64-sse3
10476 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10477 @item amdfam10, barcelona
10478 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10479 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10480 instruction set extensions.)
10481 @item winchip-c6
10482 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10483 set support.
10484 @item winchip2
10485 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10486 instruction set support.
10487 @item c3
10488 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10489 implemented for this chip.)
10490 @item c3-2
10491 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10492 implemented for this chip.)
10493 @item geode
10494 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10495 @end table
10497 While picking a specific @var{cpu-type} will schedule things appropriately
10498 for that particular chip, the compiler will not generate any code that
10499 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10500 being used.
10502 @item -march=@var{cpu-type}
10503 @opindex march
10504 Generate instructions for the machine type @var{cpu-type}.  The choices
10505 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10506 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10508 @item -mcpu=@var{cpu-type}
10509 @opindex mcpu
10510 A deprecated synonym for @option{-mtune}.
10512 @item -mfpmath=@var{unit}
10513 @opindex march
10514 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10515 for @var{unit} are:
10517 @table @samp
10518 @item 387
10519 Use the standard 387 floating point coprocessor present majority of chips and
10520 emulated otherwise.  Code compiled with this option will run almost everywhere.
10521 The temporary results are computed in 80bit precision instead of precision
10522 specified by the type resulting in slightly different results compared to most
10523 of other chips.  See @option{-ffloat-store} for more detailed description.
10525 This is the default choice for i386 compiler.
10527 @item sse
10528 Use scalar floating point instructions present in the SSE instruction set.
10529 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10530 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10531 instruction set supports only single precision arithmetics, thus the double and
10532 extended precision arithmetics is still done using 387.  Later version, present
10533 only in Pentium4 and the future AMD x86-64 chips supports double precision
10534 arithmetics too.
10536 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10537 or @option{-msse2} switches to enable SSE extensions and make this option
10538 effective.  For the x86-64 compiler, these extensions are enabled by default.
10540 The resulting code should be considerably faster in the majority of cases and avoid
10541 the numerical instability problems of 387 code, but may break some existing
10542 code that expects temporaries to be 80bit.
10544 This is the default choice for the x86-64 compiler.
10546 @item sse,387
10547 Attempt to utilize both instruction sets at once.  This effectively double the
10548 amount of available registers and on chips with separate execution units for
10549 387 and SSE the execution resources too.  Use this option with care, as it is
10550 still experimental, because the GCC register allocator does not model separate
10551 functional units well resulting in instable performance.
10552 @end table
10554 @item -masm=@var{dialect}
10555 @opindex masm=@var{dialect}
10556 Output asm instructions using selected @var{dialect}.  Supported
10557 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10558 not support @samp{intel}.
10560 @item -mieee-fp
10561 @itemx -mno-ieee-fp
10562 @opindex mieee-fp
10563 @opindex mno-ieee-fp
10564 Control whether or not the compiler uses IEEE floating point
10565 comparisons.  These handle correctly the case where the result of a
10566 comparison is unordered.
10568 @item -msoft-float
10569 @opindex msoft-float
10570 Generate output containing library calls for floating point.
10571 @strong{Warning:} the requisite libraries are not part of GCC@.
10572 Normally the facilities of the machine's usual C compiler are used, but
10573 this can't be done directly in cross-compilation.  You must make your
10574 own arrangements to provide suitable library functions for
10575 cross-compilation.
10577 On machines where a function returns floating point results in the 80387
10578 register stack, some floating point opcodes may be emitted even if
10579 @option{-msoft-float} is used.
10581 @item -mno-fp-ret-in-387
10582 @opindex mno-fp-ret-in-387
10583 Do not use the FPU registers for return values of functions.
10585 The usual calling convention has functions return values of types
10586 @code{float} and @code{double} in an FPU register, even if there
10587 is no FPU@.  The idea is that the operating system should emulate
10588 an FPU@.
10590 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10591 in ordinary CPU registers instead.
10593 @item -mno-fancy-math-387
10594 @opindex mno-fancy-math-387
10595 Some 387 emulators do not support the @code{sin}, @code{cos} and
10596 @code{sqrt} instructions for the 387.  Specify this option to avoid
10597 generating those instructions.  This option is the default on FreeBSD,
10598 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10599 indicates that the target cpu will always have an FPU and so the
10600 instruction will not need emulation.  As of revision 2.6.1, these
10601 instructions are not generated unless you also use the
10602 @option{-funsafe-math-optimizations} switch.
10604 @item -malign-double
10605 @itemx -mno-align-double
10606 @opindex malign-double
10607 @opindex mno-align-double
10608 Control whether GCC aligns @code{double}, @code{long double}, and
10609 @code{long long} variables on a two word boundary or a one word
10610 boundary.  Aligning @code{double} variables on a two word boundary will
10611 produce code that runs somewhat faster on a @samp{Pentium} at the
10612 expense of more memory.
10614 On x86-64, @option{-malign-double} is enabled by default.
10616 @strong{Warning:} if you use the @option{-malign-double} switch,
10617 structures containing the above types will be aligned differently than
10618 the published application binary interface specifications for the 386
10619 and will not be binary compatible with structures in code compiled
10620 without that switch.
10622 @item -m96bit-long-double
10623 @itemx -m128bit-long-double
10624 @opindex m96bit-long-double
10625 @opindex m128bit-long-double
10626 These switches control the size of @code{long double} type.  The i386
10627 application binary interface specifies the size to be 96 bits,
10628 so @option{-m96bit-long-double} is the default in 32 bit mode.
10630 Modern architectures (Pentium and newer) would prefer @code{long double}
10631 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10632 conforming to the ABI, this would not be possible.  So specifying a
10633 @option{-m128bit-long-double} will align @code{long double}
10634 to a 16 byte boundary by padding the @code{long double} with an additional
10635 32 bit zero.
10637 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10638 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10640 Notice that neither of these options enable any extra precision over the x87
10641 standard of 80 bits for a @code{long double}.
10643 @strong{Warning:} if you override the default value for your target ABI, the
10644 structures and arrays containing @code{long double} variables will change
10645 their size as well as function calling convention for function taking
10646 @code{long double} will be modified.  Hence they will not be binary
10647 compatible with arrays or structures in code compiled without that switch.
10649 @item -mmlarge-data-threshold=@var{number}
10650 @opindex mlarge-data-threshold=@var{number}
10651 When @option{-mcmodel=medium} is specified, the data greater than
10652 @var{threshold} are placed in large data section.  This value must be the
10653 same across all object linked into the binary and defaults to 65535.
10655 @item -mrtd
10656 @opindex mrtd
10657 Use a different function-calling convention, in which functions that
10658 take a fixed number of arguments return with the @code{ret} @var{num}
10659 instruction, which pops their arguments while returning.  This saves one
10660 instruction in the caller since there is no need to pop the arguments
10661 there.
10663 You can specify that an individual function is called with this calling
10664 sequence with the function attribute @samp{stdcall}.  You can also
10665 override the @option{-mrtd} option by using the function attribute
10666 @samp{cdecl}.  @xref{Function Attributes}.
10668 @strong{Warning:} this calling convention is incompatible with the one
10669 normally used on Unix, so you cannot use it if you need to call
10670 libraries compiled with the Unix compiler.
10672 Also, you must provide function prototypes for all functions that
10673 take variable numbers of arguments (including @code{printf});
10674 otherwise incorrect code will be generated for calls to those
10675 functions.
10677 In addition, seriously incorrect code will result if you call a
10678 function with too many arguments.  (Normally, extra arguments are
10679 harmlessly ignored.)
10681 @item -mregparm=@var{num}
10682 @opindex mregparm
10683 Control how many registers are used to pass integer arguments.  By
10684 default, no registers are used to pass arguments, and at most 3
10685 registers can be used.  You can control this behavior for a specific
10686 function by using the function attribute @samp{regparm}.
10687 @xref{Function Attributes}.
10689 @strong{Warning:} if you use this switch, and
10690 @var{num} is nonzero, then you must build all modules with the same
10691 value, including any libraries.  This includes the system libraries and
10692 startup modules.
10694 @item -msseregparm
10695 @opindex msseregparm
10696 Use SSE register passing conventions for float and double arguments
10697 and return values.  You can control this behavior for a specific
10698 function by using the function attribute @samp{sseregparm}.
10699 @xref{Function Attributes}.
10701 @strong{Warning:} if you use this switch then you must build all
10702 modules with the same value, including any libraries.  This includes
10703 the system libraries and startup modules.
10705 @item -mpc32
10706 @itemx -mpc64
10707 @itemx -mpc80
10708 @opindex mpc32
10709 @opindex mpc64
10710 @opindex mpc80
10712 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10713 is specified, the significands of results of floating-point operations are
10714 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10715 significands of results of floating-point operations to 53 bits (double
10716 precision) and @option{-mpc80} rounds the significands of results of
10717 floating-point operations to 64 bits (extended double precision), which is
10718 the default.  When this option is used, floating-point operations in higher
10719 precisions are not available to the programmer without setting the FPU
10720 control word explicitly.
10722 Setting the rounding of floating-point operations to less than the default
10723 80 bits can speed some programs by 2% or more.  Note that some mathematical
10724 libraries assume that extended precision (80 bit) floating-point operations
10725 are enabled by default; routines in such libraries could suffer significant
10726 loss of accuracy, typically through so-called "catastrophic cancellation",
10727 when this option is used to set the precision to less than extended precision. 
10729 @item -mstackrealign
10730 @opindex mstackrealign
10731 Realign the stack at entry.  On the Intel x86, the
10732 @option{-mstackrealign} option will generate an alternate prologue and
10733 epilogue that realigns the runtime stack.  This supports mixing legacy
10734 codes that keep a 4-byte aligned stack with modern codes that keep a
10735 16-byte stack for SSE compatibility.  The alternate prologue and
10736 epilogue are slower and bigger than the regular ones, and the
10737 alternate prologue requires an extra scratch register; this lowers the
10738 number of registers available if used in conjunction with the
10739 @code{regparm} attribute.  The @option{-mstackrealign} option is
10740 incompatible with the nested function prologue; this is considered a
10741 hard error.  See also the attribute @code{force_align_arg_pointer},
10742 applicable to individual functions.
10744 @item -mpreferred-stack-boundary=@var{num}
10745 @opindex mpreferred-stack-boundary
10746 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10747 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10748 the default is 4 (16 bytes or 128 bits).
10750 On Pentium and PentiumPro, @code{double} and @code{long double} values
10751 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10752 suffer significant run time performance penalties.  On Pentium III, the
10753 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10754 properly if it is not 16 byte aligned.
10756 To ensure proper alignment of this values on the stack, the stack boundary
10757 must be as aligned as that required by any value stored on the stack.
10758 Further, every function must be generated such that it keeps the stack
10759 aligned.  Thus calling a function compiled with a higher preferred
10760 stack boundary from a function compiled with a lower preferred stack
10761 boundary will most likely misalign the stack.  It is recommended that
10762 libraries that use callbacks always use the default setting.
10764 This extra alignment does consume extra stack space, and generally
10765 increases code size.  Code that is sensitive to stack space usage, such
10766 as embedded systems and operating system kernels, may want to reduce the
10767 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10769 @item -mmmx
10770 @itemx -mno-mmx
10771 @itemx -msse
10772 @itemx -mno-sse
10773 @itemx -msse2
10774 @itemx -mno-sse2
10775 @itemx -msse3
10776 @itemx -mno-sse3
10777 @itemx -mssse3
10778 @itemx -mno-ssse3
10779 @itemx -msse4.1
10780 @itemx -mno-sse4.1
10781 @itemx -msse4.2
10782 @itemx -mno-sse4.2
10783 @itemx -msse4
10784 @itemx -mno-sse4
10785 @itemx -maes
10786 @itemx -mno-aes
10787 @itemx -mpclmul
10788 @itemx -mno-pclmul
10789 @itemx -msse4a
10790 @itemx -mno-sse4a
10791 @itemx -msse5
10792 @itemx -mno-sse5
10793 @itemx -m3dnow
10794 @itemx -mno-3dnow
10795 @itemx -mpopcnt
10796 @itemx -mno-popcnt
10797 @itemx -mabm
10798 @itemx -mno-abm
10799 @opindex mmmx
10800 @opindex mno-mmx
10801 @opindex msse
10802 @opindex mno-sse
10803 @opindex m3dnow
10804 @opindex mno-3dnow
10805 These switches enable or disable the use of instructions in the MMX,
10806 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10807 3DNow!@: extended instruction sets.
10808 These extensions are also available as built-in functions: see
10809 @ref{X86 Built-in Functions}, for details of the functions enabled and
10810 disabled by these switches.
10812 To have SSE/SSE2 instructions generated automatically from floating-point
10813 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10815 These options will enable GCC to use these extended instructions in
10816 generated code, even without @option{-mfpmath=sse}.  Applications which
10817 perform runtime CPU detection must compile separate files for each
10818 supported architecture, using the appropriate flags.  In particular,
10819 the file containing the CPU detection code should be compiled without
10820 these options.
10822 @item -mcx16
10823 @opindex mcx16
10824 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10825 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10826 data types.  This is useful for high resolution counters that could be updated
10827 by multiple processors (or cores).  This instruction is generated as part of
10828 atomic built-in functions: see @ref{Atomic Builtins} for details.
10830 @item -msahf
10831 @opindex msahf
10832 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10833 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10834 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10835 SAHF are load and store instructions, respectively, for certain status flags.
10836 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10837 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10839 @item -mrecip
10840 @opindex mrecip
10841 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10842 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10843 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10844 variants) for single precision floating point arguments.  These instructions
10845 are generated only when @option{-funsafe-math-optimizations} is enabled
10846 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10847 Note that while the throughput of the sequence is higher than the throughput
10848 of the non-reciprocal instruction, the precision of the sequence can be
10849 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10851 @item -mveclibabi=@var{type}
10852 @opindex mveclibabi
10853 Specifies the ABI type to use for vectorizing intrinsics using an
10854 external library.  Supported types are @code{svml} for the Intel short
10855 vector math library and @code{acml} for the AMD math core library style
10856 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10857 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10858 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10859 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10860 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10861 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10862 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10863 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10864 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10865 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10866 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10867 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10868 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10869 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10870 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10871 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10872 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10873 compatible library will have to be specified at link time.
10875 @item -mpush-args
10876 @itemx -mno-push-args
10877 @opindex mpush-args
10878 @opindex mno-push-args
10879 Use PUSH operations to store outgoing parameters.  This method is shorter
10880 and usually equally fast as method using SUB/MOV operations and is enabled
10881 by default.  In some cases disabling it may improve performance because of
10882 improved scheduling and reduced dependencies.
10884 @item -maccumulate-outgoing-args
10885 @opindex maccumulate-outgoing-args
10886 If enabled, the maximum amount of space required for outgoing arguments will be
10887 computed in the function prologue.  This is faster on most modern CPUs
10888 because of reduced dependencies, improved scheduling and reduced stack usage
10889 when preferred stack boundary is not equal to 2.  The drawback is a notable
10890 increase in code size.  This switch implies @option{-mno-push-args}.
10892 @item -mthreads
10893 @opindex mthreads
10894 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10895 on thread-safe exception handling must compile and link all code with the
10896 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10897 @option{-D_MT}; when linking, it links in a special thread helper library
10898 @option{-lmingwthrd} which cleans up per thread exception handling data.
10900 @item -mno-align-stringops
10901 @opindex mno-align-stringops
10902 Do not align destination of inlined string operations.  This switch reduces
10903 code size and improves performance in case the destination is already aligned,
10904 but GCC doesn't know about it.
10906 @item -minline-all-stringops
10907 @opindex minline-all-stringops
10908 By default GCC inlines string operations only when destination is known to be
10909 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10910 size, but may improve performance of code that depends on fast memcpy, strlen
10911 and memset for short lengths.
10913 @item -minline-stringops-dynamically
10914 @opindex minline-stringops-dynamically
10915 For string operation of unknown size, inline runtime checks so for small
10916 blocks inline code is used, while for large blocks library call is used.
10918 @item -mstringop-strategy=@var{alg}
10919 @opindex mstringop-strategy=@var{alg}
10920 Overwrite internal decision heuristic about particular algorithm to inline
10921 string operation with.  The allowed values are @code{rep_byte},
10922 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10923 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10924 expanding inline loop, @code{libcall} for always expanding library call.
10926 @item -momit-leaf-frame-pointer
10927 @opindex momit-leaf-frame-pointer
10928 Don't keep the frame pointer in a register for leaf functions.  This
10929 avoids the instructions to save, set up and restore frame pointers and
10930 makes an extra register available in leaf functions.  The option
10931 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10932 which might make debugging harder.
10934 @item -mtls-direct-seg-refs
10935 @itemx -mno-tls-direct-seg-refs
10936 @opindex mtls-direct-seg-refs
10937 Controls whether TLS variables may be accessed with offsets from the
10938 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10939 or whether the thread base pointer must be added.  Whether or not this
10940 is legal depends on the operating system, and whether it maps the
10941 segment to cover the entire TLS area.
10943 For systems that use GNU libc, the default is on.
10945 @item -mfused-madd
10946 @itemx -mno-fused-madd
10947 @opindex mfused-madd
10948 Enable automatic generation of fused floating point multiply-add instructions
10949 if the ISA supports such instructions.  The -mfused-madd option is on by
10950 default.  The fused multiply-add instructions have a different
10951 rounding behavior compared to executing a multiply followed by an add.
10952 @end table
10954 These @samp{-m} switches are supported in addition to the above
10955 on AMD x86-64 processors in 64-bit environments.
10957 @table @gcctabopt
10958 @item -m32
10959 @itemx -m64
10960 @opindex m32
10961 @opindex m64
10962 Generate code for a 32-bit or 64-bit environment.
10963 The 32-bit environment sets int, long and pointer to 32 bits and
10964 generates code that runs on any i386 system.
10965 The 64-bit environment sets int to 32 bits and long and pointer
10966 to 64 bits and generates code for AMD's x86-64 architecture. For
10967 darwin only the -m64 option turns off the @option{-fno-pic} and
10968 @option{-mdynamic-no-pic} options.
10970 @item -mno-red-zone
10971 @opindex no-red-zone
10972 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10973 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10974 stack pointer that will not be modified by signal or interrupt handlers
10975 and therefore can be used for temporary data without adjusting the stack
10976 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10978 @item -mcmodel=small
10979 @opindex mcmodel=small
10980 Generate code for the small code model: the program and its symbols must
10981 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10982 Programs can be statically or dynamically linked.  This is the default
10983 code model.
10985 @item -mcmodel=kernel
10986 @opindex mcmodel=kernel
10987 Generate code for the kernel code model.  The kernel runs in the
10988 negative 2 GB of the address space.
10989 This model has to be used for Linux kernel code.
10991 @item -mcmodel=medium
10992 @opindex mcmodel=medium
10993 Generate code for the medium model: The program is linked in the lower 2
10994 GB of the address space but symbols can be located anywhere in the
10995 address space.  Programs can be statically or dynamically linked, but
10996 building of shared libraries are not supported with the medium model.
10998 @item -mcmodel=large
10999 @opindex mcmodel=large
11000 Generate code for the large model: This model makes no assumptions
11001 about addresses and sizes of sections.
11002 @end table
11004 @node IA-64 Options
11005 @subsection IA-64 Options
11006 @cindex IA-64 Options
11008 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11010 @table @gcctabopt
11011 @item -mbig-endian
11012 @opindex mbig-endian
11013 Generate code for a big endian target.  This is the default for HP-UX@.
11015 @item -mlittle-endian
11016 @opindex mlittle-endian
11017 Generate code for a little endian target.  This is the default for AIX5
11018 and GNU/Linux.
11020 @item -mgnu-as
11021 @itemx -mno-gnu-as
11022 @opindex mgnu-as
11023 @opindex mno-gnu-as
11024 Generate (or don't) code for the GNU assembler.  This is the default.
11025 @c Also, this is the default if the configure option @option{--with-gnu-as}
11026 @c is used.
11028 @item -mgnu-ld
11029 @itemx -mno-gnu-ld
11030 @opindex mgnu-ld
11031 @opindex mno-gnu-ld
11032 Generate (or don't) code for the GNU linker.  This is the default.
11033 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11034 @c is used.
11036 @item -mno-pic
11037 @opindex mno-pic
11038 Generate code that does not use a global pointer register.  The result
11039 is not position independent code, and violates the IA-64 ABI@.
11041 @item -mvolatile-asm-stop
11042 @itemx -mno-volatile-asm-stop
11043 @opindex mvolatile-asm-stop
11044 @opindex mno-volatile-asm-stop
11045 Generate (or don't) a stop bit immediately before and after volatile asm
11046 statements.
11048 @item -mregister-names
11049 @itemx -mno-register-names
11050 @opindex mregister-names
11051 @opindex mno-register-names
11052 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11053 the stacked registers.  This may make assembler output more readable.
11055 @item -mno-sdata
11056 @itemx -msdata
11057 @opindex mno-sdata
11058 @opindex msdata
11059 Disable (or enable) optimizations that use the small data section.  This may
11060 be useful for working around optimizer bugs.
11062 @item -mconstant-gp
11063 @opindex mconstant-gp
11064 Generate code that uses a single constant global pointer value.  This is
11065 useful when compiling kernel code.
11067 @item -mauto-pic
11068 @opindex mauto-pic
11069 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11070 This is useful when compiling firmware code.
11072 @item -minline-float-divide-min-latency
11073 @opindex minline-float-divide-min-latency
11074 Generate code for inline divides of floating point values
11075 using the minimum latency algorithm.
11077 @item -minline-float-divide-max-throughput
11078 @opindex minline-float-divide-max-throughput
11079 Generate code for inline divides of floating point values
11080 using the maximum throughput algorithm.
11082 @item -minline-int-divide-min-latency
11083 @opindex minline-int-divide-min-latency
11084 Generate code for inline divides of integer values
11085 using the minimum latency algorithm.
11087 @item -minline-int-divide-max-throughput
11088 @opindex minline-int-divide-max-throughput
11089 Generate code for inline divides of integer values
11090 using the maximum throughput algorithm.
11092 @item -minline-sqrt-min-latency
11093 @opindex minline-sqrt-min-latency
11094 Generate code for inline square roots
11095 using the minimum latency algorithm.
11097 @item -minline-sqrt-max-throughput
11098 @opindex minline-sqrt-max-throughput
11099 Generate code for inline square roots
11100 using the maximum throughput algorithm.
11102 @item -mno-dwarf2-asm
11103 @itemx -mdwarf2-asm
11104 @opindex mno-dwarf2-asm
11105 @opindex mdwarf2-asm
11106 Don't (or do) generate assembler code for the DWARF2 line number debugging
11107 info.  This may be useful when not using the GNU assembler.
11109 @item -mearly-stop-bits
11110 @itemx -mno-early-stop-bits
11111 @opindex mearly-stop-bits
11112 @opindex mno-early-stop-bits
11113 Allow stop bits to be placed earlier than immediately preceding the
11114 instruction that triggered the stop bit.  This can improve instruction
11115 scheduling, but does not always do so.
11117 @item -mfixed-range=@var{register-range}
11118 @opindex mfixed-range
11119 Generate code treating the given register range as fixed registers.
11120 A fixed register is one that the register allocator can not use.  This is
11121 useful when compiling kernel code.  A register range is specified as
11122 two registers separated by a dash.  Multiple register ranges can be
11123 specified separated by a comma.
11125 @item -mtls-size=@var{tls-size}
11126 @opindex mtls-size
11127 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11130 @item -mtune=@var{cpu-type}
11131 @opindex mtune
11132 Tune the instruction scheduling for a particular CPU, Valid values are
11133 itanium, itanium1, merced, itanium2, and mckinley.
11135 @item -mt
11136 @itemx -pthread
11137 @opindex mt
11138 @opindex pthread
11139 Add support for multithreading using the POSIX threads library.  This
11140 option sets flags for both the preprocessor and linker.  It does
11141 not affect the thread safety of object code produced by the compiler or
11142 that of libraries supplied with it.  These are HP-UX specific flags.
11144 @item -milp32
11145 @itemx -mlp64
11146 @opindex milp32
11147 @opindex mlp64
11148 Generate code for a 32-bit or 64-bit environment.
11149 The 32-bit environment sets int, long and pointer to 32 bits.
11150 The 64-bit environment sets int to 32 bits and long and pointer
11151 to 64 bits.  These are HP-UX specific flags.
11153 @item -mno-sched-br-data-spec
11154 @itemx -msched-br-data-spec
11155 @opindex mno-sched-br-data-spec
11156 @opindex msched-br-data-spec
11157 (Dis/En)able data speculative scheduling before reload.
11158 This will result in generation of the ld.a instructions and
11159 the corresponding check instructions (ld.c / chk.a).
11160 The default is 'disable'.
11162 @item -msched-ar-data-spec
11163 @itemx -mno-sched-ar-data-spec
11164 @opindex msched-ar-data-spec
11165 @opindex mno-sched-ar-data-spec
11166 (En/Dis)able data speculative scheduling after reload.
11167 This will result in generation of the ld.a instructions and
11168 the corresponding check instructions (ld.c / chk.a).
11169 The default is 'enable'.
11171 @item -mno-sched-control-spec
11172 @itemx -msched-control-spec
11173 @opindex mno-sched-control-spec
11174 @opindex msched-control-spec
11175 (Dis/En)able control speculative scheduling.  This feature is
11176 available only during region scheduling (i.e.@: before reload).
11177 This will result in generation of the ld.s instructions and
11178 the corresponding check instructions chk.s .
11179 The default is 'disable'.
11181 @item -msched-br-in-data-spec
11182 @itemx -mno-sched-br-in-data-spec
11183 @opindex msched-br-in-data-spec
11184 @opindex mno-sched-br-in-data-spec
11185 (En/Dis)able speculative scheduling of the instructions that
11186 are dependent on the data speculative loads before reload.
11187 This is effective only with @option{-msched-br-data-spec} enabled.
11188 The default is 'enable'.
11190 @item -msched-ar-in-data-spec
11191 @itemx -mno-sched-ar-in-data-spec
11192 @opindex msched-ar-in-data-spec
11193 @opindex mno-sched-ar-in-data-spec
11194 (En/Dis)able speculative scheduling of the instructions that
11195 are dependent on the data speculative loads after reload.
11196 This is effective only with @option{-msched-ar-data-spec} enabled.
11197 The default is 'enable'.
11199 @item -msched-in-control-spec
11200 @itemx -mno-sched-in-control-spec
11201 @opindex msched-in-control-spec
11202 @opindex mno-sched-in-control-spec
11203 (En/Dis)able speculative scheduling of the instructions that
11204 are dependent on the control speculative loads.
11205 This is effective only with @option{-msched-control-spec} enabled.
11206 The default is 'enable'.
11208 @item -msched-ldc
11209 @itemx -mno-sched-ldc
11210 @opindex msched-ldc
11211 @opindex mno-sched-ldc
11212 (En/Dis)able use of simple data speculation checks ld.c .
11213 If disabled, only chk.a instructions will be emitted to check
11214 data speculative loads.
11215 The default is 'enable'.
11217 @item -mno-sched-control-ldc
11218 @itemx -msched-control-ldc
11219 @opindex mno-sched-control-ldc
11220 @opindex msched-control-ldc
11221 (Dis/En)able use of ld.c instructions to check control speculative loads.
11222 If enabled, in case of control speculative load with no speculatively
11223 scheduled dependent instructions this load will be emitted as ld.sa and
11224 ld.c will be used to check it.
11225 The default is 'disable'.
11227 @item -mno-sched-spec-verbose
11228 @itemx -msched-spec-verbose
11229 @opindex mno-sched-spec-verbose
11230 @opindex msched-spec-verbose
11231 (Dis/En)able printing of the information about speculative motions.
11233 @item -mno-sched-prefer-non-data-spec-insns
11234 @itemx -msched-prefer-non-data-spec-insns
11235 @opindex mno-sched-prefer-non-data-spec-insns
11236 @opindex msched-prefer-non-data-spec-insns
11237 If enabled, data speculative instructions will be chosen for schedule
11238 only if there are no other choices at the moment.  This will make
11239 the use of the data speculation much more conservative.
11240 The default is 'disable'.
11242 @item -mno-sched-prefer-non-control-spec-insns
11243 @itemx -msched-prefer-non-control-spec-insns
11244 @opindex mno-sched-prefer-non-control-spec-insns
11245 @opindex msched-prefer-non-control-spec-insns
11246 If enabled, control speculative instructions will be chosen for schedule
11247 only if there are no other choices at the moment.  This will make
11248 the use of the control speculation much more conservative.
11249 The default is 'disable'.
11251 @item -mno-sched-count-spec-in-critical-path
11252 @itemx -msched-count-spec-in-critical-path
11253 @opindex mno-sched-count-spec-in-critical-path
11254 @opindex msched-count-spec-in-critical-path
11255 If enabled, speculative dependencies will be considered during
11256 computation of the instructions priorities.  This will make the use of the
11257 speculation a bit more conservative.
11258 The default is 'disable'.
11260 @end table
11262 @node M32C Options
11263 @subsection M32C Options
11264 @cindex M32C options
11266 @table @gcctabopt
11267 @item -mcpu=@var{name}
11268 @opindex mcpu=
11269 Select the CPU for which code is generated.  @var{name} may be one of
11270 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11271 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11272 the M32C/80 series.
11274 @item -msim
11275 @opindex msim
11276 Specifies that the program will be run on the simulator.  This causes
11277 an alternate runtime library to be linked in which supports, for
11278 example, file I/O@.  You must not use this option when generating
11279 programs that will run on real hardware; you must provide your own
11280 runtime library for whatever I/O functions are needed.
11282 @item -memregs=@var{number}
11283 @opindex memregs=
11284 Specifies the number of memory-based pseudo-registers GCC will use
11285 during code generation.  These pseudo-registers will be used like real
11286 registers, so there is a tradeoff between GCC's ability to fit the
11287 code into available registers, and the performance penalty of using
11288 memory instead of registers.  Note that all modules in a program must
11289 be compiled with the same value for this option.  Because of that, you
11290 must not use this option with the default runtime libraries gcc
11291 builds.
11293 @end table
11295 @node M32R/D Options
11296 @subsection M32R/D Options
11297 @cindex M32R/D options
11299 These @option{-m} options are defined for Renesas M32R/D architectures:
11301 @table @gcctabopt
11302 @item -m32r2
11303 @opindex m32r2
11304 Generate code for the M32R/2@.
11306 @item -m32rx
11307 @opindex m32rx
11308 Generate code for the M32R/X@.
11310 @item -m32r
11311 @opindex m32r
11312 Generate code for the M32R@.  This is the default.
11314 @item -mmodel=small
11315 @opindex mmodel=small
11316 Assume all objects live in the lower 16MB of memory (so that their addresses
11317 can be loaded with the @code{ld24} instruction), and assume all subroutines
11318 are reachable with the @code{bl} instruction.
11319 This is the default.
11321 The addressability of a particular object can be set with the
11322 @code{model} attribute.
11324 @item -mmodel=medium
11325 @opindex mmodel=medium
11326 Assume objects may be anywhere in the 32-bit address space (the compiler
11327 will generate @code{seth/add3} instructions to load their addresses), and
11328 assume all subroutines are reachable with the @code{bl} instruction.
11330 @item -mmodel=large
11331 @opindex mmodel=large
11332 Assume objects may be anywhere in the 32-bit address space (the compiler
11333 will generate @code{seth/add3} instructions to load their addresses), and
11334 assume subroutines may not be reachable with the @code{bl} instruction
11335 (the compiler will generate the much slower @code{seth/add3/jl}
11336 instruction sequence).
11338 @item -msdata=none
11339 @opindex msdata=none
11340 Disable use of the small data area.  Variables will be put into
11341 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11342 @code{section} attribute has been specified).
11343 This is the default.
11345 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11346 Objects may be explicitly put in the small data area with the
11347 @code{section} attribute using one of these sections.
11349 @item -msdata=sdata
11350 @opindex msdata=sdata
11351 Put small global and static data in the small data area, but do not
11352 generate special code to reference them.
11354 @item -msdata=use
11355 @opindex msdata=use
11356 Put small global and static data in the small data area, and generate
11357 special instructions to reference them.
11359 @item -G @var{num}
11360 @opindex G
11361 @cindex smaller data references
11362 Put global and static objects less than or equal to @var{num} bytes
11363 into the small data or bss sections instead of the normal data or bss
11364 sections.  The default value of @var{num} is 8.
11365 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11366 for this option to have any effect.
11368 All modules should be compiled with the same @option{-G @var{num}} value.
11369 Compiling with different values of @var{num} may or may not work; if it
11370 doesn't the linker will give an error message---incorrect code will not be
11371 generated.
11373 @item -mdebug
11374 @opindex mdebug
11375 Makes the M32R specific code in the compiler display some statistics
11376 that might help in debugging programs.
11378 @item -malign-loops
11379 @opindex malign-loops
11380 Align all loops to a 32-byte boundary.
11382 @item -mno-align-loops
11383 @opindex mno-align-loops
11384 Do not enforce a 32-byte alignment for loops.  This is the default.
11386 @item -missue-rate=@var{number}
11387 @opindex missue-rate=@var{number}
11388 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11389 or 2.
11391 @item -mbranch-cost=@var{number}
11392 @opindex mbranch-cost=@var{number}
11393 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11394 preferred over conditional code, if it is 2, then the opposite will
11395 apply.
11397 @item -mflush-trap=@var{number}
11398 @opindex mflush-trap=@var{number}
11399 Specifies the trap number to use to flush the cache.  The default is
11400 12.  Valid numbers are between 0 and 15 inclusive.
11402 @item -mno-flush-trap
11403 @opindex mno-flush-trap
11404 Specifies that the cache cannot be flushed by using a trap.
11406 @item -mflush-func=@var{name}
11407 @opindex mflush-func=@var{name}
11408 Specifies the name of the operating system function to call to flush
11409 the cache.  The default is @emph{_flush_cache}, but a function call
11410 will only be used if a trap is not available.
11412 @item -mno-flush-func
11413 @opindex mno-flush-func
11414 Indicates that there is no OS function for flushing the cache.
11416 @end table
11418 @node M680x0 Options
11419 @subsection M680x0 Options
11420 @cindex M680x0 options
11422 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11423 The default settings depend on which architecture was selected when
11424 the compiler was configured; the defaults for the most common choices
11425 are given below.
11427 @table @gcctabopt
11428 @item -march=@var{arch}
11429 @opindex march
11430 Generate code for a specific M680x0 or ColdFire instruction set
11431 architecture.  Permissible values of @var{arch} for M680x0
11432 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11433 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11434 architectures are selected according to Freescale's ISA classification
11435 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11436 @samp{isab} and @samp{isac}.
11438 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11439 code for a ColdFire target.  The @var{arch} in this macro is one of the
11440 @option{-march} arguments given above.
11442 When used together, @option{-march} and @option{-mtune} select code
11443 that runs on a family of similar processors but that is optimized
11444 for a particular microarchitecture.
11446 @item -mcpu=@var{cpu}
11447 @opindex mcpu
11448 Generate code for a specific M680x0 or ColdFire processor.
11449 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11450 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11451 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11452 below, which also classifies the CPUs into families:
11454 @multitable @columnfractions 0.20 0.80
11455 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11456 @item @samp{51qe} @tab @samp{51qe}
11457 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11458 @item @samp{5206e} @tab @samp{5206e}
11459 @item @samp{5208} @tab @samp{5207} @samp{5208}
11460 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11461 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11462 @item @samp{5216} @tab @samp{5214} @samp{5216}
11463 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11464 @item @samp{5225} @tab @samp{5224} @samp{5225}
11465 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11466 @item @samp{5249} @tab @samp{5249}
11467 @item @samp{5250} @tab @samp{5250}
11468 @item @samp{5271} @tab @samp{5270} @samp{5271}
11469 @item @samp{5272} @tab @samp{5272}
11470 @item @samp{5275} @tab @samp{5274} @samp{5275}
11471 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11472 @item @samp{5307} @tab @samp{5307}
11473 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11474 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11475 @item @samp{5407} @tab @samp{5407}
11476 @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}
11477 @end multitable
11479 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11480 @var{arch} is compatible with @var{cpu}.  Other combinations of
11481 @option{-mcpu} and @option{-march} are rejected.
11483 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11484 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11485 where the value of @var{family} is given by the table above.
11487 @item -mtune=@var{tune}
11488 @opindex mtune
11489 Tune the code for a particular microarchitecture, within the
11490 constraints set by @option{-march} and @option{-mcpu}.
11491 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11492 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11493 and @samp{cpu32}.  The ColdFire microarchitectures
11494 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11496 You can also use @option{-mtune=68020-40} for code that needs
11497 to run relatively well on 68020, 68030 and 68040 targets.
11498 @option{-mtune=68020-60} is similar but includes 68060 targets
11499 as well.  These two options select the same tuning decisions as
11500 @option{-m68020-40} and @option{-m68020-60} respectively.
11502 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11503 when tuning for 680x0 architecture @var{arch}.  It also defines
11504 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11505 option is used.  If gcc is tuning for a range of architectures,
11506 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11507 it defines the macros for every architecture in the range.
11509 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11510 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11511 of the arguments given above.
11513 @item -m68000
11514 @itemx -mc68000
11515 @opindex m68000
11516 @opindex mc68000
11517 Generate output for a 68000.  This is the default
11518 when the compiler is configured for 68000-based systems.
11519 It is equivalent to @option{-march=68000}.
11521 Use this option for microcontrollers with a 68000 or EC000 core,
11522 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11524 @item -m68010
11525 @opindex m68010
11526 Generate output for a 68010.  This is the default
11527 when the compiler is configured for 68010-based systems.
11528 It is equivalent to @option{-march=68010}.
11530 @item -m68020
11531 @itemx -mc68020
11532 @opindex m68020
11533 @opindex mc68020
11534 Generate output for a 68020.  This is the default
11535 when the compiler is configured for 68020-based systems.
11536 It is equivalent to @option{-march=68020}.
11538 @item -m68030
11539 @opindex m68030
11540 Generate output for a 68030.  This is the default when the compiler is
11541 configured for 68030-based systems.  It is equivalent to
11542 @option{-march=68030}.
11544 @item -m68040
11545 @opindex m68040
11546 Generate output for a 68040.  This is the default when the compiler is
11547 configured for 68040-based systems.  It is equivalent to
11548 @option{-march=68040}.
11550 This option inhibits the use of 68881/68882 instructions that have to be
11551 emulated by software on the 68040.  Use this option if your 68040 does not
11552 have code to emulate those instructions.
11554 @item -m68060
11555 @opindex m68060
11556 Generate output for a 68060.  This is the default when the compiler is
11557 configured for 68060-based systems.  It is equivalent to
11558 @option{-march=68060}.
11560 This option inhibits the use of 68020 and 68881/68882 instructions that
11561 have to be emulated by software on the 68060.  Use this option if your 68060
11562 does not have code to emulate those instructions.
11564 @item -mcpu32
11565 @opindex mcpu32
11566 Generate output for a CPU32.  This is the default
11567 when the compiler is configured for CPU32-based systems.
11568 It is equivalent to @option{-march=cpu32}.
11570 Use this option for microcontrollers with a
11571 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11572 68336, 68340, 68341, 68349 and 68360.
11574 @item -m5200
11575 @opindex m5200
11576 Generate output for a 520X ColdFire CPU@.  This is the default
11577 when the compiler is configured for 520X-based systems.
11578 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11579 in favor of that option.
11581 Use this option for microcontroller with a 5200 core, including
11582 the MCF5202, MCF5203, MCF5204 and MCF5206.
11584 @item -m5206e
11585 @opindex m5206e
11586 Generate output for a 5206e ColdFire CPU@.  The option is now
11587 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11589 @item -m528x
11590 @opindex m528x
11591 Generate output for a member of the ColdFire 528X family.
11592 The option is now deprecated in favor of the equivalent
11593 @option{-mcpu=528x}.
11595 @item -m5307
11596 @opindex m5307
11597 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11598 in favor of the equivalent @option{-mcpu=5307}.
11600 @item -m5407
11601 @opindex m5407
11602 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11603 in favor of the equivalent @option{-mcpu=5407}.
11605 @item -mcfv4e
11606 @opindex mcfv4e
11607 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11608 This includes use of hardware floating point instructions.
11609 The option is equivalent to @option{-mcpu=547x}, and is now
11610 deprecated in favor of that option.
11612 @item -m68020-40
11613 @opindex m68020-40
11614 Generate output for a 68040, without using any of the new instructions.
11615 This results in code which can run relatively efficiently on either a
11616 68020/68881 or a 68030 or a 68040.  The generated code does use the
11617 68881 instructions that are emulated on the 68040.
11619 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11621 @item -m68020-60
11622 @opindex m68020-60
11623 Generate output for a 68060, without using any of the new instructions.
11624 This results in code which can run relatively efficiently on either a
11625 68020/68881 or a 68030 or a 68040.  The generated code does use the
11626 68881 instructions that are emulated on the 68060.
11628 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11630 @item -mhard-float
11631 @itemx -m68881
11632 @opindex mhard-float
11633 @opindex m68881
11634 Generate floating-point instructions.  This is the default for 68020
11635 and above, and for ColdFire devices that have an FPU@.  It defines the
11636 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11637 on ColdFire targets.
11639 @item -msoft-float
11640 @opindex msoft-float
11641 Do not generate floating-point instructions; use library calls instead.
11642 This is the default for 68000, 68010, and 68832 targets.  It is also
11643 the default for ColdFire devices that have no FPU.
11645 @item -mdiv
11646 @itemx -mno-div
11647 @opindex mdiv
11648 @opindex mno-div
11649 Generate (do not generate) ColdFire hardware divide and remainder
11650 instructions.  If @option{-march} is used without @option{-mcpu},
11651 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11652 architectures.  Otherwise, the default is taken from the target CPU
11653 (either the default CPU, or the one specified by @option{-mcpu}).  For
11654 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11655 @option{-mcpu=5206e}.
11657 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11659 @item -mshort
11660 @opindex mshort
11661 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11662 Additionally, parameters passed on the stack are also aligned to a
11663 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11665 @item -mno-short
11666 @opindex mno-short
11667 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11669 @item -mnobitfield
11670 @itemx -mno-bitfield
11671 @opindex mnobitfield
11672 @opindex mno-bitfield
11673 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11674 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11676 @item -mbitfield
11677 @opindex mbitfield
11678 Do use the bit-field instructions.  The @option{-m68020} option implies
11679 @option{-mbitfield}.  This is the default if you use a configuration
11680 designed for a 68020.
11682 @item -mrtd
11683 @opindex mrtd
11684 Use a different function-calling convention, in which functions
11685 that take a fixed number of arguments return with the @code{rtd}
11686 instruction, which pops their arguments while returning.  This
11687 saves one instruction in the caller since there is no need to pop
11688 the arguments there.
11690 This calling convention is incompatible with the one normally
11691 used on Unix, so you cannot use it if you need to call libraries
11692 compiled with the Unix compiler.
11694 Also, you must provide function prototypes for all functions that
11695 take variable numbers of arguments (including @code{printf});
11696 otherwise incorrect code will be generated for calls to those
11697 functions.
11699 In addition, seriously incorrect code will result if you call a
11700 function with too many arguments.  (Normally, extra arguments are
11701 harmlessly ignored.)
11703 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11704 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11706 @item -mno-rtd
11707 @opindex mno-rtd
11708 Do not use the calling conventions selected by @option{-mrtd}.
11709 This is the default.
11711 @item -malign-int
11712 @itemx -mno-align-int
11713 @opindex malign-int
11714 @opindex mno-align-int
11715 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11716 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11717 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11718 Aligning variables on 32-bit boundaries produces code that runs somewhat
11719 faster on processors with 32-bit busses at the expense of more memory.
11721 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11722 align structures containing the above types  differently than
11723 most published application binary interface specifications for the m68k.
11725 @item -mpcrel
11726 @opindex mpcrel
11727 Use the pc-relative addressing mode of the 68000 directly, instead of
11728 using a global offset table.  At present, this option implies @option{-fpic},
11729 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11730 not presently supported with @option{-mpcrel}, though this could be supported for
11731 68020 and higher processors.
11733 @item -mno-strict-align
11734 @itemx -mstrict-align
11735 @opindex mno-strict-align
11736 @opindex mstrict-align
11737 Do not (do) assume that unaligned memory references will be handled by
11738 the system.
11740 @item -msep-data
11741 Generate code that allows the data segment to be located in a different
11742 area of memory from the text segment.  This allows for execute in place in
11743 an environment without virtual memory management.  This option implies
11744 @option{-fPIC}.
11746 @item -mno-sep-data
11747 Generate code that assumes that the data segment follows the text segment.
11748 This is the default.
11750 @item -mid-shared-library
11751 Generate code that supports shared libraries via the library ID method.
11752 This allows for execute in place and shared libraries in an environment
11753 without virtual memory management.  This option implies @option{-fPIC}.
11755 @item -mno-id-shared-library
11756 Generate code that doesn't assume ID based shared libraries are being used.
11757 This is the default.
11759 @item -mshared-library-id=n
11760 Specified the identification number of the ID based shared library being
11761 compiled.  Specifying a value of 0 will generate more compact code, specifying
11762 other values will force the allocation of that number to the current
11763 library but is no more space or time efficient than omitting this option.
11765 @end table
11767 @node M68hc1x Options
11768 @subsection M68hc1x Options
11769 @cindex M68hc1x options
11771 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11772 microcontrollers.  The default values for these options depends on
11773 which style of microcontroller was selected when the compiler was configured;
11774 the defaults for the most common choices are given below.
11776 @table @gcctabopt
11777 @item -m6811
11778 @itemx -m68hc11
11779 @opindex m6811
11780 @opindex m68hc11
11781 Generate output for a 68HC11.  This is the default
11782 when the compiler is configured for 68HC11-based systems.
11784 @item -m6812
11785 @itemx -m68hc12
11786 @opindex m6812
11787 @opindex m68hc12
11788 Generate output for a 68HC12.  This is the default
11789 when the compiler is configured for 68HC12-based systems.
11791 @item -m68S12
11792 @itemx -m68hcs12
11793 @opindex m68S12
11794 @opindex m68hcs12
11795 Generate output for a 68HCS12.
11797 @item -mauto-incdec
11798 @opindex mauto-incdec
11799 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11800 addressing modes.
11802 @item -minmax
11803 @itemx -nominmax
11804 @opindex minmax
11805 @opindex mnominmax
11806 Enable the use of 68HC12 min and max instructions.
11808 @item -mlong-calls
11809 @itemx -mno-long-calls
11810 @opindex mlong-calls
11811 @opindex mno-long-calls
11812 Treat all calls as being far away (near).  If calls are assumed to be
11813 far away, the compiler will use the @code{call} instruction to
11814 call a function and the @code{rtc} instruction for returning.
11816 @item -mshort
11817 @opindex mshort
11818 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11820 @item -msoft-reg-count=@var{count}
11821 @opindex msoft-reg-count
11822 Specify the number of pseudo-soft registers which are used for the
11823 code generation.  The maximum number is 32.  Using more pseudo-soft
11824 register may or may not result in better code depending on the program.
11825 The default is 4 for 68HC11 and 2 for 68HC12.
11827 @end table
11829 @node MCore Options
11830 @subsection MCore Options
11831 @cindex MCore options
11833 These are the @samp{-m} options defined for the Motorola M*Core
11834 processors.
11836 @table @gcctabopt
11838 @item -mhardlit
11839 @itemx -mno-hardlit
11840 @opindex mhardlit
11841 @opindex mno-hardlit
11842 Inline constants into the code stream if it can be done in two
11843 instructions or less.
11845 @item -mdiv
11846 @itemx -mno-div
11847 @opindex mdiv
11848 @opindex mno-div
11849 Use the divide instruction.  (Enabled by default).
11851 @item -mrelax-immediate
11852 @itemx -mno-relax-immediate
11853 @opindex mrelax-immediate
11854 @opindex mno-relax-immediate
11855 Allow arbitrary sized immediates in bit operations.
11857 @item -mwide-bitfields
11858 @itemx -mno-wide-bitfields
11859 @opindex mwide-bitfields
11860 @opindex mno-wide-bitfields
11861 Always treat bit-fields as int-sized.
11863 @item -m4byte-functions
11864 @itemx -mno-4byte-functions
11865 @opindex m4byte-functions
11866 @opindex mno-4byte-functions
11867 Force all functions to be aligned to a four byte boundary.
11869 @item -mcallgraph-data
11870 @itemx -mno-callgraph-data
11871 @opindex mcallgraph-data
11872 @opindex mno-callgraph-data
11873 Emit callgraph information.
11875 @item -mslow-bytes
11876 @itemx -mno-slow-bytes
11877 @opindex mslow-bytes
11878 @opindex mno-slow-bytes
11879 Prefer word access when reading byte quantities.
11881 @item -mlittle-endian
11882 @itemx -mbig-endian
11883 @opindex mlittle-endian
11884 @opindex mbig-endian
11885 Generate code for a little endian target.
11887 @item -m210
11888 @itemx -m340
11889 @opindex m210
11890 @opindex m340
11891 Generate code for the 210 processor.
11892 @end table
11894 @node MIPS Options
11895 @subsection MIPS Options
11896 @cindex MIPS options
11898 @table @gcctabopt
11900 @item -EB
11901 @opindex EB
11902 Generate big-endian code.
11904 @item -EL
11905 @opindex EL
11906 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11907 configurations.
11909 @item -march=@var{arch}
11910 @opindex march
11911 Generate code that will run on @var{arch}, which can be the name of a
11912 generic MIPS ISA, or the name of a particular processor.
11913 The ISA names are:
11914 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11915 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11916 The processor names are:
11917 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11918 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11919 @samp{5kc}, @samp{5kf},
11920 @samp{20kc},
11921 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11922 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11923 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11924 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11925 @samp{m4k},
11926 @samp{orion},
11927 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11928 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11929 @samp{rm7000}, @samp{rm9000},
11930 @samp{sb1},
11931 @samp{sr71000},
11932 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11933 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11934 The special value @samp{from-abi} selects the
11935 most compatible architecture for the selected ABI (that is,
11936 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11938 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11939 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11940 @samp{vr} may be written @samp{r}.
11942 Names of the form @samp{@var{n}f2_1} refer to processors with
11943 FPUs clocked at half the rate of the core, names of the form
11944 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11945 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11946 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11947 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11948 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11949 accepted as synonyms for @samp{@var{n}f1_1}.
11951 GCC defines two macros based on the value of this option.  The first
11952 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11953 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11954 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11955 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11956 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11958 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11959 above.  In other words, it will have the full prefix and will not
11960 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11961 the macro names the resolved architecture (either @samp{"mips1"} or
11962 @samp{"mips3"}).  It names the default architecture when no
11963 @option{-march} option is given.
11965 @item -mtune=@var{arch}
11966 @opindex mtune
11967 Optimize for @var{arch}.  Among other things, this option controls
11968 the way instructions are scheduled, and the perceived cost of arithmetic
11969 operations.  The list of @var{arch} values is the same as for
11970 @option{-march}.
11972 When this option is not used, GCC will optimize for the processor
11973 specified by @option{-march}.  By using @option{-march} and
11974 @option{-mtune} together, it is possible to generate code that will
11975 run on a family of processors, but optimize the code for one
11976 particular member of that family.
11978 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11979 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11980 @samp{-march} ones described above.
11982 @item -mips1
11983 @opindex mips1
11984 Equivalent to @samp{-march=mips1}.
11986 @item -mips2
11987 @opindex mips2
11988 Equivalent to @samp{-march=mips2}.
11990 @item -mips3
11991 @opindex mips3
11992 Equivalent to @samp{-march=mips3}.
11994 @item -mips4
11995 @opindex mips4
11996 Equivalent to @samp{-march=mips4}.
11998 @item -mips32
11999 @opindex mips32
12000 Equivalent to @samp{-march=mips32}.
12002 @item -mips32r2
12003 @opindex mips32r2
12004 Equivalent to @samp{-march=mips32r2}.
12006 @item -mips64
12007 @opindex mips64
12008 Equivalent to @samp{-march=mips64}.
12010 @item -mips16
12011 @itemx -mno-mips16
12012 @opindex mips16
12013 @opindex mno-mips16
12014 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12015 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12017 MIPS16 code generation can also be controlled on a per-function basis
12018 by means of @code{mips16} and @code{nomips16} attributes.  
12019 @xref{Function Attributes}, for more information.
12021 @item -mflip-mips16
12022 @opindex mflip-mips16
12023 Generate MIPS16 code on alternating functions.  This option is provided
12024 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12025 not intended for ordinary use in compiling user code.
12027 @item -minterlink-mips16
12028 @itemx -mno-interlink-mips16
12029 @opindex minterlink-mips16
12030 @opindex mno-interlink-mips16
12031 Require (do not require) that non-MIPS16 code be link-compatible with
12032 MIPS16 code.
12034 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12035 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12036 therefore disables direct jumps unless GCC knows that the target of the
12037 jump is not MIPS16.
12039 @item -mabi=32
12040 @itemx -mabi=o64
12041 @itemx -mabi=n32
12042 @itemx -mabi=64
12043 @itemx -mabi=eabi
12044 @opindex mabi=32
12045 @opindex mabi=o64
12046 @opindex mabi=n32
12047 @opindex mabi=64
12048 @opindex mabi=eabi
12049 Generate code for the given ABI@.
12051 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12052 generates 64-bit code when you select a 64-bit architecture, but you
12053 can use @option{-mgp32} to get 32-bit code instead.
12055 For information about the O64 ABI, see
12056 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12058 GCC supports a variant of the o32 ABI in which floating-point registers
12059 are 64 rather than 32 bits wide.  You can select this combination with
12060 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12061 and @samp{mfhc1} instructions and is therefore only supported for
12062 MIPS32R2 processors.
12064 The register assignments for arguments and return values remain the
12065 same, but each scalar value is passed in a single 64-bit register
12066 rather than a pair of 32-bit registers.  For example, scalar
12067 floating-point values are returned in @samp{$f0} only, not a
12068 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12069 remains the same, but all 64 bits are saved.
12071 @item -mabicalls
12072 @itemx -mno-abicalls
12073 @opindex mabicalls
12074 @opindex mno-abicalls
12075 Generate (do not generate) code that is suitable for SVR4-style
12076 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12077 systems.
12079 @item -mshared
12080 @itemx -mno-shared
12081 Generate (do not generate) code that is fully position-independent,
12082 and that can therefore be linked into shared libraries.  This option
12083 only affects @option{-mabicalls}.
12085 All @option{-mabicalls} code has traditionally been position-independent,
12086 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12087 as an extension, the GNU toolchain allows executables to use absolute
12088 accesses for locally-binding symbols.  It can also use shorter GP
12089 initialization sequences and generate direct calls to locally-defined
12090 functions.  This mode is selected by @option{-mno-shared}.
12092 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12093 objects that can only be linked by the GNU linker.  However, the option
12094 does not affect the ABI of the final executable; it only affects the ABI
12095 of relocatable objects.  Using @option{-mno-shared} will generally make
12096 executables both smaller and quicker.
12098 @option{-mshared} is the default.
12100 @item -mxgot
12101 @itemx -mno-xgot
12102 @opindex mxgot
12103 @opindex mno-xgot
12104 Lift (do not lift) the usual restrictions on the size of the global
12105 offset table.
12107 GCC normally uses a single instruction to load values from the GOT@.
12108 While this is relatively efficient, it will only work if the GOT
12109 is smaller than about 64k.  Anything larger will cause the linker
12110 to report an error such as:
12112 @cindex relocation truncated to fit (MIPS)
12113 @smallexample
12114 relocation truncated to fit: R_MIPS_GOT16 foobar
12115 @end smallexample
12117 If this happens, you should recompile your code with @option{-mxgot}.
12118 It should then work with very large GOTs, although it will also be
12119 less efficient, since it will take three instructions to fetch the
12120 value of a global symbol.
12122 Note that some linkers can create multiple GOTs.  If you have such a
12123 linker, you should only need to use @option{-mxgot} when a single object
12124 file accesses more than 64k's worth of GOT entries.  Very few do.
12126 These options have no effect unless GCC is generating position
12127 independent code.
12129 @item -mgp32
12130 @opindex mgp32
12131 Assume that general-purpose registers are 32 bits wide.
12133 @item -mgp64
12134 @opindex mgp64
12135 Assume that general-purpose registers are 64 bits wide.
12137 @item -mfp32
12138 @opindex mfp32
12139 Assume that floating-point registers are 32 bits wide.
12141 @item -mfp64
12142 @opindex mfp64
12143 Assume that floating-point registers are 64 bits wide.
12145 @item -mhard-float
12146 @opindex mhard-float
12147 Use floating-point coprocessor instructions.
12149 @item -msoft-float
12150 @opindex msoft-float
12151 Do not use floating-point coprocessor instructions.  Implement
12152 floating-point calculations using library calls instead.
12154 @item -msingle-float
12155 @opindex msingle-float
12156 Assume that the floating-point coprocessor only supports single-precision
12157 operations.
12159 @item -mdouble-float
12160 @opindex mdouble-float
12161 Assume that the floating-point coprocessor supports double-precision
12162 operations.  This is the default.
12164 @item -mllsc
12165 @itemx -mno-llsc
12166 @opindex mllsc
12167 @opindex mno-llsc
12168 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12169 implement atomic memory built-in functions.  When neither option is
12170 specified, GCC will use the instructions if the target architecture
12171 supports them.
12173 @option{-mllsc} is useful if the runtime environment can emulate the
12174 instructions and @option{-mno-llsc} can be useful when compiling for
12175 nonstandard ISAs.  You can make either option the default by
12176 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12177 respectively.  @option{--with-llsc} is the default for some
12178 configurations; see the installation documentation for details.
12180 @item -mdsp
12181 @itemx -mno-dsp
12182 @opindex mdsp
12183 @opindex mno-dsp
12184 Use (do not use) revision 1 of the MIPS DSP ASE@.
12185 @xref{MIPS DSP Built-in Functions}.  This option defines the
12186 preprocessor macro @samp{__mips_dsp}.  It also defines
12187 @samp{__mips_dsp_rev} to 1.
12189 @item -mdspr2
12190 @itemx -mno-dspr2
12191 @opindex mdspr2
12192 @opindex mno-dspr2
12193 Use (do not use) revision 2 of the MIPS DSP ASE@.
12194 @xref{MIPS DSP Built-in Functions}.  This option defines the
12195 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12196 It also defines @samp{__mips_dsp_rev} to 2.
12198 @item -msmartmips
12199 @itemx -mno-smartmips
12200 @opindex msmartmips
12201 @opindex mno-smartmips
12202 Use (do not use) the MIPS SmartMIPS ASE.
12204 @item -mpaired-single
12205 @itemx -mno-paired-single
12206 @opindex mpaired-single
12207 @opindex mno-paired-single
12208 Use (do not use) paired-single floating-point instructions.
12209 @xref{MIPS Paired-Single Support}.  This option requires
12210 hardware floating-point support to be enabled.
12212 @item -mdmx
12213 @itemx -mno-mdmx
12214 @opindex mdmx
12215 @opindex mno-mdmx
12216 Use (do not use) MIPS Digital Media Extension instructions.
12217 This option can only be used when generating 64-bit code and requires
12218 hardware floating-point support to be enabled.
12220 @item -mips3d
12221 @itemx -mno-mips3d
12222 @opindex mips3d
12223 @opindex mno-mips3d
12224 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12225 The option @option{-mips3d} implies @option{-mpaired-single}.
12227 @item -mmt
12228 @itemx -mno-mt
12229 @opindex mmt
12230 @opindex mno-mt
12231 Use (do not use) MT Multithreading instructions.
12233 @item -mlong64
12234 @opindex mlong64
12235 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12236 an explanation of the default and the way that the pointer size is
12237 determined.
12239 @item -mlong32
12240 @opindex mlong32
12241 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12243 The default size of @code{int}s, @code{long}s and pointers depends on
12244 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12245 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12246 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12247 or the same size as integer registers, whichever is smaller.
12249 @item -msym32
12250 @itemx -mno-sym32
12251 @opindex msym32
12252 @opindex mno-sym32
12253 Assume (do not assume) that all symbols have 32-bit values, regardless
12254 of the selected ABI@.  This option is useful in combination with
12255 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12256 to generate shorter and faster references to symbolic addresses.
12258 @item -G @var{num}
12259 @opindex G
12260 Put definitions of externally-visible data in a small data section
12261 if that data is no bigger than @var{num} bytes.  GCC can then access
12262 the data more efficiently; see @option{-mgpopt} for details.
12264 The default @option{-G} option depends on the configuration.
12266 @item -mlocal-sdata
12267 @itemx -mno-local-sdata
12268 @opindex mlocal-sdata
12269 @opindex mno-local-sdata
12270 Extend (do not extend) the @option{-G} behavior to local data too,
12271 such as to static variables in C@.  @option{-mlocal-sdata} is the
12272 default for all configurations.
12274 If the linker complains that an application is using too much small data,
12275 you might want to try rebuilding the less performance-critical parts with
12276 @option{-mno-local-sdata}.  You might also want to build large
12277 libraries with @option{-mno-local-sdata}, so that the libraries leave
12278 more room for the main program.
12280 @item -mextern-sdata
12281 @itemx -mno-extern-sdata
12282 @opindex mextern-sdata
12283 @opindex mno-extern-sdata
12284 Assume (do not assume) that externally-defined data will be in
12285 a small data section if that data is within the @option{-G} limit.
12286 @option{-mextern-sdata} is the default for all configurations.
12288 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12289 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12290 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12291 is placed in a small data section.  If @var{Var} is defined by another
12292 module, you must either compile that module with a high-enough
12293 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12294 definition.  If @var{Var} is common, you must link the application
12295 with a high-enough @option{-G} setting.
12297 The easiest way of satisfying these restrictions is to compile
12298 and link every module with the same @option{-G} option.  However,
12299 you may wish to build a library that supports several different
12300 small data limits.  You can do this by compiling the library with
12301 the highest supported @option{-G} setting and additionally using
12302 @option{-mno-extern-sdata} to stop the library from making assumptions
12303 about externally-defined data.
12305 @item -mgpopt
12306 @itemx -mno-gpopt
12307 @opindex mgpopt
12308 @opindex mno-gpopt
12309 Use (do not use) GP-relative accesses for symbols that are known to be
12310 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12311 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12312 configurations.
12314 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12315 might not hold the value of @code{_gp}.  For example, if the code is
12316 part of a library that might be used in a boot monitor, programs that
12317 call boot monitor routines will pass an unknown value in @code{$gp}.
12318 (In such situations, the boot monitor itself would usually be compiled
12319 with @option{-G0}.)
12321 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12322 @option{-mno-extern-sdata}.
12324 @item -membedded-data
12325 @itemx -mno-embedded-data
12326 @opindex membedded-data
12327 @opindex mno-embedded-data
12328 Allocate variables to the read-only data section first if possible, then
12329 next in the small data section if possible, otherwise in data.  This gives
12330 slightly slower code than the default, but reduces the amount of RAM required
12331 when executing, and thus may be preferred for some embedded systems.
12333 @item -muninit-const-in-rodata
12334 @itemx -mno-uninit-const-in-rodata
12335 @opindex muninit-const-in-rodata
12336 @opindex mno-uninit-const-in-rodata
12337 Put uninitialized @code{const} variables in the read-only data section.
12338 This option is only meaningful in conjunction with @option{-membedded-data}.
12340 @item -mcode-readable=@var{setting}
12341 @opindex mcode-readable
12342 Specify whether GCC may generate code that reads from executable sections.
12343 There are three possible settings:
12345 @table @gcctabopt
12346 @item -mcode-readable=yes
12347 Instructions may freely access executable sections.  This is the
12348 default setting.
12350 @item -mcode-readable=pcrel
12351 MIPS16 PC-relative load instructions can access executable sections,
12352 but other instructions must not do so.  This option is useful on 4KSc
12353 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12354 It is also useful on processors that can be configured to have a dual
12355 instruction/data SRAM interface and that, like the M4K, automatically
12356 redirect PC-relative loads to the instruction RAM.
12358 @item -mcode-readable=no
12359 Instructions must not access executable sections.  This option can be
12360 useful on targets that are configured to have a dual instruction/data
12361 SRAM interface but that (unlike the M4K) do not automatically redirect
12362 PC-relative loads to the instruction RAM.
12363 @end table
12365 @item -msplit-addresses
12366 @itemx -mno-split-addresses
12367 @opindex msplit-addresses
12368 @opindex mno-split-addresses
12369 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12370 relocation operators.  This option has been superseded by
12371 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12373 @item -mexplicit-relocs
12374 @itemx -mno-explicit-relocs
12375 @opindex mexplicit-relocs
12376 @opindex mno-explicit-relocs
12377 Use (do not use) assembler relocation operators when dealing with symbolic
12378 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12379 is to use assembler macros instead.
12381 @option{-mexplicit-relocs} is the default if GCC was configured
12382 to use an assembler that supports relocation operators.
12384 @item -mcheck-zero-division
12385 @itemx -mno-check-zero-division
12386 @opindex mcheck-zero-division
12387 @opindex mno-check-zero-division
12388 Trap (do not trap) on integer division by zero.
12390 The default is @option{-mcheck-zero-division}.
12392 @item -mdivide-traps
12393 @itemx -mdivide-breaks
12394 @opindex mdivide-traps
12395 @opindex mdivide-breaks
12396 MIPS systems check for division by zero by generating either a
12397 conditional trap or a break instruction.  Using traps results in
12398 smaller code, but is only supported on MIPS II and later.  Also, some
12399 versions of the Linux kernel have a bug that prevents trap from
12400 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12401 allow conditional traps on architectures that support them and
12402 @option{-mdivide-breaks} to force the use of breaks.
12404 The default is usually @option{-mdivide-traps}, but this can be
12405 overridden at configure time using @option{--with-divide=breaks}.
12406 Divide-by-zero checks can be completely disabled using
12407 @option{-mno-check-zero-division}.
12409 @item -mmemcpy
12410 @itemx -mno-memcpy
12411 @opindex mmemcpy
12412 @opindex mno-memcpy
12413 Force (do not force) the use of @code{memcpy()} for non-trivial block
12414 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12415 most constant-sized copies.
12417 @item -mlong-calls
12418 @itemx -mno-long-calls
12419 @opindex mlong-calls
12420 @opindex mno-long-calls
12421 Disable (do not disable) use of the @code{jal} instruction.  Calling
12422 functions using @code{jal} is more efficient but requires the caller
12423 and callee to be in the same 256 megabyte segment.
12425 This option has no effect on abicalls code.  The default is
12426 @option{-mno-long-calls}.
12428 @item -mmad
12429 @itemx -mno-mad
12430 @opindex mmad
12431 @opindex mno-mad
12432 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12433 instructions, as provided by the R4650 ISA@.
12435 @item -mfused-madd
12436 @itemx -mno-fused-madd
12437 @opindex mfused-madd
12438 @opindex mno-fused-madd
12439 Enable (disable) use of the floating point multiply-accumulate
12440 instructions, when they are available.  The default is
12441 @option{-mfused-madd}.
12443 When multiply-accumulate instructions are used, the intermediate
12444 product is calculated to infinite precision and is not subject to
12445 the FCSR Flush to Zero bit.  This may be undesirable in some
12446 circumstances.
12448 @item -nocpp
12449 @opindex nocpp
12450 Tell the MIPS assembler to not run its preprocessor over user
12451 assembler files (with a @samp{.s} suffix) when assembling them.
12453 @item -mfix-r4000
12454 @itemx -mno-fix-r4000
12455 @opindex mfix-r4000
12456 @opindex mno-fix-r4000
12457 Work around certain R4000 CPU errata:
12458 @itemize @minus
12459 @item
12460 A double-word or a variable shift may give an incorrect result if executed
12461 immediately after starting an integer division.
12462 @item
12463 A double-word or a variable shift may give an incorrect result if executed
12464 while an integer multiplication is in progress.
12465 @item
12466 An integer division may give an incorrect result if started in a delay slot
12467 of a taken branch or a jump.
12468 @end itemize
12470 @item -mfix-r4400
12471 @itemx -mno-fix-r4400
12472 @opindex mfix-r4400
12473 @opindex mno-fix-r4400
12474 Work around certain R4400 CPU errata:
12475 @itemize @minus
12476 @item
12477 A double-word or a variable shift may give an incorrect result if executed
12478 immediately after starting an integer division.
12479 @end itemize
12481 @item -mfix-vr4120
12482 @itemx -mno-fix-vr4120
12483 @opindex mfix-vr4120
12484 Work around certain VR4120 errata:
12485 @itemize @minus
12486 @item
12487 @code{dmultu} does not always produce the correct result.
12488 @item
12489 @code{div} and @code{ddiv} do not always produce the correct result if one
12490 of the operands is negative.
12491 @end itemize
12492 The workarounds for the division errata rely on special functions in
12493 @file{libgcc.a}.  At present, these functions are only provided by
12494 the @code{mips64vr*-elf} configurations.
12496 Other VR4120 errata require a nop to be inserted between certain pairs of
12497 instructions.  These errata are handled by the assembler, not by GCC itself.
12499 @item -mfix-vr4130
12500 @opindex mfix-vr4130
12501 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12502 workarounds are implemented by the assembler rather than by GCC,
12503 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12504 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12505 instructions are available instead.
12507 @item -mfix-sb1
12508 @itemx -mno-fix-sb1
12509 @opindex mfix-sb1
12510 Work around certain SB-1 CPU core errata.
12511 (This flag currently works around the SB-1 revision 2
12512 ``F1'' and ``F2'' floating point errata.)
12514 @item -mflush-func=@var{func}
12515 @itemx -mno-flush-func
12516 @opindex mflush-func
12517 Specifies the function to call to flush the I and D caches, or to not
12518 call any such function.  If called, the function must take the same
12519 arguments as the common @code{_flush_func()}, that is, the address of the
12520 memory range for which the cache is being flushed, the size of the
12521 memory range, and the number 3 (to flush both caches).  The default
12522 depends on the target GCC was configured for, but commonly is either
12523 @samp{_flush_func} or @samp{__cpu_flush}.
12525 @item mbranch-cost=@var{num}
12526 @opindex mbranch-cost
12527 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12528 This cost is only a heuristic and is not guaranteed to produce
12529 consistent results across releases.  A zero cost redundantly selects
12530 the default, which is based on the @option{-mtune} setting.
12532 @item -mbranch-likely
12533 @itemx -mno-branch-likely
12534 @opindex mbranch-likely
12535 @opindex mno-branch-likely
12536 Enable or disable use of Branch Likely instructions, regardless of the
12537 default for the selected architecture.  By default, Branch Likely
12538 instructions may be generated if they are supported by the selected
12539 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12540 and processors which implement those architectures; for those, Branch
12541 Likely instructions will not be generated by default because the MIPS32
12542 and MIPS64 architectures specifically deprecate their use.
12544 @item -mfp-exceptions
12545 @itemx -mno-fp-exceptions
12546 @opindex mfp-exceptions
12547 Specifies whether FP exceptions are enabled.  This affects how we schedule
12548 FP instructions for some processors.  The default is that FP exceptions are
12549 enabled.
12551 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12552 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12553 FP pipe.
12555 @item -mvr4130-align
12556 @itemx -mno-vr4130-align
12557 @opindex mvr4130-align
12558 The VR4130 pipeline is two-way superscalar, but can only issue two
12559 instructions together if the first one is 8-byte aligned.  When this
12560 option is enabled, GCC will align pairs of instructions that it
12561 thinks should execute in parallel.
12563 This option only has an effect when optimizing for the VR4130.
12564 It normally makes code faster, but at the expense of making it bigger.
12565 It is enabled by default at optimization level @option{-O3}.
12566 @end table
12568 @node MMIX Options
12569 @subsection MMIX Options
12570 @cindex MMIX Options
12572 These options are defined for the MMIX:
12574 @table @gcctabopt
12575 @item -mlibfuncs
12576 @itemx -mno-libfuncs
12577 @opindex mlibfuncs
12578 @opindex mno-libfuncs
12579 Specify that intrinsic library functions are being compiled, passing all
12580 values in registers, no matter the size.
12582 @item -mepsilon
12583 @itemx -mno-epsilon
12584 @opindex mepsilon
12585 @opindex mno-epsilon
12586 Generate floating-point comparison instructions that compare with respect
12587 to the @code{rE} epsilon register.
12589 @item -mabi=mmixware
12590 @itemx -mabi=gnu
12591 @opindex mabi-mmixware
12592 @opindex mabi=gnu
12593 Generate code that passes function parameters and return values that (in
12594 the called function) are seen as registers @code{$0} and up, as opposed to
12595 the GNU ABI which uses global registers @code{$231} and up.
12597 @item -mzero-extend
12598 @itemx -mno-zero-extend
12599 @opindex mzero-extend
12600 @opindex mno-zero-extend
12601 When reading data from memory in sizes shorter than 64 bits, use (do not
12602 use) zero-extending load instructions by default, rather than
12603 sign-extending ones.
12605 @item -mknuthdiv
12606 @itemx -mno-knuthdiv
12607 @opindex mknuthdiv
12608 @opindex mno-knuthdiv
12609 Make the result of a division yielding a remainder have the same sign as
12610 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12611 remainder follows the sign of the dividend.  Both methods are
12612 arithmetically valid, the latter being almost exclusively used.
12614 @item -mtoplevel-symbols
12615 @itemx -mno-toplevel-symbols
12616 @opindex mtoplevel-symbols
12617 @opindex mno-toplevel-symbols
12618 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12619 code can be used with the @code{PREFIX} assembly directive.
12621 @item -melf
12622 @opindex melf
12623 Generate an executable in the ELF format, rather than the default
12624 @samp{mmo} format used by the @command{mmix} simulator.
12626 @item -mbranch-predict
12627 @itemx -mno-branch-predict
12628 @opindex mbranch-predict
12629 @opindex mno-branch-predict
12630 Use (do not use) the probable-branch instructions, when static branch
12631 prediction indicates a probable branch.
12633 @item -mbase-addresses
12634 @itemx -mno-base-addresses
12635 @opindex mbase-addresses
12636 @opindex mno-base-addresses
12637 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12638 base address automatically generates a request (handled by the assembler
12639 and the linker) for a constant to be set up in a global register.  The
12640 register is used for one or more base address requests within the range 0
12641 to 255 from the value held in the register.  The generally leads to short
12642 and fast code, but the number of different data items that can be
12643 addressed is limited.  This means that a program that uses lots of static
12644 data may require @option{-mno-base-addresses}.
12646 @item -msingle-exit
12647 @itemx -mno-single-exit
12648 @opindex msingle-exit
12649 @opindex mno-single-exit
12650 Force (do not force) generated code to have a single exit point in each
12651 function.
12652 @end table
12654 @node MN10300 Options
12655 @subsection MN10300 Options
12656 @cindex MN10300 options
12658 These @option{-m} options are defined for Matsushita MN10300 architectures:
12660 @table @gcctabopt
12661 @item -mmult-bug
12662 @opindex mmult-bug
12663 Generate code to avoid bugs in the multiply instructions for the MN10300
12664 processors.  This is the default.
12666 @item -mno-mult-bug
12667 @opindex mno-mult-bug
12668 Do not generate code to avoid bugs in the multiply instructions for the
12669 MN10300 processors.
12671 @item -mam33
12672 @opindex mam33
12673 Generate code which uses features specific to the AM33 processor.
12675 @item -mno-am33
12676 @opindex mno-am33
12677 Do not generate code which uses features specific to the AM33 processor.  This
12678 is the default.
12680 @item -mreturn-pointer-on-d0
12681 @opindex mreturn-pointer-on-d0
12682 When generating a function which returns a pointer, return the pointer
12683 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12684 only in a0, and attempts to call such functions without a prototype
12685 would result in errors.  Note that this option is on by default; use
12686 @option{-mno-return-pointer-on-d0} to disable it.
12688 @item -mno-crt0
12689 @opindex mno-crt0
12690 Do not link in the C run-time initialization object file.
12692 @item -mrelax
12693 @opindex mrelax
12694 Indicate to the linker that it should perform a relaxation optimization pass
12695 to shorten branches, calls and absolute memory addresses.  This option only
12696 has an effect when used on the command line for the final link step.
12698 This option makes symbolic debugging impossible.
12699 @end table
12701 @node MT Options
12702 @subsection MT Options
12703 @cindex MT options
12705 These @option{-m} options are defined for Morpho MT architectures:
12707 @table @gcctabopt
12709 @item -march=@var{cpu-type}
12710 @opindex march
12711 Generate code that will run on @var{cpu-type}, which is the name of a system
12712 representing a certain processor type.  Possible values for
12713 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12714 @samp{ms1-16-003} and @samp{ms2}.
12716 When this option is not used, the default is @option{-march=ms1-16-002}.
12718 @item -mbacc
12719 @opindex mbacc
12720 Use byte loads and stores when generating code.
12722 @item -mno-bacc
12723 @opindex mno-bacc
12724 Do not use byte loads and stores when generating code.
12726 @item -msim
12727 @opindex msim
12728 Use simulator runtime
12730 @item -mno-crt0
12731 @opindex mno-crt0
12732 Do not link in the C run-time initialization object file
12733 @file{crti.o}.  Other run-time initialization and termination files
12734 such as @file{startup.o} and @file{exit.o} are still included on the
12735 linker command line.
12737 @end table
12739 @node PDP-11 Options
12740 @subsection PDP-11 Options
12741 @cindex PDP-11 Options
12743 These options are defined for the PDP-11:
12745 @table @gcctabopt
12746 @item -mfpu
12747 @opindex mfpu
12748 Use hardware FPP floating point.  This is the default.  (FIS floating
12749 point on the PDP-11/40 is not supported.)
12751 @item -msoft-float
12752 @opindex msoft-float
12753 Do not use hardware floating point.
12755 @item -mac0
12756 @opindex mac0
12757 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12759 @item -mno-ac0
12760 @opindex mno-ac0
12761 Return floating-point results in memory.  This is the default.
12763 @item -m40
12764 @opindex m40
12765 Generate code for a PDP-11/40.
12767 @item -m45
12768 @opindex m45
12769 Generate code for a PDP-11/45.  This is the default.
12771 @item -m10
12772 @opindex m10
12773 Generate code for a PDP-11/10.
12775 @item -mbcopy-builtin
12776 @opindex bcopy-builtin
12777 Use inline @code{movmemhi} patterns for copying memory.  This is the
12778 default.
12780 @item -mbcopy
12781 @opindex mbcopy
12782 Do not use inline @code{movmemhi} patterns for copying memory.
12784 @item -mint16
12785 @itemx -mno-int32
12786 @opindex mint16
12787 @opindex mno-int32
12788 Use 16-bit @code{int}.  This is the default.
12790 @item -mint32
12791 @itemx -mno-int16
12792 @opindex mint32
12793 @opindex mno-int16
12794 Use 32-bit @code{int}.
12796 @item -mfloat64
12797 @itemx -mno-float32
12798 @opindex mfloat64
12799 @opindex mno-float32
12800 Use 64-bit @code{float}.  This is the default.
12802 @item -mfloat32
12803 @itemx -mno-float64
12804 @opindex mfloat32
12805 @opindex mno-float64
12806 Use 32-bit @code{float}.
12808 @item -mabshi
12809 @opindex mabshi
12810 Use @code{abshi2} pattern.  This is the default.
12812 @item -mno-abshi
12813 @opindex mno-abshi
12814 Do not use @code{abshi2} pattern.
12816 @item -mbranch-expensive
12817 @opindex mbranch-expensive
12818 Pretend that branches are expensive.  This is for experimenting with
12819 code generation only.
12821 @item -mbranch-cheap
12822 @opindex mbranch-cheap
12823 Do not pretend that branches are expensive.  This is the default.
12825 @item -msplit
12826 @opindex msplit
12827 Generate code for a system with split I&D@.
12829 @item -mno-split
12830 @opindex mno-split
12831 Generate code for a system without split I&D@.  This is the default.
12833 @item -munix-asm
12834 @opindex munix-asm
12835 Use Unix assembler syntax.  This is the default when configured for
12836 @samp{pdp11-*-bsd}.
12838 @item -mdec-asm
12839 @opindex mdec-asm
12840 Use DEC assembler syntax.  This is the default when configured for any
12841 PDP-11 target other than @samp{pdp11-*-bsd}.
12842 @end table
12844 @node PowerPC Options
12845 @subsection PowerPC Options
12846 @cindex PowerPC options
12848 These are listed under @xref{RS/6000 and PowerPC Options}.
12850 @node RS/6000 and PowerPC Options
12851 @subsection IBM RS/6000 and PowerPC Options
12852 @cindex RS/6000 and PowerPC Options
12853 @cindex IBM RS/6000 and PowerPC Options
12855 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12856 @table @gcctabopt
12857 @item -mpower
12858 @itemx -mno-power
12859 @itemx -mpower2
12860 @itemx -mno-power2
12861 @itemx -mpowerpc
12862 @itemx -mno-powerpc
12863 @itemx -mpowerpc-gpopt
12864 @itemx -mno-powerpc-gpopt
12865 @itemx -mpowerpc-gfxopt
12866 @itemx -mno-powerpc-gfxopt
12867 @itemx -mpowerpc64
12868 @itemx -mno-powerpc64
12869 @itemx -mmfcrf
12870 @itemx -mno-mfcrf
12871 @itemx -mpopcntb
12872 @itemx -mno-popcntb
12873 @itemx -mfprnd
12874 @itemx -mno-fprnd
12875 @itemx -mcmpb
12876 @itemx -mno-cmpb
12877 @itemx -mmfpgpr
12878 @itemx -mno-mfpgpr
12879 @itemx -mhard-dfp
12880 @itemx -mno-hard-dfp
12881 @opindex mpower
12882 @opindex mno-power
12883 @opindex mpower2
12884 @opindex mno-power2
12885 @opindex mpowerpc
12886 @opindex mno-powerpc
12887 @opindex mpowerpc-gpopt
12888 @opindex mno-powerpc-gpopt
12889 @opindex mpowerpc-gfxopt
12890 @opindex mno-powerpc-gfxopt
12891 @opindex mpowerpc64
12892 @opindex mno-powerpc64
12893 @opindex mmfcrf
12894 @opindex mno-mfcrf
12895 @opindex mpopcntb
12896 @opindex mno-popcntb
12897 @opindex mfprnd
12898 @opindex mno-fprnd
12899 @opindex mcmpb
12900 @opindex mno-cmpb
12901 @opindex mmfpgpr
12902 @opindex mno-mfpgpr
12903 @opindex mhard-dfp
12904 @opindex mno-hard-dfp
12905 GCC supports two related instruction set architectures for the
12906 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12907 instructions supported by the @samp{rios} chip set used in the original
12908 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12909 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12910 the IBM 4xx, 6xx, and follow-on microprocessors.
12912 Neither architecture is a subset of the other.  However there is a
12913 large common subset of instructions supported by both.  An MQ
12914 register is included in processors supporting the POWER architecture.
12916 You use these options to specify which instructions are available on the
12917 processor you are using.  The default value of these options is
12918 determined when configuring GCC@.  Specifying the
12919 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12920 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12921 rather than the options listed above.
12923 The @option{-mpower} option allows GCC to generate instructions that
12924 are found only in the POWER architecture and to use the MQ register.
12925 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12926 to generate instructions that are present in the POWER2 architecture but
12927 not the original POWER architecture.
12929 The @option{-mpowerpc} option allows GCC to generate instructions that
12930 are found only in the 32-bit subset of the PowerPC architecture.
12931 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12932 GCC to use the optional PowerPC architecture instructions in the
12933 General Purpose group, including floating-point square root.  Specifying
12934 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12935 use the optional PowerPC architecture instructions in the Graphics
12936 group, including floating-point select.
12938 The @option{-mmfcrf} option allows GCC to generate the move from
12939 condition register field instruction implemented on the POWER4
12940 processor and other processors that support the PowerPC V2.01
12941 architecture.
12942 The @option{-mpopcntb} option allows GCC to generate the popcount and
12943 double precision FP reciprocal estimate instruction implemented on the
12944 POWER5 processor and other processors that support the PowerPC V2.02
12945 architecture.
12946 The @option{-mfprnd} option allows GCC to generate the FP round to
12947 integer instructions implemented on the POWER5+ processor and other
12948 processors that support the PowerPC V2.03 architecture.
12949 The @option{-mcmpb} option allows GCC to generate the compare bytes
12950 instruction implemented on the POWER6 processor and other processors
12951 that support the PowerPC V2.05 architecture.
12952 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12953 general purpose register instructions implemented on the POWER6X
12954 processor and other processors that support the extended PowerPC V2.05
12955 architecture.
12956 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12957 point instructions implemented on some POWER processors.
12959 The @option{-mpowerpc64} option allows GCC to generate the additional
12960 64-bit instructions that are found in the full PowerPC64 architecture
12961 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12962 @option{-mno-powerpc64}.
12964 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12965 will use only the instructions in the common subset of both
12966 architectures plus some special AIX common-mode calls, and will not use
12967 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12968 permits GCC to use any instruction from either architecture and to
12969 allow use of the MQ register; specify this for the Motorola MPC601.
12971 @item -mnew-mnemonics
12972 @itemx -mold-mnemonics
12973 @opindex mnew-mnemonics
12974 @opindex mold-mnemonics
12975 Select which mnemonics to use in the generated assembler code.  With
12976 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12977 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12978 assembler mnemonics defined for the POWER architecture.  Instructions
12979 defined in only one architecture have only one mnemonic; GCC uses that
12980 mnemonic irrespective of which of these options is specified.
12982 GCC defaults to the mnemonics appropriate for the architecture in
12983 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12984 value of these option.  Unless you are building a cross-compiler, you
12985 should normally not specify either @option{-mnew-mnemonics} or
12986 @option{-mold-mnemonics}, but should instead accept the default.
12988 @item -mcpu=@var{cpu_type}
12989 @opindex mcpu
12990 Set architecture type, register usage, choice of mnemonics, and
12991 instruction scheduling parameters for machine type @var{cpu_type}.
12992 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12993 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
12994 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12995 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12996 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12997 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
12998 @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, @samp{power},
12999 @samp{power2}, @samp{power3}, @samp{power4}, @samp{power5},
13000 @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{common},
13001 @samp{powerpc}, @samp{powerpc64}, @samp{rios}, @samp{rios1},
13002 @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13004 @option{-mcpu=common} selects a completely generic processor.  Code
13005 generated under this option will run on any POWER or PowerPC processor.
13006 GCC will use only the instructions in the common subset of both
13007 architectures, and will not use the MQ register.  GCC assumes a generic
13008 processor model for scheduling purposes.
13010 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13011 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13012 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13013 types, with an appropriate, generic processor model assumed for
13014 scheduling purposes.
13016 The other options specify a specific processor.  Code generated under
13017 those options will run best on that processor, and may not run at all on
13018 others.
13020 The @option{-mcpu} options automatically enable or disable the
13021 following options:
13023 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13024 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13025 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13027 The particular options set for any particular CPU will vary between
13028 compiler versions, depending on what setting seems to produce optimal
13029 code for that CPU; it doesn't necessarily reflect the actual hardware's
13030 capabilities.  If you wish to set an individual option to a particular
13031 value, you may specify it after the @option{-mcpu} option, like
13032 @samp{-mcpu=970 -mno-altivec}.
13034 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13035 not enabled or disabled by the @option{-mcpu} option at present because
13036 AIX does not have full support for these options.  You may still
13037 enable or disable them individually if you're sure it'll work in your
13038 environment.
13040 @item -mtune=@var{cpu_type}
13041 @opindex mtune
13042 Set the instruction scheduling parameters for machine type
13043 @var{cpu_type}, but do not set the architecture type, register usage, or
13044 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13045 values for @var{cpu_type} are used for @option{-mtune} as for
13046 @option{-mcpu}.  If both are specified, the code generated will use the
13047 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13048 scheduling parameters set by @option{-mtune}.
13050 @item -mswdiv
13051 @itemx -mno-swdiv
13052 @opindex mswdiv
13053 @opindex mno-swdiv
13054 Generate code to compute division as reciprocal estimate and iterative
13055 refinement, creating opportunities for increased throughput.  This
13056 feature requires: optional PowerPC Graphics instruction set for single
13057 precision and FRE instruction for double precision, assuming divides
13058 cannot generate user-visible traps, and the domain values not include
13059 Infinities, denormals or zero denominator.
13061 @item -maltivec
13062 @itemx -mno-altivec
13063 @opindex maltivec
13064 @opindex mno-altivec
13065 Generate code that uses (does not use) AltiVec instructions, and also
13066 enable the use of built-in functions that allow more direct access to
13067 the AltiVec instruction set.  You may also need to set
13068 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13069 enhancements.
13071 @item -mvrsave
13072 @itemx -mno-vrsave
13073 @opindex mvrsave
13074 @opindex mno-vrsave
13075 Generate VRSAVE instructions when generating AltiVec code.
13077 @item -msecure-plt
13078 @opindex msecure-plt
13079 Generate code that allows ld and ld.so to build executables and shared
13080 libraries with non-exec .plt and .got sections.  This is a PowerPC
13081 32-bit SYSV ABI option.
13083 @item -mbss-plt
13084 @opindex mbss-plt
13085 Generate code that uses a BSS .plt section that ld.so fills in, and
13086 requires .plt and .got sections that are both writable and executable.
13087 This is a PowerPC 32-bit SYSV ABI option.
13089 @item -misel
13090 @itemx -mno-isel
13091 @opindex misel
13092 @opindex mno-isel
13093 This switch enables or disables the generation of ISEL instructions.
13095 @item -misel=@var{yes/no}
13096 This switch has been deprecated.  Use @option{-misel} and
13097 @option{-mno-isel} instead.
13099 @item -mspe
13100 @itemx -mno-spe
13101 @opindex mspe
13102 @opindex mno-spe
13103 This switch enables or disables the generation of SPE simd
13104 instructions.
13106 @item -mpaired
13107 @itemx -mno-paired
13108 @opindex mpaired
13109 @opindex mno-paired
13110 This switch enables or disables the generation of PAIRED simd
13111 instructions.
13113 @item -mspe=@var{yes/no}
13114 This option has been deprecated.  Use @option{-mspe} and
13115 @option{-mno-spe} instead.
13117 @item -mfloat-gprs=@var{yes/single/double/no}
13118 @itemx -mfloat-gprs
13119 @opindex mfloat-gprs
13120 This switch enables or disables the generation of floating point
13121 operations on the general purpose registers for architectures that
13122 support it.
13124 The argument @var{yes} or @var{single} enables the use of
13125 single-precision floating point operations.
13127 The argument @var{double} enables the use of single and
13128 double-precision floating point operations.
13130 The argument @var{no} disables floating point operations on the
13131 general purpose registers.
13133 This option is currently only available on the MPC854x.
13135 @item -m32
13136 @itemx -m64
13137 @opindex m32
13138 @opindex m64
13139 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13140 targets (including GNU/Linux).  The 32-bit environment sets int, long
13141 and pointer to 32 bits and generates code that runs on any PowerPC
13142 variant.  The 64-bit environment sets int to 32 bits and long and
13143 pointer to 64 bits, and generates code for PowerPC64, as for
13144 @option{-mpowerpc64}.
13146 @item -mfull-toc
13147 @itemx -mno-fp-in-toc
13148 @itemx -mno-sum-in-toc
13149 @itemx -mminimal-toc
13150 @opindex mfull-toc
13151 @opindex mno-fp-in-toc
13152 @opindex mno-sum-in-toc
13153 @opindex mminimal-toc
13154 Modify generation of the TOC (Table Of Contents), which is created for
13155 every executable file.  The @option{-mfull-toc} option is selected by
13156 default.  In that case, GCC will allocate at least one TOC entry for
13157 each unique non-automatic variable reference in your program.  GCC
13158 will also place floating-point constants in the TOC@.  However, only
13159 16,384 entries are available in the TOC@.
13161 If you receive a linker error message that saying you have overflowed
13162 the available TOC space, you can reduce the amount of TOC space used
13163 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13164 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13165 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13166 generate code to calculate the sum of an address and a constant at
13167 run-time instead of putting that sum into the TOC@.  You may specify one
13168 or both of these options.  Each causes GCC to produce very slightly
13169 slower and larger code at the expense of conserving TOC space.
13171 If you still run out of space in the TOC even when you specify both of
13172 these options, specify @option{-mminimal-toc} instead.  This option causes
13173 GCC to make only one TOC entry for every file.  When you specify this
13174 option, GCC will produce code that is slower and larger but which
13175 uses extremely little TOC space.  You may wish to use this option
13176 only on files that contain less frequently executed code.
13178 @item -maix64
13179 @itemx -maix32
13180 @opindex maix64
13181 @opindex maix32
13182 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13183 @code{long} type, and the infrastructure needed to support them.
13184 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13185 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13186 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13188 @item -mxl-compat
13189 @itemx -mno-xl-compat
13190 @opindex mxl-compat
13191 @opindex mno-xl-compat
13192 Produce code that conforms more closely to IBM XL compiler semantics
13193 when using AIX-compatible ABI@.  Pass floating-point arguments to
13194 prototyped functions beyond the register save area (RSA) on the stack
13195 in addition to argument FPRs.  Do not assume that most significant
13196 double in 128-bit long double value is properly rounded when comparing
13197 values and converting to double.  Use XL symbol names for long double
13198 support routines.
13200 The AIX calling convention was extended but not initially documented to
13201 handle an obscure K&R C case of calling a function that takes the
13202 address of its arguments with fewer arguments than declared.  IBM XL
13203 compilers access floating point arguments which do not fit in the
13204 RSA from the stack when a subroutine is compiled without
13205 optimization.  Because always storing floating-point arguments on the
13206 stack is inefficient and rarely needed, this option is not enabled by
13207 default and only is necessary when calling subroutines compiled by IBM
13208 XL compilers without optimization.
13210 @item -mpe
13211 @opindex mpe
13212 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13213 application written to use message passing with special startup code to
13214 enable the application to run.  The system must have PE installed in the
13215 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13216 must be overridden with the @option{-specs=} option to specify the
13217 appropriate directory location.  The Parallel Environment does not
13218 support threads, so the @option{-mpe} option and the @option{-pthread}
13219 option are incompatible.
13221 @item -malign-natural
13222 @itemx -malign-power
13223 @opindex malign-natural
13224 @opindex malign-power
13225 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13226 @option{-malign-natural} overrides the ABI-defined alignment of larger
13227 types, such as floating-point doubles, on their natural size-based boundary.
13228 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13229 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13231 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13232 is not supported.
13234 @item -msoft-float
13235 @itemx -mhard-float
13236 @opindex msoft-float
13237 @opindex mhard-float
13238 Generate code that does not use (uses) the floating-point register set.
13239 Software floating point emulation is provided if you use the
13240 @option{-msoft-float} option, and pass the option to GCC when linking.
13242 @item -mmultiple
13243 @itemx -mno-multiple
13244 @opindex mmultiple
13245 @opindex mno-multiple
13246 Generate code that uses (does not use) the load multiple word
13247 instructions and the store multiple word instructions.  These
13248 instructions are generated by default on POWER systems, and not
13249 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13250 endian PowerPC systems, since those instructions do not work when the
13251 processor is in little endian mode.  The exceptions are PPC740 and
13252 PPC750 which permit the instructions usage in little endian mode.
13254 @item -mstring
13255 @itemx -mno-string
13256 @opindex mstring
13257 @opindex mno-string
13258 Generate code that uses (does not use) the load string instructions
13259 and the store string word instructions to save multiple registers and
13260 do small block moves.  These instructions are generated by default on
13261 POWER systems, and not generated on PowerPC systems.  Do not use
13262 @option{-mstring} on little endian PowerPC systems, since those
13263 instructions do not work when the processor is in little endian mode.
13264 The exceptions are PPC740 and PPC750 which permit the instructions
13265 usage in little endian mode.
13267 @item -mupdate
13268 @itemx -mno-update
13269 @opindex mupdate
13270 @opindex mno-update
13271 Generate code that uses (does not use) the load or store instructions
13272 that update the base register to the address of the calculated memory
13273 location.  These instructions are generated by default.  If you use
13274 @option{-mno-update}, there is a small window between the time that the
13275 stack pointer is updated and the address of the previous frame is
13276 stored, which means code that walks the stack frame across interrupts or
13277 signals may get corrupted data.
13279 @item -mfused-madd
13280 @itemx -mno-fused-madd
13281 @opindex mfused-madd
13282 @opindex mno-fused-madd
13283 Generate code that uses (does not use) the floating point multiply and
13284 accumulate instructions.  These instructions are generated by default if
13285 hardware floating is used.
13287 @item -mmulhw
13288 @itemx -mno-mulhw
13289 @opindex mmulhw
13290 @opindex mno-mulhw
13291 Generate code that uses (does not use) the half-word multiply and
13292 multiply-accumulate instructions on the IBM 405 and 440 processors.
13293 These instructions are generated by default when targetting those
13294 processors.
13296 @item -mdlmzb
13297 @itemx -mno-dlmzb
13298 @opindex mdlmzb
13299 @opindex mno-dlmzb
13300 Generate code that uses (does not use) the string-search @samp{dlmzb}
13301 instruction on the IBM 405 and 440 processors.  This instruction is
13302 generated by default when targetting those processors.
13304 @item -mno-bit-align
13305 @itemx -mbit-align
13306 @opindex mno-bit-align
13307 @opindex mbit-align
13308 On System V.4 and embedded PowerPC systems do not (do) force structures
13309 and unions that contain bit-fields to be aligned to the base type of the
13310 bit-field.
13312 For example, by default a structure containing nothing but 8
13313 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13314 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13315 the structure would be aligned to a 1 byte boundary and be one byte in
13316 size.
13318 @item -mno-strict-align
13319 @itemx -mstrict-align
13320 @opindex mno-strict-align
13321 @opindex mstrict-align
13322 On System V.4 and embedded PowerPC systems do not (do) assume that
13323 unaligned memory references will be handled by the system.
13325 @item -mrelocatable
13326 @itemx -mno-relocatable
13327 @opindex mrelocatable
13328 @opindex mno-relocatable
13329 On embedded PowerPC systems generate code that allows (does not allow)
13330 the program to be relocated to a different address at runtime.  If you
13331 use @option{-mrelocatable} on any module, all objects linked together must
13332 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13334 @item -mrelocatable-lib
13335 @itemx -mno-relocatable-lib
13336 @opindex mrelocatable-lib
13337 @opindex mno-relocatable-lib
13338 On embedded PowerPC systems generate code that allows (does not allow)
13339 the program to be relocated to a different address at runtime.  Modules
13340 compiled with @option{-mrelocatable-lib} can be linked with either modules
13341 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13342 with modules compiled with the @option{-mrelocatable} options.
13344 @item -mno-toc
13345 @itemx -mtoc
13346 @opindex mno-toc
13347 @opindex mtoc
13348 On System V.4 and embedded PowerPC systems do not (do) assume that
13349 register 2 contains a pointer to a global area pointing to the addresses
13350 used in the program.
13352 @item -mlittle
13353 @itemx -mlittle-endian
13354 @opindex mlittle
13355 @opindex mlittle-endian
13356 On System V.4 and embedded PowerPC systems compile code for the
13357 processor in little endian mode.  The @option{-mlittle-endian} option is
13358 the same as @option{-mlittle}.
13360 @item -mbig
13361 @itemx -mbig-endian
13362 @opindex mbig
13363 @opindex mbig-endian
13364 On System V.4 and embedded PowerPC systems compile code for the
13365 processor in big endian mode.  The @option{-mbig-endian} option is
13366 the same as @option{-mbig}.
13368 @item -mdynamic-no-pic
13369 @opindex mdynamic-no-pic
13370 On Darwin and Mac OS X systems, compile code so that it is not
13371 relocatable, but that its external references are relocatable.  The
13372 resulting code is suitable for applications, but not shared
13373 libraries.
13375 @item -mprioritize-restricted-insns=@var{priority}
13376 @opindex mprioritize-restricted-insns
13377 This option controls the priority that is assigned to
13378 dispatch-slot restricted instructions during the second scheduling
13379 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13380 @var{no/highest/second-highest} priority to dispatch slot restricted
13381 instructions.
13383 @item -msched-costly-dep=@var{dependence_type}
13384 @opindex msched-costly-dep
13385 This option controls which dependences are considered costly
13386 by the target during instruction scheduling.  The argument
13387 @var{dependence_type} takes one of the following values:
13388 @var{no}: no dependence is costly,
13389 @var{all}: all dependences are costly,
13390 @var{true_store_to_load}: a true dependence from store to load is costly,
13391 @var{store_to_load}: any dependence from store to load is costly,
13392 @var{number}: any dependence which latency >= @var{number} is costly.
13394 @item -minsert-sched-nops=@var{scheme}
13395 @opindex minsert-sched-nops
13396 This option controls which nop insertion scheme will be used during
13397 the second scheduling pass.  The argument @var{scheme} takes one of the
13398 following values:
13399 @var{no}: Don't insert nops.
13400 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13401 according to the scheduler's grouping.
13402 @var{regroup_exact}: Insert nops to force costly dependent insns into
13403 separate groups.  Insert exactly as many nops as needed to force an insn
13404 to a new group, according to the estimated processor grouping.
13405 @var{number}: Insert nops to force costly dependent insns into
13406 separate groups.  Insert @var{number} nops to force an insn to a new group.
13408 @item -mcall-sysv
13409 @opindex mcall-sysv
13410 On System V.4 and embedded PowerPC systems compile code using calling
13411 conventions that adheres to the March 1995 draft of the System V
13412 Application Binary Interface, PowerPC processor supplement.  This is the
13413 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13415 @item -mcall-sysv-eabi
13416 @opindex mcall-sysv-eabi
13417 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13419 @item -mcall-sysv-noeabi
13420 @opindex mcall-sysv-noeabi
13421 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13423 @item -mcall-solaris
13424 @opindex mcall-solaris
13425 On System V.4 and embedded PowerPC systems compile code for the Solaris
13426 operating system.
13428 @item -mcall-linux
13429 @opindex mcall-linux
13430 On System V.4 and embedded PowerPC systems compile code for the
13431 Linux-based GNU system.
13433 @item -mcall-gnu
13434 @opindex mcall-gnu
13435 On System V.4 and embedded PowerPC systems compile code for the
13436 Hurd-based GNU system.
13438 @item -mcall-netbsd
13439 @opindex mcall-netbsd
13440 On System V.4 and embedded PowerPC systems compile code for the
13441 NetBSD operating system.
13443 @item -maix-struct-return
13444 @opindex maix-struct-return
13445 Return all structures in memory (as specified by the AIX ABI)@.
13447 @item -msvr4-struct-return
13448 @opindex msvr4-struct-return
13449 Return structures smaller than 8 bytes in registers (as specified by the
13450 SVR4 ABI)@.
13452 @item -mabi=@var{abi-type}
13453 @opindex mabi
13454 Extend the current ABI with a particular extension, or remove such extension.
13455 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13456 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13458 @item -mabi=spe
13459 @opindex mabi=spe
13460 Extend the current ABI with SPE ABI extensions.  This does not change
13461 the default ABI, instead it adds the SPE ABI extensions to the current
13462 ABI@.
13464 @item -mabi=no-spe
13465 @opindex mabi=no-spe
13466 Disable Booke SPE ABI extensions for the current ABI@.
13468 @item -mabi=ibmlongdouble
13469 @opindex mabi=ibmlongdouble
13470 Change the current ABI to use IBM extended precision long double.
13471 This is a PowerPC 32-bit SYSV ABI option.
13473 @item -mabi=ieeelongdouble
13474 @opindex mabi=ieeelongdouble
13475 Change the current ABI to use IEEE extended precision long double.
13476 This is a PowerPC 32-bit Linux ABI option.
13478 @item -mprototype
13479 @itemx -mno-prototype
13480 @opindex mprototype
13481 @opindex mno-prototype
13482 On System V.4 and embedded PowerPC systems assume that all calls to
13483 variable argument functions are properly prototyped.  Otherwise, the
13484 compiler must insert an instruction before every non prototyped call to
13485 set or clear bit 6 of the condition code register (@var{CR}) to
13486 indicate whether floating point values were passed in the floating point
13487 registers in case the function takes a variable arguments.  With
13488 @option{-mprototype}, only calls to prototyped variable argument functions
13489 will set or clear the bit.
13491 @item -msim
13492 @opindex msim
13493 On embedded PowerPC systems, assume that the startup module is called
13494 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13495 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13496 configurations.
13498 @item -mmvme
13499 @opindex mmvme
13500 On embedded PowerPC systems, assume that the startup module is called
13501 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13502 @file{libc.a}.
13504 @item -mads
13505 @opindex mads
13506 On embedded PowerPC systems, assume that the startup module is called
13507 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13508 @file{libc.a}.
13510 @item -myellowknife
13511 @opindex myellowknife
13512 On embedded PowerPC systems, assume that the startup module is called
13513 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13514 @file{libc.a}.
13516 @item -mvxworks
13517 @opindex mvxworks
13518 On System V.4 and embedded PowerPC systems, specify that you are
13519 compiling for a VxWorks system.
13521 @item -mwindiss
13522 @opindex mwindiss
13523 Specify that you are compiling for the WindISS simulation environment.
13525 @item -memb
13526 @opindex memb
13527 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13528 header to indicate that @samp{eabi} extended relocations are used.
13530 @item -meabi
13531 @itemx -mno-eabi
13532 @opindex meabi
13533 @opindex mno-eabi
13534 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13535 Embedded Applications Binary Interface (eabi) which is a set of
13536 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13537 means that the stack is aligned to an 8 byte boundary, a function
13538 @code{__eabi} is called to from @code{main} to set up the eabi
13539 environment, and the @option{-msdata} option can use both @code{r2} and
13540 @code{r13} to point to two separate small data areas.  Selecting
13541 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13542 do not call an initialization function from @code{main}, and the
13543 @option{-msdata} option will only use @code{r13} to point to a single
13544 small data area.  The @option{-meabi} option is on by default if you
13545 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13547 @item -msdata=eabi
13548 @opindex msdata=eabi
13549 On System V.4 and embedded PowerPC systems, put small initialized
13550 @code{const} global and static data in the @samp{.sdata2} section, which
13551 is pointed to by register @code{r2}.  Put small initialized
13552 non-@code{const} global and static data in the @samp{.sdata} section,
13553 which is pointed to by register @code{r13}.  Put small uninitialized
13554 global and static data in the @samp{.sbss} section, which is adjacent to
13555 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13556 incompatible with the @option{-mrelocatable} option.  The
13557 @option{-msdata=eabi} option also sets the @option{-memb} option.
13559 @item -msdata=sysv
13560 @opindex msdata=sysv
13561 On System V.4 and embedded PowerPC systems, put small global and static
13562 data in the @samp{.sdata} section, which is pointed to by register
13563 @code{r13}.  Put small uninitialized global and static data in the
13564 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13565 The @option{-msdata=sysv} option is incompatible with the
13566 @option{-mrelocatable} option.
13568 @item -msdata=default
13569 @itemx -msdata
13570 @opindex msdata=default
13571 @opindex msdata
13572 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13573 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13574 same as @option{-msdata=sysv}.
13576 @item -msdata-data
13577 @opindex msdata-data
13578 On System V.4 and embedded PowerPC systems, put small global
13579 data in the @samp{.sdata} section.  Put small uninitialized global
13580 data in the @samp{.sbss} section.  Do not use register @code{r13}
13581 to address small data however.  This is the default behavior unless
13582 other @option{-msdata} options are used.
13584 @item -msdata=none
13585 @itemx -mno-sdata
13586 @opindex msdata=none
13587 @opindex mno-sdata
13588 On embedded PowerPC systems, put all initialized global and static data
13589 in the @samp{.data} section, and all uninitialized data in the
13590 @samp{.bss} section.
13592 @item -G @var{num}
13593 @opindex G
13594 @cindex smaller data references (PowerPC)
13595 @cindex .sdata/.sdata2 references (PowerPC)
13596 On embedded PowerPC systems, put global and static items less than or
13597 equal to @var{num} bytes into the small data or bss sections instead of
13598 the normal data or bss section.  By default, @var{num} is 8.  The
13599 @option{-G @var{num}} switch is also passed to the linker.
13600 All modules should be compiled with the same @option{-G @var{num}} value.
13602 @item -mregnames
13603 @itemx -mno-regnames
13604 @opindex mregnames
13605 @opindex mno-regnames
13606 On System V.4 and embedded PowerPC systems do (do not) emit register
13607 names in the assembly language output using symbolic forms.
13609 @item -mlongcall
13610 @itemx -mno-longcall
13611 @opindex mlongcall
13612 @opindex mno-longcall
13613 By default assume that all calls are far away so that a longer more
13614 expensive calling sequence is required.  This is required for calls
13615 further than 32 megabytes (33,554,432 bytes) from the current location.
13616 A short call will be generated if the compiler knows
13617 the call cannot be that far away.  This setting can be overridden by
13618 the @code{shortcall} function attribute, or by @code{#pragma
13619 longcall(0)}.
13621 Some linkers are capable of detecting out-of-range calls and generating
13622 glue code on the fly.  On these systems, long calls are unnecessary and
13623 generate slower code.  As of this writing, the AIX linker can do this,
13624 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13625 to the GNU linker for 32-bit PowerPC systems as well.
13627 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13628 callee, L42'', plus a ``branch island'' (glue code).  The two target
13629 addresses represent the callee and the ``branch island''.  The
13630 Darwin/PPC linker will prefer the first address and generate a ``bl
13631 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13632 otherwise, the linker will generate ``bl L42'' to call the ``branch
13633 island''.  The ``branch island'' is appended to the body of the
13634 calling function; it computes the full 32-bit address of the callee
13635 and jumps to it.
13637 On Mach-O (Darwin) systems, this option directs the compiler emit to
13638 the glue for every direct call, and the Darwin linker decides whether
13639 to use or discard it.
13641 In the future, we may cause GCC to ignore all longcall specifications
13642 when the linker is known to generate glue.
13644 @item -pthread
13645 @opindex pthread
13646 Adds support for multithreading with the @dfn{pthreads} library.
13647 This option sets flags for both the preprocessor and linker.
13649 @end table
13651 @node S/390 and zSeries Options
13652 @subsection S/390 and zSeries Options
13653 @cindex S/390 and zSeries Options
13655 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13657 @table @gcctabopt
13658 @item -mhard-float
13659 @itemx -msoft-float
13660 @opindex mhard-float
13661 @opindex msoft-float
13662 Use (do not use) the hardware floating-point instructions and registers
13663 for floating-point operations.  When @option{-msoft-float} is specified,
13664 functions in @file{libgcc.a} will be used to perform floating-point
13665 operations.  When @option{-mhard-float} is specified, the compiler
13666 generates IEEE floating-point instructions.  This is the default.
13668 @item -mlong-double-64
13669 @itemx -mlong-double-128
13670 @opindex mlong-double-64
13671 @opindex mlong-double-128
13672 These switches control the size of @code{long double} type. A size
13673 of 64bit makes the @code{long double} type equivalent to the @code{double}
13674 type. This is the default.
13676 @item -mbackchain
13677 @itemx -mno-backchain
13678 @opindex mbackchain
13679 @opindex mno-backchain
13680 Store (do not store) the address of the caller's frame as backchain pointer
13681 into the callee's stack frame.
13682 A backchain may be needed to allow debugging using tools that do not understand
13683 DWARF-2 call frame information.
13684 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13685 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13686 the backchain is placed into the topmost word of the 96/160 byte register
13687 save area.
13689 In general, code compiled with @option{-mbackchain} is call-compatible with
13690 code compiled with @option{-mmo-backchain}; however, use of the backchain
13691 for debugging purposes usually requires that the whole binary is built with
13692 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13693 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13694 to build a linux kernel use @option{-msoft-float}.
13696 The default is to not maintain the backchain.
13698 @item -mpacked-stack
13699 @itemx -mno-packed-stack
13700 @opindex mpacked-stack
13701 @opindex mno-packed-stack
13702 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13703 specified, the compiler uses the all fields of the 96/160 byte register save
13704 area only for their default purpose; unused fields still take up stack space.
13705 When @option{-mpacked-stack} is specified, register save slots are densely
13706 packed at the top of the register save area; unused space is reused for other
13707 purposes, allowing for more efficient use of the available stack space.
13708 However, when @option{-mbackchain} is also in effect, the topmost word of
13709 the save area is always used to store the backchain, and the return address
13710 register is always saved two words below the backchain.
13712 As long as the stack frame backchain is not used, code generated with
13713 @option{-mpacked-stack} is call-compatible with code generated with
13714 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13715 S/390 or zSeries generated code that uses the stack frame backchain at run
13716 time, not just for debugging purposes.  Such code is not call-compatible
13717 with code compiled with @option{-mpacked-stack}.  Also, note that the
13718 combination of @option{-mbackchain},
13719 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13720 to build a linux kernel use @option{-msoft-float}.
13722 The default is to not use the packed stack layout.
13724 @item -msmall-exec
13725 @itemx -mno-small-exec
13726 @opindex msmall-exec
13727 @opindex mno-small-exec
13728 Generate (or do not generate) code using the @code{bras} instruction
13729 to do subroutine calls.
13730 This only works reliably if the total executable size does not
13731 exceed 64k.  The default is to use the @code{basr} instruction instead,
13732 which does not have this limitation.
13734 @item -m64
13735 @itemx -m31
13736 @opindex m64
13737 @opindex m31
13738 When @option{-m31} is specified, generate code compliant to the
13739 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13740 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13741 particular to generate 64-bit instructions.  For the @samp{s390}
13742 targets, the default is @option{-m31}, while the @samp{s390x}
13743 targets default to @option{-m64}.
13745 @item -mzarch
13746 @itemx -mesa
13747 @opindex mzarch
13748 @opindex mesa
13749 When @option{-mzarch} is specified, generate code using the
13750 instructions available on z/Architecture.
13751 When @option{-mesa} is specified, generate code using the
13752 instructions available on ESA/390.  Note that @option{-mesa} is
13753 not possible with @option{-m64}.
13754 When generating code compliant to the GNU/Linux for S/390 ABI,
13755 the default is @option{-mesa}.  When generating code compliant
13756 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13758 @item -mmvcle
13759 @itemx -mno-mvcle
13760 @opindex mmvcle
13761 @opindex mno-mvcle
13762 Generate (or do not generate) code using the @code{mvcle} instruction
13763 to perform block moves.  When @option{-mno-mvcle} is specified,
13764 use a @code{mvc} loop instead.  This is the default unless optimizing for
13765 size.
13767 @item -mdebug
13768 @itemx -mno-debug
13769 @opindex mdebug
13770 @opindex mno-debug
13771 Print (or do not print) additional debug information when compiling.
13772 The default is to not print debug information.
13774 @item -march=@var{cpu-type}
13775 @opindex march
13776 Generate code that will run on @var{cpu-type}, which is the name of a system
13777 representing a certain processor type.  Possible values for
13778 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13779 When generating code using the instructions available on z/Architecture,
13780 the default is @option{-march=z900}.  Otherwise, the default is
13781 @option{-march=g5}.
13783 @item -mtune=@var{cpu-type}
13784 @opindex mtune
13785 Tune to @var{cpu-type} everything applicable about the generated code,
13786 except for the ABI and the set of available instructions.
13787 The list of @var{cpu-type} values is the same as for @option{-march}.
13788 The default is the value used for @option{-march}.
13790 @item -mtpf-trace
13791 @itemx -mno-tpf-trace
13792 @opindex mtpf-trace
13793 @opindex mno-tpf-trace
13794 Generate code that adds (does not add) in TPF OS specific branches to trace
13795 routines in the operating system.  This option is off by default, even
13796 when compiling for the TPF OS@.
13798 @item -mfused-madd
13799 @itemx -mno-fused-madd
13800 @opindex mfused-madd
13801 @opindex mno-fused-madd
13802 Generate code that uses (does not use) the floating point multiply and
13803 accumulate instructions.  These instructions are generated by default if
13804 hardware floating point is used.
13806 @item -mwarn-framesize=@var{framesize}
13807 @opindex mwarn-framesize
13808 Emit a warning if the current function exceeds the given frame size.  Because
13809 this is a compile time check it doesn't need to be a real problem when the program
13810 runs.  It is intended to identify functions which most probably cause
13811 a stack overflow.  It is useful to be used in an environment with limited stack
13812 size e.g.@: the linux kernel.
13814 @item -mwarn-dynamicstack
13815 @opindex mwarn-dynamicstack
13816 Emit a warning if the function calls alloca or uses dynamically
13817 sized arrays.  This is generally a bad idea with a limited stack size.
13819 @item -mstack-guard=@var{stack-guard}
13820 @itemx -mstack-size=@var{stack-size}
13821 @opindex mstack-guard
13822 @opindex mstack-size
13823 If these options are provided the s390 back end emits additional instructions in
13824 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13825 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13826 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13827 the frame size of the compiled function is chosen.
13828 These options are intended to be used to help debugging stack overflow problems.
13829 The additionally emitted code causes only little overhead and hence can also be
13830 used in production like systems without greater performance degradation.  The given
13831 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13832 @var{stack-guard} without exceeding 64k.
13833 In order to be efficient the extra code makes the assumption that the stack starts
13834 at an address aligned to the value given by @var{stack-size}.
13835 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13836 @end table
13838 @node Score Options
13839 @subsection Score Options
13840 @cindex Score Options
13842 These options are defined for Score implementations:
13844 @table @gcctabopt
13845 @item -meb
13846 @opindex meb
13847 Compile code for big endian mode.  This is the default.
13849 @item -mel
13850 @opindex mel
13851 Compile code for little endian mode. 
13853 @item -mnhwloop
13854 @opindex mnhwloop
13855 Disable generate bcnz instruction.
13857 @item -muls
13858 @opindex muls
13859 Enable generate unaligned load and store instruction.
13861 @item -mmac
13862 @opindex mmac
13863 Enable the use of multiply-accumulate instructions. Disabled by default. 
13865 @item -mscore5
13866 @opindex mscore5
13867 Specify the SCORE5 as the target architecture.
13869 @item -mscore5u
13870 @opindex mscore5u
13871 Specify the SCORE5U of the target architecture.
13873 @item -mscore7
13874 @opindex mscore7
13875 Specify the SCORE7 as the target architecture. This is the default.
13877 @item -mscore7d
13878 @opindex mscore7d
13879 Specify the SCORE7D as the target architecture.
13880 @end table
13882 @node SH Options
13883 @subsection SH Options
13885 These @samp{-m} options are defined for the SH implementations:
13887 @table @gcctabopt
13888 @item -m1
13889 @opindex m1
13890 Generate code for the SH1.
13892 @item -m2
13893 @opindex m2
13894 Generate code for the SH2.
13896 @item -m2e
13897 Generate code for the SH2e.
13899 @item -m3
13900 @opindex m3
13901 Generate code for the SH3.
13903 @item -m3e
13904 @opindex m3e
13905 Generate code for the SH3e.
13907 @item -m4-nofpu
13908 @opindex m4-nofpu
13909 Generate code for the SH4 without a floating-point unit.
13911 @item -m4-single-only
13912 @opindex m4-single-only
13913 Generate code for the SH4 with a floating-point unit that only
13914 supports single-precision arithmetic.
13916 @item -m4-single
13917 @opindex m4-single
13918 Generate code for the SH4 assuming the floating-point unit is in
13919 single-precision mode by default.
13921 @item -m4
13922 @opindex m4
13923 Generate code for the SH4.
13925 @item -m4a-nofpu
13926 @opindex m4a-nofpu
13927 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13928 floating-point unit is not used.
13930 @item -m4a-single-only
13931 @opindex m4a-single-only
13932 Generate code for the SH4a, in such a way that no double-precision
13933 floating point operations are used.
13935 @item -m4a-single
13936 @opindex m4a-single
13937 Generate code for the SH4a assuming the floating-point unit is in
13938 single-precision mode by default.
13940 @item -m4a
13941 @opindex m4a
13942 Generate code for the SH4a.
13944 @item -m4al
13945 @opindex m4al
13946 Same as @option{-m4a-nofpu}, except that it implicitly passes
13947 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13948 instructions at the moment.
13950 @item -mb
13951 @opindex mb
13952 Compile code for the processor in big endian mode.
13954 @item -ml
13955 @opindex ml
13956 Compile code for the processor in little endian mode.
13958 @item -mdalign
13959 @opindex mdalign
13960 Align doubles at 64-bit boundaries.  Note that this changes the calling
13961 conventions, and thus some functions from the standard C library will
13962 not work unless you recompile it first with @option{-mdalign}.
13964 @item -mrelax
13965 @opindex mrelax
13966 Shorten some address references at link time, when possible; uses the
13967 linker option @option{-relax}.
13969 @item -mbigtable
13970 @opindex mbigtable
13971 Use 32-bit offsets in @code{switch} tables.  The default is to use
13972 16-bit offsets.
13974 @item -mbitops
13975 @opindex mbitops
13976 Enable the use of bit manipulation instructions on SH2A.
13978 @item -mfmovd
13979 @opindex mfmovd
13980 Enable the use of the instruction @code{fmovd}.
13982 @item -mhitachi
13983 @opindex mhitachi
13984 Comply with the calling conventions defined by Renesas.
13986 @item -mrenesas
13987 @opindex mhitachi
13988 Comply with the calling conventions defined by Renesas.
13990 @item -mno-renesas
13991 @opindex mhitachi
13992 Comply with the calling conventions defined for GCC before the Renesas
13993 conventions were available.  This option is the default for all
13994 targets of the SH toolchain except for @samp{sh-symbianelf}.
13996 @item -mnomacsave
13997 @opindex mnomacsave
13998 Mark the @code{MAC} register as call-clobbered, even if
13999 @option{-mhitachi} is given.
14001 @item -mieee
14002 @opindex mieee
14003 Increase IEEE-compliance of floating-point code.
14004 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14005 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14006 comparisons of NANs / infinities incurs extra overhead in every
14007 floating point comparison, therefore the default is set to
14008 @option{-ffinite-math-only}.
14010 @item -minline-ic_invalidate
14011 @opindex minline-ic_invalidate
14012 Inline code to invalidate instruction cache entries after setting up
14013 nested function trampolines.
14014 This option has no effect if -musermode is in effect and the selected
14015 code generation option (e.g. -m4) does not allow the use of the icbi
14016 instruction.
14017 If the selected code generation option does not allow the use of the icbi
14018 instruction, and -musermode is not in effect, the inlined code will
14019 manipulate the instruction cache address array directly with an associative
14020 write.  This not only requires privileged mode, but it will also
14021 fail if the cache line had been mapped via the TLB and has become unmapped.
14023 @item -misize
14024 @opindex misize
14025 Dump instruction size and location in the assembly code.
14027 @item -mpadstruct
14028 @opindex mpadstruct
14029 This option is deprecated.  It pads structures to multiple of 4 bytes,
14030 which is incompatible with the SH ABI@.
14032 @item -mspace
14033 @opindex mspace
14034 Optimize for space instead of speed.  Implied by @option{-Os}.
14036 @item -mprefergot
14037 @opindex mprefergot
14038 When generating position-independent code, emit function calls using
14039 the Global Offset Table instead of the Procedure Linkage Table.
14041 @item -musermode
14042 @opindex musermode
14043 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14044 if the inlined code would not work in user mode.
14045 This is the default when the target is @code{sh-*-linux*}.
14047 @item -multcost=@var{number}
14048 @opindex multcost=@var{number}
14049 Set the cost to assume for a multiply insn.
14051 @item -mdiv=@var{strategy}
14052 @opindex mdiv=@var{strategy}
14053 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14054 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14055 inv:call2, inv:fp .
14056 "fp" performs the operation in floating point.  This has a very high latency,
14057 but needs only a few instructions, so it might be a good choice if
14058 your code has enough easily exploitable ILP to allow the compiler to
14059 schedule the floating point instructions together with other instructions.
14060 Division by zero causes a floating point exception.
14061 "inv" uses integer operations to calculate the inverse of the divisor,
14062 and then multiplies the dividend with the inverse.  This strategy allows
14063 cse and hoisting of the inverse calculation.  Division by zero calculates
14064 an unspecified result, but does not trap.
14065 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14066 have been found, or if the entire operation has been hoisted to the same
14067 place, the last stages of the inverse calculation are intertwined with the
14068 final multiply to reduce the overall latency, at the expense of using a few
14069 more instructions, and thus offering fewer scheduling opportunities with
14070 other code.
14071 "call" calls a library function that usually implements the inv:minlat
14072 strategy.
14073 This gives high code density for m5-*media-nofpu compilations.
14074 "call2" uses a different entry point of the same library function, where it
14075 assumes that a pointer to a lookup table has already been set up, which
14076 exposes the pointer load to cse / code hoisting optimizations.
14077 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14078 code generation, but if the code stays unoptimized, revert to the "call",
14079 "call2", or "fp" strategies, respectively.  Note that the
14080 potentially-trapping side effect of division by zero is carried by a
14081 separate instruction, so it is possible that all the integer instructions
14082 are hoisted out, but the marker for the side effect stays where it is.
14083 A recombination to fp operations or a call is not possible in that case.
14084 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14085 that the inverse calculation was nor separated from the multiply, they speed
14086 up division where the dividend fits into 20 bits (plus sign where applicable),
14087 by inserting a test to skip a number of operations in this case; this test
14088 slows down the case of larger dividends.  inv20u assumes the case of a such
14089 a small dividend to be unlikely, and inv20l assumes it to be likely.
14091 @item -mdivsi3_libfunc=@var{name}
14092 @opindex mdivsi3_libfunc=@var{name}
14093 Set the name of the library function used for 32 bit signed division to
14094 @var{name}.  This only affect the name used in the call and inv:call
14095 division strategies, and the compiler will still expect the same
14096 sets of input/output/clobbered registers as if this option was not present.
14098 @item -madjust-unroll
14099 @opindex madjust-unroll
14100 Throttle unrolling to avoid thrashing target registers.
14101 This option only has an effect if the gcc code base supports the
14102 TARGET_ADJUST_UNROLL_MAX target hook.
14104 @item -mindexed-addressing
14105 @opindex mindexed-addressing
14106 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14107 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14108 semantics for the indexed addressing mode.  The architecture allows the
14109 implementation of processors with 64 bit MMU, which the OS could use to
14110 get 32 bit addressing, but since no current hardware implementation supports
14111 this or any other way to make the indexed addressing mode safe to use in
14112 the 32 bit ABI, the default is -mno-indexed-addressing.
14114 @item -mgettrcost=@var{number}
14115 @opindex mgettrcost=@var{number}
14116 Set the cost assumed for the gettr instruction to @var{number}.
14117 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14119 @item -mpt-fixed
14120 @opindex mpt-fixed
14121 Assume pt* instructions won't trap.  This will generally generate better
14122 scheduled code, but is unsafe on current hardware.  The current architecture
14123 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14124 This has the unintentional effect of making it unsafe to schedule ptabs /
14125 ptrel before a branch, or hoist it out of a loop.  For example,
14126 __do_global_ctors, a part of libgcc that runs constructors at program
14127 startup, calls functions in a list which is delimited by @minus{}1.  With the
14128 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14129 That means that all the constructors will be run a bit quicker, but when
14130 the loop comes to the end of the list, the program crashes because ptabs
14131 loads @minus{}1 into a target register.  Since this option is unsafe for any
14132 hardware implementing the current architecture specification, the default
14133 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14134 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14135 this deters register allocation using target registers for storing
14136 ordinary integers.
14138 @item -minvalid-symbols
14139 @opindex minvalid-symbols
14140 Assume symbols might be invalid.  Ordinary function symbols generated by
14141 the compiler will always be valid to load with movi/shori/ptabs or
14142 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14143 to generate symbols that will cause ptabs / ptrel to trap.
14144 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14145 It will then prevent cross-basic-block cse, hoisting and most scheduling
14146 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14147 @end table
14149 @node SPARC Options
14150 @subsection SPARC Options
14151 @cindex SPARC options
14153 These @samp{-m} options are supported on the SPARC:
14155 @table @gcctabopt
14156 @item -mno-app-regs
14157 @itemx -mapp-regs
14158 @opindex mno-app-regs
14159 @opindex mapp-regs
14160 Specify @option{-mapp-regs} to generate output using the global registers
14161 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14162 is the default.
14164 To be fully SVR4 ABI compliant at the cost of some performance loss,
14165 specify @option{-mno-app-regs}.  You should compile libraries and system
14166 software with this option.
14168 @item -mfpu
14169 @itemx -mhard-float
14170 @opindex mfpu
14171 @opindex mhard-float
14172 Generate output containing floating point instructions.  This is the
14173 default.
14175 @item -mno-fpu
14176 @itemx -msoft-float
14177 @opindex mno-fpu
14178 @opindex msoft-float
14179 Generate output containing library calls for floating point.
14180 @strong{Warning:} the requisite libraries are not available for all SPARC
14181 targets.  Normally the facilities of the machine's usual C compiler are
14182 used, but this cannot be done directly in cross-compilation.  You must make
14183 your own arrangements to provide suitable library functions for
14184 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14185 @samp{sparclite-*-*} do provide software floating point support.
14187 @option{-msoft-float} changes the calling convention in the output file;
14188 therefore, it is only useful if you compile @emph{all} of a program with
14189 this option.  In particular, you need to compile @file{libgcc.a}, the
14190 library that comes with GCC, with @option{-msoft-float} in order for
14191 this to work.
14193 @item -mhard-quad-float
14194 @opindex mhard-quad-float
14195 Generate output containing quad-word (long double) floating point
14196 instructions.
14198 @item -msoft-quad-float
14199 @opindex msoft-quad-float
14200 Generate output containing library calls for quad-word (long double)
14201 floating point instructions.  The functions called are those specified
14202 in the SPARC ABI@.  This is the default.
14204 As of this writing, there are no SPARC implementations that have hardware
14205 support for the quad-word floating point instructions.  They all invoke
14206 a trap handler for one of these instructions, and then the trap handler
14207 emulates the effect of the instruction.  Because of the trap handler overhead,
14208 this is much slower than calling the ABI library routines.  Thus the
14209 @option{-msoft-quad-float} option is the default.
14211 @item -mno-unaligned-doubles
14212 @itemx -munaligned-doubles
14213 @opindex mno-unaligned-doubles
14214 @opindex munaligned-doubles
14215 Assume that doubles have 8 byte alignment.  This is the default.
14217 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14218 alignment only if they are contained in another type, or if they have an
14219 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14220 Specifying this option avoids some rare compatibility problems with code
14221 generated by other compilers.  It is not the default because it results
14222 in a performance loss, especially for floating point code.
14224 @item -mno-faster-structs
14225 @itemx -mfaster-structs
14226 @opindex mno-faster-structs
14227 @opindex mfaster-structs
14228 With @option{-mfaster-structs}, the compiler assumes that structures
14229 should have 8 byte alignment.  This enables the use of pairs of
14230 @code{ldd} and @code{std} instructions for copies in structure
14231 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14232 However, the use of this changed alignment directly violates the SPARC
14233 ABI@.  Thus, it's intended only for use on targets where the developer
14234 acknowledges that their resulting code will not be directly in line with
14235 the rules of the ABI@.
14237 @item -mimpure-text
14238 @opindex mimpure-text
14239 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14240 the compiler to not pass @option{-z text} to the linker when linking a
14241 shared object.  Using this option, you can link position-dependent
14242 code into a shared object.
14244 @option{-mimpure-text} suppresses the ``relocations remain against
14245 allocatable but non-writable sections'' linker error message.
14246 However, the necessary relocations will trigger copy-on-write, and the
14247 shared object is not actually shared across processes.  Instead of
14248 using @option{-mimpure-text}, you should compile all source code with
14249 @option{-fpic} or @option{-fPIC}.
14251 This option is only available on SunOS and Solaris.
14253 @item -mcpu=@var{cpu_type}
14254 @opindex mcpu
14255 Set the instruction set, register set, and instruction scheduling parameters
14256 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14257 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14258 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14259 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14260 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14262 Default instruction scheduling parameters are used for values that select
14263 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14264 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14266 Here is a list of each supported architecture and their supported
14267 implementations.
14269 @smallexample
14270     v7:             cypress
14271     v8:             supersparc, hypersparc
14272     sparclite:      f930, f934, sparclite86x
14273     sparclet:       tsc701
14274     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14275 @end smallexample
14277 By default (unless configured otherwise), GCC generates code for the V7
14278 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14279 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14280 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14281 SPARCStation 1, 2, IPX etc.
14283 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14284 architecture.  The only difference from V7 code is that the compiler emits
14285 the integer multiply and integer divide instructions which exist in SPARC-V8
14286 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14287 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14288 2000 series.
14290 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14291 the SPARC architecture.  This adds the integer multiply, integer divide step
14292 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14293 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14294 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14295 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14296 MB86934 chip, which is the more recent SPARClite with FPU@.
14298 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14299 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14300 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14301 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14302 optimizes it for the TEMIC SPARClet chip.
14304 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14305 architecture.  This adds 64-bit integer and floating-point move instructions,
14306 3 additional floating-point condition code registers and conditional move
14307 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14308 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14309 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14310 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14311 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14312 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14313 additionally optimizes it for Sun UltraSPARC T2 chips.
14315 @item -mtune=@var{cpu_type}
14316 @opindex mtune
14317 Set the instruction scheduling parameters for machine type
14318 @var{cpu_type}, but do not set the instruction set or register set that the
14319 option @option{-mcpu=@var{cpu_type}} would.
14321 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14322 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14323 that select a particular cpu implementation.  Those are @samp{cypress},
14324 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14325 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14326 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14328 @item -mv8plus
14329 @itemx -mno-v8plus
14330 @opindex mv8plus
14331 @opindex mno-v8plus
14332 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14333 difference from the V8 ABI is that the global and out registers are
14334 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14335 mode for all SPARC-V9 processors.
14337 @item -mvis
14338 @itemx -mno-vis
14339 @opindex mvis
14340 @opindex mno-vis
14341 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14342 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14343 @end table
14345 These @samp{-m} options are supported in addition to the above
14346 on SPARC-V9 processors in 64-bit environments:
14348 @table @gcctabopt
14349 @item -mlittle-endian
14350 @opindex mlittle-endian
14351 Generate code for a processor running in little-endian mode.  It is only
14352 available for a few configurations and most notably not on Solaris and Linux.
14354 @item -m32
14355 @itemx -m64
14356 @opindex m32
14357 @opindex m64
14358 Generate code for a 32-bit or 64-bit environment.
14359 The 32-bit environment sets int, long and pointer to 32 bits.
14360 The 64-bit environment sets int to 32 bits and long and pointer
14361 to 64 bits.
14363 @item -mcmodel=medlow
14364 @opindex mcmodel=medlow
14365 Generate code for the Medium/Low code model: 64-bit addresses, programs
14366 must be linked in the low 32 bits of memory.  Programs can be statically
14367 or dynamically linked.
14369 @item -mcmodel=medmid
14370 @opindex mcmodel=medmid
14371 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14372 must be linked in the low 44 bits of memory, the text and data segments must
14373 be less than 2GB in size and the data segment must be located within 2GB of
14374 the text segment.
14376 @item -mcmodel=medany
14377 @opindex mcmodel=medany
14378 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14379 may be linked anywhere in memory, the text and data segments must be less
14380 than 2GB in size and the data segment must be located within 2GB of the
14381 text segment.
14383 @item -mcmodel=embmedany
14384 @opindex mcmodel=embmedany
14385 Generate code for the Medium/Anywhere code model for embedded systems:
14386 64-bit addresses, the text and data segments must be less than 2GB in
14387 size, both starting anywhere in memory (determined at link time).  The
14388 global register %g4 points to the base of the data segment.  Programs
14389 are statically linked and PIC is not supported.
14391 @item -mstack-bias
14392 @itemx -mno-stack-bias
14393 @opindex mstack-bias
14394 @opindex mno-stack-bias
14395 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14396 frame pointer if present, are offset by @minus{}2047 which must be added back
14397 when making stack frame references.  This is the default in 64-bit mode.
14398 Otherwise, assume no such offset is present.
14399 @end table
14401 These switches are supported in addition to the above on Solaris:
14403 @table @gcctabopt
14404 @item -threads
14405 @opindex threads
14406 Add support for multithreading using the Solaris threads library.  This
14407 option sets flags for both the preprocessor and linker.  This option does
14408 not affect the thread safety of object code produced by the compiler or
14409 that of libraries supplied with it.
14411 @item -pthreads
14412 @opindex pthreads
14413 Add support for multithreading using the POSIX threads library.  This
14414 option sets flags for both the preprocessor and linker.  This option does
14415 not affect the thread safety of object code produced  by the compiler or
14416 that of libraries supplied with it.
14418 @item -pthread
14419 @opindex pthread
14420 This is a synonym for @option{-pthreads}.
14421 @end table
14423 @node SPU Options
14424 @subsection SPU Options
14425 @cindex SPU options
14427 These @samp{-m} options are supported on the SPU:
14429 @table @gcctabopt
14430 @item -mwarn-reloc
14431 @itemx -merror-reloc
14432 @opindex mwarn-reloc
14433 @opindex merror-reloc
14435 The loader for SPU does not handle dynamic relocations.  By default, GCC
14436 will give an error when it generates code that requires a dynamic
14437 relocation.  @option{-mno-error-reloc} disables the error,
14438 @option{-mwarn-reloc} will generate a warning instead.
14440 @item -msafe-dma
14441 @itemx -munsafe-dma
14442 @opindex msafe-dma
14443 @opindex munsafe-dma
14445 Instructions which initiate or test completion of DMA must not be
14446 reordered with respect to loads and stores of the memory which is being
14447 accessed.  Users typically address this problem using the volatile
14448 keyword, but that can lead to inefficient code in places where the
14449 memory is known to not change.  Rather than mark the memory as volatile
14450 we treat the DMA instructions as potentially effecting all memory.  With
14451 @option{-munsafe-dma} users must use the volatile keyword to protect
14452 memory accesses.
14454 @item -mbranch-hints
14455 @opindex mbranch-hints
14457 By default, GCC will generate a branch hint instruction to avoid
14458 pipeline stalls for always taken or probably taken branches.  A hint
14459 will not be generated closer than 8 instructions away from its branch.
14460 There is little reason to disable them, except for debugging purposes,
14461 or to make an object a little bit smaller.
14463 @item -msmall-mem
14464 @itemx -mlarge-mem
14465 @opindex msmall-mem
14466 @opindex mlarge-mem
14468 By default, GCC generates code assuming that addresses are never larger
14469 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14470 a full 32 bit address.
14472 @item -mstdmain
14473 @opindex mstdmain
14475 By default, GCC links against startup code that assumes the SPU-style
14476 main function interface (which has an unconventional parameter list).
14477 With @option{-mstdmain}, GCC will link your program against startup
14478 code that assumes a C99-style interface to @code{main}, including a
14479 local copy of @code{argv} strings.
14481 @item -mfixed-range=@var{register-range}
14482 @opindex mfixed-range
14483 Generate code treating the given register range as fixed registers.
14484 A fixed register is one that the register allocator can not use.  This is
14485 useful when compiling kernel code.  A register range is specified as
14486 two registers separated by a dash.  Multiple register ranges can be
14487 specified separated by a comma.
14489 @end table
14491 @node System V Options
14492 @subsection Options for System V
14494 These additional options are available on System V Release 4 for
14495 compatibility with other compilers on those systems:
14497 @table @gcctabopt
14498 @item -G
14499 @opindex G
14500 Create a shared object.
14501 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14503 @item -Qy
14504 @opindex Qy
14505 Identify the versions of each tool used by the compiler, in a
14506 @code{.ident} assembler directive in the output.
14508 @item -Qn
14509 @opindex Qn
14510 Refrain from adding @code{.ident} directives to the output file (this is
14511 the default).
14513 @item -YP,@var{dirs}
14514 @opindex YP
14515 Search the directories @var{dirs}, and no others, for libraries
14516 specified with @option{-l}.
14518 @item -Ym,@var{dir}
14519 @opindex Ym
14520 Look in the directory @var{dir} to find the M4 preprocessor.
14521 The assembler uses this option.
14522 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14523 @c the generic assembler that comes with Solaris takes just -Ym.
14524 @end table
14526 @node V850 Options
14527 @subsection V850 Options
14528 @cindex V850 Options
14530 These @samp{-m} options are defined for V850 implementations:
14532 @table @gcctabopt
14533 @item -mlong-calls
14534 @itemx -mno-long-calls
14535 @opindex mlong-calls
14536 @opindex mno-long-calls
14537 Treat all calls as being far away (near).  If calls are assumed to be
14538 far away, the compiler will always load the functions address up into a
14539 register, and call indirect through the pointer.
14541 @item -mno-ep
14542 @itemx -mep
14543 @opindex mno-ep
14544 @opindex mep
14545 Do not optimize (do optimize) basic blocks that use the same index
14546 pointer 4 or more times to copy pointer into the @code{ep} register, and
14547 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14548 option is on by default if you optimize.
14550 @item -mno-prolog-function
14551 @itemx -mprolog-function
14552 @opindex mno-prolog-function
14553 @opindex mprolog-function
14554 Do not use (do use) external functions to save and restore registers
14555 at the prologue and epilogue of a function.  The external functions
14556 are slower, but use less code space if more than one function saves
14557 the same number of registers.  The @option{-mprolog-function} option
14558 is on by default if you optimize.
14560 @item -mspace
14561 @opindex mspace
14562 Try to make the code as small as possible.  At present, this just turns
14563 on the @option{-mep} and @option{-mprolog-function} options.
14565 @item -mtda=@var{n}
14566 @opindex mtda
14567 Put static or global variables whose size is @var{n} bytes or less into
14568 the tiny data area that register @code{ep} points to.  The tiny data
14569 area can hold up to 256 bytes in total (128 bytes for byte references).
14571 @item -msda=@var{n}
14572 @opindex msda
14573 Put static or global variables whose size is @var{n} bytes or less into
14574 the small data area that register @code{gp} points to.  The small data
14575 area can hold up to 64 kilobytes.
14577 @item -mzda=@var{n}
14578 @opindex mzda
14579 Put static or global variables whose size is @var{n} bytes or less into
14580 the first 32 kilobytes of memory.
14582 @item -mv850
14583 @opindex mv850
14584 Specify that the target processor is the V850.
14586 @item -mbig-switch
14587 @opindex mbig-switch
14588 Generate code suitable for big switch tables.  Use this option only if
14589 the assembler/linker complain about out of range branches within a switch
14590 table.
14592 @item -mapp-regs
14593 @opindex mapp-regs
14594 This option will cause r2 and r5 to be used in the code generated by
14595 the compiler.  This setting is the default.
14597 @item -mno-app-regs
14598 @opindex mno-app-regs
14599 This option will cause r2 and r5 to be treated as fixed registers.
14601 @item -mv850e1
14602 @opindex mv850e1
14603 Specify that the target processor is the V850E1.  The preprocessor
14604 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14605 this option is used.
14607 @item -mv850e
14608 @opindex mv850e
14609 Specify that the target processor is the V850E@.  The preprocessor
14610 constant @samp{__v850e__} will be defined if this option is used.
14612 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14613 are defined then a default target processor will be chosen and the
14614 relevant @samp{__v850*__} preprocessor constant will be defined.
14616 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14617 defined, regardless of which processor variant is the target.
14619 @item -mdisable-callt
14620 @opindex mdisable-callt
14621 This option will suppress generation of the CALLT instruction for the
14622 v850e and v850e1 flavors of the v850 architecture.  The default is
14623 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14625 @end table
14627 @node VAX Options
14628 @subsection VAX Options
14629 @cindex VAX options
14631 These @samp{-m} options are defined for the VAX:
14633 @table @gcctabopt
14634 @item -munix
14635 @opindex munix
14636 Do not output certain jump instructions (@code{aobleq} and so on)
14637 that the Unix assembler for the VAX cannot handle across long
14638 ranges.
14640 @item -mgnu
14641 @opindex mgnu
14642 Do output those jump instructions, on the assumption that you
14643 will assemble with the GNU assembler.
14645 @item -mg
14646 @opindex mg
14647 Output code for g-format floating point numbers instead of d-format.
14648 @end table
14650 @node VxWorks Options
14651 @subsection VxWorks Options
14652 @cindex VxWorks Options
14654 The options in this section are defined for all VxWorks targets.
14655 Options specific to the target hardware are listed with the other
14656 options for that target.
14658 @table @gcctabopt
14659 @item -mrtp
14660 @opindex mrtp
14661 GCC can generate code for both VxWorks kernels and real time processes
14662 (RTPs).  This option switches from the former to the latter.  It also
14663 defines the preprocessor macro @code{__RTP__}.
14665 @item -non-static
14666 @opindex non-static
14667 Link an RTP executable against shared libraries rather than static
14668 libraries.  The options @option{-static} and @option{-shared} can
14669 also be used for RTPs (@pxref{Link Options}); @option{-static}
14670 is the default.
14672 @item -Bstatic
14673 @itemx -Bdynamic
14674 @opindex Bstatic
14675 @opindex Bdynamic
14676 These options are passed down to the linker.  They are defined for
14677 compatibility with Diab.
14679 @item -Xbind-lazy
14680 @opindex Xbind-lazy
14681 Enable lazy binding of function calls.  This option is equivalent to
14682 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14684 @item -Xbind-now
14685 @opindex Xbind-now
14686 Disable lazy binding of function calls.  This option is the default and
14687 is defined for compatibility with Diab.
14688 @end table
14690 @node x86-64 Options
14691 @subsection x86-64 Options
14692 @cindex x86-64 options
14694 These are listed under @xref{i386 and x86-64 Options}.
14696 @node Xstormy16 Options
14697 @subsection Xstormy16 Options
14698 @cindex Xstormy16 Options
14700 These options are defined for Xstormy16:
14702 @table @gcctabopt
14703 @item -msim
14704 @opindex msim
14705 Choose startup files and linker script suitable for the simulator.
14706 @end table
14708 @node Xtensa Options
14709 @subsection Xtensa Options
14710 @cindex Xtensa Options
14712 These options are supported for Xtensa targets:
14714 @table @gcctabopt
14715 @item -mconst16
14716 @itemx -mno-const16
14717 @opindex mconst16
14718 @opindex mno-const16
14719 Enable or disable use of @code{CONST16} instructions for loading
14720 constant values.  The @code{CONST16} instruction is currently not a
14721 standard option from Tensilica.  When enabled, @code{CONST16}
14722 instructions are always used in place of the standard @code{L32R}
14723 instructions.  The use of @code{CONST16} is enabled by default only if
14724 the @code{L32R} instruction is not available.
14726 @item -mfused-madd
14727 @itemx -mno-fused-madd
14728 @opindex mfused-madd
14729 @opindex mno-fused-madd
14730 Enable or disable use of fused multiply/add and multiply/subtract
14731 instructions in the floating-point option.  This has no effect if the
14732 floating-point option is not also enabled.  Disabling fused multiply/add
14733 and multiply/subtract instructions forces the compiler to use separate
14734 instructions for the multiply and add/subtract operations.  This may be
14735 desirable in some cases where strict IEEE 754-compliant results are
14736 required: the fused multiply add/subtract instructions do not round the
14737 intermediate result, thereby producing results with @emph{more} bits of
14738 precision than specified by the IEEE standard.  Disabling fused multiply
14739 add/subtract instructions also ensures that the program output is not
14740 sensitive to the compiler's ability to combine multiply and add/subtract
14741 operations.
14743 @item -mserialize-volatile
14744 @itemx -mno-serialize-volatile
14745 @opindex mserialize-volatile
14746 @opindex mno-serialize-volatile
14747 When this option is enabled, GCC inserts @code{MEMW} instructions before
14748 @code{volatile} memory references to guarantee sequential consistency.
14749 The default is @option{-mserialize-volatile}.  Use
14750 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14752 @item -mtext-section-literals
14753 @itemx -mno-text-section-literals
14754 @opindex mtext-section-literals
14755 @opindex mno-text-section-literals
14756 Control the treatment of literal pools.  The default is
14757 @option{-mno-text-section-literals}, which places literals in a separate
14758 section in the output file.  This allows the literal pool to be placed
14759 in a data RAM/ROM, and it also allows the linker to combine literal
14760 pools from separate object files to remove redundant literals and
14761 improve code size.  With @option{-mtext-section-literals}, the literals
14762 are interspersed in the text section in order to keep them as close as
14763 possible to their references.  This may be necessary for large assembly
14764 files.
14766 @item -mtarget-align
14767 @itemx -mno-target-align
14768 @opindex mtarget-align
14769 @opindex mno-target-align
14770 When this option is enabled, GCC instructs the assembler to
14771 automatically align instructions to reduce branch penalties at the
14772 expense of some code density.  The assembler attempts to widen density
14773 instructions to align branch targets and the instructions following call
14774 instructions.  If there are not enough preceding safe density
14775 instructions to align a target, no widening will be performed.  The
14776 default is @option{-mtarget-align}.  These options do not affect the
14777 treatment of auto-aligned instructions like @code{LOOP}, which the
14778 assembler will always align, either by widening density instructions or
14779 by inserting no-op instructions.
14781 @item -mlongcalls
14782 @itemx -mno-longcalls
14783 @opindex mlongcalls
14784 @opindex mno-longcalls
14785 When this option is enabled, GCC instructs the assembler to translate
14786 direct calls to indirect calls unless it can determine that the target
14787 of a direct call is in the range allowed by the call instruction.  This
14788 translation typically occurs for calls to functions in other source
14789 files.  Specifically, the assembler translates a direct @code{CALL}
14790 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14791 The default is @option{-mno-longcalls}.  This option should be used in
14792 programs where the call target can potentially be out of range.  This
14793 option is implemented in the assembler, not the compiler, so the
14794 assembly code generated by GCC will still show direct call
14795 instructions---look at the disassembled object code to see the actual
14796 instructions.  Note that the assembler will use an indirect call for
14797 every cross-file call, not just those that really will be out of range.
14798 @end table
14800 @node zSeries Options
14801 @subsection zSeries Options
14802 @cindex zSeries options
14804 These are listed under @xref{S/390 and zSeries Options}.
14806 @node Code Gen Options
14807 @section Options for Code Generation Conventions
14808 @cindex code generation conventions
14809 @cindex options, code generation
14810 @cindex run-time options
14812 These machine-independent options control the interface conventions
14813 used in code generation.
14815 Most of them have both positive and negative forms; the negative form
14816 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14817 one of the forms is listed---the one which is not the default.  You
14818 can figure out the other form by either removing @samp{no-} or adding
14821 @table @gcctabopt
14822 @item -fbounds-check
14823 @opindex fbounds-check
14824 For front-ends that support it, generate additional code to check that
14825 indices used to access arrays are within the declared range.  This is
14826 currently only supported by the Java and Fortran front-ends, where
14827 this option defaults to true and false respectively.
14829 @item -ftrapv
14830 @opindex ftrapv
14831 This option generates traps for signed overflow on addition, subtraction,
14832 multiplication operations.
14834 @item -fwrapv
14835 @opindex fwrapv
14836 This option instructs the compiler to assume that signed arithmetic
14837 overflow of addition, subtraction and multiplication wraps around
14838 using twos-complement representation.  This flag enables some optimizations
14839 and disables others.  This option is enabled by default for the Java
14840 front-end, as required by the Java language specification.
14842 @item -fexceptions
14843 @opindex fexceptions
14844 Enable exception handling.  Generates extra code needed to propagate
14845 exceptions.  For some targets, this implies GCC will generate frame
14846 unwind information for all functions, which can produce significant data
14847 size overhead, although it does not affect execution.  If you do not
14848 specify this option, GCC will enable it by default for languages like
14849 C++ which normally require exception handling, and disable it for
14850 languages like C that do not normally require it.  However, you may need
14851 to enable this option when compiling C code that needs to interoperate
14852 properly with exception handlers written in C++.  You may also wish to
14853 disable this option if you are compiling older C++ programs that don't
14854 use exception handling.
14856 @item -fnon-call-exceptions
14857 @opindex fnon-call-exceptions
14858 Generate code that allows trapping instructions to throw exceptions.
14859 Note that this requires platform-specific runtime support that does
14860 not exist everywhere.  Moreover, it only allows @emph{trapping}
14861 instructions to throw exceptions, i.e.@: memory references or floating
14862 point instructions.  It does not allow exceptions to be thrown from
14863 arbitrary signal handlers such as @code{SIGALRM}.
14865 @item -funwind-tables
14866 @opindex funwind-tables
14867 Similar to @option{-fexceptions}, except that it will just generate any needed
14868 static data, but will not affect the generated code in any other way.
14869 You will normally not enable this option; instead, a language processor
14870 that needs this handling would enable it on your behalf.
14872 @item -fasynchronous-unwind-tables
14873 @opindex fasynchronous-unwind-tables
14874 Generate unwind table in dwarf2 format, if supported by target machine.  The
14875 table is exact at each instruction boundary, so it can be used for stack
14876 unwinding from asynchronous events (such as debugger or garbage collector).
14878 @item -fpcc-struct-return
14879 @opindex fpcc-struct-return
14880 Return ``short'' @code{struct} and @code{union} values in memory like
14881 longer ones, rather than in registers.  This convention is less
14882 efficient, but it has the advantage of allowing intercallability between
14883 GCC-compiled files and files compiled with other compilers, particularly
14884 the Portable C Compiler (pcc).
14886 The precise convention for returning structures in memory depends
14887 on the target configuration macros.
14889 Short structures and unions are those whose size and alignment match
14890 that of some integer type.
14892 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14893 switch is not binary compatible with code compiled with the
14894 @option{-freg-struct-return} switch.
14895 Use it to conform to a non-default application binary interface.
14897 @item -freg-struct-return
14898 @opindex freg-struct-return
14899 Return @code{struct} and @code{union} values in registers when possible.
14900 This is more efficient for small structures than
14901 @option{-fpcc-struct-return}.
14903 If you specify neither @option{-fpcc-struct-return} nor
14904 @option{-freg-struct-return}, GCC defaults to whichever convention is
14905 standard for the target.  If there is no standard convention, GCC
14906 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14907 the principal compiler.  In those cases, we can choose the standard, and
14908 we chose the more efficient register return alternative.
14910 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14911 switch is not binary compatible with code compiled with the
14912 @option{-fpcc-struct-return} switch.
14913 Use it to conform to a non-default application binary interface.
14915 @item -fshort-enums
14916 @opindex fshort-enums
14917 Allocate to an @code{enum} type only as many bytes as it needs for the
14918 declared range of possible values.  Specifically, the @code{enum} type
14919 will be equivalent to the smallest integer type which has enough room.
14921 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14922 code that is not binary compatible with code generated without that switch.
14923 Use it to conform to a non-default application binary interface.
14925 @item -fshort-double
14926 @opindex fshort-double
14927 Use the same size for @code{double} as for @code{float}.
14929 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14930 code that is not binary compatible with code generated without that switch.
14931 Use it to conform to a non-default application binary interface.
14933 @item -fshort-wchar
14934 @opindex fshort-wchar
14935 Override the underlying type for @samp{wchar_t} to be @samp{short
14936 unsigned int} instead of the default for the target.  This option is
14937 useful for building programs to run under WINE@.
14939 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14940 code that is not binary compatible with code generated without that switch.
14941 Use it to conform to a non-default application binary interface.
14943 @item -fno-common
14944 @opindex fno-common
14945 In C, allocate even uninitialized global variables in the data section of the
14946 object file, rather than generating them as common blocks.  This has the
14947 effect that if the same variable is declared (without @code{extern}) in
14948 two different compilations, you will get an error when you link them.
14949 The only reason this might be useful is if you wish to verify that the
14950 program will work on other systems which always work this way.
14952 @item -fno-ident
14953 @opindex fno-ident
14954 Ignore the @samp{#ident} directive.
14956 @item -finhibit-size-directive
14957 @opindex finhibit-size-directive
14958 Don't output a @code{.size} assembler directive, or anything else that
14959 would cause trouble if the function is split in the middle, and the
14960 two halves are placed at locations far apart in memory.  This option is
14961 used when compiling @file{crtstuff.c}; you should not need to use it
14962 for anything else.
14964 @item -fverbose-asm
14965 @opindex fverbose-asm
14966 Put extra commentary information in the generated assembly code to
14967 make it more readable.  This option is generally only of use to those
14968 who actually need to read the generated assembly code (perhaps while
14969 debugging the compiler itself).
14971 @option{-fno-verbose-asm}, the default, causes the
14972 extra information to be omitted and is useful when comparing two assembler
14973 files.
14975 @item -frecord-gcc-switches
14976 @opindex frecord-gcc-switches
14977 This switch causes the command line that was used to invoke the
14978 compiler to be recorded into the object file that is being created.
14979 This switch is only implemented on some targets and the exact format
14980 of the recording is target and binary file format dependent, but it
14981 usually takes the form of a section containing ASCII text.  This
14982 switch is related to the @option{-fverbose-asm} switch, but that
14983 switch only records information in the assembler output file as
14984 comments, so it never reaches the object file.
14986 @item -fpic
14987 @opindex fpic
14988 @cindex global offset table
14989 @cindex PIC
14990 Generate position-independent code (PIC) suitable for use in a shared
14991 library, if supported for the target machine.  Such code accesses all
14992 constant addresses through a global offset table (GOT)@.  The dynamic
14993 loader resolves the GOT entries when the program starts (the dynamic
14994 loader is not part of GCC; it is part of the operating system).  If
14995 the GOT size for the linked executable exceeds a machine-specific
14996 maximum size, you get an error message from the linker indicating that
14997 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14998 instead.  (These maximums are 8k on the SPARC and 32k
14999 on the m68k and RS/6000.  The 386 has no such limit.)
15001 Position-independent code requires special support, and therefore works
15002 only on certain machines.  For the 386, GCC supports PIC for System V
15003 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15004 position-independent.
15006 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15007 are defined to 1.
15009 @item -fPIC
15010 @opindex fPIC
15011 If supported for the target machine, emit position-independent code,
15012 suitable for dynamic linking and avoiding any limit on the size of the
15013 global offset table.  This option makes a difference on the m68k,
15014 PowerPC and SPARC@.
15016 Position-independent code requires special support, and therefore works
15017 only on certain machines.
15019 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15020 are defined to 2.
15022 @item -fpie
15023 @itemx -fPIE
15024 @opindex fpie
15025 @opindex fPIE
15026 These options are similar to @option{-fpic} and @option{-fPIC}, but
15027 generated position independent code can be only linked into executables.
15028 Usually these options are used when @option{-pie} GCC option will be
15029 used during linking.
15031 @option{-fpie} and @option{-fPIE} both define the macros
15032 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15033 for @option{-fpie} and 2 for @option{-fPIE}.
15035 @item -fno-jump-tables
15036 @opindex fno-jump-tables
15037 Do not use jump tables for switch statements even where it would be
15038 more efficient than other code generation strategies.  This option is
15039 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15040 building code which forms part of a dynamic linker and cannot
15041 reference the address of a jump table.  On some targets, jump tables
15042 do not require a GOT and this option is not needed.
15044 @item -ffixed-@var{reg}
15045 @opindex ffixed
15046 Treat the register named @var{reg} as a fixed register; generated code
15047 should never refer to it (except perhaps as a stack pointer, frame
15048 pointer or in some other fixed role).
15050 @var{reg} must be the name of a register.  The register names accepted
15051 are machine-specific and are defined in the @code{REGISTER_NAMES}
15052 macro in the machine description macro file.
15054 This flag does not have a negative form, because it specifies a
15055 three-way choice.
15057 @item -fcall-used-@var{reg}
15058 @opindex fcall-used
15059 Treat the register named @var{reg} as an allocable register that is
15060 clobbered by function calls.  It may be allocated for temporaries or
15061 variables that do not live across a call.  Functions compiled this way
15062 will not save and restore the register @var{reg}.
15064 It is an error to used this flag with the frame pointer or stack pointer.
15065 Use of this flag for other registers that have fixed pervasive roles in
15066 the machine's execution model will produce disastrous results.
15068 This flag does not have a negative form, because it specifies a
15069 three-way choice.
15071 @item -fcall-saved-@var{reg}
15072 @opindex fcall-saved
15073 Treat the register named @var{reg} as an allocable register saved by
15074 functions.  It may be allocated even for temporaries or variables that
15075 live across a call.  Functions compiled this way will save and restore
15076 the register @var{reg} if they use it.
15078 It is an error to used this flag with the frame pointer or stack pointer.
15079 Use of this flag for other registers that have fixed pervasive roles in
15080 the machine's execution model will produce disastrous results.
15082 A different sort of disaster will result from the use of this flag for
15083 a register in which function values may be returned.
15085 This flag does not have a negative form, because it specifies a
15086 three-way choice.
15088 @item -fpack-struct[=@var{n}]
15089 @opindex fpack-struct
15090 Without a value specified, pack all structure members together without
15091 holes.  When a value is specified (which must be a small power of two), pack
15092 structure members according to this value, representing the maximum
15093 alignment (that is, objects with default alignment requirements larger than
15094 this will be output potentially unaligned at the next fitting location.
15096 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15097 code that is not binary compatible with code generated without that switch.
15098 Additionally, it makes the code suboptimal.
15099 Use it to conform to a non-default application binary interface.
15101 @item -finstrument-functions
15102 @opindex finstrument-functions
15103 Generate instrumentation calls for entry and exit to functions.  Just
15104 after function entry and just before function exit, the following
15105 profiling functions will be called with the address of the current
15106 function and its call site.  (On some platforms,
15107 @code{__builtin_return_address} does not work beyond the current
15108 function, so the call site information may not be available to the
15109 profiling functions otherwise.)
15111 @smallexample
15112 void __cyg_profile_func_enter (void *this_fn,
15113                                void *call_site);
15114 void __cyg_profile_func_exit  (void *this_fn,
15115                                void *call_site);
15116 @end smallexample
15118 The first argument is the address of the start of the current function,
15119 which may be looked up exactly in the symbol table.
15121 This instrumentation is also done for functions expanded inline in other
15122 functions.  The profiling calls will indicate where, conceptually, the
15123 inline function is entered and exited.  This means that addressable
15124 versions of such functions must be available.  If all your uses of a
15125 function are expanded inline, this may mean an additional expansion of
15126 code size.  If you use @samp{extern inline} in your C code, an
15127 addressable version of such functions must be provided.  (This is
15128 normally the case anyways, but if you get lucky and the optimizer always
15129 expands the functions inline, you might have gotten away without
15130 providing static copies.)
15132 A function may be given the attribute @code{no_instrument_function}, in
15133 which case this instrumentation will not be done.  This can be used, for
15134 example, for the profiling functions listed above, high-priority
15135 interrupt routines, and any functions from which the profiling functions
15136 cannot safely be called (perhaps signal handlers, if the profiling
15137 routines generate output or allocate memory).
15139 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15140 @opindex finstrument-functions-exclude-file-list
15142 Set the list of functions that are excluded from instrumentation (see
15143 the description of @code{-finstrument-functions}).  If the file that
15144 contains a function definition matches with one of @var{file}, then
15145 that function is not instrumented.  The match is done on substrings:
15146 if the @var{file} parameter is a substring of the file name, it is
15147 considered to be a match.
15149 For example,
15150 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15151 will exclude any inline function defined in files whose pathnames
15152 contain @code{/bits/stl} or @code{include/sys}.
15154 If, for some reason, you want to include letter @code{','} in one of
15155 @var{sym}, write @code{'\,'}. For example,
15156 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15157 (note the single quote surrounding the option).
15159 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15160 @opindex finstrument-functions-exclude-function-list
15162 This is similar to @code{-finstrument-functions-exclude-file-list},
15163 but this option sets the list of function names to be excluded from
15164 instrumentation.  The function name to be matched is its user-visible
15165 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15166 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15167 match is done on substrings: if the @var{sym} parameter is a substring
15168 of the function name, it is considered to be a match.
15170 @item -fstack-check
15171 @opindex fstack-check
15172 Generate code to verify that you do not go beyond the boundary of the
15173 stack.  You should specify this flag if you are running in an
15174 environment with multiple threads, but only rarely need to specify it in
15175 a single-threaded environment since stack overflow is automatically
15176 detected on nearly all systems if there is only one stack.
15178 Note that this switch does not actually cause checking to be done; the
15179 operating system must do that.  The switch causes generation of code
15180 to ensure that the operating system sees the stack being extended.
15182 @item -fstack-limit-register=@var{reg}
15183 @itemx -fstack-limit-symbol=@var{sym}
15184 @itemx -fno-stack-limit
15185 @opindex fstack-limit-register
15186 @opindex fstack-limit-symbol
15187 @opindex fno-stack-limit
15188 Generate code to ensure that the stack does not grow beyond a certain value,
15189 either the value of a register or the address of a symbol.  If the stack
15190 would grow beyond the value, a signal is raised.  For most targets,
15191 the signal is raised before the stack overruns the boundary, so
15192 it is possible to catch the signal without taking special precautions.
15194 For instance, if the stack starts at absolute address @samp{0x80000000}
15195 and grows downwards, you can use the flags
15196 @option{-fstack-limit-symbol=__stack_limit} and
15197 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15198 of 128KB@.  Note that this may only work with the GNU linker.
15200 @cindex aliasing of parameters
15201 @cindex parameters, aliased
15202 @item -fargument-alias
15203 @itemx -fargument-noalias
15204 @itemx -fargument-noalias-global
15205 @itemx -fargument-noalias-anything
15206 @opindex fargument-alias
15207 @opindex fargument-noalias
15208 @opindex fargument-noalias-global
15209 @opindex fargument-noalias-anything
15210 Specify the possible relationships among parameters and between
15211 parameters and global data.
15213 @option{-fargument-alias} specifies that arguments (parameters) may
15214 alias each other and may alias global storage.@*
15215 @option{-fargument-noalias} specifies that arguments do not alias
15216 each other, but may alias global storage.@*
15217 @option{-fargument-noalias-global} specifies that arguments do not
15218 alias each other and do not alias global storage.
15219 @option{-fargument-noalias-anything} specifies that arguments do not
15220 alias any other storage.
15222 Each language will automatically use whatever option is required by
15223 the language standard.  You should not need to use these options yourself.
15225 @item -fleading-underscore
15226 @opindex fleading-underscore
15227 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15228 change the way C symbols are represented in the object file.  One use
15229 is to help link with legacy assembly code.
15231 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15232 generate code that is not binary compatible with code generated without that
15233 switch.  Use it to conform to a non-default application binary interface.
15234 Not all targets provide complete support for this switch.
15236 @item -ftls-model=@var{model}
15237 @opindex ftls-model
15238 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15239 The @var{model} argument should be one of @code{global-dynamic},
15240 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15242 The default without @option{-fpic} is @code{initial-exec}; with
15243 @option{-fpic} the default is @code{global-dynamic}.
15245 @item -fvisibility=@var{default|internal|hidden|protected}
15246 @opindex fvisibility
15247 Set the default ELF image symbol visibility to the specified option---all
15248 symbols will be marked with this unless overridden within the code.
15249 Using this feature can very substantially improve linking and
15250 load times of shared object libraries, produce more optimized
15251 code, provide near-perfect API export and prevent symbol clashes.
15252 It is @strong{strongly} recommended that you use this in any shared objects
15253 you distribute.
15255 Despite the nomenclature, @code{default} always means public ie;
15256 available to be linked against from outside the shared object.
15257 @code{protected} and @code{internal} are pretty useless in real-world
15258 usage so the only other commonly used option will be @code{hidden}.
15259 The default if @option{-fvisibility} isn't specified is
15260 @code{default}, i.e., make every
15261 symbol public---this causes the same behavior as previous versions of
15262 GCC@.
15264 A good explanation of the benefits offered by ensuring ELF
15265 symbols have the correct visibility is given by ``How To Write
15266 Shared Libraries'' by Ulrich Drepper (which can be found at
15267 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15268 solution made possible by this option to marking things hidden when
15269 the default is public is to make the default hidden and mark things
15270 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15271 and @code{__attribute__ ((visibility("default")))} instead of
15272 @code{__declspec(dllexport)} you get almost identical semantics with
15273 identical syntax.  This is a great boon to those working with
15274 cross-platform projects.
15276 For those adding visibility support to existing code, you may find
15277 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15278 the declarations you wish to set visibility for with (for example)
15279 @samp{#pragma GCC visibility push(hidden)} and
15280 @samp{#pragma GCC visibility pop}.
15281 Bear in mind that symbol visibility should be viewed @strong{as
15282 part of the API interface contract} and thus all new code should
15283 always specify visibility when it is not the default ie; declarations
15284 only for use within the local DSO should @strong{always} be marked explicitly
15285 as hidden as so to avoid PLT indirection overheads---making this
15286 abundantly clear also aids readability and self-documentation of the code.
15287 Note that due to ISO C++ specification requirements, operator new and
15288 operator delete must always be of default visibility.
15290 Be aware that headers from outside your project, in particular system
15291 headers and headers from any other library you use, may not be
15292 expecting to be compiled with visibility other than the default.  You
15293 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15294 before including any such headers.
15296 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15297 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15298 no modifications.  However, this means that calls to @samp{extern}
15299 functions with no explicit visibility will use the PLT, so it is more
15300 effective to use @samp{__attribute ((visibility))} and/or
15301 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15302 declarations should be treated as hidden.
15304 Note that @samp{-fvisibility} does affect C++ vague linkage
15305 entities. This means that, for instance, an exception class that will
15306 be thrown between DSOs must be explicitly marked with default
15307 visibility so that the @samp{type_info} nodes will be unified between
15308 the DSOs.
15310 An overview of these techniques, their benefits and how to use them
15311 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15313 @end table
15315 @c man end
15317 @node Environment Variables
15318 @section Environment Variables Affecting GCC
15319 @cindex environment variables
15321 @c man begin ENVIRONMENT
15322 This section describes several environment variables that affect how GCC
15323 operates.  Some of them work by specifying directories or prefixes to use
15324 when searching for various kinds of files.  Some are used to specify other
15325 aspects of the compilation environment.
15327 Note that you can also specify places to search using options such as
15328 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15329 take precedence over places specified using environment variables, which
15330 in turn take precedence over those specified by the configuration of GCC@.
15331 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15332 GNU Compiler Collection (GCC) Internals}.
15334 @table @env
15335 @item LANG
15336 @itemx LC_CTYPE
15337 @c @itemx LC_COLLATE
15338 @itemx LC_MESSAGES
15339 @c @itemx LC_MONETARY
15340 @c @itemx LC_NUMERIC
15341 @c @itemx LC_TIME
15342 @itemx LC_ALL
15343 @findex LANG
15344 @findex LC_CTYPE
15345 @c @findex LC_COLLATE
15346 @findex LC_MESSAGES
15347 @c @findex LC_MONETARY
15348 @c @findex LC_NUMERIC
15349 @c @findex LC_TIME
15350 @findex LC_ALL
15351 @cindex locale
15352 These environment variables control the way that GCC uses
15353 localization information that allow GCC to work with different
15354 national conventions.  GCC inspects the locale categories
15355 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15356 so.  These locale categories can be set to any value supported by your
15357 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15358 Kingdom encoded in UTF-8.
15360 The @env{LC_CTYPE} environment variable specifies character
15361 classification.  GCC uses it to determine the character boundaries in
15362 a string; this is needed for some multibyte encodings that contain quote
15363 and escape characters that would otherwise be interpreted as a string
15364 end or escape.
15366 The @env{LC_MESSAGES} environment variable specifies the language to
15367 use in diagnostic messages.
15369 If the @env{LC_ALL} environment variable is set, it overrides the value
15370 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15371 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15372 environment variable.  If none of these variables are set, GCC
15373 defaults to traditional C English behavior.
15375 @item TMPDIR
15376 @findex TMPDIR
15377 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15378 files.  GCC uses temporary files to hold the output of one stage of
15379 compilation which is to be used as input to the next stage: for example,
15380 the output of the preprocessor, which is the input to the compiler
15381 proper.
15383 @item GCC_EXEC_PREFIX
15384 @findex GCC_EXEC_PREFIX
15385 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15386 names of the subprograms executed by the compiler.  No slash is added
15387 when this prefix is combined with the name of a subprogram, but you can
15388 specify a prefix that ends with a slash if you wish.
15390 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15391 an appropriate prefix to use based on the pathname it was invoked with.
15393 If GCC cannot find the subprogram using the specified prefix, it
15394 tries looking in the usual places for the subprogram.
15396 The default value of @env{GCC_EXEC_PREFIX} is
15397 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15398 the installed compiler. In many cases @var{prefix} is the value
15399 of @code{prefix} when you ran the @file{configure} script.
15401 Other prefixes specified with @option{-B} take precedence over this prefix.
15403 This prefix is also used for finding files such as @file{crt0.o} that are
15404 used for linking.
15406 In addition, the prefix is used in an unusual way in finding the
15407 directories to search for header files.  For each of the standard
15408 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15409 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15410 replacing that beginning with the specified prefix to produce an
15411 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15412 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15413 These alternate directories are searched first; the standard directories
15414 come next. If a standard directory begins with the configured
15415 @var{prefix} then the value of @var{prefix} is replaced by
15416 @env{GCC_EXEC_PREFIX} when looking for header files.
15418 @item COMPILER_PATH
15419 @findex COMPILER_PATH
15420 The value of @env{COMPILER_PATH} is a colon-separated list of
15421 directories, much like @env{PATH}.  GCC tries the directories thus
15422 specified when searching for subprograms, if it can't find the
15423 subprograms using @env{GCC_EXEC_PREFIX}.
15425 @item LIBRARY_PATH
15426 @findex LIBRARY_PATH
15427 The value of @env{LIBRARY_PATH} is a colon-separated list of
15428 directories, much like @env{PATH}.  When configured as a native compiler,
15429 GCC tries the directories thus specified when searching for special
15430 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15431 using GCC also uses these directories when searching for ordinary
15432 libraries for the @option{-l} option (but directories specified with
15433 @option{-L} come first).
15435 @item LANG
15436 @findex LANG
15437 @cindex locale definition
15438 This variable is used to pass locale information to the compiler.  One way in
15439 which this information is used is to determine the character set to be used
15440 when character literals, string literals and comments are parsed in C and C++.
15441 When the compiler is configured to allow multibyte characters,
15442 the following values for @env{LANG} are recognized:
15444 @table @samp
15445 @item C-JIS
15446 Recognize JIS characters.
15447 @item C-SJIS
15448 Recognize SJIS characters.
15449 @item C-EUCJP
15450 Recognize EUCJP characters.
15451 @end table
15453 If @env{LANG} is not defined, or if it has some other value, then the
15454 compiler will use mblen and mbtowc as defined by the default locale to
15455 recognize and translate multibyte characters.
15456 @end table
15458 @noindent
15459 Some additional environments variables affect the behavior of the
15460 preprocessor.
15462 @include cppenv.texi
15464 @c man end
15466 @node Precompiled Headers
15467 @section Using Precompiled Headers
15468 @cindex precompiled headers
15469 @cindex speed of compilation
15471 Often large projects have many header files that are included in every
15472 source file.  The time the compiler takes to process these header files
15473 over and over again can account for nearly all of the time required to
15474 build the project.  To make builds faster, GCC allows users to
15475 `precompile' a header file; then, if builds can use the precompiled
15476 header file they will be much faster.
15478 To create a precompiled header file, simply compile it as you would any
15479 other file, if necessary using the @option{-x} option to make the driver
15480 treat it as a C or C++ header file.  You will probably want to use a
15481 tool like @command{make} to keep the precompiled header up-to-date when
15482 the headers it contains change.
15484 A precompiled header file will be searched for when @code{#include} is
15485 seen in the compilation.  As it searches for the included file
15486 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15487 compiler looks for a precompiled header in each directory just before it
15488 looks for the include file in that directory.  The name searched for is
15489 the name specified in the @code{#include} with @samp{.gch} appended.  If
15490 the precompiled header file can't be used, it is ignored.
15492 For instance, if you have @code{#include "all.h"}, and you have
15493 @file{all.h.gch} in the same directory as @file{all.h}, then the
15494 precompiled header file will be used if possible, and the original
15495 header will be used otherwise.
15497 Alternatively, you might decide to put the precompiled header file in a
15498 directory and use @option{-I} to ensure that directory is searched
15499 before (or instead of) the directory containing the original header.
15500 Then, if you want to check that the precompiled header file is always
15501 used, you can put a file of the same name as the original header in this
15502 directory containing an @code{#error} command.
15504 This also works with @option{-include}.  So yet another way to use
15505 precompiled headers, good for projects not designed with precompiled
15506 header files in mind, is to simply take most of the header files used by
15507 a project, include them from another header file, precompile that header
15508 file, and @option{-include} the precompiled header.  If the header files
15509 have guards against multiple inclusion, they will be skipped because
15510 they've already been included (in the precompiled header).
15512 If you need to precompile the same header file for different
15513 languages, targets, or compiler options, you can instead make a
15514 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15515 header in the directory, perhaps using @option{-o}.  It doesn't matter
15516 what you call the files in the directory, every precompiled header in
15517 the directory will be considered.  The first precompiled header
15518 encountered in the directory that is valid for this compilation will
15519 be used; they're searched in no particular order.
15521 There are many other possibilities, limited only by your imagination,
15522 good sense, and the constraints of your build system.
15524 A precompiled header file can be used only when these conditions apply:
15526 @itemize
15527 @item
15528 Only one precompiled header can be used in a particular compilation.
15530 @item
15531 A precompiled header can't be used once the first C token is seen.  You
15532 can have preprocessor directives before a precompiled header; you can
15533 even include a precompiled header from inside another header, so long as
15534 there are no C tokens before the @code{#include}.
15536 @item
15537 The precompiled header file must be produced for the same language as
15538 the current compilation.  You can't use a C precompiled header for a C++
15539 compilation.
15541 @item
15542 The precompiled header file must have been produced by the same compiler
15543 binary as the current compilation is using.
15545 @item
15546 Any macros defined before the precompiled header is included must
15547 either be defined in the same way as when the precompiled header was
15548 generated, or must not affect the precompiled header, which usually
15549 means that they don't appear in the precompiled header at all.
15551 The @option{-D} option is one way to define a macro before a
15552 precompiled header is included; using a @code{#define} can also do it.
15553 There are also some options that define macros implicitly, like
15554 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15555 defined this way.
15557 @item If debugging information is output when using the precompiled
15558 header, using @option{-g} or similar, the same kind of debugging information
15559 must have been output when building the precompiled header.  However,
15560 a precompiled header built using @option{-g} can be used in a compilation
15561 when no debugging information is being output.
15563 @item The same @option{-m} options must generally be used when building
15564 and using the precompiled header.  @xref{Submodel Options},
15565 for any cases where this rule is relaxed.
15567 @item Each of the following options must be the same when building and using
15568 the precompiled header:
15570 @gccoptlist{-fexceptions -funit-at-a-time}
15572 @item
15573 Some other command-line options starting with @option{-f},
15574 @option{-p}, or @option{-O} must be defined in the same way as when
15575 the precompiled header was generated.  At present, it's not clear
15576 which options are safe to change and which are not; the safest choice
15577 is to use exactly the same options when generating and using the
15578 precompiled header.  The following are known to be safe:
15580 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15581 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15582 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15583 -pedantic-errors}
15585 @end itemize
15587 For all of these except the last, the compiler will automatically
15588 ignore the precompiled header if the conditions aren't met.  If you
15589 find an option combination that doesn't work and doesn't cause the
15590 precompiled header to be ignored, please consider filing a bug report,
15591 see @ref{Bugs}.
15593 If you do use differing options when generating and using the
15594 precompiled header, the actual behavior will be a mixture of the
15595 behavior for the options.  For instance, if you use @option{-g} to
15596 generate the precompiled header but not when using it, you may or may
15597 not get debugging information for routines in the precompiled header.
15599 @node Running Protoize
15600 @section Running Protoize
15602 The program @code{protoize} is an optional part of GCC@.  You can use
15603 it to add prototypes to a program, thus converting the program to ISO
15604 C in one respect.  The companion program @code{unprotoize} does the
15605 reverse: it removes argument types from any prototypes that are found.
15607 When you run these programs, you must specify a set of source files as
15608 command line arguments.  The conversion programs start out by compiling
15609 these files to see what functions they define.  The information gathered
15610 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15612 After scanning comes actual conversion.  The specified files are all
15613 eligible to be converted; any files they include (whether sources or
15614 just headers) are eligible as well.
15616 But not all the eligible files are converted.  By default,
15617 @code{protoize} and @code{unprotoize} convert only source and header
15618 files in the current directory.  You can specify additional directories
15619 whose files should be converted with the @option{-d @var{directory}}
15620 option.  You can also specify particular files to exclude with the
15621 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15622 directory name matches one of the specified directory names, and its
15623 name within the directory has not been excluded.
15625 Basic conversion with @code{protoize} consists of rewriting most
15626 function definitions and function declarations to specify the types of
15627 the arguments.  The only ones not rewritten are those for varargs
15628 functions.
15630 @code{protoize} optionally inserts prototype declarations at the
15631 beginning of the source file, to make them available for any calls that
15632 precede the function's definition.  Or it can insert prototype
15633 declarations with block scope in the blocks where undeclared functions
15634 are called.
15636 Basic conversion with @code{unprotoize} consists of rewriting most
15637 function declarations to remove any argument types, and rewriting
15638 function definitions to the old-style pre-ISO form.
15640 Both conversion programs print a warning for any function declaration or
15641 definition that they can't convert.  You can suppress these warnings
15642 with @option{-q}.
15644 The output from @code{protoize} or @code{unprotoize} replaces the
15645 original source file.  The original file is renamed to a name ending
15646 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15647 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15648 for DOS) file already exists, then the source file is simply discarded.
15650 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15651 scan the program and collect information about the functions it uses.
15652 So neither of these programs will work until GCC is installed.
15654 Here is a table of the options you can use with @code{protoize} and
15655 @code{unprotoize}.  Each option works with both programs unless
15656 otherwise stated.
15658 @table @code
15659 @item -B @var{directory}
15660 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15661 usual directory (normally @file{/usr/local/lib}).  This file contains
15662 prototype information about standard system functions.  This option
15663 applies only to @code{protoize}.
15665 @item -c @var{compilation-options}
15666 Use @var{compilation-options} as the options when running @command{gcc} to
15667 produce the @samp{.X} files.  The special option @option{-aux-info} is
15668 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15670 Note that the compilation options must be given as a single argument to
15671 @code{protoize} or @code{unprotoize}.  If you want to specify several
15672 @command{gcc} options, you must quote the entire set of compilation options
15673 to make them a single word in the shell.
15675 There are certain @command{gcc} arguments that you cannot use, because they
15676 would produce the wrong kind of output.  These include @option{-g},
15677 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15678 the @var{compilation-options}, they are ignored.
15680 @item -C
15681 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15682 systems) instead of @samp{.c}.  This is convenient if you are converting
15683 a C program to C++.  This option applies only to @code{protoize}.
15685 @item -g
15686 Add explicit global declarations.  This means inserting explicit
15687 declarations at the beginning of each source file for each function
15688 that is called in the file and was not declared.  These declarations
15689 precede the first function definition that contains a call to an
15690 undeclared function.  This option applies only to @code{protoize}.
15692 @item -i @var{string}
15693 Indent old-style parameter declarations with the string @var{string}.
15694 This option applies only to @code{protoize}.
15696 @code{unprotoize} converts prototyped function definitions to old-style
15697 function definitions, where the arguments are declared between the
15698 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15699 uses five spaces as the indentation.  If you want to indent with just
15700 one space instead, use @option{-i " "}.
15702 @item -k
15703 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15704 is finished.
15706 @item -l
15707 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15708 a prototype declaration for each function in each block which calls the
15709 function without any declaration.  This option applies only to
15710 @code{protoize}.
15712 @item -n
15713 Make no real changes.  This mode just prints information about the conversions
15714 that would have been done without @option{-n}.
15716 @item -N
15717 Make no @samp{.save} files.  The original files are simply deleted.
15718 Use this option with caution.
15720 @item -p @var{program}
15721 Use the program @var{program} as the compiler.  Normally, the name
15722 @file{gcc} is used.
15724 @item -q
15725 Work quietly.  Most warnings are suppressed.
15727 @item -v
15728 Print the version number, just like @option{-v} for @command{gcc}.
15729 @end table
15731 If you need special compiler options to compile one of your program's
15732 source files, then you should generate that file's @samp{.X} file
15733 specially, by running @command{gcc} on that source file with the
15734 appropriate options and the option @option{-aux-info}.  Then run
15735 @code{protoize} on the entire set of files.  @code{protoize} will use
15736 the existing @samp{.X} file because it is newer than the source file.
15737 For example:
15739 @smallexample
15740 gcc -Dfoo=bar file1.c -aux-info file1.X
15741 protoize *.c
15742 @end smallexample
15744 @noindent
15745 You need to include the special files along with the rest in the
15746 @code{protoize} command, even though their @samp{.X} files already
15747 exist, because otherwise they won't get converted.
15749 @xref{Protoize Caveats}, for more information on how to use
15750 @code{protoize} successfully.