Check in tree-dce enh to trunk
[official-gcc.git] / gcc / doc / invoke.texi
blob0fdadd2aec14a8bba39070362874da3b9d6e7896
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 -ftree-builtin-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-builtin-dce @gol
5161 -ftree-dominator-opts @gol
5162 -ftree-dse @gol
5163 -ftree-fre @gol
5164 -ftree-sra @gol
5165 -ftree-ter @gol
5166 -funit-at-a-time}
5168 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5169 where doing so does not interfere with debugging.
5171 @item -O2
5172 @opindex O2
5173 Optimize even more.  GCC performs nearly all supported optimizations
5174 that do not involve a space-speed tradeoff.  The compiler does not
5175 perform loop unrolling or function inlining when you specify @option{-O2}.
5176 As compared to @option{-O}, this option increases both compilation time
5177 and the performance of the generated code.
5179 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5180 also turns on the following optimization flags:
5181 @gccoptlist{-fthread-jumps @gol
5182 -falign-functions  -falign-jumps @gol
5183 -falign-loops  -falign-labels @gol
5184 -fcaller-saves @gol
5185 -fcrossjumping @gol
5186 -fcse-follow-jumps  -fcse-skip-blocks @gol
5187 -fdelete-null-pointer-checks @gol
5188 -fexpensive-optimizations @gol
5189 -fgcse  -fgcse-lm  @gol
5190 -foptimize-sibling-calls @gol
5191 -fpeephole2 @gol
5192 -fregmove @gol
5193 -freorder-blocks  -freorder-functions @gol
5194 -frerun-cse-after-loop  @gol
5195 -fsched-interblock  -fsched-spec @gol
5196 -fschedule-insns  -fschedule-insns2 @gol
5197 -fstrict-aliasing -fstrict-overflow @gol
5198 -ftree-pre @gol
5199 -ftree-vrp}
5201 Please note the warning under @option{-fgcse} about
5202 invoking @option{-O2} on programs that use computed gotos.
5204 @item -O3
5205 @opindex O3
5206 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5207 @option{-O2} and also turns on the @option{-finline-functions},
5208 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5209 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5211 @item -O0
5212 @opindex O0
5213 Reduce compilation time and make debugging produce the expected
5214 results.  This is the default.
5216 @item -Os
5217 @opindex Os
5218 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5219 do not typically increase code size.  It also performs further
5220 optimizations designed to reduce code size.
5222 @option{-Os} disables the following optimization flags:
5223 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5224 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5225 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5227 If you use multiple @option{-O} options, with or without level numbers,
5228 the last such option is the one that is effective.
5229 @end table
5231 Options of the form @option{-f@var{flag}} specify machine-independent
5232 flags.  Most flags have both positive and negative forms; the negative
5233 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5234 below, only one of the forms is listed---the one you typically will
5235 use.  You can figure out the other form by either removing @samp{no-}
5236 or adding it.
5238 The following options control specific optimizations.  They are either
5239 activated by @option{-O} options or are related to ones that are.  You
5240 can use the following flags in the rare cases when ``fine-tuning'' of
5241 optimizations to be performed is desired.
5243 @table @gcctabopt
5244 @item -fno-default-inline
5245 @opindex fno-default-inline
5246 Do not make member functions inline by default merely because they are
5247 defined inside the class scope (C++ only).  Otherwise, when you specify
5248 @w{@option{-O}}, member functions defined inside class scope are compiled
5249 inline by default; i.e., you don't need to add @samp{inline} in front of
5250 the member function name.
5252 @item -fno-defer-pop
5253 @opindex fno-defer-pop
5254 Always pop the arguments to each function call as soon as that function
5255 returns.  For machines which must pop arguments after a function call,
5256 the compiler normally lets arguments accumulate on the stack for several
5257 function calls and pops them all at once.
5259 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5261 @item -fforward-propagate
5262 @opindex fforward-propagate
5263 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5264 instructions and checks if the result can be simplified.  If loop unrolling
5265 is active, two passes are performed and the second is scheduled after
5266 loop unrolling.
5268 This option is enabled by default at optimization levels @option{-O2},
5269 @option{-O3}, @option{-Os}.
5271 @item -fomit-frame-pointer
5272 @opindex fomit-frame-pointer
5273 Don't keep the frame pointer in a register for functions that
5274 don't need one.  This avoids the instructions to save, set up and
5275 restore frame pointers; it also makes an extra register available
5276 in many functions.  @strong{It also makes debugging impossible on
5277 some machines.}
5279 On some machines, such as the VAX, this flag has no effect, because
5280 the standard calling sequence automatically handles the frame pointer
5281 and nothing is saved by pretending it doesn't exist.  The
5282 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5283 whether a target machine supports this flag.  @xref{Registers,,Register
5284 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5286 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5288 @item -foptimize-sibling-calls
5289 @opindex foptimize-sibling-calls
5290 Optimize sibling and tail recursive calls.
5292 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5294 @item -fno-inline
5295 @opindex fno-inline
5296 Don't pay attention to the @code{inline} keyword.  Normally this option
5297 is used to keep the compiler from expanding any functions inline.
5298 Note that if you are not optimizing, no functions can be expanded inline.
5300 @item -finline-small-functions
5301 @opindex finline-small-functions
5302 Integrate functions into their callers when their body is smaller than expected
5303 function call code (so overall size of program gets smaller).  The compiler
5304 heuristically decides which functions are simple enough to be worth integrating
5305 in this way.
5307 Enabled at level @option{-O2}.
5309 @item -finline-functions
5310 @opindex finline-functions
5311 Integrate all simple functions into their callers.  The compiler
5312 heuristically decides which functions are simple enough to be worth
5313 integrating in this way.
5315 If all calls to a given function are integrated, and the function is
5316 declared @code{static}, then the function is normally not output as
5317 assembler code in its own right.
5319 Enabled at level @option{-O3}.
5321 @item -finline-functions-called-once
5322 @opindex finline-functions-called-once
5323 Consider all @code{static} functions called once for inlining into their
5324 caller even if they are not marked @code{inline}.  If a call to a given
5325 function is integrated, then the function is not output as assembler code
5326 in its own right.
5328 Enabled if @option{-funit-at-a-time} is enabled.
5330 @item -fearly-inlining
5331 @opindex fearly-inlining
5332 Inline functions marked by @code{always_inline} and functions whose body seems
5333 smaller than the function call overhead early before doing
5334 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5335 makes profiling significantly cheaper and usually inlining faster on programs
5336 having large chains of nested wrapper functions.
5338 Enabled by default.
5340 @item -finline-limit=@var{n}
5341 @opindex finline-limit
5342 By default, GCC limits the size of functions that can be inlined.  This flag
5343 allows coarse control of this limit.  @var{n} is the size of functions that
5344 can be inlined in number of pseudo instructions.
5346 Inlining is actually controlled by a number of parameters, which may be
5347 specified individually by using @option{--param @var{name}=@var{value}}.
5348 The @option{-finline-limit=@var{n}} option sets some of these parameters
5349 as follows:
5351 @table @gcctabopt
5352 @item max-inline-insns-single
5353  is set to @var{n}/2.
5354 @item max-inline-insns-auto
5355  is set to @var{n}/2.
5356 @end table
5358 See below for a documentation of the individual
5359 parameters controlling inlining and for the defaults of these parameters.
5361 @emph{Note:} there may be no value to @option{-finline-limit} that results
5362 in default behavior.
5364 @emph{Note:} pseudo instruction represents, in this particular context, an
5365 abstract measurement of function's size.  In no way does it represent a count
5366 of assembly instructions and as such its exact meaning might change from one
5367 release to an another.
5369 @item -fkeep-inline-functions
5370 @opindex fkeep-inline-functions
5371 In C, emit @code{static} functions that are declared @code{inline}
5372 into the object file, even if the function has been inlined into all
5373 of its callers.  This switch does not affect functions using the
5374 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5375 inline functions into the object file.
5377 @item -fkeep-static-consts
5378 @opindex fkeep-static-consts
5379 Emit variables declared @code{static const} when optimization isn't turned
5380 on, even if the variables aren't referenced.
5382 GCC enables this option by default.  If you want to force the compiler to
5383 check if the variable was referenced, regardless of whether or not
5384 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5386 @item -fmerge-constants
5387 @opindex fmerge-constants
5388 Attempt to merge identical constants (string constants and floating point
5389 constants) across compilation units.
5391 This option is the default for optimized compilation if the assembler and
5392 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5393 behavior.
5395 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5397 @item -fmerge-all-constants
5398 @opindex fmerge-all-constants
5399 Attempt to merge identical constants and identical variables.
5401 This option implies @option{-fmerge-constants}.  In addition to
5402 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5403 arrays or initialized constant variables with integral or floating point
5404 types.  Languages like C or C++ require each non-automatic variable to
5405 have distinct location, so using this option will result in non-conforming
5406 behavior.
5408 @item -fmodulo-sched
5409 @opindex fmodulo-sched
5410 Perform swing modulo scheduling immediately before the first scheduling
5411 pass.  This pass looks at innermost loops and reorders their
5412 instructions by overlapping different iterations.
5414 @item -fmodulo-sched-allow-regmoves
5415 @opindex fmodulo-sched-allow-regmoves
5416 Perform more aggressive SMS based modulo scheduling with register moves
5417 allowed.  By setting this flag certain anti-dependences edges will be
5418 deleted which will trigger the generation of reg-moves based on the
5419 life-range analysis.  This option is effective only with
5420 @option{-fmodulo-sched} enabled.
5422 @item -fno-branch-count-reg
5423 @opindex fno-branch-count-reg
5424 Do not use ``decrement and branch'' instructions on a count register,
5425 but instead generate a sequence of instructions that decrement a
5426 register, compare it against zero, then branch based upon the result.
5427 This option is only meaningful on architectures that support such
5428 instructions, which include x86, PowerPC, IA-64 and S/390.
5430 The default is @option{-fbranch-count-reg}.
5432 @item -fno-function-cse
5433 @opindex fno-function-cse
5434 Do not put function addresses in registers; make each instruction that
5435 calls a constant function contain the function's address explicitly.
5437 This option results in less efficient code, but some strange hacks
5438 that alter the assembler output may be confused by the optimizations
5439 performed when this option is not used.
5441 The default is @option{-ffunction-cse}
5443 @item -fno-zero-initialized-in-bss
5444 @opindex fno-zero-initialized-in-bss
5445 If the target supports a BSS section, GCC by default puts variables that
5446 are initialized to zero into BSS@.  This can save space in the resulting
5447 code.
5449 This option turns off this behavior because some programs explicitly
5450 rely on variables going to the data section.  E.g., so that the
5451 resulting executable can find the beginning of that section and/or make
5452 assumptions based on that.
5454 The default is @option{-fzero-initialized-in-bss}.
5456 @item -fmudflap -fmudflapth -fmudflapir
5457 @opindex fmudflap
5458 @opindex fmudflapth
5459 @opindex fmudflapir
5460 @cindex bounds checking
5461 @cindex mudflap
5462 For front-ends that support it (C and C++), instrument all risky
5463 pointer/array dereferencing operations, some standard library
5464 string/heap functions, and some other associated constructs with
5465 range/validity tests.  Modules so instrumented should be immune to
5466 buffer overflows, invalid heap use, and some other classes of C/C++
5467 programming errors.  The instrumentation relies on a separate runtime
5468 library (@file{libmudflap}), which will be linked into a program if
5469 @option{-fmudflap} is given at link time.  Run-time behavior of the
5470 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5471 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5472 for its options.
5474 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5475 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5476 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5477 instrumentation should ignore pointer reads.  This produces less
5478 instrumentation (and therefore faster execution) and still provides
5479 some protection against outright memory corrupting writes, but allows
5480 erroneously read data to propagate within a program.
5482 @item -fthread-jumps
5483 @opindex fthread-jumps
5484 Perform optimizations where we check to see if a jump branches to a
5485 location where another comparison subsumed by the first is found.  If
5486 so, the first branch is redirected to either the destination of the
5487 second branch or a point immediately following it, depending on whether
5488 the condition is known to be true or false.
5490 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5492 @item -fsplit-wide-types
5493 @opindex fsplit-wide-types
5494 When using a type that occupies multiple registers, such as @code{long
5495 long} on a 32-bit system, split the registers apart and allocate them
5496 independently.  This normally generates better code for those types,
5497 but may make debugging more difficult.
5499 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5500 @option{-Os}.
5502 @item -fcse-follow-jumps
5503 @opindex fcse-follow-jumps
5504 In common subexpression elimination (CSE), scan through jump instructions
5505 when the target of the jump is not reached by any other path.  For
5506 example, when CSE encounters an @code{if} statement with an
5507 @code{else} clause, CSE will follow the jump when the condition
5508 tested is false.
5510 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5512 @item -fcse-skip-blocks
5513 @opindex fcse-skip-blocks
5514 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5515 follow jumps which conditionally skip over blocks.  When CSE
5516 encounters a simple @code{if} statement with no else clause,
5517 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5518 body of the @code{if}.
5520 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5522 @item -frerun-cse-after-loop
5523 @opindex frerun-cse-after-loop
5524 Re-run common subexpression elimination after loop optimizations has been
5525 performed.
5527 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5529 @item -fgcse
5530 @opindex fgcse
5531 Perform a global common subexpression elimination pass.
5532 This pass also performs global constant and copy propagation.
5534 @emph{Note:} When compiling a program using computed gotos, a GCC
5535 extension, you may get better runtime performance if you disable
5536 the global common subexpression elimination pass by adding
5537 @option{-fno-gcse} to the command line.
5539 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5541 @item -fgcse-lm
5542 @opindex fgcse-lm
5543 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5544 attempt to move loads which are only killed by stores into themselves.  This
5545 allows a loop containing a load/store sequence to be changed to a load outside
5546 the loop, and a copy/store within the loop.
5548 Enabled by default when gcse is enabled.
5550 @item -fgcse-sm
5551 @opindex fgcse-sm
5552 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5553 global common subexpression elimination.  This pass will attempt to move
5554 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5555 loops containing a load/store sequence can be changed to a load before
5556 the loop and a store after the loop.
5558 Not enabled at any optimization level.
5560 @item -fgcse-las
5561 @opindex fgcse-las
5562 When @option{-fgcse-las} is enabled, the global common subexpression
5563 elimination pass eliminates redundant loads that come after stores to the
5564 same memory location (both partial and full redundancies).
5566 Not enabled at any optimization level.
5568 @item -fgcse-after-reload
5569 @opindex fgcse-after-reload
5570 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5571 pass is performed after reload.  The purpose of this pass is to cleanup
5572 redundant spilling.
5574 @item -funsafe-loop-optimizations
5575 @opindex funsafe-loop-optimizations
5576 If given, the loop optimizer will assume that loop indices do not
5577 overflow, and that the loops with nontrivial exit condition are not
5578 infinite.  This enables a wider range of loop optimizations even if
5579 the loop optimizer itself cannot prove that these assumptions are valid.
5580 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5581 if it finds this kind of loop.
5583 @item -fcrossjumping
5584 @opindex fcrossjumping
5585 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5586 resulting code may or may not perform better than without cross-jumping.
5588 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5590 @item -fauto-inc-dec
5591 @opindex fauto-inc-dec
5592 Combine increments or decrements of addresses with memory accesses.
5593 This pass is always skipped on architectures that do not have
5594 instructions to support this.  Enabled by default at @option{-O} and
5595 higher on architectures that support this.
5597 @item -fdce
5598 @opindex fdce
5599 Perform dead code elimination (DCE) on RTL@.
5600 Enabled by default at @option{-O} and higher.
5602 @item -fdse
5603 @opindex fdse
5604 Perform dead store elimination (DSE) on RTL@.
5605 Enabled by default at @option{-O} and higher.
5607 @item -fif-conversion
5608 @opindex fif-conversion
5609 Attempt to transform conditional jumps into branch-less equivalents.  This
5610 include use of conditional moves, min, max, set flags and abs instructions, and
5611 some tricks doable by standard arithmetics.  The use of conditional execution
5612 on chips where it is available is controlled by @code{if-conversion2}.
5614 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5616 @item -fif-conversion2
5617 @opindex fif-conversion2
5618 Use conditional execution (where available) to transform conditional jumps into
5619 branch-less equivalents.
5621 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5623 @item -fdelete-null-pointer-checks
5624 @opindex fdelete-null-pointer-checks
5625 Use global dataflow analysis to identify and eliminate useless checks
5626 for null pointers.  The compiler assumes that dereferencing a null
5627 pointer would have halted the program.  If a pointer is checked after
5628 it has already been dereferenced, it cannot be null.
5630 In some environments, this assumption is not true, and programs can
5631 safely dereference null pointers.  Use
5632 @option{-fno-delete-null-pointer-checks} to disable this optimization
5633 for programs which depend on that behavior.
5635 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5637 @item -fexpensive-optimizations
5638 @opindex fexpensive-optimizations
5639 Perform a number of minor optimizations that are relatively expensive.
5641 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5643 @item -foptimize-register-move
5644 @itemx -fregmove
5645 @opindex foptimize-register-move
5646 @opindex fregmove
5647 Attempt to reassign register numbers in move instructions and as
5648 operands of other simple instructions in order to maximize the amount of
5649 register tying.  This is especially helpful on machines with two-operand
5650 instructions.
5652 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5653 optimization.
5655 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5657 @item -fdelayed-branch
5658 @opindex fdelayed-branch
5659 If supported for the target machine, attempt to reorder instructions
5660 to exploit instruction slots available after delayed branch
5661 instructions.
5663 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5665 @item -fschedule-insns
5666 @opindex fschedule-insns
5667 If supported for the target machine, attempt to reorder instructions to
5668 eliminate execution stalls due to required data being unavailable.  This
5669 helps machines that have slow floating point or memory load instructions
5670 by allowing other instructions to be issued until the result of the load
5671 or floating point instruction is required.
5673 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5675 @item -fschedule-insns2
5676 @opindex fschedule-insns2
5677 Similar to @option{-fschedule-insns}, but requests an additional pass of
5678 instruction scheduling after register allocation has been done.  This is
5679 especially useful on machines with a relatively small number of
5680 registers and where memory load instructions take more than one cycle.
5682 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5684 @item -fno-sched-interblock
5685 @opindex fno-sched-interblock
5686 Don't schedule instructions across basic blocks.  This is normally
5687 enabled by default when scheduling before register allocation, i.e.@:
5688 with @option{-fschedule-insns} or at @option{-O2} or higher.
5690 @item -fno-sched-spec
5691 @opindex fno-sched-spec
5692 Don't allow speculative motion of non-load instructions.  This is normally
5693 enabled by default when scheduling before register allocation, i.e.@:
5694 with @option{-fschedule-insns} or at @option{-O2} or higher.
5696 @item -fsched-spec-load
5697 @opindex fsched-spec-load
5698 Allow speculative motion of some load instructions.  This only makes
5699 sense when scheduling before register allocation, i.e.@: with
5700 @option{-fschedule-insns} or at @option{-O2} or higher.
5702 @item -fsched-spec-load-dangerous
5703 @opindex fsched-spec-load-dangerous
5704 Allow speculative motion of more load instructions.  This only makes
5705 sense when scheduling before register allocation, i.e.@: with
5706 @option{-fschedule-insns} or at @option{-O2} or higher.
5708 @item -fsched-stalled-insns
5709 @itemx -fsched-stalled-insns=@var{n}
5710 @opindex fsched-stalled-insns
5711 Define how many insns (if any) can be moved prematurely from the queue
5712 of stalled insns into the ready list, during the second scheduling pass.
5713 @option{-fno-sched-stalled-insns} means that no insns will be moved
5714 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
5715 on how many queued insns can be moved prematurely.
5716 @option{-fsched-stalled-insns} without a value is equivalent to
5717 @option{-fsched-stalled-insns=1}.
5719 @item -fsched-stalled-insns-dep
5720 @itemx -fsched-stalled-insns-dep=@var{n}
5721 @opindex fsched-stalled-insns-dep
5722 Define how many insn groups (cycles) will be examined for a dependency
5723 on a stalled insn that is candidate for premature removal from the queue
5724 of stalled insns.  This has an effect only during the second scheduling pass,
5725 and only if @option{-fsched-stalled-insns} is used.
5726 @option{-fno-sched-stalled-insns-dep} is equivalent to
5727 @option{-fsched-stalled-insns-dep=0}.
5728 @option{-fsched-stalled-insns-dep} without a value is equivalent to
5729 @option{-fsched-stalled-insns-dep=1}.
5731 @item -fsched2-use-superblocks
5732 @opindex fsched2-use-superblocks
5733 When scheduling after register allocation, do use superblock scheduling
5734 algorithm.  Superblock scheduling allows motion across basic block boundaries
5735 resulting on faster schedules.  This option is experimental, as not all machine
5736 descriptions used by GCC model the CPU closely enough to avoid unreliable
5737 results from the algorithm.
5739 This only makes sense when scheduling after register allocation, i.e.@: with
5740 @option{-fschedule-insns2} or at @option{-O2} or higher.
5742 @item -fsched2-use-traces
5743 @opindex fsched2-use-traces
5744 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5745 allocation and additionally perform code duplication in order to increase the
5746 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5747 trace formation.
5749 This mode should produce faster but significantly longer programs.  Also
5750 without @option{-fbranch-probabilities} the traces constructed may not
5751 match the reality and hurt the performance.  This only makes
5752 sense when scheduling after register allocation, i.e.@: with
5753 @option{-fschedule-insns2} or at @option{-O2} or higher.
5755 @item -fsee
5756 @opindex fsee
5757 Eliminate redundant sign extension instructions and move the non-redundant
5758 ones to optimal placement using lazy code motion (LCM).
5760 @item -freschedule-modulo-scheduled-loops
5761 @opindex freschedule-modulo-scheduled-loops
5762 The modulo scheduling comes before the traditional scheduling, if a loop
5763 was modulo scheduled we may want to prevent the later scheduling passes
5764 from changing its schedule, we use this option to control that.
5766 @item -fcaller-saves
5767 @opindex fcaller-saves
5768 Enable values to be allocated in registers that will be clobbered by
5769 function calls, by emitting extra instructions to save and restore the
5770 registers around such calls.  Such allocation is done only when it
5771 seems to result in better code than would otherwise be produced.
5773 This option is always enabled by default on certain machines, usually
5774 those which have no call-preserved registers to use instead.
5776 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5778 @item -ftree-reassoc
5779 @opindex ftree-reassoc
5780 Perform reassociation on trees.  This flag is enabled by default
5781 at @option{-O} and higher.
5783 @item -ftree-pre
5784 @opindex ftree-pre
5785 Perform partial redundancy elimination (PRE) on trees.  This flag is
5786 enabled by default at @option{-O2} and @option{-O3}.
5788 @item -ftree-fre
5789 @opindex ftree-fre
5790 Perform full redundancy elimination (FRE) on trees.  The difference
5791 between FRE and PRE is that FRE only considers expressions
5792 that are computed on all paths leading to the redundant computation.
5793 This analysis is faster than PRE, though it exposes fewer redundancies.
5794 This flag is enabled by default at @option{-O} and higher.
5796 @item -ftree-copy-prop
5797 @opindex ftree-copy-prop
5798 Perform copy propagation on trees.  This pass eliminates unnecessary
5799 copy operations.  This flag is enabled by default at @option{-O} and
5800 higher.
5802 @item -fipa-pure-const
5803 @opindex fipa-pure-const
5804 Discover which functions are pure or constant.
5805 Enabled by default at @option{-O} and higher.
5807 @item -fipa-reference
5808 @opindex fipa-reference
5809 Discover which static variables do not escape cannot escape the
5810 compilation unit.
5811 Enabled by default at @option{-O} and higher.
5813 @item -fipa-struct-reorg
5814 @opindex fipa-struct-reorg
5815 Perform structure reorganization optimization, that change C-like structures 
5816 layout in order to better utilize spatial locality.  This transformation is 
5817 affective for programs containing arrays of structures.  Available in two 
5818 compilation modes: profile-based (enabled with @option{-fprofile-generate})
5819 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
5820 to provide the safety of this transformation.  It works only in whole program
5821 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
5822 enabled.  Structures considered @samp{cold} by this transformation are not
5823 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
5825 With this flag, the program debug info reflects a new structure layout.
5827 @item -fipa-pta
5828 @opindex fipa-pta
5829 Perform interprocedural pointer analysis.
5831 @item -fipa-cp
5832 @opindex fipa-cp
5833 Perform interprocedural constant propagation.
5834 This optimization analyzes the program to determine when values passed
5835 to functions are constants and then optimizes accordingly.  
5836 This optimization can substantially increase performance
5837 if the application has constants passed to functions, but
5838 because this optimization can create multiple copies of functions,
5839 it may significantly increase code size.
5841 @item -fipa-matrix-reorg
5842 @opindex fipa-matrix-reorg
5843 Perform matrix flattening and transposing.
5844 Matrix flattening tries to replace a m-dimensional matrix 
5845 with its equivalent n-dimensional matrix, where n < m.
5846 This reduces the level of indirection needed for accessing the elements
5847 of the matrix. The second optimization is matrix transposing that
5848 attemps to change the order of the matrix's dimensions in order to 
5849 improve cache locality.
5850 Both optimizations need fwhole-program flag. 
5851 Transposing is enabled only if profiling information is avaliable.
5854 @item -ftree-sink
5855 @opindex ftree-sink
5856 Perform forward store motion  on trees.  This flag is
5857 enabled by default at @option{-O} and higher.
5859 @item -ftree-ccp
5860 @opindex ftree-ccp
5861 Perform sparse conditional constant propagation (CCP) on trees.  This
5862 pass only operates on local scalar variables and is enabled by default
5863 at @option{-O} and higher.
5865 @item -ftree-store-ccp
5866 @opindex ftree-store-ccp
5867 Perform sparse conditional constant propagation (CCP) on trees.  This
5868 pass operates on both local scalar variables and memory stores and
5869 loads (global variables, structures, arrays, etc).  This flag is
5870 enabled by default at @option{-O2} and higher.
5872 @item -ftree-dce
5873 @opindex ftree-dce
5874 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5875 default at @option{-O} and higher.
5877 @item -ftree-builtin-dce
5878 @opindex ftree-builtin-dce
5879 Perform conditional dead code elimination (DCE) on builtin calls that
5880 may set errno but are otherwise side-effect free.  This flag is enabled by
5881 default at @option{-O} and higher.
5883 @item -ftree-dominator-opts
5884 @opindex ftree-dominator-opts
5885 Perform a variety of simple scalar cleanups (constant/copy
5886 propagation, redundancy elimination, range propagation and expression
5887 simplification) based on a dominator tree traversal.  This also
5888 performs jump threading (to reduce jumps to jumps). This flag is
5889 enabled by default at @option{-O} and higher.
5891 @item -ftree-dse
5892 @opindex ftree-dse
5893 Perform dead store elimination (DSE) on trees.  A dead store is a store into
5894 a memory location which will later be overwritten by another store without
5895 any intervening loads.  In this case the earlier store can be deleted.  This
5896 flag is enabled by default at @option{-O} and higher.
5898 @item -ftree-ch
5899 @opindex ftree-ch
5900 Perform loop header copying on trees.  This is beneficial since it increases
5901 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5902 is enabled by default at @option{-O} and higher.  It is not enabled
5903 for @option{-Os}, since it usually increases code size.
5905 @item -ftree-loop-optimize
5906 @opindex ftree-loop-optimize
5907 Perform loop optimizations on trees.  This flag is enabled by default
5908 at @option{-O} and higher.
5910 @item -ftree-loop-linear
5911 @opindex ftree-loop-linear
5912 Perform linear loop transformations on tree.  This flag can improve cache
5913 performance and allow further loop optimizations to take place.
5915 @item -fcheck-data-deps
5916 @opindex fcheck-data-deps
5917 Compare the results of several data dependence analyzers.  This option
5918 is used for debugging the data dependence analyzers.
5920 @item -ftree-loop-distribution
5921 Perform loop distribution.  This flag can improve cache performance on
5922 big loop bodies and allow further loop optimizations, like
5923 parallelization or vectorization, to take place.  For example, the loop
5924 @smallexample
5925 DO I = 1, N
5926   A(I) = B(I) + C
5927   D(I) = E(I) * F
5928 ENDDO
5929 @end smallexample
5930 is transformed to
5931 @smallexample
5932 DO I = 1, N
5933    A(I) = B(I) + C
5934 ENDDO
5935 DO I = 1, N
5936    D(I) = E(I) * F
5937 ENDDO
5938 @end smallexample
5940 @item -ftree-loop-im
5941 @opindex ftree-loop-im
5942 Perform loop invariant motion on trees.  This pass moves only invariants that
5943 would be hard to handle at RTL level (function calls, operations that expand to
5944 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5945 operands of conditions that are invariant out of the loop, so that we can use
5946 just trivial invariantness analysis in loop unswitching.  The pass also includes
5947 store motion.
5949 @item -ftree-loop-ivcanon
5950 @opindex ftree-loop-ivcanon
5951 Create a canonical counter for number of iterations in the loop for that
5952 determining number of iterations requires complicated analysis.  Later
5953 optimizations then may determine the number easily.  Useful especially
5954 in connection with unrolling.
5956 @item -fivopts
5957 @opindex fivopts
5958 Perform induction variable optimizations (strength reduction, induction
5959 variable merging and induction variable elimination) on trees.
5961 @item -ftree-parallelize-loops=n
5962 @opindex ftree-parallelize-loops
5963 Parallelize loops, i.e., split their iteration space to run in n threads.
5964 This is only possible for loops whose iterations are independent
5965 and can be arbitrarily reordered.  The optimization is only
5966 profitable on multiprocessor machines, for loops that are CPU-intensive,
5967 rather than constrained e.g.@: by memory bandwidth.  This option
5968 implies @option{-pthread}, and thus is only supported on targets
5969 that have support for @option{-pthread}.
5971 @item -ftree-sra
5972 @opindex ftree-sra
5973 Perform scalar replacement of aggregates.  This pass replaces structure
5974 references with scalars to prevent committing structures to memory too
5975 early.  This flag is enabled by default at @option{-O} and higher.
5977 @item -ftree-copyrename
5978 @opindex ftree-copyrename
5979 Perform copy renaming on trees.  This pass attempts to rename compiler
5980 temporaries to other variables at copy locations, usually resulting in
5981 variable names which more closely resemble the original variables.  This flag
5982 is enabled by default at @option{-O} and higher.
5984 @item -ftree-ter
5985 @opindex ftree-ter
5986 Perform temporary expression replacement during the SSA->normal phase.  Single
5987 use/single def temporaries are replaced at their use location with their
5988 defining expression.  This results in non-GIMPLE code, but gives the expanders
5989 much more complex trees to work on resulting in better RTL generation.  This is
5990 enabled by default at @option{-O} and higher.
5992 @item -ftree-vectorize
5993 @opindex ftree-vectorize
5994 Perform loop vectorization on trees. This flag is enabled by default at
5995 @option{-O3}.
5997 @item -ftree-vect-loop-version
5998 @opindex ftree-vect-loop-version
5999 Perform loop versioning when doing loop vectorization on trees.  When a loop
6000 appears to be vectorizable except that data alignment or data dependence cannot
6001 be determined at compile time then vectorized and non-vectorized versions of
6002 the loop are generated along with runtime checks for alignment or dependence
6003 to control which version is executed.  This option is enabled by default
6004 except at level @option{-Os} where it is disabled.
6006 @item -fvect-cost-model
6007 @opindex fvect-cost-model
6008 Enable cost model for vectorization.
6010 @item -ftree-vrp
6011 @opindex ftree-vrp
6012 Perform Value Range Propagation on trees.  This is similar to the
6013 constant propagation pass, but instead of values, ranges of values are
6014 propagated.  This allows the optimizers to remove unnecessary range
6015 checks like array bound checks and null pointer checks.  This is
6016 enabled by default at @option{-O2} and higher.  Null pointer check
6017 elimination is only done if @option{-fdelete-null-pointer-checks} is
6018 enabled.
6020 @item -ftracer
6021 @opindex ftracer
6022 Perform tail duplication to enlarge superblock size.  This transformation
6023 simplifies the control flow of the function allowing other optimizations to do
6024 better job.
6026 @item -funroll-loops
6027 @opindex funroll-loops
6028 Unroll loops whose number of iterations can be determined at compile
6029 time or upon entry to the loop.  @option{-funroll-loops} implies
6030 @option{-frerun-cse-after-loop}.  This option makes code larger,
6031 and may or may not make it run faster.
6033 @item -funroll-all-loops
6034 @opindex funroll-all-loops
6035 Unroll all loops, even if their number of iterations is uncertain when
6036 the loop is entered.  This usually makes programs run more slowly.
6037 @option{-funroll-all-loops} implies the same options as
6038 @option{-funroll-loops},
6040 @item -fsplit-ivs-in-unroller
6041 @opindex fsplit-ivs-in-unroller
6042 Enables expressing of values of induction variables in later iterations
6043 of the unrolled loop using the value in the first iteration.  This breaks
6044 long dependency chains, thus improving efficiency of the scheduling passes.
6046 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6047 same effect.  However in cases the loop body is more complicated than
6048 a single basic block, this is not reliable.  It also does not work at all
6049 on some of the architectures due to restrictions in the CSE pass.
6051 This optimization is enabled by default.
6053 @item -fvariable-expansion-in-unroller
6054 @opindex fvariable-expansion-in-unroller
6055 With this option, the compiler will create multiple copies of some
6056 local variables when unrolling a loop which can result in superior code.
6058 @item -fpredictive-commoning
6059 @opindex fpredictive-commoning
6060 Perform predictive commoning optimization, i.e., reusing computations
6061 (especially memory loads and stores) performed in previous
6062 iterations of loops.
6064 This option is enabled at level @option{-O3}.
6066 @item -fprefetch-loop-arrays
6067 @opindex fprefetch-loop-arrays
6068 If supported by the target machine, generate instructions to prefetch
6069 memory to improve the performance of loops that access large arrays.
6071 This option may generate better or worse code; results are highly
6072 dependent on the structure of loops within the source code.
6074 Disabled at level @option{-Os}.
6076 @item -fno-peephole
6077 @itemx -fno-peephole2
6078 @opindex fno-peephole
6079 @opindex fno-peephole2
6080 Disable any machine-specific peephole optimizations.  The difference
6081 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6082 are implemented in the compiler; some targets use one, some use the
6083 other, a few use both.
6085 @option{-fpeephole} is enabled by default.
6086 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6088 @item -fno-guess-branch-probability
6089 @opindex fno-guess-branch-probability
6090 Do not guess branch probabilities using heuristics.
6092 GCC will use heuristics to guess branch probabilities if they are
6093 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6094 heuristics are based on the control flow graph.  If some branch probabilities
6095 are specified by @samp{__builtin_expect}, then the heuristics will be
6096 used to guess branch probabilities for the rest of the control flow graph,
6097 taking the @samp{__builtin_expect} info into account.  The interactions
6098 between the heuristics and @samp{__builtin_expect} can be complex, and in
6099 some cases, it may be useful to disable the heuristics so that the effects
6100 of @samp{__builtin_expect} are easier to understand.
6102 The default is @option{-fguess-branch-probability} at levels
6103 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6105 @item -freorder-blocks
6106 @opindex freorder-blocks
6107 Reorder basic blocks in the compiled function in order to reduce number of
6108 taken branches and improve code locality.
6110 Enabled at levels @option{-O2}, @option{-O3}.
6112 @item -freorder-blocks-and-partition
6113 @opindex freorder-blocks-and-partition
6114 In addition to reordering basic blocks in the compiled function, in order
6115 to reduce number of taken branches, partitions hot and cold basic blocks
6116 into separate sections of the assembly and .o files, to improve
6117 paging and cache locality performance.
6119 This optimization is automatically turned off in the presence of
6120 exception handling, for linkonce sections, for functions with a user-defined
6121 section attribute and on any architecture that does not support named
6122 sections.
6124 @item -freorder-functions
6125 @opindex freorder-functions
6126 Reorder functions in the object file in order to
6127 improve code locality.  This is implemented by using special
6128 subsections @code{.text.hot} for most frequently executed functions and
6129 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6130 the linker so object file format must support named sections and linker must
6131 place them in a reasonable way.
6133 Also profile feedback must be available in to make this option effective.  See
6134 @option{-fprofile-arcs} for details.
6136 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6138 @item -fstrict-aliasing
6139 @opindex fstrict-aliasing
6140 Allows the compiler to assume the strictest aliasing rules applicable to
6141 the language being compiled.  For C (and C++), this activates
6142 optimizations based on the type of expressions.  In particular, an
6143 object of one type is assumed never to reside at the same address as an
6144 object of a different type, unless the types are almost the same.  For
6145 example, an @code{unsigned int} can alias an @code{int}, but not a
6146 @code{void*} or a @code{double}.  A character type may alias any other
6147 type.
6149 Pay special attention to code like this:
6150 @smallexample
6151 union a_union @{
6152   int i;
6153   double d;
6156 int f() @{
6157   a_union t;
6158   t.d = 3.0;
6159   return t.i;
6161 @end smallexample
6162 The practice of reading from a different union member than the one most
6163 recently written to (called ``type-punning'') is common.  Even with
6164 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
6165 is accessed through the union type.  So, the code above will work as
6166 expected.  However, this code might not:
6167 @smallexample
6168 int f() @{
6169   a_union t;
6170   int* ip;
6171   t.d = 3.0;
6172   ip = &t.i;
6173   return *ip;
6175 @end smallexample
6177 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6179 @item -fstrict-overflow
6180 @opindex fstrict-overflow
6181 Allow the compiler to assume strict signed overflow rules, depending
6182 on the language being compiled.  For C (and C++) this means that
6183 overflow when doing arithmetic with signed numbers is undefined, which
6184 means that the compiler may assume that it will not happen.  This
6185 permits various optimizations.  For example, the compiler will assume
6186 that an expression like @code{i + 10 > i} will always be true for
6187 signed @code{i}.  This assumption is only valid if signed overflow is
6188 undefined, as the expression is false if @code{i + 10} overflows when
6189 using twos complement arithmetic.  When this option is in effect any
6190 attempt to determine whether an operation on signed numbers will
6191 overflow must be written carefully to not actually involve overflow.
6193 This option also allows the compiler to assume strict pointer
6194 semantics: given a pointer to an object, if adding an offset to that
6195 pointer does not produce a pointer to the same object, the addition is
6196 undefined.  This permits the compiler to conclude that @code{p + u >
6197 p} is always true for a pointer @code{p} and unsigned integer
6198 @code{u}.  This assumption is only valid because pointer wraparound is
6199 undefined, as the expression is false if @code{p + u} overflows using
6200 twos complement arithmetic.
6202 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6203 that integer signed overflow is fully defined: it wraps.  When
6204 @option{-fwrapv} is used, there is no difference between
6205 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
6206 integers.  With @option{-fwrapv} certain types of overflow are
6207 permitted.  For example, if the compiler gets an overflow when doing
6208 arithmetic on constants, the overflowed value can still be used with
6209 @option{-fwrapv}, but not otherwise.
6211 The @option{-fstrict-overflow} option is enabled at levels
6212 @option{-O2}, @option{-O3}, @option{-Os}.
6214 @item -falign-functions
6215 @itemx -falign-functions=@var{n}
6216 @opindex falign-functions
6217 Align the start of functions to the next power-of-two greater than
6218 @var{n}, skipping up to @var{n} bytes.  For instance,
6219 @option{-falign-functions=32} aligns functions to the next 32-byte
6220 boundary, but @option{-falign-functions=24} would align to the next
6221 32-byte boundary only if this can be done by skipping 23 bytes or less.
6223 @option{-fno-align-functions} and @option{-falign-functions=1} are
6224 equivalent and mean that functions will not be aligned.
6226 Some assemblers only support this flag when @var{n} is a power of two;
6227 in that case, it is rounded up.
6229 If @var{n} is not specified or is zero, use a machine-dependent default.
6231 Enabled at levels @option{-O2}, @option{-O3}.
6233 @item -falign-labels
6234 @itemx -falign-labels=@var{n}
6235 @opindex falign-labels
6236 Align all branch targets to a power-of-two boundary, skipping up to
6237 @var{n} bytes like @option{-falign-functions}.  This option can easily
6238 make code slower, because it must insert dummy operations for when the
6239 branch target is reached in the usual flow of the code.
6241 @option{-fno-align-labels} and @option{-falign-labels=1} are
6242 equivalent and mean that labels will not be aligned.
6244 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6245 are greater than this value, then their values are used instead.
6247 If @var{n} is not specified or is zero, use a machine-dependent default
6248 which is very likely to be @samp{1}, meaning no alignment.
6250 Enabled at levels @option{-O2}, @option{-O3}.
6252 @item -falign-loops
6253 @itemx -falign-loops=@var{n}
6254 @opindex falign-loops
6255 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6256 like @option{-falign-functions}.  The hope is that the loop will be
6257 executed many times, which will make up for any execution of the dummy
6258 operations.
6260 @option{-fno-align-loops} and @option{-falign-loops=1} are
6261 equivalent and mean that loops will not be aligned.
6263 If @var{n} is not specified or is zero, use a machine-dependent default.
6265 Enabled at levels @option{-O2}, @option{-O3}.
6267 @item -falign-jumps
6268 @itemx -falign-jumps=@var{n}
6269 @opindex falign-jumps
6270 Align branch targets to a power-of-two boundary, for branch targets
6271 where the targets can only be reached by jumping, skipping up to @var{n}
6272 bytes like @option{-falign-functions}.  In this case, no dummy operations
6273 need be executed.
6275 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6276 equivalent and mean that loops will not be aligned.
6278 If @var{n} is not specified or is zero, use a machine-dependent default.
6280 Enabled at levels @option{-O2}, @option{-O3}.
6282 @item -funit-at-a-time
6283 @opindex funit-at-a-time
6284 Parse the whole compilation unit before starting to produce code.
6285 This allows some extra optimizations to take place but consumes
6286 more memory (in general).  There are some compatibility issues
6287 with @emph{unit-at-a-time} mode:
6288 @itemize @bullet
6289 @item
6290 enabling @emph{unit-at-a-time} mode may change the order
6291 in which functions, variables, and top-level @code{asm} statements
6292 are emitted, and will likely break code relying on some particular
6293 ordering.  The majority of such top-level @code{asm} statements,
6294 though, can be replaced by @code{section} attributes.  The
6295 @option{fno-toplevel-reorder} option may be used to keep the ordering
6296 used in the input file, at the cost of some optimizations.
6298 @item
6299 @emph{unit-at-a-time} mode removes unreferenced static variables
6300 and functions.  This may result in undefined references
6301 when an @code{asm} statement refers directly to variables or functions
6302 that are otherwise unused.  In that case either the variable/function
6303 shall be listed as an operand of the @code{asm} statement operand or,
6304 in the case of top-level @code{asm} statements the attribute @code{used}
6305 shall be used on the declaration.
6307 @item
6308 Static functions now can use non-standard passing conventions that
6309 may break @code{asm} statements calling functions directly.  Again,
6310 attribute @code{used} will prevent this behavior.
6311 @end itemize
6313 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6314 but this scheme may not be supported by future releases of GCC@.
6316 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6318 @item -fno-toplevel-reorder
6319 @opindex fno-toplevel-reorder
6320 Do not reorder top-level functions, variables, and @code{asm}
6321 statements.  Output them in the same order that they appear in the
6322 input file.  When this option is used, unreferenced static variables
6323 will not be removed.  This option is intended to support existing code
6324 which relies on a particular ordering.  For new code, it is better to
6325 use attributes.
6327 @item -fweb
6328 @opindex fweb
6329 Constructs webs as commonly used for register allocation purposes and assign
6330 each web individual pseudo register.  This allows the register allocation pass
6331 to operate on pseudos directly, but also strengthens several other optimization
6332 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6333 however, make debugging impossible, since variables will no longer stay in a
6334 ``home register''.
6336 Enabled by default with @option{-funroll-loops}.
6338 @item -fwhole-program
6339 @opindex fwhole-program
6340 Assume that the current compilation unit represents whole program being
6341 compiled.  All public functions and variables with the exception of @code{main}
6342 and those merged by attribute @code{externally_visible} become static functions
6343 and in a affect gets more aggressively optimized by interprocedural optimizers.
6344 While this option is equivalent to proper use of @code{static} keyword for
6345 programs consisting of single file, in combination with option
6346 @option{--combine} this flag can be used to compile most of smaller scale C
6347 programs since the functions and variables become local for the whole combined
6348 compilation unit, not for the single source file itself.
6350 This option is not supported for Fortran programs.
6352 @item -fcprop-registers
6353 @opindex fcprop-registers
6354 After register allocation and post-register allocation instruction splitting,
6355 we perform a copy-propagation pass to try to reduce scheduling dependencies
6356 and occasionally eliminate the copy.
6358 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6360 @item -fprofile-dir=@var{path}
6361 @opindex fprofile-dir
6363 Set the directory to search the profile data files in to @var{path}.
6364 This option affects only the profile data generated by
6365 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
6366 and used by @option{-fprofile-use} and @option{-fbranch-probabilities} 
6367 and its related options.
6368 By default, GCC will use the current directory as @var{path}
6369 thus the profile data file will appear in the same directory as the object file.
6371 @item -fprofile-generate
6372 @itemx -fprofile-generate=@var{path}
6373 @opindex fprofile-generate
6375 Enable options usually used for instrumenting application to produce
6376 profile useful for later recompilation with profile feedback based
6377 optimization.  You must use @option{-fprofile-generate} both when
6378 compiling and when linking your program.
6380 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6382 If @var{path} is specified, GCC will look at the @var{path} to find
6383 the profile feeedback data files. See @option{-fprofile-dir}.
6385 @item -fprofile-use
6386 @itemx -fprofile-use=@var{path}
6387 @opindex fprofile-use
6388 Enable profile feedback directed optimizations, and optimizations
6389 generally profitable only with profile feedback available.
6391 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6392 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6394 By default, GCC emits an error message if the feedback profiles do not
6395 match the source code.  This error can be turned into a warning by using
6396 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6397 code.
6399 If @var{path} is specified, GCC will look at the @var{path} to find
6400 the profile feedback data files. See @option{-fprofile-dir}.
6401 @end table
6403 The following options control compiler behavior regarding floating
6404 point arithmetic.  These options trade off between speed and
6405 correctness.  All must be specifically enabled.
6407 @table @gcctabopt
6408 @item -ffloat-store
6409 @opindex ffloat-store
6410 Do not store floating point variables in registers, and inhibit other
6411 options that might change whether a floating point value is taken from a
6412 register or memory.
6414 @cindex floating point precision
6415 This option prevents undesirable excess precision on machines such as
6416 the 68000 where the floating registers (of the 68881) keep more
6417 precision than a @code{double} is supposed to have.  Similarly for the
6418 x86 architecture.  For most programs, the excess precision does only
6419 good, but a few programs rely on the precise definition of IEEE floating
6420 point.  Use @option{-ffloat-store} for such programs, after modifying
6421 them to store all pertinent intermediate computations into variables.
6423 @item -ffast-math
6424 @opindex ffast-math
6425 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
6426 @option{-ffinite-math-only}, @option{-fno-rounding-math},
6427 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
6429 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6431 This option is not turned on by any @option{-O} option since
6432 it can result in incorrect output for programs which depend on
6433 an exact implementation of IEEE or ISO rules/specifications for
6434 math functions. It may, however, yield faster code for programs
6435 that do not require the guarantees of these specifications.
6437 @item -fno-math-errno
6438 @opindex fno-math-errno
6439 Do not set ERRNO after calling math functions that are executed
6440 with a single instruction, e.g., sqrt.  A program that relies on
6441 IEEE exceptions for math error handling may want to use this flag
6442 for speed while maintaining IEEE arithmetic compatibility.
6444 This option is not turned on by any @option{-O} option since
6445 it can result in incorrect output for programs which depend on
6446 an exact implementation of IEEE or ISO rules/specifications for
6447 math functions. It may, however, yield faster code for programs
6448 that do not require the guarantees of these specifications.
6450 The default is @option{-fmath-errno}.
6452 On Darwin systems, the math library never sets @code{errno}.  There is
6453 therefore no reason for the compiler to consider the possibility that
6454 it might, and @option{-fno-math-errno} is the default.
6456 @item -funsafe-math-optimizations
6457 @opindex funsafe-math-optimizations
6459 Allow optimizations for floating-point arithmetic that (a) assume
6460 that arguments and results are valid and (b) may violate IEEE or
6461 ANSI standards.  When used at link-time, it may include libraries
6462 or startup files that change the default FPU control word or other
6463 similar optimizations.
6465 This option is not turned on by any @option{-O} option since
6466 it can result in incorrect output for programs which depend on
6467 an exact implementation of IEEE or ISO rules/specifications for
6468 math functions. It may, however, yield faster code for programs
6469 that do not require the guarantees of these specifications.
6470 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
6471 @option{-fassociative-math} and @option{-freciprocal-math}.
6473 The default is @option{-fno-unsafe-math-optimizations}.
6475 @item -fassociative-math
6476 @opindex fassociative-math
6478 Allow re-association of operands in series of floating-point operations.
6479 This violates the ISO C and C++ language standard by possibly changing
6480 computation result.  NOTE: re-ordering may change the sign of zero as
6481 well as ignore NaNs and inhibit or create underflow or overflow (and
6482 thus cannot be used on a code which relies on rounding behavior like
6483 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
6484 and thus may not be used when ordered comparisons are required.
6485 This option requires that both @option{-fno-signed-zeros} and
6486 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
6487 much sense with @option{-frounding-math}.
6489 The default is @option{-fno-associative-math}.
6491 @item -freciprocal-math
6492 @opindex freciprocal-math
6494 Allow the reciprocal of a value to be used instead of dividing by
6495 the value if this enables optimizations.  For example @code{x / y}
6496 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
6497 is subject to common subexpression elimination.  Note that this loses
6498 precision and increases the number of flops operating on the value.
6500 The default is @option{-fno-reciprocal-math}.
6502 @item -ffinite-math-only
6503 @opindex ffinite-math-only
6504 Allow optimizations for floating-point arithmetic that assume
6505 that arguments and results are not NaNs or +-Infs.
6507 This option is not turned on by any @option{-O} option since
6508 it can result in incorrect output for programs which depend on
6509 an exact implementation of IEEE or ISO rules/specifications for
6510 math functions. It may, however, yield faster code for programs
6511 that do not require the guarantees of these specifications.
6513 The default is @option{-fno-finite-math-only}.
6515 @item -fno-signed-zeros
6516 @opindex fno-signed-zeros
6517 Allow optimizations for floating point arithmetic that ignore the
6518 signedness of zero.  IEEE arithmetic specifies the behavior of
6519 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6520 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6521 This option implies that the sign of a zero result isn't significant.
6523 The default is @option{-fsigned-zeros}.
6525 @item -fno-trapping-math
6526 @opindex fno-trapping-math
6527 Compile code assuming that floating-point operations cannot generate
6528 user-visible traps.  These traps include division by zero, overflow,
6529 underflow, inexact result and invalid operation.  This option requires
6530 that @option{-fno-signaling-nans} be in effect.  Setting this option may
6531 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
6533 This option should never be turned on by any @option{-O} option since
6534 it can result in incorrect output for programs which depend on
6535 an exact implementation of IEEE or ISO rules/specifications for
6536 math functions.
6538 The default is @option{-ftrapping-math}.
6540 @item -frounding-math
6541 @opindex frounding-math
6542 Disable transformations and optimizations that assume default floating
6543 point rounding behavior.  This is round-to-zero for all floating point
6544 to integer conversions, and round-to-nearest for all other arithmetic
6545 truncations.  This option should be specified for programs that change
6546 the FP rounding mode dynamically, or that may be executed with a
6547 non-default rounding mode.  This option disables constant folding of
6548 floating point expressions at compile-time (which may be affected by
6549 rounding mode) and arithmetic transformations that are unsafe in the
6550 presence of sign-dependent rounding modes.
6552 The default is @option{-fno-rounding-math}.
6554 This option is experimental and does not currently guarantee to
6555 disable all GCC optimizations that are affected by rounding mode.
6556 Future versions of GCC may provide finer control of this setting
6557 using C99's @code{FENV_ACCESS} pragma.  This command line option
6558 will be used to specify the default state for @code{FENV_ACCESS}.
6560 @item -frtl-abstract-sequences
6561 @opindex frtl-abstract-sequences
6562 It is a size optimization method. This option is to find identical
6563 sequences of code, which can be turned into pseudo-procedures  and
6564 then  replace  all  occurrences with  calls to  the  newly created
6565 subroutine. It is kind of an opposite of @option{-finline-functions}.
6566 This optimization runs at RTL level.
6568 @item -fsignaling-nans
6569 @opindex fsignaling-nans
6570 Compile code assuming that IEEE signaling NaNs may generate user-visible
6571 traps during floating-point operations.  Setting this option disables
6572 optimizations that may change the number of exceptions visible with
6573 signaling NaNs.  This option implies @option{-ftrapping-math}.
6575 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6576 be defined.
6578 The default is @option{-fno-signaling-nans}.
6580 This option is experimental and does not currently guarantee to
6581 disable all GCC optimizations that affect signaling NaN behavior.
6583 @item -fsingle-precision-constant
6584 @opindex fsingle-precision-constant
6585 Treat floating point constant as single precision constant instead of
6586 implicitly converting it to double precision constant.
6588 @item -fcx-limited-range
6589 @opindex fcx-limited-range
6590 When enabled, this option states that a range reduction step is not
6591 needed when performing complex division.  Also, there is no checking
6592 whether the result of a complex multiplication or division is @code{NaN
6593 + I*NaN}, with an attempt to rescue the situation in that case.  The
6594 default is @option{-fno-cx-limited-range}, but is enabled by
6595 @option{-ffast-math}.
6597 This option controls the default setting of the ISO C99
6598 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6599 all languages.
6601 @item -fcx-fortran-rules
6602 @opindex fcx-fortran-rules
6603 Complex multiplication and division follow Fortran rules.  Range
6604 reduction is done as part of complex division, but there is no checking
6605 whether the result of a complex multiplication or division is @code{NaN
6606 + I*NaN}, with an attempt to rescue the situation in that case.
6608 The default is @option{-fno-cx-fortran-rules}.
6610 @end table
6612 The following options control optimizations that may improve
6613 performance, but are not enabled by any @option{-O} options.  This
6614 section includes experimental options that may produce broken code.
6616 @table @gcctabopt
6617 @item -fbranch-probabilities
6618 @opindex fbranch-probabilities
6619 After running a program compiled with @option{-fprofile-arcs}
6620 (@pxref{Debugging Options,, Options for Debugging Your Program or
6621 @command{gcc}}), you can compile it a second time using
6622 @option{-fbranch-probabilities}, to improve optimizations based on
6623 the number of times each branch was taken.  When the program
6624 compiled with @option{-fprofile-arcs} exits it saves arc execution
6625 counts to a file called @file{@var{sourcename}.gcda} for each source
6626 file.  The information in this data file is very dependent on the
6627 structure of the generated code, so you must use the same source code
6628 and the same optimization options for both compilations.
6630 With @option{-fbranch-probabilities}, GCC puts a
6631 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6632 These can be used to improve optimization.  Currently, they are only
6633 used in one place: in @file{reorg.c}, instead of guessing which path a
6634 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6635 exactly determine which path is taken more often.
6637 @item -fprofile-values
6638 @opindex fprofile-values
6639 If combined with @option{-fprofile-arcs}, it adds code so that some
6640 data about values of expressions in the program is gathered.
6642 With @option{-fbranch-probabilities}, it reads back the data gathered
6643 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6644 notes to instructions for their later usage in optimizations.
6646 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6648 @item -fvpt
6649 @opindex fvpt
6650 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6651 a code to gather information about values of expressions.
6653 With @option{-fbranch-probabilities}, it reads back the data gathered
6654 and actually performs the optimizations based on them.
6655 Currently the optimizations include specialization of division operation
6656 using the knowledge about the value of the denominator.
6658 @item -frename-registers
6659 @opindex frename-registers
6660 Attempt to avoid false dependencies in scheduled code by making use
6661 of registers left over after register allocation.  This optimization
6662 will most benefit processors with lots of registers.  Depending on the
6663 debug information format adopted by the target, however, it can
6664 make debugging impossible, since variables will no longer stay in
6665 a ``home register''.
6667 Enabled by default with @option{-funroll-loops}.
6669 @item -ftracer
6670 @opindex ftracer
6671 Perform tail duplication to enlarge superblock size.  This transformation
6672 simplifies the control flow of the function allowing other optimizations to do
6673 better job.
6675 Enabled with @option{-fprofile-use}.
6677 @item -funroll-loops
6678 @opindex funroll-loops
6679 Unroll loops whose number of iterations can be determined at compile time or
6680 upon entry to the loop.  @option{-funroll-loops} implies
6681 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6682 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6683 small constant number of iterations).  This option makes code larger, and may
6684 or may not make it run faster.
6686 Enabled with @option{-fprofile-use}.
6688 @item -funroll-all-loops
6689 @opindex funroll-all-loops
6690 Unroll all loops, even if their number of iterations is uncertain when
6691 the loop is entered.  This usually makes programs run more slowly.
6692 @option{-funroll-all-loops} implies the same options as
6693 @option{-funroll-loops}.
6695 @item -fpeel-loops
6696 @opindex fpeel-loops
6697 Peels the loops for that there is enough information that they do not
6698 roll much (from profile feedback).  It also turns on complete loop peeling
6699 (i.e.@: complete removal of loops with small constant number of iterations).
6701 Enabled with @option{-fprofile-use}.
6703 @item -fmove-loop-invariants
6704 @opindex fmove-loop-invariants
6705 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6706 at level @option{-O1}
6708 @item -funswitch-loops
6709 @opindex funswitch-loops
6710 Move branches with loop invariant conditions out of the loop, with duplicates
6711 of the loop on both branches (modified according to result of the condition).
6713 @item -ffunction-sections
6714 @itemx -fdata-sections
6715 @opindex ffunction-sections
6716 @opindex fdata-sections
6717 Place each function or data item into its own section in the output
6718 file if the target supports arbitrary sections.  The name of the
6719 function or the name of the data item determines the section's name
6720 in the output file.
6722 Use these options on systems where the linker can perform optimizations
6723 to improve locality of reference in the instruction space.  Most systems
6724 using the ELF object format and SPARC processors running Solaris 2 have
6725 linkers with such optimizations.  AIX may have these optimizations in
6726 the future.
6728 Only use these options when there are significant benefits from doing
6729 so.  When you specify these options, the assembler and linker will
6730 create larger object and executable files and will also be slower.
6731 You will not be able to use @code{gprof} on all systems if you
6732 specify this option and you may have problems with debugging if
6733 you specify both this option and @option{-g}.
6735 @item -fbranch-target-load-optimize
6736 @opindex fbranch-target-load-optimize
6737 Perform branch target register load optimization before prologue / epilogue
6738 threading.
6739 The use of target registers can typically be exposed only during reload,
6740 thus hoisting loads out of loops and doing inter-block scheduling needs
6741 a separate optimization pass.
6743 @item -fbranch-target-load-optimize2
6744 @opindex fbranch-target-load-optimize2
6745 Perform branch target register load optimization after prologue / epilogue
6746 threading.
6748 @item -fbtr-bb-exclusive
6749 @opindex fbtr-bb-exclusive
6750 When performing branch target register load optimization, don't reuse
6751 branch target registers in within any basic block.
6753 @item -fstack-protector
6754 @opindex fstack-protector
6755 Emit extra code to check for buffer overflows, such as stack smashing
6756 attacks.  This is done by adding a guard variable to functions with
6757 vulnerable objects.  This includes functions that call alloca, and
6758 functions with buffers larger than 8 bytes.  The guards are initialized
6759 when a function is entered and then checked when the function exits.
6760 If a guard check fails, an error message is printed and the program exits.
6762 @item -fstack-protector-all
6763 @opindex fstack-protector-all
6764 Like @option{-fstack-protector} except that all functions are protected.
6766 @item -fsection-anchors
6767 @opindex fsection-anchors
6768 Try to reduce the number of symbolic address calculations by using
6769 shared ``anchor'' symbols to address nearby objects.  This transformation
6770 can help to reduce the number of GOT entries and GOT accesses on some
6771 targets.
6773 For example, the implementation of the following function @code{foo}:
6775 @smallexample
6776 static int a, b, c;
6777 int foo (void) @{ return a + b + c; @}
6778 @end smallexample
6780 would usually calculate the addresses of all three variables, but if you
6781 compile it with @option{-fsection-anchors}, it will access the variables
6782 from a common anchor point instead.  The effect is similar to the
6783 following pseudocode (which isn't valid C):
6785 @smallexample
6786 int foo (void)
6788   register int *xr = &x;
6789   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6791 @end smallexample
6793 Not all targets support this option.
6795 @item --param @var{name}=@var{value}
6796 @opindex param
6797 In some places, GCC uses various constants to control the amount of
6798 optimization that is done.  For example, GCC will not inline functions
6799 that contain more that a certain number of instructions.  You can
6800 control some of these constants on the command-line using the
6801 @option{--param} option.
6803 The names of specific parameters, and the meaning of the values, are
6804 tied to the internals of the compiler, and are subject to change
6805 without notice in future releases.
6807 In each case, the @var{value} is an integer.  The allowable choices for
6808 @var{name} are given in the following table:
6810 @table @gcctabopt
6811 @item sra-max-structure-size
6812 The maximum structure size, in bytes, at which the scalar replacement
6813 of aggregates (SRA) optimization will perform block copies.  The
6814 default value, 0, implies that GCC will select the most appropriate
6815 size itself.
6817 @item sra-field-structure-ratio
6818 The threshold ratio (as a percentage) between instantiated fields and
6819 the complete structure size.  We say that if the ratio of the number
6820 of bytes in instantiated fields to the number of bytes in the complete
6821 structure exceeds this parameter, then block copies are not used.  The
6822 default is 75.
6824 @item struct-reorg-cold-struct-ratio
6825 The threshold ratio (as a percentage) between a structure frequency
6826 and the frequency of the hottest structure in the program.  This parameter
6827 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
6828 We say that if the ratio of a structure frequency, calculated by profiling, 
6829 to the hottest structure frequency in the program is less than this 
6830 parameter, then structure reorganization is not applied to this structure.
6831 The default is 10.
6833 @item max-crossjump-edges
6834 The maximum number of incoming edges to consider for crossjumping.
6835 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6836 the number of edges incoming to each block.  Increasing values mean
6837 more aggressive optimization, making the compile time increase with
6838 probably small improvement in executable size.
6840 @item min-crossjump-insns
6841 The minimum number of instructions which must be matched at the end
6842 of two blocks before crossjumping will be performed on them.  This
6843 value is ignored in the case where all instructions in the block being
6844 crossjumped from are matched.  The default value is 5.
6846 @item max-grow-copy-bb-insns
6847 The maximum code size expansion factor when copying basic blocks
6848 instead of jumping.  The expansion is relative to a jump instruction.
6849 The default value is 8.
6851 @item max-goto-duplication-insns
6852 The maximum number of instructions to duplicate to a block that jumps
6853 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6854 passes, GCC factors computed gotos early in the compilation process,
6855 and unfactors them as late as possible.  Only computed jumps at the
6856 end of a basic blocks with no more than max-goto-duplication-insns are
6857 unfactored.  The default value is 8.
6859 @item max-delay-slot-insn-search
6860 The maximum number of instructions to consider when looking for an
6861 instruction to fill a delay slot.  If more than this arbitrary number of
6862 instructions is searched, the time savings from filling the delay slot
6863 will be minimal so stop searching.  Increasing values mean more
6864 aggressive optimization, making the compile time increase with probably
6865 small improvement in executable run time.
6867 @item max-delay-slot-live-search
6868 When trying to fill delay slots, the maximum number of instructions to
6869 consider when searching for a block with valid live register
6870 information.  Increasing this arbitrarily chosen value means more
6871 aggressive optimization, increasing the compile time.  This parameter
6872 should be removed when the delay slot code is rewritten to maintain the
6873 control-flow graph.
6875 @item max-gcse-memory
6876 The approximate maximum amount of memory that will be allocated in
6877 order to perform the global common subexpression elimination
6878 optimization.  If more memory than specified is required, the
6879 optimization will not be done.
6881 @item max-gcse-passes
6882 The maximum number of passes of GCSE to run.  The default is 1.
6884 @item max-pending-list-length
6885 The maximum number of pending dependencies scheduling will allow
6886 before flushing the current state and starting over.  Large functions
6887 with few branches or calls can create excessively large lists which
6888 needlessly consume memory and resources.
6890 @item max-inline-insns-single
6891 Several parameters control the tree inliner used in gcc.
6892 This number sets the maximum number of instructions (counted in GCC's
6893 internal representation) in a single function that the tree inliner
6894 will consider for inlining.  This only affects functions declared
6895 inline and methods implemented in a class declaration (C++).
6896 The default value is 450.
6898 @item max-inline-insns-auto
6899 When you use @option{-finline-functions} (included in @option{-O3}),
6900 a lot of functions that would otherwise not be considered for inlining
6901 by the compiler will be investigated.  To those functions, a different
6902 (more restrictive) limit compared to functions declared inline can
6903 be applied.
6904 The default value is 90.
6906 @item large-function-insns
6907 The limit specifying really large functions.  For functions larger than this
6908 limit after inlining inlining is constrained by
6909 @option{--param large-function-growth}.  This parameter is useful primarily
6910 to avoid extreme compilation time caused by non-linear algorithms used by the
6911 backend.
6912 This parameter is ignored when @option{-funit-at-a-time} is not used.
6913 The default value is 2700.
6915 @item large-function-growth
6916 Specifies maximal growth of large function caused by inlining in percents.
6917 This parameter is ignored when @option{-funit-at-a-time} is not used.
6918 The default value is 100 which limits large function growth to 2.0 times
6919 the original size.
6921 @item large-unit-insns
6922 The limit specifying large translation unit.  Growth caused by inlining of
6923 units larger than this limit is limited by @option{--param inline-unit-growth}.
6924 For small units this might be too tight (consider unit consisting of function A
6925 that is inline and B that just calls A three time.  If B is small relative to
6926 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6927 large units consisting of small inlineable functions however the overall unit
6928 growth limit is needed to avoid exponential explosion of code size.  Thus for
6929 smaller units, the size is increased to @option{--param large-unit-insns}
6930 before applying @option{--param inline-unit-growth}.  The default is 10000
6932 @item inline-unit-growth
6933 Specifies maximal overall growth of the compilation unit caused by inlining.
6934 This parameter is ignored when @option{-funit-at-a-time} is not used.
6935 The default value is 30 which limits unit growth to 1.3 times the original
6936 size.
6938 @item large-stack-frame
6939 The limit specifying large stack frames.  While inlining the algorithm is trying
6940 to not grow past this limit too much.  Default value is 256 bytes.
6942 @item large-stack-frame-growth
6943 Specifies maximal growth of large stack frames caused by inlining in percents.
6944 The default value is 1000 which limits large stack frame growth to 11 times
6945 the original size.
6947 @item max-inline-insns-recursive
6948 @itemx max-inline-insns-recursive-auto
6949 Specifies maximum number of instructions out-of-line copy of self recursive inline
6950 function can grow into by performing recursive inlining.
6952 For functions declared inline @option{--param max-inline-insns-recursive} is
6953 taken into account.  For function not declared inline, recursive inlining
6954 happens only when @option{-finline-functions} (included in @option{-O3}) is
6955 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6956 default value is 450.
6958 @item max-inline-recursive-depth
6959 @itemx max-inline-recursive-depth-auto
6960 Specifies maximum recursion depth used by the recursive inlining.
6962 For functions declared inline @option{--param max-inline-recursive-depth} is
6963 taken into account.  For function not declared inline, recursive inlining
6964 happens only when @option{-finline-functions} (included in @option{-O3}) is
6965 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6966 default value is 8.
6968 @item min-inline-recursive-probability
6969 Recursive inlining is profitable only for function having deep recursion
6970 in average and can hurt for function having little recursion depth by
6971 increasing the prologue size or complexity of function body to other
6972 optimizers.
6974 When profile feedback is available (see @option{-fprofile-generate}) the actual
6975 recursion depth can be guessed from probability that function will recurse via
6976 given call expression.  This parameter limits inlining only to call expression
6977 whose probability exceeds given threshold (in percents).  The default value is
6980 @item inline-call-cost
6981 Specify cost of call instruction relative to simple arithmetics operations
6982 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6983 functions and at the same time increases size of leaf function that is believed to
6984 reduce function size by being inlined.  In effect it increases amount of
6985 inlining for code having large abstraction penalty (many functions that just
6986 pass the arguments to other functions) and decrease inlining for code with low
6987 abstraction penalty.  The default value is 12.
6989 @item min-vect-loop-bound
6990 The minimum number of iterations under which a loop will not get vectorized
6991 when @option{-ftree-vectorize} is used.  The number of iterations after
6992 vectorization needs to be greater than the value specified by this option
6993 to allow vectorization.  The default value is 0.
6995 @item max-unrolled-insns
6996 The maximum number of instructions that a loop should have if that loop
6997 is unrolled, and if the loop is unrolled, it determines how many times
6998 the loop code is unrolled.
7000 @item max-average-unrolled-insns
7001 The maximum number of instructions biased by probabilities of their execution
7002 that a loop should have if that loop is unrolled, and if the loop is unrolled,
7003 it determines how many times the loop code is unrolled.
7005 @item max-unroll-times
7006 The maximum number of unrollings of a single loop.
7008 @item max-peeled-insns
7009 The maximum number of instructions that a loop should have if that loop
7010 is peeled, and if the loop is peeled, it determines how many times
7011 the loop code is peeled.
7013 @item max-peel-times
7014 The maximum number of peelings of a single loop.
7016 @item max-completely-peeled-insns
7017 The maximum number of insns of a completely peeled loop.
7019 @item max-completely-peel-times
7020 The maximum number of iterations of a loop to be suitable for complete peeling.
7022 @item max-unswitch-insns
7023 The maximum number of insns of an unswitched loop.
7025 @item max-unswitch-level
7026 The maximum number of branches unswitched in a single loop.
7028 @item lim-expensive
7029 The minimum cost of an expensive expression in the loop invariant motion.
7031 @item iv-consider-all-candidates-bound
7032 Bound on number of candidates for induction variables below that
7033 all candidates are considered for each use in induction variable
7034 optimizations.  Only the most relevant candidates are considered
7035 if there are more candidates, to avoid quadratic time complexity.
7037 @item iv-max-considered-uses
7038 The induction variable optimizations give up on loops that contain more
7039 induction variable uses.
7041 @item iv-always-prune-cand-set-bound
7042 If number of candidates in the set is smaller than this value,
7043 we always try to remove unnecessary ivs from the set during its
7044 optimization when a new iv is added to the set.
7046 @item scev-max-expr-size
7047 Bound on size of expressions used in the scalar evolutions analyzer.
7048 Large expressions slow the analyzer.
7050 @item omega-max-vars
7051 The maximum number of variables in an Omega constraint system.
7052 The default value is 128.
7054 @item omega-max-geqs
7055 The maximum number of inequalities in an Omega constraint system.
7056 The default value is 256.
7058 @item omega-max-eqs
7059 The maximum number of equalities in an Omega constraint system.
7060 The default value is 128.
7062 @item omega-max-wild-cards
7063 The maximum number of wildcard variables that the Omega solver will
7064 be able to insert.  The default value is 18.
7066 @item omega-hash-table-size
7067 The size of the hash table in the Omega solver.  The default value is
7068 550.
7070 @item omega-max-keys
7071 The maximal number of keys used by the Omega solver.  The default
7072 value is 500.
7074 @item omega-eliminate-redundant-constraints
7075 When set to 1, use expensive methods to eliminate all redundant
7076 constraints.  The default value is 0.
7078 @item vect-max-version-for-alignment-checks
7079 The maximum number of runtime checks that can be performed when
7080 doing loop versioning for alignment in the vectorizer.  See option
7081 ftree-vect-loop-version for more information.
7083 @item vect-max-version-for-alias-checks
7084 The maximum number of runtime checks that can be performed when
7085 doing loop versioning for alias in the vectorizer.  See option
7086 ftree-vect-loop-version for more information.
7088 @item max-iterations-to-track
7090 The maximum number of iterations of a loop the brute force algorithm
7091 for analysis of # of iterations of the loop tries to evaluate.
7093 @item hot-bb-count-fraction
7094 Select fraction of the maximal count of repetitions of basic block in program
7095 given basic block needs to have to be considered hot.
7097 @item hot-bb-frequency-fraction
7098 Select fraction of the maximal frequency of executions of basic block in
7099 function given basic block needs to have to be considered hot
7101 @item max-predicted-iterations
7102 The maximum number of loop iterations we predict statically.  This is useful
7103 in cases where function contain single loop with known bound and other loop
7104 with unknown.  We predict the known number of iterations correctly, while
7105 the unknown number of iterations average to roughly 10.  This means that the
7106 loop without bounds would appear artificially cold relative to the other one.
7108 @item align-threshold
7110 Select fraction of the maximal frequency of executions of basic block in
7111 function given basic block will get aligned.
7113 @item align-loop-iterations
7115 A loop expected to iterate at lest the selected number of iterations will get
7116 aligned.
7118 @item tracer-dynamic-coverage
7119 @itemx tracer-dynamic-coverage-feedback
7121 This value is used to limit superblock formation once the given percentage of
7122 executed instructions is covered.  This limits unnecessary code size
7123 expansion.
7125 The @option{tracer-dynamic-coverage-feedback} is used only when profile
7126 feedback is available.  The real profiles (as opposed to statically estimated
7127 ones) are much less balanced allowing the threshold to be larger value.
7129 @item tracer-max-code-growth
7130 Stop tail duplication once code growth has reached given percentage.  This is
7131 rather hokey argument, as most of the duplicates will be eliminated later in
7132 cross jumping, so it may be set to much higher values than is the desired code
7133 growth.
7135 @item tracer-min-branch-ratio
7137 Stop reverse growth when the reverse probability of best edge is less than this
7138 threshold (in percent).
7140 @item tracer-min-branch-ratio
7141 @itemx tracer-min-branch-ratio-feedback
7143 Stop forward growth if the best edge do have probability lower than this
7144 threshold.
7146 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
7147 compilation for profile feedback and one for compilation without.  The value
7148 for compilation with profile feedback needs to be more conservative (higher) in
7149 order to make tracer effective.
7151 @item max-cse-path-length
7153 Maximum number of basic blocks on path that cse considers.  The default is 10.
7155 @item max-cse-insns
7156 The maximum instructions CSE process before flushing. The default is 1000.
7158 @item max-aliased-vops
7160 Maximum number of virtual operands per function allowed to represent
7161 aliases before triggering the alias partitioning heuristic.  Alias
7162 partitioning reduces compile times and memory consumption needed for
7163 aliasing at the expense of precision loss in alias information.  The
7164 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
7165 for -O3.
7167 Notice that if a function contains more memory statements than the
7168 value of this parameter, it is not really possible to achieve this
7169 reduction.  In this case, the compiler will use the number of memory
7170 statements as the value for @option{max-aliased-vops}.
7172 @item avg-aliased-vops
7174 Average number of virtual operands per statement allowed to represent
7175 aliases before triggering the alias partitioning heuristic.  This
7176 works in conjunction with @option{max-aliased-vops}.  If a function
7177 contains more than @option{max-aliased-vops} virtual operators, then
7178 memory symbols will be grouped into memory partitions until either the
7179 total number of virtual operators is below @option{max-aliased-vops}
7180 or the average number of virtual operators per memory statement is
7181 below @option{avg-aliased-vops}.  The default value for this parameter
7182 is 1 for -O1 and -O2, and 3 for -O3.
7184 @item ggc-min-expand
7186 GCC uses a garbage collector to manage its own memory allocation.  This
7187 parameter specifies the minimum percentage by which the garbage
7188 collector's heap should be allowed to expand between collections.
7189 Tuning this may improve compilation speed; it has no effect on code
7190 generation.
7192 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
7193 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
7194 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
7195 GCC is not able to calculate RAM on a particular platform, the lower
7196 bound of 30% is used.  Setting this parameter and
7197 @option{ggc-min-heapsize} to zero causes a full collection to occur at
7198 every opportunity.  This is extremely slow, but can be useful for
7199 debugging.
7201 @item ggc-min-heapsize
7203 Minimum size of the garbage collector's heap before it begins bothering
7204 to collect garbage.  The first collection occurs after the heap expands
7205 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
7206 tuning this may improve compilation speed, and has no effect on code
7207 generation.
7209 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
7210 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
7211 with a lower bound of 4096 (four megabytes) and an upper bound of
7212 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
7213 particular platform, the lower bound is used.  Setting this parameter
7214 very large effectively disables garbage collection.  Setting this
7215 parameter and @option{ggc-min-expand} to zero causes a full collection
7216 to occur at every opportunity.
7218 @item max-reload-search-insns
7219 The maximum number of instruction reload should look backward for equivalent
7220 register.  Increasing values mean more aggressive optimization, making the
7221 compile time increase with probably slightly better performance.  The default
7222 value is 100.
7224 @item max-cselib-memory-locations
7225 The maximum number of memory locations cselib should take into account.
7226 Increasing values mean more aggressive optimization, making the compile time
7227 increase with probably slightly better performance.  The default value is 500.
7229 @item reorder-blocks-duplicate
7230 @itemx reorder-blocks-duplicate-feedback
7232 Used by basic block reordering pass to decide whether to use unconditional
7233 branch or duplicate the code on its destination.  Code is duplicated when its
7234 estimated size is smaller than this value multiplied by the estimated size of
7235 unconditional jump in the hot spots of the program.
7237 The @option{reorder-block-duplicate-feedback} is used only when profile
7238 feedback is available and may be set to higher values than
7239 @option{reorder-block-duplicate} since information about the hot spots is more
7240 accurate.
7242 @item max-sched-ready-insns
7243 The maximum number of instructions ready to be issued the scheduler should
7244 consider at any given time during the first scheduling pass.  Increasing
7245 values mean more thorough searches, making the compilation time increase
7246 with probably little benefit.  The default value is 100.
7248 @item max-sched-region-blocks
7249 The maximum number of blocks in a region to be considered for
7250 interblock scheduling.  The default value is 10.
7252 @item max-sched-region-insns
7253 The maximum number of insns in a region to be considered for
7254 interblock scheduling.  The default value is 100.
7256 @item min-spec-prob
7257 The minimum probability (in percents) of reaching a source block
7258 for interblock speculative scheduling.  The default value is 40.
7260 @item max-sched-extend-regions-iters
7261 The maximum number of iterations through CFG to extend regions.
7262 0 - disable region extension,
7263 N - do at most N iterations.
7264 The default value is 0.
7266 @item max-sched-insn-conflict-delay
7267 The maximum conflict delay for an insn to be considered for speculative motion.
7268 The default value is 3.
7270 @item sched-spec-prob-cutoff
7271 The minimal probability of speculation success (in percents), so that
7272 speculative insn will be scheduled.
7273 The default value is 40.
7275 @item max-last-value-rtl
7277 The maximum size measured as number of RTLs that can be recorded in an expression
7278 in combiner for a pseudo register as last known value of that register.  The default
7279 is 10000.
7281 @item integer-share-limit
7282 Small integer constants can use a shared data structure, reducing the
7283 compiler's memory usage and increasing its speed.  This sets the maximum
7284 value of a shared integer constant.  The default value is 256.
7286 @item min-virtual-mappings
7287 Specifies the minimum number of virtual mappings in the incremental
7288 SSA updater that should be registered to trigger the virtual mappings
7289 heuristic defined by virtual-mappings-ratio.  The default value is
7290 100.
7292 @item virtual-mappings-ratio
7293 If the number of virtual mappings is virtual-mappings-ratio bigger
7294 than the number of virtual symbols to be updated, then the incremental
7295 SSA updater switches to a full update for those symbols.  The default
7296 ratio is 3.
7298 @item ssp-buffer-size
7299 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
7300 protection when @option{-fstack-protection} is used.
7302 @item max-jump-thread-duplication-stmts
7303 Maximum number of statements allowed in a block that needs to be
7304 duplicated when threading jumps.
7306 @item max-fields-for-field-sensitive
7307 Maximum number of fields in a structure we will treat in
7308 a field sensitive manner during pointer analysis.
7310 @item prefetch-latency
7311 Estimate on average number of instructions that are executed before
7312 prefetch finishes.  The distance we prefetch ahead is proportional
7313 to this constant.  Increasing this number may also lead to less
7314 streams being prefetched (see @option{simultaneous-prefetches}).
7316 @item simultaneous-prefetches
7317 Maximum number of prefetches that can run at the same time.
7319 @item l1-cache-line-size
7320 The size of cache line in L1 cache, in bytes.
7322 @item l1-cache-size
7323 The size of L1 cache, in kilobytes.
7325 @item l2-cache-size
7326 The size of L2 cache, in kilobytes.
7328 @item use-canonical-types
7329 Whether the compiler should use the ``canonical'' type system.  By
7330 default, this should always be 1, which uses a more efficient internal
7331 mechanism for comparing types in C++ and Objective-C++.  However, if
7332 bugs in the canonical type system are causing compilation failures,
7333 set this value to 0 to disable canonical types.
7335 @item max-partial-antic-length
7336 Maximum length of the partial antic set computed during the tree
7337 partial redundancy elimination optimization (@option{-ftree-pre}) when
7338 optimizing at @option{-O3} and above.  For some sorts of source code
7339 the enhanced partial redundancy elimination optimization can run away,
7340 consuming all of the memory available on the host machine.  This
7341 parameter sets a limit on the length of the sets that are computed,
7342 which prevents the runaway behaviour.  Setting a value of 0 for
7343 this paramter will allow an unlimited set length.
7345 @item sccvn-max-scc-size
7346 Maximum size of a strongly connected component (SCC) during SCCVN
7347 processing.  If this limit is hit, SCCVN processing for the whole
7348 function will not be done and optimizations depending on it will
7349 be disabled.  The default maximum SCC size is 10000.
7351 @end table
7352 @end table
7354 @node Preprocessor Options
7355 @section Options Controlling the Preprocessor
7356 @cindex preprocessor options
7357 @cindex options, preprocessor
7359 These options control the C preprocessor, which is run on each C source
7360 file before actual compilation.
7362 If you use the @option{-E} option, nothing is done except preprocessing.
7363 Some of these options make sense only together with @option{-E} because
7364 they cause the preprocessor output to be unsuitable for actual
7365 compilation.
7367 @table @gcctabopt
7368 @opindex Wp
7369 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7370 and pass @var{option} directly through to the preprocessor.  If
7371 @var{option} contains commas, it is split into multiple options at the
7372 commas.  However, many options are modified, translated or interpreted
7373 by the compiler driver before being passed to the preprocessor, and
7374 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7375 interface is undocumented and subject to change, so whenever possible
7376 you should avoid using @option{-Wp} and let the driver handle the
7377 options instead.
7379 @item -Xpreprocessor @var{option}
7380 @opindex preprocessor
7381 Pass @var{option} as an option to the preprocessor.  You can use this to
7382 supply system-specific preprocessor options which GCC does not know how to
7383 recognize.
7385 If you want to pass an option that takes an argument, you must use
7386 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7387 @end table
7389 @include cppopts.texi
7391 @node Assembler Options
7392 @section Passing Options to the Assembler
7394 @c prevent bad page break with this line
7395 You can pass options to the assembler.
7397 @table @gcctabopt
7398 @item -Wa,@var{option}
7399 @opindex Wa
7400 Pass @var{option} as an option to the assembler.  If @var{option}
7401 contains commas, it is split into multiple options at the commas.
7403 @item -Xassembler @var{option}
7404 @opindex Xassembler
7405 Pass @var{option} as an option to the assembler.  You can use this to
7406 supply system-specific assembler options which GCC does not know how to
7407 recognize.
7409 If you want to pass an option that takes an argument, you must use
7410 @option{-Xassembler} twice, once for the option and once for the argument.
7412 @end table
7414 @node Link Options
7415 @section Options for Linking
7416 @cindex link options
7417 @cindex options, linking
7419 These options come into play when the compiler links object files into
7420 an executable output file.  They are meaningless if the compiler is
7421 not doing a link step.
7423 @table @gcctabopt
7424 @cindex file names
7425 @item @var{object-file-name}
7426 A file name that does not end in a special recognized suffix is
7427 considered to name an object file or library.  (Object files are
7428 distinguished from libraries by the linker according to the file
7429 contents.)  If linking is done, these object files are used as input
7430 to the linker.
7432 @item -c
7433 @itemx -S
7434 @itemx -E
7435 @opindex c
7436 @opindex S
7437 @opindex E
7438 If any of these options is used, then the linker is not run, and
7439 object file names should not be used as arguments.  @xref{Overall
7440 Options}.
7442 @cindex Libraries
7443 @item -l@var{library}
7444 @itemx -l @var{library}
7445 @opindex l
7446 Search the library named @var{library} when linking.  (The second
7447 alternative with the library as a separate argument is only for
7448 POSIX compliance and is not recommended.)
7450 It makes a difference where in the command you write this option; the
7451 linker searches and processes libraries and object files in the order they
7452 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7453 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7454 to functions in @samp{z}, those functions may not be loaded.
7456 The linker searches a standard list of directories for the library,
7457 which is actually a file named @file{lib@var{library}.a}.  The linker
7458 then uses this file as if it had been specified precisely by name.
7460 The directories searched include several standard system directories
7461 plus any that you specify with @option{-L}.
7463 Normally the files found this way are library files---archive files
7464 whose members are object files.  The linker handles an archive file by
7465 scanning through it for members which define symbols that have so far
7466 been referenced but not defined.  But if the file that is found is an
7467 ordinary object file, it is linked in the usual fashion.  The only
7468 difference between using an @option{-l} option and specifying a file name
7469 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7470 and searches several directories.
7472 @item -lobjc
7473 @opindex lobjc
7474 You need this special case of the @option{-l} option in order to
7475 link an Objective-C or Objective-C++ program.
7477 @item -nostartfiles
7478 @opindex nostartfiles
7479 Do not use the standard system startup files when linking.
7480 The standard system libraries are used normally, unless @option{-nostdlib}
7481 or @option{-nodefaultlibs} is used.
7483 @item -nodefaultlibs
7484 @opindex nodefaultlibs
7485 Do not use the standard system libraries when linking.
7486 Only the libraries you specify will be passed to the linker.
7487 The standard startup files are used normally, unless @option{-nostartfiles}
7488 is used.  The compiler may generate calls to @code{memcmp},
7489 @code{memset}, @code{memcpy} and @code{memmove}.
7490 These entries are usually resolved by entries in
7491 libc.  These entry points should be supplied through some other
7492 mechanism when this option is specified.
7494 @item -nostdlib
7495 @opindex nostdlib
7496 Do not use the standard system startup files or libraries when linking.
7497 No startup files and only the libraries you specify will be passed to
7498 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7499 @code{memcpy} and @code{memmove}.
7500 These entries are usually resolved by entries in
7501 libc.  These entry points should be supplied through some other
7502 mechanism when this option is specified.
7504 @cindex @option{-lgcc}, use with @option{-nostdlib}
7505 @cindex @option{-nostdlib} and unresolved references
7506 @cindex unresolved references and @option{-nostdlib}
7507 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7508 @cindex @option{-nodefaultlibs} and unresolved references
7509 @cindex unresolved references and @option{-nodefaultlibs}
7510 One of the standard libraries bypassed by @option{-nostdlib} and
7511 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7512 that GCC uses to overcome shortcomings of particular machines, or special
7513 needs for some languages.
7514 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7515 Collection (GCC) Internals},
7516 for more discussion of @file{libgcc.a}.)
7517 In most cases, you need @file{libgcc.a} even when you want to avoid
7518 other standard libraries.  In other words, when you specify @option{-nostdlib}
7519 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7520 This ensures that you have no unresolved references to internal GCC
7521 library subroutines.  (For example, @samp{__main}, used to ensure C++
7522 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7523 GNU Compiler Collection (GCC) Internals}.)
7525 @item -pie
7526 @opindex pie
7527 Produce a position independent executable on targets which support it.
7528 For predictable results, you must also specify the same set of options
7529 that were used to generate code (@option{-fpie}, @option{-fPIE},
7530 or model suboptions) when you specify this option.
7532 @item -rdynamic
7533 @opindex rdynamic
7534 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7535 that support it. This instructs the linker to add all symbols, not
7536 only used ones, to the dynamic symbol table. This option is needed
7537 for some uses of @code{dlopen} or to allow obtaining backtraces
7538 from within a program.
7540 @item -s
7541 @opindex s
7542 Remove all symbol table and relocation information from the executable.
7544 @item -static
7545 @opindex static
7546 On systems that support dynamic linking, this prevents linking with the shared
7547 libraries.  On other systems, this option has no effect.
7549 @item -shared
7550 @opindex shared
7551 Produce a shared object which can then be linked with other objects to
7552 form an executable.  Not all systems support this option.  For predictable
7553 results, you must also specify the same set of options that were used to
7554 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7555 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7556 needs to build supplementary stub code for constructors to work.  On
7557 multi-libbed systems, @samp{gcc -shared} must select the correct support
7558 libraries to link against.  Failing to supply the correct flags may lead
7559 to subtle defects.  Supplying them in cases where they are not necessary
7560 is innocuous.}
7562 @item -shared-libgcc
7563 @itemx -static-libgcc
7564 @opindex shared-libgcc
7565 @opindex static-libgcc
7566 On systems that provide @file{libgcc} as a shared library, these options
7567 force the use of either the shared or static version respectively.
7568 If no shared version of @file{libgcc} was built when the compiler was
7569 configured, these options have no effect.
7571 There are several situations in which an application should use the
7572 shared @file{libgcc} instead of the static version.  The most common
7573 of these is when the application wishes to throw and catch exceptions
7574 across different shared libraries.  In that case, each of the libraries
7575 as well as the application itself should use the shared @file{libgcc}.
7577 Therefore, the G++ and GCJ drivers automatically add
7578 @option{-shared-libgcc} whenever you build a shared library or a main
7579 executable, because C++ and Java programs typically use exceptions, so
7580 this is the right thing to do.
7582 If, instead, you use the GCC driver to create shared libraries, you may
7583 find that they will not always be linked with the shared @file{libgcc}.
7584 If GCC finds, at its configuration time, that you have a non-GNU linker
7585 or a GNU linker that does not support option @option{--eh-frame-hdr},
7586 it will link the shared version of @file{libgcc} into shared libraries
7587 by default.  Otherwise, it will take advantage of the linker and optimize
7588 away the linking with the shared version of @file{libgcc}, linking with
7589 the static version of libgcc by default.  This allows exceptions to
7590 propagate through such shared libraries, without incurring relocation
7591 costs at library load time.
7593 However, if a library or main executable is supposed to throw or catch
7594 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7595 for the languages used in the program, or using the option
7596 @option{-shared-libgcc}, such that it is linked with the shared
7597 @file{libgcc}.
7599 @item -symbolic
7600 @opindex symbolic
7601 Bind references to global symbols when building a shared object.  Warn
7602 about any unresolved references (unless overridden by the link editor
7603 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7604 this option.
7606 @item -Xlinker @var{option}
7607 @opindex Xlinker
7608 Pass @var{option} as an option to the linker.  You can use this to
7609 supply system-specific linker options which GCC does not know how to
7610 recognize.
7612 If you want to pass an option that takes an argument, you must use
7613 @option{-Xlinker} twice, once for the option and once for the argument.
7614 For example, to pass @option{-assert definitions}, you must write
7615 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7616 @option{-Xlinker "-assert definitions"}, because this passes the entire
7617 string as a single argument, which is not what the linker expects.
7619 @item -Wl,@var{option}
7620 @opindex Wl
7621 Pass @var{option} as an option to the linker.  If @var{option} contains
7622 commas, it is split into multiple options at the commas.
7624 @item -u @var{symbol}
7625 @opindex u
7626 Pretend the symbol @var{symbol} is undefined, to force linking of
7627 library modules to define it.  You can use @option{-u} multiple times with
7628 different symbols to force loading of additional library modules.
7629 @end table
7631 @node Directory Options
7632 @section Options for Directory Search
7633 @cindex directory options
7634 @cindex options, directory search
7635 @cindex search path
7637 These options specify directories to search for header files, for
7638 libraries and for parts of the compiler:
7640 @table @gcctabopt
7641 @item -I@var{dir}
7642 @opindex I
7643 Add the directory @var{dir} to the head of the list of directories to be
7644 searched for header files.  This can be used to override a system header
7645 file, substituting your own version, since these directories are
7646 searched before the system header file directories.  However, you should
7647 not use this option to add directories that contain vendor-supplied
7648 system header files (use @option{-isystem} for that).  If you use more than
7649 one @option{-I} option, the directories are scanned in left-to-right
7650 order; the standard system directories come after.
7652 If a standard system include directory, or a directory specified with
7653 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7654 option will be ignored.  The directory will still be searched but as a
7655 system directory at its normal position in the system include chain.
7656 This is to ensure that GCC's procedure to fix buggy system headers and
7657 the ordering for the include_next directive are not inadvertently changed.
7658 If you really need to change the search order for system directories,
7659 use the @option{-nostdinc} and/or @option{-isystem} options.
7661 @item -iquote@var{dir}
7662 @opindex iquote
7663 Add the directory @var{dir} to the head of the list of directories to
7664 be searched for header files only for the case of @samp{#include
7665 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7666 otherwise just like @option{-I}.
7668 @item -L@var{dir}
7669 @opindex L
7670 Add directory @var{dir} to the list of directories to be searched
7671 for @option{-l}.
7673 @item -B@var{prefix}
7674 @opindex B
7675 This option specifies where to find the executables, libraries,
7676 include files, and data files of the compiler itself.
7678 The compiler driver program runs one or more of the subprograms
7679 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7680 @var{prefix} as a prefix for each program it tries to run, both with and
7681 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7683 For each subprogram to be run, the compiler driver first tries the
7684 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7685 was not specified, the driver tries two standard prefixes, which are
7686 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7687 those results in a file name that is found, the unmodified program
7688 name is searched for using the directories specified in your
7689 @env{PATH} environment variable.
7691 The compiler will check to see if the path provided by the @option{-B}
7692 refers to a directory, and if necessary it will add a directory
7693 separator character at the end of the path.
7695 @option{-B} prefixes that effectively specify directory names also apply
7696 to libraries in the linker, because the compiler translates these
7697 options into @option{-L} options for the linker.  They also apply to
7698 includes files in the preprocessor, because the compiler translates these
7699 options into @option{-isystem} options for the preprocessor.  In this case,
7700 the compiler appends @samp{include} to the prefix.
7702 The run-time support file @file{libgcc.a} can also be searched for using
7703 the @option{-B} prefix, if needed.  If it is not found there, the two
7704 standard prefixes above are tried, and that is all.  The file is left
7705 out of the link if it is not found by those means.
7707 Another way to specify a prefix much like the @option{-B} prefix is to use
7708 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7709 Variables}.
7711 As a special kludge, if the path provided by @option{-B} is
7712 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7713 9, then it will be replaced by @file{[dir/]include}.  This is to help
7714 with boot-strapping the compiler.
7716 @item -specs=@var{file}
7717 @opindex specs
7718 Process @var{file} after the compiler reads in the standard @file{specs}
7719 file, in order to override the defaults that the @file{gcc} driver
7720 program uses when determining what switches to pass to @file{cc1},
7721 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7722 @option{-specs=@var{file}} can be specified on the command line, and they
7723 are processed in order, from left to right.
7725 @item --sysroot=@var{dir}
7726 @opindex sysroot
7727 Use @var{dir} as the logical root directory for headers and libraries.
7728 For example, if the compiler would normally search for headers in
7729 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7730 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7732 If you use both this option and the @option{-isysroot} option, then
7733 the @option{--sysroot} option will apply to libraries, but the
7734 @option{-isysroot} option will apply to header files.
7736 The GNU linker (beginning with version 2.16) has the necessary support
7737 for this option.  If your linker does not support this option, the
7738 header file aspect of @option{--sysroot} will still work, but the
7739 library aspect will not.
7741 @item -I-
7742 @opindex I-
7743 This option has been deprecated.  Please use @option{-iquote} instead for
7744 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7745 Any directories you specify with @option{-I} options before the @option{-I-}
7746 option are searched only for the case of @samp{#include "@var{file}"};
7747 they are not searched for @samp{#include <@var{file}>}.
7749 If additional directories are specified with @option{-I} options after
7750 the @option{-I-}, these directories are searched for all @samp{#include}
7751 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7752 this way.)
7754 In addition, the @option{-I-} option inhibits the use of the current
7755 directory (where the current input file came from) as the first search
7756 directory for @samp{#include "@var{file}"}.  There is no way to
7757 override this effect of @option{-I-}.  With @option{-I.} you can specify
7758 searching the directory which was current when the compiler was
7759 invoked.  That is not exactly the same as what the preprocessor does
7760 by default, but it is often satisfactory.
7762 @option{-I-} does not inhibit the use of the standard system directories
7763 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7764 independent.
7765 @end table
7767 @c man end
7769 @node Spec Files
7770 @section Specifying subprocesses and the switches to pass to them
7771 @cindex Spec Files
7773 @command{gcc} is a driver program.  It performs its job by invoking a
7774 sequence of other programs to do the work of compiling, assembling and
7775 linking.  GCC interprets its command-line parameters and uses these to
7776 deduce which programs it should invoke, and which command-line options
7777 it ought to place on their command lines.  This behavior is controlled
7778 by @dfn{spec strings}.  In most cases there is one spec string for each
7779 program that GCC can invoke, but a few programs have multiple spec
7780 strings to control their behavior.  The spec strings built into GCC can
7781 be overridden by using the @option{-specs=} command-line switch to specify
7782 a spec file.
7784 @dfn{Spec files} are plaintext files that are used to construct spec
7785 strings.  They consist of a sequence of directives separated by blank
7786 lines.  The type of directive is determined by the first non-whitespace
7787 character on the line and it can be one of the following:
7789 @table @code
7790 @item %@var{command}
7791 Issues a @var{command} to the spec file processor.  The commands that can
7792 appear here are:
7794 @table @code
7795 @item %include <@var{file}>
7796 @cindex %include
7797 Search for @var{file} and insert its text at the current point in the
7798 specs file.
7800 @item %include_noerr <@var{file}>
7801 @cindex %include_noerr
7802 Just like @samp{%include}, but do not generate an error message if the include
7803 file cannot be found.
7805 @item %rename @var{old_name} @var{new_name}
7806 @cindex %rename
7807 Rename the spec string @var{old_name} to @var{new_name}.
7809 @end table
7811 @item *[@var{spec_name}]:
7812 This tells the compiler to create, override or delete the named spec
7813 string.  All lines after this directive up to the next directive or
7814 blank line are considered to be the text for the spec string.  If this
7815 results in an empty string then the spec will be deleted.  (Or, if the
7816 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7817 does not currently exist a new spec will be created.  If the spec does
7818 exist then its contents will be overridden by the text of this
7819 directive, unless the first character of that text is the @samp{+}
7820 character, in which case the text will be appended to the spec.
7822 @item [@var{suffix}]:
7823 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7824 and up to the next directive or blank line are considered to make up the
7825 spec string for the indicated suffix.  When the compiler encounters an
7826 input file with the named suffix, it will processes the spec string in
7827 order to work out how to compile that file.  For example:
7829 @smallexample
7830 .ZZ:
7831 z-compile -input %i
7832 @end smallexample
7834 This says that any input file whose name ends in @samp{.ZZ} should be
7835 passed to the program @samp{z-compile}, which should be invoked with the
7836 command-line switch @option{-input} and with the result of performing the
7837 @samp{%i} substitution.  (See below.)
7839 As an alternative to providing a spec string, the text that follows a
7840 suffix directive can be one of the following:
7842 @table @code
7843 @item @@@var{language}
7844 This says that the suffix is an alias for a known @var{language}.  This is
7845 similar to using the @option{-x} command-line switch to GCC to specify a
7846 language explicitly.  For example:
7848 @smallexample
7849 .ZZ:
7850 @@c++
7851 @end smallexample
7853 Says that .ZZ files are, in fact, C++ source files.
7855 @item #@var{name}
7856 This causes an error messages saying:
7858 @smallexample
7859 @var{name} compiler not installed on this system.
7860 @end smallexample
7861 @end table
7863 GCC already has an extensive list of suffixes built into it.
7864 This directive will add an entry to the end of the list of suffixes, but
7865 since the list is searched from the end backwards, it is effectively
7866 possible to override earlier entries using this technique.
7868 @end table
7870 GCC has the following spec strings built into it.  Spec files can
7871 override these strings or create their own.  Note that individual
7872 targets can also add their own spec strings to this list.
7874 @smallexample
7875 asm          Options to pass to the assembler
7876 asm_final    Options to pass to the assembler post-processor
7877 cpp          Options to pass to the C preprocessor
7878 cc1          Options to pass to the C compiler
7879 cc1plus      Options to pass to the C++ compiler
7880 endfile      Object files to include at the end of the link
7881 link         Options to pass to the linker
7882 lib          Libraries to include on the command line to the linker
7883 libgcc       Decides which GCC support library to pass to the linker
7884 linker       Sets the name of the linker
7885 predefines   Defines to be passed to the C preprocessor
7886 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7887              by default
7888 startfile    Object files to include at the start of the link
7889 @end smallexample
7891 Here is a small example of a spec file:
7893 @smallexample
7894 %rename lib                 old_lib
7896 *lib:
7897 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7898 @end smallexample
7900 This example renames the spec called @samp{lib} to @samp{old_lib} and
7901 then overrides the previous definition of @samp{lib} with a new one.
7902 The new definition adds in some extra command-line options before
7903 including the text of the old definition.
7905 @dfn{Spec strings} are a list of command-line options to be passed to their
7906 corresponding program.  In addition, the spec strings can contain
7907 @samp{%}-prefixed sequences to substitute variable text or to
7908 conditionally insert text into the command line.  Using these constructs
7909 it is possible to generate quite complex command lines.
7911 Here is a table of all defined @samp{%}-sequences for spec
7912 strings.  Note that spaces are not generated automatically around the
7913 results of expanding these sequences.  Therefore you can concatenate them
7914 together or combine them with constant text in a single argument.
7916 @table @code
7917 @item %%
7918 Substitute one @samp{%} into the program name or argument.
7920 @item %i
7921 Substitute the name of the input file being processed.
7923 @item %b
7924 Substitute the basename of the input file being processed.
7925 This is the substring up to (and not including) the last period
7926 and not including the directory.
7928 @item %B
7929 This is the same as @samp{%b}, but include the file suffix (text after
7930 the last period).
7932 @item %d
7933 Marks the argument containing or following the @samp{%d} as a
7934 temporary file name, so that that file will be deleted if GCC exits
7935 successfully.  Unlike @samp{%g}, this contributes no text to the
7936 argument.
7938 @item %g@var{suffix}
7939 Substitute a file name that has suffix @var{suffix} and is chosen
7940 once per compilation, and mark the argument in the same way as
7941 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7942 name is now chosen in a way that is hard to predict even when previously
7943 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7944 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7945 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7946 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7947 was simply substituted with a file name chosen once per compilation,
7948 without regard to any appended suffix (which was therefore treated
7949 just like ordinary text), making such attacks more likely to succeed.
7951 @item %u@var{suffix}
7952 Like @samp{%g}, but generates a new temporary file name even if
7953 @samp{%u@var{suffix}} was already seen.
7955 @item %U@var{suffix}
7956 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7957 new one if there is no such last file name.  In the absence of any
7958 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7959 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7960 would involve the generation of two distinct file names, one
7961 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7962 simply substituted with a file name chosen for the previous @samp{%u},
7963 without regard to any appended suffix.
7965 @item %j@var{suffix}
7966 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7967 writable, and if save-temps is off; otherwise, substitute the name
7968 of a temporary file, just like @samp{%u}.  This temporary file is not
7969 meant for communication between processes, but rather as a junk
7970 disposal mechanism.
7972 @item %|@var{suffix}
7973 @itemx %m@var{suffix}
7974 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7975 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7976 all.  These are the two most common ways to instruct a program that it
7977 should read from standard input or write to standard output.  If you
7978 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7979 construct: see for example @file{f/lang-specs.h}.
7981 @item %.@var{SUFFIX}
7982 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7983 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7984 terminated by the next space or %.
7986 @item %w
7987 Marks the argument containing or following the @samp{%w} as the
7988 designated output file of this compilation.  This puts the argument
7989 into the sequence of arguments that @samp{%o} will substitute later.
7991 @item %o
7992 Substitutes the names of all the output files, with spaces
7993 automatically placed around them.  You should write spaces
7994 around the @samp{%o} as well or the results are undefined.
7995 @samp{%o} is for use in the specs for running the linker.
7996 Input files whose names have no recognized suffix are not compiled
7997 at all, but they are included among the output files, so they will
7998 be linked.
8000 @item %O
8001 Substitutes the suffix for object files.  Note that this is
8002 handled specially when it immediately follows @samp{%g, %u, or %U},
8003 because of the need for those to form complete file names.  The
8004 handling is such that @samp{%O} is treated exactly as if it had already
8005 been substituted, except that @samp{%g, %u, and %U} do not currently
8006 support additional @var{suffix} characters following @samp{%O} as they would
8007 following, for example, @samp{.o}.
8009 @item %p
8010 Substitutes the standard macro predefinitions for the
8011 current target machine.  Use this when running @code{cpp}.
8013 @item %P
8014 Like @samp{%p}, but puts @samp{__} before and after the name of each
8015 predefined macro, except for macros that start with @samp{__} or with
8016 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
8019 @item %I
8020 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
8021 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
8022 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
8023 and @option{-imultilib} as necessary.
8025 @item %s
8026 Current argument is the name of a library or startup file of some sort.
8027 Search for that file in a standard list of directories and substitute
8028 the full name found.
8030 @item %e@var{str}
8031 Print @var{str} as an error message.  @var{str} is terminated by a newline.
8032 Use this when inconsistent options are detected.
8034 @item %(@var{name})
8035 Substitute the contents of spec string @var{name} at this point.
8037 @item %[@var{name}]
8038 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
8040 @item %x@{@var{option}@}
8041 Accumulate an option for @samp{%X}.
8043 @item %X
8044 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
8045 spec string.
8047 @item %Y
8048 Output the accumulated assembler options specified by @option{-Wa}.
8050 @item %Z
8051 Output the accumulated preprocessor options specified by @option{-Wp}.
8053 @item %a
8054 Process the @code{asm} spec.  This is used to compute the
8055 switches to be passed to the assembler.
8057 @item %A
8058 Process the @code{asm_final} spec.  This is a spec string for
8059 passing switches to an assembler post-processor, if such a program is
8060 needed.
8062 @item %l
8063 Process the @code{link} spec.  This is the spec for computing the
8064 command line passed to the linker.  Typically it will make use of the
8065 @samp{%L %G %S %D and %E} sequences.
8067 @item %D
8068 Dump out a @option{-L} option for each directory that GCC believes might
8069 contain startup files.  If the target supports multilibs then the
8070 current multilib directory will be prepended to each of these paths.
8072 @item %L
8073 Process the @code{lib} spec.  This is a spec string for deciding which
8074 libraries should be included on the command line to the linker.
8076 @item %G
8077 Process the @code{libgcc} spec.  This is a spec string for deciding
8078 which GCC support library should be included on the command line to the linker.
8080 @item %S
8081 Process the @code{startfile} spec.  This is a spec for deciding which
8082 object files should be the first ones passed to the linker.  Typically
8083 this might be a file named @file{crt0.o}.
8085 @item %E
8086 Process the @code{endfile} spec.  This is a spec string that specifies
8087 the last object files that will be passed to the linker.
8089 @item %C
8090 Process the @code{cpp} spec.  This is used to construct the arguments
8091 to be passed to the C preprocessor.
8093 @item %1
8094 Process the @code{cc1} spec.  This is used to construct the options to be
8095 passed to the actual C compiler (@samp{cc1}).
8097 @item %2
8098 Process the @code{cc1plus} spec.  This is used to construct the options to be
8099 passed to the actual C++ compiler (@samp{cc1plus}).
8101 @item %*
8102 Substitute the variable part of a matched option.  See below.
8103 Note that each comma in the substituted string is replaced by
8104 a single space.
8106 @item %<@code{S}
8107 Remove all occurrences of @code{-S} from the command line.  Note---this
8108 command is position dependent.  @samp{%} commands in the spec string
8109 before this one will see @code{-S}, @samp{%} commands in the spec string
8110 after this one will not.
8112 @item %:@var{function}(@var{args})
8113 Call the named function @var{function}, passing it @var{args}.
8114 @var{args} is first processed as a nested spec string, then split
8115 into an argument vector in the usual fashion.  The function returns
8116 a string which is processed as if it had appeared literally as part
8117 of the current spec.
8119 The following built-in spec functions are provided:
8121 @table @code
8122 @item @code{getenv}
8123 The @code{getenv} spec function takes two arguments: an environment
8124 variable name and a string.  If the environment variable is not
8125 defined, a fatal error is issued.  Otherwise, the return value is the
8126 value of the environment variable concatenated with the string.  For
8127 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
8129 @smallexample
8130 %:getenv(TOPDIR /include)
8131 @end smallexample
8133 expands to @file{/path/to/top/include}.
8135 @item @code{if-exists}
8136 The @code{if-exists} spec function takes one argument, an absolute
8137 pathname to a file.  If the file exists, @code{if-exists} returns the
8138 pathname.  Here is a small example of its usage:
8140 @smallexample
8141 *startfile:
8142 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
8143 @end smallexample
8145 @item @code{if-exists-else}
8146 The @code{if-exists-else} spec function is similar to the @code{if-exists}
8147 spec function, except that it takes two arguments.  The first argument is
8148 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
8149 returns the pathname.  If it does not exist, it returns the second argument.
8150 This way, @code{if-exists-else} can be used to select one file or another,
8151 based on the existence of the first.  Here is a small example of its usage:
8153 @smallexample
8154 *startfile:
8155 crt0%O%s %:if-exists(crti%O%s) \
8156 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
8157 @end smallexample
8159 @item @code{replace-outfile}
8160 The @code{replace-outfile} spec function takes two arguments.  It looks for the
8161 first argument in the outfiles array and replaces it with the second argument.  Here
8162 is a small example of its usage:
8164 @smallexample
8165 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
8166 @end smallexample
8168 @item @code{print-asm-header}
8169 The @code{print-asm-header} function takes no arguments and simply
8170 prints a banner like:
8172 @smallexample
8173 Assembler options
8174 =================
8176 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
8177 @end smallexample
8179 It is used to separate compiler options from assembler options
8180 in the @option{--target-help} output.
8181 @end table
8183 @item %@{@code{S}@}
8184 Substitutes the @code{-S} switch, if that switch was given to GCC@.
8185 If that switch was not specified, this substitutes nothing.  Note that
8186 the leading dash is omitted when specifying this option, and it is
8187 automatically inserted if the substitution is performed.  Thus the spec
8188 string @samp{%@{foo@}} would match the command-line option @option{-foo}
8189 and would output the command line option @option{-foo}.
8191 @item %W@{@code{S}@}
8192 Like %@{@code{S}@} but mark last argument supplied within as a file to be
8193 deleted on failure.
8195 @item %@{@code{S}*@}
8196 Substitutes all the switches specified to GCC whose names start
8197 with @code{-S}, but which also take an argument.  This is used for
8198 switches like @option{-o}, @option{-D}, @option{-I}, etc.
8199 GCC considers @option{-o foo} as being
8200 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
8201 text, including the space.  Thus two arguments would be generated.
8203 @item %@{@code{S}*&@code{T}*@}
8204 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
8205 (the order of @code{S} and @code{T} in the spec is not significant).
8206 There can be any number of ampersand-separated variables; for each the
8207 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
8209 @item %@{@code{S}:@code{X}@}
8210 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
8212 @item %@{!@code{S}:@code{X}@}
8213 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
8215 @item %@{@code{S}*:@code{X}@}
8216 Substitutes @code{X} if one or more switches whose names start with
8217 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
8218 once, no matter how many such switches appeared.  However, if @code{%*}
8219 appears somewhere in @code{X}, then @code{X} will be substituted once
8220 for each matching switch, with the @code{%*} replaced by the part of
8221 that switch that matched the @code{*}.
8223 @item %@{.@code{S}:@code{X}@}
8224 Substitutes @code{X}, if processing a file with suffix @code{S}.
8226 @item %@{!.@code{S}:@code{X}@}
8227 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
8229 @item %@{,@code{S}:@code{X}@}
8230 Substitutes @code{X}, if processing a file for language @code{S}.
8232 @item %@{!,@code{S}:@code{X}@}
8233 Substitutes @code{X}, if not processing a file for language @code{S}.
8235 @item %@{@code{S}|@code{P}:@code{X}@}
8236 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
8237 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
8238 @code{*} sequences as well, although they have a stronger binding than
8239 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
8240 alternatives must be starred, and only the first matching alternative
8241 is substituted.
8243 For example, a spec string like this:
8245 @smallexample
8246 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
8247 @end smallexample
8249 will output the following command-line options from the following input
8250 command-line options:
8252 @smallexample
8253 fred.c        -foo -baz
8254 jim.d         -bar -boggle
8255 -d fred.c     -foo -baz -boggle
8256 -d jim.d      -bar -baz -boggle
8257 @end smallexample
8259 @item %@{S:X; T:Y; :D@}
8261 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
8262 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
8263 be as many clauses as you need.  This may be combined with @code{.},
8264 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
8267 @end table
8269 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
8270 construct may contain other nested @samp{%} constructs or spaces, or
8271 even newlines.  They are processed as usual, as described above.
8272 Trailing white space in @code{X} is ignored.  White space may also
8273 appear anywhere on the left side of the colon in these constructs,
8274 except between @code{.} or @code{*} and the corresponding word.
8276 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8277 handled specifically in these constructs.  If another value of
8278 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8279 @option{-W} switch is found later in the command line, the earlier
8280 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8281 just one letter, which passes all matching options.
8283 The character @samp{|} at the beginning of the predicate text is used to
8284 indicate that a command should be piped to the following command, but
8285 only if @option{-pipe} is specified.
8287 It is built into GCC which switches take arguments and which do not.
8288 (You might think it would be useful to generalize this to allow each
8289 compiler's spec to say which switches take arguments.  But this cannot
8290 be done in a consistent fashion.  GCC cannot even decide which input
8291 files have been specified without knowing which switches take arguments,
8292 and it must know which input files to compile in order to tell which
8293 compilers to run).
8295 GCC also knows implicitly that arguments starting in @option{-l} are to be
8296 treated as compiler output files, and passed to the linker in their
8297 proper position among the other output files.
8299 @c man begin OPTIONS
8301 @node Target Options
8302 @section Specifying Target Machine and Compiler Version
8303 @cindex target options
8304 @cindex cross compiling
8305 @cindex specifying machine version
8306 @cindex specifying compiler version and target machine
8307 @cindex compiler version, specifying
8308 @cindex target machine, specifying
8310 The usual way to run GCC is to run the executable called @file{gcc}, or
8311 @file{<machine>-gcc} when cross-compiling, or
8312 @file{<machine>-gcc-<version>} to run a version other than the one that
8313 was installed last.  Sometimes this is inconvenient, so GCC provides
8314 options that will switch to another cross-compiler or version.
8316 @table @gcctabopt
8317 @item -b @var{machine}
8318 @opindex b
8319 The argument @var{machine} specifies the target machine for compilation.
8321 The value to use for @var{machine} is the same as was specified as the
8322 machine type when configuring GCC as a cross-compiler.  For
8323 example, if a cross-compiler was configured with @samp{configure
8324 arm-elf}, meaning to compile for an arm processor with elf binaries,
8325 then you would specify @option{-b arm-elf} to run that cross compiler.
8326 Because there are other options beginning with @option{-b}, the
8327 configuration must contain a hyphen.
8329 @item -V @var{version}
8330 @opindex V
8331 The argument @var{version} specifies which version of GCC to run.
8332 This is useful when multiple versions are installed.  For example,
8333 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8334 @end table
8336 The @option{-V} and @option{-b} options work by running the
8337 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8338 use them if you can just run that directly.
8340 @node Submodel Options
8341 @section Hardware Models and Configurations
8342 @cindex submodel options
8343 @cindex specifying hardware config
8344 @cindex hardware models and configurations, specifying
8345 @cindex machine dependent options
8347 Earlier we discussed the standard option @option{-b} which chooses among
8348 different installed compilers for completely different target
8349 machines, such as VAX vs.@: 68000 vs.@: 80386.
8351 In addition, each of these target machine types can have its own
8352 special options, starting with @samp{-m}, to choose among various
8353 hardware models or configurations---for example, 68010 vs 68020,
8354 floating coprocessor or none.  A single installed version of the
8355 compiler can compile for any model or configuration, according to the
8356 options specified.
8358 Some configurations of the compiler also support additional special
8359 options, usually for compatibility with other compilers on the same
8360 platform.
8362 @c This list is ordered alphanumerically by subsection name.
8363 @c It should be the same order and spelling as these options are listed
8364 @c in Machine Dependent Options
8366 @menu
8367 * ARC Options::
8368 * ARM Options::
8369 * AVR Options::
8370 * Blackfin Options::
8371 * CRIS Options::
8372 * CRX Options::
8373 * Darwin Options::
8374 * DEC Alpha Options::
8375 * DEC Alpha/VMS Options::
8376 * FRV Options::
8377 * GNU/Linux Options::
8378 * H8/300 Options::
8379 * HPPA Options::
8380 * i386 and x86-64 Options::
8381 * IA-64 Options::
8382 * M32C Options::
8383 * M32R/D Options::
8384 * M680x0 Options::
8385 * M68hc1x Options::
8386 * MCore Options::
8387 * MIPS Options::
8388 * MMIX Options::
8389 * MN10300 Options::
8390 * MT Options::
8391 * PDP-11 Options::
8392 * PowerPC Options::
8393 * RS/6000 and PowerPC Options::
8394 * S/390 and zSeries Options::
8395 * Score Options::
8396 * SH Options::
8397 * SPARC Options::
8398 * SPU Options::
8399 * System V Options::
8400 * V850 Options::
8401 * VAX Options::
8402 * VxWorks Options::
8403 * x86-64 Options::
8404 * Xstormy16 Options::
8405 * Xtensa Options::
8406 * zSeries Options::
8407 @end menu
8409 @node ARC Options
8410 @subsection ARC Options
8411 @cindex ARC Options
8413 These options are defined for ARC implementations:
8415 @table @gcctabopt
8416 @item -EL
8417 @opindex EL
8418 Compile code for little endian mode.  This is the default.
8420 @item -EB
8421 @opindex EB
8422 Compile code for big endian mode.
8424 @item -mmangle-cpu
8425 @opindex mmangle-cpu
8426 Prepend the name of the cpu to all public symbol names.
8427 In multiple-processor systems, there are many ARC variants with different
8428 instruction and register set characteristics.  This flag prevents code
8429 compiled for one cpu to be linked with code compiled for another.
8430 No facility exists for handling variants that are ``almost identical''.
8431 This is an all or nothing option.
8433 @item -mcpu=@var{cpu}
8434 @opindex mcpu
8435 Compile code for ARC variant @var{cpu}.
8436 Which variants are supported depend on the configuration.
8437 All variants support @option{-mcpu=base}, this is the default.
8439 @item -mtext=@var{text-section}
8440 @itemx -mdata=@var{data-section}
8441 @itemx -mrodata=@var{readonly-data-section}
8442 @opindex mtext
8443 @opindex mdata
8444 @opindex mrodata
8445 Put functions, data, and readonly data in @var{text-section},
8446 @var{data-section}, and @var{readonly-data-section} respectively
8447 by default.  This can be overridden with the @code{section} attribute.
8448 @xref{Variable Attributes}.
8450 @end table
8452 @node ARM Options
8453 @subsection ARM Options
8454 @cindex ARM options
8456 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8457 architectures:
8459 @table @gcctabopt
8460 @item -mabi=@var{name}
8461 @opindex mabi
8462 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8463 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8465 @item -mapcs-frame
8466 @opindex mapcs-frame
8467 Generate a stack frame that is compliant with the ARM Procedure Call
8468 Standard for all functions, even if this is not strictly necessary for
8469 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8470 with this option will cause the stack frames not to be generated for
8471 leaf functions.  The default is @option{-mno-apcs-frame}.
8473 @item -mapcs
8474 @opindex mapcs
8475 This is a synonym for @option{-mapcs-frame}.
8477 @ignore
8478 @c not currently implemented
8479 @item -mapcs-stack-check
8480 @opindex mapcs-stack-check
8481 Generate code to check the amount of stack space available upon entry to
8482 every function (that actually uses some stack space).  If there is
8483 insufficient space available then either the function
8484 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8485 called, depending upon the amount of stack space required.  The run time
8486 system is required to provide these functions.  The default is
8487 @option{-mno-apcs-stack-check}, since this produces smaller code.
8489 @c not currently implemented
8490 @item -mapcs-float
8491 @opindex mapcs-float
8492 Pass floating point arguments using the float point registers.  This is
8493 one of the variants of the APCS@.  This option is recommended if the
8494 target hardware has a floating point unit or if a lot of floating point
8495 arithmetic is going to be performed by the code.  The default is
8496 @option{-mno-apcs-float}, since integer only code is slightly increased in
8497 size if @option{-mapcs-float} is used.
8499 @c not currently implemented
8500 @item -mapcs-reentrant
8501 @opindex mapcs-reentrant
8502 Generate reentrant, position independent code.  The default is
8503 @option{-mno-apcs-reentrant}.
8504 @end ignore
8506 @item -mthumb-interwork
8507 @opindex mthumb-interwork
8508 Generate code which supports calling between the ARM and Thumb
8509 instruction sets.  Without this option the two instruction sets cannot
8510 be reliably used inside one program.  The default is
8511 @option{-mno-thumb-interwork}, since slightly larger code is generated
8512 when @option{-mthumb-interwork} is specified.
8514 @item -mno-sched-prolog
8515 @opindex mno-sched-prolog
8516 Prevent the reordering of instructions in the function prolog, or the
8517 merging of those instruction with the instructions in the function's
8518 body.  This means that all functions will start with a recognizable set
8519 of instructions (or in fact one of a choice from a small set of
8520 different function prologues), and this information can be used to
8521 locate the start if functions inside an executable piece of code.  The
8522 default is @option{-msched-prolog}.
8524 @item -mhard-float
8525 @opindex mhard-float
8526 Generate output containing floating point instructions.  This is the
8527 default.
8529 @item -msoft-float
8530 @opindex msoft-float
8531 Generate output containing library calls for floating point.
8532 @strong{Warning:} the requisite libraries are not available for all ARM
8533 targets.  Normally the facilities of the machine's usual C compiler are
8534 used, but this cannot be done directly in cross-compilation.  You must make
8535 your own arrangements to provide suitable library functions for
8536 cross-compilation.
8538 @option{-msoft-float} changes the calling convention in the output file;
8539 therefore, it is only useful if you compile @emph{all} of a program with
8540 this option.  In particular, you need to compile @file{libgcc.a}, the
8541 library that comes with GCC, with @option{-msoft-float} in order for
8542 this to work.
8544 @item -mfloat-abi=@var{name}
8545 @opindex mfloat-abi
8546 Specifies which ABI to use for floating point values.  Permissible values
8547 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8549 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8550 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8551 of floating point instructions, but still uses the soft-float calling
8552 conventions.
8554 @item -mlittle-endian
8555 @opindex mlittle-endian
8556 Generate code for a processor running in little-endian mode.  This is
8557 the default for all standard configurations.
8559 @item -mbig-endian
8560 @opindex mbig-endian
8561 Generate code for a processor running in big-endian mode; the default is
8562 to compile code for a little-endian processor.
8564 @item -mwords-little-endian
8565 @opindex mwords-little-endian
8566 This option only applies when generating code for big-endian processors.
8567 Generate code for a little-endian word order but a big-endian byte
8568 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8569 option should only be used if you require compatibility with code for
8570 big-endian ARM processors generated by versions of the compiler prior to
8571 2.8.
8573 @item -mcpu=@var{name}
8574 @opindex mcpu
8575 This specifies the name of the target ARM processor.  GCC uses this name
8576 to determine what kind of instructions it can emit when generating
8577 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8578 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8579 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8580 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8581 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8582 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8583 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8584 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8585 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8586 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8587 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8588 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8589 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8590 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8591 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3}, @samp{cortex-m1},
8592 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8594 @item -mtune=@var{name}
8595 @opindex mtune
8596 This option is very similar to the @option{-mcpu=} option, except that
8597 instead of specifying the actual target processor type, and hence
8598 restricting which instructions can be used, it specifies that GCC should
8599 tune the performance of the code as if the target were of the type
8600 specified in this option, but still choosing the instructions that it
8601 will generate based on the cpu specified by a @option{-mcpu=} option.
8602 For some ARM implementations better performance can be obtained by using
8603 this option.
8605 @item -march=@var{name}
8606 @opindex march
8607 This specifies the name of the target ARM architecture.  GCC uses this
8608 name to determine what kind of instructions it can emit when generating
8609 assembly code.  This option can be used in conjunction with or instead
8610 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8611 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8612 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8613 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
8614 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
8615 @samp{iwmmxt}, @samp{ep9312}.
8617 @item -mfpu=@var{name}
8618 @itemx -mfpe=@var{number}
8619 @itemx -mfp=@var{number}
8620 @opindex mfpu
8621 @opindex mfpe
8622 @opindex mfp
8623 This specifies what floating point hardware (or hardware emulation) is
8624 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8625 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8626 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8627 with older versions of GCC@.
8629 If @option{-msoft-float} is specified this specifies the format of
8630 floating point values.
8632 @item -mstructure-size-boundary=@var{n}
8633 @opindex mstructure-size-boundary
8634 The size of all structures and unions will be rounded up to a multiple
8635 of the number of bits set by this option.  Permissible values are 8, 32
8636 and 64.  The default value varies for different toolchains.  For the COFF
8637 targeted toolchain the default value is 8.  A value of 64 is only allowed
8638 if the underlying ABI supports it.
8640 Specifying the larger number can produce faster, more efficient code, but
8641 can also increase the size of the program.  Different values are potentially
8642 incompatible.  Code compiled with one value cannot necessarily expect to
8643 work with code or libraries compiled with another value, if they exchange
8644 information using structures or unions.
8646 @item -mabort-on-noreturn
8647 @opindex mabort-on-noreturn
8648 Generate a call to the function @code{abort} at the end of a
8649 @code{noreturn} function.  It will be executed if the function tries to
8650 return.
8652 @item -mlong-calls
8653 @itemx -mno-long-calls
8654 @opindex mlong-calls
8655 @opindex mno-long-calls
8656 Tells the compiler to perform function calls by first loading the
8657 address of the function into a register and then performing a subroutine
8658 call on this register.  This switch is needed if the target function
8659 will lie outside of the 64 megabyte addressing range of the offset based
8660 version of subroutine call instruction.
8662 Even if this switch is enabled, not all function calls will be turned
8663 into long calls.  The heuristic is that static functions, functions
8664 which have the @samp{short-call} attribute, functions that are inside
8665 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8666 definitions have already been compiled within the current compilation
8667 unit, will not be turned into long calls.  The exception to this rule is
8668 that weak function definitions, functions with the @samp{long-call}
8669 attribute or the @samp{section} attribute, and functions that are within
8670 the scope of a @samp{#pragma long_calls} directive, will always be
8671 turned into long calls.
8673 This feature is not enabled by default.  Specifying
8674 @option{-mno-long-calls} will restore the default behavior, as will
8675 placing the function calls within the scope of a @samp{#pragma
8676 long_calls_off} directive.  Note these switches have no effect on how
8677 the compiler generates code to handle function calls via function
8678 pointers.
8680 @item -mnop-fun-dllimport
8681 @opindex mnop-fun-dllimport
8682 Disable support for the @code{dllimport} attribute.
8684 @item -msingle-pic-base
8685 @opindex msingle-pic-base
8686 Treat the register used for PIC addressing as read-only, rather than
8687 loading it in the prologue for each function.  The run-time system is
8688 responsible for initializing this register with an appropriate value
8689 before execution begins.
8691 @item -mpic-register=@var{reg}
8692 @opindex mpic-register
8693 Specify the register to be used for PIC addressing.  The default is R10
8694 unless stack-checking is enabled, when R9 is used.
8696 @item -mcirrus-fix-invalid-insns
8697 @opindex mcirrus-fix-invalid-insns
8698 @opindex mno-cirrus-fix-invalid-insns
8699 Insert NOPs into the instruction stream to in order to work around
8700 problems with invalid Maverick instruction combinations.  This option
8701 is only valid if the @option{-mcpu=ep9312} option has been used to
8702 enable generation of instructions for the Cirrus Maverick floating
8703 point co-processor.  This option is not enabled by default, since the
8704 problem is only present in older Maverick implementations.  The default
8705 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8706 switch.
8708 @item -mpoke-function-name
8709 @opindex mpoke-function-name
8710 Write the name of each function into the text section, directly
8711 preceding the function prologue.  The generated code is similar to this:
8713 @smallexample
8714      t0
8715          .ascii "arm_poke_function_name", 0
8716          .align
8717      t1
8718          .word 0xff000000 + (t1 - t0)
8719      arm_poke_function_name
8720          mov     ip, sp
8721          stmfd   sp!, @{fp, ip, lr, pc@}
8722          sub     fp, ip, #4
8723 @end smallexample
8725 When performing a stack backtrace, code can inspect the value of
8726 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8727 location @code{pc - 12} and the top 8 bits are set, then we know that
8728 there is a function name embedded immediately preceding this location
8729 and has length @code{((pc[-3]) & 0xff000000)}.
8731 @item -mthumb
8732 @opindex mthumb
8733 Generate code for the Thumb instruction set.  The default is to
8734 use the 32-bit ARM instruction set.
8735 This option automatically enables either 16-bit Thumb-1 or
8736 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8737 and @option{-march=@var{name}} options.
8739 @item -mtpcs-frame
8740 @opindex mtpcs-frame
8741 Generate a stack frame that is compliant with the Thumb Procedure Call
8742 Standard for all non-leaf functions.  (A leaf function is one that does
8743 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8745 @item -mtpcs-leaf-frame
8746 @opindex mtpcs-leaf-frame
8747 Generate a stack frame that is compliant with the Thumb Procedure Call
8748 Standard for all leaf functions.  (A leaf function is one that does
8749 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8751 @item -mcallee-super-interworking
8752 @opindex mcallee-super-interworking
8753 Gives all externally visible functions in the file being compiled an ARM
8754 instruction set header which switches to Thumb mode before executing the
8755 rest of the function.  This allows these functions to be called from
8756 non-interworking code.
8758 @item -mcaller-super-interworking
8759 @opindex mcaller-super-interworking
8760 Allows calls via function pointers (including virtual functions) to
8761 execute correctly regardless of whether the target code has been
8762 compiled for interworking or not.  There is a small overhead in the cost
8763 of executing a function pointer if this option is enabled.
8765 @item -mtp=@var{name}
8766 @opindex mtp
8767 Specify the access model for the thread local storage pointer.  The valid
8768 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8769 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8770 (supported in the arm6k architecture), and @option{auto}, which uses the
8771 best available method for the selected processor.  The default setting is
8772 @option{auto}.
8774 @end table
8776 @node AVR Options
8777 @subsection AVR Options
8778 @cindex AVR Options
8780 These options are defined for AVR implementations:
8782 @table @gcctabopt
8783 @item -mmcu=@var{mcu}
8784 @opindex mmcu
8785 Specify ATMEL AVR instruction set or MCU type.
8787 Instruction set avr1 is for the minimal AVR core, not supported by the C
8788 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8789 attiny11, attiny12, attiny15, attiny28).
8791 Instruction set avr2 (default) is for the classic AVR core with up to
8792 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8793 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8794 at90c8534, at90s8535).
8796 Instruction set avr3 is for the classic AVR core with up to 128K program
8797 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8799 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8800 memory space (MCU types: atmega8, atmega83, atmega85).
8802 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8803 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8804 atmega64, atmega128, at43usb355, at94k).
8806 @item -msize
8807 @opindex msize
8808 Output instruction sizes to the asm file.
8810 @item -minit-stack=@var{N}
8811 @opindex minit-stack
8812 Specify the initial stack address, which may be a symbol or numeric value,
8813 @samp{__stack} is the default.
8815 @item -mno-interrupts
8816 @opindex mno-interrupts
8817 Generated code is not compatible with hardware interrupts.
8818 Code size will be smaller.
8820 @item -mcall-prologues
8821 @opindex mcall-prologues
8822 Functions prologues/epilogues expanded as call to appropriate
8823 subroutines.  Code size will be smaller.
8825 @item -mno-tablejump
8826 @opindex mno-tablejump
8827 Do not generate tablejump insns which sometimes increase code size.
8829 @item -mtiny-stack
8830 @opindex mtiny-stack
8831 Change only the low 8 bits of the stack pointer.
8833 @item -mint8
8834 @opindex mint8
8835 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8836 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8837 and long long will be 4 bytes.  Please note that this option does not
8838 comply to the C standards, but it will provide you with smaller code
8839 size.
8840 @end table
8842 @node Blackfin Options
8843 @subsection Blackfin Options
8844 @cindex Blackfin Options
8846 @table @gcctabopt
8847 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
8848 @opindex mcpu=
8849 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
8850 can be one of @samp{bf522}, @samp{bf523}, @samp{bf524},
8851 @samp{bf525}, @samp{bf526}, @samp{bf527},
8852 @samp{bf531}, @samp{bf532}, @samp{bf533}, @samp{bf534},
8853 @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
8854 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
8855 @samp{bf561}.
8856 The optional @var{sirevision} specifies the silicon revision of the target
8857 Blackfin processor.  Any workarounds available for the targeted silicon revision
8858 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
8859 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
8860 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
8861 hexadecimal digits representing the major and minor numbers in the silicon
8862 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
8863 is not defined.  If @var{sirevision} is @samp{any}, the
8864 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
8865 If this optional @var{sirevision} is not used, GCC assumes the latest known
8866 silicon revision of the targeted Blackfin processor.
8868 Support for @samp{bf561} is incomplete.  For @samp{bf561},
8869 Only the processor macro is defined.
8870 Without this option, @samp{bf532} is used as the processor by default.
8871 The corresponding predefined processor macros for @var{cpu} is to
8872 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
8873 provided by libgloss to be linked in if @option{-msim} is not given.
8875 @item -msim
8876 @opindex msim
8877 Specifies that the program will be run on the simulator.  This causes
8878 the simulator BSP provided by libgloss to be linked in.  This option
8879 has effect only for @samp{bfin-elf} toolchain.
8880 Certain other options, such as @option{-mid-shared-library} and
8881 @option{-mfdpic}, imply @option{-msim}.
8883 @item -momit-leaf-frame-pointer
8884 @opindex momit-leaf-frame-pointer
8885 Don't keep the frame pointer in a register for leaf functions.  This
8886 avoids the instructions to save, set up and restore frame pointers and
8887 makes an extra register available in leaf functions.  The option
8888 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8889 which might make debugging harder.
8891 @item -mspecld-anomaly
8892 @opindex mspecld-anomaly
8893 When enabled, the compiler will ensure that the generated code does not
8894 contain speculative loads after jump instructions. If this option is used,
8895 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
8897 @item -mno-specld-anomaly
8898 @opindex mno-specld-anomaly
8899 Don't generate extra code to prevent speculative loads from occurring.
8901 @item -mcsync-anomaly
8902 @opindex mcsync-anomaly
8903 When enabled, the compiler will ensure that the generated code does not
8904 contain CSYNC or SSYNC instructions too soon after conditional branches.
8905 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
8907 @item -mno-csync-anomaly
8908 @opindex mno-csync-anomaly
8909 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8910 occurring too soon after a conditional branch.
8912 @item -mlow-64k
8913 @opindex mlow-64k
8914 When enabled, the compiler is free to take advantage of the knowledge that
8915 the entire program fits into the low 64k of memory.
8917 @item -mno-low-64k
8918 @opindex mno-low-64k
8919 Assume that the program is arbitrarily large.  This is the default.
8921 @item -mstack-check-l1
8922 @opindex mstack-check-l1
8923 Do stack checking using information placed into L1 scratchpad memory by the
8924 uClinux kernel.
8926 @item -mid-shared-library
8927 @opindex mid-shared-library
8928 Generate code that supports shared libraries via the library ID method.
8929 This allows for execute in place and shared libraries in an environment
8930 without virtual memory management.  This option implies @option{-fPIC}.
8931 With a @samp{bfin-elf} target, this option implies @option{-msim}.
8933 @item -mno-id-shared-library
8934 @opindex mno-id-shared-library
8935 Generate code that doesn't assume ID based shared libraries are being used.
8936 This is the default.
8938 @item -mleaf-id-shared-library
8939 @opindex mleaf-id-shared-library
8940 Generate code that supports shared libraries via the library ID method,
8941 but assumes that this library or executable won't link against any other
8942 ID shared libraries.  That allows the compiler to use faster code for jumps
8943 and calls.
8945 @item -mno-leaf-id-shared-library
8946 @opindex mno-leaf-id-shared-library
8947 Do not assume that the code being compiled won't link against any ID shared
8948 libraries.  Slower code will be generated for jump and call insns.
8950 @item -mshared-library-id=n
8951 @opindex mshared-library-id
8952 Specified the identification number of the ID based shared library being
8953 compiled.  Specifying a value of 0 will generate more compact code, specifying
8954 other values will force the allocation of that number to the current
8955 library but is no more space or time efficient than omitting this option.
8957 @item -msep-data
8958 @opindex msep-data
8959 Generate code that allows the data segment to be located in a different
8960 area of memory from the text segment.  This allows for execute in place in
8961 an environment without virtual memory management by eliminating relocations
8962 against the text section.
8964 @item -mno-sep-data
8965 @opindex mno-sep-data
8966 Generate code that assumes that the data segment follows the text segment.
8967 This is the default.
8969 @item -mlong-calls
8970 @itemx -mno-long-calls
8971 @opindex mlong-calls
8972 @opindex mno-long-calls
8973 Tells the compiler to perform function calls by first loading the
8974 address of the function into a register and then performing a subroutine
8975 call on this register.  This switch is needed if the target function
8976 will lie outside of the 24 bit addressing range of the offset based
8977 version of subroutine call instruction.
8979 This feature is not enabled by default.  Specifying
8980 @option{-mno-long-calls} will restore the default behavior.  Note these
8981 switches have no effect on how the compiler generates code to handle
8982 function calls via function pointers.
8984 @item -mfast-fp
8985 @opindex mfast-fp
8986 Link with the fast floating-point library. This library relaxes some of
8987 the IEEE floating-point standard's rules for checking inputs against
8988 Not-a-Number (NAN), in the interest of performance.
8990 @item -minline-plt
8991 @opindex minline-plt
8992 Enable inlining of PLT entries in function calls to functions that are
8993 not known to bind locally.  It has no effect without @option{-mfdpic}.
8995 @item -mmulticore
8996 @opindex mmulticore
8997 Build standalone application for multicore Blackfin processor. Proper
8998 start files and link scripts will be used to support multicore.
8999 This option defines @code{__BFIN_MULTICORE}. It can only be used with
9000 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
9001 @option{-mcorea} or @option{-mcoreb}. If it's used without
9002 @option{-mcorea} or @option{-mcoreb}, single application/dual core
9003 programming model is used. In this model, the main function of Core B
9004 should be named as coreb_main. If it's used with @option{-mcorea} or
9005 @option{-mcoreb}, one application per core programming model is used.
9006 If this option is not used, single core application programming
9007 model is used.
9009 @item -mcorea
9010 @opindex mcorea
9011 Build standalone application for Core A of BF561 when using
9012 one application per core programming model. Proper start files
9013 and link scripts will be used to support Core A. This option
9014 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
9016 @item -mcoreb
9017 @opindex mcoreb
9018 Build standalone application for Core B of BF561 when using
9019 one application per core programming model. Proper start files
9020 and link scripts will be used to support Core B. This option
9021 defines @code{__BFIN_COREB}. When this option is used, coreb_main
9022 should be used instead of main. It must be used with
9023 @option{-mmulticore}. 
9025 @item -msdram
9026 @opindex msdram
9027 Build standalone application for SDRAM. Proper start files and
9028 link scripts will be used to put the application into SDRAM.
9029 Loader should initialize SDRAM before loading the application
9030 into SDRAM. This option defines @code{__BFIN_SDRAM}.
9031 @end table
9032   
9033 @node CRIS Options
9034 @subsection CRIS Options
9035 @cindex CRIS Options
9037 These options are defined specifically for the CRIS ports.
9039 @table @gcctabopt
9040 @item -march=@var{architecture-type}
9041 @itemx -mcpu=@var{architecture-type}
9042 @opindex march
9043 @opindex mcpu
9044 Generate code for the specified architecture.  The choices for
9045 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
9046 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
9047 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
9048 @samp{v10}.
9050 @item -mtune=@var{architecture-type}
9051 @opindex mtune
9052 Tune to @var{architecture-type} everything applicable about the generated
9053 code, except for the ABI and the set of available instructions.  The
9054 choices for @var{architecture-type} are the same as for
9055 @option{-march=@var{architecture-type}}.
9057 @item -mmax-stack-frame=@var{n}
9058 @opindex mmax-stack-frame
9059 Warn when the stack frame of a function exceeds @var{n} bytes.
9061 @item -melinux-stacksize=@var{n}
9062 @opindex melinux-stacksize
9063 Only available with the @samp{cris-axis-aout} target.  Arranges for
9064 indications in the program to the kernel loader that the stack of the
9065 program should be set to @var{n} bytes.
9067 @item -metrax4
9068 @itemx -metrax100
9069 @opindex metrax4
9070 @opindex metrax100
9071 The options @option{-metrax4} and @option{-metrax100} are synonyms for
9072 @option{-march=v3} and @option{-march=v8} respectively.
9074 @item -mmul-bug-workaround
9075 @itemx -mno-mul-bug-workaround
9076 @opindex mmul-bug-workaround
9077 @opindex mno-mul-bug-workaround
9078 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
9079 models where it applies.  This option is active by default.
9081 @item -mpdebug
9082 @opindex mpdebug
9083 Enable CRIS-specific verbose debug-related information in the assembly
9084 code.  This option also has the effect to turn off the @samp{#NO_APP}
9085 formatted-code indicator to the assembler at the beginning of the
9086 assembly file.
9088 @item -mcc-init
9089 @opindex mcc-init
9090 Do not use condition-code results from previous instruction; always emit
9091 compare and test instructions before use of condition codes.
9093 @item -mno-side-effects
9094 @opindex mno-side-effects
9095 Do not emit instructions with side-effects in addressing modes other than
9096 post-increment.
9098 @item -mstack-align
9099 @itemx -mno-stack-align
9100 @itemx -mdata-align
9101 @itemx -mno-data-align
9102 @itemx -mconst-align
9103 @itemx -mno-const-align
9104 @opindex mstack-align
9105 @opindex mno-stack-align
9106 @opindex mdata-align
9107 @opindex mno-data-align
9108 @opindex mconst-align
9109 @opindex mno-const-align
9110 These options (no-options) arranges (eliminate arrangements) for the
9111 stack-frame, individual data and constants to be aligned for the maximum
9112 single data access size for the chosen CPU model.  The default is to
9113 arrange for 32-bit alignment.  ABI details such as structure layout are
9114 not affected by these options.
9116 @item -m32-bit
9117 @itemx -m16-bit
9118 @itemx -m8-bit
9119 @opindex m32-bit
9120 @opindex m16-bit
9121 @opindex m8-bit
9122 Similar to the stack- data- and const-align options above, these options
9123 arrange for stack-frame, writable data and constants to all be 32-bit,
9124 16-bit or 8-bit aligned.  The default is 32-bit alignment.
9126 @item -mno-prologue-epilogue
9127 @itemx -mprologue-epilogue
9128 @opindex mno-prologue-epilogue
9129 @opindex mprologue-epilogue
9130 With @option{-mno-prologue-epilogue}, the normal function prologue and
9131 epilogue that sets up the stack-frame are omitted and no return
9132 instructions or return sequences are generated in the code.  Use this
9133 option only together with visual inspection of the compiled code: no
9134 warnings or errors are generated when call-saved registers must be saved,
9135 or storage for local variable needs to be allocated.
9137 @item -mno-gotplt
9138 @itemx -mgotplt
9139 @opindex mno-gotplt
9140 @opindex mgotplt
9141 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
9142 instruction sequences that load addresses for functions from the PLT part
9143 of the GOT rather than (traditional on other architectures) calls to the
9144 PLT@.  The default is @option{-mgotplt}.
9146 @item -maout
9147 @opindex maout
9148 Legacy no-op option only recognized with the cris-axis-aout target.
9150 @item -melf
9151 @opindex melf
9152 Legacy no-op option only recognized with the cris-axis-elf and
9153 cris-axis-linux-gnu targets.
9155 @item -melinux
9156 @opindex melinux
9157 Only recognized with the cris-axis-aout target, where it selects a
9158 GNU/linux-like multilib, include files and instruction set for
9159 @option{-march=v8}.
9161 @item -mlinux
9162 @opindex mlinux
9163 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
9165 @item -sim
9166 @opindex sim
9167 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
9168 to link with input-output functions from a simulator library.  Code,
9169 initialized data and zero-initialized data are allocated consecutively.
9171 @item -sim2
9172 @opindex sim2
9173 Like @option{-sim}, but pass linker options to locate initialized data at
9174 0x40000000 and zero-initialized data at 0x80000000.
9175 @end table
9177 @node CRX Options
9178 @subsection CRX Options
9179 @cindex CRX Options
9181 These options are defined specifically for the CRX ports.
9183 @table @gcctabopt
9185 @item -mmac
9186 @opindex mmac
9187 Enable the use of multiply-accumulate instructions. Disabled by default.
9189 @item -mpush-args
9190 @opindex mpush-args
9191 Push instructions will be used to pass outgoing arguments when functions
9192 are called. Enabled by default.
9193 @end table
9195 @node Darwin Options
9196 @subsection Darwin Options
9197 @cindex Darwin options
9199 These options are defined for all architectures running the Darwin operating
9200 system.
9202 FSF GCC on Darwin does not create ``fat'' object files; it will create
9203 an object file for the single architecture that it was built to
9204 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
9205 @option{-arch} options are used; it does so by running the compiler or
9206 linker multiple times and joining the results together with
9207 @file{lipo}.
9209 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
9210 @samp{i686}) is determined by the flags that specify the ISA
9211 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
9212 @option{-force_cpusubtype_ALL} option can be used to override this.
9214 The Darwin tools vary in their behavior when presented with an ISA
9215 mismatch.  The assembler, @file{as}, will only permit instructions to
9216 be used that are valid for the subtype of the file it is generating,
9217 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
9218 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
9219 and print an error if asked to create a shared library with a less
9220 restrictive subtype than its input files (for instance, trying to put
9221 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
9222 for executables, @file{ld}, will quietly give the executable the most
9223 restrictive subtype of any of its input files.
9225 @table @gcctabopt
9226 @item -F@var{dir}
9227 @opindex F
9228 Add the framework directory @var{dir} to the head of the list of
9229 directories to be searched for header files.  These directories are
9230 interleaved with those specified by @option{-I} options and are
9231 scanned in a left-to-right order.
9233 A framework directory is a directory with frameworks in it.  A
9234 framework is a directory with a @samp{"Headers"} and/or
9235 @samp{"PrivateHeaders"} directory contained directly in it that ends
9236 in @samp{".framework"}.  The name of a framework is the name of this
9237 directory excluding the @samp{".framework"}.  Headers associated with
9238 the framework are found in one of those two directories, with
9239 @samp{"Headers"} being searched first.  A subframework is a framework
9240 directory that is in a framework's @samp{"Frameworks"} directory.
9241 Includes of subframework headers can only appear in a header of a
9242 framework that contains the subframework, or in a sibling subframework
9243 header.  Two subframeworks are siblings if they occur in the same
9244 framework.  A subframework should not have the same name as a
9245 framework, a warning will be issued if this is violated.  Currently a
9246 subframework cannot have subframeworks, in the future, the mechanism
9247 may be extended to support this.  The standard frameworks can be found
9248 in @samp{"/System/Library/Frameworks"} and
9249 @samp{"/Library/Frameworks"}.  An example include looks like
9250 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
9251 the name of the framework and header.h is found in the
9252 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
9254 @item -iframework@var{dir}
9255 @opindex iframework
9256 Like @option{-F} except the directory is a treated as a system
9257 directory.  The main difference between this @option{-iframework} and
9258 @option{-F} is that with @option{-iframework} the compiler does not
9259 warn about constructs contained within header files found via
9260 @var{dir}.  This option is valid only for the C family of languages.
9262 @item -gused
9263 @opindex gused
9264 Emit debugging information for symbols that are used.  For STABS
9265 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
9266 This is by default ON@.
9268 @item -gfull
9269 @opindex gfull
9270 Emit debugging information for all symbols and types.
9272 @item -mmacosx-version-min=@var{version}
9273 The earliest version of MacOS X that this executable will run on
9274 is @var{version}.  Typical values of @var{version} include @code{10.1},
9275 @code{10.2}, and @code{10.3.9}.
9277 If the compiler was built to use the system's headers by default,
9278 then the default for this option is the system version on which the
9279 compiler is running, otherwise the default is to make choices which
9280 are compatible with as many systems and code bases as possible.
9282 @item -mkernel
9283 @opindex mkernel
9284 Enable kernel development mode.  The @option{-mkernel} option sets
9285 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
9286 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
9287 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
9288 applicable.  This mode also sets @option{-mno-altivec},
9289 @option{-msoft-float}, @option{-fno-builtin} and
9290 @option{-mlong-branch} for PowerPC targets.
9292 @item -mone-byte-bool
9293 @opindex mone-byte-bool
9294 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
9295 By default @samp{sizeof(bool)} is @samp{4} when compiling for
9296 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
9297 option has no effect on x86.
9299 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
9300 to generate code that is not binary compatible with code generated
9301 without that switch.  Using this switch may require recompiling all
9302 other modules in a program, including system libraries.  Use this
9303 switch to conform to a non-default data model.
9305 @item -mfix-and-continue
9306 @itemx -ffix-and-continue
9307 @itemx -findirect-data
9308 @opindex mfix-and-continue
9309 @opindex ffix-and-continue
9310 @opindex findirect-data
9311 Generate code suitable for fast turn around development.  Needed to
9312 enable gdb to dynamically load @code{.o} files into already running
9313 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
9314 are provided for backwards compatibility.
9316 @item -all_load
9317 @opindex all_load
9318 Loads all members of static archive libraries.
9319 See man ld(1) for more information.
9321 @item -arch_errors_fatal
9322 @opindex arch_errors_fatal
9323 Cause the errors having to do with files that have the wrong architecture
9324 to be fatal.
9326 @item -bind_at_load
9327 @opindex bind_at_load
9328 Causes the output file to be marked such that the dynamic linker will
9329 bind all undefined references when the file is loaded or launched.
9331 @item -bundle
9332 @opindex bundle
9333 Produce a Mach-o bundle format file.
9334 See man ld(1) for more information.
9336 @item -bundle_loader @var{executable}
9337 @opindex bundle_loader
9338 This option specifies the @var{executable} that will be loading the build
9339 output file being linked.  See man ld(1) for more information.
9341 @item -dynamiclib
9342 @opindex dynamiclib
9343 When passed this option, GCC will produce a dynamic library instead of
9344 an executable when linking, using the Darwin @file{libtool} command.
9346 @item -force_cpusubtype_ALL
9347 @opindex force_cpusubtype_ALL
9348 This causes GCC's output file to have the @var{ALL} subtype, instead of
9349 one controlled by the @option{-mcpu} or @option{-march} option.
9351 @item -allowable_client  @var{client_name}
9352 @itemx -client_name
9353 @itemx -compatibility_version
9354 @itemx -current_version
9355 @itemx -dead_strip
9356 @itemx -dependency-file
9357 @itemx -dylib_file
9358 @itemx -dylinker_install_name
9359 @itemx -dynamic
9360 @itemx -exported_symbols_list
9361 @itemx -filelist
9362 @itemx -flat_namespace
9363 @itemx -force_flat_namespace
9364 @itemx -headerpad_max_install_names
9365 @itemx -image_base
9366 @itemx -init
9367 @itemx -install_name
9368 @itemx -keep_private_externs
9369 @itemx -multi_module
9370 @itemx -multiply_defined
9371 @itemx -multiply_defined_unused
9372 @itemx -noall_load
9373 @itemx -no_dead_strip_inits_and_terms
9374 @itemx -nofixprebinding
9375 @itemx -nomultidefs
9376 @itemx -noprebind
9377 @itemx -noseglinkedit
9378 @itemx -pagezero_size
9379 @itemx -prebind
9380 @itemx -prebind_all_twolevel_modules
9381 @itemx -private_bundle
9382 @itemx -read_only_relocs
9383 @itemx -sectalign
9384 @itemx -sectobjectsymbols
9385 @itemx -whyload
9386 @itemx -seg1addr
9387 @itemx -sectcreate
9388 @itemx -sectobjectsymbols
9389 @itemx -sectorder
9390 @itemx -segaddr
9391 @itemx -segs_read_only_addr
9392 @itemx -segs_read_write_addr
9393 @itemx -seg_addr_table
9394 @itemx -seg_addr_table_filename
9395 @itemx -seglinkedit
9396 @itemx -segprot
9397 @itemx -segs_read_only_addr
9398 @itemx -segs_read_write_addr
9399 @itemx -single_module
9400 @itemx -static
9401 @itemx -sub_library
9402 @itemx -sub_umbrella
9403 @itemx -twolevel_namespace
9404 @itemx -umbrella
9405 @itemx -undefined
9406 @itemx -unexported_symbols_list
9407 @itemx -weak_reference_mismatches
9408 @itemx -whatsloaded
9409 @opindex allowable_client
9410 @opindex client_name
9411 @opindex compatibility_version
9412 @opindex current_version
9413 @opindex dead_strip
9414 @opindex dependency-file
9415 @opindex dylib_file
9416 @opindex dylinker_install_name
9417 @opindex dynamic
9418 @opindex exported_symbols_list
9419 @opindex filelist
9420 @opindex flat_namespace
9421 @opindex force_flat_namespace
9422 @opindex headerpad_max_install_names
9423 @opindex image_base
9424 @opindex init
9425 @opindex install_name
9426 @opindex keep_private_externs
9427 @opindex multi_module
9428 @opindex multiply_defined
9429 @opindex multiply_defined_unused
9430 @opindex noall_load
9431 @opindex no_dead_strip_inits_and_terms
9432 @opindex nofixprebinding
9433 @opindex nomultidefs
9434 @opindex noprebind
9435 @opindex noseglinkedit
9436 @opindex pagezero_size
9437 @opindex prebind
9438 @opindex prebind_all_twolevel_modules
9439 @opindex private_bundle
9440 @opindex read_only_relocs
9441 @opindex sectalign
9442 @opindex sectobjectsymbols
9443 @opindex whyload
9444 @opindex seg1addr
9445 @opindex sectcreate
9446 @opindex sectobjectsymbols
9447 @opindex sectorder
9448 @opindex segaddr
9449 @opindex segs_read_only_addr
9450 @opindex segs_read_write_addr
9451 @opindex seg_addr_table
9452 @opindex seg_addr_table_filename
9453 @opindex seglinkedit
9454 @opindex segprot
9455 @opindex segs_read_only_addr
9456 @opindex segs_read_write_addr
9457 @opindex single_module
9458 @opindex static
9459 @opindex sub_library
9460 @opindex sub_umbrella
9461 @opindex twolevel_namespace
9462 @opindex umbrella
9463 @opindex undefined
9464 @opindex unexported_symbols_list
9465 @opindex weak_reference_mismatches
9466 @opindex whatsloaded
9467 These options are passed to the Darwin linker.  The Darwin linker man page
9468 describes them in detail.
9469 @end table
9471 @node DEC Alpha Options
9472 @subsection DEC Alpha Options
9474 These @samp{-m} options are defined for the DEC Alpha implementations:
9476 @table @gcctabopt
9477 @item -mno-soft-float
9478 @itemx -msoft-float
9479 @opindex mno-soft-float
9480 @opindex msoft-float
9481 Use (do not use) the hardware floating-point instructions for
9482 floating-point operations.  When @option{-msoft-float} is specified,
9483 functions in @file{libgcc.a} will be used to perform floating-point
9484 operations.  Unless they are replaced by routines that emulate the
9485 floating-point operations, or compiled in such a way as to call such
9486 emulations routines, these routines will issue floating-point
9487 operations.   If you are compiling for an Alpha without floating-point
9488 operations, you must ensure that the library is built so as not to call
9489 them.
9491 Note that Alpha implementations without floating-point operations are
9492 required to have floating-point registers.
9494 @item -mfp-reg
9495 @itemx -mno-fp-regs
9496 @opindex mfp-reg
9497 @opindex mno-fp-regs
9498 Generate code that uses (does not use) the floating-point register set.
9499 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9500 register set is not used, floating point operands are passed in integer
9501 registers as if they were integers and floating-point results are passed
9502 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9503 so any function with a floating-point argument or return value called by code
9504 compiled with @option{-mno-fp-regs} must also be compiled with that
9505 option.
9507 A typical use of this option is building a kernel that does not use,
9508 and hence need not save and restore, any floating-point registers.
9510 @item -mieee
9511 @opindex mieee
9512 The Alpha architecture implements floating-point hardware optimized for
9513 maximum performance.  It is mostly compliant with the IEEE floating
9514 point standard.  However, for full compliance, software assistance is
9515 required.  This option generates code fully IEEE compliant code
9516 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9517 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9518 defined during compilation.  The resulting code is less efficient but is
9519 able to correctly support denormalized numbers and exceptional IEEE
9520 values such as not-a-number and plus/minus infinity.  Other Alpha
9521 compilers call this option @option{-ieee_with_no_inexact}.
9523 @item -mieee-with-inexact
9524 @opindex mieee-with-inexact
9525 This is like @option{-mieee} except the generated code also maintains
9526 the IEEE @var{inexact-flag}.  Turning on this option causes the
9527 generated code to implement fully-compliant IEEE math.  In addition to
9528 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9529 macro.  On some Alpha implementations the resulting code may execute
9530 significantly slower than the code generated by default.  Since there is
9531 very little code that depends on the @var{inexact-flag}, you should
9532 normally not specify this option.  Other Alpha compilers call this
9533 option @option{-ieee_with_inexact}.
9535 @item -mfp-trap-mode=@var{trap-mode}
9536 @opindex mfp-trap-mode
9537 This option controls what floating-point related traps are enabled.
9538 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9539 The trap mode can be set to one of four values:
9541 @table @samp
9542 @item n
9543 This is the default (normal) setting.  The only traps that are enabled
9544 are the ones that cannot be disabled in software (e.g., division by zero
9545 trap).
9547 @item u
9548 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9549 as well.
9551 @item su
9552 Like @samp{u}, but the instructions are marked to be safe for software
9553 completion (see Alpha architecture manual for details).
9555 @item sui
9556 Like @samp{su}, but inexact traps are enabled as well.
9557 @end table
9559 @item -mfp-rounding-mode=@var{rounding-mode}
9560 @opindex mfp-rounding-mode
9561 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9562 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9565 @table @samp
9566 @item n
9567 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9568 the nearest machine number or towards the even machine number in case
9569 of a tie.
9571 @item m
9572 Round towards minus infinity.
9574 @item c
9575 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9577 @item d
9578 Dynamic rounding mode.  A field in the floating point control register
9579 (@var{fpcr}, see Alpha architecture reference manual) controls the
9580 rounding mode in effect.  The C library initializes this register for
9581 rounding towards plus infinity.  Thus, unless your program modifies the
9582 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9583 @end table
9585 @item -mtrap-precision=@var{trap-precision}
9586 @opindex mtrap-precision
9587 In the Alpha architecture, floating point traps are imprecise.  This
9588 means without software assistance it is impossible to recover from a
9589 floating trap and program execution normally needs to be terminated.
9590 GCC can generate code that can assist operating system trap handlers
9591 in determining the exact location that caused a floating point trap.
9592 Depending on the requirements of an application, different levels of
9593 precisions can be selected:
9595 @table @samp
9596 @item p
9597 Program precision.  This option is the default and means a trap handler
9598 can only identify which program caused a floating point exception.
9600 @item f
9601 Function precision.  The trap handler can determine the function that
9602 caused a floating point exception.
9604 @item i
9605 Instruction precision.  The trap handler can determine the exact
9606 instruction that caused a floating point exception.
9607 @end table
9609 Other Alpha compilers provide the equivalent options called
9610 @option{-scope_safe} and @option{-resumption_safe}.
9612 @item -mieee-conformant
9613 @opindex mieee-conformant
9614 This option marks the generated code as IEEE conformant.  You must not
9615 use this option unless you also specify @option{-mtrap-precision=i} and either
9616 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9617 is to emit the line @samp{.eflag 48} in the function prologue of the
9618 generated assembly file.  Under DEC Unix, this has the effect that
9619 IEEE-conformant math library routines will be linked in.
9621 @item -mbuild-constants
9622 @opindex mbuild-constants
9623 Normally GCC examines a 32- or 64-bit integer constant to
9624 see if it can construct it from smaller constants in two or three
9625 instructions.  If it cannot, it will output the constant as a literal and
9626 generate code to load it from the data segment at runtime.
9628 Use this option to require GCC to construct @emph{all} integer constants
9629 using code, even if it takes more instructions (the maximum is six).
9631 You would typically use this option to build a shared library dynamic
9632 loader.  Itself a shared library, it must relocate itself in memory
9633 before it can find the variables and constants in its own data segment.
9635 @item -malpha-as
9636 @itemx -mgas
9637 @opindex malpha-as
9638 @opindex mgas
9639 Select whether to generate code to be assembled by the vendor-supplied
9640 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9642 @item -mbwx
9643 @itemx -mno-bwx
9644 @itemx -mcix
9645 @itemx -mno-cix
9646 @itemx -mfix
9647 @itemx -mno-fix
9648 @itemx -mmax
9649 @itemx -mno-max
9650 @opindex mbwx
9651 @opindex mno-bwx
9652 @opindex mcix
9653 @opindex mno-cix
9654 @opindex mfix
9655 @opindex mno-fix
9656 @opindex mmax
9657 @opindex mno-max
9658 Indicate whether GCC should generate code to use the optional BWX,
9659 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9660 sets supported by the CPU type specified via @option{-mcpu=} option or that
9661 of the CPU on which GCC was built if none was specified.
9663 @item -mfloat-vax
9664 @itemx -mfloat-ieee
9665 @opindex mfloat-vax
9666 @opindex mfloat-ieee
9667 Generate code that uses (does not use) VAX F and G floating point
9668 arithmetic instead of IEEE single and double precision.
9670 @item -mexplicit-relocs
9671 @itemx -mno-explicit-relocs
9672 @opindex mexplicit-relocs
9673 @opindex mno-explicit-relocs
9674 Older Alpha assemblers provided no way to generate symbol relocations
9675 except via assembler macros.  Use of these macros does not allow
9676 optimal instruction scheduling.  GNU binutils as of version 2.12
9677 supports a new syntax that allows the compiler to explicitly mark
9678 which relocations should apply to which instructions.  This option
9679 is mostly useful for debugging, as GCC detects the capabilities of
9680 the assembler when it is built and sets the default accordingly.
9682 @item -msmall-data
9683 @itemx -mlarge-data
9684 @opindex msmall-data
9685 @opindex mlarge-data
9686 When @option{-mexplicit-relocs} is in effect, static data is
9687 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9688 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9689 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9690 16-bit relocations off of the @code{$gp} register.  This limits the
9691 size of the small data area to 64KB, but allows the variables to be
9692 directly accessed via a single instruction.
9694 The default is @option{-mlarge-data}.  With this option the data area
9695 is limited to just below 2GB@.  Programs that require more than 2GB of
9696 data must use @code{malloc} or @code{mmap} to allocate the data in the
9697 heap instead of in the program's data segment.
9699 When generating code for shared libraries, @option{-fpic} implies
9700 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9702 @item -msmall-text
9703 @itemx -mlarge-text
9704 @opindex msmall-text
9705 @opindex mlarge-text
9706 When @option{-msmall-text} is used, the compiler assumes that the
9707 code of the entire program (or shared library) fits in 4MB, and is
9708 thus reachable with a branch instruction.  When @option{-msmall-data}
9709 is used, the compiler can assume that all local symbols share the
9710 same @code{$gp} value, and thus reduce the number of instructions
9711 required for a function call from 4 to 1.
9713 The default is @option{-mlarge-text}.
9715 @item -mcpu=@var{cpu_type}
9716 @opindex mcpu
9717 Set the instruction set and instruction scheduling parameters for
9718 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9719 style name or the corresponding chip number.  GCC supports scheduling
9720 parameters for the EV4, EV5 and EV6 family of processors and will
9721 choose the default values for the instruction set from the processor
9722 you specify.  If you do not specify a processor type, GCC will default
9723 to the processor on which the compiler was built.
9725 Supported values for @var{cpu_type} are
9727 @table @samp
9728 @item ev4
9729 @itemx ev45
9730 @itemx 21064
9731 Schedules as an EV4 and has no instruction set extensions.
9733 @item ev5
9734 @itemx 21164
9735 Schedules as an EV5 and has no instruction set extensions.
9737 @item ev56
9738 @itemx 21164a
9739 Schedules as an EV5 and supports the BWX extension.
9741 @item pca56
9742 @itemx 21164pc
9743 @itemx 21164PC
9744 Schedules as an EV5 and supports the BWX and MAX extensions.
9746 @item ev6
9747 @itemx 21264
9748 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9750 @item ev67
9751 @itemx 21264a
9752 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9753 @end table
9755 @item -mtune=@var{cpu_type}
9756 @opindex mtune
9757 Set only the instruction scheduling parameters for machine type
9758 @var{cpu_type}.  The instruction set is not changed.
9760 @item -mmemory-latency=@var{time}
9761 @opindex mmemory-latency
9762 Sets the latency the scheduler should assume for typical memory
9763 references as seen by the application.  This number is highly
9764 dependent on the memory access patterns used by the application
9765 and the size of the external cache on the machine.
9767 Valid options for @var{time} are
9769 @table @samp
9770 @item @var{number}
9771 A decimal number representing clock cycles.
9773 @item L1
9774 @itemx L2
9775 @itemx L3
9776 @itemx main
9777 The compiler contains estimates of the number of clock cycles for
9778 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9779 (also called Dcache, Scache, and Bcache), as well as to main memory.
9780 Note that L3 is only valid for EV5.
9782 @end table
9783 @end table
9785 @node DEC Alpha/VMS Options
9786 @subsection DEC Alpha/VMS Options
9788 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9790 @table @gcctabopt
9791 @item -mvms-return-codes
9792 @opindex mvms-return-codes
9793 Return VMS condition codes from main.  The default is to return POSIX
9794 style condition (e.g.@: error) codes.
9795 @end table
9797 @node FRV Options
9798 @subsection FRV Options
9799 @cindex FRV Options
9801 @table @gcctabopt
9802 @item -mgpr-32
9803 @opindex mgpr-32
9805 Only use the first 32 general purpose registers.
9807 @item -mgpr-64
9808 @opindex mgpr-64
9810 Use all 64 general purpose registers.
9812 @item -mfpr-32
9813 @opindex mfpr-32
9815 Use only the first 32 floating point registers.
9817 @item -mfpr-64
9818 @opindex mfpr-64
9820 Use all 64 floating point registers
9822 @item -mhard-float
9823 @opindex mhard-float
9825 Use hardware instructions for floating point operations.
9827 @item -msoft-float
9828 @opindex msoft-float
9830 Use library routines for floating point operations.
9832 @item -malloc-cc
9833 @opindex malloc-cc
9835 Dynamically allocate condition code registers.
9837 @item -mfixed-cc
9838 @opindex mfixed-cc
9840 Do not try to dynamically allocate condition code registers, only
9841 use @code{icc0} and @code{fcc0}.
9843 @item -mdword
9844 @opindex mdword
9846 Change ABI to use double word insns.
9848 @item -mno-dword
9849 @opindex mno-dword
9851 Do not use double word instructions.
9853 @item -mdouble
9854 @opindex mdouble
9856 Use floating point double instructions.
9858 @item -mno-double
9859 @opindex mno-double
9861 Do not use floating point double instructions.
9863 @item -mmedia
9864 @opindex mmedia
9866 Use media instructions.
9868 @item -mno-media
9869 @opindex mno-media
9871 Do not use media instructions.
9873 @item -mmuladd
9874 @opindex mmuladd
9876 Use multiply and add/subtract instructions.
9878 @item -mno-muladd
9879 @opindex mno-muladd
9881 Do not use multiply and add/subtract instructions.
9883 @item -mfdpic
9884 @opindex mfdpic
9886 Select the FDPIC ABI, that uses function descriptors to represent
9887 pointers to functions.  Without any PIC/PIE-related options, it
9888 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9889 assumes GOT entries and small data are within a 12-bit range from the
9890 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9891 are computed with 32 bits.
9892 With a @samp{bfin-elf} target, this option implies @option{-msim}.
9894 @item -minline-plt
9895 @opindex minline-plt
9897 Enable inlining of PLT entries in function calls to functions that are
9898 not known to bind locally.  It has no effect without @option{-mfdpic}.
9899 It's enabled by default if optimizing for speed and compiling for
9900 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9901 optimization option such as @option{-O3} or above is present in the
9902 command line.
9904 @item -mTLS
9905 @opindex TLS
9907 Assume a large TLS segment when generating thread-local code.
9909 @item -mtls
9910 @opindex tls
9912 Do not assume a large TLS segment when generating thread-local code.
9914 @item -mgprel-ro
9915 @opindex mgprel-ro
9917 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9918 that is known to be in read-only sections.  It's enabled by default,
9919 except for @option{-fpic} or @option{-fpie}: even though it may help
9920 make the global offset table smaller, it trades 1 instruction for 4.
9921 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9922 one of which may be shared by multiple symbols, and it avoids the need
9923 for a GOT entry for the referenced symbol, so it's more likely to be a
9924 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9926 @item -multilib-library-pic
9927 @opindex multilib-library-pic
9929 Link with the (library, not FD) pic libraries.  It's implied by
9930 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9931 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9932 it explicitly.
9934 @item -mlinked-fp
9935 @opindex mlinked-fp
9937 Follow the EABI requirement of always creating a frame pointer whenever
9938 a stack frame is allocated.  This option is enabled by default and can
9939 be disabled with @option{-mno-linked-fp}.
9941 @item -mlong-calls
9942 @opindex mlong-calls
9944 Use indirect addressing to call functions outside the current
9945 compilation unit.  This allows the functions to be placed anywhere
9946 within the 32-bit address space.
9948 @item -malign-labels
9949 @opindex malign-labels
9951 Try to align labels to an 8-byte boundary by inserting nops into the
9952 previous packet.  This option only has an effect when VLIW packing
9953 is enabled.  It doesn't create new packets; it merely adds nops to
9954 existing ones.
9956 @item -mlibrary-pic
9957 @opindex mlibrary-pic
9959 Generate position-independent EABI code.
9961 @item -macc-4
9962 @opindex macc-4
9964 Use only the first four media accumulator registers.
9966 @item -macc-8
9967 @opindex macc-8
9969 Use all eight media accumulator registers.
9971 @item -mpack
9972 @opindex mpack
9974 Pack VLIW instructions.
9976 @item -mno-pack
9977 @opindex mno-pack
9979 Do not pack VLIW instructions.
9981 @item -mno-eflags
9982 @opindex mno-eflags
9984 Do not mark ABI switches in e_flags.
9986 @item -mcond-move
9987 @opindex mcond-move
9989 Enable the use of conditional-move instructions (default).
9991 This switch is mainly for debugging the compiler and will likely be removed
9992 in a future version.
9994 @item -mno-cond-move
9995 @opindex mno-cond-move
9997 Disable the use of conditional-move instructions.
9999 This switch is mainly for debugging the compiler and will likely be removed
10000 in a future version.
10002 @item -mscc
10003 @opindex mscc
10005 Enable the use of conditional set instructions (default).
10007 This switch is mainly for debugging the compiler and will likely be removed
10008 in a future version.
10010 @item -mno-scc
10011 @opindex mno-scc
10013 Disable the use of conditional set instructions.
10015 This switch is mainly for debugging the compiler and will likely be removed
10016 in a future version.
10018 @item -mcond-exec
10019 @opindex mcond-exec
10021 Enable the use of conditional execution (default).
10023 This switch is mainly for debugging the compiler and will likely be removed
10024 in a future version.
10026 @item -mno-cond-exec
10027 @opindex mno-cond-exec
10029 Disable the use of conditional execution.
10031 This switch is mainly for debugging the compiler and will likely be removed
10032 in a future version.
10034 @item -mvliw-branch
10035 @opindex mvliw-branch
10037 Run a pass to pack branches into VLIW instructions (default).
10039 This switch is mainly for debugging the compiler and will likely be removed
10040 in a future version.
10042 @item -mno-vliw-branch
10043 @opindex mno-vliw-branch
10045 Do not run a pass to pack branches into VLIW instructions.
10047 This switch is mainly for debugging the compiler and will likely be removed
10048 in a future version.
10050 @item -mmulti-cond-exec
10051 @opindex mmulti-cond-exec
10053 Enable optimization of @code{&&} and @code{||} in conditional execution
10054 (default).
10056 This switch is mainly for debugging the compiler and will likely be removed
10057 in a future version.
10059 @item -mno-multi-cond-exec
10060 @opindex mno-multi-cond-exec
10062 Disable optimization of @code{&&} and @code{||} in conditional execution.
10064 This switch is mainly for debugging the compiler and will likely be removed
10065 in a future version.
10067 @item -mnested-cond-exec
10068 @opindex mnested-cond-exec
10070 Enable nested conditional execution optimizations (default).
10072 This switch is mainly for debugging the compiler and will likely be removed
10073 in a future version.
10075 @item -mno-nested-cond-exec
10076 @opindex mno-nested-cond-exec
10078 Disable nested conditional execution optimizations.
10080 This switch is mainly for debugging the compiler and will likely be removed
10081 in a future version.
10083 @item -moptimize-membar
10084 @opindex moptimize-membar
10086 This switch removes redundant @code{membar} instructions from the
10087 compiler generated code.  It is enabled by default.
10089 @item -mno-optimize-membar
10090 @opindex mno-optimize-membar
10092 This switch disables the automatic removal of redundant @code{membar}
10093 instructions from the generated code.
10095 @item -mtomcat-stats
10096 @opindex mtomcat-stats
10098 Cause gas to print out tomcat statistics.
10100 @item -mcpu=@var{cpu}
10101 @opindex mcpu
10103 Select the processor type for which to generate code.  Possible values are
10104 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
10105 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
10107 @end table
10109 @node GNU/Linux Options
10110 @subsection GNU/Linux Options
10112 These @samp{-m} options are defined for GNU/Linux targets:
10114 @table @gcctabopt
10115 @item -mglibc
10116 @opindex mglibc
10117 Use the GNU C library instead of uClibc.  This is the default except
10118 on @samp{*-*-linux-*uclibc*} targets.
10120 @item -muclibc
10121 @opindex muclibc
10122 Use uClibc instead of the GNU C library.  This is the default on
10123 @samp{*-*-linux-*uclibc*} targets.
10124 @end table
10126 @node H8/300 Options
10127 @subsection H8/300 Options
10129 These @samp{-m} options are defined for the H8/300 implementations:
10131 @table @gcctabopt
10132 @item -mrelax
10133 @opindex mrelax
10134 Shorten some address references at link time, when possible; uses the
10135 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
10136 ld, Using ld}, for a fuller description.
10138 @item -mh
10139 @opindex mh
10140 Generate code for the H8/300H@.
10142 @item -ms
10143 @opindex ms
10144 Generate code for the H8S@.
10146 @item -mn
10147 @opindex mn
10148 Generate code for the H8S and H8/300H in the normal mode.  This switch
10149 must be used either with @option{-mh} or @option{-ms}.
10151 @item -ms2600
10152 @opindex ms2600
10153 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
10155 @item -mint32
10156 @opindex mint32
10157 Make @code{int} data 32 bits by default.
10159 @item -malign-300
10160 @opindex malign-300
10161 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
10162 The default for the H8/300H and H8S is to align longs and floats on 4
10163 byte boundaries.
10164 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
10165 This option has no effect on the H8/300.
10166 @end table
10168 @node HPPA Options
10169 @subsection HPPA Options
10170 @cindex HPPA Options
10172 These @samp{-m} options are defined for the HPPA family of computers:
10174 @table @gcctabopt
10175 @item -march=@var{architecture-type}
10176 @opindex march
10177 Generate code for the specified architecture.  The choices for
10178 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
10179 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
10180 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
10181 architecture option for your machine.  Code compiled for lower numbered
10182 architectures will run on higher numbered architectures, but not the
10183 other way around.
10185 @item -mpa-risc-1-0
10186 @itemx -mpa-risc-1-1
10187 @itemx -mpa-risc-2-0
10188 @opindex mpa-risc-1-0
10189 @opindex mpa-risc-1-1
10190 @opindex mpa-risc-2-0
10191 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
10193 @item -mbig-switch
10194 @opindex mbig-switch
10195 Generate code suitable for big switch tables.  Use this option only if
10196 the assembler/linker complain about out of range branches within a switch
10197 table.
10199 @item -mjump-in-delay
10200 @opindex mjump-in-delay
10201 Fill delay slots of function calls with unconditional jump instructions
10202 by modifying the return pointer for the function call to be the target
10203 of the conditional jump.
10205 @item -mdisable-fpregs
10206 @opindex mdisable-fpregs
10207 Prevent floating point registers from being used in any manner.  This is
10208 necessary for compiling kernels which perform lazy context switching of
10209 floating point registers.  If you use this option and attempt to perform
10210 floating point operations, the compiler will abort.
10212 @item -mdisable-indexing
10213 @opindex mdisable-indexing
10214 Prevent the compiler from using indexing address modes.  This avoids some
10215 rather obscure problems when compiling MIG generated code under MACH@.
10217 @item -mno-space-regs
10218 @opindex mno-space-regs
10219 Generate code that assumes the target has no space registers.  This allows
10220 GCC to generate faster indirect calls and use unscaled index address modes.
10222 Such code is suitable for level 0 PA systems and kernels.
10224 @item -mfast-indirect-calls
10225 @opindex mfast-indirect-calls
10226 Generate code that assumes calls never cross space boundaries.  This
10227 allows GCC to emit code which performs faster indirect calls.
10229 This option will not work in the presence of shared libraries or nested
10230 functions.
10232 @item -mfixed-range=@var{register-range}
10233 @opindex mfixed-range
10234 Generate code treating the given register range as fixed registers.
10235 A fixed register is one that the register allocator can not use.  This is
10236 useful when compiling kernel code.  A register range is specified as
10237 two registers separated by a dash.  Multiple register ranges can be
10238 specified separated by a comma.
10240 @item -mlong-load-store
10241 @opindex mlong-load-store
10242 Generate 3-instruction load and store sequences as sometimes required by
10243 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
10244 the HP compilers.
10246 @item -mportable-runtime
10247 @opindex mportable-runtime
10248 Use the portable calling conventions proposed by HP for ELF systems.
10250 @item -mgas
10251 @opindex mgas
10252 Enable the use of assembler directives only GAS understands.
10254 @item -mschedule=@var{cpu-type}
10255 @opindex mschedule
10256 Schedule code according to the constraints for the machine type
10257 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
10258 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
10259 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
10260 proper scheduling option for your machine.  The default scheduling is
10261 @samp{8000}.
10263 @item -mlinker-opt
10264 @opindex mlinker-opt
10265 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
10266 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
10267 linkers in which they give bogus error messages when linking some programs.
10269 @item -msoft-float
10270 @opindex msoft-float
10271 Generate output containing library calls for floating point.
10272 @strong{Warning:} the requisite libraries are not available for all HPPA
10273 targets.  Normally the facilities of the machine's usual C compiler are
10274 used, but this cannot be done directly in cross-compilation.  You must make
10275 your own arrangements to provide suitable library functions for
10276 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
10277 does provide software floating point support.
10279 @option{-msoft-float} changes the calling convention in the output file;
10280 therefore, it is only useful if you compile @emph{all} of a program with
10281 this option.  In particular, you need to compile @file{libgcc.a}, the
10282 library that comes with GCC, with @option{-msoft-float} in order for
10283 this to work.
10285 @item -msio
10286 @opindex msio
10287 Generate the predefine, @code{_SIO}, for server IO@.  The default is
10288 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
10289 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
10290 options are available under HP-UX and HI-UX@.
10292 @item -mgnu-ld
10293 @opindex gnu-ld
10294 Use GNU ld specific options.  This passes @option{-shared} to ld when
10295 building a shared library.  It is the default when GCC is configured,
10296 explicitly or implicitly, with the GNU linker.  This option does not
10297 have any affect on which ld is called, it only changes what parameters
10298 are passed to that ld.  The ld that is called is determined by the
10299 @option{--with-ld} configure option, GCC's program search path, and
10300 finally by the user's @env{PATH}.  The linker used by GCC can be printed
10301 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
10302 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10304 @item -mhp-ld
10305 @opindex hp-ld
10306 Use HP ld specific options.  This passes @option{-b} to ld when building
10307 a shared library and passes @option{+Accept TypeMismatch} to ld on all
10308 links.  It is the default when GCC is configured, explicitly or
10309 implicitly, with the HP linker.  This option does not have any affect on
10310 which ld is called, it only changes what parameters are passed to that
10311 ld.  The ld that is called is determined by the @option{--with-ld}
10312 configure option, GCC's program search path, and finally by the user's
10313 @env{PATH}.  The linker used by GCC can be printed using @samp{which
10314 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
10315 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
10317 @item -mlong-calls
10318 @opindex mno-long-calls
10319 Generate code that uses long call sequences.  This ensures that a call
10320 is always able to reach linker generated stubs.  The default is to generate
10321 long calls only when the distance from the call site to the beginning
10322 of the function or translation unit, as the case may be, exceeds a
10323 predefined limit set by the branch type being used.  The limits for
10324 normal calls are 7,600,000 and 240,000 bytes, respectively for the
10325 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
10326 240,000 bytes.
10328 Distances are measured from the beginning of functions when using the
10329 @option{-ffunction-sections} option, or when using the @option{-mgas}
10330 and @option{-mno-portable-runtime} options together under HP-UX with
10331 the SOM linker.
10333 It is normally not desirable to use this option as it will degrade
10334 performance.  However, it may be useful in large applications,
10335 particularly when partial linking is used to build the application.
10337 The types of long calls used depends on the capabilities of the
10338 assembler and linker, and the type of code being generated.  The
10339 impact on systems that support long absolute calls, and long pic
10340 symbol-difference or pc-relative calls should be relatively small.
10341 However, an indirect call is used on 32-bit ELF systems in pic code
10342 and it is quite long.
10344 @item -munix=@var{unix-std}
10345 @opindex march
10346 Generate compiler predefines and select a startfile for the specified
10347 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10348 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10349 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10350 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10351 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10352 and later.
10354 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10355 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10356 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10357 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10358 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10359 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10361 It is @emph{important} to note that this option changes the interfaces
10362 for various library routines.  It also affects the operational behavior
10363 of the C library.  Thus, @emph{extreme} care is needed in using this
10364 option.
10366 Library code that is intended to operate with more than one UNIX
10367 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10368 as appropriate.  Most GNU software doesn't provide this capability.
10370 @item -nolibdld
10371 @opindex nolibdld
10372 Suppress the generation of link options to search libdld.sl when the
10373 @option{-static} option is specified on HP-UX 10 and later.
10375 @item -static
10376 @opindex static
10377 The HP-UX implementation of setlocale in libc has a dependency on
10378 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10379 when the @option{-static} option is specified, special link options
10380 are needed to resolve this dependency.
10382 On HP-UX 10 and later, the GCC driver adds the necessary options to
10383 link with libdld.sl when the @option{-static} option is specified.
10384 This causes the resulting binary to be dynamic.  On the 64-bit port,
10385 the linkers generate dynamic binaries by default in any case.  The
10386 @option{-nolibdld} option can be used to prevent the GCC driver from
10387 adding these link options.
10389 @item -threads
10390 @opindex threads
10391 Add support for multithreading with the @dfn{dce thread} library
10392 under HP-UX@.  This option sets flags for both the preprocessor and
10393 linker.
10394 @end table
10396 @node i386 and x86-64 Options
10397 @subsection Intel 386 and AMD x86-64 Options
10398 @cindex i386 Options
10399 @cindex x86-64 Options
10400 @cindex Intel 386 Options
10401 @cindex AMD x86-64 Options
10403 These @samp{-m} options are defined for the i386 and x86-64 family of
10404 computers:
10406 @table @gcctabopt
10407 @item -mtune=@var{cpu-type}
10408 @opindex mtune
10409 Tune to @var{cpu-type} everything applicable about the generated code, except
10410 for the ABI and the set of available instructions.  The choices for
10411 @var{cpu-type} are:
10412 @table @emph
10413 @item generic
10414 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10415 If you know the CPU on which your code will run, then you should use
10416 the corresponding @option{-mtune} option instead of
10417 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10418 of your application will have, then you should use this option.
10420 As new processors are deployed in the marketplace, the behavior of this
10421 option will change.  Therefore, if you upgrade to a newer version of
10422 GCC, the code generated option will change to reflect the processors
10423 that were most common when that version of GCC was released.
10425 There is no @option{-march=generic} option because @option{-march}
10426 indicates the instruction set the compiler can use, and there is no
10427 generic instruction set applicable to all processors.  In contrast,
10428 @option{-mtune} indicates the processor (or, in this case, collection of
10429 processors) for which the code is optimized.
10430 @item native
10431 This selects the CPU to tune for at compilation time by determining
10432 the processor type of the compiling machine.  Using @option{-mtune=native}
10433 will produce code optimized for the local machine under the constraints
10434 of the selected instruction set.  Using @option{-march=native} will
10435 enable all instruction subsets supported by the local machine (hence
10436 the result might not run on different machines).
10437 @item i386
10438 Original Intel's i386 CPU@.
10439 @item i486
10440 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10441 @item i586, pentium
10442 Intel Pentium CPU with no MMX support.
10443 @item pentium-mmx
10444 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10445 @item pentiumpro
10446 Intel PentiumPro CPU@.
10447 @item i686
10448 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10449 instruction set will be used, so the code will run on all i686 family chips.
10450 @item pentium2
10451 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10452 @item pentium3, pentium3m
10453 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10454 support.
10455 @item pentium-m
10456 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10457 support.  Used by Centrino notebooks.
10458 @item pentium4, pentium4m
10459 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10460 @item prescott
10461 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10462 set support.
10463 @item nocona
10464 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10465 SSE2 and SSE3 instruction set support.
10466 @item core2
10467 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10468 instruction set support.
10469 @item k6
10470 AMD K6 CPU with MMX instruction set support.
10471 @item k6-2, k6-3
10472 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
10473 @item athlon, athlon-tbird
10474 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
10475 support.
10476 @item athlon-4, athlon-xp, athlon-mp
10477 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
10478 instruction set support.
10479 @item k8, opteron, athlon64, athlon-fx
10480 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10481 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
10482 @item k8-sse3, opteron-sse3, athlon64-sse3
10483 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10484 @item amdfam10, barcelona
10485 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10486 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10487 instruction set extensions.)
10488 @item winchip-c6
10489 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10490 set support.
10491 @item winchip2
10492 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
10493 instruction set support.
10494 @item c3
10495 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
10496 implemented for this chip.)
10497 @item c3-2
10498 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10499 implemented for this chip.)
10500 @item geode
10501 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10502 @end table
10504 While picking a specific @var{cpu-type} will schedule things appropriately
10505 for that particular chip, the compiler will not generate any code that
10506 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10507 being used.
10509 @item -march=@var{cpu-type}
10510 @opindex march
10511 Generate instructions for the machine type @var{cpu-type}.  The choices
10512 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10513 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10515 @item -mcpu=@var{cpu-type}
10516 @opindex mcpu
10517 A deprecated synonym for @option{-mtune}.
10519 @item -mfpmath=@var{unit}
10520 @opindex march
10521 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10522 for @var{unit} are:
10524 @table @samp
10525 @item 387
10526 Use the standard 387 floating point coprocessor present majority of chips and
10527 emulated otherwise.  Code compiled with this option will run almost everywhere.
10528 The temporary results are computed in 80bit precision instead of precision
10529 specified by the type resulting in slightly different results compared to most
10530 of other chips.  See @option{-ffloat-store} for more detailed description.
10532 This is the default choice for i386 compiler.
10534 @item sse
10535 Use scalar floating point instructions present in the SSE instruction set.
10536 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10537 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10538 instruction set supports only single precision arithmetics, thus the double and
10539 extended precision arithmetics is still done using 387.  Later version, present
10540 only in Pentium4 and the future AMD x86-64 chips supports double precision
10541 arithmetics too.
10543 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10544 or @option{-msse2} switches to enable SSE extensions and make this option
10545 effective.  For the x86-64 compiler, these extensions are enabled by default.
10547 The resulting code should be considerably faster in the majority of cases and avoid
10548 the numerical instability problems of 387 code, but may break some existing
10549 code that expects temporaries to be 80bit.
10551 This is the default choice for the x86-64 compiler.
10553 @item sse,387
10554 Attempt to utilize both instruction sets at once.  This effectively double the
10555 amount of available registers and on chips with separate execution units for
10556 387 and SSE the execution resources too.  Use this option with care, as it is
10557 still experimental, because the GCC register allocator does not model separate
10558 functional units well resulting in instable performance.
10559 @end table
10561 @item -masm=@var{dialect}
10562 @opindex masm=@var{dialect}
10563 Output asm instructions using selected @var{dialect}.  Supported
10564 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10565 not support @samp{intel}.
10567 @item -mieee-fp
10568 @itemx -mno-ieee-fp
10569 @opindex mieee-fp
10570 @opindex mno-ieee-fp
10571 Control whether or not the compiler uses IEEE floating point
10572 comparisons.  These handle correctly the case where the result of a
10573 comparison is unordered.
10575 @item -msoft-float
10576 @opindex msoft-float
10577 Generate output containing library calls for floating point.
10578 @strong{Warning:} the requisite libraries are not part of GCC@.
10579 Normally the facilities of the machine's usual C compiler are used, but
10580 this can't be done directly in cross-compilation.  You must make your
10581 own arrangements to provide suitable library functions for
10582 cross-compilation.
10584 On machines where a function returns floating point results in the 80387
10585 register stack, some floating point opcodes may be emitted even if
10586 @option{-msoft-float} is used.
10588 @item -mno-fp-ret-in-387
10589 @opindex mno-fp-ret-in-387
10590 Do not use the FPU registers for return values of functions.
10592 The usual calling convention has functions return values of types
10593 @code{float} and @code{double} in an FPU register, even if there
10594 is no FPU@.  The idea is that the operating system should emulate
10595 an FPU@.
10597 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10598 in ordinary CPU registers instead.
10600 @item -mno-fancy-math-387
10601 @opindex mno-fancy-math-387
10602 Some 387 emulators do not support the @code{sin}, @code{cos} and
10603 @code{sqrt} instructions for the 387.  Specify this option to avoid
10604 generating those instructions.  This option is the default on FreeBSD,
10605 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10606 indicates that the target cpu will always have an FPU and so the
10607 instruction will not need emulation.  As of revision 2.6.1, these
10608 instructions are not generated unless you also use the
10609 @option{-funsafe-math-optimizations} switch.
10611 @item -malign-double
10612 @itemx -mno-align-double
10613 @opindex malign-double
10614 @opindex mno-align-double
10615 Control whether GCC aligns @code{double}, @code{long double}, and
10616 @code{long long} variables on a two word boundary or a one word
10617 boundary.  Aligning @code{double} variables on a two word boundary will
10618 produce code that runs somewhat faster on a @samp{Pentium} at the
10619 expense of more memory.
10621 On x86-64, @option{-malign-double} is enabled by default.
10623 @strong{Warning:} if you use the @option{-malign-double} switch,
10624 structures containing the above types will be aligned differently than
10625 the published application binary interface specifications for the 386
10626 and will not be binary compatible with structures in code compiled
10627 without that switch.
10629 @item -m96bit-long-double
10630 @itemx -m128bit-long-double
10631 @opindex m96bit-long-double
10632 @opindex m128bit-long-double
10633 These switches control the size of @code{long double} type.  The i386
10634 application binary interface specifies the size to be 96 bits,
10635 so @option{-m96bit-long-double} is the default in 32 bit mode.
10637 Modern architectures (Pentium and newer) would prefer @code{long double}
10638 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10639 conforming to the ABI, this would not be possible.  So specifying a
10640 @option{-m128bit-long-double} will align @code{long double}
10641 to a 16 byte boundary by padding the @code{long double} with an additional
10642 32 bit zero.
10644 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10645 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10647 Notice that neither of these options enable any extra precision over the x87
10648 standard of 80 bits for a @code{long double}.
10650 @strong{Warning:} if you override the default value for your target ABI, the
10651 structures and arrays containing @code{long double} variables will change
10652 their size as well as function calling convention for function taking
10653 @code{long double} will be modified.  Hence they will not be binary
10654 compatible with arrays or structures in code compiled without that switch.
10656 @item -mmlarge-data-threshold=@var{number}
10657 @opindex mlarge-data-threshold=@var{number}
10658 When @option{-mcmodel=medium} is specified, the data greater than
10659 @var{threshold} are placed in large data section.  This value must be the
10660 same across all object linked into the binary and defaults to 65535.
10662 @item -mrtd
10663 @opindex mrtd
10664 Use a different function-calling convention, in which functions that
10665 take a fixed number of arguments return with the @code{ret} @var{num}
10666 instruction, which pops their arguments while returning.  This saves one
10667 instruction in the caller since there is no need to pop the arguments
10668 there.
10670 You can specify that an individual function is called with this calling
10671 sequence with the function attribute @samp{stdcall}.  You can also
10672 override the @option{-mrtd} option by using the function attribute
10673 @samp{cdecl}.  @xref{Function Attributes}.
10675 @strong{Warning:} this calling convention is incompatible with the one
10676 normally used on Unix, so you cannot use it if you need to call
10677 libraries compiled with the Unix compiler.
10679 Also, you must provide function prototypes for all functions that
10680 take variable numbers of arguments (including @code{printf});
10681 otherwise incorrect code will be generated for calls to those
10682 functions.
10684 In addition, seriously incorrect code will result if you call a
10685 function with too many arguments.  (Normally, extra arguments are
10686 harmlessly ignored.)
10688 @item -mregparm=@var{num}
10689 @opindex mregparm
10690 Control how many registers are used to pass integer arguments.  By
10691 default, no registers are used to pass arguments, and at most 3
10692 registers can be used.  You can control this behavior for a specific
10693 function by using the function attribute @samp{regparm}.
10694 @xref{Function Attributes}.
10696 @strong{Warning:} if you use this switch, and
10697 @var{num} is nonzero, then you must build all modules with the same
10698 value, including any libraries.  This includes the system libraries and
10699 startup modules.
10701 @item -msseregparm
10702 @opindex msseregparm
10703 Use SSE register passing conventions for float and double arguments
10704 and return values.  You can control this behavior for a specific
10705 function by using the function attribute @samp{sseregparm}.
10706 @xref{Function Attributes}.
10708 @strong{Warning:} if you use this switch then you must build all
10709 modules with the same value, including any libraries.  This includes
10710 the system libraries and startup modules.
10712 @item -mpc32
10713 @itemx -mpc64
10714 @itemx -mpc80
10715 @opindex mpc32
10716 @opindex mpc64
10717 @opindex mpc80
10719 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10720 is specified, the significands of results of floating-point operations are
10721 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10722 significands of results of floating-point operations to 53 bits (double
10723 precision) and @option{-mpc80} rounds the significands of results of
10724 floating-point operations to 64 bits (extended double precision), which is
10725 the default.  When this option is used, floating-point operations in higher
10726 precisions are not available to the programmer without setting the FPU
10727 control word explicitly.
10729 Setting the rounding of floating-point operations to less than the default
10730 80 bits can speed some programs by 2% or more.  Note that some mathematical
10731 libraries assume that extended precision (80 bit) floating-point operations
10732 are enabled by default; routines in such libraries could suffer significant
10733 loss of accuracy, typically through so-called "catastrophic cancellation",
10734 when this option is used to set the precision to less than extended precision. 
10736 @item -mstackrealign
10737 @opindex mstackrealign
10738 Realign the stack at entry.  On the Intel x86, the
10739 @option{-mstackrealign} option will generate an alternate prologue and
10740 epilogue that realigns the runtime stack.  This supports mixing legacy
10741 codes that keep a 4-byte aligned stack with modern codes that keep a
10742 16-byte stack for SSE compatibility.  The alternate prologue and
10743 epilogue are slower and bigger than the regular ones, and the
10744 alternate prologue requires an extra scratch register; this lowers the
10745 number of registers available if used in conjunction with the
10746 @code{regparm} attribute.  The @option{-mstackrealign} option is
10747 incompatible with the nested function prologue; this is considered a
10748 hard error.  See also the attribute @code{force_align_arg_pointer},
10749 applicable to individual functions.
10751 @item -mpreferred-stack-boundary=@var{num}
10752 @opindex mpreferred-stack-boundary
10753 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10754 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10755 the default is 4 (16 bytes or 128 bits).
10757 On Pentium and PentiumPro, @code{double} and @code{long double} values
10758 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10759 suffer significant run time performance penalties.  On Pentium III, the
10760 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10761 properly if it is not 16 byte aligned.
10763 To ensure proper alignment of this values on the stack, the stack boundary
10764 must be as aligned as that required by any value stored on the stack.
10765 Further, every function must be generated such that it keeps the stack
10766 aligned.  Thus calling a function compiled with a higher preferred
10767 stack boundary from a function compiled with a lower preferred stack
10768 boundary will most likely misalign the stack.  It is recommended that
10769 libraries that use callbacks always use the default setting.
10771 This extra alignment does consume extra stack space, and generally
10772 increases code size.  Code that is sensitive to stack space usage, such
10773 as embedded systems and operating system kernels, may want to reduce the
10774 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10776 @item -mmmx
10777 @itemx -mno-mmx
10778 @itemx -msse
10779 @itemx -mno-sse
10780 @itemx -msse2
10781 @itemx -mno-sse2
10782 @itemx -msse3
10783 @itemx -mno-sse3
10784 @itemx -mssse3
10785 @itemx -mno-ssse3
10786 @itemx -msse4.1
10787 @itemx -mno-sse4.1
10788 @itemx -msse4.2
10789 @itemx -mno-sse4.2
10790 @itemx -msse4
10791 @itemx -mno-sse4
10792 @itemx -maes
10793 @itemx -mno-aes
10794 @itemx -mpclmul
10795 @itemx -mno-pclmul
10796 @itemx -msse4a
10797 @itemx -mno-sse4a
10798 @itemx -msse5
10799 @itemx -mno-sse5
10800 @itemx -m3dnow
10801 @itemx -mno-3dnow
10802 @itemx -mpopcnt
10803 @itemx -mno-popcnt
10804 @itemx -mabm
10805 @itemx -mno-abm
10806 @opindex mmmx
10807 @opindex mno-mmx
10808 @opindex msse
10809 @opindex mno-sse
10810 @opindex m3dnow
10811 @opindex mno-3dnow
10812 These switches enable or disable the use of instructions in the MMX,
10813 SSE, SSE2, SSE3, SSSE3, SSE4.1, AES, PCLMUL, SSE4A, SSE5, ABM or
10814 3DNow!@: extended instruction sets.
10815 These extensions are also available as built-in functions: see
10816 @ref{X86 Built-in Functions}, for details of the functions enabled and
10817 disabled by these switches.
10819 To have SSE/SSE2 instructions generated automatically from floating-point
10820 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10822 These options will enable GCC to use these extended instructions in
10823 generated code, even without @option{-mfpmath=sse}.  Applications which
10824 perform runtime CPU detection must compile separate files for each
10825 supported architecture, using the appropriate flags.  In particular,
10826 the file containing the CPU detection code should be compiled without
10827 these options.
10829 @item -mcx16
10830 @opindex mcx16
10831 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10832 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10833 data types.  This is useful for high resolution counters that could be updated
10834 by multiple processors (or cores).  This instruction is generated as part of
10835 atomic built-in functions: see @ref{Atomic Builtins} for details.
10837 @item -msahf
10838 @opindex msahf
10839 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10840 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10841 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10842 SAHF are load and store instructions, respectively, for certain status flags.
10843 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10844 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10846 @item -mrecip
10847 @opindex mrecip
10848 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10849 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Rhapson step
10850 to increase precision instead of DIVSS and SQRTSS (and their vectorized
10851 variants) for single precision floating point arguments.  These instructions
10852 are generated only when @option{-funsafe-math-optimizations} is enabled
10853 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
10854 Note that while the throughput of the sequence is higher than the throughput
10855 of the non-reciprocal instruction, the precision of the sequence can be
10856 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
10858 @item -mveclibabi=@var{type}
10859 @opindex mveclibabi
10860 Specifies the ABI type to use for vectorizing intrinsics using an
10861 external library.  Supported types are @code{svml} for the Intel short
10862 vector math library and @code{acml} for the AMD math core library style
10863 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
10864 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
10865 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
10866 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
10867 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
10868 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
10869 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
10870 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
10871 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
10872 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
10873 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
10874 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
10875 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
10876 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
10877 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
10878 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
10879 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
10880 compatible library will have to be specified at link time.
10882 @item -mpush-args
10883 @itemx -mno-push-args
10884 @opindex mpush-args
10885 @opindex mno-push-args
10886 Use PUSH operations to store outgoing parameters.  This method is shorter
10887 and usually equally fast as method using SUB/MOV operations and is enabled
10888 by default.  In some cases disabling it may improve performance because of
10889 improved scheduling and reduced dependencies.
10891 @item -maccumulate-outgoing-args
10892 @opindex maccumulate-outgoing-args
10893 If enabled, the maximum amount of space required for outgoing arguments will be
10894 computed in the function prologue.  This is faster on most modern CPUs
10895 because of reduced dependencies, improved scheduling and reduced stack usage
10896 when preferred stack boundary is not equal to 2.  The drawback is a notable
10897 increase in code size.  This switch implies @option{-mno-push-args}.
10899 @item -mthreads
10900 @opindex mthreads
10901 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10902 on thread-safe exception handling must compile and link all code with the
10903 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10904 @option{-D_MT}; when linking, it links in a special thread helper library
10905 @option{-lmingwthrd} which cleans up per thread exception handling data.
10907 @item -mno-align-stringops
10908 @opindex mno-align-stringops
10909 Do not align destination of inlined string operations.  This switch reduces
10910 code size and improves performance in case the destination is already aligned,
10911 but GCC doesn't know about it.
10913 @item -minline-all-stringops
10914 @opindex minline-all-stringops
10915 By default GCC inlines string operations only when destination is known to be
10916 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10917 size, but may improve performance of code that depends on fast memcpy, strlen
10918 and memset for short lengths.
10920 @item -minline-stringops-dynamically
10921 @opindex minline-stringops-dynamically
10922 For string operation of unknown size, inline runtime checks so for small
10923 blocks inline code is used, while for large blocks library call is used.
10925 @item -mstringop-strategy=@var{alg}
10926 @opindex mstringop-strategy=@var{alg}
10927 Overwrite internal decision heuristic about particular algorithm to inline
10928 string operation with.  The allowed values are @code{rep_byte},
10929 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10930 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10931 expanding inline loop, @code{libcall} for always expanding library call.
10933 @item -momit-leaf-frame-pointer
10934 @opindex momit-leaf-frame-pointer
10935 Don't keep the frame pointer in a register for leaf functions.  This
10936 avoids the instructions to save, set up and restore frame pointers and
10937 makes an extra register available in leaf functions.  The option
10938 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10939 which might make debugging harder.
10941 @item -mtls-direct-seg-refs
10942 @itemx -mno-tls-direct-seg-refs
10943 @opindex mtls-direct-seg-refs
10944 Controls whether TLS variables may be accessed with offsets from the
10945 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10946 or whether the thread base pointer must be added.  Whether or not this
10947 is legal depends on the operating system, and whether it maps the
10948 segment to cover the entire TLS area.
10950 For systems that use GNU libc, the default is on.
10952 @item -mfused-madd
10953 @itemx -mno-fused-madd
10954 @opindex mfused-madd
10955 Enable automatic generation of fused floating point multiply-add instructions
10956 if the ISA supports such instructions.  The -mfused-madd option is on by
10957 default.  The fused multiply-add instructions have a different
10958 rounding behavior compared to executing a multiply followed by an add.
10959 @end table
10961 These @samp{-m} switches are supported in addition to the above
10962 on AMD x86-64 processors in 64-bit environments.
10964 @table @gcctabopt
10965 @item -m32
10966 @itemx -m64
10967 @opindex m32
10968 @opindex m64
10969 Generate code for a 32-bit or 64-bit environment.
10970 The 32-bit environment sets int, long and pointer to 32 bits and
10971 generates code that runs on any i386 system.
10972 The 64-bit environment sets int to 32 bits and long and pointer
10973 to 64 bits and generates code for AMD's x86-64 architecture. For
10974 darwin only the -m64 option turns off the @option{-fno-pic} and
10975 @option{-mdynamic-no-pic} options.
10977 @item -mno-red-zone
10978 @opindex no-red-zone
10979 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10980 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10981 stack pointer that will not be modified by signal or interrupt handlers
10982 and therefore can be used for temporary data without adjusting the stack
10983 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10985 @item -mcmodel=small
10986 @opindex mcmodel=small
10987 Generate code for the small code model: the program and its symbols must
10988 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10989 Programs can be statically or dynamically linked.  This is the default
10990 code model.
10992 @item -mcmodel=kernel
10993 @opindex mcmodel=kernel
10994 Generate code for the kernel code model.  The kernel runs in the
10995 negative 2 GB of the address space.
10996 This model has to be used for Linux kernel code.
10998 @item -mcmodel=medium
10999 @opindex mcmodel=medium
11000 Generate code for the medium model: The program is linked in the lower 2
11001 GB of the address space but symbols can be located anywhere in the
11002 address space.  Programs can be statically or dynamically linked, but
11003 building of shared libraries are not supported with the medium model.
11005 @item -mcmodel=large
11006 @opindex mcmodel=large
11007 Generate code for the large model: This model makes no assumptions
11008 about addresses and sizes of sections.
11009 @end table
11011 @node IA-64 Options
11012 @subsection IA-64 Options
11013 @cindex IA-64 Options
11015 These are the @samp{-m} options defined for the Intel IA-64 architecture.
11017 @table @gcctabopt
11018 @item -mbig-endian
11019 @opindex mbig-endian
11020 Generate code for a big endian target.  This is the default for HP-UX@.
11022 @item -mlittle-endian
11023 @opindex mlittle-endian
11024 Generate code for a little endian target.  This is the default for AIX5
11025 and GNU/Linux.
11027 @item -mgnu-as
11028 @itemx -mno-gnu-as
11029 @opindex mgnu-as
11030 @opindex mno-gnu-as
11031 Generate (or don't) code for the GNU assembler.  This is the default.
11032 @c Also, this is the default if the configure option @option{--with-gnu-as}
11033 @c is used.
11035 @item -mgnu-ld
11036 @itemx -mno-gnu-ld
11037 @opindex mgnu-ld
11038 @opindex mno-gnu-ld
11039 Generate (or don't) code for the GNU linker.  This is the default.
11040 @c Also, this is the default if the configure option @option{--with-gnu-ld}
11041 @c is used.
11043 @item -mno-pic
11044 @opindex mno-pic
11045 Generate code that does not use a global pointer register.  The result
11046 is not position independent code, and violates the IA-64 ABI@.
11048 @item -mvolatile-asm-stop
11049 @itemx -mno-volatile-asm-stop
11050 @opindex mvolatile-asm-stop
11051 @opindex mno-volatile-asm-stop
11052 Generate (or don't) a stop bit immediately before and after volatile asm
11053 statements.
11055 @item -mregister-names
11056 @itemx -mno-register-names
11057 @opindex mregister-names
11058 @opindex mno-register-names
11059 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
11060 the stacked registers.  This may make assembler output more readable.
11062 @item -mno-sdata
11063 @itemx -msdata
11064 @opindex mno-sdata
11065 @opindex msdata
11066 Disable (or enable) optimizations that use the small data section.  This may
11067 be useful for working around optimizer bugs.
11069 @item -mconstant-gp
11070 @opindex mconstant-gp
11071 Generate code that uses a single constant global pointer value.  This is
11072 useful when compiling kernel code.
11074 @item -mauto-pic
11075 @opindex mauto-pic
11076 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
11077 This is useful when compiling firmware code.
11079 @item -minline-float-divide-min-latency
11080 @opindex minline-float-divide-min-latency
11081 Generate code for inline divides of floating point values
11082 using the minimum latency algorithm.
11084 @item -minline-float-divide-max-throughput
11085 @opindex minline-float-divide-max-throughput
11086 Generate code for inline divides of floating point values
11087 using the maximum throughput algorithm.
11089 @item -minline-int-divide-min-latency
11090 @opindex minline-int-divide-min-latency
11091 Generate code for inline divides of integer values
11092 using the minimum latency algorithm.
11094 @item -minline-int-divide-max-throughput
11095 @opindex minline-int-divide-max-throughput
11096 Generate code for inline divides of integer values
11097 using the maximum throughput algorithm.
11099 @item -minline-sqrt-min-latency
11100 @opindex minline-sqrt-min-latency
11101 Generate code for inline square roots
11102 using the minimum latency algorithm.
11104 @item -minline-sqrt-max-throughput
11105 @opindex minline-sqrt-max-throughput
11106 Generate code for inline square roots
11107 using the maximum throughput algorithm.
11109 @item -mno-dwarf2-asm
11110 @itemx -mdwarf2-asm
11111 @opindex mno-dwarf2-asm
11112 @opindex mdwarf2-asm
11113 Don't (or do) generate assembler code for the DWARF2 line number debugging
11114 info.  This may be useful when not using the GNU assembler.
11116 @item -mearly-stop-bits
11117 @itemx -mno-early-stop-bits
11118 @opindex mearly-stop-bits
11119 @opindex mno-early-stop-bits
11120 Allow stop bits to be placed earlier than immediately preceding the
11121 instruction that triggered the stop bit.  This can improve instruction
11122 scheduling, but does not always do so.
11124 @item -mfixed-range=@var{register-range}
11125 @opindex mfixed-range
11126 Generate code treating the given register range as fixed registers.
11127 A fixed register is one that the register allocator can not use.  This is
11128 useful when compiling kernel code.  A register range is specified as
11129 two registers separated by a dash.  Multiple register ranges can be
11130 specified separated by a comma.
11132 @item -mtls-size=@var{tls-size}
11133 @opindex mtls-size
11134 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
11137 @item -mtune=@var{cpu-type}
11138 @opindex mtune
11139 Tune the instruction scheduling for a particular CPU, Valid values are
11140 itanium, itanium1, merced, itanium2, and mckinley.
11142 @item -mt
11143 @itemx -pthread
11144 @opindex mt
11145 @opindex pthread
11146 Add support for multithreading using the POSIX threads library.  This
11147 option sets flags for both the preprocessor and linker.  It does
11148 not affect the thread safety of object code produced by the compiler or
11149 that of libraries supplied with it.  These are HP-UX specific flags.
11151 @item -milp32
11152 @itemx -mlp64
11153 @opindex milp32
11154 @opindex mlp64
11155 Generate code for a 32-bit or 64-bit environment.
11156 The 32-bit environment sets int, long and pointer to 32 bits.
11157 The 64-bit environment sets int to 32 bits and long and pointer
11158 to 64 bits.  These are HP-UX specific flags.
11160 @item -mno-sched-br-data-spec
11161 @itemx -msched-br-data-spec
11162 @opindex mno-sched-br-data-spec
11163 @opindex msched-br-data-spec
11164 (Dis/En)able data speculative scheduling before reload.
11165 This will result in generation of the ld.a instructions and
11166 the corresponding check instructions (ld.c / chk.a).
11167 The default is 'disable'.
11169 @item -msched-ar-data-spec
11170 @itemx -mno-sched-ar-data-spec
11171 @opindex msched-ar-data-spec
11172 @opindex mno-sched-ar-data-spec
11173 (En/Dis)able data speculative scheduling after reload.
11174 This will result in generation of the ld.a instructions and
11175 the corresponding check instructions (ld.c / chk.a).
11176 The default is 'enable'.
11178 @item -mno-sched-control-spec
11179 @itemx -msched-control-spec
11180 @opindex mno-sched-control-spec
11181 @opindex msched-control-spec
11182 (Dis/En)able control speculative scheduling.  This feature is
11183 available only during region scheduling (i.e.@: before reload).
11184 This will result in generation of the ld.s instructions and
11185 the corresponding check instructions chk.s .
11186 The default is 'disable'.
11188 @item -msched-br-in-data-spec
11189 @itemx -mno-sched-br-in-data-spec
11190 @opindex msched-br-in-data-spec
11191 @opindex mno-sched-br-in-data-spec
11192 (En/Dis)able speculative scheduling of the instructions that
11193 are dependent on the data speculative loads before reload.
11194 This is effective only with @option{-msched-br-data-spec} enabled.
11195 The default is 'enable'.
11197 @item -msched-ar-in-data-spec
11198 @itemx -mno-sched-ar-in-data-spec
11199 @opindex msched-ar-in-data-spec
11200 @opindex mno-sched-ar-in-data-spec
11201 (En/Dis)able speculative scheduling of the instructions that
11202 are dependent on the data speculative loads after reload.
11203 This is effective only with @option{-msched-ar-data-spec} enabled.
11204 The default is 'enable'.
11206 @item -msched-in-control-spec
11207 @itemx -mno-sched-in-control-spec
11208 @opindex msched-in-control-spec
11209 @opindex mno-sched-in-control-spec
11210 (En/Dis)able speculative scheduling of the instructions that
11211 are dependent on the control speculative loads.
11212 This is effective only with @option{-msched-control-spec} enabled.
11213 The default is 'enable'.
11215 @item -msched-ldc
11216 @itemx -mno-sched-ldc
11217 @opindex msched-ldc
11218 @opindex mno-sched-ldc
11219 (En/Dis)able use of simple data speculation checks ld.c .
11220 If disabled, only chk.a instructions will be emitted to check
11221 data speculative loads.
11222 The default is 'enable'.
11224 @item -mno-sched-control-ldc
11225 @itemx -msched-control-ldc
11226 @opindex mno-sched-control-ldc
11227 @opindex msched-control-ldc
11228 (Dis/En)able use of ld.c instructions to check control speculative loads.
11229 If enabled, in case of control speculative load with no speculatively
11230 scheduled dependent instructions this load will be emitted as ld.sa and
11231 ld.c will be used to check it.
11232 The default is 'disable'.
11234 @item -mno-sched-spec-verbose
11235 @itemx -msched-spec-verbose
11236 @opindex mno-sched-spec-verbose
11237 @opindex msched-spec-verbose
11238 (Dis/En)able printing of the information about speculative motions.
11240 @item -mno-sched-prefer-non-data-spec-insns
11241 @itemx -msched-prefer-non-data-spec-insns
11242 @opindex mno-sched-prefer-non-data-spec-insns
11243 @opindex msched-prefer-non-data-spec-insns
11244 If enabled, data speculative instructions will be chosen for schedule
11245 only if there are no other choices at the moment.  This will make
11246 the use of the data speculation much more conservative.
11247 The default is 'disable'.
11249 @item -mno-sched-prefer-non-control-spec-insns
11250 @itemx -msched-prefer-non-control-spec-insns
11251 @opindex mno-sched-prefer-non-control-spec-insns
11252 @opindex msched-prefer-non-control-spec-insns
11253 If enabled, control speculative instructions will be chosen for schedule
11254 only if there are no other choices at the moment.  This will make
11255 the use of the control speculation much more conservative.
11256 The default is 'disable'.
11258 @item -mno-sched-count-spec-in-critical-path
11259 @itemx -msched-count-spec-in-critical-path
11260 @opindex mno-sched-count-spec-in-critical-path
11261 @opindex msched-count-spec-in-critical-path
11262 If enabled, speculative dependencies will be considered during
11263 computation of the instructions priorities.  This will make the use of the
11264 speculation a bit more conservative.
11265 The default is 'disable'.
11267 @end table
11269 @node M32C Options
11270 @subsection M32C Options
11271 @cindex M32C options
11273 @table @gcctabopt
11274 @item -mcpu=@var{name}
11275 @opindex mcpu=
11276 Select the CPU for which code is generated.  @var{name} may be one of
11277 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
11278 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
11279 the M32C/80 series.
11281 @item -msim
11282 @opindex msim
11283 Specifies that the program will be run on the simulator.  This causes
11284 an alternate runtime library to be linked in which supports, for
11285 example, file I/O@.  You must not use this option when generating
11286 programs that will run on real hardware; you must provide your own
11287 runtime library for whatever I/O functions are needed.
11289 @item -memregs=@var{number}
11290 @opindex memregs=
11291 Specifies the number of memory-based pseudo-registers GCC will use
11292 during code generation.  These pseudo-registers will be used like real
11293 registers, so there is a tradeoff between GCC's ability to fit the
11294 code into available registers, and the performance penalty of using
11295 memory instead of registers.  Note that all modules in a program must
11296 be compiled with the same value for this option.  Because of that, you
11297 must not use this option with the default runtime libraries gcc
11298 builds.
11300 @end table
11302 @node M32R/D Options
11303 @subsection M32R/D Options
11304 @cindex M32R/D options
11306 These @option{-m} options are defined for Renesas M32R/D architectures:
11308 @table @gcctabopt
11309 @item -m32r2
11310 @opindex m32r2
11311 Generate code for the M32R/2@.
11313 @item -m32rx
11314 @opindex m32rx
11315 Generate code for the M32R/X@.
11317 @item -m32r
11318 @opindex m32r
11319 Generate code for the M32R@.  This is the default.
11321 @item -mmodel=small
11322 @opindex mmodel=small
11323 Assume all objects live in the lower 16MB of memory (so that their addresses
11324 can be loaded with the @code{ld24} instruction), and assume all subroutines
11325 are reachable with the @code{bl} instruction.
11326 This is the default.
11328 The addressability of a particular object can be set with the
11329 @code{model} attribute.
11331 @item -mmodel=medium
11332 @opindex mmodel=medium
11333 Assume objects may be anywhere in the 32-bit address space (the compiler
11334 will generate @code{seth/add3} instructions to load their addresses), and
11335 assume all subroutines are reachable with the @code{bl} instruction.
11337 @item -mmodel=large
11338 @opindex mmodel=large
11339 Assume objects may be anywhere in the 32-bit address space (the compiler
11340 will generate @code{seth/add3} instructions to load their addresses), and
11341 assume subroutines may not be reachable with the @code{bl} instruction
11342 (the compiler will generate the much slower @code{seth/add3/jl}
11343 instruction sequence).
11345 @item -msdata=none
11346 @opindex msdata=none
11347 Disable use of the small data area.  Variables will be put into
11348 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
11349 @code{section} attribute has been specified).
11350 This is the default.
11352 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
11353 Objects may be explicitly put in the small data area with the
11354 @code{section} attribute using one of these sections.
11356 @item -msdata=sdata
11357 @opindex msdata=sdata
11358 Put small global and static data in the small data area, but do not
11359 generate special code to reference them.
11361 @item -msdata=use
11362 @opindex msdata=use
11363 Put small global and static data in the small data area, and generate
11364 special instructions to reference them.
11366 @item -G @var{num}
11367 @opindex G
11368 @cindex smaller data references
11369 Put global and static objects less than or equal to @var{num} bytes
11370 into the small data or bss sections instead of the normal data or bss
11371 sections.  The default value of @var{num} is 8.
11372 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11373 for this option to have any effect.
11375 All modules should be compiled with the same @option{-G @var{num}} value.
11376 Compiling with different values of @var{num} may or may not work; if it
11377 doesn't the linker will give an error message---incorrect code will not be
11378 generated.
11380 @item -mdebug
11381 @opindex mdebug
11382 Makes the M32R specific code in the compiler display some statistics
11383 that might help in debugging programs.
11385 @item -malign-loops
11386 @opindex malign-loops
11387 Align all loops to a 32-byte boundary.
11389 @item -mno-align-loops
11390 @opindex mno-align-loops
11391 Do not enforce a 32-byte alignment for loops.  This is the default.
11393 @item -missue-rate=@var{number}
11394 @opindex missue-rate=@var{number}
11395 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11396 or 2.
11398 @item -mbranch-cost=@var{number}
11399 @opindex mbranch-cost=@var{number}
11400 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11401 preferred over conditional code, if it is 2, then the opposite will
11402 apply.
11404 @item -mflush-trap=@var{number}
11405 @opindex mflush-trap=@var{number}
11406 Specifies the trap number to use to flush the cache.  The default is
11407 12.  Valid numbers are between 0 and 15 inclusive.
11409 @item -mno-flush-trap
11410 @opindex mno-flush-trap
11411 Specifies that the cache cannot be flushed by using a trap.
11413 @item -mflush-func=@var{name}
11414 @opindex mflush-func=@var{name}
11415 Specifies the name of the operating system function to call to flush
11416 the cache.  The default is @emph{_flush_cache}, but a function call
11417 will only be used if a trap is not available.
11419 @item -mno-flush-func
11420 @opindex mno-flush-func
11421 Indicates that there is no OS function for flushing the cache.
11423 @end table
11425 @node M680x0 Options
11426 @subsection M680x0 Options
11427 @cindex M680x0 options
11429 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11430 The default settings depend on which architecture was selected when
11431 the compiler was configured; the defaults for the most common choices
11432 are given below.
11434 @table @gcctabopt
11435 @item -march=@var{arch}
11436 @opindex march
11437 Generate code for a specific M680x0 or ColdFire instruction set
11438 architecture.  Permissible values of @var{arch} for M680x0
11439 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11440 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11441 architectures are selected according to Freescale's ISA classification
11442 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11443 @samp{isab} and @samp{isac}.
11445 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11446 code for a ColdFire target.  The @var{arch} in this macro is one of the
11447 @option{-march} arguments given above.
11449 When used together, @option{-march} and @option{-mtune} select code
11450 that runs on a family of similar processors but that is optimized
11451 for a particular microarchitecture.
11453 @item -mcpu=@var{cpu}
11454 @opindex mcpu
11455 Generate code for a specific M680x0 or ColdFire processor.
11456 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11457 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11458 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11459 below, which also classifies the CPUs into families:
11461 @multitable @columnfractions 0.20 0.80
11462 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11463 @item @samp{51qe} @tab @samp{51qe}
11464 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11465 @item @samp{5206e} @tab @samp{5206e}
11466 @item @samp{5208} @tab @samp{5207} @samp{5208}
11467 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11468 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11469 @item @samp{5216} @tab @samp{5214} @samp{5216}
11470 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11471 @item @samp{5225} @tab @samp{5224} @samp{5225}
11472 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11473 @item @samp{5249} @tab @samp{5249}
11474 @item @samp{5250} @tab @samp{5250}
11475 @item @samp{5271} @tab @samp{5270} @samp{5271}
11476 @item @samp{5272} @tab @samp{5272}
11477 @item @samp{5275} @tab @samp{5274} @samp{5275}
11478 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11479 @item @samp{5307} @tab @samp{5307}
11480 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11481 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11482 @item @samp{5407} @tab @samp{5407}
11483 @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}
11484 @end multitable
11486 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11487 @var{arch} is compatible with @var{cpu}.  Other combinations of
11488 @option{-mcpu} and @option{-march} are rejected.
11490 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11491 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11492 where the value of @var{family} is given by the table above.
11494 @item -mtune=@var{tune}
11495 @opindex mtune
11496 Tune the code for a particular microarchitecture, within the
11497 constraints set by @option{-march} and @option{-mcpu}.
11498 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11499 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11500 and @samp{cpu32}.  The ColdFire microarchitectures
11501 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11503 You can also use @option{-mtune=68020-40} for code that needs
11504 to run relatively well on 68020, 68030 and 68040 targets.
11505 @option{-mtune=68020-60} is similar but includes 68060 targets
11506 as well.  These two options select the same tuning decisions as
11507 @option{-m68020-40} and @option{-m68020-60} respectively.
11509 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11510 when tuning for 680x0 architecture @var{arch}.  It also defines
11511 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11512 option is used.  If gcc is tuning for a range of architectures,
11513 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11514 it defines the macros for every architecture in the range.
11516 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11517 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11518 of the arguments given above.
11520 @item -m68000
11521 @itemx -mc68000
11522 @opindex m68000
11523 @opindex mc68000
11524 Generate output for a 68000.  This is the default
11525 when the compiler is configured for 68000-based systems.
11526 It is equivalent to @option{-march=68000}.
11528 Use this option for microcontrollers with a 68000 or EC000 core,
11529 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11531 @item -m68010
11532 @opindex m68010
11533 Generate output for a 68010.  This is the default
11534 when the compiler is configured for 68010-based systems.
11535 It is equivalent to @option{-march=68010}.
11537 @item -m68020
11538 @itemx -mc68020
11539 @opindex m68020
11540 @opindex mc68020
11541 Generate output for a 68020.  This is the default
11542 when the compiler is configured for 68020-based systems.
11543 It is equivalent to @option{-march=68020}.
11545 @item -m68030
11546 @opindex m68030
11547 Generate output for a 68030.  This is the default when the compiler is
11548 configured for 68030-based systems.  It is equivalent to
11549 @option{-march=68030}.
11551 @item -m68040
11552 @opindex m68040
11553 Generate output for a 68040.  This is the default when the compiler is
11554 configured for 68040-based systems.  It is equivalent to
11555 @option{-march=68040}.
11557 This option inhibits the use of 68881/68882 instructions that have to be
11558 emulated by software on the 68040.  Use this option if your 68040 does not
11559 have code to emulate those instructions.
11561 @item -m68060
11562 @opindex m68060
11563 Generate output for a 68060.  This is the default when the compiler is
11564 configured for 68060-based systems.  It is equivalent to
11565 @option{-march=68060}.
11567 This option inhibits the use of 68020 and 68881/68882 instructions that
11568 have to be emulated by software on the 68060.  Use this option if your 68060
11569 does not have code to emulate those instructions.
11571 @item -mcpu32
11572 @opindex mcpu32
11573 Generate output for a CPU32.  This is the default
11574 when the compiler is configured for CPU32-based systems.
11575 It is equivalent to @option{-march=cpu32}.
11577 Use this option for microcontrollers with a
11578 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11579 68336, 68340, 68341, 68349 and 68360.
11581 @item -m5200
11582 @opindex m5200
11583 Generate output for a 520X ColdFire CPU@.  This is the default
11584 when the compiler is configured for 520X-based systems.
11585 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11586 in favor of that option.
11588 Use this option for microcontroller with a 5200 core, including
11589 the MCF5202, MCF5203, MCF5204 and MCF5206.
11591 @item -m5206e
11592 @opindex m5206e
11593 Generate output for a 5206e ColdFire CPU@.  The option is now
11594 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11596 @item -m528x
11597 @opindex m528x
11598 Generate output for a member of the ColdFire 528X family.
11599 The option is now deprecated in favor of the equivalent
11600 @option{-mcpu=528x}.
11602 @item -m5307
11603 @opindex m5307
11604 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
11605 in favor of the equivalent @option{-mcpu=5307}.
11607 @item -m5407
11608 @opindex m5407
11609 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
11610 in favor of the equivalent @option{-mcpu=5407}.
11612 @item -mcfv4e
11613 @opindex mcfv4e
11614 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11615 This includes use of hardware floating point instructions.
11616 The option is equivalent to @option{-mcpu=547x}, and is now
11617 deprecated in favor of that option.
11619 @item -m68020-40
11620 @opindex m68020-40
11621 Generate output for a 68040, without using any of the new instructions.
11622 This results in code which can run relatively efficiently on either a
11623 68020/68881 or a 68030 or a 68040.  The generated code does use the
11624 68881 instructions that are emulated on the 68040.
11626 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11628 @item -m68020-60
11629 @opindex m68020-60
11630 Generate output for a 68060, without using any of the new instructions.
11631 This results in code which can run relatively efficiently on either a
11632 68020/68881 or a 68030 or a 68040.  The generated code does use the
11633 68881 instructions that are emulated on the 68060.
11635 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11637 @item -mhard-float
11638 @itemx -m68881
11639 @opindex mhard-float
11640 @opindex m68881
11641 Generate floating-point instructions.  This is the default for 68020
11642 and above, and for ColdFire devices that have an FPU@.  It defines the
11643 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11644 on ColdFire targets.
11646 @item -msoft-float
11647 @opindex msoft-float
11648 Do not generate floating-point instructions; use library calls instead.
11649 This is the default for 68000, 68010, and 68832 targets.  It is also
11650 the default for ColdFire devices that have no FPU.
11652 @item -mdiv
11653 @itemx -mno-div
11654 @opindex mdiv
11655 @opindex mno-div
11656 Generate (do not generate) ColdFire hardware divide and remainder
11657 instructions.  If @option{-march} is used without @option{-mcpu},
11658 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11659 architectures.  Otherwise, the default is taken from the target CPU
11660 (either the default CPU, or the one specified by @option{-mcpu}).  For
11661 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11662 @option{-mcpu=5206e}.
11664 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11666 @item -mshort
11667 @opindex mshort
11668 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11669 Additionally, parameters passed on the stack are also aligned to a
11670 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11672 @item -mno-short
11673 @opindex mno-short
11674 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11676 @item -mnobitfield
11677 @itemx -mno-bitfield
11678 @opindex mnobitfield
11679 @opindex mno-bitfield
11680 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11681 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11683 @item -mbitfield
11684 @opindex mbitfield
11685 Do use the bit-field instructions.  The @option{-m68020} option implies
11686 @option{-mbitfield}.  This is the default if you use a configuration
11687 designed for a 68020.
11689 @item -mrtd
11690 @opindex mrtd
11691 Use a different function-calling convention, in which functions
11692 that take a fixed number of arguments return with the @code{rtd}
11693 instruction, which pops their arguments while returning.  This
11694 saves one instruction in the caller since there is no need to pop
11695 the arguments there.
11697 This calling convention is incompatible with the one normally
11698 used on Unix, so you cannot use it if you need to call libraries
11699 compiled with the Unix compiler.
11701 Also, you must provide function prototypes for all functions that
11702 take variable numbers of arguments (including @code{printf});
11703 otherwise incorrect code will be generated for calls to those
11704 functions.
11706 In addition, seriously incorrect code will result if you call a
11707 function with too many arguments.  (Normally, extra arguments are
11708 harmlessly ignored.)
11710 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11711 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11713 @item -mno-rtd
11714 @opindex mno-rtd
11715 Do not use the calling conventions selected by @option{-mrtd}.
11716 This is the default.
11718 @item -malign-int
11719 @itemx -mno-align-int
11720 @opindex malign-int
11721 @opindex mno-align-int
11722 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11723 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11724 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11725 Aligning variables on 32-bit boundaries produces code that runs somewhat
11726 faster on processors with 32-bit busses at the expense of more memory.
11728 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11729 align structures containing the above types  differently than
11730 most published application binary interface specifications for the m68k.
11732 @item -mpcrel
11733 @opindex mpcrel
11734 Use the pc-relative addressing mode of the 68000 directly, instead of
11735 using a global offset table.  At present, this option implies @option{-fpic},
11736 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11737 not presently supported with @option{-mpcrel}, though this could be supported for
11738 68020 and higher processors.
11740 @item -mno-strict-align
11741 @itemx -mstrict-align
11742 @opindex mno-strict-align
11743 @opindex mstrict-align
11744 Do not (do) assume that unaligned memory references will be handled by
11745 the system.
11747 @item -msep-data
11748 Generate code that allows the data segment to be located in a different
11749 area of memory from the text segment.  This allows for execute in place in
11750 an environment without virtual memory management.  This option implies
11751 @option{-fPIC}.
11753 @item -mno-sep-data
11754 Generate code that assumes that the data segment follows the text segment.
11755 This is the default.
11757 @item -mid-shared-library
11758 Generate code that supports shared libraries via the library ID method.
11759 This allows for execute in place and shared libraries in an environment
11760 without virtual memory management.  This option implies @option{-fPIC}.
11762 @item -mno-id-shared-library
11763 Generate code that doesn't assume ID based shared libraries are being used.
11764 This is the default.
11766 @item -mshared-library-id=n
11767 Specified the identification number of the ID based shared library being
11768 compiled.  Specifying a value of 0 will generate more compact code, specifying
11769 other values will force the allocation of that number to the current
11770 library but is no more space or time efficient than omitting this option.
11772 @end table
11774 @node M68hc1x Options
11775 @subsection M68hc1x Options
11776 @cindex M68hc1x options
11778 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11779 microcontrollers.  The default values for these options depends on
11780 which style of microcontroller was selected when the compiler was configured;
11781 the defaults for the most common choices are given below.
11783 @table @gcctabopt
11784 @item -m6811
11785 @itemx -m68hc11
11786 @opindex m6811
11787 @opindex m68hc11
11788 Generate output for a 68HC11.  This is the default
11789 when the compiler is configured for 68HC11-based systems.
11791 @item -m6812
11792 @itemx -m68hc12
11793 @opindex m6812
11794 @opindex m68hc12
11795 Generate output for a 68HC12.  This is the default
11796 when the compiler is configured for 68HC12-based systems.
11798 @item -m68S12
11799 @itemx -m68hcs12
11800 @opindex m68S12
11801 @opindex m68hcs12
11802 Generate output for a 68HCS12.
11804 @item -mauto-incdec
11805 @opindex mauto-incdec
11806 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11807 addressing modes.
11809 @item -minmax
11810 @itemx -nominmax
11811 @opindex minmax
11812 @opindex mnominmax
11813 Enable the use of 68HC12 min and max instructions.
11815 @item -mlong-calls
11816 @itemx -mno-long-calls
11817 @opindex mlong-calls
11818 @opindex mno-long-calls
11819 Treat all calls as being far away (near).  If calls are assumed to be
11820 far away, the compiler will use the @code{call} instruction to
11821 call a function and the @code{rtc} instruction for returning.
11823 @item -mshort
11824 @opindex mshort
11825 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11827 @item -msoft-reg-count=@var{count}
11828 @opindex msoft-reg-count
11829 Specify the number of pseudo-soft registers which are used for the
11830 code generation.  The maximum number is 32.  Using more pseudo-soft
11831 register may or may not result in better code depending on the program.
11832 The default is 4 for 68HC11 and 2 for 68HC12.
11834 @end table
11836 @node MCore Options
11837 @subsection MCore Options
11838 @cindex MCore options
11840 These are the @samp{-m} options defined for the Motorola M*Core
11841 processors.
11843 @table @gcctabopt
11845 @item -mhardlit
11846 @itemx -mno-hardlit
11847 @opindex mhardlit
11848 @opindex mno-hardlit
11849 Inline constants into the code stream if it can be done in two
11850 instructions or less.
11852 @item -mdiv
11853 @itemx -mno-div
11854 @opindex mdiv
11855 @opindex mno-div
11856 Use the divide instruction.  (Enabled by default).
11858 @item -mrelax-immediate
11859 @itemx -mno-relax-immediate
11860 @opindex mrelax-immediate
11861 @opindex mno-relax-immediate
11862 Allow arbitrary sized immediates in bit operations.
11864 @item -mwide-bitfields
11865 @itemx -mno-wide-bitfields
11866 @opindex mwide-bitfields
11867 @opindex mno-wide-bitfields
11868 Always treat bit-fields as int-sized.
11870 @item -m4byte-functions
11871 @itemx -mno-4byte-functions
11872 @opindex m4byte-functions
11873 @opindex mno-4byte-functions
11874 Force all functions to be aligned to a four byte boundary.
11876 @item -mcallgraph-data
11877 @itemx -mno-callgraph-data
11878 @opindex mcallgraph-data
11879 @opindex mno-callgraph-data
11880 Emit callgraph information.
11882 @item -mslow-bytes
11883 @itemx -mno-slow-bytes
11884 @opindex mslow-bytes
11885 @opindex mno-slow-bytes
11886 Prefer word access when reading byte quantities.
11888 @item -mlittle-endian
11889 @itemx -mbig-endian
11890 @opindex mlittle-endian
11891 @opindex mbig-endian
11892 Generate code for a little endian target.
11894 @item -m210
11895 @itemx -m340
11896 @opindex m210
11897 @opindex m340
11898 Generate code for the 210 processor.
11899 @end table
11901 @node MIPS Options
11902 @subsection MIPS Options
11903 @cindex MIPS options
11905 @table @gcctabopt
11907 @item -EB
11908 @opindex EB
11909 Generate big-endian code.
11911 @item -EL
11912 @opindex EL
11913 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11914 configurations.
11916 @item -march=@var{arch}
11917 @opindex march
11918 Generate code that will run on @var{arch}, which can be the name of a
11919 generic MIPS ISA, or the name of a particular processor.
11920 The ISA names are:
11921 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11922 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11923 The processor names are:
11924 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11925 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11926 @samp{5kc}, @samp{5kf},
11927 @samp{20kc},
11928 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11929 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11930 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11931 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11932 @samp{m4k},
11933 @samp{orion},
11934 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11935 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11936 @samp{rm7000}, @samp{rm9000},
11937 @samp{sb1},
11938 @samp{sr71000},
11939 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11940 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11941 The special value @samp{from-abi} selects the
11942 most compatible architecture for the selected ABI (that is,
11943 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11945 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11946 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11947 @samp{vr} may be written @samp{r}.
11949 Names of the form @samp{@var{n}f2_1} refer to processors with
11950 FPUs clocked at half the rate of the core, names of the form
11951 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11952 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11953 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11954 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11955 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11956 accepted as synonyms for @samp{@var{n}f1_1}.
11958 GCC defines two macros based on the value of this option.  The first
11959 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11960 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11961 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11962 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11963 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11965 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11966 above.  In other words, it will have the full prefix and will not
11967 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11968 the macro names the resolved architecture (either @samp{"mips1"} or
11969 @samp{"mips3"}).  It names the default architecture when no
11970 @option{-march} option is given.
11972 @item -mtune=@var{arch}
11973 @opindex mtune
11974 Optimize for @var{arch}.  Among other things, this option controls
11975 the way instructions are scheduled, and the perceived cost of arithmetic
11976 operations.  The list of @var{arch} values is the same as for
11977 @option{-march}.
11979 When this option is not used, GCC will optimize for the processor
11980 specified by @option{-march}.  By using @option{-march} and
11981 @option{-mtune} together, it is possible to generate code that will
11982 run on a family of processors, but optimize the code for one
11983 particular member of that family.
11985 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11986 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11987 @samp{-march} ones described above.
11989 @item -mips1
11990 @opindex mips1
11991 Equivalent to @samp{-march=mips1}.
11993 @item -mips2
11994 @opindex mips2
11995 Equivalent to @samp{-march=mips2}.
11997 @item -mips3
11998 @opindex mips3
11999 Equivalent to @samp{-march=mips3}.
12001 @item -mips4
12002 @opindex mips4
12003 Equivalent to @samp{-march=mips4}.
12005 @item -mips32
12006 @opindex mips32
12007 Equivalent to @samp{-march=mips32}.
12009 @item -mips32r2
12010 @opindex mips32r2
12011 Equivalent to @samp{-march=mips32r2}.
12013 @item -mips64
12014 @opindex mips64
12015 Equivalent to @samp{-march=mips64}.
12017 @item -mips16
12018 @itemx -mno-mips16
12019 @opindex mips16
12020 @opindex mno-mips16
12021 Generate (do not generate) MIPS16 code.  If GCC is targetting a
12022 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
12024 MIPS16 code generation can also be controlled on a per-function basis
12025 by means of @code{mips16} and @code{nomips16} attributes.  
12026 @xref{Function Attributes}, for more information.
12028 @item -mflip-mips16
12029 @opindex mflip-mips16
12030 Generate MIPS16 code on alternating functions.  This option is provided
12031 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
12032 not intended for ordinary use in compiling user code.
12034 @item -minterlink-mips16
12035 @itemx -mno-interlink-mips16
12036 @opindex minterlink-mips16
12037 @opindex mno-interlink-mips16
12038 Require (do not require) that non-MIPS16 code be link-compatible with
12039 MIPS16 code.
12041 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
12042 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
12043 therefore disables direct jumps unless GCC knows that the target of the
12044 jump is not MIPS16.
12046 @item -mabi=32
12047 @itemx -mabi=o64
12048 @itemx -mabi=n32
12049 @itemx -mabi=64
12050 @itemx -mabi=eabi
12051 @opindex mabi=32
12052 @opindex mabi=o64
12053 @opindex mabi=n32
12054 @opindex mabi=64
12055 @opindex mabi=eabi
12056 Generate code for the given ABI@.
12058 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
12059 generates 64-bit code when you select a 64-bit architecture, but you
12060 can use @option{-mgp32} to get 32-bit code instead.
12062 For information about the O64 ABI, see
12063 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
12065 GCC supports a variant of the o32 ABI in which floating-point registers
12066 are 64 rather than 32 bits wide.  You can select this combination with
12067 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
12068 and @samp{mfhc1} instructions and is therefore only supported for
12069 MIPS32R2 processors.
12071 The register assignments for arguments and return values remain the
12072 same, but each scalar value is passed in a single 64-bit register
12073 rather than a pair of 32-bit registers.  For example, scalar
12074 floating-point values are returned in @samp{$f0} only, not a
12075 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
12076 remains the same, but all 64 bits are saved.
12078 @item -mabicalls
12079 @itemx -mno-abicalls
12080 @opindex mabicalls
12081 @opindex mno-abicalls
12082 Generate (do not generate) code that is suitable for SVR4-style
12083 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
12084 systems.
12086 @item -mshared
12087 @itemx -mno-shared
12088 Generate (do not generate) code that is fully position-independent,
12089 and that can therefore be linked into shared libraries.  This option
12090 only affects @option{-mabicalls}.
12092 All @option{-mabicalls} code has traditionally been position-independent,
12093 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
12094 as an extension, the GNU toolchain allows executables to use absolute
12095 accesses for locally-binding symbols.  It can also use shorter GP
12096 initialization sequences and generate direct calls to locally-defined
12097 functions.  This mode is selected by @option{-mno-shared}.
12099 @option{-mno-shared} depends on binutils 2.16 or higher and generates
12100 objects that can only be linked by the GNU linker.  However, the option
12101 does not affect the ABI of the final executable; it only affects the ABI
12102 of relocatable objects.  Using @option{-mno-shared} will generally make
12103 executables both smaller and quicker.
12105 @option{-mshared} is the default.
12107 @item -mxgot
12108 @itemx -mno-xgot
12109 @opindex mxgot
12110 @opindex mno-xgot
12111 Lift (do not lift) the usual restrictions on the size of the global
12112 offset table.
12114 GCC normally uses a single instruction to load values from the GOT@.
12115 While this is relatively efficient, it will only work if the GOT
12116 is smaller than about 64k.  Anything larger will cause the linker
12117 to report an error such as:
12119 @cindex relocation truncated to fit (MIPS)
12120 @smallexample
12121 relocation truncated to fit: R_MIPS_GOT16 foobar
12122 @end smallexample
12124 If this happens, you should recompile your code with @option{-mxgot}.
12125 It should then work with very large GOTs, although it will also be
12126 less efficient, since it will take three instructions to fetch the
12127 value of a global symbol.
12129 Note that some linkers can create multiple GOTs.  If you have such a
12130 linker, you should only need to use @option{-mxgot} when a single object
12131 file accesses more than 64k's worth of GOT entries.  Very few do.
12133 These options have no effect unless GCC is generating position
12134 independent code.
12136 @item -mgp32
12137 @opindex mgp32
12138 Assume that general-purpose registers are 32 bits wide.
12140 @item -mgp64
12141 @opindex mgp64
12142 Assume that general-purpose registers are 64 bits wide.
12144 @item -mfp32
12145 @opindex mfp32
12146 Assume that floating-point registers are 32 bits wide.
12148 @item -mfp64
12149 @opindex mfp64
12150 Assume that floating-point registers are 64 bits wide.
12152 @item -mhard-float
12153 @opindex mhard-float
12154 Use floating-point coprocessor instructions.
12156 @item -msoft-float
12157 @opindex msoft-float
12158 Do not use floating-point coprocessor instructions.  Implement
12159 floating-point calculations using library calls instead.
12161 @item -msingle-float
12162 @opindex msingle-float
12163 Assume that the floating-point coprocessor only supports single-precision
12164 operations.
12166 @item -mdouble-float
12167 @opindex mdouble-float
12168 Assume that the floating-point coprocessor supports double-precision
12169 operations.  This is the default.
12171 @item -mllsc
12172 @itemx -mno-llsc
12173 @opindex mllsc
12174 @opindex mno-llsc
12175 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
12176 implement atomic memory built-in functions.  When neither option is
12177 specified, GCC will use the instructions if the target architecture
12178 supports them.
12180 @option{-mllsc} is useful if the runtime environment can emulate the
12181 instructions and @option{-mno-llsc} can be useful when compiling for
12182 nonstandard ISAs.  You can make either option the default by
12183 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
12184 respectively.  @option{--with-llsc} is the default for some
12185 configurations; see the installation documentation for details.
12187 @item -mdsp
12188 @itemx -mno-dsp
12189 @opindex mdsp
12190 @opindex mno-dsp
12191 Use (do not use) revision 1 of the MIPS DSP ASE@.
12192 @xref{MIPS DSP Built-in Functions}.  This option defines the
12193 preprocessor macro @samp{__mips_dsp}.  It also defines
12194 @samp{__mips_dsp_rev} to 1.
12196 @item -mdspr2
12197 @itemx -mno-dspr2
12198 @opindex mdspr2
12199 @opindex mno-dspr2
12200 Use (do not use) revision 2 of the MIPS DSP ASE@.
12201 @xref{MIPS DSP Built-in Functions}.  This option defines the
12202 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
12203 It also defines @samp{__mips_dsp_rev} to 2.
12205 @item -msmartmips
12206 @itemx -mno-smartmips
12207 @opindex msmartmips
12208 @opindex mno-smartmips
12209 Use (do not use) the MIPS SmartMIPS ASE.
12211 @item -mpaired-single
12212 @itemx -mno-paired-single
12213 @opindex mpaired-single
12214 @opindex mno-paired-single
12215 Use (do not use) paired-single floating-point instructions.
12216 @xref{MIPS Paired-Single Support}.  This option requires
12217 hardware floating-point support to be enabled.
12219 @item -mdmx
12220 @itemx -mno-mdmx
12221 @opindex mdmx
12222 @opindex mno-mdmx
12223 Use (do not use) MIPS Digital Media Extension instructions.
12224 This option can only be used when generating 64-bit code and requires
12225 hardware floating-point support to be enabled.
12227 @item -mips3d
12228 @itemx -mno-mips3d
12229 @opindex mips3d
12230 @opindex mno-mips3d
12231 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
12232 The option @option{-mips3d} implies @option{-mpaired-single}.
12234 @item -mmt
12235 @itemx -mno-mt
12236 @opindex mmt
12237 @opindex mno-mt
12238 Use (do not use) MT Multithreading instructions.
12240 @item -mlong64
12241 @opindex mlong64
12242 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
12243 an explanation of the default and the way that the pointer size is
12244 determined.
12246 @item -mlong32
12247 @opindex mlong32
12248 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
12250 The default size of @code{int}s, @code{long}s and pointers depends on
12251 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
12252 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
12253 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
12254 or the same size as integer registers, whichever is smaller.
12256 @item -msym32
12257 @itemx -mno-sym32
12258 @opindex msym32
12259 @opindex mno-sym32
12260 Assume (do not assume) that all symbols have 32-bit values, regardless
12261 of the selected ABI@.  This option is useful in combination with
12262 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
12263 to generate shorter and faster references to symbolic addresses.
12265 @item -G @var{num}
12266 @opindex G
12267 Put definitions of externally-visible data in a small data section
12268 if that data is no bigger than @var{num} bytes.  GCC can then access
12269 the data more efficiently; see @option{-mgpopt} for details.
12271 The default @option{-G} option depends on the configuration.
12273 @item -mlocal-sdata
12274 @itemx -mno-local-sdata
12275 @opindex mlocal-sdata
12276 @opindex mno-local-sdata
12277 Extend (do not extend) the @option{-G} behavior to local data too,
12278 such as to static variables in C@.  @option{-mlocal-sdata} is the
12279 default for all configurations.
12281 If the linker complains that an application is using too much small data,
12282 you might want to try rebuilding the less performance-critical parts with
12283 @option{-mno-local-sdata}.  You might also want to build large
12284 libraries with @option{-mno-local-sdata}, so that the libraries leave
12285 more room for the main program.
12287 @item -mextern-sdata
12288 @itemx -mno-extern-sdata
12289 @opindex mextern-sdata
12290 @opindex mno-extern-sdata
12291 Assume (do not assume) that externally-defined data will be in
12292 a small data section if that data is within the @option{-G} limit.
12293 @option{-mextern-sdata} is the default for all configurations.
12295 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
12296 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
12297 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
12298 is placed in a small data section.  If @var{Var} is defined by another
12299 module, you must either compile that module with a high-enough
12300 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
12301 definition.  If @var{Var} is common, you must link the application
12302 with a high-enough @option{-G} setting.
12304 The easiest way of satisfying these restrictions is to compile
12305 and link every module with the same @option{-G} option.  However,
12306 you may wish to build a library that supports several different
12307 small data limits.  You can do this by compiling the library with
12308 the highest supported @option{-G} setting and additionally using
12309 @option{-mno-extern-sdata} to stop the library from making assumptions
12310 about externally-defined data.
12312 @item -mgpopt
12313 @itemx -mno-gpopt
12314 @opindex mgpopt
12315 @opindex mno-gpopt
12316 Use (do not use) GP-relative accesses for symbols that are known to be
12317 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
12318 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
12319 configurations.
12321 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
12322 might not hold the value of @code{_gp}.  For example, if the code is
12323 part of a library that might be used in a boot monitor, programs that
12324 call boot monitor routines will pass an unknown value in @code{$gp}.
12325 (In such situations, the boot monitor itself would usually be compiled
12326 with @option{-G0}.)
12328 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
12329 @option{-mno-extern-sdata}.
12331 @item -membedded-data
12332 @itemx -mno-embedded-data
12333 @opindex membedded-data
12334 @opindex mno-embedded-data
12335 Allocate variables to the read-only data section first if possible, then
12336 next in the small data section if possible, otherwise in data.  This gives
12337 slightly slower code than the default, but reduces the amount of RAM required
12338 when executing, and thus may be preferred for some embedded systems.
12340 @item -muninit-const-in-rodata
12341 @itemx -mno-uninit-const-in-rodata
12342 @opindex muninit-const-in-rodata
12343 @opindex mno-uninit-const-in-rodata
12344 Put uninitialized @code{const} variables in the read-only data section.
12345 This option is only meaningful in conjunction with @option{-membedded-data}.
12347 @item -mcode-readable=@var{setting}
12348 @opindex mcode-readable
12349 Specify whether GCC may generate code that reads from executable sections.
12350 There are three possible settings:
12352 @table @gcctabopt
12353 @item -mcode-readable=yes
12354 Instructions may freely access executable sections.  This is the
12355 default setting.
12357 @item -mcode-readable=pcrel
12358 MIPS16 PC-relative load instructions can access executable sections,
12359 but other instructions must not do so.  This option is useful on 4KSc
12360 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
12361 It is also useful on processors that can be configured to have a dual
12362 instruction/data SRAM interface and that, like the M4K, automatically
12363 redirect PC-relative loads to the instruction RAM.
12365 @item -mcode-readable=no
12366 Instructions must not access executable sections.  This option can be
12367 useful on targets that are configured to have a dual instruction/data
12368 SRAM interface but that (unlike the M4K) do not automatically redirect
12369 PC-relative loads to the instruction RAM.
12370 @end table
12372 @item -msplit-addresses
12373 @itemx -mno-split-addresses
12374 @opindex msplit-addresses
12375 @opindex mno-split-addresses
12376 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
12377 relocation operators.  This option has been superseded by
12378 @option{-mexplicit-relocs} but is retained for backwards compatibility.
12380 @item -mexplicit-relocs
12381 @itemx -mno-explicit-relocs
12382 @opindex mexplicit-relocs
12383 @opindex mno-explicit-relocs
12384 Use (do not use) assembler relocation operators when dealing with symbolic
12385 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
12386 is to use assembler macros instead.
12388 @option{-mexplicit-relocs} is the default if GCC was configured
12389 to use an assembler that supports relocation operators.
12391 @item -mcheck-zero-division
12392 @itemx -mno-check-zero-division
12393 @opindex mcheck-zero-division
12394 @opindex mno-check-zero-division
12395 Trap (do not trap) on integer division by zero.
12397 The default is @option{-mcheck-zero-division}.
12399 @item -mdivide-traps
12400 @itemx -mdivide-breaks
12401 @opindex mdivide-traps
12402 @opindex mdivide-breaks
12403 MIPS systems check for division by zero by generating either a
12404 conditional trap or a break instruction.  Using traps results in
12405 smaller code, but is only supported on MIPS II and later.  Also, some
12406 versions of the Linux kernel have a bug that prevents trap from
12407 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
12408 allow conditional traps on architectures that support them and
12409 @option{-mdivide-breaks} to force the use of breaks.
12411 The default is usually @option{-mdivide-traps}, but this can be
12412 overridden at configure time using @option{--with-divide=breaks}.
12413 Divide-by-zero checks can be completely disabled using
12414 @option{-mno-check-zero-division}.
12416 @item -mmemcpy
12417 @itemx -mno-memcpy
12418 @opindex mmemcpy
12419 @opindex mno-memcpy
12420 Force (do not force) the use of @code{memcpy()} for non-trivial block
12421 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
12422 most constant-sized copies.
12424 @item -mlong-calls
12425 @itemx -mno-long-calls
12426 @opindex mlong-calls
12427 @opindex mno-long-calls
12428 Disable (do not disable) use of the @code{jal} instruction.  Calling
12429 functions using @code{jal} is more efficient but requires the caller
12430 and callee to be in the same 256 megabyte segment.
12432 This option has no effect on abicalls code.  The default is
12433 @option{-mno-long-calls}.
12435 @item -mmad
12436 @itemx -mno-mad
12437 @opindex mmad
12438 @opindex mno-mad
12439 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
12440 instructions, as provided by the R4650 ISA@.
12442 @item -mfused-madd
12443 @itemx -mno-fused-madd
12444 @opindex mfused-madd
12445 @opindex mno-fused-madd
12446 Enable (disable) use of the floating point multiply-accumulate
12447 instructions, when they are available.  The default is
12448 @option{-mfused-madd}.
12450 When multiply-accumulate instructions are used, the intermediate
12451 product is calculated to infinite precision and is not subject to
12452 the FCSR Flush to Zero bit.  This may be undesirable in some
12453 circumstances.
12455 @item -nocpp
12456 @opindex nocpp
12457 Tell the MIPS assembler to not run its preprocessor over user
12458 assembler files (with a @samp{.s} suffix) when assembling them.
12460 @item -mfix-r4000
12461 @itemx -mno-fix-r4000
12462 @opindex mfix-r4000
12463 @opindex mno-fix-r4000
12464 Work around certain R4000 CPU errata:
12465 @itemize @minus
12466 @item
12467 A double-word or a variable shift may give an incorrect result if executed
12468 immediately after starting an integer division.
12469 @item
12470 A double-word or a variable shift may give an incorrect result if executed
12471 while an integer multiplication is in progress.
12472 @item
12473 An integer division may give an incorrect result if started in a delay slot
12474 of a taken branch or a jump.
12475 @end itemize
12477 @item -mfix-r4400
12478 @itemx -mno-fix-r4400
12479 @opindex mfix-r4400
12480 @opindex mno-fix-r4400
12481 Work around certain R4400 CPU errata:
12482 @itemize @minus
12483 @item
12484 A double-word or a variable shift may give an incorrect result if executed
12485 immediately after starting an integer division.
12486 @end itemize
12488 @item -mfix-vr4120
12489 @itemx -mno-fix-vr4120
12490 @opindex mfix-vr4120
12491 Work around certain VR4120 errata:
12492 @itemize @minus
12493 @item
12494 @code{dmultu} does not always produce the correct result.
12495 @item
12496 @code{div} and @code{ddiv} do not always produce the correct result if one
12497 of the operands is negative.
12498 @end itemize
12499 The workarounds for the division errata rely on special functions in
12500 @file{libgcc.a}.  At present, these functions are only provided by
12501 the @code{mips64vr*-elf} configurations.
12503 Other VR4120 errata require a nop to be inserted between certain pairs of
12504 instructions.  These errata are handled by the assembler, not by GCC itself.
12506 @item -mfix-vr4130
12507 @opindex mfix-vr4130
12508 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12509 workarounds are implemented by the assembler rather than by GCC,
12510 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12511 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12512 instructions are available instead.
12514 @item -mfix-sb1
12515 @itemx -mno-fix-sb1
12516 @opindex mfix-sb1
12517 Work around certain SB-1 CPU core errata.
12518 (This flag currently works around the SB-1 revision 2
12519 ``F1'' and ``F2'' floating point errata.)
12521 @item -mflush-func=@var{func}
12522 @itemx -mno-flush-func
12523 @opindex mflush-func
12524 Specifies the function to call to flush the I and D caches, or to not
12525 call any such function.  If called, the function must take the same
12526 arguments as the common @code{_flush_func()}, that is, the address of the
12527 memory range for which the cache is being flushed, the size of the
12528 memory range, and the number 3 (to flush both caches).  The default
12529 depends on the target GCC was configured for, but commonly is either
12530 @samp{_flush_func} or @samp{__cpu_flush}.
12532 @item mbranch-cost=@var{num}
12533 @opindex mbranch-cost
12534 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12535 This cost is only a heuristic and is not guaranteed to produce
12536 consistent results across releases.  A zero cost redundantly selects
12537 the default, which is based on the @option{-mtune} setting.
12539 @item -mbranch-likely
12540 @itemx -mno-branch-likely
12541 @opindex mbranch-likely
12542 @opindex mno-branch-likely
12543 Enable or disable use of Branch Likely instructions, regardless of the
12544 default for the selected architecture.  By default, Branch Likely
12545 instructions may be generated if they are supported by the selected
12546 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12547 and processors which implement those architectures; for those, Branch
12548 Likely instructions will not be generated by default because the MIPS32
12549 and MIPS64 architectures specifically deprecate their use.
12551 @item -mfp-exceptions
12552 @itemx -mno-fp-exceptions
12553 @opindex mfp-exceptions
12554 Specifies whether FP exceptions are enabled.  This affects how we schedule
12555 FP instructions for some processors.  The default is that FP exceptions are
12556 enabled.
12558 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12559 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12560 FP pipe.
12562 @item -mvr4130-align
12563 @itemx -mno-vr4130-align
12564 @opindex mvr4130-align
12565 The VR4130 pipeline is two-way superscalar, but can only issue two
12566 instructions together if the first one is 8-byte aligned.  When this
12567 option is enabled, GCC will align pairs of instructions that it
12568 thinks should execute in parallel.
12570 This option only has an effect when optimizing for the VR4130.
12571 It normally makes code faster, but at the expense of making it bigger.
12572 It is enabled by default at optimization level @option{-O3}.
12573 @end table
12575 @node MMIX Options
12576 @subsection MMIX Options
12577 @cindex MMIX Options
12579 These options are defined for the MMIX:
12581 @table @gcctabopt
12582 @item -mlibfuncs
12583 @itemx -mno-libfuncs
12584 @opindex mlibfuncs
12585 @opindex mno-libfuncs
12586 Specify that intrinsic library functions are being compiled, passing all
12587 values in registers, no matter the size.
12589 @item -mepsilon
12590 @itemx -mno-epsilon
12591 @opindex mepsilon
12592 @opindex mno-epsilon
12593 Generate floating-point comparison instructions that compare with respect
12594 to the @code{rE} epsilon register.
12596 @item -mabi=mmixware
12597 @itemx -mabi=gnu
12598 @opindex mabi-mmixware
12599 @opindex mabi=gnu
12600 Generate code that passes function parameters and return values that (in
12601 the called function) are seen as registers @code{$0} and up, as opposed to
12602 the GNU ABI which uses global registers @code{$231} and up.
12604 @item -mzero-extend
12605 @itemx -mno-zero-extend
12606 @opindex mzero-extend
12607 @opindex mno-zero-extend
12608 When reading data from memory in sizes shorter than 64 bits, use (do not
12609 use) zero-extending load instructions by default, rather than
12610 sign-extending ones.
12612 @item -mknuthdiv
12613 @itemx -mno-knuthdiv
12614 @opindex mknuthdiv
12615 @opindex mno-knuthdiv
12616 Make the result of a division yielding a remainder have the same sign as
12617 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12618 remainder follows the sign of the dividend.  Both methods are
12619 arithmetically valid, the latter being almost exclusively used.
12621 @item -mtoplevel-symbols
12622 @itemx -mno-toplevel-symbols
12623 @opindex mtoplevel-symbols
12624 @opindex mno-toplevel-symbols
12625 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12626 code can be used with the @code{PREFIX} assembly directive.
12628 @item -melf
12629 @opindex melf
12630 Generate an executable in the ELF format, rather than the default
12631 @samp{mmo} format used by the @command{mmix} simulator.
12633 @item -mbranch-predict
12634 @itemx -mno-branch-predict
12635 @opindex mbranch-predict
12636 @opindex mno-branch-predict
12637 Use (do not use) the probable-branch instructions, when static branch
12638 prediction indicates a probable branch.
12640 @item -mbase-addresses
12641 @itemx -mno-base-addresses
12642 @opindex mbase-addresses
12643 @opindex mno-base-addresses
12644 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12645 base address automatically generates a request (handled by the assembler
12646 and the linker) for a constant to be set up in a global register.  The
12647 register is used for one or more base address requests within the range 0
12648 to 255 from the value held in the register.  The generally leads to short
12649 and fast code, but the number of different data items that can be
12650 addressed is limited.  This means that a program that uses lots of static
12651 data may require @option{-mno-base-addresses}.
12653 @item -msingle-exit
12654 @itemx -mno-single-exit
12655 @opindex msingle-exit
12656 @opindex mno-single-exit
12657 Force (do not force) generated code to have a single exit point in each
12658 function.
12659 @end table
12661 @node MN10300 Options
12662 @subsection MN10300 Options
12663 @cindex MN10300 options
12665 These @option{-m} options are defined for Matsushita MN10300 architectures:
12667 @table @gcctabopt
12668 @item -mmult-bug
12669 @opindex mmult-bug
12670 Generate code to avoid bugs in the multiply instructions for the MN10300
12671 processors.  This is the default.
12673 @item -mno-mult-bug
12674 @opindex mno-mult-bug
12675 Do not generate code to avoid bugs in the multiply instructions for the
12676 MN10300 processors.
12678 @item -mam33
12679 @opindex mam33
12680 Generate code which uses features specific to the AM33 processor.
12682 @item -mno-am33
12683 @opindex mno-am33
12684 Do not generate code which uses features specific to the AM33 processor.  This
12685 is the default.
12687 @item -mreturn-pointer-on-d0
12688 @opindex mreturn-pointer-on-d0
12689 When generating a function which returns a pointer, return the pointer
12690 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12691 only in a0, and attempts to call such functions without a prototype
12692 would result in errors.  Note that this option is on by default; use
12693 @option{-mno-return-pointer-on-d0} to disable it.
12695 @item -mno-crt0
12696 @opindex mno-crt0
12697 Do not link in the C run-time initialization object file.
12699 @item -mrelax
12700 @opindex mrelax
12701 Indicate to the linker that it should perform a relaxation optimization pass
12702 to shorten branches, calls and absolute memory addresses.  This option only
12703 has an effect when used on the command line for the final link step.
12705 This option makes symbolic debugging impossible.
12706 @end table
12708 @node MT Options
12709 @subsection MT Options
12710 @cindex MT options
12712 These @option{-m} options are defined for Morpho MT architectures:
12714 @table @gcctabopt
12716 @item -march=@var{cpu-type}
12717 @opindex march
12718 Generate code that will run on @var{cpu-type}, which is the name of a system
12719 representing a certain processor type.  Possible values for
12720 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12721 @samp{ms1-16-003} and @samp{ms2}.
12723 When this option is not used, the default is @option{-march=ms1-16-002}.
12725 @item -mbacc
12726 @opindex mbacc
12727 Use byte loads and stores when generating code.
12729 @item -mno-bacc
12730 @opindex mno-bacc
12731 Do not use byte loads and stores when generating code.
12733 @item -msim
12734 @opindex msim
12735 Use simulator runtime
12737 @item -mno-crt0
12738 @opindex mno-crt0
12739 Do not link in the C run-time initialization object file
12740 @file{crti.o}.  Other run-time initialization and termination files
12741 such as @file{startup.o} and @file{exit.o} are still included on the
12742 linker command line.
12744 @end table
12746 @node PDP-11 Options
12747 @subsection PDP-11 Options
12748 @cindex PDP-11 Options
12750 These options are defined for the PDP-11:
12752 @table @gcctabopt
12753 @item -mfpu
12754 @opindex mfpu
12755 Use hardware FPP floating point.  This is the default.  (FIS floating
12756 point on the PDP-11/40 is not supported.)
12758 @item -msoft-float
12759 @opindex msoft-float
12760 Do not use hardware floating point.
12762 @item -mac0
12763 @opindex mac0
12764 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12766 @item -mno-ac0
12767 @opindex mno-ac0
12768 Return floating-point results in memory.  This is the default.
12770 @item -m40
12771 @opindex m40
12772 Generate code for a PDP-11/40.
12774 @item -m45
12775 @opindex m45
12776 Generate code for a PDP-11/45.  This is the default.
12778 @item -m10
12779 @opindex m10
12780 Generate code for a PDP-11/10.
12782 @item -mbcopy-builtin
12783 @opindex bcopy-builtin
12784 Use inline @code{movmemhi} patterns for copying memory.  This is the
12785 default.
12787 @item -mbcopy
12788 @opindex mbcopy
12789 Do not use inline @code{movmemhi} patterns for copying memory.
12791 @item -mint16
12792 @itemx -mno-int32
12793 @opindex mint16
12794 @opindex mno-int32
12795 Use 16-bit @code{int}.  This is the default.
12797 @item -mint32
12798 @itemx -mno-int16
12799 @opindex mint32
12800 @opindex mno-int16
12801 Use 32-bit @code{int}.
12803 @item -mfloat64
12804 @itemx -mno-float32
12805 @opindex mfloat64
12806 @opindex mno-float32
12807 Use 64-bit @code{float}.  This is the default.
12809 @item -mfloat32
12810 @itemx -mno-float64
12811 @opindex mfloat32
12812 @opindex mno-float64
12813 Use 32-bit @code{float}.
12815 @item -mabshi
12816 @opindex mabshi
12817 Use @code{abshi2} pattern.  This is the default.
12819 @item -mno-abshi
12820 @opindex mno-abshi
12821 Do not use @code{abshi2} pattern.
12823 @item -mbranch-expensive
12824 @opindex mbranch-expensive
12825 Pretend that branches are expensive.  This is for experimenting with
12826 code generation only.
12828 @item -mbranch-cheap
12829 @opindex mbranch-cheap
12830 Do not pretend that branches are expensive.  This is the default.
12832 @item -msplit
12833 @opindex msplit
12834 Generate code for a system with split I&D@.
12836 @item -mno-split
12837 @opindex mno-split
12838 Generate code for a system without split I&D@.  This is the default.
12840 @item -munix-asm
12841 @opindex munix-asm
12842 Use Unix assembler syntax.  This is the default when configured for
12843 @samp{pdp11-*-bsd}.
12845 @item -mdec-asm
12846 @opindex mdec-asm
12847 Use DEC assembler syntax.  This is the default when configured for any
12848 PDP-11 target other than @samp{pdp11-*-bsd}.
12849 @end table
12851 @node PowerPC Options
12852 @subsection PowerPC Options
12853 @cindex PowerPC options
12855 These are listed under @xref{RS/6000 and PowerPC Options}.
12857 @node RS/6000 and PowerPC Options
12858 @subsection IBM RS/6000 and PowerPC Options
12859 @cindex RS/6000 and PowerPC Options
12860 @cindex IBM RS/6000 and PowerPC Options
12862 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12863 @table @gcctabopt
12864 @item -mpower
12865 @itemx -mno-power
12866 @itemx -mpower2
12867 @itemx -mno-power2
12868 @itemx -mpowerpc
12869 @itemx -mno-powerpc
12870 @itemx -mpowerpc-gpopt
12871 @itemx -mno-powerpc-gpopt
12872 @itemx -mpowerpc-gfxopt
12873 @itemx -mno-powerpc-gfxopt
12874 @itemx -mpowerpc64
12875 @itemx -mno-powerpc64
12876 @itemx -mmfcrf
12877 @itemx -mno-mfcrf
12878 @itemx -mpopcntb
12879 @itemx -mno-popcntb
12880 @itemx -mfprnd
12881 @itemx -mno-fprnd
12882 @itemx -mcmpb
12883 @itemx -mno-cmpb
12884 @itemx -mmfpgpr
12885 @itemx -mno-mfpgpr
12886 @itemx -mhard-dfp
12887 @itemx -mno-hard-dfp
12888 @opindex mpower
12889 @opindex mno-power
12890 @opindex mpower2
12891 @opindex mno-power2
12892 @opindex mpowerpc
12893 @opindex mno-powerpc
12894 @opindex mpowerpc-gpopt
12895 @opindex mno-powerpc-gpopt
12896 @opindex mpowerpc-gfxopt
12897 @opindex mno-powerpc-gfxopt
12898 @opindex mpowerpc64
12899 @opindex mno-powerpc64
12900 @opindex mmfcrf
12901 @opindex mno-mfcrf
12902 @opindex mpopcntb
12903 @opindex mno-popcntb
12904 @opindex mfprnd
12905 @opindex mno-fprnd
12906 @opindex mcmpb
12907 @opindex mno-cmpb
12908 @opindex mmfpgpr
12909 @opindex mno-mfpgpr
12910 @opindex mhard-dfp
12911 @opindex mno-hard-dfp
12912 GCC supports two related instruction set architectures for the
12913 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12914 instructions supported by the @samp{rios} chip set used in the original
12915 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12916 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12917 the IBM 4xx, 6xx, and follow-on microprocessors.
12919 Neither architecture is a subset of the other.  However there is a
12920 large common subset of instructions supported by both.  An MQ
12921 register is included in processors supporting the POWER architecture.
12923 You use these options to specify which instructions are available on the
12924 processor you are using.  The default value of these options is
12925 determined when configuring GCC@.  Specifying the
12926 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12927 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12928 rather than the options listed above.
12930 The @option{-mpower} option allows GCC to generate instructions that
12931 are found only in the POWER architecture and to use the MQ register.
12932 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12933 to generate instructions that are present in the POWER2 architecture but
12934 not the original POWER architecture.
12936 The @option{-mpowerpc} option allows GCC to generate instructions that
12937 are found only in the 32-bit subset of the PowerPC architecture.
12938 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12939 GCC to use the optional PowerPC architecture instructions in the
12940 General Purpose group, including floating-point square root.  Specifying
12941 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12942 use the optional PowerPC architecture instructions in the Graphics
12943 group, including floating-point select.
12945 The @option{-mmfcrf} option allows GCC to generate the move from
12946 condition register field instruction implemented on the POWER4
12947 processor and other processors that support the PowerPC V2.01
12948 architecture.
12949 The @option{-mpopcntb} option allows GCC to generate the popcount and
12950 double precision FP reciprocal estimate instruction implemented on the
12951 POWER5 processor and other processors that support the PowerPC V2.02
12952 architecture.
12953 The @option{-mfprnd} option allows GCC to generate the FP round to
12954 integer instructions implemented on the POWER5+ processor and other
12955 processors that support the PowerPC V2.03 architecture.
12956 The @option{-mcmpb} option allows GCC to generate the compare bytes
12957 instruction implemented on the POWER6 processor and other processors
12958 that support the PowerPC V2.05 architecture.
12959 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12960 general purpose register instructions implemented on the POWER6X
12961 processor and other processors that support the extended PowerPC V2.05
12962 architecture.
12963 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
12964 point instructions implemented on some POWER processors.
12966 The @option{-mpowerpc64} option allows GCC to generate the additional
12967 64-bit instructions that are found in the full PowerPC64 architecture
12968 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12969 @option{-mno-powerpc64}.
12971 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12972 will use only the instructions in the common subset of both
12973 architectures plus some special AIX common-mode calls, and will not use
12974 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12975 permits GCC to use any instruction from either architecture and to
12976 allow use of the MQ register; specify this for the Motorola MPC601.
12978 @item -mnew-mnemonics
12979 @itemx -mold-mnemonics
12980 @opindex mnew-mnemonics
12981 @opindex mold-mnemonics
12982 Select which mnemonics to use in the generated assembler code.  With
12983 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12984 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12985 assembler mnemonics defined for the POWER architecture.  Instructions
12986 defined in only one architecture have only one mnemonic; GCC uses that
12987 mnemonic irrespective of which of these options is specified.
12989 GCC defaults to the mnemonics appropriate for the architecture in
12990 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12991 value of these option.  Unless you are building a cross-compiler, you
12992 should normally not specify either @option{-mnew-mnemonics} or
12993 @option{-mold-mnemonics}, but should instead accept the default.
12995 @item -mcpu=@var{cpu_type}
12996 @opindex mcpu
12997 Set architecture type, register usage, choice of mnemonics, and
12998 instruction scheduling parameters for machine type @var{cpu_type}.
12999 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
13000 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
13001 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
13002 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
13003 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
13004 @samp{860}, @samp{970}, @samp{8540}, @samp{e300c2}, @samp{e300c3},
13005 @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, @samp{power},
13006 @samp{power2}, @samp{power3}, @samp{power4}, @samp{power5},
13007 @samp{power5+}, @samp{power6}, @samp{power6x}, @samp{common},
13008 @samp{powerpc}, @samp{powerpc64}, @samp{rios}, @samp{rios1},
13009 @samp{rios2}, @samp{rsc}, and @samp{rs64}.
13011 @option{-mcpu=common} selects a completely generic processor.  Code
13012 generated under this option will run on any POWER or PowerPC processor.
13013 GCC will use only the instructions in the common subset of both
13014 architectures, and will not use the MQ register.  GCC assumes a generic
13015 processor model for scheduling purposes.
13017 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
13018 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
13019 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
13020 types, with an appropriate, generic processor model assumed for
13021 scheduling purposes.
13023 The other options specify a specific processor.  Code generated under
13024 those options will run best on that processor, and may not run at all on
13025 others.
13027 The @option{-mcpu} options automatically enable or disable the
13028 following options:
13030 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
13031 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
13032 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
13034 The particular options set for any particular CPU will vary between
13035 compiler versions, depending on what setting seems to produce optimal
13036 code for that CPU; it doesn't necessarily reflect the actual hardware's
13037 capabilities.  If you wish to set an individual option to a particular
13038 value, you may specify it after the @option{-mcpu} option, like
13039 @samp{-mcpu=970 -mno-altivec}.
13041 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
13042 not enabled or disabled by the @option{-mcpu} option at present because
13043 AIX does not have full support for these options.  You may still
13044 enable or disable them individually if you're sure it'll work in your
13045 environment.
13047 @item -mtune=@var{cpu_type}
13048 @opindex mtune
13049 Set the instruction scheduling parameters for machine type
13050 @var{cpu_type}, but do not set the architecture type, register usage, or
13051 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
13052 values for @var{cpu_type} are used for @option{-mtune} as for
13053 @option{-mcpu}.  If both are specified, the code generated will use the
13054 architecture, registers, and mnemonics set by @option{-mcpu}, but the
13055 scheduling parameters set by @option{-mtune}.
13057 @item -mswdiv
13058 @itemx -mno-swdiv
13059 @opindex mswdiv
13060 @opindex mno-swdiv
13061 Generate code to compute division as reciprocal estimate and iterative
13062 refinement, creating opportunities for increased throughput.  This
13063 feature requires: optional PowerPC Graphics instruction set for single
13064 precision and FRE instruction for double precision, assuming divides
13065 cannot generate user-visible traps, and the domain values not include
13066 Infinities, denormals or zero denominator.
13068 @item -maltivec
13069 @itemx -mno-altivec
13070 @opindex maltivec
13071 @opindex mno-altivec
13072 Generate code that uses (does not use) AltiVec instructions, and also
13073 enable the use of built-in functions that allow more direct access to
13074 the AltiVec instruction set.  You may also need to set
13075 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
13076 enhancements.
13078 @item -mvrsave
13079 @itemx -mno-vrsave
13080 @opindex mvrsave
13081 @opindex mno-vrsave
13082 Generate VRSAVE instructions when generating AltiVec code.
13084 @item -msecure-plt
13085 @opindex msecure-plt
13086 Generate code that allows ld and ld.so to build executables and shared
13087 libraries with non-exec .plt and .got sections.  This is a PowerPC
13088 32-bit SYSV ABI option.
13090 @item -mbss-plt
13091 @opindex mbss-plt
13092 Generate code that uses a BSS .plt section that ld.so fills in, and
13093 requires .plt and .got sections that are both writable and executable.
13094 This is a PowerPC 32-bit SYSV ABI option.
13096 @item -misel
13097 @itemx -mno-isel
13098 @opindex misel
13099 @opindex mno-isel
13100 This switch enables or disables the generation of ISEL instructions.
13102 @item -misel=@var{yes/no}
13103 This switch has been deprecated.  Use @option{-misel} and
13104 @option{-mno-isel} instead.
13106 @item -mspe
13107 @itemx -mno-spe
13108 @opindex mspe
13109 @opindex mno-spe
13110 This switch enables or disables the generation of SPE simd
13111 instructions.
13113 @item -mpaired
13114 @itemx -mno-paired
13115 @opindex mpaired
13116 @opindex mno-paired
13117 This switch enables or disables the generation of PAIRED simd
13118 instructions.
13120 @item -mspe=@var{yes/no}
13121 This option has been deprecated.  Use @option{-mspe} and
13122 @option{-mno-spe} instead.
13124 @item -mfloat-gprs=@var{yes/single/double/no}
13125 @itemx -mfloat-gprs
13126 @opindex mfloat-gprs
13127 This switch enables or disables the generation of floating point
13128 operations on the general purpose registers for architectures that
13129 support it.
13131 The argument @var{yes} or @var{single} enables the use of
13132 single-precision floating point operations.
13134 The argument @var{double} enables the use of single and
13135 double-precision floating point operations.
13137 The argument @var{no} disables floating point operations on the
13138 general purpose registers.
13140 This option is currently only available on the MPC854x.
13142 @item -m32
13143 @itemx -m64
13144 @opindex m32
13145 @opindex m64
13146 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
13147 targets (including GNU/Linux).  The 32-bit environment sets int, long
13148 and pointer to 32 bits and generates code that runs on any PowerPC
13149 variant.  The 64-bit environment sets int to 32 bits and long and
13150 pointer to 64 bits, and generates code for PowerPC64, as for
13151 @option{-mpowerpc64}.
13153 @item -mfull-toc
13154 @itemx -mno-fp-in-toc
13155 @itemx -mno-sum-in-toc
13156 @itemx -mminimal-toc
13157 @opindex mfull-toc
13158 @opindex mno-fp-in-toc
13159 @opindex mno-sum-in-toc
13160 @opindex mminimal-toc
13161 Modify generation of the TOC (Table Of Contents), which is created for
13162 every executable file.  The @option{-mfull-toc} option is selected by
13163 default.  In that case, GCC will allocate at least one TOC entry for
13164 each unique non-automatic variable reference in your program.  GCC
13165 will also place floating-point constants in the TOC@.  However, only
13166 16,384 entries are available in the TOC@.
13168 If you receive a linker error message that saying you have overflowed
13169 the available TOC space, you can reduce the amount of TOC space used
13170 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
13171 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
13172 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
13173 generate code to calculate the sum of an address and a constant at
13174 run-time instead of putting that sum into the TOC@.  You may specify one
13175 or both of these options.  Each causes GCC to produce very slightly
13176 slower and larger code at the expense of conserving TOC space.
13178 If you still run out of space in the TOC even when you specify both of
13179 these options, specify @option{-mminimal-toc} instead.  This option causes
13180 GCC to make only one TOC entry for every file.  When you specify this
13181 option, GCC will produce code that is slower and larger but which
13182 uses extremely little TOC space.  You may wish to use this option
13183 only on files that contain less frequently executed code.
13185 @item -maix64
13186 @itemx -maix32
13187 @opindex maix64
13188 @opindex maix32
13189 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
13190 @code{long} type, and the infrastructure needed to support them.
13191 Specifying @option{-maix64} implies @option{-mpowerpc64} and
13192 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
13193 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
13195 @item -mxl-compat
13196 @itemx -mno-xl-compat
13197 @opindex mxl-compat
13198 @opindex mno-xl-compat
13199 Produce code that conforms more closely to IBM XL compiler semantics
13200 when using AIX-compatible ABI@.  Pass floating-point arguments to
13201 prototyped functions beyond the register save area (RSA) on the stack
13202 in addition to argument FPRs.  Do not assume that most significant
13203 double in 128-bit long double value is properly rounded when comparing
13204 values and converting to double.  Use XL symbol names for long double
13205 support routines.
13207 The AIX calling convention was extended but not initially documented to
13208 handle an obscure K&R C case of calling a function that takes the
13209 address of its arguments with fewer arguments than declared.  IBM XL
13210 compilers access floating point arguments which do not fit in the
13211 RSA from the stack when a subroutine is compiled without
13212 optimization.  Because always storing floating-point arguments on the
13213 stack is inefficient and rarely needed, this option is not enabled by
13214 default and only is necessary when calling subroutines compiled by IBM
13215 XL compilers without optimization.
13217 @item -mpe
13218 @opindex mpe
13219 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
13220 application written to use message passing with special startup code to
13221 enable the application to run.  The system must have PE installed in the
13222 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
13223 must be overridden with the @option{-specs=} option to specify the
13224 appropriate directory location.  The Parallel Environment does not
13225 support threads, so the @option{-mpe} option and the @option{-pthread}
13226 option are incompatible.
13228 @item -malign-natural
13229 @itemx -malign-power
13230 @opindex malign-natural
13231 @opindex malign-power
13232 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
13233 @option{-malign-natural} overrides the ABI-defined alignment of larger
13234 types, such as floating-point doubles, on their natural size-based boundary.
13235 The option @option{-malign-power} instructs GCC to follow the ABI-specified
13236 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
13238 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
13239 is not supported.
13241 @item -msoft-float
13242 @itemx -mhard-float
13243 @opindex msoft-float
13244 @opindex mhard-float
13245 Generate code that does not use (uses) the floating-point register set.
13246 Software floating point emulation is provided if you use the
13247 @option{-msoft-float} option, and pass the option to GCC when linking.
13249 @item -mmultiple
13250 @itemx -mno-multiple
13251 @opindex mmultiple
13252 @opindex mno-multiple
13253 Generate code that uses (does not use) the load multiple word
13254 instructions and the store multiple word instructions.  These
13255 instructions are generated by default on POWER systems, and not
13256 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
13257 endian PowerPC systems, since those instructions do not work when the
13258 processor is in little endian mode.  The exceptions are PPC740 and
13259 PPC750 which permit the instructions usage in little endian mode.
13261 @item -mstring
13262 @itemx -mno-string
13263 @opindex mstring
13264 @opindex mno-string
13265 Generate code that uses (does not use) the load string instructions
13266 and the store string word instructions to save multiple registers and
13267 do small block moves.  These instructions are generated by default on
13268 POWER systems, and not generated on PowerPC systems.  Do not use
13269 @option{-mstring} on little endian PowerPC systems, since those
13270 instructions do not work when the processor is in little endian mode.
13271 The exceptions are PPC740 and PPC750 which permit the instructions
13272 usage in little endian mode.
13274 @item -mupdate
13275 @itemx -mno-update
13276 @opindex mupdate
13277 @opindex mno-update
13278 Generate code that uses (does not use) the load or store instructions
13279 that update the base register to the address of the calculated memory
13280 location.  These instructions are generated by default.  If you use
13281 @option{-mno-update}, there is a small window between the time that the
13282 stack pointer is updated and the address of the previous frame is
13283 stored, which means code that walks the stack frame across interrupts or
13284 signals may get corrupted data.
13286 @item -mfused-madd
13287 @itemx -mno-fused-madd
13288 @opindex mfused-madd
13289 @opindex mno-fused-madd
13290 Generate code that uses (does not use) the floating point multiply and
13291 accumulate instructions.  These instructions are generated by default if
13292 hardware floating is used.
13294 @item -mmulhw
13295 @itemx -mno-mulhw
13296 @opindex mmulhw
13297 @opindex mno-mulhw
13298 Generate code that uses (does not use) the half-word multiply and
13299 multiply-accumulate instructions on the IBM 405 and 440 processors.
13300 These instructions are generated by default when targetting those
13301 processors.
13303 @item -mdlmzb
13304 @itemx -mno-dlmzb
13305 @opindex mdlmzb
13306 @opindex mno-dlmzb
13307 Generate code that uses (does not use) the string-search @samp{dlmzb}
13308 instruction on the IBM 405 and 440 processors.  This instruction is
13309 generated by default when targetting those processors.
13311 @item -mno-bit-align
13312 @itemx -mbit-align
13313 @opindex mno-bit-align
13314 @opindex mbit-align
13315 On System V.4 and embedded PowerPC systems do not (do) force structures
13316 and unions that contain bit-fields to be aligned to the base type of the
13317 bit-field.
13319 For example, by default a structure containing nothing but 8
13320 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
13321 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
13322 the structure would be aligned to a 1 byte boundary and be one byte in
13323 size.
13325 @item -mno-strict-align
13326 @itemx -mstrict-align
13327 @opindex mno-strict-align
13328 @opindex mstrict-align
13329 On System V.4 and embedded PowerPC systems do not (do) assume that
13330 unaligned memory references will be handled by the system.
13332 @item -mrelocatable
13333 @itemx -mno-relocatable
13334 @opindex mrelocatable
13335 @opindex mno-relocatable
13336 On embedded PowerPC systems generate code that allows (does not allow)
13337 the program to be relocated to a different address at runtime.  If you
13338 use @option{-mrelocatable} on any module, all objects linked together must
13339 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
13341 @item -mrelocatable-lib
13342 @itemx -mno-relocatable-lib
13343 @opindex mrelocatable-lib
13344 @opindex mno-relocatable-lib
13345 On embedded PowerPC systems generate code that allows (does not allow)
13346 the program to be relocated to a different address at runtime.  Modules
13347 compiled with @option{-mrelocatable-lib} can be linked with either modules
13348 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
13349 with modules compiled with the @option{-mrelocatable} options.
13351 @item -mno-toc
13352 @itemx -mtoc
13353 @opindex mno-toc
13354 @opindex mtoc
13355 On System V.4 and embedded PowerPC systems do not (do) assume that
13356 register 2 contains a pointer to a global area pointing to the addresses
13357 used in the program.
13359 @item -mlittle
13360 @itemx -mlittle-endian
13361 @opindex mlittle
13362 @opindex mlittle-endian
13363 On System V.4 and embedded PowerPC systems compile code for the
13364 processor in little endian mode.  The @option{-mlittle-endian} option is
13365 the same as @option{-mlittle}.
13367 @item -mbig
13368 @itemx -mbig-endian
13369 @opindex mbig
13370 @opindex mbig-endian
13371 On System V.4 and embedded PowerPC systems compile code for the
13372 processor in big endian mode.  The @option{-mbig-endian} option is
13373 the same as @option{-mbig}.
13375 @item -mdynamic-no-pic
13376 @opindex mdynamic-no-pic
13377 On Darwin and Mac OS X systems, compile code so that it is not
13378 relocatable, but that its external references are relocatable.  The
13379 resulting code is suitable for applications, but not shared
13380 libraries.
13382 @item -mprioritize-restricted-insns=@var{priority}
13383 @opindex mprioritize-restricted-insns
13384 This option controls the priority that is assigned to
13385 dispatch-slot restricted instructions during the second scheduling
13386 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
13387 @var{no/highest/second-highest} priority to dispatch slot restricted
13388 instructions.
13390 @item -msched-costly-dep=@var{dependence_type}
13391 @opindex msched-costly-dep
13392 This option controls which dependences are considered costly
13393 by the target during instruction scheduling.  The argument
13394 @var{dependence_type} takes one of the following values:
13395 @var{no}: no dependence is costly,
13396 @var{all}: all dependences are costly,
13397 @var{true_store_to_load}: a true dependence from store to load is costly,
13398 @var{store_to_load}: any dependence from store to load is costly,
13399 @var{number}: any dependence which latency >= @var{number} is costly.
13401 @item -minsert-sched-nops=@var{scheme}
13402 @opindex minsert-sched-nops
13403 This option controls which nop insertion scheme will be used during
13404 the second scheduling pass.  The argument @var{scheme} takes one of the
13405 following values:
13406 @var{no}: Don't insert nops.
13407 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
13408 according to the scheduler's grouping.
13409 @var{regroup_exact}: Insert nops to force costly dependent insns into
13410 separate groups.  Insert exactly as many nops as needed to force an insn
13411 to a new group, according to the estimated processor grouping.
13412 @var{number}: Insert nops to force costly dependent insns into
13413 separate groups.  Insert @var{number} nops to force an insn to a new group.
13415 @item -mcall-sysv
13416 @opindex mcall-sysv
13417 On System V.4 and embedded PowerPC systems compile code using calling
13418 conventions that adheres to the March 1995 draft of the System V
13419 Application Binary Interface, PowerPC processor supplement.  This is the
13420 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
13422 @item -mcall-sysv-eabi
13423 @opindex mcall-sysv-eabi
13424 Specify both @option{-mcall-sysv} and @option{-meabi} options.
13426 @item -mcall-sysv-noeabi
13427 @opindex mcall-sysv-noeabi
13428 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
13430 @item -mcall-solaris
13431 @opindex mcall-solaris
13432 On System V.4 and embedded PowerPC systems compile code for the Solaris
13433 operating system.
13435 @item -mcall-linux
13436 @opindex mcall-linux
13437 On System V.4 and embedded PowerPC systems compile code for the
13438 Linux-based GNU system.
13440 @item -mcall-gnu
13441 @opindex mcall-gnu
13442 On System V.4 and embedded PowerPC systems compile code for the
13443 Hurd-based GNU system.
13445 @item -mcall-netbsd
13446 @opindex mcall-netbsd
13447 On System V.4 and embedded PowerPC systems compile code for the
13448 NetBSD operating system.
13450 @item -maix-struct-return
13451 @opindex maix-struct-return
13452 Return all structures in memory (as specified by the AIX ABI)@.
13454 @item -msvr4-struct-return
13455 @opindex msvr4-struct-return
13456 Return structures smaller than 8 bytes in registers (as specified by the
13457 SVR4 ABI)@.
13459 @item -mabi=@var{abi-type}
13460 @opindex mabi
13461 Extend the current ABI with a particular extension, or remove such extension.
13462 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
13463 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13465 @item -mabi=spe
13466 @opindex mabi=spe
13467 Extend the current ABI with SPE ABI extensions.  This does not change
13468 the default ABI, instead it adds the SPE ABI extensions to the current
13469 ABI@.
13471 @item -mabi=no-spe
13472 @opindex mabi=no-spe
13473 Disable Booke SPE ABI extensions for the current ABI@.
13475 @item -mabi=ibmlongdouble
13476 @opindex mabi=ibmlongdouble
13477 Change the current ABI to use IBM extended precision long double.
13478 This is a PowerPC 32-bit SYSV ABI option.
13480 @item -mabi=ieeelongdouble
13481 @opindex mabi=ieeelongdouble
13482 Change the current ABI to use IEEE extended precision long double.
13483 This is a PowerPC 32-bit Linux ABI option.
13485 @item -mprototype
13486 @itemx -mno-prototype
13487 @opindex mprototype
13488 @opindex mno-prototype
13489 On System V.4 and embedded PowerPC systems assume that all calls to
13490 variable argument functions are properly prototyped.  Otherwise, the
13491 compiler must insert an instruction before every non prototyped call to
13492 set or clear bit 6 of the condition code register (@var{CR}) to
13493 indicate whether floating point values were passed in the floating point
13494 registers in case the function takes a variable arguments.  With
13495 @option{-mprototype}, only calls to prototyped variable argument functions
13496 will set or clear the bit.
13498 @item -msim
13499 @opindex msim
13500 On embedded PowerPC systems, assume that the startup module is called
13501 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13502 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
13503 configurations.
13505 @item -mmvme
13506 @opindex mmvme
13507 On embedded PowerPC systems, assume that the startup module is called
13508 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13509 @file{libc.a}.
13511 @item -mads
13512 @opindex mads
13513 On embedded PowerPC systems, assume that the startup module is called
13514 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13515 @file{libc.a}.
13517 @item -myellowknife
13518 @opindex myellowknife
13519 On embedded PowerPC systems, assume that the startup module is called
13520 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13521 @file{libc.a}.
13523 @item -mvxworks
13524 @opindex mvxworks
13525 On System V.4 and embedded PowerPC systems, specify that you are
13526 compiling for a VxWorks system.
13528 @item -mwindiss
13529 @opindex mwindiss
13530 Specify that you are compiling for the WindISS simulation environment.
13532 @item -memb
13533 @opindex memb
13534 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13535 header to indicate that @samp{eabi} extended relocations are used.
13537 @item -meabi
13538 @itemx -mno-eabi
13539 @opindex meabi
13540 @opindex mno-eabi
13541 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13542 Embedded Applications Binary Interface (eabi) which is a set of
13543 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13544 means that the stack is aligned to an 8 byte boundary, a function
13545 @code{__eabi} is called to from @code{main} to set up the eabi
13546 environment, and the @option{-msdata} option can use both @code{r2} and
13547 @code{r13} to point to two separate small data areas.  Selecting
13548 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13549 do not call an initialization function from @code{main}, and the
13550 @option{-msdata} option will only use @code{r13} to point to a single
13551 small data area.  The @option{-meabi} option is on by default if you
13552 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13554 @item -msdata=eabi
13555 @opindex msdata=eabi
13556 On System V.4 and embedded PowerPC systems, put small initialized
13557 @code{const} global and static data in the @samp{.sdata2} section, which
13558 is pointed to by register @code{r2}.  Put small initialized
13559 non-@code{const} global and static data in the @samp{.sdata} section,
13560 which is pointed to by register @code{r13}.  Put small uninitialized
13561 global and static data in the @samp{.sbss} section, which is adjacent to
13562 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13563 incompatible with the @option{-mrelocatable} option.  The
13564 @option{-msdata=eabi} option also sets the @option{-memb} option.
13566 @item -msdata=sysv
13567 @opindex msdata=sysv
13568 On System V.4 and embedded PowerPC systems, put small global and static
13569 data in the @samp{.sdata} section, which is pointed to by register
13570 @code{r13}.  Put small uninitialized global and static data in the
13571 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13572 The @option{-msdata=sysv} option is incompatible with the
13573 @option{-mrelocatable} option.
13575 @item -msdata=default
13576 @itemx -msdata
13577 @opindex msdata=default
13578 @opindex msdata
13579 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13580 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13581 same as @option{-msdata=sysv}.
13583 @item -msdata-data
13584 @opindex msdata-data
13585 On System V.4 and embedded PowerPC systems, put small global
13586 data in the @samp{.sdata} section.  Put small uninitialized global
13587 data in the @samp{.sbss} section.  Do not use register @code{r13}
13588 to address small data however.  This is the default behavior unless
13589 other @option{-msdata} options are used.
13591 @item -msdata=none
13592 @itemx -mno-sdata
13593 @opindex msdata=none
13594 @opindex mno-sdata
13595 On embedded PowerPC systems, put all initialized global and static data
13596 in the @samp{.data} section, and all uninitialized data in the
13597 @samp{.bss} section.
13599 @item -G @var{num}
13600 @opindex G
13601 @cindex smaller data references (PowerPC)
13602 @cindex .sdata/.sdata2 references (PowerPC)
13603 On embedded PowerPC systems, put global and static items less than or
13604 equal to @var{num} bytes into the small data or bss sections instead of
13605 the normal data or bss section.  By default, @var{num} is 8.  The
13606 @option{-G @var{num}} switch is also passed to the linker.
13607 All modules should be compiled with the same @option{-G @var{num}} value.
13609 @item -mregnames
13610 @itemx -mno-regnames
13611 @opindex mregnames
13612 @opindex mno-regnames
13613 On System V.4 and embedded PowerPC systems do (do not) emit register
13614 names in the assembly language output using symbolic forms.
13616 @item -mlongcall
13617 @itemx -mno-longcall
13618 @opindex mlongcall
13619 @opindex mno-longcall
13620 By default assume that all calls are far away so that a longer more
13621 expensive calling sequence is required.  This is required for calls
13622 further than 32 megabytes (33,554,432 bytes) from the current location.
13623 A short call will be generated if the compiler knows
13624 the call cannot be that far away.  This setting can be overridden by
13625 the @code{shortcall} function attribute, or by @code{#pragma
13626 longcall(0)}.
13628 Some linkers are capable of detecting out-of-range calls and generating
13629 glue code on the fly.  On these systems, long calls are unnecessary and
13630 generate slower code.  As of this writing, the AIX linker can do this,
13631 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13632 to the GNU linker for 32-bit PowerPC systems as well.
13634 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13635 callee, L42'', plus a ``branch island'' (glue code).  The two target
13636 addresses represent the callee and the ``branch island''.  The
13637 Darwin/PPC linker will prefer the first address and generate a ``bl
13638 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13639 otherwise, the linker will generate ``bl L42'' to call the ``branch
13640 island''.  The ``branch island'' is appended to the body of the
13641 calling function; it computes the full 32-bit address of the callee
13642 and jumps to it.
13644 On Mach-O (Darwin) systems, this option directs the compiler emit to
13645 the glue for every direct call, and the Darwin linker decides whether
13646 to use or discard it.
13648 In the future, we may cause GCC to ignore all longcall specifications
13649 when the linker is known to generate glue.
13651 @item -pthread
13652 @opindex pthread
13653 Adds support for multithreading with the @dfn{pthreads} library.
13654 This option sets flags for both the preprocessor and linker.
13656 @end table
13658 @node S/390 and zSeries Options
13659 @subsection S/390 and zSeries Options
13660 @cindex S/390 and zSeries Options
13662 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13664 @table @gcctabopt
13665 @item -mhard-float
13666 @itemx -msoft-float
13667 @opindex mhard-float
13668 @opindex msoft-float
13669 Use (do not use) the hardware floating-point instructions and registers
13670 for floating-point operations.  When @option{-msoft-float} is specified,
13671 functions in @file{libgcc.a} will be used to perform floating-point
13672 operations.  When @option{-mhard-float} is specified, the compiler
13673 generates IEEE floating-point instructions.  This is the default.
13675 @item -mlong-double-64
13676 @itemx -mlong-double-128
13677 @opindex mlong-double-64
13678 @opindex mlong-double-128
13679 These switches control the size of @code{long double} type. A size
13680 of 64bit makes the @code{long double} type equivalent to the @code{double}
13681 type. This is the default.
13683 @item -mbackchain
13684 @itemx -mno-backchain
13685 @opindex mbackchain
13686 @opindex mno-backchain
13687 Store (do not store) the address of the caller's frame as backchain pointer
13688 into the callee's stack frame.
13689 A backchain may be needed to allow debugging using tools that do not understand
13690 DWARF-2 call frame information.
13691 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13692 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13693 the backchain is placed into the topmost word of the 96/160 byte register
13694 save area.
13696 In general, code compiled with @option{-mbackchain} is call-compatible with
13697 code compiled with @option{-mmo-backchain}; however, use of the backchain
13698 for debugging purposes usually requires that the whole binary is built with
13699 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13700 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13701 to build a linux kernel use @option{-msoft-float}.
13703 The default is to not maintain the backchain.
13705 @item -mpacked-stack
13706 @itemx -mno-packed-stack
13707 @opindex mpacked-stack
13708 @opindex mno-packed-stack
13709 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13710 specified, the compiler uses the all fields of the 96/160 byte register save
13711 area only for their default purpose; unused fields still take up stack space.
13712 When @option{-mpacked-stack} is specified, register save slots are densely
13713 packed at the top of the register save area; unused space is reused for other
13714 purposes, allowing for more efficient use of the available stack space.
13715 However, when @option{-mbackchain} is also in effect, the topmost word of
13716 the save area is always used to store the backchain, and the return address
13717 register is always saved two words below the backchain.
13719 As long as the stack frame backchain is not used, code generated with
13720 @option{-mpacked-stack} is call-compatible with code generated with
13721 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13722 S/390 or zSeries generated code that uses the stack frame backchain at run
13723 time, not just for debugging purposes.  Such code is not call-compatible
13724 with code compiled with @option{-mpacked-stack}.  Also, note that the
13725 combination of @option{-mbackchain},
13726 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13727 to build a linux kernel use @option{-msoft-float}.
13729 The default is to not use the packed stack layout.
13731 @item -msmall-exec
13732 @itemx -mno-small-exec
13733 @opindex msmall-exec
13734 @opindex mno-small-exec
13735 Generate (or do not generate) code using the @code{bras} instruction
13736 to do subroutine calls.
13737 This only works reliably if the total executable size does not
13738 exceed 64k.  The default is to use the @code{basr} instruction instead,
13739 which does not have this limitation.
13741 @item -m64
13742 @itemx -m31
13743 @opindex m64
13744 @opindex m31
13745 When @option{-m31} is specified, generate code compliant to the
13746 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13747 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13748 particular to generate 64-bit instructions.  For the @samp{s390}
13749 targets, the default is @option{-m31}, while the @samp{s390x}
13750 targets default to @option{-m64}.
13752 @item -mzarch
13753 @itemx -mesa
13754 @opindex mzarch
13755 @opindex mesa
13756 When @option{-mzarch} is specified, generate code using the
13757 instructions available on z/Architecture.
13758 When @option{-mesa} is specified, generate code using the
13759 instructions available on ESA/390.  Note that @option{-mesa} is
13760 not possible with @option{-m64}.
13761 When generating code compliant to the GNU/Linux for S/390 ABI,
13762 the default is @option{-mesa}.  When generating code compliant
13763 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13765 @item -mmvcle
13766 @itemx -mno-mvcle
13767 @opindex mmvcle
13768 @opindex mno-mvcle
13769 Generate (or do not generate) code using the @code{mvcle} instruction
13770 to perform block moves.  When @option{-mno-mvcle} is specified,
13771 use a @code{mvc} loop instead.  This is the default unless optimizing for
13772 size.
13774 @item -mdebug
13775 @itemx -mno-debug
13776 @opindex mdebug
13777 @opindex mno-debug
13778 Print (or do not print) additional debug information when compiling.
13779 The default is to not print debug information.
13781 @item -march=@var{cpu-type}
13782 @opindex march
13783 Generate code that will run on @var{cpu-type}, which is the name of a system
13784 representing a certain processor type.  Possible values for
13785 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13786 When generating code using the instructions available on z/Architecture,
13787 the default is @option{-march=z900}.  Otherwise, the default is
13788 @option{-march=g5}.
13790 @item -mtune=@var{cpu-type}
13791 @opindex mtune
13792 Tune to @var{cpu-type} everything applicable about the generated code,
13793 except for the ABI and the set of available instructions.
13794 The list of @var{cpu-type} values is the same as for @option{-march}.
13795 The default is the value used for @option{-march}.
13797 @item -mtpf-trace
13798 @itemx -mno-tpf-trace
13799 @opindex mtpf-trace
13800 @opindex mno-tpf-trace
13801 Generate code that adds (does not add) in TPF OS specific branches to trace
13802 routines in the operating system.  This option is off by default, even
13803 when compiling for the TPF OS@.
13805 @item -mfused-madd
13806 @itemx -mno-fused-madd
13807 @opindex mfused-madd
13808 @opindex mno-fused-madd
13809 Generate code that uses (does not use) the floating point multiply and
13810 accumulate instructions.  These instructions are generated by default if
13811 hardware floating point is used.
13813 @item -mwarn-framesize=@var{framesize}
13814 @opindex mwarn-framesize
13815 Emit a warning if the current function exceeds the given frame size.  Because
13816 this is a compile time check it doesn't need to be a real problem when the program
13817 runs.  It is intended to identify functions which most probably cause
13818 a stack overflow.  It is useful to be used in an environment with limited stack
13819 size e.g.@: the linux kernel.
13821 @item -mwarn-dynamicstack
13822 @opindex mwarn-dynamicstack
13823 Emit a warning if the function calls alloca or uses dynamically
13824 sized arrays.  This is generally a bad idea with a limited stack size.
13826 @item -mstack-guard=@var{stack-guard}
13827 @itemx -mstack-size=@var{stack-size}
13828 @opindex mstack-guard
13829 @opindex mstack-size
13830 If these options are provided the s390 back end emits additional instructions in
13831 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13832 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13833 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13834 the frame size of the compiled function is chosen.
13835 These options are intended to be used to help debugging stack overflow problems.
13836 The additionally emitted code causes only little overhead and hence can also be
13837 used in production like systems without greater performance degradation.  The given
13838 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13839 @var{stack-guard} without exceeding 64k.
13840 In order to be efficient the extra code makes the assumption that the stack starts
13841 at an address aligned to the value given by @var{stack-size}.
13842 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13843 @end table
13845 @node Score Options
13846 @subsection Score Options
13847 @cindex Score Options
13849 These options are defined for Score implementations:
13851 @table @gcctabopt
13852 @item -meb
13853 @opindex meb
13854 Compile code for big endian mode.  This is the default.
13856 @item -mel
13857 @opindex mel
13858 Compile code for little endian mode. 
13860 @item -mnhwloop
13861 @opindex mnhwloop
13862 Disable generate bcnz instruction.
13864 @item -muls
13865 @opindex muls
13866 Enable generate unaligned load and store instruction.
13868 @item -mmac
13869 @opindex mmac
13870 Enable the use of multiply-accumulate instructions. Disabled by default. 
13872 @item -mscore5
13873 @opindex mscore5
13874 Specify the SCORE5 as the target architecture.
13876 @item -mscore5u
13877 @opindex mscore5u
13878 Specify the SCORE5U of the target architecture.
13880 @item -mscore7
13881 @opindex mscore7
13882 Specify the SCORE7 as the target architecture. This is the default.
13884 @item -mscore7d
13885 @opindex mscore7d
13886 Specify the SCORE7D as the target architecture.
13887 @end table
13889 @node SH Options
13890 @subsection SH Options
13892 These @samp{-m} options are defined for the SH implementations:
13894 @table @gcctabopt
13895 @item -m1
13896 @opindex m1
13897 Generate code for the SH1.
13899 @item -m2
13900 @opindex m2
13901 Generate code for the SH2.
13903 @item -m2e
13904 Generate code for the SH2e.
13906 @item -m3
13907 @opindex m3
13908 Generate code for the SH3.
13910 @item -m3e
13911 @opindex m3e
13912 Generate code for the SH3e.
13914 @item -m4-nofpu
13915 @opindex m4-nofpu
13916 Generate code for the SH4 without a floating-point unit.
13918 @item -m4-single-only
13919 @opindex m4-single-only
13920 Generate code for the SH4 with a floating-point unit that only
13921 supports single-precision arithmetic.
13923 @item -m4-single
13924 @opindex m4-single
13925 Generate code for the SH4 assuming the floating-point unit is in
13926 single-precision mode by default.
13928 @item -m4
13929 @opindex m4
13930 Generate code for the SH4.
13932 @item -m4a-nofpu
13933 @opindex m4a-nofpu
13934 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13935 floating-point unit is not used.
13937 @item -m4a-single-only
13938 @opindex m4a-single-only
13939 Generate code for the SH4a, in such a way that no double-precision
13940 floating point operations are used.
13942 @item -m4a-single
13943 @opindex m4a-single
13944 Generate code for the SH4a assuming the floating-point unit is in
13945 single-precision mode by default.
13947 @item -m4a
13948 @opindex m4a
13949 Generate code for the SH4a.
13951 @item -m4al
13952 @opindex m4al
13953 Same as @option{-m4a-nofpu}, except that it implicitly passes
13954 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13955 instructions at the moment.
13957 @item -mb
13958 @opindex mb
13959 Compile code for the processor in big endian mode.
13961 @item -ml
13962 @opindex ml
13963 Compile code for the processor in little endian mode.
13965 @item -mdalign
13966 @opindex mdalign
13967 Align doubles at 64-bit boundaries.  Note that this changes the calling
13968 conventions, and thus some functions from the standard C library will
13969 not work unless you recompile it first with @option{-mdalign}.
13971 @item -mrelax
13972 @opindex mrelax
13973 Shorten some address references at link time, when possible; uses the
13974 linker option @option{-relax}.
13976 @item -mbigtable
13977 @opindex mbigtable
13978 Use 32-bit offsets in @code{switch} tables.  The default is to use
13979 16-bit offsets.
13981 @item -mbitops
13982 @opindex mbitops
13983 Enable the use of bit manipulation instructions on SH2A.
13985 @item -mfmovd
13986 @opindex mfmovd
13987 Enable the use of the instruction @code{fmovd}.
13989 @item -mhitachi
13990 @opindex mhitachi
13991 Comply with the calling conventions defined by Renesas.
13993 @item -mrenesas
13994 @opindex mhitachi
13995 Comply with the calling conventions defined by Renesas.
13997 @item -mno-renesas
13998 @opindex mhitachi
13999 Comply with the calling conventions defined for GCC before the Renesas
14000 conventions were available.  This option is the default for all
14001 targets of the SH toolchain except for @samp{sh-symbianelf}.
14003 @item -mnomacsave
14004 @opindex mnomacsave
14005 Mark the @code{MAC} register as call-clobbered, even if
14006 @option{-mhitachi} is given.
14008 @item -mieee
14009 @opindex mieee
14010 Increase IEEE-compliance of floating-point code.
14011 At the moment, this is equivalent to @option{-fno-finite-math-only}.
14012 When generating 16 bit SH opcodes, getting IEEE-conforming results for
14013 comparisons of NANs / infinities incurs extra overhead in every
14014 floating point comparison, therefore the default is set to
14015 @option{-ffinite-math-only}.
14017 @item -minline-ic_invalidate
14018 @opindex minline-ic_invalidate
14019 Inline code to invalidate instruction cache entries after setting up
14020 nested function trampolines.
14021 This option has no effect if -musermode is in effect and the selected
14022 code generation option (e.g. -m4) does not allow the use of the icbi
14023 instruction.
14024 If the selected code generation option does not allow the use of the icbi
14025 instruction, and -musermode is not in effect, the inlined code will
14026 manipulate the instruction cache address array directly with an associative
14027 write.  This not only requires privileged mode, but it will also
14028 fail if the cache line had been mapped via the TLB and has become unmapped.
14030 @item -misize
14031 @opindex misize
14032 Dump instruction size and location in the assembly code.
14034 @item -mpadstruct
14035 @opindex mpadstruct
14036 This option is deprecated.  It pads structures to multiple of 4 bytes,
14037 which is incompatible with the SH ABI@.
14039 @item -mspace
14040 @opindex mspace
14041 Optimize for space instead of speed.  Implied by @option{-Os}.
14043 @item -mprefergot
14044 @opindex mprefergot
14045 When generating position-independent code, emit function calls using
14046 the Global Offset Table instead of the Procedure Linkage Table.
14048 @item -musermode
14049 @opindex musermode
14050 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
14051 if the inlined code would not work in user mode.
14052 This is the default when the target is @code{sh-*-linux*}.
14054 @item -multcost=@var{number}
14055 @opindex multcost=@var{number}
14056 Set the cost to assume for a multiply insn.
14058 @item -mdiv=@var{strategy}
14059 @opindex mdiv=@var{strategy}
14060 Set the division strategy to use for SHmedia code.  @var{strategy} must be
14061 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
14062 inv:call2, inv:fp .
14063 "fp" performs the operation in floating point.  This has a very high latency,
14064 but needs only a few instructions, so it might be a good choice if
14065 your code has enough easily exploitable ILP to allow the compiler to
14066 schedule the floating point instructions together with other instructions.
14067 Division by zero causes a floating point exception.
14068 "inv" uses integer operations to calculate the inverse of the divisor,
14069 and then multiplies the dividend with the inverse.  This strategy allows
14070 cse and hoisting of the inverse calculation.  Division by zero calculates
14071 an unspecified result, but does not trap.
14072 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
14073 have been found, or if the entire operation has been hoisted to the same
14074 place, the last stages of the inverse calculation are intertwined with the
14075 final multiply to reduce the overall latency, at the expense of using a few
14076 more instructions, and thus offering fewer scheduling opportunities with
14077 other code.
14078 "call" calls a library function that usually implements the inv:minlat
14079 strategy.
14080 This gives high code density for m5-*media-nofpu compilations.
14081 "call2" uses a different entry point of the same library function, where it
14082 assumes that a pointer to a lookup table has already been set up, which
14083 exposes the pointer load to cse / code hoisting optimizations.
14084 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
14085 code generation, but if the code stays unoptimized, revert to the "call",
14086 "call2", or "fp" strategies, respectively.  Note that the
14087 potentially-trapping side effect of division by zero is carried by a
14088 separate instruction, so it is possible that all the integer instructions
14089 are hoisted out, but the marker for the side effect stays where it is.
14090 A recombination to fp operations or a call is not possible in that case.
14091 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
14092 that the inverse calculation was nor separated from the multiply, they speed
14093 up division where the dividend fits into 20 bits (plus sign where applicable),
14094 by inserting a test to skip a number of operations in this case; this test
14095 slows down the case of larger dividends.  inv20u assumes the case of a such
14096 a small dividend to be unlikely, and inv20l assumes it to be likely.
14098 @item -mdivsi3_libfunc=@var{name}
14099 @opindex mdivsi3_libfunc=@var{name}
14100 Set the name of the library function used for 32 bit signed division to
14101 @var{name}.  This only affect the name used in the call and inv:call
14102 division strategies, and the compiler will still expect the same
14103 sets of input/output/clobbered registers as if this option was not present.
14105 @item -madjust-unroll
14106 @opindex madjust-unroll
14107 Throttle unrolling to avoid thrashing target registers.
14108 This option only has an effect if the gcc code base supports the
14109 TARGET_ADJUST_UNROLL_MAX target hook.
14111 @item -mindexed-addressing
14112 @opindex mindexed-addressing
14113 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
14114 This is only safe if the hardware and/or OS implement 32 bit wrap-around
14115 semantics for the indexed addressing mode.  The architecture allows the
14116 implementation of processors with 64 bit MMU, which the OS could use to
14117 get 32 bit addressing, but since no current hardware implementation supports
14118 this or any other way to make the indexed addressing mode safe to use in
14119 the 32 bit ABI, the default is -mno-indexed-addressing.
14121 @item -mgettrcost=@var{number}
14122 @opindex mgettrcost=@var{number}
14123 Set the cost assumed for the gettr instruction to @var{number}.
14124 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
14126 @item -mpt-fixed
14127 @opindex mpt-fixed
14128 Assume pt* instructions won't trap.  This will generally generate better
14129 scheduled code, but is unsafe on current hardware.  The current architecture
14130 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
14131 This has the unintentional effect of making it unsafe to schedule ptabs /
14132 ptrel before a branch, or hoist it out of a loop.  For example,
14133 __do_global_ctors, a part of libgcc that runs constructors at program
14134 startup, calls functions in a list which is delimited by @minus{}1.  With the
14135 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
14136 That means that all the constructors will be run a bit quicker, but when
14137 the loop comes to the end of the list, the program crashes because ptabs
14138 loads @minus{}1 into a target register.  Since this option is unsafe for any
14139 hardware implementing the current architecture specification, the default
14140 is -mno-pt-fixed.  Unless the user specifies a specific cost with
14141 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
14142 this deters register allocation using target registers for storing
14143 ordinary integers.
14145 @item -minvalid-symbols
14146 @opindex minvalid-symbols
14147 Assume symbols might be invalid.  Ordinary function symbols generated by
14148 the compiler will always be valid to load with movi/shori/ptabs or
14149 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
14150 to generate symbols that will cause ptabs / ptrel to trap.
14151 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
14152 It will then prevent cross-basic-block cse, hoisting and most scheduling
14153 of symbol loads.  The default is @option{-mno-invalid-symbols}.
14154 @end table
14156 @node SPARC Options
14157 @subsection SPARC Options
14158 @cindex SPARC options
14160 These @samp{-m} options are supported on the SPARC:
14162 @table @gcctabopt
14163 @item -mno-app-regs
14164 @itemx -mapp-regs
14165 @opindex mno-app-regs
14166 @opindex mapp-regs
14167 Specify @option{-mapp-regs} to generate output using the global registers
14168 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
14169 is the default.
14171 To be fully SVR4 ABI compliant at the cost of some performance loss,
14172 specify @option{-mno-app-regs}.  You should compile libraries and system
14173 software with this option.
14175 @item -mfpu
14176 @itemx -mhard-float
14177 @opindex mfpu
14178 @opindex mhard-float
14179 Generate output containing floating point instructions.  This is the
14180 default.
14182 @item -mno-fpu
14183 @itemx -msoft-float
14184 @opindex mno-fpu
14185 @opindex msoft-float
14186 Generate output containing library calls for floating point.
14187 @strong{Warning:} the requisite libraries are not available for all SPARC
14188 targets.  Normally the facilities of the machine's usual C compiler are
14189 used, but this cannot be done directly in cross-compilation.  You must make
14190 your own arrangements to provide suitable library functions for
14191 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
14192 @samp{sparclite-*-*} do provide software floating point support.
14194 @option{-msoft-float} changes the calling convention in the output file;
14195 therefore, it is only useful if you compile @emph{all} of a program with
14196 this option.  In particular, you need to compile @file{libgcc.a}, the
14197 library that comes with GCC, with @option{-msoft-float} in order for
14198 this to work.
14200 @item -mhard-quad-float
14201 @opindex mhard-quad-float
14202 Generate output containing quad-word (long double) floating point
14203 instructions.
14205 @item -msoft-quad-float
14206 @opindex msoft-quad-float
14207 Generate output containing library calls for quad-word (long double)
14208 floating point instructions.  The functions called are those specified
14209 in the SPARC ABI@.  This is the default.
14211 As of this writing, there are no SPARC implementations that have hardware
14212 support for the quad-word floating point instructions.  They all invoke
14213 a trap handler for one of these instructions, and then the trap handler
14214 emulates the effect of the instruction.  Because of the trap handler overhead,
14215 this is much slower than calling the ABI library routines.  Thus the
14216 @option{-msoft-quad-float} option is the default.
14218 @item -mno-unaligned-doubles
14219 @itemx -munaligned-doubles
14220 @opindex mno-unaligned-doubles
14221 @opindex munaligned-doubles
14222 Assume that doubles have 8 byte alignment.  This is the default.
14224 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
14225 alignment only if they are contained in another type, or if they have an
14226 absolute address.  Otherwise, it assumes they have 4 byte alignment.
14227 Specifying this option avoids some rare compatibility problems with code
14228 generated by other compilers.  It is not the default because it results
14229 in a performance loss, especially for floating point code.
14231 @item -mno-faster-structs
14232 @itemx -mfaster-structs
14233 @opindex mno-faster-structs
14234 @opindex mfaster-structs
14235 With @option{-mfaster-structs}, the compiler assumes that structures
14236 should have 8 byte alignment.  This enables the use of pairs of
14237 @code{ldd} and @code{std} instructions for copies in structure
14238 assignment, in place of twice as many @code{ld} and @code{st} pairs.
14239 However, the use of this changed alignment directly violates the SPARC
14240 ABI@.  Thus, it's intended only for use on targets where the developer
14241 acknowledges that their resulting code will not be directly in line with
14242 the rules of the ABI@.
14244 @item -mimpure-text
14245 @opindex mimpure-text
14246 @option{-mimpure-text}, used in addition to @option{-shared}, tells
14247 the compiler to not pass @option{-z text} to the linker when linking a
14248 shared object.  Using this option, you can link position-dependent
14249 code into a shared object.
14251 @option{-mimpure-text} suppresses the ``relocations remain against
14252 allocatable but non-writable sections'' linker error message.
14253 However, the necessary relocations will trigger copy-on-write, and the
14254 shared object is not actually shared across processes.  Instead of
14255 using @option{-mimpure-text}, you should compile all source code with
14256 @option{-fpic} or @option{-fPIC}.
14258 This option is only available on SunOS and Solaris.
14260 @item -mcpu=@var{cpu_type}
14261 @opindex mcpu
14262 Set the instruction set, register set, and instruction scheduling parameters
14263 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
14264 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
14265 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
14266 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
14267 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
14269 Default instruction scheduling parameters are used for values that select
14270 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
14271 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
14273 Here is a list of each supported architecture and their supported
14274 implementations.
14276 @smallexample
14277     v7:             cypress
14278     v8:             supersparc, hypersparc
14279     sparclite:      f930, f934, sparclite86x
14280     sparclet:       tsc701
14281     v9:             ultrasparc, ultrasparc3, niagara, niagara2
14282 @end smallexample
14284 By default (unless configured otherwise), GCC generates code for the V7
14285 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
14286 additionally optimizes it for the Cypress CY7C602 chip, as used in the
14287 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
14288 SPARCStation 1, 2, IPX etc.
14290 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
14291 architecture.  The only difference from V7 code is that the compiler emits
14292 the integer multiply and integer divide instructions which exist in SPARC-V8
14293 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
14294 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
14295 2000 series.
14297 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
14298 the SPARC architecture.  This adds the integer multiply, integer divide step
14299 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
14300 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
14301 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
14302 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
14303 MB86934 chip, which is the more recent SPARClite with FPU@.
14305 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
14306 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
14307 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
14308 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
14309 optimizes it for the TEMIC SPARClet chip.
14311 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
14312 architecture.  This adds 64-bit integer and floating-point move instructions,
14313 3 additional floating-point condition code registers and conditional move
14314 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
14315 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
14316 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
14317 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
14318 @option{-mcpu=niagara}, the compiler additionally optimizes it for
14319 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
14320 additionally optimizes it for Sun UltraSPARC T2 chips.
14322 @item -mtune=@var{cpu_type}
14323 @opindex mtune
14324 Set the instruction scheduling parameters for machine type
14325 @var{cpu_type}, but do not set the instruction set or register set that the
14326 option @option{-mcpu=@var{cpu_type}} would.
14328 The same values for @option{-mcpu=@var{cpu_type}} can be used for
14329 @option{-mtune=@var{cpu_type}}, but the only useful values are those
14330 that select a particular cpu implementation.  Those are @samp{cypress},
14331 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
14332 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
14333 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
14335 @item -mv8plus
14336 @itemx -mno-v8plus
14337 @opindex mv8plus
14338 @opindex mno-v8plus
14339 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
14340 difference from the V8 ABI is that the global and out registers are
14341 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
14342 mode for all SPARC-V9 processors.
14344 @item -mvis
14345 @itemx -mno-vis
14346 @opindex mvis
14347 @opindex mno-vis
14348 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
14349 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
14350 @end table
14352 These @samp{-m} options are supported in addition to the above
14353 on SPARC-V9 processors in 64-bit environments:
14355 @table @gcctabopt
14356 @item -mlittle-endian
14357 @opindex mlittle-endian
14358 Generate code for a processor running in little-endian mode.  It is only
14359 available for a few configurations and most notably not on Solaris and Linux.
14361 @item -m32
14362 @itemx -m64
14363 @opindex m32
14364 @opindex m64
14365 Generate code for a 32-bit or 64-bit environment.
14366 The 32-bit environment sets int, long and pointer to 32 bits.
14367 The 64-bit environment sets int to 32 bits and long and pointer
14368 to 64 bits.
14370 @item -mcmodel=medlow
14371 @opindex mcmodel=medlow
14372 Generate code for the Medium/Low code model: 64-bit addresses, programs
14373 must be linked in the low 32 bits of memory.  Programs can be statically
14374 or dynamically linked.
14376 @item -mcmodel=medmid
14377 @opindex mcmodel=medmid
14378 Generate code for the Medium/Middle code model: 64-bit addresses, programs
14379 must be linked in the low 44 bits of memory, the text and data segments must
14380 be less than 2GB in size and the data segment must be located within 2GB of
14381 the text segment.
14383 @item -mcmodel=medany
14384 @opindex mcmodel=medany
14385 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
14386 may be linked anywhere in memory, the text and data segments must be less
14387 than 2GB in size and the data segment must be located within 2GB of the
14388 text segment.
14390 @item -mcmodel=embmedany
14391 @opindex mcmodel=embmedany
14392 Generate code for the Medium/Anywhere code model for embedded systems:
14393 64-bit addresses, the text and data segments must be less than 2GB in
14394 size, both starting anywhere in memory (determined at link time).  The
14395 global register %g4 points to the base of the data segment.  Programs
14396 are statically linked and PIC is not supported.
14398 @item -mstack-bias
14399 @itemx -mno-stack-bias
14400 @opindex mstack-bias
14401 @opindex mno-stack-bias
14402 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
14403 frame pointer if present, are offset by @minus{}2047 which must be added back
14404 when making stack frame references.  This is the default in 64-bit mode.
14405 Otherwise, assume no such offset is present.
14406 @end table
14408 These switches are supported in addition to the above on Solaris:
14410 @table @gcctabopt
14411 @item -threads
14412 @opindex threads
14413 Add support for multithreading using the Solaris 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 -pthreads
14419 @opindex pthreads
14420 Add support for multithreading using the POSIX threads library.  This
14421 option sets flags for both the preprocessor and linker.  This option does
14422 not affect the thread safety of object code produced  by the compiler or
14423 that of libraries supplied with it.
14425 @item -pthread
14426 @opindex pthread
14427 This is a synonym for @option{-pthreads}.
14428 @end table
14430 @node SPU Options
14431 @subsection SPU Options
14432 @cindex SPU options
14434 These @samp{-m} options are supported on the SPU:
14436 @table @gcctabopt
14437 @item -mwarn-reloc
14438 @itemx -merror-reloc
14439 @opindex mwarn-reloc
14440 @opindex merror-reloc
14442 The loader for SPU does not handle dynamic relocations.  By default, GCC
14443 will give an error when it generates code that requires a dynamic
14444 relocation.  @option{-mno-error-reloc} disables the error,
14445 @option{-mwarn-reloc} will generate a warning instead.
14447 @item -msafe-dma
14448 @itemx -munsafe-dma
14449 @opindex msafe-dma
14450 @opindex munsafe-dma
14452 Instructions which initiate or test completion of DMA must not be
14453 reordered with respect to loads and stores of the memory which is being
14454 accessed.  Users typically address this problem using the volatile
14455 keyword, but that can lead to inefficient code in places where the
14456 memory is known to not change.  Rather than mark the memory as volatile
14457 we treat the DMA instructions as potentially effecting all memory.  With
14458 @option{-munsafe-dma} users must use the volatile keyword to protect
14459 memory accesses.
14461 @item -mbranch-hints
14462 @opindex mbranch-hints
14464 By default, GCC will generate a branch hint instruction to avoid
14465 pipeline stalls for always taken or probably taken branches.  A hint
14466 will not be generated closer than 8 instructions away from its branch.
14467 There is little reason to disable them, except for debugging purposes,
14468 or to make an object a little bit smaller.
14470 @item -msmall-mem
14471 @itemx -mlarge-mem
14472 @opindex msmall-mem
14473 @opindex mlarge-mem
14475 By default, GCC generates code assuming that addresses are never larger
14476 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14477 a full 32 bit address.
14479 @item -mstdmain
14480 @opindex mstdmain
14482 By default, GCC links against startup code that assumes the SPU-style
14483 main function interface (which has an unconventional parameter list).
14484 With @option{-mstdmain}, GCC will link your program against startup
14485 code that assumes a C99-style interface to @code{main}, including a
14486 local copy of @code{argv} strings.
14488 @item -mfixed-range=@var{register-range}
14489 @opindex mfixed-range
14490 Generate code treating the given register range as fixed registers.
14491 A fixed register is one that the register allocator can not use.  This is
14492 useful when compiling kernel code.  A register range is specified as
14493 two registers separated by a dash.  Multiple register ranges can be
14494 specified separated by a comma.
14496 @end table
14498 @node System V Options
14499 @subsection Options for System V
14501 These additional options are available on System V Release 4 for
14502 compatibility with other compilers on those systems:
14504 @table @gcctabopt
14505 @item -G
14506 @opindex G
14507 Create a shared object.
14508 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14510 @item -Qy
14511 @opindex Qy
14512 Identify the versions of each tool used by the compiler, in a
14513 @code{.ident} assembler directive in the output.
14515 @item -Qn
14516 @opindex Qn
14517 Refrain from adding @code{.ident} directives to the output file (this is
14518 the default).
14520 @item -YP,@var{dirs}
14521 @opindex YP
14522 Search the directories @var{dirs}, and no others, for libraries
14523 specified with @option{-l}.
14525 @item -Ym,@var{dir}
14526 @opindex Ym
14527 Look in the directory @var{dir} to find the M4 preprocessor.
14528 The assembler uses this option.
14529 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14530 @c the generic assembler that comes with Solaris takes just -Ym.
14531 @end table
14533 @node V850 Options
14534 @subsection V850 Options
14535 @cindex V850 Options
14537 These @samp{-m} options are defined for V850 implementations:
14539 @table @gcctabopt
14540 @item -mlong-calls
14541 @itemx -mno-long-calls
14542 @opindex mlong-calls
14543 @opindex mno-long-calls
14544 Treat all calls as being far away (near).  If calls are assumed to be
14545 far away, the compiler will always load the functions address up into a
14546 register, and call indirect through the pointer.
14548 @item -mno-ep
14549 @itemx -mep
14550 @opindex mno-ep
14551 @opindex mep
14552 Do not optimize (do optimize) basic blocks that use the same index
14553 pointer 4 or more times to copy pointer into the @code{ep} register, and
14554 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14555 option is on by default if you optimize.
14557 @item -mno-prolog-function
14558 @itemx -mprolog-function
14559 @opindex mno-prolog-function
14560 @opindex mprolog-function
14561 Do not use (do use) external functions to save and restore registers
14562 at the prologue and epilogue of a function.  The external functions
14563 are slower, but use less code space if more than one function saves
14564 the same number of registers.  The @option{-mprolog-function} option
14565 is on by default if you optimize.
14567 @item -mspace
14568 @opindex mspace
14569 Try to make the code as small as possible.  At present, this just turns
14570 on the @option{-mep} and @option{-mprolog-function} options.
14572 @item -mtda=@var{n}
14573 @opindex mtda
14574 Put static or global variables whose size is @var{n} bytes or less into
14575 the tiny data area that register @code{ep} points to.  The tiny data
14576 area can hold up to 256 bytes in total (128 bytes for byte references).
14578 @item -msda=@var{n}
14579 @opindex msda
14580 Put static or global variables whose size is @var{n} bytes or less into
14581 the small data area that register @code{gp} points to.  The small data
14582 area can hold up to 64 kilobytes.
14584 @item -mzda=@var{n}
14585 @opindex mzda
14586 Put static or global variables whose size is @var{n} bytes or less into
14587 the first 32 kilobytes of memory.
14589 @item -mv850
14590 @opindex mv850
14591 Specify that the target processor is the V850.
14593 @item -mbig-switch
14594 @opindex mbig-switch
14595 Generate code suitable for big switch tables.  Use this option only if
14596 the assembler/linker complain about out of range branches within a switch
14597 table.
14599 @item -mapp-regs
14600 @opindex mapp-regs
14601 This option will cause r2 and r5 to be used in the code generated by
14602 the compiler.  This setting is the default.
14604 @item -mno-app-regs
14605 @opindex mno-app-regs
14606 This option will cause r2 and r5 to be treated as fixed registers.
14608 @item -mv850e1
14609 @opindex mv850e1
14610 Specify that the target processor is the V850E1.  The preprocessor
14611 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14612 this option is used.
14614 @item -mv850e
14615 @opindex mv850e
14616 Specify that the target processor is the V850E@.  The preprocessor
14617 constant @samp{__v850e__} will be defined if this option is used.
14619 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14620 are defined then a default target processor will be chosen and the
14621 relevant @samp{__v850*__} preprocessor constant will be defined.
14623 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14624 defined, regardless of which processor variant is the target.
14626 @item -mdisable-callt
14627 @opindex mdisable-callt
14628 This option will suppress generation of the CALLT instruction for the
14629 v850e and v850e1 flavors of the v850 architecture.  The default is
14630 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14632 @end table
14634 @node VAX Options
14635 @subsection VAX Options
14636 @cindex VAX options
14638 These @samp{-m} options are defined for the VAX:
14640 @table @gcctabopt
14641 @item -munix
14642 @opindex munix
14643 Do not output certain jump instructions (@code{aobleq} and so on)
14644 that the Unix assembler for the VAX cannot handle across long
14645 ranges.
14647 @item -mgnu
14648 @opindex mgnu
14649 Do output those jump instructions, on the assumption that you
14650 will assemble with the GNU assembler.
14652 @item -mg
14653 @opindex mg
14654 Output code for g-format floating point numbers instead of d-format.
14655 @end table
14657 @node VxWorks Options
14658 @subsection VxWorks Options
14659 @cindex VxWorks Options
14661 The options in this section are defined for all VxWorks targets.
14662 Options specific to the target hardware are listed with the other
14663 options for that target.
14665 @table @gcctabopt
14666 @item -mrtp
14667 @opindex mrtp
14668 GCC can generate code for both VxWorks kernels and real time processes
14669 (RTPs).  This option switches from the former to the latter.  It also
14670 defines the preprocessor macro @code{__RTP__}.
14672 @item -non-static
14673 @opindex non-static
14674 Link an RTP executable against shared libraries rather than static
14675 libraries.  The options @option{-static} and @option{-shared} can
14676 also be used for RTPs (@pxref{Link Options}); @option{-static}
14677 is the default.
14679 @item -Bstatic
14680 @itemx -Bdynamic
14681 @opindex Bstatic
14682 @opindex Bdynamic
14683 These options are passed down to the linker.  They are defined for
14684 compatibility with Diab.
14686 @item -Xbind-lazy
14687 @opindex Xbind-lazy
14688 Enable lazy binding of function calls.  This option is equivalent to
14689 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14691 @item -Xbind-now
14692 @opindex Xbind-now
14693 Disable lazy binding of function calls.  This option is the default and
14694 is defined for compatibility with Diab.
14695 @end table
14697 @node x86-64 Options
14698 @subsection x86-64 Options
14699 @cindex x86-64 options
14701 These are listed under @xref{i386 and x86-64 Options}.
14703 @node Xstormy16 Options
14704 @subsection Xstormy16 Options
14705 @cindex Xstormy16 Options
14707 These options are defined for Xstormy16:
14709 @table @gcctabopt
14710 @item -msim
14711 @opindex msim
14712 Choose startup files and linker script suitable for the simulator.
14713 @end table
14715 @node Xtensa Options
14716 @subsection Xtensa Options
14717 @cindex Xtensa Options
14719 These options are supported for Xtensa targets:
14721 @table @gcctabopt
14722 @item -mconst16
14723 @itemx -mno-const16
14724 @opindex mconst16
14725 @opindex mno-const16
14726 Enable or disable use of @code{CONST16} instructions for loading
14727 constant values.  The @code{CONST16} instruction is currently not a
14728 standard option from Tensilica.  When enabled, @code{CONST16}
14729 instructions are always used in place of the standard @code{L32R}
14730 instructions.  The use of @code{CONST16} is enabled by default only if
14731 the @code{L32R} instruction is not available.
14733 @item -mfused-madd
14734 @itemx -mno-fused-madd
14735 @opindex mfused-madd
14736 @opindex mno-fused-madd
14737 Enable or disable use of fused multiply/add and multiply/subtract
14738 instructions in the floating-point option.  This has no effect if the
14739 floating-point option is not also enabled.  Disabling fused multiply/add
14740 and multiply/subtract instructions forces the compiler to use separate
14741 instructions for the multiply and add/subtract operations.  This may be
14742 desirable in some cases where strict IEEE 754-compliant results are
14743 required: the fused multiply add/subtract instructions do not round the
14744 intermediate result, thereby producing results with @emph{more} bits of
14745 precision than specified by the IEEE standard.  Disabling fused multiply
14746 add/subtract instructions also ensures that the program output is not
14747 sensitive to the compiler's ability to combine multiply and add/subtract
14748 operations.
14750 @item -mserialize-volatile
14751 @itemx -mno-serialize-volatile
14752 @opindex mserialize-volatile
14753 @opindex mno-serialize-volatile
14754 When this option is enabled, GCC inserts @code{MEMW} instructions before
14755 @code{volatile} memory references to guarantee sequential consistency.
14756 The default is @option{-mserialize-volatile}.  Use
14757 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
14759 @item -mtext-section-literals
14760 @itemx -mno-text-section-literals
14761 @opindex mtext-section-literals
14762 @opindex mno-text-section-literals
14763 Control the treatment of literal pools.  The default is
14764 @option{-mno-text-section-literals}, which places literals in a separate
14765 section in the output file.  This allows the literal pool to be placed
14766 in a data RAM/ROM, and it also allows the linker to combine literal
14767 pools from separate object files to remove redundant literals and
14768 improve code size.  With @option{-mtext-section-literals}, the literals
14769 are interspersed in the text section in order to keep them as close as
14770 possible to their references.  This may be necessary for large assembly
14771 files.
14773 @item -mtarget-align
14774 @itemx -mno-target-align
14775 @opindex mtarget-align
14776 @opindex mno-target-align
14777 When this option is enabled, GCC instructs the assembler to
14778 automatically align instructions to reduce branch penalties at the
14779 expense of some code density.  The assembler attempts to widen density
14780 instructions to align branch targets and the instructions following call
14781 instructions.  If there are not enough preceding safe density
14782 instructions to align a target, no widening will be performed.  The
14783 default is @option{-mtarget-align}.  These options do not affect the
14784 treatment of auto-aligned instructions like @code{LOOP}, which the
14785 assembler will always align, either by widening density instructions or
14786 by inserting no-op instructions.
14788 @item -mlongcalls
14789 @itemx -mno-longcalls
14790 @opindex mlongcalls
14791 @opindex mno-longcalls
14792 When this option is enabled, GCC instructs the assembler to translate
14793 direct calls to indirect calls unless it can determine that the target
14794 of a direct call is in the range allowed by the call instruction.  This
14795 translation typically occurs for calls to functions in other source
14796 files.  Specifically, the assembler translates a direct @code{CALL}
14797 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14798 The default is @option{-mno-longcalls}.  This option should be used in
14799 programs where the call target can potentially be out of range.  This
14800 option is implemented in the assembler, not the compiler, so the
14801 assembly code generated by GCC will still show direct call
14802 instructions---look at the disassembled object code to see the actual
14803 instructions.  Note that the assembler will use an indirect call for
14804 every cross-file call, not just those that really will be out of range.
14805 @end table
14807 @node zSeries Options
14808 @subsection zSeries Options
14809 @cindex zSeries options
14811 These are listed under @xref{S/390 and zSeries Options}.
14813 @node Code Gen Options
14814 @section Options for Code Generation Conventions
14815 @cindex code generation conventions
14816 @cindex options, code generation
14817 @cindex run-time options
14819 These machine-independent options control the interface conventions
14820 used in code generation.
14822 Most of them have both positive and negative forms; the negative form
14823 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14824 one of the forms is listed---the one which is not the default.  You
14825 can figure out the other form by either removing @samp{no-} or adding
14828 @table @gcctabopt
14829 @item -fbounds-check
14830 @opindex fbounds-check
14831 For front-ends that support it, generate additional code to check that
14832 indices used to access arrays are within the declared range.  This is
14833 currently only supported by the Java and Fortran front-ends, where
14834 this option defaults to true and false respectively.
14836 @item -ftrapv
14837 @opindex ftrapv
14838 This option generates traps for signed overflow on addition, subtraction,
14839 multiplication operations.
14841 @item -fwrapv
14842 @opindex fwrapv
14843 This option instructs the compiler to assume that signed arithmetic
14844 overflow of addition, subtraction and multiplication wraps around
14845 using twos-complement representation.  This flag enables some optimizations
14846 and disables others.  This option is enabled by default for the Java
14847 front-end, as required by the Java language specification.
14849 @item -fexceptions
14850 @opindex fexceptions
14851 Enable exception handling.  Generates extra code needed to propagate
14852 exceptions.  For some targets, this implies GCC will generate frame
14853 unwind information for all functions, which can produce significant data
14854 size overhead, although it does not affect execution.  If you do not
14855 specify this option, GCC will enable it by default for languages like
14856 C++ which normally require exception handling, and disable it for
14857 languages like C that do not normally require it.  However, you may need
14858 to enable this option when compiling C code that needs to interoperate
14859 properly with exception handlers written in C++.  You may also wish to
14860 disable this option if you are compiling older C++ programs that don't
14861 use exception handling.
14863 @item -fnon-call-exceptions
14864 @opindex fnon-call-exceptions
14865 Generate code that allows trapping instructions to throw exceptions.
14866 Note that this requires platform-specific runtime support that does
14867 not exist everywhere.  Moreover, it only allows @emph{trapping}
14868 instructions to throw exceptions, i.e.@: memory references or floating
14869 point instructions.  It does not allow exceptions to be thrown from
14870 arbitrary signal handlers such as @code{SIGALRM}.
14872 @item -funwind-tables
14873 @opindex funwind-tables
14874 Similar to @option{-fexceptions}, except that it will just generate any needed
14875 static data, but will not affect the generated code in any other way.
14876 You will normally not enable this option; instead, a language processor
14877 that needs this handling would enable it on your behalf.
14879 @item -fasynchronous-unwind-tables
14880 @opindex fasynchronous-unwind-tables
14881 Generate unwind table in dwarf2 format, if supported by target machine.  The
14882 table is exact at each instruction boundary, so it can be used for stack
14883 unwinding from asynchronous events (such as debugger or garbage collector).
14885 @item -fpcc-struct-return
14886 @opindex fpcc-struct-return
14887 Return ``short'' @code{struct} and @code{union} values in memory like
14888 longer ones, rather than in registers.  This convention is less
14889 efficient, but it has the advantage of allowing intercallability between
14890 GCC-compiled files and files compiled with other compilers, particularly
14891 the Portable C Compiler (pcc).
14893 The precise convention for returning structures in memory depends
14894 on the target configuration macros.
14896 Short structures and unions are those whose size and alignment match
14897 that of some integer type.
14899 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14900 switch is not binary compatible with code compiled with the
14901 @option{-freg-struct-return} switch.
14902 Use it to conform to a non-default application binary interface.
14904 @item -freg-struct-return
14905 @opindex freg-struct-return
14906 Return @code{struct} and @code{union} values in registers when possible.
14907 This is more efficient for small structures than
14908 @option{-fpcc-struct-return}.
14910 If you specify neither @option{-fpcc-struct-return} nor
14911 @option{-freg-struct-return}, GCC defaults to whichever convention is
14912 standard for the target.  If there is no standard convention, GCC
14913 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14914 the principal compiler.  In those cases, we can choose the standard, and
14915 we chose the more efficient register return alternative.
14917 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14918 switch is not binary compatible with code compiled with the
14919 @option{-fpcc-struct-return} switch.
14920 Use it to conform to a non-default application binary interface.
14922 @item -fshort-enums
14923 @opindex fshort-enums
14924 Allocate to an @code{enum} type only as many bytes as it needs for the
14925 declared range of possible values.  Specifically, the @code{enum} type
14926 will be equivalent to the smallest integer type which has enough room.
14928 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14929 code that is not binary compatible with code generated without that switch.
14930 Use it to conform to a non-default application binary interface.
14932 @item -fshort-double
14933 @opindex fshort-double
14934 Use the same size for @code{double} as for @code{float}.
14936 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14937 code that is not binary compatible with code generated without that switch.
14938 Use it to conform to a non-default application binary interface.
14940 @item -fshort-wchar
14941 @opindex fshort-wchar
14942 Override the underlying type for @samp{wchar_t} to be @samp{short
14943 unsigned int} instead of the default for the target.  This option is
14944 useful for building programs to run under WINE@.
14946 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14947 code that is not binary compatible with code generated without that switch.
14948 Use it to conform to a non-default application binary interface.
14950 @item -fno-common
14951 @opindex fno-common
14952 In C, allocate even uninitialized global variables in the data section of the
14953 object file, rather than generating them as common blocks.  This has the
14954 effect that if the same variable is declared (without @code{extern}) in
14955 two different compilations, you will get an error when you link them.
14956 The only reason this might be useful is if you wish to verify that the
14957 program will work on other systems which always work this way.
14959 @item -fno-ident
14960 @opindex fno-ident
14961 Ignore the @samp{#ident} directive.
14963 @item -finhibit-size-directive
14964 @opindex finhibit-size-directive
14965 Don't output a @code{.size} assembler directive, or anything else that
14966 would cause trouble if the function is split in the middle, and the
14967 two halves are placed at locations far apart in memory.  This option is
14968 used when compiling @file{crtstuff.c}; you should not need to use it
14969 for anything else.
14971 @item -fverbose-asm
14972 @opindex fverbose-asm
14973 Put extra commentary information in the generated assembly code to
14974 make it more readable.  This option is generally only of use to those
14975 who actually need to read the generated assembly code (perhaps while
14976 debugging the compiler itself).
14978 @option{-fno-verbose-asm}, the default, causes the
14979 extra information to be omitted and is useful when comparing two assembler
14980 files.
14982 @item -frecord-gcc-switches
14983 @opindex frecord-gcc-switches
14984 This switch causes the command line that was used to invoke the
14985 compiler to be recorded into the object file that is being created.
14986 This switch is only implemented on some targets and the exact format
14987 of the recording is target and binary file format dependent, but it
14988 usually takes the form of a section containing ASCII text.  This
14989 switch is related to the @option{-fverbose-asm} switch, but that
14990 switch only records information in the assembler output file as
14991 comments, so it never reaches the object file.
14993 @item -fpic
14994 @opindex fpic
14995 @cindex global offset table
14996 @cindex PIC
14997 Generate position-independent code (PIC) suitable for use in a shared
14998 library, if supported for the target machine.  Such code accesses all
14999 constant addresses through a global offset table (GOT)@.  The dynamic
15000 loader resolves the GOT entries when the program starts (the dynamic
15001 loader is not part of GCC; it is part of the operating system).  If
15002 the GOT size for the linked executable exceeds a machine-specific
15003 maximum size, you get an error message from the linker indicating that
15004 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
15005 instead.  (These maximums are 8k on the SPARC and 32k
15006 on the m68k and RS/6000.  The 386 has no such limit.)
15008 Position-independent code requires special support, and therefore works
15009 only on certain machines.  For the 386, GCC supports PIC for System V
15010 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
15011 position-independent.
15013 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15014 are defined to 1.
15016 @item -fPIC
15017 @opindex fPIC
15018 If supported for the target machine, emit position-independent code,
15019 suitable for dynamic linking and avoiding any limit on the size of the
15020 global offset table.  This option makes a difference on the m68k,
15021 PowerPC and SPARC@.
15023 Position-independent code requires special support, and therefore works
15024 only on certain machines.
15026 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
15027 are defined to 2.
15029 @item -fpie
15030 @itemx -fPIE
15031 @opindex fpie
15032 @opindex fPIE
15033 These options are similar to @option{-fpic} and @option{-fPIC}, but
15034 generated position independent code can be only linked into executables.
15035 Usually these options are used when @option{-pie} GCC option will be
15036 used during linking.
15038 @option{-fpie} and @option{-fPIE} both define the macros
15039 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
15040 for @option{-fpie} and 2 for @option{-fPIE}.
15042 @item -fno-jump-tables
15043 @opindex fno-jump-tables
15044 Do not use jump tables for switch statements even where it would be
15045 more efficient than other code generation strategies.  This option is
15046 of use in conjunction with @option{-fpic} or @option{-fPIC} for
15047 building code which forms part of a dynamic linker and cannot
15048 reference the address of a jump table.  On some targets, jump tables
15049 do not require a GOT and this option is not needed.
15051 @item -ffixed-@var{reg}
15052 @opindex ffixed
15053 Treat the register named @var{reg} as a fixed register; generated code
15054 should never refer to it (except perhaps as a stack pointer, frame
15055 pointer or in some other fixed role).
15057 @var{reg} must be the name of a register.  The register names accepted
15058 are machine-specific and are defined in the @code{REGISTER_NAMES}
15059 macro in the machine description macro file.
15061 This flag does not have a negative form, because it specifies a
15062 three-way choice.
15064 @item -fcall-used-@var{reg}
15065 @opindex fcall-used
15066 Treat the register named @var{reg} as an allocable register that is
15067 clobbered by function calls.  It may be allocated for temporaries or
15068 variables that do not live across a call.  Functions compiled this way
15069 will not save and restore the register @var{reg}.
15071 It is an error to used this flag with the frame pointer or stack pointer.
15072 Use of this flag for other registers that have fixed pervasive roles in
15073 the machine's execution model will produce disastrous results.
15075 This flag does not have a negative form, because it specifies a
15076 three-way choice.
15078 @item -fcall-saved-@var{reg}
15079 @opindex fcall-saved
15080 Treat the register named @var{reg} as an allocable register saved by
15081 functions.  It may be allocated even for temporaries or variables that
15082 live across a call.  Functions compiled this way will save and restore
15083 the register @var{reg} if they use it.
15085 It is an error to used this flag with the frame pointer or stack pointer.
15086 Use of this flag for other registers that have fixed pervasive roles in
15087 the machine's execution model will produce disastrous results.
15089 A different sort of disaster will result from the use of this flag for
15090 a register in which function values may be returned.
15092 This flag does not have a negative form, because it specifies a
15093 three-way choice.
15095 @item -fpack-struct[=@var{n}]
15096 @opindex fpack-struct
15097 Without a value specified, pack all structure members together without
15098 holes.  When a value is specified (which must be a small power of two), pack
15099 structure members according to this value, representing the maximum
15100 alignment (that is, objects with default alignment requirements larger than
15101 this will be output potentially unaligned at the next fitting location.
15103 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
15104 code that is not binary compatible with code generated without that switch.
15105 Additionally, it makes the code suboptimal.
15106 Use it to conform to a non-default application binary interface.
15108 @item -finstrument-functions
15109 @opindex finstrument-functions
15110 Generate instrumentation calls for entry and exit to functions.  Just
15111 after function entry and just before function exit, the following
15112 profiling functions will be called with the address of the current
15113 function and its call site.  (On some platforms,
15114 @code{__builtin_return_address} does not work beyond the current
15115 function, so the call site information may not be available to the
15116 profiling functions otherwise.)
15118 @smallexample
15119 void __cyg_profile_func_enter (void *this_fn,
15120                                void *call_site);
15121 void __cyg_profile_func_exit  (void *this_fn,
15122                                void *call_site);
15123 @end smallexample
15125 The first argument is the address of the start of the current function,
15126 which may be looked up exactly in the symbol table.
15128 This instrumentation is also done for functions expanded inline in other
15129 functions.  The profiling calls will indicate where, conceptually, the
15130 inline function is entered and exited.  This means that addressable
15131 versions of such functions must be available.  If all your uses of a
15132 function are expanded inline, this may mean an additional expansion of
15133 code size.  If you use @samp{extern inline} in your C code, an
15134 addressable version of such functions must be provided.  (This is
15135 normally the case anyways, but if you get lucky and the optimizer always
15136 expands the functions inline, you might have gotten away without
15137 providing static copies.)
15139 A function may be given the attribute @code{no_instrument_function}, in
15140 which case this instrumentation will not be done.  This can be used, for
15141 example, for the profiling functions listed above, high-priority
15142 interrupt routines, and any functions from which the profiling functions
15143 cannot safely be called (perhaps signal handlers, if the profiling
15144 routines generate output or allocate memory).
15146 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
15147 @opindex finstrument-functions-exclude-file-list
15149 Set the list of functions that are excluded from instrumentation (see
15150 the description of @code{-finstrument-functions}).  If the file that
15151 contains a function definition matches with one of @var{file}, then
15152 that function is not instrumented.  The match is done on substrings:
15153 if the @var{file} parameter is a substring of the file name, it is
15154 considered to be a match.
15156 For example,
15157 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
15158 will exclude any inline function defined in files whose pathnames
15159 contain @code{/bits/stl} or @code{include/sys}.
15161 If, for some reason, you want to include letter @code{','} in one of
15162 @var{sym}, write @code{'\,'}. For example,
15163 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
15164 (note the single quote surrounding the option).
15166 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
15167 @opindex finstrument-functions-exclude-function-list
15169 This is similar to @code{-finstrument-functions-exclude-file-list},
15170 but this option sets the list of function names to be excluded from
15171 instrumentation.  The function name to be matched is its user-visible
15172 name, such as @code{vector<int> blah(const vector<int> &)}, not the
15173 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
15174 match is done on substrings: if the @var{sym} parameter is a substring
15175 of the function name, it is considered to be a match.
15177 @item -fstack-check
15178 @opindex fstack-check
15179 Generate code to verify that you do not go beyond the boundary of the
15180 stack.  You should specify this flag if you are running in an
15181 environment with multiple threads, but only rarely need to specify it in
15182 a single-threaded environment since stack overflow is automatically
15183 detected on nearly all systems if there is only one stack.
15185 Note that this switch does not actually cause checking to be done; the
15186 operating system must do that.  The switch causes generation of code
15187 to ensure that the operating system sees the stack being extended.
15189 @item -fstack-limit-register=@var{reg}
15190 @itemx -fstack-limit-symbol=@var{sym}
15191 @itemx -fno-stack-limit
15192 @opindex fstack-limit-register
15193 @opindex fstack-limit-symbol
15194 @opindex fno-stack-limit
15195 Generate code to ensure that the stack does not grow beyond a certain value,
15196 either the value of a register or the address of a symbol.  If the stack
15197 would grow beyond the value, a signal is raised.  For most targets,
15198 the signal is raised before the stack overruns the boundary, so
15199 it is possible to catch the signal without taking special precautions.
15201 For instance, if the stack starts at absolute address @samp{0x80000000}
15202 and grows downwards, you can use the flags
15203 @option{-fstack-limit-symbol=__stack_limit} and
15204 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
15205 of 128KB@.  Note that this may only work with the GNU linker.
15207 @cindex aliasing of parameters
15208 @cindex parameters, aliased
15209 @item -fargument-alias
15210 @itemx -fargument-noalias
15211 @itemx -fargument-noalias-global
15212 @itemx -fargument-noalias-anything
15213 @opindex fargument-alias
15214 @opindex fargument-noalias
15215 @opindex fargument-noalias-global
15216 @opindex fargument-noalias-anything
15217 Specify the possible relationships among parameters and between
15218 parameters and global data.
15220 @option{-fargument-alias} specifies that arguments (parameters) may
15221 alias each other and may alias global storage.@*
15222 @option{-fargument-noalias} specifies that arguments do not alias
15223 each other, but may alias global storage.@*
15224 @option{-fargument-noalias-global} specifies that arguments do not
15225 alias each other and do not alias global storage.
15226 @option{-fargument-noalias-anything} specifies that arguments do not
15227 alias any other storage.
15229 Each language will automatically use whatever option is required by
15230 the language standard.  You should not need to use these options yourself.
15232 @item -fleading-underscore
15233 @opindex fleading-underscore
15234 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
15235 change the way C symbols are represented in the object file.  One use
15236 is to help link with legacy assembly code.
15238 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
15239 generate code that is not binary compatible with code generated without that
15240 switch.  Use it to conform to a non-default application binary interface.
15241 Not all targets provide complete support for this switch.
15243 @item -ftls-model=@var{model}
15244 @opindex ftls-model
15245 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
15246 The @var{model} argument should be one of @code{global-dynamic},
15247 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
15249 The default without @option{-fpic} is @code{initial-exec}; with
15250 @option{-fpic} the default is @code{global-dynamic}.
15252 @item -fvisibility=@var{default|internal|hidden|protected}
15253 @opindex fvisibility
15254 Set the default ELF image symbol visibility to the specified option---all
15255 symbols will be marked with this unless overridden within the code.
15256 Using this feature can very substantially improve linking and
15257 load times of shared object libraries, produce more optimized
15258 code, provide near-perfect API export and prevent symbol clashes.
15259 It is @strong{strongly} recommended that you use this in any shared objects
15260 you distribute.
15262 Despite the nomenclature, @code{default} always means public ie;
15263 available to be linked against from outside the shared object.
15264 @code{protected} and @code{internal} are pretty useless in real-world
15265 usage so the only other commonly used option will be @code{hidden}.
15266 The default if @option{-fvisibility} isn't specified is
15267 @code{default}, i.e., make every
15268 symbol public---this causes the same behavior as previous versions of
15269 GCC@.
15271 A good explanation of the benefits offered by ensuring ELF
15272 symbols have the correct visibility is given by ``How To Write
15273 Shared Libraries'' by Ulrich Drepper (which can be found at
15274 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
15275 solution made possible by this option to marking things hidden when
15276 the default is public is to make the default hidden and mark things
15277 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
15278 and @code{__attribute__ ((visibility("default")))} instead of
15279 @code{__declspec(dllexport)} you get almost identical semantics with
15280 identical syntax.  This is a great boon to those working with
15281 cross-platform projects.
15283 For those adding visibility support to existing code, you may find
15284 @samp{#pragma GCC visibility} of use.  This works by you enclosing
15285 the declarations you wish to set visibility for with (for example)
15286 @samp{#pragma GCC visibility push(hidden)} and
15287 @samp{#pragma GCC visibility pop}.
15288 Bear in mind that symbol visibility should be viewed @strong{as
15289 part of the API interface contract} and thus all new code should
15290 always specify visibility when it is not the default ie; declarations
15291 only for use within the local DSO should @strong{always} be marked explicitly
15292 as hidden as so to avoid PLT indirection overheads---making this
15293 abundantly clear also aids readability and self-documentation of the code.
15294 Note that due to ISO C++ specification requirements, operator new and
15295 operator delete must always be of default visibility.
15297 Be aware that headers from outside your project, in particular system
15298 headers and headers from any other library you use, may not be
15299 expecting to be compiled with visibility other than the default.  You
15300 may need to explicitly say @samp{#pragma GCC visibility push(default)}
15301 before including any such headers.
15303 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
15304 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
15305 no modifications.  However, this means that calls to @samp{extern}
15306 functions with no explicit visibility will use the PLT, so it is more
15307 effective to use @samp{__attribute ((visibility))} and/or
15308 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
15309 declarations should be treated as hidden.
15311 Note that @samp{-fvisibility} does affect C++ vague linkage
15312 entities. This means that, for instance, an exception class that will
15313 be thrown between DSOs must be explicitly marked with default
15314 visibility so that the @samp{type_info} nodes will be unified between
15315 the DSOs.
15317 An overview of these techniques, their benefits and how to use them
15318 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
15320 @end table
15322 @c man end
15324 @node Environment Variables
15325 @section Environment Variables Affecting GCC
15326 @cindex environment variables
15328 @c man begin ENVIRONMENT
15329 This section describes several environment variables that affect how GCC
15330 operates.  Some of them work by specifying directories or prefixes to use
15331 when searching for various kinds of files.  Some are used to specify other
15332 aspects of the compilation environment.
15334 Note that you can also specify places to search using options such as
15335 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15336 take precedence over places specified using environment variables, which
15337 in turn take precedence over those specified by the configuration of GCC@.
15338 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15339 GNU Compiler Collection (GCC) Internals}.
15341 @table @env
15342 @item LANG
15343 @itemx LC_CTYPE
15344 @c @itemx LC_COLLATE
15345 @itemx LC_MESSAGES
15346 @c @itemx LC_MONETARY
15347 @c @itemx LC_NUMERIC
15348 @c @itemx LC_TIME
15349 @itemx LC_ALL
15350 @findex LANG
15351 @findex LC_CTYPE
15352 @c @findex LC_COLLATE
15353 @findex LC_MESSAGES
15354 @c @findex LC_MONETARY
15355 @c @findex LC_NUMERIC
15356 @c @findex LC_TIME
15357 @findex LC_ALL
15358 @cindex locale
15359 These environment variables control the way that GCC uses
15360 localization information that allow GCC to work with different
15361 national conventions.  GCC inspects the locale categories
15362 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15363 so.  These locale categories can be set to any value supported by your
15364 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15365 Kingdom encoded in UTF-8.
15367 The @env{LC_CTYPE} environment variable specifies character
15368 classification.  GCC uses it to determine the character boundaries in
15369 a string; this is needed for some multibyte encodings that contain quote
15370 and escape characters that would otherwise be interpreted as a string
15371 end or escape.
15373 The @env{LC_MESSAGES} environment variable specifies the language to
15374 use in diagnostic messages.
15376 If the @env{LC_ALL} environment variable is set, it overrides the value
15377 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15378 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15379 environment variable.  If none of these variables are set, GCC
15380 defaults to traditional C English behavior.
15382 @item TMPDIR
15383 @findex TMPDIR
15384 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15385 files.  GCC uses temporary files to hold the output of one stage of
15386 compilation which is to be used as input to the next stage: for example,
15387 the output of the preprocessor, which is the input to the compiler
15388 proper.
15390 @item GCC_EXEC_PREFIX
15391 @findex GCC_EXEC_PREFIX
15392 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15393 names of the subprograms executed by the compiler.  No slash is added
15394 when this prefix is combined with the name of a subprogram, but you can
15395 specify a prefix that ends with a slash if you wish.
15397 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15398 an appropriate prefix to use based on the pathname it was invoked with.
15400 If GCC cannot find the subprogram using the specified prefix, it
15401 tries looking in the usual places for the subprogram.
15403 The default value of @env{GCC_EXEC_PREFIX} is
15404 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15405 the installed compiler. In many cases @var{prefix} is the value
15406 of @code{prefix} when you ran the @file{configure} script.
15408 Other prefixes specified with @option{-B} take precedence over this prefix.
15410 This prefix is also used for finding files such as @file{crt0.o} that are
15411 used for linking.
15413 In addition, the prefix is used in an unusual way in finding the
15414 directories to search for header files.  For each of the standard
15415 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15416 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15417 replacing that beginning with the specified prefix to produce an
15418 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15419 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15420 These alternate directories are searched first; the standard directories
15421 come next. If a standard directory begins with the configured
15422 @var{prefix} then the value of @var{prefix} is replaced by
15423 @env{GCC_EXEC_PREFIX} when looking for header files.
15425 @item COMPILER_PATH
15426 @findex COMPILER_PATH
15427 The value of @env{COMPILER_PATH} is a colon-separated list of
15428 directories, much like @env{PATH}.  GCC tries the directories thus
15429 specified when searching for subprograms, if it can't find the
15430 subprograms using @env{GCC_EXEC_PREFIX}.
15432 @item LIBRARY_PATH
15433 @findex LIBRARY_PATH
15434 The value of @env{LIBRARY_PATH} is a colon-separated list of
15435 directories, much like @env{PATH}.  When configured as a native compiler,
15436 GCC tries the directories thus specified when searching for special
15437 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15438 using GCC also uses these directories when searching for ordinary
15439 libraries for the @option{-l} option (but directories specified with
15440 @option{-L} come first).
15442 @item LANG
15443 @findex LANG
15444 @cindex locale definition
15445 This variable is used to pass locale information to the compiler.  One way in
15446 which this information is used is to determine the character set to be used
15447 when character literals, string literals and comments are parsed in C and C++.
15448 When the compiler is configured to allow multibyte characters,
15449 the following values for @env{LANG} are recognized:
15451 @table @samp
15452 @item C-JIS
15453 Recognize JIS characters.
15454 @item C-SJIS
15455 Recognize SJIS characters.
15456 @item C-EUCJP
15457 Recognize EUCJP characters.
15458 @end table
15460 If @env{LANG} is not defined, or if it has some other value, then the
15461 compiler will use mblen and mbtowc as defined by the default locale to
15462 recognize and translate multibyte characters.
15463 @end table
15465 @noindent
15466 Some additional environments variables affect the behavior of the
15467 preprocessor.
15469 @include cppenv.texi
15471 @c man end
15473 @node Precompiled Headers
15474 @section Using Precompiled Headers
15475 @cindex precompiled headers
15476 @cindex speed of compilation
15478 Often large projects have many header files that are included in every
15479 source file.  The time the compiler takes to process these header files
15480 over and over again can account for nearly all of the time required to
15481 build the project.  To make builds faster, GCC allows users to
15482 `precompile' a header file; then, if builds can use the precompiled
15483 header file they will be much faster.
15485 To create a precompiled header file, simply compile it as you would any
15486 other file, if necessary using the @option{-x} option to make the driver
15487 treat it as a C or C++ header file.  You will probably want to use a
15488 tool like @command{make} to keep the precompiled header up-to-date when
15489 the headers it contains change.
15491 A precompiled header file will be searched for when @code{#include} is
15492 seen in the compilation.  As it searches for the included file
15493 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15494 compiler looks for a precompiled header in each directory just before it
15495 looks for the include file in that directory.  The name searched for is
15496 the name specified in the @code{#include} with @samp{.gch} appended.  If
15497 the precompiled header file can't be used, it is ignored.
15499 For instance, if you have @code{#include "all.h"}, and you have
15500 @file{all.h.gch} in the same directory as @file{all.h}, then the
15501 precompiled header file will be used if possible, and the original
15502 header will be used otherwise.
15504 Alternatively, you might decide to put the precompiled header file in a
15505 directory and use @option{-I} to ensure that directory is searched
15506 before (or instead of) the directory containing the original header.
15507 Then, if you want to check that the precompiled header file is always
15508 used, you can put a file of the same name as the original header in this
15509 directory containing an @code{#error} command.
15511 This also works with @option{-include}.  So yet another way to use
15512 precompiled headers, good for projects not designed with precompiled
15513 header files in mind, is to simply take most of the header files used by
15514 a project, include them from another header file, precompile that header
15515 file, and @option{-include} the precompiled header.  If the header files
15516 have guards against multiple inclusion, they will be skipped because
15517 they've already been included (in the precompiled header).
15519 If you need to precompile the same header file for different
15520 languages, targets, or compiler options, you can instead make a
15521 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15522 header in the directory, perhaps using @option{-o}.  It doesn't matter
15523 what you call the files in the directory, every precompiled header in
15524 the directory will be considered.  The first precompiled header
15525 encountered in the directory that is valid for this compilation will
15526 be used; they're searched in no particular order.
15528 There are many other possibilities, limited only by your imagination,
15529 good sense, and the constraints of your build system.
15531 A precompiled header file can be used only when these conditions apply:
15533 @itemize
15534 @item
15535 Only one precompiled header can be used in a particular compilation.
15537 @item
15538 A precompiled header can't be used once the first C token is seen.  You
15539 can have preprocessor directives before a precompiled header; you can
15540 even include a precompiled header from inside another header, so long as
15541 there are no C tokens before the @code{#include}.
15543 @item
15544 The precompiled header file must be produced for the same language as
15545 the current compilation.  You can't use a C precompiled header for a C++
15546 compilation.
15548 @item
15549 The precompiled header file must have been produced by the same compiler
15550 binary as the current compilation is using.
15552 @item
15553 Any macros defined before the precompiled header is included must
15554 either be defined in the same way as when the precompiled header was
15555 generated, or must not affect the precompiled header, which usually
15556 means that they don't appear in the precompiled header at all.
15558 The @option{-D} option is one way to define a macro before a
15559 precompiled header is included; using a @code{#define} can also do it.
15560 There are also some options that define macros implicitly, like
15561 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15562 defined this way.
15564 @item If debugging information is output when using the precompiled
15565 header, using @option{-g} or similar, the same kind of debugging information
15566 must have been output when building the precompiled header.  However,
15567 a precompiled header built using @option{-g} can be used in a compilation
15568 when no debugging information is being output.
15570 @item The same @option{-m} options must generally be used when building
15571 and using the precompiled header.  @xref{Submodel Options},
15572 for any cases where this rule is relaxed.
15574 @item Each of the following options must be the same when building and using
15575 the precompiled header:
15577 @gccoptlist{-fexceptions -funit-at-a-time}
15579 @item
15580 Some other command-line options starting with @option{-f},
15581 @option{-p}, or @option{-O} must be defined in the same way as when
15582 the precompiled header was generated.  At present, it's not clear
15583 which options are safe to change and which are not; the safest choice
15584 is to use exactly the same options when generating and using the
15585 precompiled header.  The following are known to be safe:
15587 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15588 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15589 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15590 -pedantic-errors}
15592 @end itemize
15594 For all of these except the last, the compiler will automatically
15595 ignore the precompiled header if the conditions aren't met.  If you
15596 find an option combination that doesn't work and doesn't cause the
15597 precompiled header to be ignored, please consider filing a bug report,
15598 see @ref{Bugs}.
15600 If you do use differing options when generating and using the
15601 precompiled header, the actual behavior will be a mixture of the
15602 behavior for the options.  For instance, if you use @option{-g} to
15603 generate the precompiled header but not when using it, you may or may
15604 not get debugging information for routines in the precompiled header.
15606 @node Running Protoize
15607 @section Running Protoize
15609 The program @code{protoize} is an optional part of GCC@.  You can use
15610 it to add prototypes to a program, thus converting the program to ISO
15611 C in one respect.  The companion program @code{unprotoize} does the
15612 reverse: it removes argument types from any prototypes that are found.
15614 When you run these programs, you must specify a set of source files as
15615 command line arguments.  The conversion programs start out by compiling
15616 these files to see what functions they define.  The information gathered
15617 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15619 After scanning comes actual conversion.  The specified files are all
15620 eligible to be converted; any files they include (whether sources or
15621 just headers) are eligible as well.
15623 But not all the eligible files are converted.  By default,
15624 @code{protoize} and @code{unprotoize} convert only source and header
15625 files in the current directory.  You can specify additional directories
15626 whose files should be converted with the @option{-d @var{directory}}
15627 option.  You can also specify particular files to exclude with the
15628 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15629 directory name matches one of the specified directory names, and its
15630 name within the directory has not been excluded.
15632 Basic conversion with @code{protoize} consists of rewriting most
15633 function definitions and function declarations to specify the types of
15634 the arguments.  The only ones not rewritten are those for varargs
15635 functions.
15637 @code{protoize} optionally inserts prototype declarations at the
15638 beginning of the source file, to make them available for any calls that
15639 precede the function's definition.  Or it can insert prototype
15640 declarations with block scope in the blocks where undeclared functions
15641 are called.
15643 Basic conversion with @code{unprotoize} consists of rewriting most
15644 function declarations to remove any argument types, and rewriting
15645 function definitions to the old-style pre-ISO form.
15647 Both conversion programs print a warning for any function declaration or
15648 definition that they can't convert.  You can suppress these warnings
15649 with @option{-q}.
15651 The output from @code{protoize} or @code{unprotoize} replaces the
15652 original source file.  The original file is renamed to a name ending
15653 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15654 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15655 for DOS) file already exists, then the source file is simply discarded.
15657 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15658 scan the program and collect information about the functions it uses.
15659 So neither of these programs will work until GCC is installed.
15661 Here is a table of the options you can use with @code{protoize} and
15662 @code{unprotoize}.  Each option works with both programs unless
15663 otherwise stated.
15665 @table @code
15666 @item -B @var{directory}
15667 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15668 usual directory (normally @file{/usr/local/lib}).  This file contains
15669 prototype information about standard system functions.  This option
15670 applies only to @code{protoize}.
15672 @item -c @var{compilation-options}
15673 Use @var{compilation-options} as the options when running @command{gcc} to
15674 produce the @samp{.X} files.  The special option @option{-aux-info} is
15675 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15677 Note that the compilation options must be given as a single argument to
15678 @code{protoize} or @code{unprotoize}.  If you want to specify several
15679 @command{gcc} options, you must quote the entire set of compilation options
15680 to make them a single word in the shell.
15682 There are certain @command{gcc} arguments that you cannot use, because they
15683 would produce the wrong kind of output.  These include @option{-g},
15684 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15685 the @var{compilation-options}, they are ignored.
15687 @item -C
15688 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15689 systems) instead of @samp{.c}.  This is convenient if you are converting
15690 a C program to C++.  This option applies only to @code{protoize}.
15692 @item -g
15693 Add explicit global declarations.  This means inserting explicit
15694 declarations at the beginning of each source file for each function
15695 that is called in the file and was not declared.  These declarations
15696 precede the first function definition that contains a call to an
15697 undeclared function.  This option applies only to @code{protoize}.
15699 @item -i @var{string}
15700 Indent old-style parameter declarations with the string @var{string}.
15701 This option applies only to @code{protoize}.
15703 @code{unprotoize} converts prototyped function definitions to old-style
15704 function definitions, where the arguments are declared between the
15705 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15706 uses five spaces as the indentation.  If you want to indent with just
15707 one space instead, use @option{-i " "}.
15709 @item -k
15710 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15711 is finished.
15713 @item -l
15714 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15715 a prototype declaration for each function in each block which calls the
15716 function without any declaration.  This option applies only to
15717 @code{protoize}.
15719 @item -n
15720 Make no real changes.  This mode just prints information about the conversions
15721 that would have been done without @option{-n}.
15723 @item -N
15724 Make no @samp{.save} files.  The original files are simply deleted.
15725 Use this option with caution.
15727 @item -p @var{program}
15728 Use the program @var{program} as the compiler.  Normally, the name
15729 @file{gcc} is used.
15731 @item -q
15732 Work quietly.  Most warnings are suppressed.
15734 @item -v
15735 Print the version number, just like @option{-v} for @command{gcc}.
15736 @end table
15738 If you need special compiler options to compile one of your program's
15739 source files, then you should generate that file's @samp{.X} file
15740 specially, by running @command{gcc} on that source file with the
15741 appropriate options and the option @option{-aux-info}.  Then run
15742 @code{protoize} on the entire set of files.  @code{protoize} will use
15743 the existing @samp{.X} file because it is newer than the source file.
15744 For example:
15746 @smallexample
15747 gcc -Dfoo=bar file1.c -aux-info file1.X
15748 protoize *.c
15749 @end smallexample
15751 @noindent
15752 You need to include the special files along with the rest in the
15753 @code{protoize} command, even though their @samp{.X} files already
15754 exist, because otherwise they won't get converted.
15756 @xref{Protoize Caveats}, for more information on how to use
15757 @code{protoize} successfully.