2007-12-17 Vladimir Makarov <vmakarov@redhat.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob4ca15d2d80737262f8db09b0b5e65acbf618bd12
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
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,
15 2007 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 @@@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++  -Wno-deprecated  -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-declarations @gol
234 -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-extra-args -Wformat-nonliteral @gol
239 -Wformat-security  -Wformat-y2k @gol
240 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
241 -Wimport  -Wno-import  -Winit-self  -Winline @gol
242 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
243 -Winvalid-pch -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations @gol
244 -Wlogical-op -Wlong-long @gol
245 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
246 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
247 -Wmissing-noreturn @gol
248 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
249 -Woverlength-strings  -Wpacked  -Wpadded @gol
250 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
251 -Wredundant-decls @gol
252 -Wreturn-type  -Wsequence-point  -Wshadow @gol
253 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
254 -Wstrict-aliasing -Wstrict-aliasing=n @gol
255 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
256 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
257 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
258 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
259 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
260 -Wunused-value  -Wunused-variable @gol
261 -Wvariadic-macros -Wvla @gol
262 -Wvolatile-register-var  -Wwrite-strings}
264 @item C-only Warning Options
265 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
266 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
267 -Wold-style-declaration  -Wold-style-definition @gol
268 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
269 -Wdeclaration-after-statement -Wpointer-sign}
271 @item Debugging Options
272 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
273 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
274 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
275 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
276 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
277 -fdump-simple-rtl @gol
278 -fdump-ipa-all -fdump-ipa-cgraph @gol
279 -fdump-tree-all @gol
280 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
281 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-inlined@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-salias @gol
297 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
299 -ftree-vectorizer-verbose=@var{n} @gol
300 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
301 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
302 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
303 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
304 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
305 -ftest-coverage  -ftime-report -fvar-tracking @gol
306 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
307 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
308 -fdebug-prefix-map=@var{old}=@var{new} @gol
309 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
310 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
311 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
312 -print-multi-directory  -print-multi-lib @gol
313 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
314 -print-sysroot-headers-suffix @gol
315 -save-temps  -time}
317 @item Optimization Options
318 @xref{Optimize Options,,Options that Control Optimization}.
319 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
320 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
321 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
322 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
323 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
324 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
325 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
326 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
327 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
328 -fforce-addr  -fforward-propagate  -ffunction-sections @gol
329 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
330 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
331 -finline-functions  -finline-functions-called-once @gol
332 -finline-limit=@var{n} -fira -fira-algorithm=@var{algorithm} @gol
333 -fira-coalesce -fira-ipra -fno-ira-move-spills @gol
334 -fira-propagate-cost @gol
335 -fno-ira-share-spill-slots -fno-ira-share-save-slots @gol
336 -fira-verbose=@var{n} @gol
337 -fkeep-inline-functions -fkeep-static-consts @gol
338 -fmerge-constants  -fmerge-all-constants @gol
339 -fmodulo-sched -fmodulo-sched-allow-regmoves -fno-branch-count-reg @gol
340 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
341 -fno-function-cse  -fno-guess-branch-probability @gol
342 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
343 -funsafe-math-optimizations  -funsafe-loop-optimizations @gol
344 -ffinite-math-only  -fno-signed-zeros @gol
345 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
346 -fomit-frame-pointer  -foptimize-register-move @gol
347 -foptimize-sibling-calls  -fpredictive-commoning -fprefetch-loop-arrays @gol
348 -fprofile-generate -fprofile-use @gol
349 -fregmove  -frename-registers @gol
350 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
351 -frerun-cse-after-loop @gol
352 -frounding-math -frtl-abstract-sequences @gol
353 -fschedule-insns  -fschedule-insns2 @gol
354 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
355 -fsched-spec-load-dangerous  @gol
356 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
357 -fsched2-use-superblocks @gol
358 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
359 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
360 -fno-split-wide-types -fstack-protector  -fstack-protector-all @gol
361 -fstrict-aliasing  -fstrict-overflow  -ftracer  -fthread-jumps @gol
362 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
363 -fsplit-ivs-in-unroller -funswitch-loops @gol
364 -fvariable-expansion-in-unroller -ftree-reassoc @gol
365 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
366 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
367 -fcheck-data-deps @gol
368 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
369 -ftree-ch -ftree-sra -ftree-ter -ftree-fre -ftree-vectorize @gol
370 -ftree-vect-loop-version -fvect-cost-model -ftree-salias -fipa-pta -fweb @gol
371 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
372 --param @var{name}=@var{value}
373 -O  -O0  -O1  -O2  -O3  -Os}
375 @item Preprocessor Options
376 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
377 @gccoptlist{-A@var{question}=@var{answer} @gol
378 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
379 -C  -dD  -dI  -dM  -dN @gol
380 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
381 -idirafter @var{dir} @gol
382 -include @var{file}  -imacros @var{file} @gol
383 -iprefix @var{file}  -iwithprefix @var{dir} @gol
384 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
385 -imultilib @var{dir} -isysroot @var{dir} @gol
386 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
387 -P  -fworking-directory  -remap @gol
388 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
389 -Xpreprocessor @var{option}}
391 @item Assembler Option
392 @xref{Assembler Options,,Passing Options to the Assembler}.
393 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
395 @item Linker Options
396 @xref{Link Options,,Options for Linking}.
397 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
398 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
399 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
400 -Wl,@var{option}  -Xlinker @var{option} @gol
401 -u @var{symbol}}
403 @item Directory Options
404 @xref{Directory Options,,Options for Directory Search}.
405 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
406 -specs=@var{file}  -I- --sysroot=@var{dir}}
408 @item Target Options
409 @c I wrote this xref this way to avoid overfull hbox. -- rms
410 @xref{Target Options}.
411 @gccoptlist{-V @var{version}  -b @var{machine}}
413 @item Machine Dependent Options
414 @xref{Submodel Options,,Hardware Models and Configurations}.
415 @c This list is ordered alphanumerically by subsection name.
416 @c Try and put the significant identifier (CPU or system) first,
417 @c so users have a clue at guessing where the ones they want will be.
419 @emph{ARC Options}
420 @gccoptlist{-EB  -EL @gol
421 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
422 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
424 @emph{ARM Options}
425 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
426 -mabi=@var{name} @gol
427 -mapcs-stack-check  -mno-apcs-stack-check @gol
428 -mapcs-float  -mno-apcs-float @gol
429 -mapcs-reentrant  -mno-apcs-reentrant @gol
430 -msched-prolog  -mno-sched-prolog @gol
431 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
432 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
433 -mthumb-interwork  -mno-thumb-interwork @gol
434 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
435 -mstructure-size-boundary=@var{n} @gol
436 -mabort-on-noreturn @gol
437 -mlong-calls  -mno-long-calls @gol
438 -msingle-pic-base  -mno-single-pic-base @gol
439 -mpic-register=@var{reg} @gol
440 -mnop-fun-dllimport @gol
441 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
442 -mpoke-function-name @gol
443 -mthumb  -marm @gol
444 -mtpcs-frame  -mtpcs-leaf-frame @gol
445 -mcaller-super-interworking  -mcallee-super-interworking @gol
446 -mtp=@var{name}}
448 @emph{AVR Options}
449 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
450 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
452 @emph{Blackfin Options}
453 @gccoptlist{-mcpu=@var{cpu}  -msim  -momit-leaf-frame-pointer @gol
454 -mno-omit-leaf-frame-pointer  -mspecld-anomaly  -mno-specld-anomaly @gol
455 -mcsync-anomaly  -mno-csync-anomaly  -mlow-64k  -mno-low64k @gol
456 -mstack-check-l1  -mid-shared-library  -mno-id-shared-library @gol
457 -mshared-library-id=@var{n}  -mleaf-id-shared-library @gol
458 -mno-leaf-id-shared-library  -msep-data  -mno-sep-data  -mlong-calls @gol
459 -mno-long-calls -mfast-fp -minline-plt}
461 @emph{CRIS Options}
462 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
463 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
464 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
465 -mstack-align  -mdata-align  -mconst-align @gol
466 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
467 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
468 -mmul-bug-workaround  -mno-mul-bug-workaround}
470 @emph{CRX Options}
471 @gccoptlist{-mmac -mpush-args}
473 @emph{Darwin Options}
474 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
475 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
476 -client_name  -compatibility_version  -current_version @gol
477 -dead_strip @gol
478 -dependency-file  -dylib_file  -dylinker_install_name @gol
479 -dynamic  -dynamiclib  -exported_symbols_list @gol
480 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
481 -force_flat_namespace  -headerpad_max_install_names @gol
482 -iframework @gol
483 -image_base  -init  -install_name  -keep_private_externs @gol
484 -multi_module  -multiply_defined  -multiply_defined_unused @gol
485 -noall_load   -no_dead_strip_inits_and_terms @gol
486 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
487 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
488 -private_bundle  -read_only_relocs  -sectalign @gol
489 -sectobjectsymbols  -whyload  -seg1addr @gol
490 -sectcreate  -sectobjectsymbols  -sectorder @gol
491 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
492 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
493 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
494 -single_module  -static  -sub_library  -sub_umbrella @gol
495 -twolevel_namespace  -umbrella  -undefined @gol
496 -unexported_symbols_list  -weak_reference_mismatches @gol
497 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
498 -mkernel -mone-byte-bool}
500 @emph{DEC Alpha Options}
501 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
502 -mieee  -mieee-with-inexact  -mieee-conformant @gol
503 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
504 -mtrap-precision=@var{mode}  -mbuild-constants @gol
505 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
506 -mbwx  -mmax  -mfix  -mcix @gol
507 -mfloat-vax  -mfloat-ieee @gol
508 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
509 -msmall-text  -mlarge-text @gol
510 -mmemory-latency=@var{time}}
512 @emph{DEC Alpha/VMS Options}
513 @gccoptlist{-mvms-return-codes}
515 @emph{FRV Options}
516 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
517 -mhard-float  -msoft-float @gol
518 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
519 -mdouble  -mno-double @gol
520 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
521 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
522 -mlinked-fp  -mlong-calls  -malign-labels @gol
523 -mlibrary-pic  -macc-4  -macc-8 @gol
524 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
525 -moptimize-membar -mno-optimize-membar @gol
526 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
527 -mvliw-branch  -mno-vliw-branch @gol
528 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
529 -mno-nested-cond-exec  -mtomcat-stats @gol
530 -mTLS -mtls @gol
531 -mcpu=@var{cpu}}
533 @emph{GNU/Linux Options}
534 @gccoptlist{-muclibc}
536 @emph{H8/300 Options}
537 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
539 @emph{HPPA Options}
540 @gccoptlist{-march=@var{architecture-type} @gol
541 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
542 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
543 -mfixed-range=@var{register-range} @gol
544 -mjump-in-delay -mlinker-opt -mlong-calls @gol
545 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
546 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
547 -mno-jump-in-delay  -mno-long-load-store @gol
548 -mno-portable-runtime  -mno-soft-float @gol
549 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
550 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
551 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
552 -munix=@var{unix-std}  -nolibdld  -static  -threads}
554 @emph{i386 and x86-64 Options}
555 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
556 -mfpmath=@var{unit} @gol
557 -masm=@var{dialect}  -mno-fancy-math-387 @gol
558 -mno-fp-ret-in-387  -msoft-float @gol
559 -mno-wide-multiply  -mrtd  -malign-double @gol
560 -mpreferred-stack-boundary=@var{num} -mcx16 -msahf -mrecip @gol
561 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 @gol
562 -msse4a -m3dnow -mpopcnt -mabm @gol
563 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
564 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
565 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
566 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
567 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
568 -mcmodel=@var{code-model} @gol
569 -m32  -m64 -mlarge-data-threshold=@var{num}}
571 @emph{IA-64 Options}
572 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
573 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
574 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
575 -minline-float-divide-max-throughput @gol
576 -minline-int-divide-min-latency @gol
577 -minline-int-divide-max-throughput  @gol
578 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
579 -mno-dwarf2-asm -mearly-stop-bits @gol
580 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
581 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
582 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
583 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
584 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
585 -mno-sched-prefer-non-data-spec-insns @gol
586 -mno-sched-prefer-non-control-spec-insns @gol
587 -mno-sched-count-spec-in-critical-path}
589 @emph{M32R/D Options}
590 @gccoptlist{-m32r2 -m32rx -m32r @gol
591 -mdebug @gol
592 -malign-loops -mno-align-loops @gol
593 -missue-rate=@var{number} @gol
594 -mbranch-cost=@var{number} @gol
595 -mmodel=@var{code-size-model-type} @gol
596 -msdata=@var{sdata-type} @gol
597 -mno-flush-func -mflush-func=@var{name} @gol
598 -mno-flush-trap -mflush-trap=@var{number} @gol
599 -G @var{num}}
601 @emph{M32C Options}
602 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
604 @emph{M680x0 Options}
605 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
606 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
607 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
608 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
609 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
610 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
611 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
612 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
614 @emph{M68hc1x Options}
615 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
616 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
617 -msoft-reg-count=@var{count}}
619 @emph{MCore Options}
620 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
621 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
622 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
623 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
624 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
626 @emph{MIPS Options}
627 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
628 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
629 -mips16  -mno-mips16  -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 @gol
636 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
637 -G@var{num}  -membedded-data  -mno-embedded-data @gol
638 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
639 -mcode-readable=@var{setting} @gol
640 -msplit-addresses  -mno-split-addresses @gol
641 -mexplicit-relocs  -mno-explicit-relocs @gol
642 -mcheck-zero-division  -mno-check-zero-division @gol
643 -mdivide-traps  -mdivide-breaks @gol
644 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
645 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
646 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
647 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130  -mno-fix-vr4130 @gol
648 -mfix-sb1  -mno-fix-sb1 @gol
649 -mflush-func=@var{func}  -mno-flush-func @gol
650 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
651 -mfp-exceptions -mno-fp-exceptions @gol
652 -mvr4130-align -mno-vr4130-align}
654 @emph{MMIX Options}
655 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
656 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
657 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
658 -mno-base-addresses  -msingle-exit  -mno-single-exit}
660 @emph{MN10300 Options}
661 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
662 -mam33  -mno-am33 @gol
663 -mam33-2  -mno-am33-2 @gol
664 -mreturn-pointer-on-d0 @gol
665 -mno-crt0  -mrelax}
667 @emph{MT Options}
668 @gccoptlist{-mno-crt0 -mbacc -msim @gol
669 -march=@var{cpu-type} }
671 @emph{PDP-11 Options}
672 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
673 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
674 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
675 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
676 -mbranch-expensive  -mbranch-cheap @gol
677 -msplit  -mno-split  -munix-asm  -mdec-asm}
679 @emph{PowerPC Options}
680 See RS/6000 and PowerPC Options.
682 @emph{RS/6000 and PowerPC Options}
683 @gccoptlist{-mcpu=@var{cpu-type} @gol
684 -mtune=@var{cpu-type} @gol
685 -mpower  -mno-power  -mpower2  -mno-power2 @gol
686 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
687 -maltivec  -mno-altivec @gol
688 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
689 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
690 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
691 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mdfp -mno-dfp @gol
692 -mnew-mnemonics  -mold-mnemonics @gol
693 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
694 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
695 -malign-power  -malign-natural @gol
696 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
697 -mstring  -mno-string  -mupdate  -mno-update @gol
698 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
699 -mstrict-align  -mno-strict-align  -mrelocatable @gol
700 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
701 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
702 -mdynamic-no-pic  -maltivec  -mswdiv @gol
703 -mprioritize-restricted-insns=@var{priority} @gol
704 -msched-costly-dep=@var{dependence_type} @gol
705 -minsert-sched-nops=@var{scheme} @gol
706 -mcall-sysv  -mcall-netbsd @gol
707 -maix-struct-return  -msvr4-struct-return @gol
708 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
709 -misel -mno-isel @gol
710 -misel=yes  -misel=no @gol
711 -mspe -mno-spe @gol
712 -mspe=yes  -mspe=no @gol
713 -mvrsave -mno-vrsave @gol
714 -mmulhw -mno-mulhw @gol
715 -mdlmzb -mno-dlmzb @gol
716 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
717 -mprototype  -mno-prototype @gol
718 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
719 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
721 @emph{S/390 and zSeries Options}
722 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
723 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
724 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
725 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
726 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
727 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
728 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
730 @emph{Score Options}
731 @gccoptlist{-meb -mel @gol
732 -mnhwloop @gol
733 -muls @gol
734 -mmac @gol
735 -mscore5 -mscore5u -mscore7 -mscore7d}
737 @emph{SH Options}
738 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
739 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
740 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
741 -m5-64media  -m5-64media-nofpu @gol
742 -m5-32media  -m5-32media-nofpu @gol
743 -m5-compact  -m5-compact-nofpu @gol
744 -mb  -ml  -mdalign  -mrelax @gol
745 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
746 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
747 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
748 -mdivsi3_libfunc=@var{name}  @gol
749 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
750  -minvalid-symbols}
752 @emph{SPARC Options}
753 @gccoptlist{-mcpu=@var{cpu-type} @gol
754 -mtune=@var{cpu-type} @gol
755 -mcmodel=@var{code-model} @gol
756 -m32  -m64  -mapp-regs  -mno-app-regs @gol
757 -mfaster-structs  -mno-faster-structs @gol
758 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
759 -mhard-quad-float  -msoft-quad-float @gol
760 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
761 -mstack-bias  -mno-stack-bias @gol
762 -munaligned-doubles  -mno-unaligned-doubles @gol
763 -mv8plus  -mno-v8plus  -mvis  -mno-vis
764 -threads -pthreads -pthread}
766 @emph{SPU Options}
767 @gccoptlist{-mwarn-reloc -merror-reloc @gol
768 -msafe-dma -munsafe-dma @gol
769 -mbranch-hints @gol
770 -msmall-mem -mlarge-mem -mstdmain @gol
771 -mfixed-range=@var{register-range}}
773 @emph{System V Options}
774 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
776 @emph{TMS320C3x/C4x Options}
777 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
778 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
779 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
780 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
782 @emph{V850 Options}
783 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
784 -mprolog-function  -mno-prolog-function  -mspace @gol
785 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
786 -mapp-regs  -mno-app-regs @gol
787 -mdisable-callt  -mno-disable-callt @gol
788 -mv850e1 @gol
789 -mv850e @gol
790 -mv850  -mbig-switch}
792 @emph{VAX Options}
793 @gccoptlist{-mg  -mgnu  -munix}
795 @emph{VxWorks Options}
796 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
797 -Xbind-lazy  -Xbind-now}
799 @emph{x86-64 Options}
800 See i386 and x86-64 Options.
802 @emph{Xstormy16 Options}
803 @gccoptlist{-msim}
805 @emph{Xtensa Options}
806 @gccoptlist{-mconst16 -mno-const16 @gol
807 -mfused-madd  -mno-fused-madd @gol
808 -mtext-section-literals  -mno-text-section-literals @gol
809 -mtarget-align  -mno-target-align @gol
810 -mlongcalls  -mno-longcalls}
812 @emph{zSeries Options}
813 See S/390 and zSeries Options.
815 @item Code Generation Options
816 @xref{Code Gen Options,,Options for Code Generation Conventions}.
817 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
818 -ffixed-@var{reg}  -fexceptions @gol
819 -fnon-call-exceptions  -funwind-tables @gol
820 -fasynchronous-unwind-tables @gol
821 -finhibit-size-directive  -finstrument-functions @gol
822 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
823 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
824 -fno-common  -fno-ident @gol
825 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
826 -fno-jump-tables @gol
827 -frecord-gcc-switches @gol
828 -freg-struct-return  -fshort-enums @gol
829 -fshort-double  -fshort-wchar @gol
830 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
831 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
832 -fargument-alias  -fargument-noalias @gol
833 -fargument-noalias-global  -fargument-noalias-anything
834 -fleading-underscore  -ftls-model=@var{model} @gol
835 -ftrapv  -fwrapv  -fbounds-check @gol
836 -fvisibility}
837 @end table
839 @menu
840 * Overall Options::     Controlling the kind of output:
841                         an executable, object files, assembler files,
842                         or preprocessed source.
843 * C Dialect Options::   Controlling the variant of C language compiled.
844 * C++ Dialect Options:: Variations on C++.
845 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
846                         and Objective-C++.
847 * Language Independent Options:: Controlling how diagnostics should be
848                         formatted.
849 * Warning Options::     How picky should the compiler be?
850 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
851 * Optimize Options::    How much optimization?
852 * Preprocessor Options:: Controlling header files and macro definitions.
853                          Also, getting dependency information for Make.
854 * Assembler Options::   Passing options to the assembler.
855 * Link Options::        Specifying libraries and so on.
856 * Directory Options::   Where to find header files and libraries.
857                         Where to find the compiler executable files.
858 * Spec Files::          How to pass switches to sub-processes.
859 * Target Options::      Running a cross-compiler, or an old version of GCC.
860 @end menu
862 @node Overall Options
863 @section Options Controlling the Kind of Output
865 Compilation can involve up to four stages: preprocessing, compilation
866 proper, assembly and linking, always in that order.  GCC is capable of
867 preprocessing and compiling several files either into several
868 assembler input files, or into one assembler input file; then each
869 assembler input file produces an object file, and linking combines all
870 the object files (those newly compiled, and those specified as input)
871 into an executable file.
873 @cindex file name suffix
874 For any given input file, the file name suffix determines what kind of
875 compilation is done:
877 @table @gcctabopt
878 @item @var{file}.c
879 C source code which must be preprocessed.
881 @item @var{file}.i
882 C source code which should not be preprocessed.
884 @item @var{file}.ii
885 C++ source code which should not be preprocessed.
887 @item @var{file}.m
888 Objective-C source code.  Note that you must link with the @file{libobjc}
889 library to make an Objective-C program work.
891 @item @var{file}.mi
892 Objective-C source code which should not be preprocessed.
894 @item @var{file}.mm
895 @itemx @var{file}.M
896 Objective-C++ source code.  Note that you must link with the @file{libobjc}
897 library to make an Objective-C++ program work.  Note that @samp{.M} refers
898 to a literal capital M@.
900 @item @var{file}.mii
901 Objective-C++ source code which should not be preprocessed.
903 @item @var{file}.h
904 C, C++, Objective-C or Objective-C++ header file to be turned into a
905 precompiled header.
907 @item @var{file}.cc
908 @itemx @var{file}.cp
909 @itemx @var{file}.cxx
910 @itemx @var{file}.cpp
911 @itemx @var{file}.CPP
912 @itemx @var{file}.c++
913 @itemx @var{file}.C
914 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
915 the last two letters must both be literally @samp{x}.  Likewise,
916 @samp{.C} refers to a literal capital C@.
918 @item @var{file}.mm
919 @itemx @var{file}.M
920 Objective-C++ source code which must be preprocessed.
922 @item @var{file}.mii
923 Objective-C++ source code which should not be preprocessed.
925 @item @var{file}.hh
926 @itemx @var{file}.H
927 @itemx @var{file}.hp
928 @itemx @var{file}.hxx
929 @itemx @var{file}.hpp
930 @itemx @var{file}.HPP
931 @itemx @var{file}.h++
932 @itemx @var{file}.tcc
933 C++ header file to be turned into a precompiled header.
935 @item @var{file}.f
936 @itemx @var{file}.for
937 @itemx @var{file}.FOR
938 Fixed form Fortran source code which should not be preprocessed.
940 @item @var{file}.F
941 @itemx @var{file}.fpp
942 @itemx @var{file}.FPP
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 Free form Fortran source code which should not be preprocessed.
950 @item @var{file}.F90
951 @itemx @var{file}.F95
952 Free form Fortran source code which must be preprocessed (with the
953 traditional preprocessor).
955 @c FIXME: Descriptions of Java file types.
956 @c @var{file}.java
957 @c @var{file}.class
958 @c @var{file}.zip
959 @c @var{file}.jar
961 @item @var{file}.ads
962 Ada source code file which contains a library unit declaration (a
963 declaration of a package, subprogram, or generic, or a generic
964 instantiation), or a library unit renaming declaration (a package,
965 generic, or subprogram renaming declaration).  Such files are also
966 called @dfn{specs}.
968 @itemx @var{file}.adb
969 Ada source code file containing a library unit body (a subprogram or
970 package body).  Such files are also called @dfn{bodies}.
972 @c GCC also knows about some suffixes for languages not yet included:
973 @c Pascal:
974 @c @var{file}.p
975 @c @var{file}.pas
976 @c Ratfor:
977 @c @var{file}.r
979 @item @var{file}.s
980 Assembler code.
982 @item @var{file}.S
983 Assembler code which must be preprocessed.
985 @item @var{other}
986 An object file to be fed straight into linking.
987 Any file name with no recognized suffix is treated this way.
988 @end table
990 @opindex x
991 You can specify the input language explicitly with the @option{-x} option:
993 @table @gcctabopt
994 @item -x @var{language}
995 Specify explicitly the @var{language} for the following input files
996 (rather than letting the compiler choose a default based on the file
997 name suffix).  This option applies to all following input files until
998 the next @option{-x} option.  Possible values for @var{language} are:
999 @smallexample
1000 c  c-header  c-cpp-output
1001 c++  c++-header  c++-cpp-output
1002 objective-c  objective-c-header  objective-c-cpp-output
1003 objective-c++ objective-c++-header objective-c++-cpp-output
1004 assembler  assembler-with-cpp
1006 f95  f95-cpp-input
1007 java
1008 treelang
1009 @end smallexample
1011 @item -x none
1012 Turn off any specification of a language, so that subsequent files are
1013 handled according to their file name suffixes (as they are if @option{-x}
1014 has not been used at all).
1016 @item -pass-exit-codes
1017 @opindex pass-exit-codes
1018 Normally the @command{gcc} program will exit with the code of 1 if any
1019 phase of the compiler returns a non-success return code.  If you specify
1020 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1021 numerically highest error produced by any phase that returned an error
1022 indication.  The C, C++, and Fortran frontends return 4, if an internal
1023 compiler error is encountered.
1024 @end table
1026 If you only want some of the stages of compilation, you can use
1027 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1028 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1029 @command{gcc} is to stop.  Note that some combinations (for example,
1030 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1032 @table @gcctabopt
1033 @item -c
1034 @opindex c
1035 Compile or assemble the source files, but do not link.  The linking
1036 stage simply is not done.  The ultimate output is in the form of an
1037 object file for each source file.
1039 By default, the object file name for a source file is made by replacing
1040 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1042 Unrecognized input files, not requiring compilation or assembly, are
1043 ignored.
1045 @item -S
1046 @opindex S
1047 Stop after the stage of compilation proper; do not assemble.  The output
1048 is in the form of an assembler code file for each non-assembler input
1049 file specified.
1051 By default, the assembler file name for a source file is made by
1052 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1054 Input files that don't require compilation are ignored.
1056 @item -E
1057 @opindex E
1058 Stop after the preprocessing stage; do not run the compiler proper.  The
1059 output is in the form of preprocessed source code, which is sent to the
1060 standard output.
1062 Input files which don't require preprocessing are ignored.
1064 @cindex output file option
1065 @item -o @var{file}
1066 @opindex o
1067 Place output in file @var{file}.  This applies regardless to whatever
1068 sort of output is being produced, whether it be an executable file,
1069 an object file, an assembler file or preprocessed C code.
1071 If @option{-o} is not specified, the default is to put an executable
1072 file in @file{a.out}, the object file for
1073 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1074 assembler file in @file{@var{source}.s}, a precompiled header file in
1075 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1076 standard output.
1078 @item -v
1079 @opindex v
1080 Print (on standard error output) the commands executed to run the stages
1081 of compilation.  Also print the version number of the compiler driver
1082 program and of the preprocessor and the compiler proper.
1084 @item -###
1085 @opindex ###
1086 Like @option{-v} except the commands are not executed and all command
1087 arguments are quoted.  This is useful for shell scripts to capture the
1088 driver-generated command lines.
1090 @item -pipe
1091 @opindex pipe
1092 Use pipes rather than temporary files for communication between the
1093 various stages of compilation.  This fails to work on some systems where
1094 the assembler is unable to read from a pipe; but the GNU assembler has
1095 no trouble.
1097 @item -combine
1098 @opindex combine
1099 If you are compiling multiple source files, this option tells the driver
1100 to pass all the source files to the compiler at once (for those
1101 languages for which the compiler can handle this).  This will allow
1102 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1103 language for which this is supported is C@.  If you pass source files for
1104 multiple languages to the driver, using this option, the driver will invoke
1105 the compiler(s) that support IMA once each, passing each compiler all the
1106 source files appropriate for it.  For those languages that do not support
1107 IMA this option will be ignored, and the compiler will be invoked once for
1108 each source file in that language.  If you use this option in conjunction
1109 with @option{-save-temps}, the compiler will generate multiple
1110 pre-processed files
1111 (one for each source file), but only one (combined) @file{.o} or
1112 @file{.s} file.
1114 @item --help
1115 @opindex help
1116 Print (on the standard output) a description of the command line options
1117 understood by @command{gcc}.  If the @option{-v} option is also specified
1118 then @option{--help} will also be passed on to the various processes
1119 invoked by @command{gcc}, so that they can display the command line options
1120 they accept.  If the @option{-Wextra} option has also been specified
1121 (prior to the @option{--help} option), then command line options which
1122 have no documentation associated with them will also be displayed.
1124 @item --target-help
1125 @opindex target-help
1126 Print (on the standard output) a description of target-specific command
1127 line options for each tool.  For some targets extra target-specific
1128 information may also be printed.
1130 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
1131 Print (on the standard output) a description of the command line
1132 options understood by the compiler that fit into a specific class.
1133 The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
1134 @samp{params}, or @var{language}:
1136 @table @asis
1137 @item @samp{optimizers}
1138 This will display all of the optimization options supported by the
1139 compiler.
1141 @item @samp{warnings}
1142 This will display all of the options controlling warning messages
1143 produced by the compiler.
1145 @item @samp{target}
1146 This will display target-specific options.  Unlike the
1147 @option{--target-help} option however, target-specific options of the
1148 linker and assembler will not be displayed.  This is because those
1149 tools do not currently support the extended @option{--help=} syntax.
1151 @item @samp{params}
1152 This will display the values recognized by the @option{--param}
1153 option.
1155 @item @var{language}
1156 This will display the options supported for @var{language}, where 
1157 @var{language} is the name of one of the languages supported in this 
1158 version of GCC.
1160 @item @samp{common}
1161 This will display the options that are common to all languages.
1162 @end table
1164 It is possible to further refine the output of the @option{--help=}
1165 option by adding a comma separated list of qualifiers after the
1166 class.  These can be any from the following list:
1168 @table @asis
1169 @item @samp{undocumented}
1170 Display only those options which are undocumented.
1172 @item @samp{joined}
1173 Display options which take an argument that appears after an equal
1174 sign in the same continuous piece of text, such as:
1175 @samp{--help=target}.
1177 @item @samp{separate}
1178 Display options which take an argument that appears as a separate word
1179 following the original option, such as: @samp{-o output-file}.
1180 @end table
1182 Thus for example to display all the undocumented target-specific
1183 switches supported by the compiler the following can be used:
1185 @smallexample
1186 --help=target,undocumented
1187 @end smallexample
1189 The sense of a qualifier can be inverted by prefixing it with the
1190 @var{^} character, so for example to display all binary warning
1191 options (i.e. ones that are either on or off and that do not take an
1192 argument), which have a description the following can be used:
1194 @smallexample
1195 --help=warnings,^joined,^undocumented
1196 @end smallexample
1198 A class can also be used as a qualifier, although this usually
1199 restricts the output by so much that there is nothing to display.  One
1200 case where it does work however is when one of the classes is
1201 @var{target}.  So for example to display all the target-specific
1202 optimization options the following can be used:
1204 @smallexample
1205 --help=target,optimizers
1206 @end smallexample
1208 The @option{--help=} option can be repeated on the command line.  Each
1209 successive use will display its requested class of options, skipping
1210 those that have already been displayed.
1212 If the @option{-Q} option appears on the command line before the
1213 @option{--help=} option, then the descriptive text displayed by
1214 @option{--help=} is changed.  Instead of describing the displayed
1215 options, an indication is given as to whether the option is enabled,
1216 disabled or set to a specific value (assuming that the compiler
1217 knows this at the point where the @option{--help=} option is used).
1219 Here is a truncated example from the ARM port of @command{gcc}:
1221 @smallexample
1222   % gcc -Q -mabi=2 --help=target -c
1223   The following options are target specific:
1224   -mabi=                                2
1225   -mabort-on-noreturn                   [disabled]
1226   -mapcs                                [disabled]
1227 @end smallexample
1229 The output is sensitive to the effects of previous command line
1230 options, so for example it is possible to find out which optimizations
1231 are enabled at @option{-O2} by using:
1233 @smallexample
1234 -O2 --help=optimizers
1235 @end smallexample
1237 Alternatively you can discover which binary optimizations are enabled
1238 by @option{-O3} by using:
1240 @smallexample
1241 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1242 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1243 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1244 @end smallexample
1246 @item --version
1247 @opindex version
1248 Display the version number and copyrights of the invoked GCC@.
1250 @include @value{srcdir}/../libiberty/at-file.texi
1251 @end table
1253 @node Invoking G++
1254 @section Compiling C++ Programs
1256 @cindex suffixes for C++ source
1257 @cindex C++ source file suffixes
1258 C++ source files conventionally use one of the suffixes @samp{.C},
1259 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1260 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1261 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1262 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1263 files with these names and compiles them as C++ programs even if you
1264 call the compiler the same way as for compiling C programs (usually
1265 with the name @command{gcc}).
1267 @findex g++
1268 @findex c++
1269 However, the use of @command{gcc} does not add the C++ library.
1270 @command{g++} is a program that calls GCC and treats @samp{.c},
1271 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1272 files unless @option{-x} is used, and automatically specifies linking
1273 against the C++ library.  This program is also useful when
1274 precompiling a C header file with a @samp{.h} extension for use in C++
1275 compilations.  On many systems, @command{g++} is also installed with
1276 the name @command{c++}.
1278 @cindex invoking @command{g++}
1279 When you compile C++ programs, you may specify many of the same
1280 command-line options that you use for compiling programs in any
1281 language; or command-line options meaningful for C and related
1282 languages; or options that are meaningful only for C++ programs.
1283 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1284 explanations of options for languages related to C@.
1285 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1286 explanations of options that are meaningful only for C++ programs.
1288 @node C Dialect Options
1289 @section Options Controlling C Dialect
1290 @cindex dialect options
1291 @cindex language dialect options
1292 @cindex options, dialect
1294 The following options control the dialect of C (or languages derived
1295 from C, such as C++, Objective-C and Objective-C++) that the compiler
1296 accepts:
1298 @table @gcctabopt
1299 @cindex ANSI support
1300 @cindex ISO support
1301 @item -ansi
1302 @opindex ansi
1303 In C mode, support all ISO C90 programs.  In C++ mode,
1304 remove GNU extensions that conflict with ISO C++.
1306 This turns off certain features of GCC that are incompatible with ISO
1307 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1308 such as the @code{asm} and @code{typeof} keywords, and
1309 predefined macros such as @code{unix} and @code{vax} that identify the
1310 type of system you are using.  It also enables the undesirable and
1311 rarely used ISO trigraph feature.  For the C compiler,
1312 it disables recognition of C++ style @samp{//} comments as well as
1313 the @code{inline} keyword.
1315 The alternate keywords @code{__asm__}, @code{__extension__},
1316 @code{__inline__} and @code{__typeof__} continue to work despite
1317 @option{-ansi}.  You would not want to use them in an ISO C program, of
1318 course, but it is useful to put them in header files that might be included
1319 in compilations done with @option{-ansi}.  Alternate predefined macros
1320 such as @code{__unix__} and @code{__vax__} are also available, with or
1321 without @option{-ansi}.
1323 The @option{-ansi} option does not cause non-ISO programs to be
1324 rejected gratuitously.  For that, @option{-pedantic} is required in
1325 addition to @option{-ansi}.  @xref{Warning Options}.
1327 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1328 option is used.  Some header files may notice this macro and refrain
1329 from declaring certain functions or defining certain macros that the
1330 ISO standard doesn't call for; this is to avoid interfering with any
1331 programs that might use these names for other things.
1333 Functions which would normally be built in but do not have semantics
1334 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1335 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1336 built-in functions provided by GCC}, for details of the functions
1337 affected.
1339 @item -std=
1340 @opindex std
1341 Determine the language standard.  This option is currently only
1342 supported when compiling C or C++.  A value for this option must be
1343 provided; possible values are
1345 @table @samp
1346 @item c89
1347 @itemx iso9899:1990
1348 ISO C90 (same as @option{-ansi}).
1350 @item iso9899:199409
1351 ISO C90 as modified in amendment 1.
1353 @item c99
1354 @itemx c9x
1355 @itemx iso9899:1999
1356 @itemx iso9899:199x
1357 ISO C99.  Note that this standard is not yet fully supported; see
1358 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1359 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1361 @item gnu89
1362 Default, ISO C90 plus GNU extensions (including some C99 features).
1364 @item gnu99
1365 @itemx gnu9x
1366 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1367 this will become the default.  The name @samp{gnu9x} is deprecated.
1369 @item c++98
1370 The 1998 ISO C++ standard plus amendments.
1372 @item gnu++98
1373 The same as @option{-std=c++98} plus GNU extensions.  This is the
1374 default for C++ code.
1376 @item c++0x
1377 The working draft of the upcoming ISO C++0x standard. This option
1378 enables experimental features that are likely to be included in
1379 C++0x. The working draft is constantly changing, and any feature that is
1380 enabled by this flag may be removed from future versions of GCC if it is
1381 not part of the C++0x standard.
1383 @item gnu++0x
1384 The same as @option{-std=c++0x} plus GNU extensions. As with
1385 @option{-std=c++0x}, this option enables experimental features that may
1386 be removed in future versions of GCC.
1387 @end table
1389 Even when this option is not specified, you can still use some of the
1390 features of newer standards in so far as they do not conflict with
1391 previous C standards.  For example, you may use @code{__restrict__} even
1392 when @option{-std=c99} is not specified.
1394 The @option{-std} options specifying some version of ISO C have the same
1395 effects as @option{-ansi}, except that features that were not in ISO C90
1396 but are in the specified version (for example, @samp{//} comments and
1397 the @code{inline} keyword in ISO C99) are not disabled.
1399 @xref{Standards,,Language Standards Supported by GCC}, for details of
1400 these standard versions.
1402 @item -fgnu89-inline
1403 @opindex fgnu89-inline
1404 The option @option{-fgnu89-inline} tells GCC to use the traditional
1405 GNU semantics for @code{inline} functions when in C99 mode.
1406 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1407 is accepted and ignored by GCC versions 4.1.3 up to but not including
1408 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1409 C99 mode.  Using this option is roughly equivalent to adding the
1410 @code{gnu_inline} function attribute to all inline functions
1411 (@pxref{Function Attributes}).
1413 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1414 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1415 specifies the default behavior).  This option was first supported in
1416 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1418 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1419 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1420 in effect for @code{inline} functions.  @xref{Common Predefined
1421 Macros,,,cpp,The C Preprocessor}.
1423 @item -aux-info @var{filename}
1424 @opindex aux-info
1425 Output to the given filename prototyped declarations for all functions
1426 declared and/or defined in a translation unit, including those in header
1427 files.  This option is silently ignored in any language other than C@.
1429 Besides declarations, the file indicates, in comments, the origin of
1430 each declaration (source file and line), whether the declaration was
1431 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1432 @samp{O} for old, respectively, in the first character after the line
1433 number and the colon), and whether it came from a declaration or a
1434 definition (@samp{C} or @samp{F}, respectively, in the following
1435 character).  In the case of function definitions, a K&R-style list of
1436 arguments followed by their declarations is also provided, inside
1437 comments, after the declaration.
1439 @item -fno-asm
1440 @opindex fno-asm
1441 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1442 keyword, so that code can use these words as identifiers.  You can use
1443 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1444 instead.  @option{-ansi} implies @option{-fno-asm}.
1446 In C++, this switch only affects the @code{typeof} keyword, since
1447 @code{asm} and @code{inline} are standard keywords.  You may want to
1448 use the @option{-fno-gnu-keywords} flag instead, which has the same
1449 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1450 switch only affects the @code{asm} and @code{typeof} keywords, since
1451 @code{inline} is a standard keyword in ISO C99.
1453 @item -fno-builtin
1454 @itemx -fno-builtin-@var{function}
1455 @opindex fno-builtin
1456 @cindex built-in functions
1457 Don't recognize built-in functions that do not begin with
1458 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1459 functions provided by GCC}, for details of the functions affected,
1460 including those which are not built-in functions when @option{-ansi} or
1461 @option{-std} options for strict ISO C conformance are used because they
1462 do not have an ISO standard meaning.
1464 GCC normally generates special code to handle certain built-in functions
1465 more efficiently; for instance, calls to @code{alloca} may become single
1466 instructions that adjust the stack directly, and calls to @code{memcpy}
1467 may become inline copy loops.  The resulting code is often both smaller
1468 and faster, but since the function calls no longer appear as such, you
1469 cannot set a breakpoint on those calls, nor can you change the behavior
1470 of the functions by linking with a different library.  In addition,
1471 when a function is recognized as a built-in function, GCC may use
1472 information about that function to warn about problems with calls to
1473 that function, or to generate more efficient code, even if the
1474 resulting code still contains calls to that function.  For example,
1475 warnings are given with @option{-Wformat} for bad calls to
1476 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1477 known not to modify global memory.
1479 With the @option{-fno-builtin-@var{function}} option
1480 only the built-in function @var{function} is
1481 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1482 function is named this is not built-in in this version of GCC, this
1483 option is ignored.  There is no corresponding
1484 @option{-fbuiltin-@var{function}} option; if you wish to enable
1485 built-in functions selectively when using @option{-fno-builtin} or
1486 @option{-ffreestanding}, you may define macros such as:
1488 @smallexample
1489 #define abs(n)          __builtin_abs ((n))
1490 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1491 @end smallexample
1493 @item -fhosted
1494 @opindex fhosted
1495 @cindex hosted environment
1497 Assert that compilation takes place in a hosted environment.  This implies
1498 @option{-fbuiltin}.  A hosted environment is one in which the
1499 entire standard library is available, and in which @code{main} has a return
1500 type of @code{int}.  Examples are nearly everything except a kernel.
1501 This is equivalent to @option{-fno-freestanding}.
1503 @item -ffreestanding
1504 @opindex ffreestanding
1505 @cindex hosted environment
1507 Assert that compilation takes place in a freestanding environment.  This
1508 implies @option{-fno-builtin}.  A freestanding environment
1509 is one in which the standard library may not exist, and program startup may
1510 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1511 This is equivalent to @option{-fno-hosted}.
1513 @xref{Standards,,Language Standards Supported by GCC}, for details of
1514 freestanding and hosted environments.
1516 @item -fopenmp
1517 @opindex fopenmp
1518 @cindex openmp parallel
1519 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1520 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1521 compiler generates parallel code according to the OpenMP Application
1522 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1524 @item -fms-extensions
1525 @opindex fms-extensions
1526 Accept some non-standard constructs used in Microsoft header files.
1528 Some cases of unnamed fields in structures and unions are only
1529 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1530 fields within structs/unions}, for details.
1532 @item -trigraphs
1533 @opindex trigraphs
1534 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1535 options for strict ISO C conformance) implies @option{-trigraphs}.
1537 @item -no-integrated-cpp
1538 @opindex no-integrated-cpp
1539 Performs a compilation in two passes: preprocessing and compiling.  This
1540 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1541 @option{-B} option.  The user supplied compilation step can then add in
1542 an additional preprocessing step after normal preprocessing but before
1543 compiling.  The default is to use the integrated cpp (internal cpp)
1545 The semantics of this option will change if "cc1", "cc1plus", and
1546 "cc1obj" are merged.
1548 @cindex traditional C language
1549 @cindex C language, traditional
1550 @item -traditional
1551 @itemx -traditional-cpp
1552 @opindex traditional-cpp
1553 @opindex traditional
1554 Formerly, these options caused GCC to attempt to emulate a pre-standard
1555 C compiler.  They are now only supported with the @option{-E} switch.
1556 The preprocessor continues to support a pre-standard mode.  See the GNU
1557 CPP manual for details.
1559 @item -fcond-mismatch
1560 @opindex fcond-mismatch
1561 Allow conditional expressions with mismatched types in the second and
1562 third arguments.  The value of such an expression is void.  This option
1563 is not supported for C++.
1565 @item -flax-vector-conversions
1566 @opindex flax-vector-conversions
1567 Allow implicit conversions between vectors with differing numbers of
1568 elements and/or incompatible element types.  This option should not be
1569 used for new code.
1571 @item -funsigned-char
1572 @opindex funsigned-char
1573 Let the type @code{char} be unsigned, like @code{unsigned char}.
1575 Each kind of machine has a default for what @code{char} should
1576 be.  It is either like @code{unsigned char} by default or like
1577 @code{signed char} by default.
1579 Ideally, a portable program should always use @code{signed char} or
1580 @code{unsigned char} when it depends on the signedness of an object.
1581 But many programs have been written to use plain @code{char} and
1582 expect it to be signed, or expect it to be unsigned, depending on the
1583 machines they were written for.  This option, and its inverse, let you
1584 make such a program work with the opposite default.
1586 The type @code{char} is always a distinct type from each of
1587 @code{signed char} or @code{unsigned char}, even though its behavior
1588 is always just like one of those two.
1590 @item -fsigned-char
1591 @opindex fsigned-char
1592 Let the type @code{char} be signed, like @code{signed char}.
1594 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1595 the negative form of @option{-funsigned-char}.  Likewise, the option
1596 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1598 @item -fsigned-bitfields
1599 @itemx -funsigned-bitfields
1600 @itemx -fno-signed-bitfields
1601 @itemx -fno-unsigned-bitfields
1602 @opindex fsigned-bitfields
1603 @opindex funsigned-bitfields
1604 @opindex fno-signed-bitfields
1605 @opindex fno-unsigned-bitfields
1606 These options control whether a bit-field is signed or unsigned, when the
1607 declaration does not use either @code{signed} or @code{unsigned}.  By
1608 default, such a bit-field is signed, because this is consistent: the
1609 basic integer types such as @code{int} are signed types.
1610 @end table
1612 @node C++ Dialect Options
1613 @section Options Controlling C++ Dialect
1615 @cindex compiler options, C++
1616 @cindex C++ options, command line
1617 @cindex options, C++
1618 This section describes the command-line options that are only meaningful
1619 for C++ programs; but you can also use most of the GNU compiler options
1620 regardless of what language your program is in.  For example, you
1621 might compile a file @code{firstClass.C} like this:
1623 @smallexample
1624 g++ -g -frepo -O -c firstClass.C
1625 @end smallexample
1627 @noindent
1628 In this example, only @option{-frepo} is an option meant
1629 only for C++ programs; you can use the other options with any
1630 language supported by GCC@.
1632 Here is a list of options that are @emph{only} for compiling C++ programs:
1634 @table @gcctabopt
1636 @item -fabi-version=@var{n}
1637 @opindex fabi-version
1638 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1639 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1640 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1641 the version that conforms most closely to the C++ ABI specification.
1642 Therefore, the ABI obtained using version 0 will change as ABI bugs
1643 are fixed.
1645 The default is version 2.
1647 @item -fno-access-control
1648 @opindex fno-access-control
1649 Turn off all access checking.  This switch is mainly useful for working
1650 around bugs in the access control code.
1652 @item -fcheck-new
1653 @opindex fcheck-new
1654 Check that the pointer returned by @code{operator new} is non-null
1655 before attempting to modify the storage allocated.  This check is
1656 normally unnecessary because the C++ standard specifies that
1657 @code{operator new} will only return @code{0} if it is declared
1658 @samp{throw()}, in which case the compiler will always check the
1659 return value even without this option.  In all other cases, when
1660 @code{operator new} has a non-empty exception specification, memory
1661 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1662 @samp{new (nothrow)}.
1664 @item -fconserve-space
1665 @opindex fconserve-space
1666 Put uninitialized or runtime-initialized global variables into the
1667 common segment, as C does.  This saves space in the executable at the
1668 cost of not diagnosing duplicate definitions.  If you compile with this
1669 flag and your program mysteriously crashes after @code{main()} has
1670 completed, you may have an object that is being destroyed twice because
1671 two definitions were merged.
1673 This option is no longer useful on most targets, now that support has
1674 been added for putting variables into BSS without making them common.
1676 @item -ffriend-injection
1677 @opindex ffriend-injection
1678 Inject friend functions into the enclosing namespace, so that they are
1679 visible outside the scope of the class in which they are declared.
1680 Friend functions were documented to work this way in the old Annotated
1681 C++ Reference Manual, and versions of G++ before 4.1 always worked
1682 that way.  However, in ISO C++ a friend function which is not declared
1683 in an enclosing scope can only be found using argument dependent
1684 lookup.  This option causes friends to be injected as they were in
1685 earlier releases.
1687 This option is for compatibility, and may be removed in a future
1688 release of G++.
1690 @item -fno-elide-constructors
1691 @opindex fno-elide-constructors
1692 The C++ standard allows an implementation to omit creating a temporary
1693 which is only used to initialize another object of the same type.
1694 Specifying this option disables that optimization, and forces G++ to
1695 call the copy constructor in all cases.
1697 @item -fno-enforce-eh-specs
1698 @opindex fno-enforce-eh-specs
1699 Don't generate code to check for violation of exception specifications
1700 at runtime.  This option violates the C++ standard, but may be useful
1701 for reducing code size in production builds, much like defining
1702 @samp{NDEBUG}.  This does not give user code permission to throw
1703 exceptions in violation of the exception specifications; the compiler
1704 will still optimize based on the specifications, so throwing an
1705 unexpected exception will result in undefined behavior.
1707 @item -ffor-scope
1708 @itemx -fno-for-scope
1709 @opindex ffor-scope
1710 @opindex fno-for-scope
1711 If @option{-ffor-scope} is specified, the scope of variables declared in
1712 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1713 as specified by the C++ standard.
1714 If @option{-fno-for-scope} is specified, the scope of variables declared in
1715 a @i{for-init-statement} extends to the end of the enclosing scope,
1716 as was the case in old versions of G++, and other (traditional)
1717 implementations of C++.
1719 The default if neither flag is given to follow the standard,
1720 but to allow and give a warning for old-style code that would
1721 otherwise be invalid, or have different behavior.
1723 @item -fno-gnu-keywords
1724 @opindex fno-gnu-keywords
1725 Do not recognize @code{typeof} as a keyword, so that code can use this
1726 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1727 @option{-ansi} implies @option{-fno-gnu-keywords}.
1729 @item -fno-implicit-templates
1730 @opindex fno-implicit-templates
1731 Never emit code for non-inline templates which are instantiated
1732 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1733 @xref{Template Instantiation}, for more information.
1735 @item -fno-implicit-inline-templates
1736 @opindex fno-implicit-inline-templates
1737 Don't emit code for implicit instantiations of inline templates, either.
1738 The default is to handle inlines differently so that compiles with and
1739 without optimization will need the same set of explicit instantiations.
1741 @item -fno-implement-inlines
1742 @opindex fno-implement-inlines
1743 To save space, do not emit out-of-line copies of inline functions
1744 controlled by @samp{#pragma implementation}.  This will cause linker
1745 errors if these functions are not inlined everywhere they are called.
1747 @item -fms-extensions
1748 @opindex fms-extensions
1749 Disable pedantic warnings about constructs used in MFC, such as implicit
1750 int and getting a pointer to member function via non-standard syntax.
1752 @item -fno-nonansi-builtins
1753 @opindex fno-nonansi-builtins
1754 Disable built-in declarations of functions that are not mandated by
1755 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1756 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1758 @item -fno-operator-names
1759 @opindex fno-operator-names
1760 Do not treat the operator name keywords @code{and}, @code{bitand},
1761 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1762 synonyms as keywords.
1764 @item -fno-optional-diags
1765 @opindex fno-optional-diags
1766 Disable diagnostics that the standard says a compiler does not need to
1767 issue.  Currently, the only such diagnostic issued by G++ is the one for
1768 a name having multiple meanings within a class.
1770 @item -fpermissive
1771 @opindex fpermissive
1772 Downgrade some diagnostics about nonconformant code from errors to
1773 warnings.  Thus, using @option{-fpermissive} will allow some
1774 nonconforming code to compile.
1776 @item -frepo
1777 @opindex frepo
1778 Enable automatic template instantiation at link time.  This option also
1779 implies @option{-fno-implicit-templates}.  @xref{Template
1780 Instantiation}, for more information.
1782 @item -fno-rtti
1783 @opindex fno-rtti
1784 Disable generation of information about every class with virtual
1785 functions for use by the C++ runtime type identification features
1786 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1787 of the language, you can save some space by using this flag.  Note that
1788 exception handling uses the same information, but it will generate it as
1789 needed. The @samp{dynamic_cast} operator can still be used for casts that
1790 do not require runtime type information, i.e. casts to @code{void *} or to
1791 unambiguous base classes.
1793 @item -fstats
1794 @opindex fstats
1795 Emit statistics about front-end processing at the end of the compilation.
1796 This information is generally only useful to the G++ development team.
1798 @item -ftemplate-depth-@var{n}
1799 @opindex ftemplate-depth
1800 Set the maximum instantiation depth for template classes to @var{n}.
1801 A limit on the template instantiation depth is needed to detect
1802 endless recursions during template class instantiation.  ANSI/ISO C++
1803 conforming programs must not rely on a maximum depth greater than 17.
1805 @item -fno-threadsafe-statics
1806 @opindex fno-threadsafe-statics
1807 Do not emit the extra code to use the routines specified in the C++
1808 ABI for thread-safe initialization of local statics.  You can use this
1809 option to reduce code size slightly in code that doesn't need to be
1810 thread-safe.
1812 @item -fuse-cxa-atexit
1813 @opindex fuse-cxa-atexit
1814 Register destructors for objects with static storage duration with the
1815 @code{__cxa_atexit} function rather than the @code{atexit} function.
1816 This option is required for fully standards-compliant handling of static
1817 destructors, but will only work if your C library supports
1818 @code{__cxa_atexit}.
1820 @item -fno-use-cxa-get-exception-ptr
1821 @opindex fno-use-cxa-get-exception-ptr
1822 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1823 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1824 if the runtime routine is not available.
1826 @item -fvisibility-inlines-hidden
1827 @opindex fvisibility-inlines-hidden
1828 This switch declares that the user does not attempt to compare
1829 pointers to inline methods where the addresses of the two functions
1830 were taken in different shared objects.
1832 The effect of this is that GCC may, effectively, mark inline methods with
1833 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1834 appear in the export table of a DSO and do not require a PLT indirection
1835 when used within the DSO@.  Enabling this option can have a dramatic effect
1836 on load and link times of a DSO as it massively reduces the size of the
1837 dynamic export table when the library makes heavy use of templates.
1839 The behavior of this switch is not quite the same as marking the
1840 methods as hidden directly, because it does not affect static variables
1841 local to the function or cause the compiler to deduce that
1842 the function is defined in only one shared object.
1844 You may mark a method as having a visibility explicitly to negate the
1845 effect of the switch for that method.  For example, if you do want to
1846 compare pointers to a particular inline method, you might mark it as
1847 having default visibility.  Marking the enclosing class with explicit
1848 visibility will have no effect.
1850 Explicitly instantiated inline methods are unaffected by this option
1851 as their linkage might otherwise cross a shared library boundary.
1852 @xref{Template Instantiation}.
1854 @item -fvisibility-ms-compat
1855 @opindex fvisibility-ms-compat
1856 This flag attempts to use visibility settings to make GCC's C++
1857 linkage model compatible with that of Microsoft Visual Studio.
1859 The flag makes these changes to GCC's linkage model:
1861 @enumerate
1862 @item
1863 It sets the default visibility to @code{hidden}, like
1864 @option{-fvisibility=hidden}.
1866 @item
1867 Types, but not their members, are not hidden by default.
1869 @item
1870 The One Definition Rule is relaxed for types without explicit
1871 visibility specifications which are defined in more than one different
1872 shared object: those declarations are permitted if they would have
1873 been permitted when this option was not used.
1874 @end enumerate
1876 In new code it is better to use @option{-fvisibility=hidden} and
1877 export those classes which are intended to be externally visible.
1878 Unfortunately it is possible for code to rely, perhaps accidentally,
1879 on the Visual Studio behavior.
1881 Among the consequences of these changes are that static data members
1882 of the same type with the same name but defined in different shared
1883 objects will be different, so changing one will not change the other;
1884 and that pointers to function members defined in different shared
1885 objects may not compare equal.  When this flag is given, it is a
1886 violation of the ODR to define types with the same name differently.
1888 @item -fno-weak
1889 @opindex fno-weak
1890 Do not use weak symbol support, even if it is provided by the linker.
1891 By default, G++ will use weak symbols if they are available.  This
1892 option exists only for testing, and should not be used by end-users;
1893 it will result in inferior code and has no benefits.  This option may
1894 be removed in a future release of G++.
1896 @item -nostdinc++
1897 @opindex nostdinc++
1898 Do not search for header files in the standard directories specific to
1899 C++, but do still search the other standard directories.  (This option
1900 is used when building the C++ library.)
1901 @end table
1903 In addition, these optimization, warning, and code generation options
1904 have meanings only for C++ programs:
1906 @table @gcctabopt
1907 @item -fno-default-inline
1908 @opindex fno-default-inline
1909 Do not assume @samp{inline} for functions defined inside a class scope.
1910 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1911 functions will have linkage like inline functions; they just won't be
1912 inlined by default.
1914 @item -Wabi @r{(C++ only)}
1915 @opindex Wabi
1916 Warn when G++ generates code that is probably not compatible with the
1917 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1918 all such cases, there are probably some cases that are not warned about,
1919 even though G++ is generating incompatible code.  There may also be
1920 cases where warnings are emitted even though the code that is generated
1921 will be compatible.
1923 You should rewrite your code to avoid these warnings if you are
1924 concerned about the fact that code generated by G++ may not be binary
1925 compatible with code generated by other compilers.
1927 The known incompatibilities at this point include:
1929 @itemize @bullet
1931 @item
1932 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1933 pack data into the same byte as a base class.  For example:
1935 @smallexample
1936 struct A @{ virtual void f(); int f1 : 1; @};
1937 struct B : public A @{ int f2 : 1; @};
1938 @end smallexample
1940 @noindent
1941 In this case, G++ will place @code{B::f2} into the same byte
1942 as@code{A::f1}; other compilers will not.  You can avoid this problem
1943 by explicitly padding @code{A} so that its size is a multiple of the
1944 byte size on your platform; that will cause G++ and other compilers to
1945 layout @code{B} identically.
1947 @item
1948 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1949 tail padding when laying out virtual bases.  For example:
1951 @smallexample
1952 struct A @{ virtual void f(); char c1; @};
1953 struct B @{ B(); char c2; @};
1954 struct C : public A, public virtual B @{@};
1955 @end smallexample
1957 @noindent
1958 In this case, G++ will not place @code{B} into the tail-padding for
1959 @code{A}; other compilers will.  You can avoid this problem by
1960 explicitly padding @code{A} so that its size is a multiple of its
1961 alignment (ignoring virtual base classes); that will cause G++ and other
1962 compilers to layout @code{C} identically.
1964 @item
1965 Incorrect handling of bit-fields with declared widths greater than that
1966 of their underlying types, when the bit-fields appear in a union.  For
1967 example:
1969 @smallexample
1970 union U @{ int i : 4096; @};
1971 @end smallexample
1973 @noindent
1974 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1975 union too small by the number of bits in an @code{int}.
1977 @item
1978 Empty classes can be placed at incorrect offsets.  For example:
1980 @smallexample
1981 struct A @{@};
1983 struct B @{
1984   A a;
1985   virtual void f ();
1988 struct C : public B, public A @{@};
1989 @end smallexample
1991 @noindent
1992 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1993 it should be placed at offset zero.  G++ mistakenly believes that the
1994 @code{A} data member of @code{B} is already at offset zero.
1996 @item
1997 Names of template functions whose types involve @code{typename} or
1998 template template parameters can be mangled incorrectly.
2000 @smallexample
2001 template <typename Q>
2002 void f(typename Q::X) @{@}
2004 template <template <typename> class Q>
2005 void f(typename Q<int>::X) @{@}
2006 @end smallexample
2008 @noindent
2009 Instantiations of these templates may be mangled incorrectly.
2011 @end itemize
2013 @item -Wctor-dtor-privacy @r{(C++ only)}
2014 @opindex Wctor-dtor-privacy
2015 Warn when a class seems unusable because all the constructors or
2016 destructors in that class are private, and it has neither friends nor
2017 public static member functions.
2019 @item -Wnon-virtual-dtor @r{(C++ only)}
2020 @opindex Wnon-virtual-dtor
2021 Warn when a class has virtual functions and accessible non-virtual
2022 destructor, in which case it would be possible but unsafe to delete
2023 an instance of a derived class through a pointer to the base class.
2024 This warning is also enabled if -Weffc++ is specified.
2026 @item -Wreorder @r{(C++ only)}
2027 @opindex Wreorder
2028 @cindex reordering, warning
2029 @cindex warning for reordering of member initializers
2030 Warn when the order of member initializers given in the code does not
2031 match the order in which they must be executed.  For instance:
2033 @smallexample
2034 struct A @{
2035   int i;
2036   int j;
2037   A(): j (0), i (1) @{ @}
2039 @end smallexample
2041 The compiler will rearrange the member initializers for @samp{i}
2042 and @samp{j} to match the declaration order of the members, emitting
2043 a warning to that effect.  This warning is enabled by @option{-Wall}.
2044 @end table
2046 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2048 @table @gcctabopt
2049 @item -Weffc++ @r{(C++ only)}
2050 @opindex Weffc++
2051 Warn about violations of the following style guidelines from Scott Meyers'
2052 @cite{Effective C++} book:
2054 @itemize @bullet
2055 @item
2056 Item 11:  Define a copy constructor and an assignment operator for classes
2057 with dynamically allocated memory.
2059 @item
2060 Item 12:  Prefer initialization to assignment in constructors.
2062 @item
2063 Item 14:  Make destructors virtual in base classes.
2065 @item
2066 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2068 @item
2069 Item 23:  Don't try to return a reference when you must return an object.
2071 @end itemize
2073 Also warn about violations of the following style guidelines from
2074 Scott Meyers' @cite{More Effective C++} book:
2076 @itemize @bullet
2077 @item
2078 Item 6:  Distinguish between prefix and postfix forms of increment and
2079 decrement operators.
2081 @item
2082 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2084 @end itemize
2086 When selecting this option, be aware that the standard library
2087 headers do not obey all of these guidelines; use @samp{grep -v}
2088 to filter out those warnings.
2090 @item -Wno-deprecated @r{(C++ only)}
2091 @opindex Wno-deprecated
2092 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
2094 @item -Wstrict-null-sentinel @r{(C++ only)}
2095 @opindex Wstrict-null-sentinel
2096 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2097 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2098 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2099 it is guaranteed to of the same size as a pointer.  But this use is
2100 not portable across different compilers.
2102 @item -Wno-non-template-friend @r{(C++ only)}
2103 @opindex Wno-non-template-friend
2104 Disable warnings when non-templatized friend functions are declared
2105 within a template.  Since the advent of explicit template specification
2106 support in G++, if the name of the friend is an unqualified-id (i.e.,
2107 @samp{friend foo(int)}), the C++ language specification demands that the
2108 friend declare or define an ordinary, nontemplate function.  (Section
2109 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2110 could be interpreted as a particular specialization of a templatized
2111 function.  Because this non-conforming behavior is no longer the default
2112 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2113 check existing code for potential trouble spots and is on by default.
2114 This new compiler behavior can be turned off with
2115 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2116 but disables the helpful warning.
2118 @item -Wold-style-cast @r{(C++ only)}
2119 @opindex Wold-style-cast
2120 Warn if an old-style (C-style) cast to a non-void type is used within
2121 a C++ program.  The new-style casts (@samp{dynamic_cast},
2122 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2123 less vulnerable to unintended effects and much easier to search for.
2125 @item -Woverloaded-virtual @r{(C++ only)}
2126 @opindex Woverloaded-virtual
2127 @cindex overloaded virtual fn, warning
2128 @cindex warning for overloaded virtual fn
2129 Warn when a function declaration hides virtual functions from a
2130 base class.  For example, in:
2132 @smallexample
2133 struct A @{
2134   virtual void f();
2137 struct B: public A @{
2138   void f(int);
2140 @end smallexample
2142 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2143 like:
2145 @smallexample
2146 B* b;
2147 b->f();
2148 @end smallexample
2150 will fail to compile.
2152 @item -Wno-pmf-conversions @r{(C++ only)}
2153 @opindex Wno-pmf-conversions
2154 Disable the diagnostic for converting a bound pointer to member function
2155 to a plain pointer.
2157 @item -Wsign-promo @r{(C++ only)}
2158 @opindex Wsign-promo
2159 Warn when overload resolution chooses a promotion from unsigned or
2160 enumerated type to a signed type, over a conversion to an unsigned type of
2161 the same size.  Previous versions of G++ would try to preserve
2162 unsignedness, but the standard mandates the current behavior.
2164 @smallexample
2165 struct A @{
2166   operator int ();
2167   A& operator = (int);
2170 main ()
2172   A a,b;
2173   a = b;
2175 @end smallexample
2177 In this example, G++ will synthesize a default @samp{A& operator =
2178 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2179 @end table
2181 @node Objective-C and Objective-C++ Dialect Options
2182 @section Options Controlling Objective-C and Objective-C++ Dialects
2184 @cindex compiler options, Objective-C and Objective-C++
2185 @cindex Objective-C and Objective-C++ options, command line
2186 @cindex options, Objective-C and Objective-C++
2187 (NOTE: This manual does not describe the Objective-C and Objective-C++
2188 languages themselves.  See @xref{Standards,,Language Standards
2189 Supported by GCC}, for references.)
2191 This section describes the command-line options that are only meaningful
2192 for Objective-C and Objective-C++ programs, but you can also use most of
2193 the language-independent GNU compiler options.
2194 For example, you might compile a file @code{some_class.m} like this:
2196 @smallexample
2197 gcc -g -fgnu-runtime -O -c some_class.m
2198 @end smallexample
2200 @noindent
2201 In this example, @option{-fgnu-runtime} is an option meant only for
2202 Objective-C and Objective-C++ programs; you can use the other options with
2203 any language supported by GCC@.
2205 Note that since Objective-C is an extension of the C language, Objective-C
2206 compilations may also use options specific to the C front-end (e.g.,
2207 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2208 C++-specific options (e.g., @option{-Wabi}).
2210 Here is a list of options that are @emph{only} for compiling Objective-C
2211 and Objective-C++ programs:
2213 @table @gcctabopt
2214 @item -fconstant-string-class=@var{class-name}
2215 @opindex fconstant-string-class
2216 Use @var{class-name} as the name of the class to instantiate for each
2217 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2218 class name is @code{NXConstantString} if the GNU runtime is being used, and
2219 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2220 @option{-fconstant-cfstrings} option, if also present, will override the
2221 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2222 to be laid out as constant CoreFoundation strings.
2224 @item -fgnu-runtime
2225 @opindex fgnu-runtime
2226 Generate object code compatible with the standard GNU Objective-C
2227 runtime.  This is the default for most types of systems.
2229 @item -fnext-runtime
2230 @opindex fnext-runtime
2231 Generate output compatible with the NeXT runtime.  This is the default
2232 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2233 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2234 used.
2236 @item -fno-nil-receivers
2237 @opindex fno-nil-receivers
2238 Assume that all Objective-C message dispatches (e.g.,
2239 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2240 is not @code{nil}.  This allows for more efficient entry points in the runtime
2241 to be used.  Currently, this option is only available in conjunction with
2242 the NeXT runtime on Mac OS X 10.3 and later.
2244 @item -fobjc-call-cxx-cdtors
2245 @opindex fobjc-call-cxx-cdtors
2246 For each Objective-C class, check if any of its instance variables is a
2247 C++ object with a non-trivial default constructor.  If so, synthesize a
2248 special @code{- (id) .cxx_construct} instance method that will run
2249 non-trivial default constructors on any such instance variables, in order,
2250 and then return @code{self}.  Similarly, check if any instance variable
2251 is a C++ object with a non-trivial destructor, and if so, synthesize a
2252 special @code{- (void) .cxx_destruct} method that will run
2253 all such default destructors, in reverse order.
2255 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2256 thusly generated will only operate on instance variables declared in the
2257 current Objective-C class, and not those inherited from superclasses.  It
2258 is the responsibility of the Objective-C runtime to invoke all such methods
2259 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2260 will be invoked by the runtime immediately after a new object
2261 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2262 be invoked immediately before the runtime deallocates an object instance.
2264 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2265 support for invoking the @code{- (id) .cxx_construct} and
2266 @code{- (void) .cxx_destruct} methods.
2268 @item -fobjc-direct-dispatch
2269 @opindex fobjc-direct-dispatch
2270 Allow fast jumps to the message dispatcher.  On Darwin this is
2271 accomplished via the comm page.
2273 @item -fobjc-exceptions
2274 @opindex fobjc-exceptions
2275 Enable syntactic support for structured exception handling in Objective-C,
2276 similar to what is offered by C++ and Java.  This option is
2277 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2278 earlier.
2280 @smallexample
2281   @@try @{
2282     @dots{}
2283        @@throw expr;
2284     @dots{}
2285   @}
2286   @@catch (AnObjCClass *exc) @{
2287     @dots{}
2288       @@throw expr;
2289     @dots{}
2290       @@throw;
2291     @dots{}
2292   @}
2293   @@catch (AnotherClass *exc) @{
2294     @dots{}
2295   @}
2296   @@catch (id allOthers) @{
2297     @dots{}
2298   @}
2299   @@finally @{
2300     @dots{}
2301       @@throw expr;
2302     @dots{}
2303   @}
2304 @end smallexample
2306 The @code{@@throw} statement may appear anywhere in an Objective-C or
2307 Objective-C++ program; when used inside of a @code{@@catch} block, the
2308 @code{@@throw} may appear without an argument (as shown above), in which case
2309 the object caught by the @code{@@catch} will be rethrown.
2311 Note that only (pointers to) Objective-C objects may be thrown and
2312 caught using this scheme.  When an object is thrown, it will be caught
2313 by the nearest @code{@@catch} clause capable of handling objects of that type,
2314 analogously to how @code{catch} blocks work in C++ and Java.  A
2315 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2316 any and all Objective-C exceptions not caught by previous @code{@@catch}
2317 clauses (if any).
2319 The @code{@@finally} clause, if present, will be executed upon exit from the
2320 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2321 regardless of whether any exceptions are thrown, caught or rethrown
2322 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2323 of the @code{finally} clause in Java.
2325 There are several caveats to using the new exception mechanism:
2327 @itemize @bullet
2328 @item
2329 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2330 idioms provided by the @code{NSException} class, the new
2331 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2332 systems, due to additional functionality needed in the (NeXT) Objective-C
2333 runtime.
2335 @item
2336 As mentioned above, the new exceptions do not support handling
2337 types other than Objective-C objects.   Furthermore, when used from
2338 Objective-C++, the Objective-C exception model does not interoperate with C++
2339 exceptions at this time.  This means you cannot @code{@@throw} an exception
2340 from Objective-C and @code{catch} it in C++, or vice versa
2341 (i.e., @code{throw @dots{} @@catch}).
2342 @end itemize
2344 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2345 blocks for thread-safe execution:
2347 @smallexample
2348   @@synchronized (ObjCClass *guard) @{
2349     @dots{}
2350   @}
2351 @end smallexample
2353 Upon entering the @code{@@synchronized} block, a thread of execution shall
2354 first check whether a lock has been placed on the corresponding @code{guard}
2355 object by another thread.  If it has, the current thread shall wait until
2356 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2357 the current thread will place its own lock on it, execute the code contained in
2358 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2359 making @code{guard} available to other threads).
2361 Unlike Java, Objective-C does not allow for entire methods to be marked
2362 @code{@@synchronized}.  Note that throwing exceptions out of
2363 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2364 to be unlocked properly.
2366 @item -fobjc-gc
2367 @opindex fobjc-gc
2368 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2370 @item -freplace-objc-classes
2371 @opindex freplace-objc-classes
2372 Emit a special marker instructing @command{ld(1)} not to statically link in
2373 the resulting object file, and allow @command{dyld(1)} to load it in at
2374 run time instead.  This is used in conjunction with the Fix-and-Continue
2375 debugging mode, where the object file in question may be recompiled and
2376 dynamically reloaded in the course of program execution, without the need
2377 to restart the program itself.  Currently, Fix-and-Continue functionality
2378 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2379 and later.
2381 @item -fzero-link
2382 @opindex fzero-link
2383 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2384 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2385 compile time) with static class references that get initialized at load time,
2386 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2387 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2388 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2389 for individual class implementations to be modified during program execution.
2391 @item -gen-decls
2392 @opindex gen-decls
2393 Dump interface declarations for all classes seen in the source file to a
2394 file named @file{@var{sourcename}.decl}.
2396 @item -Wassign-intercept
2397 @opindex Wassign-intercept
2398 Warn whenever an Objective-C assignment is being intercepted by the
2399 garbage collector.
2401 @item -Wno-protocol
2402 @opindex Wno-protocol
2403 If a class is declared to implement a protocol, a warning is issued for
2404 every method in the protocol that is not implemented by the class.  The
2405 default behavior is to issue a warning for every method not explicitly
2406 implemented in the class, even if a method implementation is inherited
2407 from the superclass.  If you use the @option{-Wno-protocol} option, then
2408 methods inherited from the superclass are considered to be implemented,
2409 and no warning is issued for them.
2411 @item -Wselector
2412 @opindex Wselector
2413 Warn if multiple methods of different types for the same selector are
2414 found during compilation.  The check is performed on the list of methods
2415 in the final stage of compilation.  Additionally, a check is performed
2416 for each selector appearing in a @code{@@selector(@dots{})}
2417 expression, and a corresponding method for that selector has been found
2418 during compilation.  Because these checks scan the method table only at
2419 the end of compilation, these warnings are not produced if the final
2420 stage of compilation is not reached, for example because an error is
2421 found during compilation, or because the @option{-fsyntax-only} option is
2422 being used.
2424 @item -Wstrict-selector-match
2425 @opindex Wstrict-selector-match
2426 Warn if multiple methods with differing argument and/or return types are
2427 found for a given selector when attempting to send a message using this
2428 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2429 is off (which is the default behavior), the compiler will omit such warnings
2430 if any differences found are confined to types which share the same size
2431 and alignment.
2433 @item -Wundeclared-selector
2434 @opindex Wundeclared-selector
2435 Warn if a @code{@@selector(@dots{})} expression referring to an
2436 undeclared selector is found.  A selector is considered undeclared if no
2437 method with that name has been declared before the
2438 @code{@@selector(@dots{})} expression, either explicitly in an
2439 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2440 an @code{@@implementation} section.  This option always performs its
2441 checks as soon as a @code{@@selector(@dots{})} expression is found,
2442 while @option{-Wselector} only performs its checks in the final stage of
2443 compilation.  This also enforces the coding style convention
2444 that methods and selectors must be declared before being used.
2446 @item -print-objc-runtime-info
2447 @opindex print-objc-runtime-info
2448 Generate C header describing the largest structure that is passed by
2449 value, if any.
2451 @end table
2453 @node Language Independent Options
2454 @section Options to Control Diagnostic Messages Formatting
2455 @cindex options to control diagnostics formatting
2456 @cindex diagnostic messages
2457 @cindex message formatting
2459 Traditionally, diagnostic messages have been formatted irrespective of
2460 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2461 below can be used to control the diagnostic messages formatting
2462 algorithm, e.g.@: how many characters per line, how often source location
2463 information should be reported.  Right now, only the C++ front end can
2464 honor these options.  However it is expected, in the near future, that
2465 the remaining front ends would be able to digest them correctly.
2467 @table @gcctabopt
2468 @item -fmessage-length=@var{n}
2469 @opindex fmessage-length
2470 Try to format error messages so that they fit on lines of about @var{n}
2471 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2472 the front ends supported by GCC@.  If @var{n} is zero, then no
2473 line-wrapping will be done; each error message will appear on a single
2474 line.
2476 @opindex fdiagnostics-show-location
2477 @item -fdiagnostics-show-location=once
2478 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2479 reporter to emit @emph{once} source location information; that is, in
2480 case the message is too long to fit on a single physical line and has to
2481 be wrapped, the source location won't be emitted (as prefix) again,
2482 over and over, in subsequent continuation lines.  This is the default
2483 behavior.
2485 @item -fdiagnostics-show-location=every-line
2486 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2487 messages reporter to emit the same source location information (as
2488 prefix) for physical lines that result from the process of breaking
2489 a message which is too long to fit on a single line.
2491 @item -fdiagnostics-show-option
2492 @opindex fdiagnostics-show-option
2493 This option instructs the diagnostic machinery to add text to each
2494 diagnostic emitted, which indicates which command line option directly
2495 controls that diagnostic, when such an option is known to the
2496 diagnostic machinery.
2498 @item -Wcoverage-mismatch
2499 @opindex Wcoverage-mismatch
2500 Warn if feedback profiles do not match when using the
2501 @option{-fprofile-use} option.
2502 If a source file was changed between @option{-fprofile-gen} and
2503 @option{-fprofile-use}, the files with the profile feedback can fail
2504 to match the source file and GCC can not use the profile feedback
2505 information.  By default, GCC emits an error message in this case.
2506 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2507 error.  GCC does not use appropriate feedback profiles, so using this
2508 option can result in poorly optimized code.  This option is useful
2509 only in the case of very minor changes such as bug fixes to an
2510 existing code-base.
2512 @end table
2514 @node Warning Options
2515 @section Options to Request or Suppress Warnings
2516 @cindex options to control warnings
2517 @cindex warning messages
2518 @cindex messages, warning
2519 @cindex suppressing warnings
2521 Warnings are diagnostic messages that report constructions which
2522 are not inherently erroneous but which are risky or suggest there
2523 may have been an error.
2525 You can request many specific warnings with options beginning @samp{-W},
2526 for example @option{-Wimplicit} to request warnings on implicit
2527 declarations.  Each of these specific warning options also has a
2528 negative form beginning @samp{-Wno-} to turn off warnings;
2529 for example, @option{-Wno-implicit}.  This manual lists only one of the
2530 two forms, whichever is not the default.
2532 The following options control the amount and kinds of warnings produced
2533 by GCC; for further, language-specific options also refer to
2534 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2535 Options}.
2537 @table @gcctabopt
2538 @cindex syntax checking
2539 @item -fsyntax-only
2540 @opindex fsyntax-only
2541 Check the code for syntax errors, but don't do anything beyond that.
2543 @item -pedantic
2544 @opindex pedantic
2545 Issue all the warnings demanded by strict ISO C and ISO C++;
2546 reject all programs that use forbidden extensions, and some other
2547 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2548 version of the ISO C standard specified by any @option{-std} option used.
2550 Valid ISO C and ISO C++ programs should compile properly with or without
2551 this option (though a rare few will require @option{-ansi} or a
2552 @option{-std} option specifying the required version of ISO C)@.  However,
2553 without this option, certain GNU extensions and traditional C and C++
2554 features are supported as well.  With this option, they are rejected.
2556 @option{-pedantic} does not cause warning messages for use of the
2557 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2558 warnings are also disabled in the expression that follows
2559 @code{__extension__}.  However, only system header files should use
2560 these escape routes; application programs should avoid them.
2561 @xref{Alternate Keywords}.
2563 Some users try to use @option{-pedantic} to check programs for strict ISO
2564 C conformance.  They soon find that it does not do quite what they want:
2565 it finds some non-ISO practices, but not all---only those for which
2566 ISO C @emph{requires} a diagnostic, and some others for which
2567 diagnostics have been added.
2569 A feature to report any failure to conform to ISO C might be useful in
2570 some instances, but would require considerable additional work and would
2571 be quite different from @option{-pedantic}.  We don't have plans to
2572 support such a feature in the near future.
2574 Where the standard specified with @option{-std} represents a GNU
2575 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2576 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2577 extended dialect is based.  Warnings from @option{-pedantic} are given
2578 where they are required by the base standard.  (It would not make sense
2579 for such warnings to be given only for features not in the specified GNU
2580 C dialect, since by definition the GNU dialects of C include all
2581 features the compiler supports with the given option, and there would be
2582 nothing to warn about.)
2584 @item -pedantic-errors
2585 @opindex pedantic-errors
2586 Like @option{-pedantic}, except that errors are produced rather than
2587 warnings.
2589 @item -w
2590 @opindex w
2591 Inhibit all warning messages.
2593 @item -Wno-import
2594 @opindex Wno-import
2595 Inhibit warning messages about the use of @samp{#import}.
2597 @item -Wchar-subscripts
2598 @opindex Wchar-subscripts
2599 Warn if an array subscript has type @code{char}.  This is a common cause
2600 of error, as programmers often forget that this type is signed on some
2601 machines.
2602 This warning is enabled by @option{-Wall}.
2604 @item -Wcomment
2605 @opindex Wcomment
2606 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2607 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2608 This warning is enabled by @option{-Wall}.
2610 @item -Wfatal-errors
2611 @opindex Wfatal-errors
2612 This option causes the compiler to abort compilation on the first error
2613 occurred rather than trying to keep going and printing further error
2614 messages.
2616 @item -Wformat
2617 @opindex Wformat
2618 @opindex ffreestanding
2619 @opindex fno-builtin
2620 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2621 the arguments supplied have types appropriate to the format string
2622 specified, and that the conversions specified in the format string make
2623 sense.  This includes standard functions, and others specified by format
2624 attributes (@pxref{Function Attributes}), in the @code{printf},
2625 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2626 not in the C standard) families (or other target-specific families).
2627 Which functions are checked without format attributes having been
2628 specified depends on the standard version selected, and such checks of
2629 functions without the attribute specified are disabled by
2630 @option{-ffreestanding} or @option{-fno-builtin}.
2632 The formats are checked against the format features supported by GNU
2633 libc version 2.2.  These include all ISO C90 and C99 features, as well
2634 as features from the Single Unix Specification and some BSD and GNU
2635 extensions.  Other library implementations may not support all these
2636 features; GCC does not support warning about features that go beyond a
2637 particular library's limitations.  However, if @option{-pedantic} is used
2638 with @option{-Wformat}, warnings will be given about format features not
2639 in the selected standard version (but not for @code{strfmon} formats,
2640 since those are not in any version of the C standard).  @xref{C Dialect
2641 Options,,Options Controlling C Dialect}.
2643 Since @option{-Wformat} also checks for null format arguments for
2644 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2646 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2647 aspects of format checking, the options @option{-Wformat-y2k},
2648 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2649 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2650 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2652 @item -Wformat-y2k
2653 @opindex Wformat-y2k
2654 If @option{-Wformat} is specified, also warn about @code{strftime}
2655 formats which may yield only a two-digit year.
2657 @item -Wno-format-extra-args
2658 @opindex Wno-format-extra-args
2659 If @option{-Wformat} is specified, do not warn about excess arguments to a
2660 @code{printf} or @code{scanf} format function.  The C standard specifies
2661 that such arguments are ignored.
2663 Where the unused arguments lie between used arguments that are
2664 specified with @samp{$} operand number specifications, normally
2665 warnings are still given, since the implementation could not know what
2666 type to pass to @code{va_arg} to skip the unused arguments.  However,
2667 in the case of @code{scanf} formats, this option will suppress the
2668 warning if the unused arguments are all pointers, since the Single
2669 Unix Specification says that such unused arguments are allowed.
2671 @item -Wno-format-zero-length
2672 @opindex Wno-format-zero-length
2673 If @option{-Wformat} is specified, do not warn about zero-length formats.
2674 The C standard specifies that zero-length formats are allowed.
2676 @item -Wformat-nonliteral
2677 @opindex Wformat-nonliteral
2678 If @option{-Wformat} is specified, also warn if the format string is not a
2679 string literal and so cannot be checked, unless the format function
2680 takes its format arguments as a @code{va_list}.
2682 @item -Wformat-security
2683 @opindex Wformat-security
2684 If @option{-Wformat} is specified, also warn about uses of format
2685 functions that represent possible security problems.  At present, this
2686 warns about calls to @code{printf} and @code{scanf} functions where the
2687 format string is not a string literal and there are no format arguments,
2688 as in @code{printf (foo);}.  This may be a security hole if the format
2689 string came from untrusted input and contains @samp{%n}.  (This is
2690 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2691 in future warnings may be added to @option{-Wformat-security} that are not
2692 included in @option{-Wformat-nonliteral}.)
2694 @item -Wformat=2
2695 @opindex Wformat=2
2696 Enable @option{-Wformat} plus format checks not included in
2697 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2698 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2700 @item -Wnonnull
2701 @opindex Wnonnull
2702 Warn about passing a null pointer for arguments marked as
2703 requiring a non-null value by the @code{nonnull} function attribute.
2705 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2706 can be disabled with the @option{-Wno-nonnull} option.
2708 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2709 @opindex Winit-self
2710 Warn about uninitialized variables which are initialized with themselves.
2711 Note this option can only be used with the @option{-Wuninitialized} option,
2712 which in turn only works with @option{-O1} and above.
2714 For example, GCC will warn about @code{i} being uninitialized in the
2715 following snippet only when @option{-Winit-self} has been specified:
2716 @smallexample
2717 @group
2718 int f()
2720   int i = i;
2721   return i;
2723 @end group
2724 @end smallexample
2726 @item -Wimplicit-int
2727 @opindex Wimplicit-int
2728 Warn when a declaration does not specify a type.
2729 This warning is enabled by @option{-Wall}.
2731 @item -Wimplicit-function-declaration
2732 @opindex Wimplicit-function-declaration
2733 @opindex Wno-implicit-function-declaration
2734 Give a warning whenever a function is used before being declared. In
2735 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
2736 enabled by default and it is made into an error by
2737 @option{-pedantic-errors}. This warning is also enabled by
2738 @option{-Wall}.
2740 @item -Wimplicit
2741 @opindex Wimplicit
2742 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2743 This warning is enabled by @option{-Wall}.
2745 @item -Wmain
2746 @opindex Wmain
2747 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2748 function with external linkage, returning int, taking either zero
2749 arguments, two, or three arguments of appropriate types.
2750 This warning is enabled by @option{-Wall}.
2752 @item -Wmissing-braces
2753 @opindex Wmissing-braces
2754 Warn if an aggregate or union initializer is not fully bracketed.  In
2755 the following example, the initializer for @samp{a} is not fully
2756 bracketed, but that for @samp{b} is fully bracketed.
2758 @smallexample
2759 int a[2][2] = @{ 0, 1, 2, 3 @};
2760 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2761 @end smallexample
2763 This warning is enabled by @option{-Wall}.
2765 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2766 @opindex Wmissing-include-dirs
2767 Warn if a user-supplied include directory does not exist.
2769 @item -Wparentheses
2770 @opindex Wparentheses
2771 Warn if parentheses are omitted in certain contexts, such
2772 as when there is an assignment in a context where a truth value
2773 is expected, or when operators are nested whose precedence people
2774 often get confused about.
2776 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2777 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2778 interpretation from that of ordinary mathematical notation.
2780 Also warn about constructions where there may be confusion to which
2781 @code{if} statement an @code{else} branch belongs.  Here is an example of
2782 such a case:
2784 @smallexample
2785 @group
2787   if (a)
2788     if (b)
2789       foo ();
2790   else
2791     bar ();
2793 @end group
2794 @end smallexample
2796 In C/C++, every @code{else} branch belongs to the innermost possible
2797 @code{if} statement, which in this example is @code{if (b)}.  This is
2798 often not what the programmer expected, as illustrated in the above
2799 example by indentation the programmer chose.  When there is the
2800 potential for this confusion, GCC will issue a warning when this flag
2801 is specified.  To eliminate the warning, add explicit braces around
2802 the innermost @code{if} statement so there is no way the @code{else}
2803 could belong to the enclosing @code{if}.  The resulting code would
2804 look like this:
2806 @smallexample
2807 @group
2809   if (a)
2810     @{
2811       if (b)
2812         foo ();
2813       else
2814         bar ();
2815     @}
2817 @end group
2818 @end smallexample
2820 This warning is enabled by @option{-Wall}.
2822 @item -Wsequence-point
2823 @opindex Wsequence-point
2824 Warn about code that may have undefined semantics because of violations
2825 of sequence point rules in the C and C++ standards.
2827 The C and C++ standards defines the order in which expressions in a C/C++
2828 program are evaluated in terms of @dfn{sequence points}, which represent
2829 a partial ordering between the execution of parts of the program: those
2830 executed before the sequence point, and those executed after it.  These
2831 occur after the evaluation of a full expression (one which is not part
2832 of a larger expression), after the evaluation of the first operand of a
2833 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2834 function is called (but after the evaluation of its arguments and the
2835 expression denoting the called function), and in certain other places.
2836 Other than as expressed by the sequence point rules, the order of
2837 evaluation of subexpressions of an expression is not specified.  All
2838 these rules describe only a partial order rather than a total order,
2839 since, for example, if two functions are called within one expression
2840 with no sequence point between them, the order in which the functions
2841 are called is not specified.  However, the standards committee have
2842 ruled that function calls do not overlap.
2844 It is not specified when between sequence points modifications to the
2845 values of objects take effect.  Programs whose behavior depends on this
2846 have undefined behavior; the C and C++ standards specify that ``Between
2847 the previous and next sequence point an object shall have its stored
2848 value modified at most once by the evaluation of an expression.
2849 Furthermore, the prior value shall be read only to determine the value
2850 to be stored.''.  If a program breaks these rules, the results on any
2851 particular implementation are entirely unpredictable.
2853 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2854 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2855 diagnosed by this option, and it may give an occasional false positive
2856 result, but in general it has been found fairly effective at detecting
2857 this sort of problem in programs.
2859 The standard is worded confusingly, therefore there is some debate
2860 over the precise meaning of the sequence point rules in subtle cases.
2861 Links to discussions of the problem, including proposed formal
2862 definitions, may be found on the GCC readings page, at
2863 @w{@uref{http://gcc.gnu.org/readings.html}}.
2865 This warning is enabled by @option{-Wall} for C and C++.
2867 @item -Wreturn-type
2868 @opindex Wreturn-type
2869 @opindex Wno-return-type
2870 Warn whenever a function is defined with a return-type that defaults
2871 to @code{int}.  Also warn about any @code{return} statement with no
2872 return-value in a function whose return-type is not @code{void}
2873 (falling off the end of the function body is considered returning
2874 without a value), and about a @code{return} statement with a
2875 expression in a function whose return-type is @code{void}.
2877 Also warn if the return type of a function has a type qualifier
2878 such as @code{const}.  For ISO C such a type qualifier has no effect,
2879 since the value returned by a function is not an lvalue.
2880 For C++, the warning is only emitted for scalar types or @code{void}.
2881 ISO C prohibits qualified @code{void} return types on function
2882 definitions, so such return types always receive a warning
2883 even without this option.
2885 For C++, a function without return type always produces a diagnostic
2886 message, even when @option{-Wno-return-type} is specified.  The only
2887 exceptions are @samp{main} and functions defined in system headers.
2889 This warning is enabled by @option{-Wall}.
2891 @item -Wswitch
2892 @opindex Wswitch
2893 Warn whenever a @code{switch} statement has an index of enumerated type
2894 and lacks a @code{case} for one or more of the named codes of that
2895 enumeration.  (The presence of a @code{default} label prevents this
2896 warning.)  @code{case} labels outside the enumeration range also
2897 provoke warnings when this option is used.
2898 This warning is enabled by @option{-Wall}.
2900 @item -Wswitch-default
2901 @opindex Wswitch-switch
2902 Warn whenever a @code{switch} statement does not have a @code{default}
2903 case.
2905 @item -Wswitch-enum
2906 @opindex Wswitch-enum
2907 Warn whenever a @code{switch} statement has an index of enumerated type
2908 and lacks a @code{case} for one or more of the named codes of that
2909 enumeration.  @code{case} labels outside the enumeration range also
2910 provoke warnings when this option is used.
2912 @item -Wtrigraphs
2913 @opindex Wtrigraphs
2914 Warn if any trigraphs are encountered that might change the meaning of
2915 the program (trigraphs within comments are not warned about).
2916 This warning is enabled by @option{-Wall}.
2918 @item -Wunused-function
2919 @opindex Wunused-function
2920 Warn whenever a static function is declared but not defined or a
2921 non-inline static function is unused.
2922 This warning is enabled by @option{-Wall}.
2924 @item -Wunused-label
2925 @opindex Wunused-label
2926 Warn whenever a label is declared but not used.
2927 This warning is enabled by @option{-Wall}.
2929 To suppress this warning use the @samp{unused} attribute
2930 (@pxref{Variable Attributes}).
2932 @item -Wunused-parameter
2933 @opindex Wunused-parameter
2934 Warn whenever a function parameter is unused aside from its declaration.
2936 To suppress this warning use the @samp{unused} attribute
2937 (@pxref{Variable Attributes}).
2939 @item -Wunused-variable
2940 @opindex Wunused-variable
2941 Warn whenever a local variable or non-constant static variable is unused
2942 aside from its declaration.
2943 This warning is enabled by @option{-Wall}.
2945 To suppress this warning use the @samp{unused} attribute
2946 (@pxref{Variable Attributes}).
2948 @item -Wunused-value
2949 @opindex Wunused-value
2950 Warn whenever a statement computes a result that is explicitly not
2951 used. To suppress this warning cast the unused expression to
2952 @samp{void}. This includes an expression-statement or the left-hand
2953 side of a comma expression that contains no side effects. For example,
2954 an expression such as @samp{x[i,j]} will cause a warning, while
2955 @samp{x[(void)i,j]} will not.
2957 This warning is enabled by @option{-Wall}.
2959 @item -Wunused
2960 @opindex Wunused
2961 All the above @option{-Wunused} options combined.
2963 In order to get a warning about an unused function parameter, you must
2964 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2965 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2967 @item -Wuninitialized
2968 @opindex Wuninitialized
2969 Warn if an automatic variable is used without first being initialized or
2970 if a variable may be clobbered by a @code{setjmp} call.
2972 These warnings are possible only in optimizing compilation,
2973 because they require data flow information that is computed only
2974 when optimizing.  If you do not specify @option{-O}, you will not get
2975 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2976 requiring @option{-O}.
2978 If you want to warn about code which uses the uninitialized value of the
2979 variable in its own initializer, use the @option{-Winit-self} option.
2981 These warnings occur for individual uninitialized or clobbered
2982 elements of structure, union or array variables as well as for
2983 variables which are uninitialized or clobbered as a whole.  They do
2984 not occur for variables or elements declared @code{volatile}.  Because
2985 these warnings depend on optimization, the exact variables or elements
2986 for which there are warnings will depend on the precise optimization
2987 options and version of GCC used.
2989 Note that there may be no warning about a variable that is used only
2990 to compute a value that itself is never used, because such
2991 computations may be deleted by data flow analysis before the warnings
2992 are printed.
2994 These warnings are made optional because GCC is not smart
2995 enough to see all the reasons why the code might be correct
2996 despite appearing to have an error.  Here is one example of how
2997 this can happen:
2999 @smallexample
3000 @group
3002   int x;
3003   switch (y)
3004     @{
3005     case 1: x = 1;
3006       break;
3007     case 2: x = 4;
3008       break;
3009     case 3: x = 5;
3010     @}
3011   foo (x);
3013 @end group
3014 @end smallexample
3016 @noindent
3017 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3018 always initialized, but GCC doesn't know this.  Here is
3019 another common case:
3021 @smallexample
3023   int save_y;
3024   if (change_y) save_y = y, y = new_y;
3025   @dots{}
3026   if (change_y) y = save_y;
3028 @end smallexample
3030 @noindent
3031 This has no bug because @code{save_y} is used only if it is set.
3033 @cindex @code{longjmp} warnings
3034 This option also warns when a non-volatile automatic variable might be
3035 changed by a call to @code{longjmp}.  These warnings as well are possible
3036 only in optimizing compilation.
3038 The compiler sees only the calls to @code{setjmp}.  It cannot know
3039 where @code{longjmp} will be called; in fact, a signal handler could
3040 call it at any point in the code.  As a result, you may get a warning
3041 even when there is in fact no problem because @code{longjmp} cannot
3042 in fact be called at the place which would cause a problem.
3044 Some spurious warnings can be avoided if you declare all the functions
3045 you use that never return as @code{noreturn}.  @xref{Function
3046 Attributes}.
3048 This warning is enabled by @option{-Wall}.
3050 @item -Wunknown-pragmas
3051 @opindex Wunknown-pragmas
3052 @cindex warning for unknown pragmas
3053 @cindex unknown pragmas, warning
3054 @cindex pragmas, warning of unknown
3055 Warn when a #pragma directive is encountered which is not understood by
3056 GCC@.  If this command line option is used, warnings will even be issued
3057 for unknown pragmas in system header files.  This is not the case if
3058 the warnings were only enabled by the @option{-Wall} command line option.
3060 @item -Wno-pragmas
3061 @opindex Wno-pragmas
3062 @opindex Wpragmas
3063 Do not warn about misuses of pragmas, such as incorrect parameters,
3064 invalid syntax, or conflicts between pragmas.  See also
3065 @samp{-Wunknown-pragmas}.
3067 @item -Wstrict-aliasing
3068 @opindex Wstrict-aliasing
3069 This option is only active when @option{-fstrict-aliasing} is active.
3070 It warns about code which might break the strict aliasing rules that the
3071 compiler is using for optimization.  The warning does not catch all
3072 cases, but does attempt to catch the more common pitfalls.  It is
3073 included in @option{-Wall}.
3074 It is equivalent to -Wstrict-aliasing=3
3076 @item -Wstrict-aliasing=n
3077 @opindex Wstrict-aliasing=n
3078 This option is only active when @option{-fstrict-aliasing} is active.
3079 It warns about code which might break the strict aliasing rules that the
3080 compiler is using for optimization.
3081 Higher levels correspond to higher accuracy (fewer false positives).
3082 Higher levels also correspond to more effort, similar to the way -O works.
3083 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3084 with n=3.
3086 Level 1: Most aggressive, quick, least accurate.
3087 Possibly useful when higher levels
3088 do not warn but -fstrict-aliasing still breaks the code, as it has very few 
3089 false negatives.  However, it has many false positives.
3090 Warns for all pointer conversions between possibly incompatible types, 
3091 even if never dereferenced.  Runs in the frontend only.
3093 Level 2: Aggressive, quick, not too precise.
3094 May still have many false positives (not as many as level 1 though),
3095 and few false negatives (but possibly more than level 1).
3096 Unlike level 1, it only warns when an address is taken.  Warns about
3097 incomplete types.  Runs in the frontend only.
3099 Level 3 (default for @option{-Wstrict-aliasing}): 
3100 Should have very few false positives and few false 
3101 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3102 Takes care of the common punn+dereference pattern in the frontend:
3103 @code{*(int*)&some_float}.
3104 If optimization is enabled, it also runs in the backend, where it deals 
3105 with multiple statement cases using flow-sensitive points-to information.
3106 Only warns when the converted pointer is dereferenced.
3107 Does not warn about incomplete types.
3109 @item -Wstrict-overflow
3110 @item -Wstrict-overflow=@var{n}
3111 @opindex Wstrict-overflow
3112 This option is only active when @option{-fstrict-overflow} is active.
3113 It warns about cases where the compiler optimizes based on the
3114 assumption that signed overflow does not occur.  Note that it does not
3115 warn about all cases where the code might overflow: it only warns
3116 about cases where the compiler implements some optimization.  Thus
3117 this warning depends on the optimization level.
3119 An optimization which assumes that signed overflow does not occur is
3120 perfectly safe if the values of the variables involved are such that
3121 overflow never does, in fact, occur.  Therefore this warning can
3122 easily give a false positive: a warning about code which is not
3123 actually a problem.  To help focus on important issues, several
3124 warning levels are defined.  No warnings are issued for the use of
3125 undefined signed overflow when estimating how many iterations a loop
3126 will require, in particular when determining whether a loop will be
3127 executed at all.
3129 @table @option
3130 @item -Wstrict-overflow=1
3131 Warn about cases which are both questionable and easy to avoid.  For
3132 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3133 compiler will simplify this to @code{1}.  This level of
3134 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3135 are not, and must be explicitly requested.
3137 @item -Wstrict-overflow=2
3138 Also warn about other cases where a comparison is simplified to a
3139 constant.  For example: @code{abs (x) >= 0}.  This can only be
3140 simplified when @option{-fstrict-overflow} is in effect, because
3141 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3142 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3143 @option{-Wstrict-overflow=2}.
3145 @item -Wstrict-overflow=3
3146 Also warn about other cases where a comparison is simplified.  For
3147 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3149 @item -Wstrict-overflow=4
3150 Also warn about other simplifications not covered by the above cases.
3151 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3153 @item -Wstrict-overflow=5
3154 Also warn about cases where the compiler reduces the magnitude of a
3155 constant involved in a comparison.  For example: @code{x + 2 > y} will
3156 be simplified to @code{x + 1 >= y}.  This is reported only at the
3157 highest warning level because this simplification applies to many
3158 comparisons, so this warning level will give a very large number of
3159 false positives.
3160 @end table
3162 @item -Warray-bounds
3163 @opindex Wno-array-bounds
3164 @opindex Warray-bounds
3165 This option is only active when @option{-ftree-vrp} is active
3166 (default for -O2 and above). It warns about subscripts to arrays
3167 that are always out of bounds. This warning is enabled by @option{-Wall}.
3169 @item -Wall
3170 @opindex Wall
3171 All of the above @samp{-W} options combined.  This enables all the
3172 warnings about constructions that some users consider questionable, and
3173 that are easy to avoid (or modify to prevent the warning), even in
3174 conjunction with macros.  This also enables some language-specific
3175 warnings described in @ref{C++ Dialect Options} and
3176 @ref{Objective-C and Objective-C++ Dialect Options}.
3177 @end table
3179 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
3180 Some of them warn about constructions that users generally do not
3181 consider questionable, but which occasionally you might wish to check
3182 for; others warn about constructions that are necessary or hard to avoid
3183 in some cases, and there is no simple way to modify the code to suppress
3184 the warning.
3186 @table @gcctabopt
3187 @item -Wextra
3188 @opindex W
3189 @opindex Wextra
3190 (This option used to be called @option{-W}.  The older name is still
3191 supported, but the newer name is more descriptive.)  Print extra warning
3192 messages for these events:
3194 @itemize @bullet
3195 @item
3196 Warn if a comparison is always true or always false due to the limited
3197 range of the data type, but do not warn for constant expressions.  For
3198 example, warn if an unsigned variable is compared against zero with
3199 @samp{<} or @samp{>=}.  This warning can be independently controlled
3200 by @option{-Wtype-limits}.
3202 @item @r{(C only)}
3203 Storage-class specifiers like @code{static} are not the first things
3204 in a declaration.  According to the C Standard, this usage is
3205 obsolescent.  This warning can be independently controlled by
3206 @option{-Wold-style-declaration}.
3208 @item
3209 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
3210 arguments.
3212 @item
3213 A comparison between signed and unsigned values could produce an
3214 incorrect result when the signed value is converted to unsigned.
3215 (But don't warn if @option{-Wno-sign-compare} is also specified.)
3217 @item
3218 An aggregate has an initializer which does not initialize all members.
3219 This warning can be independently controlled by
3220 @option{-Wmissing-field-initializers}.
3222 @item
3223 An initialized field without side effects is overridden when using
3224 designated initializers (@pxref{Designated Inits, , Designated
3225 Initializers}).  This warning can be independently controlled by
3226 @option{-Woverride-init}.
3228 @item @r{(C only)}
3229 A function parameter is declared without a type specifier in K&R-style
3230 functions.  This warning can be independently controlled by
3231 @option{-Wmissing-parameter-type}.
3233 @item
3234 An empty body occurs in an @samp{if}, @samp{else} or
3235 @samp{do while} statement. This warning can be independently
3236 controlled by @option{-Wempty-body}.
3238 @item @r{(C++ only)}
3239 An empty body occurs in a @samp{while} or @samp{for} statement with no
3240 whitespacing before the semicolon. This warning can be independently
3241 controlled by @option{-Wempty-body}.
3243 @item
3244 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3245 @samp{>}, or @samp{>=}.
3247 @item
3248 A variable might be changed by @samp{longjmp} or @samp{vfork}.
3249 This warning can be independently controlled by @option{-Wclobbered}.
3251 @item @r{(C++ only)}
3252 An enumerator and a non-enumerator both appear in a conditional expression.
3254 @item @r{(C++ only)}
3255 A non-static reference or non-static @samp{const} member appears in a
3256 class without constructors.
3258 @item @r{(C++ only)}
3259 Ambiguous virtual bases.
3261 @item @r{(C++ only)}
3262 Subscripting an array which has been declared @samp{register}.
3264 @item @r{(C++ only)}
3265 Taking the address of a variable which has been declared @samp{register}.
3267 @item @r{(C++ only)}
3268 A base class is not initialized in a derived class' copy constructor.
3269 @end itemize
3271 @item -Wno-div-by-zero
3272 @opindex Wno-div-by-zero
3273 @opindex Wdiv-by-zero
3274 Do not warn about compile-time integer division by zero.  Floating point
3275 division by zero is not warned about, as it can be a legitimate way of
3276 obtaining infinities and NaNs.
3278 @item -Wsystem-headers
3279 @opindex Wsystem-headers
3280 @cindex warnings from system headers
3281 @cindex system headers, warnings from
3282 Print warning messages for constructs found in system header files.
3283 Warnings from system headers are normally suppressed, on the assumption
3284 that they usually do not indicate real problems and would only make the
3285 compiler output harder to read.  Using this command line option tells
3286 GCC to emit warnings from system headers as if they occurred in user
3287 code.  However, note that using @option{-Wall} in conjunction with this
3288 option will @emph{not} warn about unknown pragmas in system
3289 headers---for that, @option{-Wunknown-pragmas} must also be used.
3291 @item -Wfloat-equal
3292 @opindex Wfloat-equal
3293 Warn if floating point values are used in equality comparisons.
3295 The idea behind this is that sometimes it is convenient (for the
3296 programmer) to consider floating-point values as approximations to
3297 infinitely precise real numbers.  If you are doing this, then you need
3298 to compute (by analyzing the code, or in some other way) the maximum or
3299 likely maximum error that the computation introduces, and allow for it
3300 when performing comparisons (and when producing output, but that's a
3301 different problem).  In particular, instead of testing for equality, you
3302 would check to see whether the two values have ranges that overlap; and
3303 this is done with the relational operators, so equality comparisons are
3304 probably mistaken.
3306 @item -Wtraditional @r{(C only)}
3307 @opindex Wtraditional
3308 Warn about certain constructs that behave differently in traditional and
3309 ISO C@.  Also warn about ISO C constructs that have no traditional C
3310 equivalent, and/or problematic constructs which should be avoided.
3312 @itemize @bullet
3313 @item
3314 Macro parameters that appear within string literals in the macro body.
3315 In traditional C macro replacement takes place within string literals,
3316 but does not in ISO C@.
3318 @item
3319 In traditional C, some preprocessor directives did not exist.
3320 Traditional preprocessors would only consider a line to be a directive
3321 if the @samp{#} appeared in column 1 on the line.  Therefore
3322 @option{-Wtraditional} warns about directives that traditional C
3323 understands but would ignore because the @samp{#} does not appear as the
3324 first character on the line.  It also suggests you hide directives like
3325 @samp{#pragma} not understood by traditional C by indenting them.  Some
3326 traditional implementations would not recognize @samp{#elif}, so it
3327 suggests avoiding it altogether.
3329 @item
3330 A function-like macro that appears without arguments.
3332 @item
3333 The unary plus operator.
3335 @item
3336 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3337 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3338 constants.)  Note, these suffixes appear in macros defined in the system
3339 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3340 Use of these macros in user code might normally lead to spurious
3341 warnings, however GCC's integrated preprocessor has enough context to
3342 avoid warning in these cases.
3344 @item
3345 A function declared external in one block and then used after the end of
3346 the block.
3348 @item
3349 A @code{switch} statement has an operand of type @code{long}.
3351 @item
3352 A non-@code{static} function declaration follows a @code{static} one.
3353 This construct is not accepted by some traditional C compilers.
3355 @item
3356 The ISO type of an integer constant has a different width or
3357 signedness from its traditional type.  This warning is only issued if
3358 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3359 typically represent bit patterns, are not warned about.
3361 @item
3362 Usage of ISO string concatenation is detected.
3364 @item
3365 Initialization of automatic aggregates.
3367 @item
3368 Identifier conflicts with labels.  Traditional C lacks a separate
3369 namespace for labels.
3371 @item
3372 Initialization of unions.  If the initializer is zero, the warning is
3373 omitted.  This is done under the assumption that the zero initializer in
3374 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3375 initializer warnings and relies on default initialization to zero in the
3376 traditional C case.
3378 @item
3379 Conversions by prototypes between fixed/floating point values and vice
3380 versa.  The absence of these prototypes when compiling with traditional
3381 C would cause serious problems.  This is a subset of the possible
3382 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3384 @item
3385 Use of ISO C style function definitions.  This warning intentionally is
3386 @emph{not} issued for prototype declarations or variadic functions
3387 because these ISO C features will appear in your code when using
3388 libiberty's traditional C compatibility macros, @code{PARAMS} and
3389 @code{VPARAMS}.  This warning is also bypassed for nested functions
3390 because that feature is already a GCC extension and thus not relevant to
3391 traditional C compatibility.
3392 @end itemize
3394 @item -Wtraditional-conversion @r{(C only)}
3395 @opindex Wtraditional-conversion
3396 Warn if a prototype causes a type conversion that is different from what
3397 would happen to the same argument in the absence of a prototype.  This
3398 includes conversions of fixed point to floating and vice versa, and
3399 conversions changing the width or signedness of a fixed point argument
3400 except when the same as the default promotion.
3402 @item -Wdeclaration-after-statement @r{(C only)}
3403 @opindex Wdeclaration-after-statement
3404 Warn when a declaration is found after a statement in a block.  This
3405 construct, known from C++, was introduced with ISO C99 and is by default
3406 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3407 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3409 @item -Wundef
3410 @opindex Wundef
3411 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3413 @item -Wno-endif-labels
3414 @opindex Wno-endif-labels
3415 @opindex Wendif-labels
3416 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3418 @item -Wshadow
3419 @opindex Wshadow
3420 Warn whenever a local variable shadows another local variable, parameter or
3421 global variable or whenever a built-in function is shadowed.
3423 @item -Wlarger-than-@var{len}
3424 @opindex Wlarger-than
3425 Warn whenever an object of larger than @var{len} bytes is defined.
3427 @item -Wunsafe-loop-optimizations
3428 @opindex Wunsafe-loop-optimizations
3429 Warn if the loop cannot be optimized because the compiler could not
3430 assume anything on the bounds of the loop indices.  With
3431 @option{-funsafe-loop-optimizations} warn if the compiler made
3432 such assumptions.
3434 @item -Wpointer-arith
3435 @opindex Wpointer-arith
3436 Warn about anything that depends on the ``size of'' a function type or
3437 of @code{void}.  GNU C assigns these types a size of 1, for
3438 convenience in calculations with @code{void *} pointers and pointers
3439 to functions.  In C++, warn also when an arithmetic operation involves
3440 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3442 @item -Wtype-limits
3443 @opindex Wtype-limits
3444 @opindex Wno-type-limits
3445 Warn if a comparison is always true or always false due to the limited
3446 range of the data type, but do not warn for constant expressions.  For
3447 example, warn if an unsigned variable is compared against zero with
3448 @samp{<} or @samp{>=}.  This warning is also enabled by
3449 @option{-Wextra}.
3451 @item -Wbad-function-cast @r{(C only)}
3452 @opindex Wbad-function-cast
3453 Warn whenever a function call is cast to a non-matching type.
3454 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3456 @item -Wc++-compat
3457 Warn about ISO C constructs that are outside of the common subset of
3458 ISO C and ISO C++, e.g.@: request for implicit conversion from
3459 @code{void *} to a pointer to non-@code{void} type.
3461 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3462 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3463 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3464 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3466 @item -Wcast-qual
3467 @opindex Wcast-qual
3468 Warn whenever a pointer is cast so as to remove a type qualifier from
3469 the target type.  For example, warn if a @code{const char *} is cast
3470 to an ordinary @code{char *}.
3472 @item -Wcast-align
3473 @opindex Wcast-align
3474 Warn whenever a pointer is cast such that the required alignment of the
3475 target is increased.  For example, warn if a @code{char *} is cast to
3476 an @code{int *} on machines where integers can only be accessed at
3477 two- or four-byte boundaries.
3479 @item -Wwrite-strings
3480 @opindex Wwrite-strings
3481 When compiling C, give string constants the type @code{const
3482 char[@var{length}]} so that
3483 copying the address of one into a non-@code{const} @code{char *}
3484 pointer will get a warning; when compiling C++, warn about the
3485 deprecated conversion from string literals to @code{char *}.  This
3486 warning, by default, is enabled for C++ programs.
3487 These warnings will help you find at
3488 compile time code that can try to write into a string constant, but
3489 only if you have been very careful about using @code{const} in
3490 declarations and prototypes.  Otherwise, it will just be a nuisance;
3491 this is why we did not make @option{-Wall} request these warnings.
3493 @item -Wclobbered
3494 @opindex Wclobbered
3495 Warn for variables that might be changed by @samp{longjmp} or
3496 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3498 @item -Wconversion
3499 @opindex Wconversion
3500 @opindex Wno-conversion
3501 Warn for implicit conversions that may alter a value. This includes
3502 conversions between real and integer, like @code{abs (x)} when
3503 @code{x} is @code{double}; conversions between signed and unsigned,
3504 like @code{unsigned ui = -1}; and conversions to smaller types, like
3505 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3506 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3507 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3508 conversions between signed and unsigned integers can be disabled by
3509 using @option{-Wno-sign-conversion}.
3511 For C++, also warn for conversions between @code{NULL} and non-pointer
3512 types; confusing overload resolution for user-defined conversions; and
3513 conversions that will never use a type conversion operator:
3514 conversions to @code{void}, the same type, a base class or a reference
3515 to them. Warnings about conversions between signed and unsigned
3516 integers are disabled by default in C++ unless
3517 @option{-Wsign-conversion} is explicitly enabled.
3519 @item -Wempty-body
3520 @opindex Wempty-body
3521 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3522 while} statement.  Additionally, in C++, warn when an empty body occurs
3523 in a @samp{while} or @samp{for} statement with no whitespacing before
3524 the semicolon.  This warning is also enabled by @option{-Wextra}.
3526 @item -Wsign-compare
3527 @opindex Wsign-compare
3528 @cindex warning for comparison of signed and unsigned values
3529 @cindex comparison of signed and unsigned values, warning
3530 @cindex signed and unsigned values, comparison warning
3531 Warn when a comparison between signed and unsigned values could produce
3532 an incorrect result when the signed value is converted to unsigned.
3533 This warning is also enabled by @option{-Wextra}; to get the other warnings
3534 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3536 @item -Wsign-conversion
3537 @opindex Wsign-conversion
3538 @opindex Wno-sign-conversion
3539 Warn for implicit conversions that may change the sign of an integer
3540 value, like assigning a signed integer expression to an unsigned
3541 integer variable. An explicit cast silences the warning. In C, this
3542 option is enabled also by @option{-Wconversion}.
3544 @item -Waddress
3545 @opindex Waddress
3546 @opindex Wno-address
3547 Warn about suspicious uses of memory addresses. These include using
3548 the address of a function in a conditional expression, such as
3549 @code{void func(void); if (func)}, and comparisons against the memory
3550 address of a string literal, such as @code{if (x == "abc")}.  Such
3551 uses typically indicate a programmer error: the address of a function
3552 always evaluates to true, so their use in a conditional usually
3553 indicate that the programmer forgot the parentheses in a function
3554 call; and comparisons against string literals result in unspecified
3555 behavior and are not portable in C, so they usually indicate that the
3556 programmer intended to use @code{strcmp}.  This warning is enabled by
3557 @option{-Wall}.
3559 @item -Wlogical-op
3560 @opindex Wlogical-op
3561 @opindex Wno-logical-op
3562 Warn about suspicious uses of logical operators in expressions.
3563 This includes using logical operators in contexts where a
3564 bit-wise operator is likely to be expected.
3566 @item -Waggregate-return
3567 @opindex Waggregate-return
3568 Warn if any functions that return structures or unions are defined or
3569 called.  (In languages where you can return an array, this also elicits
3570 a warning.)
3572 @item -Wno-attributes
3573 @opindex Wno-attributes
3574 @opindex Wattributes
3575 Do not warn if an unexpected @code{__attribute__} is used, such as
3576 unrecognized attributes, function attributes applied to variables,
3577 etc.  This will not stop errors for incorrect use of supported
3578 attributes.
3580 @item -Wstrict-prototypes @r{(C only)}
3581 @opindex Wstrict-prototypes
3582 Warn if a function is declared or defined without specifying the
3583 argument types.  (An old-style function definition is permitted without
3584 a warning if preceded by a declaration which specifies the argument
3585 types.)
3587 @item -Wold-style-declaration @r{(C only)}
3588 @opindex Wold-style-declaration
3589 Warn for obsolescent usages, according to the C Standard, in a
3590 declaration. For example, warn if storage-class specifiers like
3591 @code{static} are not the first things in a declaration.  This warning
3592 is also enabled by @option{-Wextra}.
3594 @item -Wold-style-definition @r{(C only)}
3595 @opindex Wold-style-definition
3596 Warn if an old-style function definition is used.  A warning is given
3597 even if there is a previous prototype.
3599 @item -Wmissing-parameter-type @r{(C only)}
3600 @opindex Wmissing-parameter-type
3601 A function parameter is declared without a type specifier in K&R-style
3602 functions:
3604 @smallexample
3605 void foo(bar) @{ @}
3606 @end smallexample
3608 This warning is also enabled by @option{-Wextra}.
3610 @item -Wmissing-prototypes @r{(C only)}
3611 @opindex Wmissing-prototypes
3612 Warn if a global function is defined without a previous prototype
3613 declaration.  This warning is issued even if the definition itself
3614 provides a prototype.  The aim is to detect global functions that fail
3615 to be declared in header files.
3617 @item -Wmissing-declarations @r{(C and C++ only)}
3618 @opindex Wmissing-declarations
3619 Warn if a global function is defined without a previous declaration.
3620 Do so even if the definition itself provides a prototype.
3621 Use this option to detect global functions that are not declared in
3622 header files.  In C++, no warnings are issued for function templates,
3623 or for inline functions, or for functions in anonymous namespaces.
3625 @item -Wmissing-field-initializers
3626 @opindex Wmissing-field-initializers
3627 @opindex W
3628 @opindex Wextra
3629 Warn if a structure's initializer has some fields missing.  For
3630 example, the following code would cause such a warning, because
3631 @code{x.h} is implicitly zero:
3633 @smallexample
3634 struct s @{ int f, g, h; @};
3635 struct s x = @{ 3, 4 @};
3636 @end smallexample
3638 This option does not warn about designated initializers, so the following
3639 modification would not trigger a warning:
3641 @smallexample
3642 struct s @{ int f, g, h; @};
3643 struct s x = @{ .f = 3, .g = 4 @};
3644 @end smallexample
3646 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3647 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3649 @item -Wmissing-noreturn
3650 @opindex Wmissing-noreturn
3651 Warn about functions which might be candidates for attribute @code{noreturn}.
3652 Note these are only possible candidates, not absolute ones.  Care should
3653 be taken to manually verify functions actually do not ever return before
3654 adding the @code{noreturn} attribute, otherwise subtle code generation
3655 bugs could be introduced.  You will not get a warning for @code{main} in
3656 hosted C environments.
3658 @item -Wmissing-format-attribute
3659 @opindex Wmissing-format-attribute
3660 @opindex Wformat
3661 Warn about function pointers which might be candidates for @code{format}
3662 attributes.  Note these are only possible candidates, not absolute ones.
3663 GCC will guess that function pointers with @code{format} attributes that
3664 are used in assignment, initialization, parameter passing or return
3665 statements should have a corresponding @code{format} attribute in the
3666 resulting type.  I.e.@: the left-hand side of the assignment or
3667 initialization, the type of the parameter variable, or the return type
3668 of the containing function respectively should also have a @code{format}
3669 attribute to avoid the warning.
3671 GCC will also warn about function definitions which might be
3672 candidates for @code{format} attributes.  Again, these are only
3673 possible candidates.  GCC will guess that @code{format} attributes
3674 might be appropriate for any function that calls a function like
3675 @code{vprintf} or @code{vscanf}, but this might not always be the
3676 case, and some functions for which @code{format} attributes are
3677 appropriate may not be detected.
3679 @item -Wno-multichar
3680 @opindex Wno-multichar
3681 @opindex Wmultichar
3682 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3683 Usually they indicate a typo in the user's code, as they have
3684 implementation-defined values, and should not be used in portable code.
3686 @item -Wnormalized=<none|id|nfc|nfkc>
3687 @opindex Wnormalized
3688 @cindex NFC
3689 @cindex NFKC
3690 @cindex character set, input normalization
3691 In ISO C and ISO C++, two identifiers are different if they are
3692 different sequences of characters.  However, sometimes when characters
3693 outside the basic ASCII character set are used, you can have two
3694 different character sequences that look the same.  To avoid confusion,
3695 the ISO 10646 standard sets out some @dfn{normalization rules} which
3696 when applied ensure that two sequences that look the same are turned into
3697 the same sequence.  GCC can warn you if you are using identifiers which
3698 have not been normalized; this option controls that warning.
3700 There are four levels of warning that GCC supports.  The default is
3701 @option{-Wnormalized=nfc}, which warns about any identifier which is
3702 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3703 recommended form for most uses.
3705 Unfortunately, there are some characters which ISO C and ISO C++ allow
3706 in identifiers that when turned into NFC aren't allowable as
3707 identifiers.  That is, there's no way to use these symbols in portable
3708 ISO C or C++ and have all your identifiers in NFC.
3709 @option{-Wnormalized=id} suppresses the warning for these characters.
3710 It is hoped that future versions of the standards involved will correct
3711 this, which is why this option is not the default.
3713 You can switch the warning off for all characters by writing
3714 @option{-Wnormalized=none}.  You would only want to do this if you
3715 were using some other normalization scheme (like ``D''), because
3716 otherwise you can easily create bugs that are literally impossible to see.
3718 Some characters in ISO 10646 have distinct meanings but look identical
3719 in some fonts or display methodologies, especially once formatting has
3720 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3721 LETTER N'', will display just like a regular @code{n} which has been
3722 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3723 normalization scheme to convert all these into a standard form as
3724 well, and GCC will warn if your code is not in NFKC if you use
3725 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3726 about every identifier that contains the letter O because it might be
3727 confused with the digit 0, and so is not the default, but may be
3728 useful as a local coding convention if the programming environment is
3729 unable to be fixed to display these characters distinctly.
3731 @item -Wno-deprecated-declarations
3732 @opindex Wno-deprecated-declarations
3733 Do not warn about uses of functions (@pxref{Function Attributes}),
3734 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3735 Attributes}) marked as deprecated by using the @code{deprecated}
3736 attribute.
3738 @item -Wno-overflow
3739 @opindex Wno-overflow
3740 Do not warn about compile-time overflow in constant expressions.
3742 @item -Woverride-init
3743 @opindex Woverride-init
3744 @opindex W
3745 @opindex Wextra
3746 Warn if an initialized field without side effects is overridden when
3747 using designated initializers (@pxref{Designated Inits, , Designated
3748 Initializers}).
3750 This warning is included in @option{-Wextra}.  To get other
3751 @option{-Wextra} warnings without this one, use @samp{-Wextra
3752 -Wno-override-init}.
3754 @item -Wpacked
3755 @opindex Wpacked
3756 Warn if a structure is given the packed attribute, but the packed
3757 attribute has no effect on the layout or size of the structure.
3758 Such structures may be mis-aligned for little benefit.  For
3759 instance, in this code, the variable @code{f.x} in @code{struct bar}
3760 will be misaligned even though @code{struct bar} does not itself
3761 have the packed attribute:
3763 @smallexample
3764 @group
3765 struct foo @{
3766   int x;
3767   char a, b, c, d;
3768 @} __attribute__((packed));
3769 struct bar @{
3770   char z;
3771   struct foo f;
3773 @end group
3774 @end smallexample
3776 @item -Wpadded
3777 @opindex Wpadded
3778 Warn if padding is included in a structure, either to align an element
3779 of the structure or to align the whole structure.  Sometimes when this
3780 happens it is possible to rearrange the fields of the structure to
3781 reduce the padding and so make the structure smaller.
3783 @item -Wredundant-decls
3784 @opindex Wredundant-decls
3785 Warn if anything is declared more than once in the same scope, even in
3786 cases where multiple declaration is valid and changes nothing.
3788 @item -Wnested-externs @r{(C only)}
3789 @opindex Wnested-externs
3790 Warn if an @code{extern} declaration is encountered within a function.
3792 @item -Wunreachable-code
3793 @opindex Wunreachable-code
3794 Warn if the compiler detects that code will never be executed.
3796 This option is intended to warn when the compiler detects that at
3797 least a whole line of source code will never be executed, because
3798 some condition is never satisfied or because it is after a
3799 procedure that never returns.
3801 It is possible for this option to produce a warning even though there
3802 are circumstances under which part of the affected line can be executed,
3803 so care should be taken when removing apparently-unreachable code.
3805 For instance, when a function is inlined, a warning may mean that the
3806 line is unreachable in only one inlined copy of the function.
3808 This option is not made part of @option{-Wall} because in a debugging
3809 version of a program there is often substantial code which checks
3810 correct functioning of the program and is, hopefully, unreachable
3811 because the program does work.  Another common use of unreachable
3812 code is to provide behavior which is selectable at compile-time.
3814 @item -Winline
3815 @opindex Winline
3816 Warn if a function can not be inlined and it was declared as inline.
3817 Even with this option, the compiler will not warn about failures to
3818 inline functions declared in system headers.
3820 The compiler uses a variety of heuristics to determine whether or not
3821 to inline a function.  For example, the compiler takes into account
3822 the size of the function being inlined and the amount of inlining
3823 that has already been done in the current function.  Therefore,
3824 seemingly insignificant changes in the source program can cause the
3825 warnings produced by @option{-Winline} to appear or disappear.
3827 @item -Wno-invalid-offsetof @r{(C++ only)}
3828 @opindex Wno-invalid-offsetof
3829 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3830 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3831 to a non-POD type is undefined.  In existing C++ implementations,
3832 however, @samp{offsetof} typically gives meaningful results even when
3833 applied to certain kinds of non-POD types. (Such as a simple
3834 @samp{struct} that fails to be a POD type only by virtue of having a
3835 constructor.)  This flag is for users who are aware that they are
3836 writing nonportable code and who have deliberately chosen to ignore the
3837 warning about it.
3839 The restrictions on @samp{offsetof} may be relaxed in a future version
3840 of the C++ standard.
3842 @item -Wno-int-to-pointer-cast @r{(C only)}
3843 @opindex Wno-int-to-pointer-cast
3844 Suppress warnings from casts to pointer type of an integer of a
3845 different size.
3847 @item -Wno-pointer-to-int-cast @r{(C only)}
3848 @opindex Wno-pointer-to-int-cast
3849 Suppress warnings from casts from a pointer to an integer type of a
3850 different size.
3852 @item -Winvalid-pch
3853 @opindex Winvalid-pch
3854 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3855 the search path but can't be used.
3857 @item -Wlong-long
3858 @opindex Wlong-long
3859 @opindex Wno-long-long
3860 Warn if @samp{long long} type is used.  This is default.  To inhibit
3861 the warning messages, use @option{-Wno-long-long}.  Flags
3862 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3863 only when @option{-pedantic} flag is used.
3865 @item -Wvariadic-macros
3866 @opindex Wvariadic-macros
3867 @opindex Wno-variadic-macros
3868 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3869 alternate syntax when in pedantic ISO C99 mode.  This is default.
3870 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3872 @item -Wvla
3873 @opindex Wvla
3874 @opindex Wno-vla
3875 Warn if variable length array is used in the code.
3876 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
3877 the variable length array.
3879 @item -Wvolatile-register-var
3880 @opindex Wvolatile-register-var
3881 @opindex Wno-volatile-register-var
3882 Warn if a register variable is declared volatile.  The volatile
3883 modifier does not inhibit all optimizations that may eliminate reads
3884 and/or writes to register variables.
3886 @item -Wdisabled-optimization
3887 @opindex Wdisabled-optimization
3888 Warn if a requested optimization pass is disabled.  This warning does
3889 not generally indicate that there is anything wrong with your code; it
3890 merely indicates that GCC's optimizers were unable to handle the code
3891 effectively.  Often, the problem is that your code is too big or too
3892 complex; GCC will refuse to optimize programs when the optimization
3893 itself is likely to take inordinate amounts of time.
3895 @item -Wpointer-sign
3896 @opindex Wpointer-sign
3897 @opindex Wno-pointer-sign
3898 Warn for pointer argument passing or assignment with different signedness.
3899 This option is only supported for C and Objective-C@.  It is implied by
3900 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3901 @option{-Wno-pointer-sign}.
3903 @item -Werror
3904 @opindex Werror
3905 Make all warnings into errors.
3907 @item -Werror=
3908 @opindex Werror=
3909 Make the specified warning into an errors.  The specifier for a
3910 warning is appended, for example @option{-Werror=switch} turns the
3911 warnings controlled by @option{-Wswitch} into errors.  This switch
3912 takes a negative form, to be used to negate @option{-Werror} for
3913 specific warnings, for example @option{-Wno-error=switch} makes
3914 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3915 is in effect.  You can use the @option{-fdiagnostics-show-option}
3916 option to have each controllable warning amended with the option which
3917 controls it, to determine what to use with this option.
3919 Note that specifying @option{-Werror=}@var{foo} automatically implies
3920 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3921 imply anything.
3923 @item -Wstack-protector
3924 @opindex Wstack-protector
3925 This option is only active when @option{-fstack-protector} is active.  It
3926 warns about functions that will not be protected against stack smashing.
3928 @item -Woverlength-strings
3929 @opindex Woverlength-strings
3930 Warn about string constants which are longer than the ``minimum
3931 maximum'' length specified in the C standard.  Modern compilers
3932 generally allow string constants which are much longer than the
3933 standard's minimum limit, but very portable programs should avoid
3934 using longer strings.
3936 The limit applies @emph{after} string constant concatenation, and does
3937 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3938 C99, it was raised to 4095.  C++98 does not specify a normative
3939 minimum maximum, so we do not diagnose overlength strings in C++@.
3941 This option is implied by @option{-pedantic}, and can be disabled with
3942 @option{-Wno-overlength-strings}.
3943 @end table
3945 @node Debugging Options
3946 @section Options for Debugging Your Program or GCC
3947 @cindex options, debugging
3948 @cindex debugging information options
3950 GCC has various special options that are used for debugging
3951 either your program or GCC:
3953 @table @gcctabopt
3954 @item -g
3955 @opindex g
3956 Produce debugging information in the operating system's native format
3957 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3958 information.
3960 On most systems that use stabs format, @option{-g} enables use of extra
3961 debugging information that only GDB can use; this extra information
3962 makes debugging work better in GDB but will probably make other debuggers
3963 crash or
3964 refuse to read the program.  If you want to control for certain whether
3965 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3966 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3968 GCC allows you to use @option{-g} with
3969 @option{-O}.  The shortcuts taken by optimized code may occasionally
3970 produce surprising results: some variables you declared may not exist
3971 at all; flow of control may briefly move where you did not expect it;
3972 some statements may not be executed because they compute constant
3973 results or their values were already at hand; some statements may
3974 execute in different places because they were moved out of loops.
3976 Nevertheless it proves possible to debug optimized output.  This makes
3977 it reasonable to use the optimizer for programs that might have bugs.
3979 The following options are useful when GCC is generated with the
3980 capability for more than one debugging format.
3982 @item -ggdb
3983 @opindex ggdb
3984 Produce debugging information for use by GDB@.  This means to use the
3985 most expressive format available (DWARF 2, stabs, or the native format
3986 if neither of those are supported), including GDB extensions if at all
3987 possible.
3989 @item -gstabs
3990 @opindex gstabs
3991 Produce debugging information in stabs format (if that is supported),
3992 without GDB extensions.  This is the format used by DBX on most BSD
3993 systems.  On MIPS, Alpha and System V Release 4 systems this option
3994 produces stabs debugging output which is not understood by DBX or SDB@.
3995 On System V Release 4 systems this option requires the GNU assembler.
3997 @item -feliminate-unused-debug-symbols
3998 @opindex feliminate-unused-debug-symbols
3999 Produce debugging information in stabs format (if that is supported),
4000 for only symbols that are actually used.
4002 @item -femit-class-debug-always
4003 Instead of emitting debugging information for a C++ class in only one
4004 object file, emit it in all object files using the class.  This option
4005 should be used only with debuggers that are unable to handle the way GCC
4006 normally emits debugging information for classes because using this
4007 option will increase the size of debugging information by as much as a
4008 factor of two.
4010 @item -gstabs+
4011 @opindex gstabs+
4012 Produce debugging information in stabs format (if that is supported),
4013 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4014 use of these extensions is likely to make other debuggers crash or
4015 refuse to read the program.
4017 @item -gcoff
4018 @opindex gcoff
4019 Produce debugging information in COFF format (if that is supported).
4020 This is the format used by SDB on most System V systems prior to
4021 System V Release 4.
4023 @item -gxcoff
4024 @opindex gxcoff
4025 Produce debugging information in XCOFF format (if that is supported).
4026 This is the format used by the DBX debugger on IBM RS/6000 systems.
4028 @item -gxcoff+
4029 @opindex gxcoff+
4030 Produce debugging information in XCOFF format (if that is supported),
4031 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4032 use of these extensions is likely to make other debuggers crash or
4033 refuse to read the program, and may cause assemblers other than the GNU
4034 assembler (GAS) to fail with an error.
4036 @item -gdwarf-2
4037 @opindex gdwarf-2
4038 Produce debugging information in DWARF version 2 format (if that is
4039 supported).  This is the format used by DBX on IRIX 6.  With this
4040 option, GCC uses features of DWARF version 3 when they are useful;
4041 version 3 is upward compatible with version 2, but may still cause
4042 problems for older debuggers.
4044 @item -gvms
4045 @opindex gvms
4046 Produce debugging information in VMS debug format (if that is
4047 supported).  This is the format used by DEBUG on VMS systems.
4049 @item -g@var{level}
4050 @itemx -ggdb@var{level}
4051 @itemx -gstabs@var{level}
4052 @itemx -gcoff@var{level}
4053 @itemx -gxcoff@var{level}
4054 @itemx -gvms@var{level}
4055 Request debugging information and also use @var{level} to specify how
4056 much information.  The default level is 2.
4058 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4059 @option{-g}.
4061 Level 1 produces minimal information, enough for making backtraces in
4062 parts of the program that you don't plan to debug.  This includes
4063 descriptions of functions and external variables, but no information
4064 about local variables and no line numbers.
4066 Level 3 includes extra information, such as all the macro definitions
4067 present in the program.  Some debuggers support macro expansion when
4068 you use @option{-g3}.
4070 @option{-gdwarf-2} does not accept a concatenated debug level, because
4071 GCC used to support an option @option{-gdwarf} that meant to generate
4072 debug information in version 1 of the DWARF format (which is very
4073 different from version 2), and it would have been too confusing.  That
4074 debug format is long obsolete, but the option cannot be changed now.
4075 Instead use an additional @option{-g@var{level}} option to change the
4076 debug level for DWARF2.
4078 @item -feliminate-dwarf2-dups
4079 @opindex feliminate-dwarf2-dups
4080 Compress DWARF2 debugging information by eliminating duplicated
4081 information about each symbol.  This option only makes sense when
4082 generating DWARF2 debugging information with @option{-gdwarf-2}.
4084 @item -femit-struct-debug-baseonly
4085 Emit debug information for struct-like types
4086 only when the base name of the compilation source file
4087 matches the base name of file in which the struct was defined.
4089 This option substantially reduces the size of debugging information,
4090 but at significant potential loss in type information to the debugger.
4091 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4092 See @option{-femit-struct-debug-detailed} for more detailed control.
4094 This option works only with DWARF 2.
4096 @item -femit-struct-debug-reduced
4097 Emit debug information for struct-like types
4098 only when the base name of the compilation source file
4099 matches the base name of file in which the type was defined,
4100 unless the struct is a template or defined in a system header.
4102 This option significantly reduces the size of debugging information,
4103 with some potential loss in type information to the debugger.
4104 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4105 See @option{-femit-struct-debug-detailed} for more detailed control.
4107 This option works only with DWARF 2.
4109 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4110 Specify the struct-like types
4111 for which the compiler will generate debug information.
4112 The intent is to reduce duplicate struct debug information
4113 between different object files within the same program.
4115 This option is a detailed version of
4116 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4117 which will serve for most needs.
4119 A specification has the syntax
4120 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4122 The optional first word limits the specification to
4123 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4124 A struct type is used directly when it is the type of a variable, member.
4125 Indirect uses arise through pointers to structs.
4126 That is, when use of an incomplete struct would be legal, the use is indirect.
4127 An example is
4128 @samp{struct one direct; struct two * indirect;}.
4130 The optional second word limits the specification to
4131 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4132 Generic structs are a bit complicated to explain.
4133 For C++, these are non-explicit specializations of template classes,
4134 or non-template classes within the above.
4135 Other programming languages have generics,
4136 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4138 The third word specifies the source files for those
4139 structs for which the compiler will emit debug information.
4140 The values @samp{none} and @samp{any} have the normal meaning.
4141 The value @samp{base} means that
4142 the base of name of the file in which the type declaration appears
4143 must match the base of the name of the main compilation file.
4144 In practice, this means that
4145 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4146 but types declared in other header will not.
4147 The value @samp{sys} means those types satisfying @samp{base}
4148 or declared in system or compiler headers.
4150 You may need to experiment to determine the best settings for your application.
4152 The default is @samp{-femit-struct-debug-detailed=all}.
4154 This option works only with DWARF 2.
4156 @item -fdebug-prefix-map=@var{old}=@var{new}
4157 @opindex fdebug-prefix-map
4158 When compiling files in directory @file{@var{old}}, record debugging
4159 information describing them as in @file{@var{new}} instead.
4161 @cindex @command{prof}
4162 @item -p
4163 @opindex p
4164 Generate extra code to write profile information suitable for the
4165 analysis program @command{prof}.  You must use this option when compiling
4166 the source files you want data about, and you must also use it when
4167 linking.
4169 @cindex @command{gprof}
4170 @item -pg
4171 @opindex pg
4172 Generate extra code to write profile information suitable for the
4173 analysis program @command{gprof}.  You must use this option when compiling
4174 the source files you want data about, and you must also use it when
4175 linking.
4177 @item -Q
4178 @opindex Q
4179 Makes the compiler print out each function name as it is compiled, and
4180 print some statistics about each pass when it finishes.
4182 @item -ftime-report
4183 @opindex ftime-report
4184 Makes the compiler print some statistics about the time consumed by each
4185 pass when it finishes.
4187 @item -fmem-report
4188 @opindex fmem-report
4189 Makes the compiler print some statistics about permanent memory
4190 allocation when it finishes.
4192 @item -fpre-ipa-mem-report
4193 @opindex fpre-ipa-mem-report
4194 @item -fpost-ipa-mem-report
4195 @opindex fpost-ipa-mem-report
4196 Makes the compiler print some statistics about permanent memory
4197 allocation before or after interprocedural optimization.
4199 @item -fprofile-arcs
4200 @opindex fprofile-arcs
4201 Add code so that program flow @dfn{arcs} are instrumented.  During
4202 execution the program records how many times each branch and call is
4203 executed and how many times it is taken or returns.  When the compiled
4204 program exits it saves this data to a file called
4205 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4206 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4207 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4208 @var{auxname} is generated from the name of the output file, if
4209 explicitly specified and it is not the final executable, otherwise it is
4210 the basename of the source file.  In both cases any suffix is removed
4211 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4212 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4213 @xref{Cross-profiling}.
4215 @cindex @command{gcov}
4216 @item --coverage
4217 @opindex coverage
4219 This option is used to compile and link code instrumented for coverage
4220 analysis.  The option is a synonym for @option{-fprofile-arcs}
4221 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4222 linking).  See the documentation for those options for more details.
4224 @itemize
4226 @item
4227 Compile the source files with @option{-fprofile-arcs} plus optimization
4228 and code generation options.  For test coverage analysis, use the
4229 additional @option{-ftest-coverage} option.  You do not need to profile
4230 every source file in a program.
4232 @item
4233 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4234 (the latter implies the former).
4236 @item
4237 Run the program on a representative workload to generate the arc profile
4238 information.  This may be repeated any number of times.  You can run
4239 concurrent instances of your program, and provided that the file system
4240 supports locking, the data files will be correctly updated.  Also
4241 @code{fork} calls are detected and correctly handled (double counting
4242 will not happen).
4244 @item
4245 For profile-directed optimizations, compile the source files again with
4246 the same optimization and code generation options plus
4247 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4248 Control Optimization}).
4250 @item
4251 For test coverage analysis, use @command{gcov} to produce human readable
4252 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4253 @command{gcov} documentation for further information.
4255 @end itemize
4257 With @option{-fprofile-arcs}, for each function of your program GCC
4258 creates a program flow graph, then finds a spanning tree for the graph.
4259 Only arcs that are not on the spanning tree have to be instrumented: the
4260 compiler adds code to count the number of times that these arcs are
4261 executed.  When an arc is the only exit or only entrance to a block, the
4262 instrumentation code can be added to the block; otherwise, a new basic
4263 block must be created to hold the instrumentation code.
4265 @need 2000
4266 @item -ftest-coverage
4267 @opindex ftest-coverage
4268 Produce a notes file that the @command{gcov} code-coverage utility
4269 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4270 show program coverage.  Each source file's note file is called
4271 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4272 above for a description of @var{auxname} and instructions on how to
4273 generate test coverage data.  Coverage data will match the source files
4274 more closely, if you do not optimize.
4276 @item -fdbg-cnt-list
4277 @opindex fdbg-cnt-list
4278 Print the name and the counter upperbound for all debug counters.
4280 @item -fdbg-cnt=@var{counter-value-list}
4281 @opindex fdbg-cnt
4282 Set the internal debug counter upperbound. @var{counter-value-list} 
4283 is a comma-separated list of @var{name}:@var{value} pairs
4284 which sets the upperbound of each debug counter @var{name} to @var{value}.
4285 All debug counters have the initial upperbound of @var{UINT_MAX},
4286 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4287 e.g. With -fdbg-cnt=dce:10,tail_call:0
4288 dbg_cnt(dce) will return true only for first 10 invocations
4289 and dbg_cnt(tail_call) will return false always.
4291 @item -d@var{letters}
4292 @item -fdump-rtl-@var{pass}
4293 @opindex d
4294 Says to make debugging dumps during compilation at times specified by
4295 @var{letters}.    This is used for debugging the RTL-based passes of the
4296 compiler.  The file names for most of the dumps are made by appending a
4297 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
4298 from the name of the output file, if explicitly specified and it is not
4299 an executable, otherwise it is the basename of the source file. These
4300 switches may have different effects when @option{-E} is used for
4301 preprocessing.
4303 Most debug dumps can be enabled either passing a letter to the @option{-d}
4304 option, or with a long @option{-fdump-rtl} switch; here are the possible
4305 letters for use in @var{letters} and @var{pass}, and their meanings:
4307 @table @gcctabopt
4308 @item -dA
4309 @opindex dA
4310 Annotate the assembler output with miscellaneous debugging information.
4312 @item -dB
4313 @itemx -fdump-rtl-bbro
4314 @opindex dB
4315 @opindex fdump-rtl-bbro
4316 Dump after block reordering, to @file{@var{file}.148r.bbro}.
4318 @item -dc
4319 @itemx -fdump-rtl-combine
4320 @opindex dc
4321 @opindex fdump-rtl-combine
4322 Dump after the RTL instruction combination pass, to the file
4323 @file{@var{file}.129r.combine}.
4325 @item -dC
4326 @itemx -fdump-rtl-ce1
4327 @itemx -fdump-rtl-ce2
4328 @opindex dC
4329 @opindex fdump-rtl-ce1
4330 @opindex fdump-rtl-ce2
4331 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
4332 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
4333 and @option{-fdump-rtl-ce2} enable dumping after the second if
4334 conversion, to the file @file{@var{file}.130r.ce2}.
4336 @item -dd
4337 @itemx -fdump-rtl-btl
4338 @itemx -fdump-rtl-dbr
4339 @opindex dd
4340 @opindex fdump-rtl-btl
4341 @opindex fdump-rtl-dbr
4342 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
4343 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
4344 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
4345 scheduling, to @file{@var{file}.36.dbr}.
4347 @item -dD
4348 @opindex dD
4349 Dump all macro definitions, at the end of preprocessing, in addition to
4350 normal output.
4352 @item -dE
4353 @itemx -fdump-rtl-ce3
4354 @opindex dE
4355 @opindex fdump-rtl-ce3
4356 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
4358 @item -df
4359 @itemx -fdump-rtl-cfg
4360 @itemx -fdump-rtl-life
4361 @opindex df
4362 @opindex fdump-rtl-cfg
4363 @opindex fdump-rtl-life
4364 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
4365 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
4366 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
4367 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
4369 @item -dg
4370 @itemx -fdump-rtl-greg
4371 @opindex dg
4372 @opindex fdump-rtl-greg
4373 Dump after global register allocation, to @file{@var{file}.139r.greg}.
4375 @item -dG
4376 @itemx -fdump-rtl-gcse
4377 @itemx -fdump-rtl-bypass
4378 @opindex dG
4379 @opindex fdump-rtl-gcse
4380 @opindex fdump-rtl-bypass
4381 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
4382 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
4383 enable dumping after jump bypassing and control flow optimizations, to
4384 @file{@var{file}.115r.bypass}.
4386 @item -dh
4387 @itemx -fdump-rtl-eh
4388 @opindex dh
4389 @opindex fdump-rtl-eh
4390 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
4392 @item -di
4393 @itemx -fdump-rtl-sibling
4394 @opindex di
4395 @opindex fdump-rtl-sibling
4396 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
4398 @item -dj
4399 @itemx -fdump-rtl-jump
4400 @opindex dj
4401 @opindex fdump-rtl-jump
4402 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
4404 @item -dk
4405 @itemx -fdump-rtl-stack
4406 @opindex dk
4407 @opindex fdump-rtl-stack
4408 Dump after conversion from GCC's "flat register file" registers to the
4409 x87's stack-like registers, to @file{@var{file}.152r.stack}.
4411 @item -dl
4412 @itemx -fdump-rtl-lreg
4413 @opindex dl
4414 @opindex fdump-rtl-lreg
4415 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
4417 @item -dL
4418 @itemx -fdump-rtl-loop2
4419 @opindex dL
4420 @opindex fdump-rtl-loop2
4421 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
4422 loop optimization pass, to @file{@var{file}.119r.loop2},
4423 @file{@var{file}.120r.loop2_init},
4424 @file{@var{file}.121r.loop2_invariant}, and
4425 @file{@var{file}.125r.loop2_done}.
4427 @item -dm
4428 @itemx -fdump-rtl-sms
4429 @opindex dm
4430 @opindex fdump-rtl-sms
4431 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4433 @item -dM
4434 @itemx -fdump-rtl-mach
4435 @opindex dM
4436 @opindex fdump-rtl-mach
4437 Dump after performing the machine dependent reorganization pass, to
4438 @file{@var{file}.155r.mach} if that pass exists.
4440 @item -dn
4441 @itemx -fdump-rtl-rnreg
4442 @opindex dn
4443 @opindex fdump-rtl-rnreg
4444 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4446 @item -dN
4447 @itemx -fdump-rtl-regmove
4448 @opindex dN
4449 @opindex fdump-rtl-regmove
4450 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4452 @item -do
4453 @itemx -fdump-rtl-postreload
4454 @opindex do
4455 @opindex fdump-rtl-postreload
4456 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4458 @item -dr
4459 @itemx -fdump-rtl-expand
4460 @opindex dr
4461 @opindex fdump-rtl-expand
4462 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4464 @item -dR
4465 @itemx -fdump-rtl-sched2
4466 @opindex dR
4467 @opindex fdump-rtl-sched2
4468 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4470 @item -ds
4471 @itemx -fdump-rtl-cse
4472 @opindex ds
4473 @opindex fdump-rtl-cse
4474 Dump after CSE (including the jump optimization that sometimes follows
4475 CSE), to @file{@var{file}.113r.cse}.
4477 @item -dS
4478 @itemx -fdump-rtl-sched1
4479 @opindex dS
4480 @opindex fdump-rtl-sched1
4481 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4483 @item -dt
4484 @itemx -fdump-rtl-cse2
4485 @opindex dt
4486 @opindex fdump-rtl-cse2
4487 Dump after the second CSE pass (including the jump optimization that
4488 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4490 @item -dT
4491 @itemx -fdump-rtl-tracer
4492 @opindex dT
4493 @opindex fdump-rtl-tracer
4494 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4496 @item -dV
4497 @itemx -fdump-rtl-vpt
4498 @itemx -fdump-rtl-vartrack
4499 @opindex dV
4500 @opindex fdump-rtl-vpt
4501 @opindex fdump-rtl-vartrack
4502 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4503 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4504 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4505 to @file{@var{file}.154r.vartrack}.
4507 @item -dw
4508 @itemx -fdump-rtl-flow2
4509 @opindex dw
4510 @opindex fdump-rtl-flow2
4511 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4513 @item -dz
4514 @itemx -fdump-rtl-peephole2
4515 @opindex dz
4516 @opindex fdump-rtl-peephole2
4517 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4519 @item -dZ
4520 @itemx -fdump-rtl-web
4521 @opindex dZ
4522 @opindex fdump-rtl-web
4523 Dump after live range splitting, to @file{@var{file}.126r.web}.
4525 @item -da
4526 @itemx -fdump-rtl-all
4527 @opindex da
4528 @opindex fdump-rtl-all
4529 Produce all the dumps listed above.
4531 @item -dH
4532 @opindex dH
4533 Produce a core dump whenever an error occurs.
4535 @item -dm
4536 @opindex dm
4537 Print statistics on memory usage, at the end of the run, to
4538 standard error.
4540 @item -dp
4541 @opindex dp
4542 Annotate the assembler output with a comment indicating which
4543 pattern and alternative was used.  The length of each instruction is
4544 also printed.
4546 @item -dP
4547 @opindex dP
4548 Dump the RTL in the assembler output as a comment before each instruction.
4549 Also turns on @option{-dp} annotation.
4551 @item -dv
4552 @opindex dv
4553 For each of the other indicated dump files (either with @option{-d} or
4554 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4555 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4557 @item -dx
4558 @opindex dx
4559 Just generate RTL for a function instead of compiling it.  Usually used
4560 with @samp{r} (@option{-fdump-rtl-expand}).
4562 @item -dy
4563 @opindex dy
4564 Dump debugging information during parsing, to standard error.
4565 @end table
4567 @item -fdump-noaddr
4568 @opindex fdump-noaddr
4569 When doing debugging dumps (see @option{-d} option above), suppress
4570 address output.  This makes it more feasible to use diff on debugging
4571 dumps for compiler invocations with different compiler binaries and/or
4572 different text / bss / data / heap / stack / dso start locations.
4574 @item -fdump-unnumbered
4575 @opindex fdump-unnumbered
4576 When doing debugging dumps (see @option{-d} option above), suppress instruction
4577 numbers and address output.  This makes it more feasible to
4578 use diff on debugging dumps for compiler invocations with different
4579 options, in particular with and without @option{-g}.
4581 @item -fdump-simple-rtl
4582 @opindex fdump-simple-rtl
4583 When doing debugging dumps (see @option{-d} option above), suppress
4584 output of flags, modes, etc.  This makes rtl dumps more compact.
4586 @item -fdump-translation-unit @r{(C++ only)}
4587 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4588 @opindex fdump-translation-unit
4589 Dump a representation of the tree structure for the entire translation
4590 unit to a file.  The file name is made by appending @file{.tu} to the
4591 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4592 controls the details of the dump as described for the
4593 @option{-fdump-tree} options.
4595 @item -fdump-class-hierarchy @r{(C++ only)}
4596 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4597 @opindex fdump-class-hierarchy
4598 Dump a representation of each class's hierarchy and virtual function
4599 table layout to a file.  The file name is made by appending @file{.class}
4600 to the source file name.  If the @samp{-@var{options}} form is used,
4601 @var{options} controls the details of the dump as described for the
4602 @option{-fdump-tree} options.
4604 @item -fdump-ipa-@var{switch}
4605 @opindex fdump-ipa
4606 Control the dumping at various stages of inter-procedural analysis
4607 language tree to a file.  The file name is generated by appending a switch
4608 specific suffix to the source file name.  The following dumps are possible:
4610 @table @samp
4611 @item all
4612 Enables all inter-procedural analysis dumps; currently the only produced
4613 dump is the @samp{cgraph} dump.
4615 @item cgraph
4616 Dumps information about call-graph optimization, unused function removal,
4617 and inlining decisions.
4618 @end table
4620 @item -fdump-tree-@var{switch}
4621 @itemx -fdump-tree-@var{switch}-@var{options}
4622 @opindex fdump-tree
4623 Control the dumping at various stages of processing the intermediate
4624 language tree to a file.  The file name is generated by appending a switch
4625 specific suffix to the source file name.  If the @samp{-@var{options}}
4626 form is used, @var{options} is a list of @samp{-} separated options that
4627 control the details of the dump.  Not all options are applicable to all
4628 dumps, those which are not meaningful will be ignored.  The following
4629 options are available
4631 @table @samp
4632 @item address
4633 Print the address of each node.  Usually this is not meaningful as it
4634 changes according to the environment and source file.  Its primary use
4635 is for tying up a dump file with a debug environment.
4636 @item slim
4637 Inhibit dumping of members of a scope or body of a function merely
4638 because that scope has been reached.  Only dump such items when they
4639 are directly reachable by some other path.  When dumping pretty-printed
4640 trees, this option inhibits dumping the bodies of control structures.
4641 @item raw
4642 Print a raw representation of the tree.  By default, trees are
4643 pretty-printed into a C-like representation.
4644 @item details
4645 Enable more detailed dumps (not honored by every dump option).
4646 @item stats
4647 Enable dumping various statistics about the pass (not honored by every dump
4648 option).
4649 @item blocks
4650 Enable showing basic block boundaries (disabled in raw dumps).
4651 @item vops
4652 Enable showing virtual operands for every statement.
4653 @item lineno
4654 Enable showing line numbers for statements.
4655 @item uid
4656 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4657 @item all
4658 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4659 @end table
4661 The following tree dumps are possible:
4662 @table @samp
4664 @item original
4665 Dump before any tree based optimization, to @file{@var{file}.original}.
4667 @item optimized
4668 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4670 @item inlined
4671 Dump after function inlining, to @file{@var{file}.inlined}.
4673 @item gimple
4674 @opindex fdump-tree-gimple
4675 Dump each function before and after the gimplification pass to a file.  The
4676 file name is made by appending @file{.gimple} to the source file name.
4678 @item cfg
4679 @opindex fdump-tree-cfg
4680 Dump the control flow graph of each function to a file.  The file name is
4681 made by appending @file{.cfg} to the source file name.
4683 @item vcg
4684 @opindex fdump-tree-vcg
4685 Dump the control flow graph of each function to a file in VCG format.  The
4686 file name is made by appending @file{.vcg} to the source file name.  Note
4687 that if the file contains more than one function, the generated file cannot
4688 be used directly by VCG@.  You will need to cut and paste each function's
4689 graph into its own separate file first.
4691 @item ch
4692 @opindex fdump-tree-ch
4693 Dump each function after copying loop headers.  The file name is made by
4694 appending @file{.ch} to the source file name.
4696 @item ssa
4697 @opindex fdump-tree-ssa
4698 Dump SSA related information to a file.  The file name is made by appending
4699 @file{.ssa} to the source file name.
4701 @item salias
4702 @opindex fdump-tree-salias
4703 Dump structure aliasing variable information to a file.  This file name
4704 is made by appending @file{.salias} to the source file name.
4706 @item alias
4707 @opindex fdump-tree-alias
4708 Dump aliasing information for each function.  The file name is made by
4709 appending @file{.alias} to the source file name.
4711 @item ccp
4712 @opindex fdump-tree-ccp
4713 Dump each function after CCP@.  The file name is made by appending
4714 @file{.ccp} to the source file name.
4716 @item storeccp
4717 @opindex fdump-tree-storeccp
4718 Dump each function after STORE-CCP.  The file name is made by appending
4719 @file{.storeccp} to the source file name.
4721 @item pre
4722 @opindex fdump-tree-pre
4723 Dump trees after partial redundancy elimination.  The file name is made
4724 by appending @file{.pre} to the source file name.
4726 @item fre
4727 @opindex fdump-tree-fre
4728 Dump trees after full redundancy elimination.  The file name is made
4729 by appending @file{.fre} to the source file name.
4731 @item copyprop
4732 @opindex fdump-tree-copyprop
4733 Dump trees after copy propagation.  The file name is made
4734 by appending @file{.copyprop} to the source file name.
4736 @item store_copyprop
4737 @opindex fdump-tree-store_copyprop
4738 Dump trees after store copy-propagation.  The file name is made
4739 by appending @file{.store_copyprop} to the source file name.
4741 @item dce
4742 @opindex fdump-tree-dce
4743 Dump each function after dead code elimination.  The file name is made by
4744 appending @file{.dce} to the source file name.
4746 @item mudflap
4747 @opindex fdump-tree-mudflap
4748 Dump each function after adding mudflap instrumentation.  The file name is
4749 made by appending @file{.mudflap} to the source file name.
4751 @item sra
4752 @opindex fdump-tree-sra
4753 Dump each function after performing scalar replacement of aggregates.  The
4754 file name is made by appending @file{.sra} to the source file name.
4756 @item sink
4757 @opindex fdump-tree-sink
4758 Dump each function after performing code sinking.  The file name is made
4759 by appending @file{.sink} to the source file name.
4761 @item dom
4762 @opindex fdump-tree-dom
4763 Dump each function after applying dominator tree optimizations.  The file
4764 name is made by appending @file{.dom} to the source file name.
4766 @item dse
4767 @opindex fdump-tree-dse
4768 Dump each function after applying dead store elimination.  The file
4769 name is made by appending @file{.dse} to the source file name.
4771 @item phiopt
4772 @opindex fdump-tree-phiopt
4773 Dump each function after optimizing PHI nodes into straightline code.  The file
4774 name is made by appending @file{.phiopt} to the source file name.
4776 @item forwprop
4777 @opindex fdump-tree-forwprop
4778 Dump each function after forward propagating single use variables.  The file
4779 name is made by appending @file{.forwprop} to the source file name.
4781 @item copyrename
4782 @opindex fdump-tree-copyrename
4783 Dump each function after applying the copy rename optimization.  The file
4784 name is made by appending @file{.copyrename} to the source file name.
4786 @item nrv
4787 @opindex fdump-tree-nrv
4788 Dump each function after applying the named return value optimization on
4789 generic trees.  The file name is made by appending @file{.nrv} to the source
4790 file name.
4792 @item vect
4793 @opindex fdump-tree-vect
4794 Dump each function after applying vectorization of loops.  The file name is
4795 made by appending @file{.vect} to the source file name.
4797 @item vrp
4798 @opindex fdump-tree-vrp
4799 Dump each function after Value Range Propagation (VRP).  The file name
4800 is made by appending @file{.vrp} to the source file name.
4802 @item all
4803 @opindex fdump-tree-all
4804 Enable all the available tree dumps with the flags provided in this option.
4805 @end table
4807 @item -ftree-vectorizer-verbose=@var{n}
4808 @opindex ftree-vectorizer-verbose
4809 This option controls the amount of debugging output the vectorizer prints.
4810 This information is written to standard error, unless
4811 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4812 in which case it is output to the usual dump listing file, @file{.vect}.
4813 For @var{n}=0 no diagnostic information is reported.
4814 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4815 and the total number of loops that got vectorized.
4816 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4817 the first analysis phase (vect_analyze_loop_form) - i.e. countable,
4818 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
4819 level that @option{-fdump-tree-vect-stats} uses.
4820 Higher verbosity levels mean either more information dumped for each
4821 reported loop, or same amount of information reported for more loops:
4822 If @var{n}=3, alignment related information is added to the reports.
4823 If @var{n}=4, data-references related information (e.g. memory dependences,
4824 memory access-patterns) is added to the reports.
4825 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4826 that did not pass the first analysis phase (i.e. may not be countable, or
4827 may have complicated control-flow).
4828 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4829 For @var{n}=7, all the information the vectorizer generates during its
4830 analysis and transformation is reported.  This is the same verbosity level
4831 that @option{-fdump-tree-vect-details} uses.
4833 @item -frandom-seed=@var{string}
4834 @opindex frandom-string
4835 This option provides a seed that GCC uses when it would otherwise use
4836 random numbers.  It is used to generate certain symbol names
4837 that have to be different in every compiled file.  It is also used to
4838 place unique stamps in coverage data files and the object files that
4839 produce them.  You can use the @option{-frandom-seed} option to produce
4840 reproducibly identical object files.
4842 The @var{string} should be different for every file you compile.
4844 @item -fsched-verbose=@var{n}
4845 @opindex fsched-verbose
4846 On targets that use instruction scheduling, this option controls the
4847 amount of debugging output the scheduler prints.  This information is
4848 written to standard error, unless @option{-dS} or @option{-dR} is
4849 specified, in which case it is output to the usual dump
4850 listing file, @file{.sched} or @file{.sched2} respectively.  However
4851 for @var{n} greater than nine, the output is always printed to standard
4852 error.
4854 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4855 same information as @option{-dRS}.  For @var{n} greater than one, it
4856 also output basic block probabilities, detailed ready list information
4857 and unit/insn info.  For @var{n} greater than two, it includes RTL
4858 at abort point, control-flow and regions info.  And for @var{n} over
4859 four, @option{-fsched-verbose} also includes dependence info.
4861 @item -save-temps
4862 @opindex save-temps
4863 Store the usual ``temporary'' intermediate files permanently; place them
4864 in the current directory and name them based on the source file.  Thus,
4865 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4866 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4867 preprocessed @file{foo.i} output file even though the compiler now
4868 normally uses an integrated preprocessor.
4870 When used in combination with the @option{-x} command line option,
4871 @option{-save-temps} is sensible enough to avoid over writing an
4872 input source file with the same extension as an intermediate file.
4873 The corresponding intermediate file may be obtained by renaming the
4874 source file before using @option{-save-temps}.
4876 @item -time
4877 @opindex time
4878 Report the CPU time taken by each subprocess in the compilation
4879 sequence.  For C source files, this is the compiler proper and assembler
4880 (plus the linker if linking is done).  The output looks like this:
4882 @smallexample
4883 # cc1 0.12 0.01
4884 # as 0.00 0.01
4885 @end smallexample
4887 The first number on each line is the ``user time'', that is time spent
4888 executing the program itself.  The second number is ``system time'',
4889 time spent executing operating system routines on behalf of the program.
4890 Both numbers are in seconds.
4892 @item -fvar-tracking
4893 @opindex fvar-tracking
4894 Run variable tracking pass.  It computes where variables are stored at each
4895 position in code.  Better debugging information is then generated
4896 (if the debugging information format supports this information).
4898 It is enabled by default when compiling with optimization (@option{-Os},
4899 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4900 the debug info format supports it.
4902 @item -print-file-name=@var{library}
4903 @opindex print-file-name
4904 Print the full absolute name of the library file @var{library} that
4905 would be used when linking---and don't do anything else.  With this
4906 option, GCC does not compile or link anything; it just prints the
4907 file name.
4909 @item -print-multi-directory
4910 @opindex print-multi-directory
4911 Print the directory name corresponding to the multilib selected by any
4912 other switches present in the command line.  This directory is supposed
4913 to exist in @env{GCC_EXEC_PREFIX}.
4915 @item -print-multi-lib
4916 @opindex print-multi-lib
4917 Print the mapping from multilib directory names to compiler switches
4918 that enable them.  The directory name is separated from the switches by
4919 @samp{;}, and each switch starts with an @samp{@@} instead of the
4920 @samp{-}, without spaces between multiple switches.  This is supposed to
4921 ease shell-processing.
4923 @item -print-prog-name=@var{program}
4924 @opindex print-prog-name
4925 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4927 @item -print-libgcc-file-name
4928 @opindex print-libgcc-file-name
4929 Same as @option{-print-file-name=libgcc.a}.
4931 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4932 but you do want to link with @file{libgcc.a}.  You can do
4934 @smallexample
4935 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4936 @end smallexample
4938 @item -print-search-dirs
4939 @opindex print-search-dirs
4940 Print the name of the configured installation directory and a list of
4941 program and library directories @command{gcc} will search---and don't do anything else.
4943 This is useful when @command{gcc} prints the error message
4944 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4945 To resolve this you either need to put @file{cpp0} and the other compiler
4946 components where @command{gcc} expects to find them, or you can set the environment
4947 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4948 Don't forget the trailing @samp{/}.
4949 @xref{Environment Variables}.
4951 @item -print-sysroot-headers-suffix
4952 @opindex print-sysroot-headers-suffix
4953 Print the suffix added to the target sysroot when searching for
4954 headers, or give an error if the compiler is not configured with such
4955 a suffix---and don't do anything else.
4957 @item -dumpmachine
4958 @opindex dumpmachine
4959 Print the compiler's target machine (for example,
4960 @samp{i686-pc-linux-gnu})---and don't do anything else.
4962 @item -dumpversion
4963 @opindex dumpversion
4964 Print the compiler version (for example, @samp{3.0})---and don't do
4965 anything else.
4967 @item -dumpspecs
4968 @opindex dumpspecs
4969 Print the compiler's built-in specs---and don't do anything else.  (This
4970 is used when GCC itself is being built.)  @xref{Spec Files}.
4972 @item -feliminate-unused-debug-types
4973 @opindex feliminate-unused-debug-types
4974 Normally, when producing DWARF2 output, GCC will emit debugging
4975 information for all types declared in a compilation
4976 unit, regardless of whether or not they are actually used
4977 in that compilation unit.  Sometimes this is useful, such as
4978 if, in the debugger, you want to cast a value to a type that is
4979 not actually used in your program (but is declared).  More often,
4980 however, this results in a significant amount of wasted space.
4981 With this option, GCC will avoid producing debug symbol output
4982 for types that are nowhere used in the source file being compiled.
4983 @end table
4985 @node Optimize Options
4986 @section Options That Control Optimization
4987 @cindex optimize options
4988 @cindex options, optimization
4990 These options control various sorts of optimizations.
4992 Without any optimization option, the compiler's goal is to reduce the
4993 cost of compilation and to make debugging produce the expected
4994 results.  Statements are independent: if you stop the program with a
4995 breakpoint between statements, you can then assign a new value to any
4996 variable or change the program counter to any other statement in the
4997 function and get exactly the results you would expect from the source
4998 code.
5000 Turning on optimization flags makes the compiler attempt to improve
5001 the performance and/or code size at the expense of compilation time
5002 and possibly the ability to debug the program.
5004 The compiler performs optimization based on the knowledge it has of
5005 the program.  Optimization levels @option{-O} and above, in
5006 particular, enable @emph{unit-at-a-time} mode, which allows the
5007 compiler to consider information gained from later functions in
5008 the file when compiling a function.  Compiling multiple files at
5009 once to a single output file in @emph{unit-at-a-time} mode allows
5010 the compiler to use information gained from all of the files when
5011 compiling each of them.
5013 Not all optimizations are controlled directly by a flag.  Only
5014 optimizations that have a flag are listed.
5016 @table @gcctabopt
5017 @item -O
5018 @itemx -O1
5019 @opindex O
5020 @opindex O1
5021 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5022 more memory for a large function.
5024 With @option{-O}, the compiler tries to reduce code size and execution
5025 time, without performing any optimizations that take a great deal of
5026 compilation time.
5028 @option{-O} turns on the following optimization flags:
5029 @gccoptlist{-fdefer-pop @gol
5030 -fdelayed-branch @gol
5031 -fguess-branch-probability @gol
5032 -fcprop-registers @gol
5033 -fif-conversion @gol
5034 -fif-conversion2 @gol
5035 -fsplit-wide-types @gol
5036 -ftree-ccp @gol
5037 -ftree-dce @gol
5038 -ftree-dominator-opts @gol
5039 -ftree-dse @gol
5040 -ftree-ter @gol
5041 -ftree-sra @gol
5042 -ftree-copyrename @gol
5043 -ftree-fre @gol
5044 -ftree-ch @gol
5045 -funit-at-a-time @gol
5046 -fmerge-constants}
5048 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5049 where doing so does not interfere with debugging.
5051 @item -O2
5052 @opindex O2
5053 Optimize even more.  GCC performs nearly all supported optimizations
5054 that do not involve a space-speed tradeoff.  The compiler does not
5055 perform loop unrolling or function inlining when you specify @option{-O2}.
5056 As compared to @option{-O}, this option increases both compilation time
5057 and the performance of the generated code.
5059 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5060 also turns on the following optimization flags:
5061 @gccoptlist{-fthread-jumps @gol
5062 -fcrossjumping @gol
5063 -foptimize-sibling-calls @gol
5064 -fcse-follow-jumps  -fcse-skip-blocks @gol
5065 -fgcse  -fgcse-lm  @gol
5066 -fexpensive-optimizations @gol
5067 -frerun-cse-after-loop  @gol
5068 -fcaller-saves @gol
5069 -fpeephole2 @gol
5070 -fschedule-insns  -fschedule-insns2 @gol
5071 -fsched-interblock  -fsched-spec @gol
5072 -fregmove @gol
5073 -fstrict-aliasing -fstrict-overflow @gol
5074 -fdelete-null-pointer-checks @gol
5075 -freorder-blocks  -freorder-functions @gol
5076 -falign-functions  -falign-jumps @gol
5077 -falign-loops  -falign-labels @gol
5078 -ftree-vrp @gol
5079 -ftree-pre}
5081 Please note the warning under @option{-fgcse} about
5082 invoking @option{-O2} on programs that use computed gotos.
5084 @item -O3
5085 @opindex O3
5086 Optimize yet more.  @option{-O3} turns on all optimizations specified by
5087 @option{-O2} and also turns on the @option{-finline-functions},
5088 @option{-funswitch-loops}, @option{-fpredictive-commoning} and
5089 @option{-fgcse-after-reload} options.
5091 @item -O0
5092 @opindex O0
5093 Reduce compilation time and make debugging produce the expected
5094 results.  This is the default.
5096 @item -Os
5097 @opindex Os
5098 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5099 do not typically increase code size.  It also performs further
5100 optimizations designed to reduce code size.
5102 @option{-Os} disables the following optimization flags:
5103 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5104 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5105 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5107 If you use multiple @option{-O} options, with or without level numbers,
5108 the last such option is the one that is effective.
5109 @end table
5111 Options of the form @option{-f@var{flag}} specify machine-independent
5112 flags.  Most flags have both positive and negative forms; the negative
5113 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5114 below, only one of the forms is listed---the one you typically will
5115 use.  You can figure out the other form by either removing @samp{no-}
5116 or adding it.
5118 The following options control specific optimizations.  They are either
5119 activated by @option{-O} options or are related to ones that are.  You
5120 can use the following flags in the rare cases when ``fine-tuning'' of
5121 optimizations to be performed is desired.
5123 @table @gcctabopt
5124 @item -fno-default-inline
5125 @opindex fno-default-inline
5126 Do not make member functions inline by default merely because they are
5127 defined inside the class scope (C++ only).  Otherwise, when you specify
5128 @w{@option{-O}}, member functions defined inside class scope are compiled
5129 inline by default; i.e., you don't need to add @samp{inline} in front of
5130 the member function name.
5132 @item -fno-defer-pop
5133 @opindex fno-defer-pop
5134 Always pop the arguments to each function call as soon as that function
5135 returns.  For machines which must pop arguments after a function call,
5136 the compiler normally lets arguments accumulate on the stack for several
5137 function calls and pops them all at once.
5139 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5141 @item -fforce-addr
5142 @opindex fforce-addr
5143 Force memory address constants to be copied into registers before
5144 doing arithmetic on them.
5146 @item -fforward-propagate
5147 @opindex fforward-propagate
5148 Perform a forward propagation pass on RTL.  The pass tries to combine two
5149 instructions and checks if the result can be simplified.  If loop unrolling
5150 is active, two passes are performed and the second is scheduled after
5151 loop unrolling.
5153 This option is enabled by default at optimization levels @option{-O2},
5154 @option{-O3}, @option{-Os}.
5156 @item -fomit-frame-pointer
5157 @opindex fomit-frame-pointer
5158 Don't keep the frame pointer in a register for functions that
5159 don't need one.  This avoids the instructions to save, set up and
5160 restore frame pointers; it also makes an extra register available
5161 in many functions.  @strong{It also makes debugging impossible on
5162 some machines.}
5164 On some machines, such as the VAX, this flag has no effect, because
5165 the standard calling sequence automatically handles the frame pointer
5166 and nothing is saved by pretending it doesn't exist.  The
5167 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5168 whether a target machine supports this flag.  @xref{Registers,,Register
5169 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5171 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5173 @item -foptimize-sibling-calls
5174 @opindex foptimize-sibling-calls
5175 Optimize sibling and tail recursive calls.
5177 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5179 @item -fno-inline
5180 @opindex fno-inline
5181 Don't pay attention to the @code{inline} keyword.  Normally this option
5182 is used to keep the compiler from expanding any functions inline.
5183 Note that if you are not optimizing, no functions can be expanded inline.
5185 @item -finline-functions
5186 @opindex finline-functions
5187 Integrate all simple functions into their callers.  The compiler
5188 heuristically decides which functions are simple enough to be worth
5189 integrating in this way.
5191 If all calls to a given function are integrated, and the function is
5192 declared @code{static}, then the function is normally not output as
5193 assembler code in its own right.
5195 Enabled at level @option{-O3}.
5197 @item -finline-functions-called-once
5198 @opindex finline-functions-called-once
5199 Consider all @code{static} functions called once for inlining into their
5200 caller even if they are not marked @code{inline}.  If a call to a given
5201 function is integrated, then the function is not output as assembler code
5202 in its own right.
5204 Enabled if @option{-funit-at-a-time} is enabled.
5206 @item -fearly-inlining
5207 @opindex fearly-inlining
5208 Inline functions marked by @code{always_inline} and functions whose body seems
5209 smaller than the function call overhead early before doing
5210 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5211 makes profiling significantly cheaper and usually inlining faster on programs
5212 having large chains of nested wrapper functions.
5214 Enabled by default.
5216 @item -finline-limit=@var{n}
5217 @opindex finline-limit
5218 By default, GCC limits the size of functions that can be inlined.  This flag
5219 allows the control of this limit for functions that are explicitly marked as
5220 inline (i.e., marked with the inline keyword or defined within the class
5221 definition in c++).  @var{n} is the size of functions that can be inlined in
5222 number of pseudo instructions (not counting parameter handling).  The default
5223 value of @var{n} is 600.
5224 Increasing this value can result in more inlined code at
5225 the cost of compilation time and memory consumption.  Decreasing usually makes
5226 the compilation faster and less code will be inlined (which presumably
5227 means slower programs).  This option is particularly useful for programs that
5228 use inlining heavily such as those based on recursive templates with C++.
5230 Inlining is actually controlled by a number of parameters, which may be
5231 specified individually by using @option{--param @var{name}=@var{value}}.
5232 The @option{-finline-limit=@var{n}} option sets some of these parameters
5233 as follows:
5235 @table @gcctabopt
5236 @item max-inline-insns-single
5237  is set to @var{n}/2.
5238 @item max-inline-insns-auto
5239  is set to @var{n}/2.
5240 @item min-inline-insns
5241  is set to 130 or @var{n}/4, whichever is smaller.
5242 @item max-inline-insns-rtl
5243  is set to @var{n}.
5244 @end table
5246 See below for a documentation of the individual
5247 parameters controlling inlining.
5249 @emph{Note:} pseudo instruction represents, in this particular context, an
5250 abstract measurement of function's size.  In no way does it represent a count
5251 of assembly instructions and as such its exact meaning might change from one
5252 release to an another.
5254 @item -fkeep-inline-functions
5255 @opindex fkeep-inline-functions
5256 In C, emit @code{static} functions that are declared @code{inline}
5257 into the object file, even if the function has been inlined into all
5258 of its callers.  This switch does not affect functions using the
5259 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5260 inline functions into the object file.
5262 @item -fkeep-static-consts
5263 @opindex fkeep-static-consts
5264 Emit variables declared @code{static const} when optimization isn't turned
5265 on, even if the variables aren't referenced.
5267 GCC enables this option by default.  If you want to force the compiler to
5268 check if the variable was referenced, regardless of whether or not
5269 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5271 @item -fmerge-constants
5272 Attempt to merge identical constants (string constants and floating point
5273 constants) across compilation units.
5275 This option is the default for optimized compilation if the assembler and
5276 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5277 behavior.
5279 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5281 @item -fmerge-all-constants
5282 Attempt to merge identical constants and identical variables.
5284 This option implies @option{-fmerge-constants}.  In addition to
5285 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5286 arrays or initialized constant variables with integral or floating point
5287 types.  Languages like C or C++ require each non-automatic variable to
5288 have distinct location, so using this option will result in non-conforming
5289 behavior.
5291 @item -fmodulo-sched
5292 @opindex fmodulo-sched
5293 Perform swing modulo scheduling immediately before the first scheduling
5294 pass.  This pass looks at innermost loops and reorders their
5295 instructions by overlapping different iterations.
5297 @item -fmodulo-sched-allow-regmoves
5298 @opindex fmodulo-sched-allow-regmoves
5299 Perform more aggressive SMS based modulo scheduling with register moves
5300 allowed.  By setting this flag certain anti-dependences edges will be
5301 deleted which will trigger the generation of reg-moves based on the
5302 life-range analysis.
5304 @item -fno-branch-count-reg
5305 @opindex fno-branch-count-reg
5306 Do not use ``decrement and branch'' instructions on a count register,
5307 but instead generate a sequence of instructions that decrement a
5308 register, compare it against zero, then branch based upon the result.
5309 This option is only meaningful on architectures that support such
5310 instructions, which include x86, PowerPC, IA-64 and S/390.
5312 The default is @option{-fbranch-count-reg}.
5314 @item -fno-function-cse
5315 @opindex fno-function-cse
5316 Do not put function addresses in registers; make each instruction that
5317 calls a constant function contain the function's address explicitly.
5319 This option results in less efficient code, but some strange hacks
5320 that alter the assembler output may be confused by the optimizations
5321 performed when this option is not used.
5323 The default is @option{-ffunction-cse}
5325 @item -fno-zero-initialized-in-bss
5326 @opindex fno-zero-initialized-in-bss
5327 If the target supports a BSS section, GCC by default puts variables that
5328 are initialized to zero into BSS@.  This can save space in the resulting
5329 code.
5331 This option turns off this behavior because some programs explicitly
5332 rely on variables going to the data section.  E.g., so that the
5333 resulting executable can find the beginning of that section and/or make
5334 assumptions based on that.
5336 The default is @option{-fzero-initialized-in-bss}.
5338 @item -fbounds-check
5339 @opindex fbounds-check
5340 For front-ends that support it, generate additional code to check that
5341 indices used to access arrays are within the declared range.  This is
5342 currently only supported by the Java and Fortran front-ends, where
5343 this option defaults to true and false respectively.
5345 @item -fmudflap -fmudflapth -fmudflapir
5346 @opindex fmudflap
5347 @opindex fmudflapth
5348 @opindex fmudflapir
5349 @cindex bounds checking
5350 @cindex mudflap
5351 For front-ends that support it (C and C++), instrument all risky
5352 pointer/array dereferencing operations, some standard library
5353 string/heap functions, and some other associated constructs with
5354 range/validity tests.  Modules so instrumented should be immune to
5355 buffer overflows, invalid heap use, and some other classes of C/C++
5356 programming errors.  The instrumentation relies on a separate runtime
5357 library (@file{libmudflap}), which will be linked into a program if
5358 @option{-fmudflap} is given at link time.  Run-time behavior of the
5359 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
5360 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
5361 for its options.
5363 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
5364 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
5365 addition to @option{-fmudflap} or @option{-fmudflapth}, if
5366 instrumentation should ignore pointer reads.  This produces less
5367 instrumentation (and therefore faster execution) and still provides
5368 some protection against outright memory corrupting writes, but allows
5369 erroneously read data to propagate within a program.
5371 @item -fthread-jumps
5372 @opindex fthread-jumps
5373 Perform optimizations where we check to see if a jump branches to a
5374 location where another comparison subsumed by the first is found.  If
5375 so, the first branch is redirected to either the destination of the
5376 second branch or a point immediately following it, depending on whether
5377 the condition is known to be true or false.
5379 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5381 @item -fsplit-wide-types
5382 @opindex fsplit-wide-types
5383 When using a type that occupies multiple registers, such as @code{long
5384 long} on a 32-bit system, split the registers apart and allocate them
5385 independently.  This normally generates better code for those types,
5386 but may make debugging more difficult.
5388 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
5389 @option{-Os}.
5391 @item -fcse-follow-jumps
5392 @opindex fcse-follow-jumps
5393 In common subexpression elimination, scan through jump instructions
5394 when the target of the jump is not reached by any other path.  For
5395 example, when CSE encounters an @code{if} statement with an
5396 @code{else} clause, CSE will follow the jump when the condition
5397 tested is false.
5399 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5401 @item -fcse-skip-blocks
5402 @opindex fcse-skip-blocks
5403 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
5404 follow jumps which conditionally skip over blocks.  When CSE
5405 encounters a simple @code{if} statement with no else clause,
5406 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
5407 body of the @code{if}.
5409 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5411 @item -frerun-cse-after-loop
5412 @opindex frerun-cse-after-loop
5413 Re-run common subexpression elimination after loop optimizations has been
5414 performed.
5416 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5418 @item -fgcse
5419 @opindex fgcse
5420 Perform a global common subexpression elimination pass.
5421 This pass also performs global constant and copy propagation.
5423 @emph{Note:} When compiling a program using computed gotos, a GCC
5424 extension, you may get better runtime performance if you disable
5425 the global common subexpression elimination pass by adding
5426 @option{-fno-gcse} to the command line.
5428 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5430 @item -fgcse-lm
5431 @opindex fgcse-lm
5432 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
5433 attempt to move loads which are only killed by stores into themselves.  This
5434 allows a loop containing a load/store sequence to be changed to a load outside
5435 the loop, and a copy/store within the loop.
5437 Enabled by default when gcse is enabled.
5439 @item -fgcse-sm
5440 @opindex fgcse-sm
5441 When @option{-fgcse-sm} is enabled, a store motion pass is run after
5442 global common subexpression elimination.  This pass will attempt to move
5443 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
5444 loops containing a load/store sequence can be changed to a load before
5445 the loop and a store after the loop.
5447 Not enabled at any optimization level.
5449 @item -fgcse-las
5450 @opindex fgcse-las
5451 When @option{-fgcse-las} is enabled, the global common subexpression
5452 elimination pass eliminates redundant loads that come after stores to the
5453 same memory location (both partial and full redundancies).
5455 Not enabled at any optimization level.
5457 @item -fgcse-after-reload
5458 @opindex fgcse-after-reload
5459 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5460 pass is performed after reload.  The purpose of this pass is to cleanup
5461 redundant spilling.
5463 @item -funsafe-loop-optimizations
5464 @opindex funsafe-loop-optimizations
5465 If given, the loop optimizer will assume that loop indices do not
5466 overflow, and that the loops with nontrivial exit condition are not
5467 infinite.  This enables a wider range of loop optimizations even if
5468 the loop optimizer itself cannot prove that these assumptions are valid.
5469 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5470 if it finds this kind of loop.
5472 @item -fcrossjumping
5473 @opindex crossjumping
5474 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5475 resulting code may or may not perform better than without cross-jumping.
5477 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5479 @item -fif-conversion
5480 @opindex if-conversion
5481 Attempt to transform conditional jumps into branch-less equivalents.  This
5482 include use of conditional moves, min, max, set flags and abs instructions, and
5483 some tricks doable by standard arithmetics.  The use of conditional execution
5484 on chips where it is available is controlled by @code{if-conversion2}.
5486 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5488 @item -fif-conversion2
5489 @opindex if-conversion2
5490 Use conditional execution (where available) to transform conditional jumps into
5491 branch-less equivalents.
5493 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5495 @item -fdelete-null-pointer-checks
5496 @opindex fdelete-null-pointer-checks
5497 Use global dataflow analysis to identify and eliminate useless checks
5498 for null pointers.  The compiler assumes that dereferencing a null
5499 pointer would have halted the program.  If a pointer is checked after
5500 it has already been dereferenced, it cannot be null.
5502 In some environments, this assumption is not true, and programs can
5503 safely dereference null pointers.  Use
5504 @option{-fno-delete-null-pointer-checks} to disable this optimization
5505 for programs which depend on that behavior.
5507 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5509 @item -fexpensive-optimizations
5510 @opindex fexpensive-optimizations
5511 Perform a number of minor optimizations that are relatively expensive.
5513 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5515 @item -foptimize-register-move
5516 @itemx -fregmove
5517 @opindex foptimize-register-move
5518 @opindex fregmove
5519 Attempt to reassign register numbers in move instructions and as
5520 operands of other simple instructions in order to maximize the amount of
5521 register tying.  This is especially helpful on machines with two-operand
5522 instructions.
5524 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5525 optimization.
5527 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5529 @item -fira
5530 @opindex fira
5531 If supported for the target machine, use the integrated register
5532 allocator (@acronym{IRA}) for the register allocation.
5534 @item -fira-algorithm=@var{algorithm}
5535 Use specified algorithm for the integrated register allocator.  The
5536 @var{algorithm} argument should be one of @code{regional}, @code{CB},
5537 @code{mixed} or @code{priority}.  The second algorithm specifies
5538 Chaitin-Briggs coloring, the fourth one specifies Chow's priority
5539 based coloring, the first one which is the default specifies regional
5540 coloring based on Chaitin-Briggs coloring, and the third one specifies
5541 a mix of Chaitin-Briggs and regional algorithms where loops with small
5542 register pressure are ignored.  The first algorithm is the best for
5543 the generated code quality especially for machines with small or
5544 moderate size register set, the second one is faster and generates
5545 decent code and the smallest size code, the priority-based one is the
5546 fastest one, and the mixed algorithm can give the best result in some
5547 cases.
5549 @item -fira-coalescing
5550 @opindex fira-coalescing
5551 Do optimistic register coalescing.  This option might be profitable for
5552 architectures with big regular register files.
5554 @item -fira-ipra
5555 @opindex fira-ipra
5556 Switch on a simple form of inter-procedural register allocation when
5557 the integrated register allocator (@acronym{IRA}) is used.
5559 @item -fira-propagate-cost
5560 @opindex -fira-propagate-cost
5561 This is an experimental option used to propagate hard reg costs down
5562 to nested regions for regional or mixed ira allocation algorithm.
5564 @item -fno-ira-move-spills
5565 @opindex fno-ira-move-spills
5566 Switch off increasing gap between the corresponding save and restore
5567 insns.  All saves and the corresponding restores of call used hard
5568 registers living through a call will be in the same basic block.
5570 @item -fno-ira-share-save-slots
5571 @opindex fno-ira-share-save-slots
5572 Switch off sharing stack slots used for saving call used hard
5573 registers living through a call.  Each hard register will get a
5574 separate stack slot and as a result function stack frame will be
5575 bigger.
5577 @item -fno-ira-share-spill-slots
5578 @opindex fno-ira-share-spill-slots
5579 Switch off sharing stack slots allocated for pseudo-registers.  Each
5580 pseudo-register which did not get a hard register will get a separate
5581 stack slot and as a result function stack frame will be bigger.
5583 @item -fira-verbose=@var{n}
5584 @opindex fira-verbose
5585 Set up how verbose dump file for the integrated register allocator
5586 will be.  Default value is 5.  If the value is greater or equal to 10,
5587 the dump file will be stderr as if the value were @var{n} minus 10.
5589 @item -fdelayed-branch
5590 @opindex fdelayed-branch
5591 If supported for the target machine, attempt to reorder instructions
5592 to exploit instruction slots available after delayed branch
5593 instructions.
5595 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5597 @item -fschedule-insns
5598 @opindex fschedule-insns
5599 If supported for the target machine, attempt to reorder instructions to
5600 eliminate execution stalls due to required data being unavailable.  This
5601 helps machines that have slow floating point or memory load instructions
5602 by allowing other instructions to be issued until the result of the load
5603 or floating point instruction is required.
5605 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5607 @item -fschedule-insns2
5608 @opindex fschedule-insns2
5609 Similar to @option{-fschedule-insns}, but requests an additional pass of
5610 instruction scheduling after register allocation has been done.  This is
5611 especially useful on machines with a relatively small number of
5612 registers and where memory load instructions take more than one cycle.
5614 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5616 @item -fno-sched-interblock
5617 @opindex fno-sched-interblock
5618 Don't schedule instructions across basic blocks.  This is normally
5619 enabled by default when scheduling before register allocation, i.e.@:
5620 with @option{-fschedule-insns} or at @option{-O2} or higher.
5622 @item -fno-sched-spec
5623 @opindex fno-sched-spec
5624 Don't allow speculative motion of non-load instructions.  This is normally
5625 enabled by default when scheduling before register allocation, i.e.@:
5626 with @option{-fschedule-insns} or at @option{-O2} or higher.
5628 @item -fsched-spec-load
5629 @opindex fsched-spec-load
5630 Allow speculative motion of some load instructions.  This only makes
5631 sense when scheduling before register allocation, i.e.@: with
5632 @option{-fschedule-insns} or at @option{-O2} or higher.
5634 @item -fsched-spec-load-dangerous
5635 @opindex fsched-spec-load-dangerous
5636 Allow speculative motion of more load instructions.  This only makes
5637 sense when scheduling before register allocation, i.e.@: with
5638 @option{-fschedule-insns} or at @option{-O2} or higher.
5640 @item -fsched-stalled-insns=@var{n}
5641 @opindex fsched-stalled-insns
5642 Define how many insns (if any) can be moved prematurely from the queue
5643 of stalled insns into the ready list, during the second scheduling pass.
5645 @item -fsched-stalled-insns-dep=@var{n}
5646 @opindex fsched-stalled-insns-dep
5647 Define how many insn groups (cycles) will be examined for a dependency
5648 on a stalled insn that is candidate for premature removal from the queue
5649 of stalled insns.  Has an effect only during the second scheduling pass,
5650 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5652 @item -fsched2-use-superblocks
5653 @opindex fsched2-use-superblocks
5654 When scheduling after register allocation, do use superblock scheduling
5655 algorithm.  Superblock scheduling allows motion across basic block boundaries
5656 resulting on faster schedules.  This option is experimental, as not all machine
5657 descriptions used by GCC model the CPU closely enough to avoid unreliable
5658 results from the algorithm.
5660 This only makes sense when scheduling after register allocation, i.e.@: with
5661 @option{-fschedule-insns2} or at @option{-O2} or higher.
5663 @item -fsched2-use-traces
5664 @opindex fsched2-use-traces
5665 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5666 allocation and additionally perform code duplication in order to increase the
5667 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5668 trace formation.
5670 This mode should produce faster but significantly longer programs.  Also
5671 without @option{-fbranch-probabilities} the traces constructed may not
5672 match the reality and hurt the performance.  This only makes
5673 sense when scheduling after register allocation, i.e.@: with
5674 @option{-fschedule-insns2} or at @option{-O2} or higher.
5676 @item -fsee
5677 @opindex fsee
5678 Eliminates redundant extension instructions and move the non redundant
5679 ones to optimal placement using LCM.
5681 @item -freschedule-modulo-scheduled-loops
5682 @opindex fscheduling-in-modulo-scheduled-loops
5683 The modulo scheduling comes before the traditional scheduling, if a loop
5684 was modulo scheduled we may want to prevent the later scheduling passes
5685 from changing its schedule, we use this option to control that.
5687 @item -fcaller-saves
5688 @opindex fcaller-saves
5689 Enable values to be allocated in registers that will be clobbered by
5690 function calls, by emitting extra instructions to save and restore the
5691 registers around such calls.  Such allocation is done only when it
5692 seems to result in better code than would otherwise be produced.
5694 This option is always enabled by default on certain machines, usually
5695 those which have no call-preserved registers to use instead.
5697 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5699 @item -ftree-reassoc
5700 Perform Reassociation on trees  This flag is enabled by default
5701 at @option{-O} and higher.
5703 @item -ftree-pre
5704 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5705 enabled by default at @option{-O2} and @option{-O3}.
5707 @item -ftree-fre
5708 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5709 between FRE and PRE is that FRE only considers expressions
5710 that are computed on all paths leading to the redundant computation.
5711 This analysis is faster than PRE, though it exposes fewer redundancies.
5712 This flag is enabled by default at @option{-O} and higher.
5714 @item -ftree-copy-prop
5715 Perform copy propagation on trees.  This pass eliminates unnecessary
5716 copy operations.  This flag is enabled by default at @option{-O} and
5717 higher.
5719 @item -ftree-store-copy-prop
5720 Perform copy propagation of memory loads and stores.  This pass
5721 eliminates unnecessary copy operations in memory references
5722 (structures, global variables, arrays, etc).  This flag is enabled by
5723 default at @option{-O2} and higher.
5725 @item -ftree-salias
5726 Perform structural alias analysis on trees.  This flag
5727 is enabled by default at @option{-O} and higher.
5729 @item -fipa-pta
5730 Perform interprocedural pointer analysis.
5732 @item -ftree-sink
5733 Perform forward store motion  on trees.  This flag is
5734 enabled by default at @option{-O} and higher.
5736 @item -ftree-ccp
5737 Perform sparse conditional constant propagation (CCP) on trees.  This
5738 pass only operates on local scalar variables and is enabled by default
5739 at @option{-O} and higher.
5741 @item -ftree-store-ccp
5742 Perform sparse conditional constant propagation (CCP) on trees.  This
5743 pass operates on both local scalar variables and memory stores and
5744 loads (global variables, structures, arrays, etc).  This flag is
5745 enabled by default at @option{-O2} and higher.
5747 @item -ftree-dce
5748 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5749 default at @option{-O} and higher.
5751 @item -ftree-dominator-opts
5752 Perform a variety of simple scalar cleanups (constant/copy
5753 propagation, redundancy elimination, range propagation and expression
5754 simplification) based on a dominator tree traversal.  This also
5755 performs jump threading (to reduce jumps to jumps). This flag is
5756 enabled by default at @option{-O} and higher.
5758 @item -ftree-ch
5759 Perform loop header copying on trees.  This is beneficial since it increases
5760 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5761 is enabled by default at @option{-O} and higher.  It is not enabled
5762 for @option{-Os}, since it usually increases code size.
5764 @item -ftree-loop-optimize
5765 Perform loop optimizations on trees.  This flag is enabled by default
5766 at @option{-O} and higher.
5768 @item -ftree-loop-linear
5769 Perform linear loop transformations on tree.  This flag can improve cache
5770 performance and allow further loop optimizations to take place.
5772 @item -fcheck-data-deps
5773 Compare the results of several data dependence analyzers.  This option
5774 is used for debugging the data dependence analyzers.
5776 @item -ftree-loop-im
5777 Perform loop invariant motion on trees.  This pass moves only invariants that
5778 would be hard to handle at RTL level (function calls, operations that expand to
5779 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5780 operands of conditions that are invariant out of the loop, so that we can use
5781 just trivial invariantness analysis in loop unswitching.  The pass also includes
5782 store motion.
5784 @item -ftree-loop-ivcanon
5785 Create a canonical counter for number of iterations in the loop for that
5786 determining number of iterations requires complicated analysis.  Later
5787 optimizations then may determine the number easily.  Useful especially
5788 in connection with unrolling.
5790 @item -fivopts
5791 Perform induction variable optimizations (strength reduction, induction
5792 variable merging and induction variable elimination) on trees.
5794 @item -ftree-sra
5795 Perform scalar replacement of aggregates.  This pass replaces structure
5796 references with scalars to prevent committing structures to memory too
5797 early.  This flag is enabled by default at @option{-O} and higher.
5799 @item -ftree-copyrename
5800 Perform copy renaming on trees.  This pass attempts to rename compiler
5801 temporaries to other variables at copy locations, usually resulting in
5802 variable names which more closely resemble the original variables.  This flag
5803 is enabled by default at @option{-O} and higher.
5805 @item -ftree-ter
5806 Perform temporary expression replacement during the SSA->normal phase.  Single
5807 use/single def temporaries are replaced at their use location with their
5808 defining expression.  This results in non-GIMPLE code, but gives the expanders
5809 much more complex trees to work on resulting in better RTL generation.  This is
5810 enabled by default at @option{-O} and higher.
5812 @item -ftree-vectorize
5813 Perform loop vectorization on trees.
5815 @item -ftree-vect-loop-version
5816 @opindex ftree-vect-loop-version
5817 Perform loop versioning when doing loop vectorization on trees.  When a loop
5818 appears to be vectorizable except that data alignment or data dependence cannot
5819 be determined at compile time then vectorized and non-vectorized versions of
5820 the loop are generated along with runtime checks for alignment or dependence
5821 to control which version is executed.  This option is enabled by default
5822 except at level @option{-Os} where it is disabled.
5824 @item -fvect-cost-model
5825 Enable cost model for vectorization.
5827 @item -ftree-vrp
5828 Perform Value Range Propagation on trees.  This is similar to the
5829 constant propagation pass, but instead of values, ranges of values are
5830 propagated.  This allows the optimizers to remove unnecessary range
5831 checks like array bound checks and null pointer checks.  This is
5832 enabled by default at @option{-O2} and higher.  Null pointer check
5833 elimination is only done if @option{-fdelete-null-pointer-checks} is
5834 enabled.
5836 @item -ftracer
5837 @opindex ftracer
5838 Perform tail duplication to enlarge superblock size.  This transformation
5839 simplifies the control flow of the function allowing other optimizations to do
5840 better job.
5842 @item -funroll-loops
5843 @opindex funroll-loops
5844 Unroll loops whose number of iterations can be determined at compile
5845 time or upon entry to the loop.  @option{-funroll-loops} implies
5846 @option{-frerun-cse-after-loop}.  This option makes code larger,
5847 and may or may not make it run faster.
5849 @item -funroll-all-loops
5850 @opindex funroll-all-loops
5851 Unroll all loops, even if their number of iterations is uncertain when
5852 the loop is entered.  This usually makes programs run more slowly.
5853 @option{-funroll-all-loops} implies the same options as
5854 @option{-funroll-loops},
5856 @item -fsplit-ivs-in-unroller
5857 @opindex fsplit-ivs-in-unroller
5858 Enables expressing of values of induction variables in later iterations
5859 of the unrolled loop using the value in the first iteration.  This breaks
5860 long dependency chains, thus improving efficiency of the scheduling passes.
5862 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5863 same effect.  However in cases the loop body is more complicated than
5864 a single basic block, this is not reliable.  It also does not work at all
5865 on some of the architectures due to restrictions in the CSE pass.
5867 This optimization is enabled by default.
5869 @item -fvariable-expansion-in-unroller
5870 @opindex fvariable-expansion-in-unroller
5871 With this option, the compiler will create multiple copies of some
5872 local variables when unrolling a loop which can result in superior code.
5874 @item -fpredictive-commoning
5875 @opindex fpredictive-commoning
5876 Perform predictive commoning optimization, i.e., reusing computations
5877 (especially memory loads and stores) performed in previous
5878 iterations of loops.
5880 This option is enabled at level @option{-O3}.
5882 @item -fprefetch-loop-arrays
5883 @opindex fprefetch-loop-arrays
5884 If supported by the target machine, generate instructions to prefetch
5885 memory to improve the performance of loops that access large arrays.
5887 This option may generate better or worse code; results are highly
5888 dependent on the structure of loops within the source code.
5890 Disabled at level @option{-Os}.
5892 @item -fno-peephole
5893 @itemx -fno-peephole2
5894 @opindex fno-peephole
5895 @opindex fno-peephole2
5896 Disable any machine-specific peephole optimizations.  The difference
5897 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5898 are implemented in the compiler; some targets use one, some use the
5899 other, a few use both.
5901 @option{-fpeephole} is enabled by default.
5902 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5904 @item -fno-guess-branch-probability
5905 @opindex fno-guess-branch-probability
5906 Do not guess branch probabilities using heuristics.
5908 GCC will use heuristics to guess branch probabilities if they are
5909 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5910 heuristics are based on the control flow graph.  If some branch probabilities
5911 are specified by @samp{__builtin_expect}, then the heuristics will be
5912 used to guess branch probabilities for the rest of the control flow graph,
5913 taking the @samp{__builtin_expect} info into account.  The interactions
5914 between the heuristics and @samp{__builtin_expect} can be complex, and in
5915 some cases, it may be useful to disable the heuristics so that the effects
5916 of @samp{__builtin_expect} are easier to understand.
5918 The default is @option{-fguess-branch-probability} at levels
5919 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5921 @item -freorder-blocks
5922 @opindex freorder-blocks
5923 Reorder basic blocks in the compiled function in order to reduce number of
5924 taken branches and improve code locality.
5926 Enabled at levels @option{-O2}, @option{-O3}.
5928 @item -freorder-blocks-and-partition
5929 @opindex freorder-blocks-and-partition
5930 In addition to reordering basic blocks in the compiled function, in order
5931 to reduce number of taken branches, partitions hot and cold basic blocks
5932 into separate sections of the assembly and .o files, to improve
5933 paging and cache locality performance.
5935 This optimization is automatically turned off in the presence of
5936 exception handling, for linkonce sections, for functions with a user-defined
5937 section attribute and on any architecture that does not support named
5938 sections.
5940 @item -freorder-functions
5941 @opindex freorder-functions
5942 Reorder functions in the object file in order to
5943 improve code locality.  This is implemented by using special
5944 subsections @code{.text.hot} for most frequently executed functions and
5945 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5946 the linker so object file format must support named sections and linker must
5947 place them in a reasonable way.
5949 Also profile feedback must be available in to make this option effective.  See
5950 @option{-fprofile-arcs} for details.
5952 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5954 @item -fstrict-aliasing
5955 @opindex fstrict-aliasing
5956 Allows the compiler to assume the strictest aliasing rules applicable to
5957 the language being compiled.  For C (and C++), this activates
5958 optimizations based on the type of expressions.  In particular, an
5959 object of one type is assumed never to reside at the same address as an
5960 object of a different type, unless the types are almost the same.  For
5961 example, an @code{unsigned int} can alias an @code{int}, but not a
5962 @code{void*} or a @code{double}.  A character type may alias any other
5963 type.
5965 Pay special attention to code like this:
5966 @smallexample
5967 union a_union @{
5968   int i;
5969   double d;
5972 int f() @{
5973   a_union t;
5974   t.d = 3.0;
5975   return t.i;
5977 @end smallexample
5978 The practice of reading from a different union member than the one most
5979 recently written to (called ``type-punning'') is common.  Even with
5980 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5981 is accessed through the union type.  So, the code above will work as
5982 expected.  However, this code might not:
5983 @smallexample
5984 int f() @{
5985   a_union t;
5986   int* ip;
5987   t.d = 3.0;
5988   ip = &t.i;
5989   return *ip;
5991 @end smallexample
5993 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5995 @item -fstrict-overflow
5996 @opindex fstrict-overflow
5997 Allow the compiler to assume strict signed overflow rules, depending
5998 on the language being compiled.  For C (and C++) this means that
5999 overflow when doing arithmetic with signed numbers is undefined, which
6000 means that the compiler may assume that it will not happen.  This
6001 permits various optimizations.  For example, the compiler will assume
6002 that an expression like @code{i + 10 > i} will always be true for
6003 signed @code{i}.  This assumption is only valid if signed overflow is
6004 undefined, as the expression is false if @code{i + 10} overflows when
6005 using twos complement arithmetic.  When this option is in effect any
6006 attempt to determine whether an operation on signed numbers will
6007 overflow must be written carefully to not actually involve overflow.
6009 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
6010 that signed overflow is fully defined: it wraps.  When
6011 @option{-fwrapv} is used, there is no difference between
6012 @option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
6013 @option{-fwrapv} certain types of overflow are permitted.  For
6014 example, if the compiler gets an overflow when doing arithmetic on
6015 constants, the overflowed value can still be used with
6016 @option{-fwrapv}, but not otherwise.
6018 The @option{-fstrict-overflow} option is enabled at levels
6019 @option{-O2}, @option{-O3}, @option{-Os}.
6021 @item -falign-functions
6022 @itemx -falign-functions=@var{n}
6023 @opindex falign-functions
6024 Align the start of functions to the next power-of-two greater than
6025 @var{n}, skipping up to @var{n} bytes.  For instance,
6026 @option{-falign-functions=32} aligns functions to the next 32-byte
6027 boundary, but @option{-falign-functions=24} would align to the next
6028 32-byte boundary only if this can be done by skipping 23 bytes or less.
6030 @option{-fno-align-functions} and @option{-falign-functions=1} are
6031 equivalent and mean that functions will not be aligned.
6033 Some assemblers only support this flag when @var{n} is a power of two;
6034 in that case, it is rounded up.
6036 If @var{n} is not specified or is zero, use a machine-dependent default.
6038 Enabled at levels @option{-O2}, @option{-O3}.
6040 @item -falign-labels
6041 @itemx -falign-labels=@var{n}
6042 @opindex falign-labels
6043 Align all branch targets to a power-of-two boundary, skipping up to
6044 @var{n} bytes like @option{-falign-functions}.  This option can easily
6045 make code slower, because it must insert dummy operations for when the
6046 branch target is reached in the usual flow of the code.
6048 @option{-fno-align-labels} and @option{-falign-labels=1} are
6049 equivalent and mean that labels will not be aligned.
6051 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
6052 are greater than this value, then their values are used instead.
6054 If @var{n} is not specified or is zero, use a machine-dependent default
6055 which is very likely to be @samp{1}, meaning no alignment.
6057 Enabled at levels @option{-O2}, @option{-O3}.
6059 @item -falign-loops
6060 @itemx -falign-loops=@var{n}
6061 @opindex falign-loops
6062 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
6063 like @option{-falign-functions}.  The hope is that the loop will be
6064 executed many times, which will make up for any execution of the dummy
6065 operations.
6067 @option{-fno-align-loops} and @option{-falign-loops=1} are
6068 equivalent and mean that loops will not be aligned.
6070 If @var{n} is not specified or is zero, use a machine-dependent default.
6072 Enabled at levels @option{-O2}, @option{-O3}.
6074 @item -falign-jumps
6075 @itemx -falign-jumps=@var{n}
6076 @opindex falign-jumps
6077 Align branch targets to a power-of-two boundary, for branch targets
6078 where the targets can only be reached by jumping, skipping up to @var{n}
6079 bytes like @option{-falign-functions}.  In this case, no dummy operations
6080 need be executed.
6082 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
6083 equivalent and mean that loops will not be aligned.
6085 If @var{n} is not specified or is zero, use a machine-dependent default.
6087 Enabled at levels @option{-O2}, @option{-O3}.
6089 @item -funit-at-a-time
6090 @opindex funit-at-a-time
6091 Parse the whole compilation unit before starting to produce code.
6092 This allows some extra optimizations to take place but consumes
6093 more memory (in general).  There are some compatibility issues
6094 with @emph{unit-at-a-time} mode:
6095 @itemize @bullet
6096 @item
6097 enabling @emph{unit-at-a-time} mode may change the order
6098 in which functions, variables, and top-level @code{asm} statements
6099 are emitted, and will likely break code relying on some particular
6100 ordering.  The majority of such top-level @code{asm} statements,
6101 though, can be replaced by @code{section} attributes.  The
6102 @option{fno-toplevel-reorder} option may be used to keep the ordering
6103 used in the input file, at the cost of some optimizations.
6105 @item
6106 @emph{unit-at-a-time} mode removes unreferenced static variables
6107 and functions.  This may result in undefined references
6108 when an @code{asm} statement refers directly to variables or functions
6109 that are otherwise unused.  In that case either the variable/function
6110 shall be listed as an operand of the @code{asm} statement operand or,
6111 in the case of top-level @code{asm} statements the attribute @code{used}
6112 shall be used on the declaration.
6114 @item
6115 Static functions now can use non-standard passing conventions that
6116 may break @code{asm} statements calling functions directly.  Again,
6117 attribute @code{used} will prevent this behavior.
6118 @end itemize
6120 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
6121 but this scheme may not be supported by future releases of GCC@.
6123 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6125 @item -fno-toplevel-reorder
6126 Do not reorder top-level functions, variables, and @code{asm}
6127 statements.  Output them in the same order that they appear in the
6128 input file.  When this option is used, unreferenced static variables
6129 will not be removed.  This option is intended to support existing code
6130 which relies on a particular ordering.  For new code, it is better to
6131 use attributes.
6133 @item -fweb
6134 @opindex fweb
6135 Constructs webs as commonly used for register allocation purposes and assign
6136 each web individual pseudo register.  This allows the register allocation pass
6137 to operate on pseudos directly, but also strengthens several other optimization
6138 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
6139 however, make debugging impossible, since variables will no longer stay in a
6140 ``home register''.
6142 Enabled by default with @option{-funroll-loops}.
6144 @item -fwhole-program
6145 @opindex fwhole-program
6146 Assume that the current compilation unit represents whole program being
6147 compiled.  All public functions and variables with the exception of @code{main}
6148 and those merged by attribute @code{externally_visible} become static functions
6149 and in a affect gets more aggressively optimized by interprocedural optimizers.
6150 While this option is equivalent to proper use of @code{static} keyword for
6151 programs consisting of single file, in combination with option
6152 @option{--combine} this flag can be used to compile most of smaller scale C
6153 programs since the functions and variables become local for the whole combined
6154 compilation unit, not for the single source file itself.
6157 @item -fno-cprop-registers
6158 @opindex fno-cprop-registers
6159 After register allocation and post-register allocation instruction splitting,
6160 we perform a copy-propagation pass to try to reduce scheduling dependencies
6161 and occasionally eliminate the copy.
6163 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6165 @item -fprofile-generate
6166 @opindex fprofile-generate
6168 Enable options usually used for instrumenting application to produce
6169 profile useful for later recompilation with profile feedback based
6170 optimization.  You must use @option{-fprofile-generate} both when
6171 compiling and when linking your program.
6173 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
6175 @item -fprofile-use
6176 @opindex fprofile-use
6177 Enable profile feedback directed optimizations, and optimizations
6178 generally profitable only with profile feedback available.
6180 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
6181 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
6183 By default, GCC emits an error message if the feedback profiles do not
6184 match the source code.  This error can be turned into a warning by using
6185 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
6186 code.
6187 @end table
6189 The following options control compiler behavior regarding floating
6190 point arithmetic.  These options trade off between speed and
6191 correctness.  All must be specifically enabled.
6193 @table @gcctabopt
6194 @item -ffloat-store
6195 @opindex ffloat-store
6196 Do not store floating point variables in registers, and inhibit other
6197 options that might change whether a floating point value is taken from a
6198 register or memory.
6200 @cindex floating point precision
6201 This option prevents undesirable excess precision on machines such as
6202 the 68000 where the floating registers (of the 68881) keep more
6203 precision than a @code{double} is supposed to have.  Similarly for the
6204 x86 architecture.  For most programs, the excess precision does only
6205 good, but a few programs rely on the precise definition of IEEE floating
6206 point.  Use @option{-ffloat-store} for such programs, after modifying
6207 them to store all pertinent intermediate computations into variables.
6209 @item -ffast-math
6210 @opindex ffast-math
6211 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
6212 @option{-fno-trapping-math}, @option{-ffinite-math-only},
6213 @option{-fno-rounding-math}, @option{-fno-signaling-nans},
6214 @option{-fno-signed-zeros} and @option{fcx-limited-range}.
6216 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
6218 This option is not turned on by any @option{-O} option since
6219 it can result in incorrect output for programs which depend on
6220 an exact implementation of IEEE or ISO rules/specifications for
6221 math functions. It may, however, yield faster code for programs
6222 that do not require the guarantees of these specifications.
6224 @item -fno-math-errno
6225 @opindex fno-math-errno
6226 Do not set ERRNO after calling math functions that are executed
6227 with a single instruction, e.g., sqrt.  A program that relies on
6228 IEEE exceptions for math error handling may want to use this flag
6229 for speed while maintaining IEEE arithmetic compatibility.
6231 This option is not turned on by any @option{-O} option since
6232 it can result in incorrect output for programs which depend on
6233 an exact implementation of IEEE or ISO rules/specifications for
6234 math functions. It may, however, yield faster code for programs
6235 that do not require the guarantees of these specifications.
6237 The default is @option{-fmath-errno}.
6239 On Darwin systems, the math library never sets @code{errno}.  There is
6240 therefore no reason for the compiler to consider the possibility that
6241 it might, and @option{-fno-math-errno} is the default.
6243 @item -funsafe-math-optimizations
6244 @opindex funsafe-math-optimizations
6245 Allow optimizations for floating-point arithmetic that (a) assume
6246 that arguments and results are valid and (b) may violate IEEE or
6247 ANSI standards.  When used at link-time, it may include libraries
6248 or startup files that change the default FPU control word or other
6249 similar optimizations.
6251 This option is not turned on by any @option{-O} option since
6252 it can result in incorrect output for programs which depend on
6253 an exact implementation of IEEE or ISO rules/specifications for
6254 math functions. It may, however, yield faster code for programs
6255 that do not require the guarantees of these specifications.
6257 The default is @option{-fno-unsafe-math-optimizations}.
6259 @item -ffinite-math-only
6260 @opindex ffinite-math-only
6261 Allow optimizations for floating-point arithmetic that assume
6262 that arguments and results are not NaNs or +-Infs.
6264 This option is not turned on by any @option{-O} option since
6265 it can result in incorrect output for programs which depend on
6266 an exact implementation of IEEE or ISO rules/specifications for
6267 math functions. It may, however, yield faster code for programs
6268 that do not require the guarantees of these specifications.
6270 The default is @option{-fno-finite-math-only}.
6272 @item -fno-signed-zeros
6273 @opindex fno-signed-zeros
6274 Allow optimizations for floating point arithmetic that ignore the
6275 signedness of zero.  IEEE arithmetic specifies the behavior of
6276 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
6277 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
6278 This option implies that the sign of a zero result isn't significant.
6280 The default is @option{-fsigned-zeros}.
6282 @item -fno-trapping-math
6283 @opindex fno-trapping-math
6284 Compile code assuming that floating-point operations cannot generate
6285 user-visible traps.  These traps include division by zero, overflow,
6286 underflow, inexact result and invalid operation.  This option implies
6287 @option{-fno-signaling-nans}.  Setting this option may allow faster
6288 code if one relies on ``non-stop'' IEEE arithmetic, for example.
6290 This option should never be turned on by any @option{-O} option since
6291 it can result in incorrect output for programs which depend on
6292 an exact implementation of IEEE or ISO rules/specifications for
6293 math functions.
6295 The default is @option{-ftrapping-math}.
6297 @item -frounding-math
6298 @opindex frounding-math
6299 Disable transformations and optimizations that assume default floating
6300 point rounding behavior.  This is round-to-zero for all floating point
6301 to integer conversions, and round-to-nearest for all other arithmetic
6302 truncations.  This option should be specified for programs that change
6303 the FP rounding mode dynamically, or that may be executed with a
6304 non-default rounding mode.  This option disables constant folding of
6305 floating point expressions at compile-time (which may be affected by
6306 rounding mode) and arithmetic transformations that are unsafe in the
6307 presence of sign-dependent rounding modes.
6309 The default is @option{-fno-rounding-math}.
6311 This option is experimental and does not currently guarantee to
6312 disable all GCC optimizations that are affected by rounding mode.
6313 Future versions of GCC may provide finer control of this setting
6314 using C99's @code{FENV_ACCESS} pragma.  This command line option
6315 will be used to specify the default state for @code{FENV_ACCESS}.
6317 @item -frtl-abstract-sequences
6318 @opindex frtl-abstract-sequences
6319 It is a size optimization method. This option is to find identical
6320 sequences of code, which can be turned into pseudo-procedures  and
6321 then  replace  all  occurrences with  calls to  the  newly created
6322 subroutine. It is kind of an opposite of @option{-finline-functions}.
6323 This optimization runs at RTL level.
6325 @item -fsignaling-nans
6326 @opindex fsignaling-nans
6327 Compile code assuming that IEEE signaling NaNs may generate user-visible
6328 traps during floating-point operations.  Setting this option disables
6329 optimizations that may change the number of exceptions visible with
6330 signaling NaNs.  This option implies @option{-ftrapping-math}.
6332 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
6333 be defined.
6335 The default is @option{-fno-signaling-nans}.
6337 This option is experimental and does not currently guarantee to
6338 disable all GCC optimizations that affect signaling NaN behavior.
6340 @item -fsingle-precision-constant
6341 @opindex fsingle-precision-constant
6342 Treat floating point constant as single precision constant instead of
6343 implicitly converting it to double precision constant.
6345 @item -fcx-limited-range
6346 @itemx -fno-cx-limited-range
6347 @opindex fcx-limited-range
6348 @opindex fno-cx-limited-range
6349 When enabled, this option states that a range reduction step is not
6350 needed when performing complex division.  The default is
6351 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
6353 This option controls the default setting of the ISO C99
6354 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
6355 all languages.
6357 @end table
6359 The following options control optimizations that may improve
6360 performance, but are not enabled by any @option{-O} options.  This
6361 section includes experimental options that may produce broken code.
6363 @table @gcctabopt
6364 @item -fbranch-probabilities
6365 @opindex fbranch-probabilities
6366 After running a program compiled with @option{-fprofile-arcs}
6367 (@pxref{Debugging Options,, Options for Debugging Your Program or
6368 @command{gcc}}), you can compile it a second time using
6369 @option{-fbranch-probabilities}, to improve optimizations based on
6370 the number of times each branch was taken.  When the program
6371 compiled with @option{-fprofile-arcs} exits it saves arc execution
6372 counts to a file called @file{@var{sourcename}.gcda} for each source
6373 file.  The information in this data file is very dependent on the
6374 structure of the generated code, so you must use the same source code
6375 and the same optimization options for both compilations.
6377 With @option{-fbranch-probabilities}, GCC puts a
6378 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
6379 These can be used to improve optimization.  Currently, they are only
6380 used in one place: in @file{reorg.c}, instead of guessing which path a
6381 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
6382 exactly determine which path is taken more often.
6384 @item -fprofile-values
6385 @opindex fprofile-values
6386 If combined with @option{-fprofile-arcs}, it adds code so that some
6387 data about values of expressions in the program is gathered.
6389 With @option{-fbranch-probabilities}, it reads back the data gathered
6390 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
6391 notes to instructions for their later usage in optimizations.
6393 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
6395 @item -fvpt
6396 @opindex fvpt
6397 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
6398 a code to gather information about values of expressions.
6400 With @option{-fbranch-probabilities}, it reads back the data gathered
6401 and actually performs the optimizations based on them.
6402 Currently the optimizations include specialization of division operation
6403 using the knowledge about the value of the denominator.
6405 @item -frename-registers
6406 @opindex frename-registers
6407 Attempt to avoid false dependencies in scheduled code by making use
6408 of registers left over after register allocation.  This optimization
6409 will most benefit processors with lots of registers.  Depending on the
6410 debug information format adopted by the target, however, it can
6411 make debugging impossible, since variables will no longer stay in
6412 a ``home register''.
6414 Enabled by default with @option{-funroll-loops}.
6416 @item -ftracer
6417 @opindex ftracer
6418 Perform tail duplication to enlarge superblock size.  This transformation
6419 simplifies the control flow of the function allowing other optimizations to do
6420 better job.
6422 Enabled with @option{-fprofile-use}.
6424 @item -funroll-loops
6425 @opindex funroll-loops
6426 Unroll loops whose number of iterations can be determined at compile time or
6427 upon entry to the loop.  @option{-funroll-loops} implies
6428 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
6429 It also turns on complete loop peeling (i.e.@: complete removal of loops with
6430 small constant number of iterations).  This option makes code larger, and may
6431 or may not make it run faster.
6433 Enabled with @option{-fprofile-use}.
6435 @item -funroll-all-loops
6436 @opindex funroll-all-loops
6437 Unroll all loops, even if their number of iterations is uncertain when
6438 the loop is entered.  This usually makes programs run more slowly.
6439 @option{-funroll-all-loops} implies the same options as
6440 @option{-funroll-loops}.
6442 @item -fpeel-loops
6443 @opindex fpeel-loops
6444 Peels the loops for that there is enough information that they do not
6445 roll much (from profile feedback).  It also turns on complete loop peeling
6446 (i.e.@: complete removal of loops with small constant number of iterations).
6448 Enabled with @option{-fprofile-use}.
6450 @item -fmove-loop-invariants
6451 @opindex fmove-loop-invariants
6452 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
6453 at level @option{-O1}
6455 @item -funswitch-loops
6456 @opindex funswitch-loops
6457 Move branches with loop invariant conditions out of the loop, with duplicates
6458 of the loop on both branches (modified according to result of the condition).
6460 @item -ffunction-sections
6461 @itemx -fdata-sections
6462 @opindex ffunction-sections
6463 @opindex fdata-sections
6464 Place each function or data item into its own section in the output
6465 file if the target supports arbitrary sections.  The name of the
6466 function or the name of the data item determines the section's name
6467 in the output file.
6469 Use these options on systems where the linker can perform optimizations
6470 to improve locality of reference in the instruction space.  Most systems
6471 using the ELF object format and SPARC processors running Solaris 2 have
6472 linkers with such optimizations.  AIX may have these optimizations in
6473 the future.
6475 Only use these options when there are significant benefits from doing
6476 so.  When you specify these options, the assembler and linker will
6477 create larger object and executable files and will also be slower.
6478 You will not be able to use @code{gprof} on all systems if you
6479 specify this option and you may have problems with debugging if
6480 you specify both this option and @option{-g}.
6482 @item -fbranch-target-load-optimize
6483 @opindex fbranch-target-load-optimize
6484 Perform branch target register load optimization before prologue / epilogue
6485 threading.
6486 The use of target registers can typically be exposed only during reload,
6487 thus hoisting loads out of loops and doing inter-block scheduling needs
6488 a separate optimization pass.
6490 @item -fbranch-target-load-optimize2
6491 @opindex fbranch-target-load-optimize2
6492 Perform branch target register load optimization after prologue / epilogue
6493 threading.
6495 @item -fbtr-bb-exclusive
6496 @opindex fbtr-bb-exclusive
6497 When performing branch target register load optimization, don't reuse
6498 branch target registers in within any basic block.
6500 @item -fstack-protector
6501 Emit extra code to check for buffer overflows, such as stack smashing
6502 attacks.  This is done by adding a guard variable to functions with
6503 vulnerable objects.  This includes functions that call alloca, and
6504 functions with buffers larger than 8 bytes.  The guards are initialized
6505 when a function is entered and then checked when the function exits.
6506 If a guard check fails, an error message is printed and the program exits.
6508 @item -fstack-protector-all
6509 Like @option{-fstack-protector} except that all functions are protected.
6511 @item -fsection-anchors
6512 @opindex fsection-anchors
6513 Try to reduce the number of symbolic address calculations by using
6514 shared ``anchor'' symbols to address nearby objects.  This transformation
6515 can help to reduce the number of GOT entries and GOT accesses on some
6516 targets.
6518 For example, the implementation of the following function @code{foo}:
6520 @smallexample
6521 static int a, b, c;
6522 int foo (void) @{ return a + b + c; @}
6523 @end smallexample
6525 would usually calculate the addresses of all three variables, but if you
6526 compile it with @option{-fsection-anchors}, it will access the variables
6527 from a common anchor point instead.  The effect is similar to the
6528 following pseudocode (which isn't valid C):
6530 @smallexample
6531 int foo (void)
6533   register int *xr = &x;
6534   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6536 @end smallexample
6538 Not all targets support this option.
6540 @item --param @var{name}=@var{value}
6541 @opindex param
6542 In some places, GCC uses various constants to control the amount of
6543 optimization that is done.  For example, GCC will not inline functions
6544 that contain more that a certain number of instructions.  You can
6545 control some of these constants on the command-line using the
6546 @option{--param} option.
6548 The names of specific parameters, and the meaning of the values, are
6549 tied to the internals of the compiler, and are subject to change
6550 without notice in future releases.
6552 In each case, the @var{value} is an integer.  The allowable choices for
6553 @var{name} are given in the following table:
6555 @table @gcctabopt
6556 @item salias-max-implicit-fields
6557 The maximum number of fields in a variable without direct
6558 structure accesses for which structure aliasing will consider trying
6559 to track each field.  The default is 5
6561 @item salias-max-array-elements
6562 The maximum number of elements an array can have and its elements
6563 still be tracked individually by structure aliasing. The default is 4
6565 @item sra-max-structure-size
6566 The maximum structure size, in bytes, at which the scalar replacement
6567 of aggregates (SRA) optimization will perform block copies.  The
6568 default value, 0, implies that GCC will select the most appropriate
6569 size itself.
6571 @item sra-field-structure-ratio
6572 The threshold ratio (as a percentage) between instantiated fields and
6573 the complete structure size.  We say that if the ratio of the number
6574 of bytes in instantiated fields to the number of bytes in the complete
6575 structure exceeds this parameter, then block copies are not used.  The
6576 default is 75.
6578 @item max-crossjump-edges
6579 The maximum number of incoming edges to consider for crossjumping.
6580 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6581 the number of edges incoming to each block.  Increasing values mean
6582 more aggressive optimization, making the compile time increase with
6583 probably small improvement in executable size.
6585 @item min-crossjump-insns
6586 The minimum number of instructions which must be matched at the end
6587 of two blocks before crossjumping will be performed on them.  This
6588 value is ignored in the case where all instructions in the block being
6589 crossjumped from are matched.  The default value is 5.
6591 @item max-grow-copy-bb-insns
6592 The maximum code size expansion factor when copying basic blocks
6593 instead of jumping.  The expansion is relative to a jump instruction.
6594 The default value is 8.
6596 @item max-goto-duplication-insns
6597 The maximum number of instructions to duplicate to a block that jumps
6598 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6599 passes, GCC factors computed gotos early in the compilation process,
6600 and unfactors them as late as possible.  Only computed jumps at the
6601 end of a basic blocks with no more than max-goto-duplication-insns are
6602 unfactored.  The default value is 8.
6604 @item max-delay-slot-insn-search
6605 The maximum number of instructions to consider when looking for an
6606 instruction to fill a delay slot.  If more than this arbitrary number of
6607 instructions is searched, the time savings from filling the delay slot
6608 will be minimal so stop searching.  Increasing values mean more
6609 aggressive optimization, making the compile time increase with probably
6610 small improvement in executable run time.
6612 @item max-delay-slot-live-search
6613 When trying to fill delay slots, the maximum number of instructions to
6614 consider when searching for a block with valid live register
6615 information.  Increasing this arbitrarily chosen value means more
6616 aggressive optimization, increasing the compile time.  This parameter
6617 should be removed when the delay slot code is rewritten to maintain the
6618 control-flow graph.
6620 @item max-gcse-memory
6621 The approximate maximum amount of memory that will be allocated in
6622 order to perform the global common subexpression elimination
6623 optimization.  If more memory than specified is required, the
6624 optimization will not be done.
6626 @item max-gcse-passes
6627 The maximum number of passes of GCSE to run.  The default is 1.
6629 @item max-pending-list-length
6630 The maximum number of pending dependencies scheduling will allow
6631 before flushing the current state and starting over.  Large functions
6632 with few branches or calls can create excessively large lists which
6633 needlessly consume memory and resources.
6635 @item max-inline-insns-single
6636 Several parameters control the tree inliner used in gcc.
6637 This number sets the maximum number of instructions (counted in GCC's
6638 internal representation) in a single function that the tree inliner
6639 will consider for inlining.  This only affects functions declared
6640 inline and methods implemented in a class declaration (C++).
6641 The default value is 450.
6643 @item max-inline-insns-auto
6644 When you use @option{-finline-functions} (included in @option{-O3}),
6645 a lot of functions that would otherwise not be considered for inlining
6646 by the compiler will be investigated.  To those functions, a different
6647 (more restrictive) limit compared to functions declared inline can
6648 be applied.
6649 The default value is 90.
6651 @item large-function-insns
6652 The limit specifying really large functions.  For functions larger than this
6653 limit after inlining inlining is constrained by
6654 @option{--param large-function-growth}.  This parameter is useful primarily
6655 to avoid extreme compilation time caused by non-linear algorithms used by the
6656 backend.
6657 This parameter is ignored when @option{-funit-at-a-time} is not used.
6658 The default value is 2700.
6660 @item large-function-growth
6661 Specifies maximal growth of large function caused by inlining in percents.
6662 This parameter is ignored when @option{-funit-at-a-time} is not used.
6663 The default value is 100 which limits large function growth to 2.0 times
6664 the original size.
6666 @item large-unit-insns
6667 The limit specifying large translation unit.  Growth caused by inlining of
6668 units larger than this limit is limited by @option{--param inline-unit-growth}.
6669 For small units this might be too tight (consider unit consisting of function A
6670 that is inline and B that just calls A three time.  If B is small relative to
6671 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6672 large units consisting of small inlininable functions however the overall unit
6673 growth limit is needed to avoid exponential explosion of code size.  Thus for
6674 smaller units, the size is increased to @option{--param large-unit-insns}
6675 before applying @option{--param inline-unit-growth}.  The default is 10000
6677 @item inline-unit-growth
6678 Specifies maximal overall growth of the compilation unit caused by inlining.
6679 This parameter is ignored when @option{-funit-at-a-time} is not used.
6680 The default value is 30 which limits unit growth to 1.3 times the original
6681 size.
6683 @item large-stack-frame
6684 The limit specifying large stack frames.  While inlining the algorithm is trying
6685 to not grow past this limit too much.  Default value is 256 bytes.
6687 @item large-stack-frame-growth
6688 Specifies maximal growth of large stack frames caused by inlining in percents.
6689 The default value is 1000 which limits large stack frame growth to 11 times
6690 the original size.
6692 @item max-inline-insns-recursive
6693 @itemx max-inline-insns-recursive-auto
6694 Specifies maximum number of instructions out-of-line copy of self recursive inline
6695 function can grow into by performing recursive inlining.
6697 For functions declared inline @option{--param max-inline-insns-recursive} is
6698 taken into account.  For function not declared inline, recursive inlining
6699 happens only when @option{-finline-functions} (included in @option{-O3}) is
6700 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6701 default value is 450.
6703 @item max-inline-recursive-depth
6704 @itemx max-inline-recursive-depth-auto
6705 Specifies maximum recursion depth used by the recursive inlining.
6707 For functions declared inline @option{--param max-inline-recursive-depth} is
6708 taken into account.  For function not declared inline, recursive inlining
6709 happens only when @option{-finline-functions} (included in @option{-O3}) is
6710 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6711 default value is 450.
6713 @item min-inline-recursive-probability
6714 Recursive inlining is profitable only for function having deep recursion
6715 in average and can hurt for function having little recursion depth by
6716 increasing the prologue size or complexity of function body to other
6717 optimizers.
6719 When profile feedback is available (see @option{-fprofile-generate}) the actual
6720 recursion depth can be guessed from probability that function will recurse via
6721 given call expression.  This parameter limits inlining only to call expression
6722 whose probability exceeds given threshold (in percents).  The default value is
6725 @item inline-call-cost
6726 Specify cost of call instruction relative to simple arithmetics operations
6727 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6728 functions and at the same time increases size of leaf function that is believed to
6729 reduce function size by being inlined.  In effect it increases amount of
6730 inlining for code having large abstraction penalty (many functions that just
6731 pass the arguments to other functions) and decrease inlining for code with low
6732 abstraction penalty.  The default value is 16.
6734 @item min-vect-loop-bound
6735 The minimum number of iterations under which a loop will not get vectorized
6736 when @option{-ftree-vectorize} is used.  The number of iterations after
6737 vectorization needs to be greater than the value specified by this option
6738 to allow vectorization.  The default value is 0.
6740 @item max-unrolled-insns
6741 The maximum number of instructions that a loop should have if that loop
6742 is unrolled, and if the loop is unrolled, it determines how many times
6743 the loop code is unrolled.
6745 @item max-average-unrolled-insns
6746 The maximum number of instructions biased by probabilities of their execution
6747 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6748 it determines how many times the loop code is unrolled.
6750 @item max-unroll-times
6751 The maximum number of unrollings of a single loop.
6753 @item max-peeled-insns
6754 The maximum number of instructions that a loop should have if that loop
6755 is peeled, and if the loop is peeled, it determines how many times
6756 the loop code is peeled.
6758 @item max-peel-times
6759 The maximum number of peelings of a single loop.
6761 @item max-completely-peeled-insns
6762 The maximum number of insns of a completely peeled loop.
6764 @item max-completely-peel-times
6765 The maximum number of iterations of a loop to be suitable for complete peeling.
6767 @item max-unswitch-insns
6768 The maximum number of insns of an unswitched loop.
6770 @item max-unswitch-level
6771 The maximum number of branches unswitched in a single loop.
6773 @item lim-expensive
6774 The minimum cost of an expensive expression in the loop invariant motion.
6776 @item iv-consider-all-candidates-bound
6777 Bound on number of candidates for induction variables below that
6778 all candidates are considered for each use in induction variable
6779 optimizations.  Only the most relevant candidates are considered
6780 if there are more candidates, to avoid quadratic time complexity.
6782 @item iv-max-considered-uses
6783 The induction variable optimizations give up on loops that contain more
6784 induction variable uses.
6786 @item iv-always-prune-cand-set-bound
6787 If number of candidates in the set is smaller than this value,
6788 we always try to remove unnecessary ivs from the set during its
6789 optimization when a new iv is added to the set.
6791 @item scev-max-expr-size
6792 Bound on size of expressions used in the scalar evolutions analyzer.
6793 Large expressions slow the analyzer.
6795 @item omega-max-vars
6796 The maximum number of variables in an Omega constraint system.
6797 The default value is 128.
6799 @item omega-max-geqs
6800 The maximum number of inequalities in an Omega constraint system.
6801 The default value is 256.
6803 @item omega-max-eqs
6804 The maximum number of equalities in an Omega constraint system.
6805 The default value is 128.
6807 @item omega-max-wild-cards
6808 The maximum number of wildcard variables that the Omega solver will
6809 be able to insert.  The default value is 18.
6811 @item omega-hash-table-size
6812 The size of the hash table in the Omega solver.  The default value is
6813 550.
6815 @item omega-max-keys
6816 The maximal number of keys used by the Omega solver.  The default
6817 value is 500.
6819 @item omega-eliminate-redundant-constraints
6820 When set to 1, use expensive methods to eliminate all redundant
6821 constraints.  The default value is 0.
6823 @item vect-max-version-for-alignment-checks
6824 The maximum number of runtime checks that can be performed when
6825 doing loop versioning for alignment in the vectorizer.  See option
6826 ftree-vect-loop-version for more information.
6828 @item vect-max-version-for-alias-checks
6829 The maximum number of runtime checks that can be performed when
6830 doing loop versioning for alias in the vectorizer.  See option
6831 ftree-vect-loop-version for more information.
6833 @item max-iterations-to-track
6835 The maximum number of iterations of a loop the brute force algorithm
6836 for analysis of # of iterations of the loop tries to evaluate.
6838 @item hot-bb-count-fraction
6839 Select fraction of the maximal count of repetitions of basic block in program
6840 given basic block needs to have to be considered hot.
6842 @item hot-bb-frequency-fraction
6843 Select fraction of the maximal frequency of executions of basic block in
6844 function given basic block needs to have to be considered hot
6846 @item max-predicted-iterations
6847 The maximum number of loop iterations we predict statically.  This is useful
6848 in cases where function contain single loop with known bound and other loop
6849 with unknown.  We predict the known number of iterations correctly, while
6850 the unknown number of iterations average to roughly 10.  This means that the
6851 loop without bounds would appear artificially cold relative to the other one.
6853 @item tracer-dynamic-coverage
6854 @itemx tracer-dynamic-coverage-feedback
6856 This value is used to limit superblock formation once the given percentage of
6857 executed instructions is covered.  This limits unnecessary code size
6858 expansion.
6860 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6861 feedback is available.  The real profiles (as opposed to statically estimated
6862 ones) are much less balanced allowing the threshold to be larger value.
6864 @item tracer-max-code-growth
6865 Stop tail duplication once code growth has reached given percentage.  This is
6866 rather hokey argument, as most of the duplicates will be eliminated later in
6867 cross jumping, so it may be set to much higher values than is the desired code
6868 growth.
6870 @item tracer-min-branch-ratio
6872 Stop reverse growth when the reverse probability of best edge is less than this
6873 threshold (in percent).
6875 @item tracer-min-branch-ratio
6876 @itemx tracer-min-branch-ratio-feedback
6878 Stop forward growth if the best edge do have probability lower than this
6879 threshold.
6881 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6882 compilation for profile feedback and one for compilation without.  The value
6883 for compilation with profile feedback needs to be more conservative (higher) in
6884 order to make tracer effective.
6886 @item max-cse-path-length
6888 Maximum number of basic blocks on path that cse considers.  The default is 10.
6890 @item max-cse-insns
6891 The maximum instructions CSE process before flushing. The default is 1000.
6893 @item max-aliased-vops
6895 Maximum number of virtual operands per function allowed to represent
6896 aliases before triggering the alias partitioning heuristic.  Alias
6897 partitioning reduces compile times and memory consumption needed for
6898 aliasing at the expense of precision loss in alias information.  The
6899 default value for this parameter is 100 for -O1, 500 for -O2 and 1000
6900 for -O3.
6902 Notice that if a function contains more memory statements than the
6903 value of this parameter, it is not really possible to achieve this
6904 reduction.  In this case, the compiler will use the number of memory
6905 statements as the value for @option{max-aliased-vops}.
6907 @item avg-aliased-vops
6909 Average number of virtual operands per statement allowed to represent
6910 aliases before triggering the alias partitioning heuristic.  This
6911 works in conjunction with @option{max-aliased-vops}.  If a function
6912 contains more than @option{max-aliased-vops} virtual operators, then
6913 memory symbols will be grouped into memory partitions until either the
6914 total number of virtual operators is below @option{max-aliased-vops}
6915 or the average number of virtual operators per memory statement is
6916 below @option{avg-aliased-vops}.  The default value for this parameter
6917 is 1 for -O1 and -O2, and 3 for -O3.
6919 @item ggc-min-expand
6921 GCC uses a garbage collector to manage its own memory allocation.  This
6922 parameter specifies the minimum percentage by which the garbage
6923 collector's heap should be allowed to expand between collections.
6924 Tuning this may improve compilation speed; it has no effect on code
6925 generation.
6927 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6928 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6929 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6930 GCC is not able to calculate RAM on a particular platform, the lower
6931 bound of 30% is used.  Setting this parameter and
6932 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6933 every opportunity.  This is extremely slow, but can be useful for
6934 debugging.
6936 @item ggc-min-heapsize
6938 Minimum size of the garbage collector's heap before it begins bothering
6939 to collect garbage.  The first collection occurs after the heap expands
6940 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6941 tuning this may improve compilation speed, and has no effect on code
6942 generation.
6944 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6945 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6946 with a lower bound of 4096 (four megabytes) and an upper bound of
6947 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6948 particular platform, the lower bound is used.  Setting this parameter
6949 very large effectively disables garbage collection.  Setting this
6950 parameter and @option{ggc-min-expand} to zero causes a full collection
6951 to occur at every opportunity.
6953 @item max-reload-search-insns
6954 The maximum number of instruction reload should look backward for equivalent
6955 register.  Increasing values mean more aggressive optimization, making the
6956 compile time increase with probably slightly better performance.  The default
6957 value is 100.
6959 @item max-cselib-memory-locations
6960 The maximum number of memory locations cselib should take into account.
6961 Increasing values mean more aggressive optimization, making the compile time
6962 increase with probably slightly better performance.  The default value is 500.
6964 @item max-flow-memory-locations
6965 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6966 The default value is 100.
6968 @item reorder-blocks-duplicate
6969 @itemx reorder-blocks-duplicate-feedback
6971 Used by basic block reordering pass to decide whether to use unconditional
6972 branch or duplicate the code on its destination.  Code is duplicated when its
6973 estimated size is smaller than this value multiplied by the estimated size of
6974 unconditional jump in the hot spots of the program.
6976 The @option{reorder-block-duplicate-feedback} is used only when profile
6977 feedback is available and may be set to higher values than
6978 @option{reorder-block-duplicate} since information about the hot spots is more
6979 accurate.
6981 @item max-sched-ready-insns
6982 The maximum number of instructions ready to be issued the scheduler should
6983 consider at any given time during the first scheduling pass.  Increasing
6984 values mean more thorough searches, making the compilation time increase
6985 with probably little benefit.  The default value is 100.
6987 @item max-sched-region-blocks
6988 The maximum number of blocks in a region to be considered for
6989 interblock scheduling.  The default value is 10.
6991 @item max-sched-region-insns
6992 The maximum number of insns in a region to be considered for
6993 interblock scheduling.  The default value is 100.
6995 @item min-spec-prob
6996 The minimum probability (in percents) of reaching a source block
6997 for interblock speculative scheduling.  The default value is 40.
6999 @item max-sched-extend-regions-iters
7000 The maximum number of iterations through CFG to extend regions.
7001 0 - disable region extension,
7002 N - do at most N iterations.
7003 The default value is 0.
7005 @item max-sched-insn-conflict-delay
7006 The maximum conflict delay for an insn to be considered for speculative motion.
7007 The default value is 3.
7009 @item sched-spec-prob-cutoff
7010 The minimal probability of speculation success (in percents), so that
7011 speculative insn will be scheduled.
7012 The default value is 40.
7014 @item max-last-value-rtl
7016 The maximum size measured as number of RTLs that can be recorded in an expression
7017 in combiner for a pseudo register as last known value of that register.  The default
7018 is 10000.
7020 @item integer-share-limit
7021 Small integer constants can use a shared data structure, reducing the
7022 compiler's memory usage and increasing its speed.  This sets the maximum
7023 value of a shared integer constant's.  The default value is 256.
7025 @item min-virtual-mappings
7026 Specifies the minimum number of virtual mappings in the incremental
7027 SSA updater that should be registered to trigger the virtual mappings
7028 heuristic defined by virtual-mappings-ratio.  The default value is
7029 100.
7031 @item virtual-mappings-ratio
7032 If the number of virtual mappings is virtual-mappings-ratio bigger
7033 than the number of virtual symbols to be updated, then the incremental
7034 SSA updater switches to a full update for those symbols.  The default
7035 ratio is 3.
7037 @item ssp-buffer-size
7038 The minimum size of buffers (i.e. arrays) that will receive stack smashing
7039 protection when @option{-fstack-protection} is used.
7041 @item max-jump-thread-duplication-stmts
7042 Maximum number of statements allowed in a block that needs to be
7043 duplicated when threading jumps.
7045 @item max-fields-for-field-sensitive
7046 Maximum number of fields in a structure we will treat in
7047 a field sensitive manner during pointer analysis.
7049 @item prefetch-latency
7050 Estimate on average number of instructions that are executed before
7051 prefetch finishes.  The distance we prefetch ahead is proportional
7052 to this constant.  Increasing this number may also lead to less
7053 streams being prefetched (see @option{simultaneous-prefetches}).
7055 @item simultaneous-prefetches
7056 Maximum number of prefetches that can run at the same time.
7058 @item l1-cache-line-size
7059 The size of cache line in L1 cache, in bytes.
7061 @item l1-cache-size
7062 The size of L1 cache, in kilobytes.
7064 @item l2-cache-size
7065 The size of L2 cache, in kilobytes.
7067 @item use-canonical-types
7068 Whether the compiler should use the ``canonical'' type system.  By
7069 default, this should always be 1, which uses a more efficient internal
7070 mechanism for comparing types in C++ and Objective-C++.  However, if
7071 bugs in the canonical type system are causing compilation failures,
7072 set this value to 0 to disable canonical types.
7074 @end table
7075 @end table
7077 @node Preprocessor Options
7078 @section Options Controlling the Preprocessor
7079 @cindex preprocessor options
7080 @cindex options, preprocessor
7082 These options control the C preprocessor, which is run on each C source
7083 file before actual compilation.
7085 If you use the @option{-E} option, nothing is done except preprocessing.
7086 Some of these options make sense only together with @option{-E} because
7087 they cause the preprocessor output to be unsuitable for actual
7088 compilation.
7090 @table @gcctabopt
7091 @opindex Wp
7092 You can use @option{-Wp,@var{option}} to bypass the compiler driver
7093 and pass @var{option} directly through to the preprocessor.  If
7094 @var{option} contains commas, it is split into multiple options at the
7095 commas.  However, many options are modified, translated or interpreted
7096 by the compiler driver before being passed to the preprocessor, and
7097 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
7098 interface is undocumented and subject to change, so whenever possible
7099 you should avoid using @option{-Wp} and let the driver handle the
7100 options instead.
7102 @item -Xpreprocessor @var{option}
7103 @opindex preprocessor
7104 Pass @var{option} as an option to the preprocessor.  You can use this to
7105 supply system-specific preprocessor options which GCC does not know how to
7106 recognize.
7108 If you want to pass an option that takes an argument, you must use
7109 @option{-Xpreprocessor} twice, once for the option and once for the argument.
7110 @end table
7112 @include cppopts.texi
7114 @node Assembler Options
7115 @section Passing Options to the Assembler
7117 @c prevent bad page break with this line
7118 You can pass options to the assembler.
7120 @table @gcctabopt
7121 @item -Wa,@var{option}
7122 @opindex Wa
7123 Pass @var{option} as an option to the assembler.  If @var{option}
7124 contains commas, it is split into multiple options at the commas.
7126 @item -Xassembler @var{option}
7127 @opindex Xassembler
7128 Pass @var{option} as an option to the assembler.  You can use this to
7129 supply system-specific assembler options which GCC does not know how to
7130 recognize.
7132 If you want to pass an option that takes an argument, you must use
7133 @option{-Xassembler} twice, once for the option and once for the argument.
7135 @end table
7137 @node Link Options
7138 @section Options for Linking
7139 @cindex link options
7140 @cindex options, linking
7142 These options come into play when the compiler links object files into
7143 an executable output file.  They are meaningless if the compiler is
7144 not doing a link step.
7146 @table @gcctabopt
7147 @cindex file names
7148 @item @var{object-file-name}
7149 A file name that does not end in a special recognized suffix is
7150 considered to name an object file or library.  (Object files are
7151 distinguished from libraries by the linker according to the file
7152 contents.)  If linking is done, these object files are used as input
7153 to the linker.
7155 @item -c
7156 @itemx -S
7157 @itemx -E
7158 @opindex c
7159 @opindex S
7160 @opindex E
7161 If any of these options is used, then the linker is not run, and
7162 object file names should not be used as arguments.  @xref{Overall
7163 Options}.
7165 @cindex Libraries
7166 @item -l@var{library}
7167 @itemx -l @var{library}
7168 @opindex l
7169 Search the library named @var{library} when linking.  (The second
7170 alternative with the library as a separate argument is only for
7171 POSIX compliance and is not recommended.)
7173 It makes a difference where in the command you write this option; the
7174 linker searches and processes libraries and object files in the order they
7175 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
7176 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
7177 to functions in @samp{z}, those functions may not be loaded.
7179 The linker searches a standard list of directories for the library,
7180 which is actually a file named @file{lib@var{library}.a}.  The linker
7181 then uses this file as if it had been specified precisely by name.
7183 The directories searched include several standard system directories
7184 plus any that you specify with @option{-L}.
7186 Normally the files found this way are library files---archive files
7187 whose members are object files.  The linker handles an archive file by
7188 scanning through it for members which define symbols that have so far
7189 been referenced but not defined.  But if the file that is found is an
7190 ordinary object file, it is linked in the usual fashion.  The only
7191 difference between using an @option{-l} option and specifying a file name
7192 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
7193 and searches several directories.
7195 @item -lobjc
7196 @opindex lobjc
7197 You need this special case of the @option{-l} option in order to
7198 link an Objective-C or Objective-C++ program.
7200 @item -nostartfiles
7201 @opindex nostartfiles
7202 Do not use the standard system startup files when linking.
7203 The standard system libraries are used normally, unless @option{-nostdlib}
7204 or @option{-nodefaultlibs} is used.
7206 @item -nodefaultlibs
7207 @opindex nodefaultlibs
7208 Do not use the standard system libraries when linking.
7209 Only the libraries you specify will be passed to the linker.
7210 The standard startup files are used normally, unless @option{-nostartfiles}
7211 is used.  The compiler may generate calls to @code{memcmp},
7212 @code{memset}, @code{memcpy} and @code{memmove}.
7213 These entries are usually resolved by entries in
7214 libc.  These entry points should be supplied through some other
7215 mechanism when this option is specified.
7217 @item -nostdlib
7218 @opindex nostdlib
7219 Do not use the standard system startup files or libraries when linking.
7220 No startup files and only the libraries you specify will be passed to
7221 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
7222 @code{memcpy} and @code{memmove}.
7223 These entries are usually resolved by entries in
7224 libc.  These entry points should be supplied through some other
7225 mechanism when this option is specified.
7227 @cindex @option{-lgcc}, use with @option{-nostdlib}
7228 @cindex @option{-nostdlib} and unresolved references
7229 @cindex unresolved references and @option{-nostdlib}
7230 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
7231 @cindex @option{-nodefaultlibs} and unresolved references
7232 @cindex unresolved references and @option{-nodefaultlibs}
7233 One of the standard libraries bypassed by @option{-nostdlib} and
7234 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
7235 that GCC uses to overcome shortcomings of particular machines, or special
7236 needs for some languages.
7237 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
7238 Collection (GCC) Internals},
7239 for more discussion of @file{libgcc.a}.)
7240 In most cases, you need @file{libgcc.a} even when you want to avoid
7241 other standard libraries.  In other words, when you specify @option{-nostdlib}
7242 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
7243 This ensures that you have no unresolved references to internal GCC
7244 library subroutines.  (For example, @samp{__main}, used to ensure C++
7245 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
7246 GNU Compiler Collection (GCC) Internals}.)
7248 @item -pie
7249 @opindex pie
7250 Produce a position independent executable on targets which support it.
7251 For predictable results, you must also specify the same set of options
7252 that were used to generate code (@option{-fpie}, @option{-fPIE},
7253 or model suboptions) when you specify this option.
7255 @item -rdynamic
7256 @opindex rdynamic
7257 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
7258 that support it. This instructs the linker to add all symbols, not
7259 only used ones, to the dynamic symbol table. This option is needed
7260 for some uses of @code{dlopen} or to allow obtaining backtraces
7261 from within a program.
7263 @item -s
7264 @opindex s
7265 Remove all symbol table and relocation information from the executable.
7267 @item -static
7268 @opindex static
7269 On systems that support dynamic linking, this prevents linking with the shared
7270 libraries.  On other systems, this option has no effect.
7272 @item -shared
7273 @opindex shared
7274 Produce a shared object which can then be linked with other objects to
7275 form an executable.  Not all systems support this option.  For predictable
7276 results, you must also specify the same set of options that were used to
7277 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
7278 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
7279 needs to build supplementary stub code for constructors to work.  On
7280 multi-libbed systems, @samp{gcc -shared} must select the correct support
7281 libraries to link against.  Failing to supply the correct flags may lead
7282 to subtle defects.  Supplying them in cases where they are not necessary
7283 is innocuous.}
7285 @item -shared-libgcc
7286 @itemx -static-libgcc
7287 @opindex shared-libgcc
7288 @opindex static-libgcc
7289 On systems that provide @file{libgcc} as a shared library, these options
7290 force the use of either the shared or static version respectively.
7291 If no shared version of @file{libgcc} was built when the compiler was
7292 configured, these options have no effect.
7294 There are several situations in which an application should use the
7295 shared @file{libgcc} instead of the static version.  The most common
7296 of these is when the application wishes to throw and catch exceptions
7297 across different shared libraries.  In that case, each of the libraries
7298 as well as the application itself should use the shared @file{libgcc}.
7300 Therefore, the G++ and GCJ drivers automatically add
7301 @option{-shared-libgcc} whenever you build a shared library or a main
7302 executable, because C++ and Java programs typically use exceptions, so
7303 this is the right thing to do.
7305 If, instead, you use the GCC driver to create shared libraries, you may
7306 find that they will not always be linked with the shared @file{libgcc}.
7307 If GCC finds, at its configuration time, that you have a non-GNU linker
7308 or a GNU linker that does not support option @option{--eh-frame-hdr},
7309 it will link the shared version of @file{libgcc} into shared libraries
7310 by default.  Otherwise, it will take advantage of the linker and optimize
7311 away the linking with the shared version of @file{libgcc}, linking with
7312 the static version of libgcc by default.  This allows exceptions to
7313 propagate through such shared libraries, without incurring relocation
7314 costs at library load time.
7316 However, if a library or main executable is supposed to throw or catch
7317 exceptions, you must link it using the G++ or GCJ driver, as appropriate
7318 for the languages used in the program, or using the option
7319 @option{-shared-libgcc}, such that it is linked with the shared
7320 @file{libgcc}.
7322 @item -symbolic
7323 @opindex symbolic
7324 Bind references to global symbols when building a shared object.  Warn
7325 about any unresolved references (unless overridden by the link editor
7326 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
7327 this option.
7329 @item -Xlinker @var{option}
7330 @opindex Xlinker
7331 Pass @var{option} as an option to the linker.  You can use this to
7332 supply system-specific linker options which GCC does not know how to
7333 recognize.
7335 If you want to pass an option that takes an argument, you must use
7336 @option{-Xlinker} twice, once for the option and once for the argument.
7337 For example, to pass @option{-assert definitions}, you must write
7338 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
7339 @option{-Xlinker "-assert definitions"}, because this passes the entire
7340 string as a single argument, which is not what the linker expects.
7342 @item -Wl,@var{option}
7343 @opindex Wl
7344 Pass @var{option} as an option to the linker.  If @var{option} contains
7345 commas, it is split into multiple options at the commas.
7347 @item -u @var{symbol}
7348 @opindex u
7349 Pretend the symbol @var{symbol} is undefined, to force linking of
7350 library modules to define it.  You can use @option{-u} multiple times with
7351 different symbols to force loading of additional library modules.
7352 @end table
7354 @node Directory Options
7355 @section Options for Directory Search
7356 @cindex directory options
7357 @cindex options, directory search
7358 @cindex search path
7360 These options specify directories to search for header files, for
7361 libraries and for parts of the compiler:
7363 @table @gcctabopt
7364 @item -I@var{dir}
7365 @opindex I
7366 Add the directory @var{dir} to the head of the list of directories to be
7367 searched for header files.  This can be used to override a system header
7368 file, substituting your own version, since these directories are
7369 searched before the system header file directories.  However, you should
7370 not use this option to add directories that contain vendor-supplied
7371 system header files (use @option{-isystem} for that).  If you use more than
7372 one @option{-I} option, the directories are scanned in left-to-right
7373 order; the standard system directories come after.
7375 If a standard system include directory, or a directory specified with
7376 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
7377 option will be ignored.  The directory will still be searched but as a
7378 system directory at its normal position in the system include chain.
7379 This is to ensure that GCC's procedure to fix buggy system headers and
7380 the ordering for the include_next directive are not inadvertently changed.
7381 If you really need to change the search order for system directories,
7382 use the @option{-nostdinc} and/or @option{-isystem} options.
7384 @item -iquote@var{dir}
7385 @opindex iquote
7386 Add the directory @var{dir} to the head of the list of directories to
7387 be searched for header files only for the case of @samp{#include
7388 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
7389 otherwise just like @option{-I}.
7391 @item -L@var{dir}
7392 @opindex L
7393 Add directory @var{dir} to the list of directories to be searched
7394 for @option{-l}.
7396 @item -B@var{prefix}
7397 @opindex B
7398 This option specifies where to find the executables, libraries,
7399 include files, and data files of the compiler itself.
7401 The compiler driver program runs one or more of the subprograms
7402 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
7403 @var{prefix} as a prefix for each program it tries to run, both with and
7404 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
7406 For each subprogram to be run, the compiler driver first tries the
7407 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
7408 was not specified, the driver tries two standard prefixes, which are
7409 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
7410 those results in a file name that is found, the unmodified program
7411 name is searched for using the directories specified in your
7412 @env{PATH} environment variable.
7414 The compiler will check to see if the path provided by the @option{-B}
7415 refers to a directory, and if necessary it will add a directory
7416 separator character at the end of the path.
7418 @option{-B} prefixes that effectively specify directory names also apply
7419 to libraries in the linker, because the compiler translates these
7420 options into @option{-L} options for the linker.  They also apply to
7421 includes files in the preprocessor, because the compiler translates these
7422 options into @option{-isystem} options for the preprocessor.  In this case,
7423 the compiler appends @samp{include} to the prefix.
7425 The run-time support file @file{libgcc.a} can also be searched for using
7426 the @option{-B} prefix, if needed.  If it is not found there, the two
7427 standard prefixes above are tried, and that is all.  The file is left
7428 out of the link if it is not found by those means.
7430 Another way to specify a prefix much like the @option{-B} prefix is to use
7431 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
7432 Variables}.
7434 As a special kludge, if the path provided by @option{-B} is
7435 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
7436 9, then it will be replaced by @file{[dir/]include}.  This is to help
7437 with boot-strapping the compiler.
7439 @item -specs=@var{file}
7440 @opindex specs
7441 Process @var{file} after the compiler reads in the standard @file{specs}
7442 file, in order to override the defaults that the @file{gcc} driver
7443 program uses when determining what switches to pass to @file{cc1},
7444 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
7445 @option{-specs=@var{file}} can be specified on the command line, and they
7446 are processed in order, from left to right.
7448 @item --sysroot=@var{dir}
7449 @opindex sysroot
7450 Use @var{dir} as the logical root directory for headers and libraries.
7451 For example, if the compiler would normally search for headers in
7452 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
7453 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
7455 If you use both this option and the @option{-isysroot} option, then
7456 the @option{--sysroot} option will apply to libraries, but the
7457 @option{-isysroot} option will apply to header files.
7459 The GNU linker (beginning with version 2.16) has the necessary support
7460 for this option.  If your linker does not support this option, the
7461 header file aspect of @option{--sysroot} will still work, but the
7462 library aspect will not.
7464 @item -I-
7465 @opindex I-
7466 This option has been deprecated.  Please use @option{-iquote} instead for
7467 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
7468 Any directories you specify with @option{-I} options before the @option{-I-}
7469 option are searched only for the case of @samp{#include "@var{file}"};
7470 they are not searched for @samp{#include <@var{file}>}.
7472 If additional directories are specified with @option{-I} options after
7473 the @option{-I-}, these directories are searched for all @samp{#include}
7474 directives.  (Ordinarily @emph{all} @option{-I} directories are used
7475 this way.)
7477 In addition, the @option{-I-} option inhibits the use of the current
7478 directory (where the current input file came from) as the first search
7479 directory for @samp{#include "@var{file}"}.  There is no way to
7480 override this effect of @option{-I-}.  With @option{-I.} you can specify
7481 searching the directory which was current when the compiler was
7482 invoked.  That is not exactly the same as what the preprocessor does
7483 by default, but it is often satisfactory.
7485 @option{-I-} does not inhibit the use of the standard system directories
7486 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
7487 independent.
7488 @end table
7490 @c man end
7492 @node Spec Files
7493 @section Specifying subprocesses and the switches to pass to them
7494 @cindex Spec Files
7496 @command{gcc} is a driver program.  It performs its job by invoking a
7497 sequence of other programs to do the work of compiling, assembling and
7498 linking.  GCC interprets its command-line parameters and uses these to
7499 deduce which programs it should invoke, and which command-line options
7500 it ought to place on their command lines.  This behavior is controlled
7501 by @dfn{spec strings}.  In most cases there is one spec string for each
7502 program that GCC can invoke, but a few programs have multiple spec
7503 strings to control their behavior.  The spec strings built into GCC can
7504 be overridden by using the @option{-specs=} command-line switch to specify
7505 a spec file.
7507 @dfn{Spec files} are plaintext files that are used to construct spec
7508 strings.  They consist of a sequence of directives separated by blank
7509 lines.  The type of directive is determined by the first non-whitespace
7510 character on the line and it can be one of the following:
7512 @table @code
7513 @item %@var{command}
7514 Issues a @var{command} to the spec file processor.  The commands that can
7515 appear here are:
7517 @table @code
7518 @item %include <@var{file}>
7519 @cindex %include
7520 Search for @var{file} and insert its text at the current point in the
7521 specs file.
7523 @item %include_noerr <@var{file}>
7524 @cindex %include_noerr
7525 Just like @samp{%include}, but do not generate an error message if the include
7526 file cannot be found.
7528 @item %rename @var{old_name} @var{new_name}
7529 @cindex %rename
7530 Rename the spec string @var{old_name} to @var{new_name}.
7532 @end table
7534 @item *[@var{spec_name}]:
7535 This tells the compiler to create, override or delete the named spec
7536 string.  All lines after this directive up to the next directive or
7537 blank line are considered to be the text for the spec string.  If this
7538 results in an empty string then the spec will be deleted.  (Or, if the
7539 spec did not exist, then nothing will happened.)  Otherwise, if the spec
7540 does not currently exist a new spec will be created.  If the spec does
7541 exist then its contents will be overridden by the text of this
7542 directive, unless the first character of that text is the @samp{+}
7543 character, in which case the text will be appended to the spec.
7545 @item [@var{suffix}]:
7546 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
7547 and up to the next directive or blank line are considered to make up the
7548 spec string for the indicated suffix.  When the compiler encounters an
7549 input file with the named suffix, it will processes the spec string in
7550 order to work out how to compile that file.  For example:
7552 @smallexample
7553 .ZZ:
7554 z-compile -input %i
7555 @end smallexample
7557 This says that any input file whose name ends in @samp{.ZZ} should be
7558 passed to the program @samp{z-compile}, which should be invoked with the
7559 command-line switch @option{-input} and with the result of performing the
7560 @samp{%i} substitution.  (See below.)
7562 As an alternative to providing a spec string, the text that follows a
7563 suffix directive can be one of the following:
7565 @table @code
7566 @item @@@var{language}
7567 This says that the suffix is an alias for a known @var{language}.  This is
7568 similar to using the @option{-x} command-line switch to GCC to specify a
7569 language explicitly.  For example:
7571 @smallexample
7572 .ZZ:
7573 @@c++
7574 @end smallexample
7576 Says that .ZZ files are, in fact, C++ source files.
7578 @item #@var{name}
7579 This causes an error messages saying:
7581 @smallexample
7582 @var{name} compiler not installed on this system.
7583 @end smallexample
7584 @end table
7586 GCC already has an extensive list of suffixes built into it.
7587 This directive will add an entry to the end of the list of suffixes, but
7588 since the list is searched from the end backwards, it is effectively
7589 possible to override earlier entries using this technique.
7591 @end table
7593 GCC has the following spec strings built into it.  Spec files can
7594 override these strings or create their own.  Note that individual
7595 targets can also add their own spec strings to this list.
7597 @smallexample
7598 asm          Options to pass to the assembler
7599 asm_final    Options to pass to the assembler post-processor
7600 cpp          Options to pass to the C preprocessor
7601 cc1          Options to pass to the C compiler
7602 cc1plus      Options to pass to the C++ compiler
7603 endfile      Object files to include at the end of the link
7604 link         Options to pass to the linker
7605 lib          Libraries to include on the command line to the linker
7606 libgcc       Decides which GCC support library to pass to the linker
7607 linker       Sets the name of the linker
7608 predefines   Defines to be passed to the C preprocessor
7609 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7610              by default
7611 startfile    Object files to include at the start of the link
7612 @end smallexample
7614 Here is a small example of a spec file:
7616 @smallexample
7617 %rename lib                 old_lib
7619 *lib:
7620 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7621 @end smallexample
7623 This example renames the spec called @samp{lib} to @samp{old_lib} and
7624 then overrides the previous definition of @samp{lib} with a new one.
7625 The new definition adds in some extra command-line options before
7626 including the text of the old definition.
7628 @dfn{Spec strings} are a list of command-line options to be passed to their
7629 corresponding program.  In addition, the spec strings can contain
7630 @samp{%}-prefixed sequences to substitute variable text or to
7631 conditionally insert text into the command line.  Using these constructs
7632 it is possible to generate quite complex command lines.
7634 Here is a table of all defined @samp{%}-sequences for spec
7635 strings.  Note that spaces are not generated automatically around the
7636 results of expanding these sequences.  Therefore you can concatenate them
7637 together or combine them with constant text in a single argument.
7639 @table @code
7640 @item %%
7641 Substitute one @samp{%} into the program name or argument.
7643 @item %i
7644 Substitute the name of the input file being processed.
7646 @item %b
7647 Substitute the basename of the input file being processed.
7648 This is the substring up to (and not including) the last period
7649 and not including the directory.
7651 @item %B
7652 This is the same as @samp{%b}, but include the file suffix (text after
7653 the last period).
7655 @item %d
7656 Marks the argument containing or following the @samp{%d} as a
7657 temporary file name, so that that file will be deleted if GCC exits
7658 successfully.  Unlike @samp{%g}, this contributes no text to the
7659 argument.
7661 @item %g@var{suffix}
7662 Substitute a file name that has suffix @var{suffix} and is chosen
7663 once per compilation, and mark the argument in the same way as
7664 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7665 name is now chosen in a way that is hard to predict even when previously
7666 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7667 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7668 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7669 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7670 was simply substituted with a file name chosen once per compilation,
7671 without regard to any appended suffix (which was therefore treated
7672 just like ordinary text), making such attacks more likely to succeed.
7674 @item %u@var{suffix}
7675 Like @samp{%g}, but generates a new temporary file name even if
7676 @samp{%u@var{suffix}} was already seen.
7678 @item %U@var{suffix}
7679 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7680 new one if there is no such last file name.  In the absence of any
7681 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7682 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7683 would involve the generation of two distinct file names, one
7684 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7685 simply substituted with a file name chosen for the previous @samp{%u},
7686 without regard to any appended suffix.
7688 @item %j@var{suffix}
7689 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7690 writable, and if save-temps is off; otherwise, substitute the name
7691 of a temporary file, just like @samp{%u}.  This temporary file is not
7692 meant for communication between processes, but rather as a junk
7693 disposal mechanism.
7695 @item %|@var{suffix}
7696 @itemx %m@var{suffix}
7697 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7698 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7699 all.  These are the two most common ways to instruct a program that it
7700 should read from standard input or write to standard output.  If you
7701 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7702 construct: see for example @file{f/lang-specs.h}.
7704 @item %.@var{SUFFIX}
7705 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7706 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7707 terminated by the next space or %.
7709 @item %w
7710 Marks the argument containing or following the @samp{%w} as the
7711 designated output file of this compilation.  This puts the argument
7712 into the sequence of arguments that @samp{%o} will substitute later.
7714 @item %o
7715 Substitutes the names of all the output files, with spaces
7716 automatically placed around them.  You should write spaces
7717 around the @samp{%o} as well or the results are undefined.
7718 @samp{%o} is for use in the specs for running the linker.
7719 Input files whose names have no recognized suffix are not compiled
7720 at all, but they are included among the output files, so they will
7721 be linked.
7723 @item %O
7724 Substitutes the suffix for object files.  Note that this is
7725 handled specially when it immediately follows @samp{%g, %u, or %U},
7726 because of the need for those to form complete file names.  The
7727 handling is such that @samp{%O} is treated exactly as if it had already
7728 been substituted, except that @samp{%g, %u, and %U} do not currently
7729 support additional @var{suffix} characters following @samp{%O} as they would
7730 following, for example, @samp{.o}.
7732 @item %p
7733 Substitutes the standard macro predefinitions for the
7734 current target machine.  Use this when running @code{cpp}.
7736 @item %P
7737 Like @samp{%p}, but puts @samp{__} before and after the name of each
7738 predefined macro, except for macros that start with @samp{__} or with
7739 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7742 @item %I
7743 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7744 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7745 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7746 and @option{-imultilib} as necessary.
7748 @item %s
7749 Current argument is the name of a library or startup file of some sort.
7750 Search for that file in a standard list of directories and substitute
7751 the full name found.
7753 @item %e@var{str}
7754 Print @var{str} as an error message.  @var{str} is terminated by a newline.
7755 Use this when inconsistent options are detected.
7757 @item %(@var{name})
7758 Substitute the contents of spec string @var{name} at this point.
7760 @item %[@var{name}]
7761 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7763 @item %x@{@var{option}@}
7764 Accumulate an option for @samp{%X}.
7766 @item %X
7767 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7768 spec string.
7770 @item %Y
7771 Output the accumulated assembler options specified by @option{-Wa}.
7773 @item %Z
7774 Output the accumulated preprocessor options specified by @option{-Wp}.
7776 @item %a
7777 Process the @code{asm} spec.  This is used to compute the
7778 switches to be passed to the assembler.
7780 @item %A
7781 Process the @code{asm_final} spec.  This is a spec string for
7782 passing switches to an assembler post-processor, if such a program is
7783 needed.
7785 @item %l
7786 Process the @code{link} spec.  This is the spec for computing the
7787 command line passed to the linker.  Typically it will make use of the
7788 @samp{%L %G %S %D and %E} sequences.
7790 @item %D
7791 Dump out a @option{-L} option for each directory that GCC believes might
7792 contain startup files.  If the target supports multilibs then the
7793 current multilib directory will be prepended to each of these paths.
7795 @item %L
7796 Process the @code{lib} spec.  This is a spec string for deciding which
7797 libraries should be included on the command line to the linker.
7799 @item %G
7800 Process the @code{libgcc} spec.  This is a spec string for deciding
7801 which GCC support library should be included on the command line to the linker.
7803 @item %S
7804 Process the @code{startfile} spec.  This is a spec for deciding which
7805 object files should be the first ones passed to the linker.  Typically
7806 this might be a file named @file{crt0.o}.
7808 @item %E
7809 Process the @code{endfile} spec.  This is a spec string that specifies
7810 the last object files that will be passed to the linker.
7812 @item %C
7813 Process the @code{cpp} spec.  This is used to construct the arguments
7814 to be passed to the C preprocessor.
7816 @item %1
7817 Process the @code{cc1} spec.  This is used to construct the options to be
7818 passed to the actual C compiler (@samp{cc1}).
7820 @item %2
7821 Process the @code{cc1plus} spec.  This is used to construct the options to be
7822 passed to the actual C++ compiler (@samp{cc1plus}).
7824 @item %*
7825 Substitute the variable part of a matched option.  See below.
7826 Note that each comma in the substituted string is replaced by
7827 a single space.
7829 @item %<@code{S}
7830 Remove all occurrences of @code{-S} from the command line.  Note---this
7831 command is position dependent.  @samp{%} commands in the spec string
7832 before this one will see @code{-S}, @samp{%} commands in the spec string
7833 after this one will not.
7835 @item %:@var{function}(@var{args})
7836 Call the named function @var{function}, passing it @var{args}.
7837 @var{args} is first processed as a nested spec string, then split
7838 into an argument vector in the usual fashion.  The function returns
7839 a string which is processed as if it had appeared literally as part
7840 of the current spec.
7842 The following built-in spec functions are provided:
7844 @table @code
7845 @item @code{getenv}
7846 The @code{getenv} spec function takes two arguments: an environment
7847 variable name and a string.  If the environment variable is not
7848 defined, a fatal error is issued.  Otherwise, the return value is the
7849 value of the environment variable concatenated with the string.  For
7850 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
7852 @smallexample
7853 %:getenv(TOPDIR /include)
7854 @end smallexample
7856 expands to @file{/path/to/top/include}.
7858 @item @code{if-exists}
7859 The @code{if-exists} spec function takes one argument, an absolute
7860 pathname to a file.  If the file exists, @code{if-exists} returns the
7861 pathname.  Here is a small example of its usage:
7863 @smallexample
7864 *startfile:
7865 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7866 @end smallexample
7868 @item @code{if-exists-else}
7869 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7870 spec function, except that it takes two arguments.  The first argument is
7871 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7872 returns the pathname.  If it does not exist, it returns the second argument.
7873 This way, @code{if-exists-else} can be used to select one file or another,
7874 based on the existence of the first.  Here is a small example of its usage:
7876 @smallexample
7877 *startfile:
7878 crt0%O%s %:if-exists(crti%O%s) \
7879 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7880 @end smallexample
7882 @item @code{replace-outfile}
7883 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7884 first argument in the outfiles array and replaces it with the second argument.  Here
7885 is a small example of its usage:
7887 @smallexample
7888 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7889 @end smallexample
7891 @item @code{print-asm-header}
7892 The @code{print-asm-header} function takes no arguments and simply
7893 prints a banner like:
7895 @smallexample
7896 Assembler options
7897 =================
7899 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
7900 @end smallexample
7902 It is used to separate compiler options from assembler options
7903 in the @option{--target-help} output.
7904 @end table
7906 @item %@{@code{S}@}
7907 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7908 If that switch was not specified, this substitutes nothing.  Note that
7909 the leading dash is omitted when specifying this option, and it is
7910 automatically inserted if the substitution is performed.  Thus the spec
7911 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7912 and would output the command line option @option{-foo}.
7914 @item %W@{@code{S}@}
7915 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7916 deleted on failure.
7918 @item %@{@code{S}*@}
7919 Substitutes all the switches specified to GCC whose names start
7920 with @code{-S}, but which also take an argument.  This is used for
7921 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7922 GCC considers @option{-o foo} as being
7923 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7924 text, including the space.  Thus two arguments would be generated.
7926 @item %@{@code{S}*&@code{T}*@}
7927 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7928 (the order of @code{S} and @code{T} in the spec is not significant).
7929 There can be any number of ampersand-separated variables; for each the
7930 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7932 @item %@{@code{S}:@code{X}@}
7933 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7935 @item %@{!@code{S}:@code{X}@}
7936 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7938 @item %@{@code{S}*:@code{X}@}
7939 Substitutes @code{X} if one or more switches whose names start with
7940 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7941 once, no matter how many such switches appeared.  However, if @code{%*}
7942 appears somewhere in @code{X}, then @code{X} will be substituted once
7943 for each matching switch, with the @code{%*} replaced by the part of
7944 that switch that matched the @code{*}.
7946 @item %@{.@code{S}:@code{X}@}
7947 Substitutes @code{X}, if processing a file with suffix @code{S}.
7949 @item %@{!.@code{S}:@code{X}@}
7950 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7952 @item %@{,@code{S}:@code{X}@}
7953 Substitutes @code{X}, if processing a file for language @code{S}.
7955 @item %@{!,@code{S}:@code{X}@}
7956 Substitutes @code{X}, if not processing a file for language @code{S}.
7958 @item %@{@code{S}|@code{P}:@code{X}@}
7959 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
7960 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
7961 @code{*} sequences as well, although they have a stronger binding than
7962 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
7963 alternatives must be starred, and only the first matching alternative
7964 is substituted.
7966 For example, a spec string like this:
7968 @smallexample
7969 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7970 @end smallexample
7972 will output the following command-line options from the following input
7973 command-line options:
7975 @smallexample
7976 fred.c        -foo -baz
7977 jim.d         -bar -boggle
7978 -d fred.c     -foo -baz -boggle
7979 -d jim.d      -bar -baz -boggle
7980 @end smallexample
7982 @item %@{S:X; T:Y; :D@}
7984 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7985 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7986 be as many clauses as you need.  This may be combined with @code{.},
7987 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
7990 @end table
7992 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7993 construct may contain other nested @samp{%} constructs or spaces, or
7994 even newlines.  They are processed as usual, as described above.
7995 Trailing white space in @code{X} is ignored.  White space may also
7996 appear anywhere on the left side of the colon in these constructs,
7997 except between @code{.} or @code{*} and the corresponding word.
7999 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
8000 handled specifically in these constructs.  If another value of
8001 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
8002 @option{-W} switch is found later in the command line, the earlier
8003 switch value is ignored, except with @{@code{S}*@} where @code{S} is
8004 just one letter, which passes all matching options.
8006 The character @samp{|} at the beginning of the predicate text is used to
8007 indicate that a command should be piped to the following command, but
8008 only if @option{-pipe} is specified.
8010 It is built into GCC which switches take arguments and which do not.
8011 (You might think it would be useful to generalize this to allow each
8012 compiler's spec to say which switches take arguments.  But this cannot
8013 be done in a consistent fashion.  GCC cannot even decide which input
8014 files have been specified without knowing which switches take arguments,
8015 and it must know which input files to compile in order to tell which
8016 compilers to run).
8018 GCC also knows implicitly that arguments starting in @option{-l} are to be
8019 treated as compiler output files, and passed to the linker in their
8020 proper position among the other output files.
8022 @c man begin OPTIONS
8024 @node Target Options
8025 @section Specifying Target Machine and Compiler Version
8026 @cindex target options
8027 @cindex cross compiling
8028 @cindex specifying machine version
8029 @cindex specifying compiler version and target machine
8030 @cindex compiler version, specifying
8031 @cindex target machine, specifying
8033 The usual way to run GCC is to run the executable called @file{gcc}, or
8034 @file{<machine>-gcc} when cross-compiling, or
8035 @file{<machine>-gcc-<version>} to run a version other than the one that
8036 was installed last.  Sometimes this is inconvenient, so GCC provides
8037 options that will switch to another cross-compiler or version.
8039 @table @gcctabopt
8040 @item -b @var{machine}
8041 @opindex b
8042 The argument @var{machine} specifies the target machine for compilation.
8044 The value to use for @var{machine} is the same as was specified as the
8045 machine type when configuring GCC as a cross-compiler.  For
8046 example, if a cross-compiler was configured with @samp{configure
8047 arm-elf}, meaning to compile for an arm processor with elf binaries,
8048 then you would specify @option{-b arm-elf} to run that cross compiler.
8049 Because there are other options beginning with @option{-b}, the
8050 configuration must contain a hyphen.
8052 @item -V @var{version}
8053 @opindex V
8054 The argument @var{version} specifies which version of GCC to run.
8055 This is useful when multiple versions are installed.  For example,
8056 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
8057 @end table
8059 The @option{-V} and @option{-b} options work by running the
8060 @file{<machine>-gcc-<version>} executable, so there's no real reason to
8061 use them if you can just run that directly.
8063 @node Submodel Options
8064 @section Hardware Models and Configurations
8065 @cindex submodel options
8066 @cindex specifying hardware config
8067 @cindex hardware models and configurations, specifying
8068 @cindex machine dependent options
8070 Earlier we discussed the standard option @option{-b} which chooses among
8071 different installed compilers for completely different target
8072 machines, such as VAX vs.@: 68000 vs.@: 80386.
8074 In addition, each of these target machine types can have its own
8075 special options, starting with @samp{-m}, to choose among various
8076 hardware models or configurations---for example, 68010 vs 68020,
8077 floating coprocessor or none.  A single installed version of the
8078 compiler can compile for any model or configuration, according to the
8079 options specified.
8081 Some configurations of the compiler also support additional special
8082 options, usually for compatibility with other compilers on the same
8083 platform.
8085 @c This list is ordered alphanumerically by subsection name.
8086 @c It should be the same order and spelling as these options are listed
8087 @c in Machine Dependent Options
8089 @menu
8090 * ARC Options::
8091 * ARM Options::
8092 * AVR Options::
8093 * Blackfin Options::
8094 * CRIS Options::
8095 * CRX Options::
8096 * Darwin Options::
8097 * DEC Alpha Options::
8098 * DEC Alpha/VMS Options::
8099 * FRV Options::
8100 * GNU/Linux Options::
8101 * H8/300 Options::
8102 * HPPA Options::
8103 * i386 and x86-64 Options::
8104 * IA-64 Options::
8105 * M32C Options::
8106 * M32R/D Options::
8107 * M680x0 Options::
8108 * M68hc1x Options::
8109 * MCore Options::
8110 * MIPS Options::
8111 * MMIX Options::
8112 * MN10300 Options::
8113 * MT Options::
8114 * PDP-11 Options::
8115 * PowerPC Options::
8116 * RS/6000 and PowerPC Options::
8117 * S/390 and zSeries Options::
8118 * Score Options::
8119 * SH Options::
8120 * SPARC Options::
8121 * SPU Options::
8122 * System V Options::
8123 * TMS320C3x/C4x Options::
8124 * V850 Options::
8125 * VAX Options::
8126 * VxWorks Options::
8127 * x86-64 Options::
8128 * Xstormy16 Options::
8129 * Xtensa Options::
8130 * zSeries Options::
8131 @end menu
8133 @node ARC Options
8134 @subsection ARC Options
8135 @cindex ARC Options
8137 These options are defined for ARC implementations:
8139 @table @gcctabopt
8140 @item -EL
8141 @opindex EL
8142 Compile code for little endian mode.  This is the default.
8144 @item -EB
8145 @opindex EB
8146 Compile code for big endian mode.
8148 @item -mmangle-cpu
8149 @opindex mmangle-cpu
8150 Prepend the name of the cpu to all public symbol names.
8151 In multiple-processor systems, there are many ARC variants with different
8152 instruction and register set characteristics.  This flag prevents code
8153 compiled for one cpu to be linked with code compiled for another.
8154 No facility exists for handling variants that are ``almost identical''.
8155 This is an all or nothing option.
8157 @item -mcpu=@var{cpu}
8158 @opindex mcpu
8159 Compile code for ARC variant @var{cpu}.
8160 Which variants are supported depend on the configuration.
8161 All variants support @option{-mcpu=base}, this is the default.
8163 @item -mtext=@var{text-section}
8164 @itemx -mdata=@var{data-section}
8165 @itemx -mrodata=@var{readonly-data-section}
8166 @opindex mtext
8167 @opindex mdata
8168 @opindex mrodata
8169 Put functions, data, and readonly data in @var{text-section},
8170 @var{data-section}, and @var{readonly-data-section} respectively
8171 by default.  This can be overridden with the @code{section} attribute.
8172 @xref{Variable Attributes}.
8174 @end table
8176 @node ARM Options
8177 @subsection ARM Options
8178 @cindex ARM options
8180 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
8181 architectures:
8183 @table @gcctabopt
8184 @item -mabi=@var{name}
8185 @opindex mabi
8186 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
8187 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
8189 @item -mapcs-frame
8190 @opindex mapcs-frame
8191 Generate a stack frame that is compliant with the ARM Procedure Call
8192 Standard for all functions, even if this is not strictly necessary for
8193 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
8194 with this option will cause the stack frames not to be generated for
8195 leaf functions.  The default is @option{-mno-apcs-frame}.
8197 @item -mapcs
8198 @opindex mapcs
8199 This is a synonym for @option{-mapcs-frame}.
8201 @ignore
8202 @c not currently implemented
8203 @item -mapcs-stack-check
8204 @opindex mapcs-stack-check
8205 Generate code to check the amount of stack space available upon entry to
8206 every function (that actually uses some stack space).  If there is
8207 insufficient space available then either the function
8208 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
8209 called, depending upon the amount of stack space required.  The run time
8210 system is required to provide these functions.  The default is
8211 @option{-mno-apcs-stack-check}, since this produces smaller code.
8213 @c not currently implemented
8214 @item -mapcs-float
8215 @opindex mapcs-float
8216 Pass floating point arguments using the float point registers.  This is
8217 one of the variants of the APCS@.  This option is recommended if the
8218 target hardware has a floating point unit or if a lot of floating point
8219 arithmetic is going to be performed by the code.  The default is
8220 @option{-mno-apcs-float}, since integer only code is slightly increased in
8221 size if @option{-mapcs-float} is used.
8223 @c not currently implemented
8224 @item -mapcs-reentrant
8225 @opindex mapcs-reentrant
8226 Generate reentrant, position independent code.  The default is
8227 @option{-mno-apcs-reentrant}.
8228 @end ignore
8230 @item -mthumb-interwork
8231 @opindex mthumb-interwork
8232 Generate code which supports calling between the ARM and Thumb
8233 instruction sets.  Without this option the two instruction sets cannot
8234 be reliably used inside one program.  The default is
8235 @option{-mno-thumb-interwork}, since slightly larger code is generated
8236 when @option{-mthumb-interwork} is specified.
8238 @item -mno-sched-prolog
8239 @opindex mno-sched-prolog
8240 Prevent the reordering of instructions in the function prolog, or the
8241 merging of those instruction with the instructions in the function's
8242 body.  This means that all functions will start with a recognizable set
8243 of instructions (or in fact one of a choice from a small set of
8244 different function prologues), and this information can be used to
8245 locate the start if functions inside an executable piece of code.  The
8246 default is @option{-msched-prolog}.
8248 @item -mhard-float
8249 @opindex mhard-float
8250 Generate output containing floating point instructions.  This is the
8251 default.
8253 @item -msoft-float
8254 @opindex msoft-float
8255 Generate output containing library calls for floating point.
8256 @strong{Warning:} the requisite libraries are not available for all ARM
8257 targets.  Normally the facilities of the machine's usual C compiler are
8258 used, but this cannot be done directly in cross-compilation.  You must make
8259 your own arrangements to provide suitable library functions for
8260 cross-compilation.
8262 @option{-msoft-float} changes the calling convention in the output file;
8263 therefore, it is only useful if you compile @emph{all} of a program with
8264 this option.  In particular, you need to compile @file{libgcc.a}, the
8265 library that comes with GCC, with @option{-msoft-float} in order for
8266 this to work.
8268 @item -mfloat-abi=@var{name}
8269 @opindex mfloat-abi
8270 Specifies which ABI to use for floating point values.  Permissible values
8271 are: @samp{soft}, @samp{softfp} and @samp{hard}.
8273 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
8274 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
8275 of floating point instructions, but still uses the soft-float calling
8276 conventions.
8278 @item -mlittle-endian
8279 @opindex mlittle-endian
8280 Generate code for a processor running in little-endian mode.  This is
8281 the default for all standard configurations.
8283 @item -mbig-endian
8284 @opindex mbig-endian
8285 Generate code for a processor running in big-endian mode; the default is
8286 to compile code for a little-endian processor.
8288 @item -mwords-little-endian
8289 @opindex mwords-little-endian
8290 This option only applies when generating code for big-endian processors.
8291 Generate code for a little-endian word order but a big-endian byte
8292 order.  That is, a byte order of the form @samp{32107654}.  Note: this
8293 option should only be used if you require compatibility with code for
8294 big-endian ARM processors generated by versions of the compiler prior to
8295 2.8.
8297 @item -mcpu=@var{name}
8298 @opindex mcpu
8299 This specifies the name of the target ARM processor.  GCC uses this name
8300 to determine what kind of instructions it can emit when generating
8301 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
8302 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
8303 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
8304 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
8305 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
8306 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
8307 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
8308 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
8309 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
8310 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
8311 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
8312 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
8313 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
8314 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
8315 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
8316 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
8318 @itemx -mtune=@var{name}
8319 @opindex mtune
8320 This option is very similar to the @option{-mcpu=} option, except that
8321 instead of specifying the actual target processor type, and hence
8322 restricting which instructions can be used, it specifies that GCC should
8323 tune the performance of the code as if the target were of the type
8324 specified in this option, but still choosing the instructions that it
8325 will generate based on the cpu specified by a @option{-mcpu=} option.
8326 For some ARM implementations better performance can be obtained by using
8327 this option.
8329 @item -march=@var{name}
8330 @opindex march
8331 This specifies the name of the target ARM architecture.  GCC uses this
8332 name to determine what kind of instructions it can emit when generating
8333 assembly code.  This option can be used in conjunction with or instead
8334 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
8335 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
8336 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
8337 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
8338 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
8340 @item -mfpu=@var{name}
8341 @itemx -mfpe=@var{number}
8342 @itemx -mfp=@var{number}
8343 @opindex mfpu
8344 @opindex mfpe
8345 @opindex mfp
8346 This specifies what floating point hardware (or hardware emulation) is
8347 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
8348 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
8349 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
8350 with older versions of GCC@.
8352 If @option{-msoft-float} is specified this specifies the format of
8353 floating point values.
8355 @item -mstructure-size-boundary=@var{n}
8356 @opindex mstructure-size-boundary
8357 The size of all structures and unions will be rounded up to a multiple
8358 of the number of bits set by this option.  Permissible values are 8, 32
8359 and 64.  The default value varies for different toolchains.  For the COFF
8360 targeted toolchain the default value is 8.  A value of 64 is only allowed
8361 if the underlying ABI supports it.
8363 Specifying the larger number can produce faster, more efficient code, but
8364 can also increase the size of the program.  Different values are potentially
8365 incompatible.  Code compiled with one value cannot necessarily expect to
8366 work with code or libraries compiled with another value, if they exchange
8367 information using structures or unions.
8369 @item -mabort-on-noreturn
8370 @opindex mabort-on-noreturn
8371 Generate a call to the function @code{abort} at the end of a
8372 @code{noreturn} function.  It will be executed if the function tries to
8373 return.
8375 @item -mlong-calls
8376 @itemx -mno-long-calls
8377 @opindex mlong-calls
8378 @opindex mno-long-calls
8379 Tells the compiler to perform function calls by first loading the
8380 address of the function into a register and then performing a subroutine
8381 call on this register.  This switch is needed if the target function
8382 will lie outside of the 64 megabyte addressing range of the offset based
8383 version of subroutine call instruction.
8385 Even if this switch is enabled, not all function calls will be turned
8386 into long calls.  The heuristic is that static functions, functions
8387 which have the @samp{short-call} attribute, functions that are inside
8388 the scope of a @samp{#pragma no_long_calls} directive and functions whose
8389 definitions have already been compiled within the current compilation
8390 unit, will not be turned into long calls.  The exception to this rule is
8391 that weak function definitions, functions with the @samp{long-call}
8392 attribute or the @samp{section} attribute, and functions that are within
8393 the scope of a @samp{#pragma long_calls} directive, will always be
8394 turned into long calls.
8396 This feature is not enabled by default.  Specifying
8397 @option{-mno-long-calls} will restore the default behavior, as will
8398 placing the function calls within the scope of a @samp{#pragma
8399 long_calls_off} directive.  Note these switches have no effect on how
8400 the compiler generates code to handle function calls via function
8401 pointers.
8403 @item -mnop-fun-dllimport
8404 @opindex mnop-fun-dllimport
8405 Disable support for the @code{dllimport} attribute.
8407 @item -msingle-pic-base
8408 @opindex msingle-pic-base
8409 Treat the register used for PIC addressing as read-only, rather than
8410 loading it in the prologue for each function.  The run-time system is
8411 responsible for initializing this register with an appropriate value
8412 before execution begins.
8414 @item -mpic-register=@var{reg}
8415 @opindex mpic-register
8416 Specify the register to be used for PIC addressing.  The default is R10
8417 unless stack-checking is enabled, when R9 is used.
8419 @item -mcirrus-fix-invalid-insns
8420 @opindex mcirrus-fix-invalid-insns
8421 @opindex mno-cirrus-fix-invalid-insns
8422 Insert NOPs into the instruction stream to in order to work around
8423 problems with invalid Maverick instruction combinations.  This option
8424 is only valid if the @option{-mcpu=ep9312} option has been used to
8425 enable generation of instructions for the Cirrus Maverick floating
8426 point co-processor.  This option is not enabled by default, since the
8427 problem is only present in older Maverick implementations.  The default
8428 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
8429 switch.
8431 @item -mpoke-function-name
8432 @opindex mpoke-function-name
8433 Write the name of each function into the text section, directly
8434 preceding the function prologue.  The generated code is similar to this:
8436 @smallexample
8437      t0
8438          .ascii "arm_poke_function_name", 0
8439          .align
8440      t1
8441          .word 0xff000000 + (t1 - t0)
8442      arm_poke_function_name
8443          mov     ip, sp
8444          stmfd   sp!, @{fp, ip, lr, pc@}
8445          sub     fp, ip, #4
8446 @end smallexample
8448 When performing a stack backtrace, code can inspect the value of
8449 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
8450 location @code{pc - 12} and the top 8 bits are set, then we know that
8451 there is a function name embedded immediately preceding this location
8452 and has length @code{((pc[-3]) & 0xff000000)}.
8454 @item -mthumb
8455 @opindex mthumb
8456 Generate code for the Thumb instruction set.  The default is to
8457 use the 32-bit ARM instruction set.
8458 This option automatically enables either 16-bit Thumb-1 or
8459 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
8460 and @option{-march=@var{name}} options.
8462 @item -mtpcs-frame
8463 @opindex mtpcs-frame
8464 Generate a stack frame that is compliant with the Thumb Procedure Call
8465 Standard for all non-leaf functions.  (A leaf function is one that does
8466 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
8468 @item -mtpcs-leaf-frame
8469 @opindex mtpcs-leaf-frame
8470 Generate a stack frame that is compliant with the Thumb Procedure Call
8471 Standard for all leaf functions.  (A leaf function is one that does
8472 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
8474 @item -mcallee-super-interworking
8475 @opindex mcallee-super-interworking
8476 Gives all externally visible functions in the file being compiled an ARM
8477 instruction set header which switches to Thumb mode before executing the
8478 rest of the function.  This allows these functions to be called from
8479 non-interworking code.
8481 @item -mcaller-super-interworking
8482 @opindex mcaller-super-interworking
8483 Allows calls via function pointers (including virtual functions) to
8484 execute correctly regardless of whether the target code has been
8485 compiled for interworking or not.  There is a small overhead in the cost
8486 of executing a function pointer if this option is enabled.
8488 @item -mtp=@var{name}
8489 @opindex mtp
8490 Specify the access model for the thread local storage pointer.  The valid
8491 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
8492 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
8493 (supported in the arm6k architecture), and @option{auto}, which uses the
8494 best available method for the selected processor.  The default setting is
8495 @option{auto}.
8497 @end table
8499 @node AVR Options
8500 @subsection AVR Options
8501 @cindex AVR Options
8503 These options are defined for AVR implementations:
8505 @table @gcctabopt
8506 @item -mmcu=@var{mcu}
8507 @opindex mmcu
8508 Specify ATMEL AVR instruction set or MCU type.
8510 Instruction set avr1 is for the minimal AVR core, not supported by the C
8511 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
8512 attiny11, attiny12, attiny15, attiny28).
8514 Instruction set avr2 (default) is for the classic AVR core with up to
8515 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
8516 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
8517 at90c8534, at90s8535).
8519 Instruction set avr3 is for the classic AVR core with up to 128K program
8520 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
8522 Instruction set avr4 is for the enhanced AVR core with up to 8K program
8523 memory space (MCU types: atmega8, atmega83, atmega85).
8525 Instruction set avr5 is for the enhanced AVR core with up to 128K program
8526 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
8527 atmega64, atmega128, at43usb355, at94k).
8529 @item -msize
8530 @opindex msize
8531 Output instruction sizes to the asm file.
8533 @item -minit-stack=@var{N}
8534 @opindex minit-stack
8535 Specify the initial stack address, which may be a symbol or numeric value,
8536 @samp{__stack} is the default.
8538 @item -mno-interrupts
8539 @opindex mno-interrupts
8540 Generated code is not compatible with hardware interrupts.
8541 Code size will be smaller.
8543 @item -mcall-prologues
8544 @opindex mcall-prologues
8545 Functions prologues/epilogues expanded as call to appropriate
8546 subroutines.  Code size will be smaller.
8548 @item -mno-tablejump
8549 @opindex mno-tablejump
8550 Do not generate tablejump insns which sometimes increase code size.
8552 @item -mtiny-stack
8553 @opindex mtiny-stack
8554 Change only the low 8 bits of the stack pointer.
8556 @item -mint8
8557 @opindex mint8
8558 Assume int to be 8 bit integer.  This affects the sizes of all types: A
8559 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8560 and long long will be 4 bytes.  Please note that this option does not
8561 comply to the C standards, but it will provide you with smaller code
8562 size.
8563 @end table
8565 @node Blackfin Options
8566 @subsection Blackfin Options
8567 @cindex Blackfin Options
8569 @table @gcctabopt
8570 @item -mcpu=@var{cpu}
8571 @opindex mcpu=
8572 Specifies the name of the target Blackfin processor. Currently, @var{cpu}
8573 can be one of @samp{bf531}, @samp{bf532}, @samp{bf533},
8574 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf561}.
8575 Without this option, @samp{bf532} is used as the processor by default.
8576 The corresponding predefined processor macros for @var{cpu} is to
8577 be defined.  For the @samp{bfin-elf} toolchain, this causes the hardware
8578 BSP provided by libgloss to be linked in if @samp{-msim} is not given.
8579 Support for @samp{bf561} is incomplete; only the processor macro is defined.
8581 @item -msim
8582 @opindex msim
8583 Specifies that the program will be run on the simulator.  This causes
8584 the simulator BSP provided by libgloss to be linked in.  This option
8585 has effect only for @samp{bfin-elf} toolchain.
8587 @item -momit-leaf-frame-pointer
8588 @opindex momit-leaf-frame-pointer
8589 Don't keep the frame pointer in a register for leaf functions.  This
8590 avoids the instructions to save, set up and restore frame pointers and
8591 makes an extra register available in leaf functions.  The option
8592 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8593 which might make debugging harder.
8595 @item -mspecld-anomaly
8596 @opindex mspecld-anomaly
8597 When enabled, the compiler will ensure that the generated code does not
8598 contain speculative loads after jump instructions.  This option is enabled
8599 by default.
8601 @item -mno-specld-anomaly
8602 @opindex mno-specld-anomaly
8603 Don't generate extra code to prevent speculative loads from occurring.
8605 @item -mcsync-anomaly
8606 @opindex mcsync-anomaly
8607 When enabled, the compiler will ensure that the generated code does not
8608 contain CSYNC or SSYNC instructions too soon after conditional branches.
8609 This option is enabled by default.
8611 @item -mno-csync-anomaly
8612 @opindex mno-csync-anomaly
8613 Don't generate extra code to prevent CSYNC or SSYNC instructions from
8614 occurring too soon after a conditional branch.
8616 @item -mlow-64k
8617 @opindex mlow-64k
8618 When enabled, the compiler is free to take advantage of the knowledge that
8619 the entire program fits into the low 64k of memory.
8621 @item -mno-low-64k
8622 @opindex mno-low-64k
8623 Assume that the program is arbitrarily large.  This is the default.
8625 @item -mstack-check-l1
8626 @opindex mstack-check-l1
8627 Do stack checking using information placed into L1 scratchpad memory by the
8628 uClinux kernel.
8630 @item -mid-shared-library
8631 @opindex mid-shared-library
8632 Generate code that supports shared libraries via the library ID method.
8633 This allows for execute in place and shared libraries in an environment
8634 without virtual memory management.  This option implies @option{-fPIC}.
8636 @item -mno-id-shared-library
8637 @opindex mno-id-shared-library
8638 Generate code that doesn't assume ID based shared libraries are being used.
8639 This is the default.
8641 @item -mleaf-id-shared-library
8642 @opindex mleaf-id-shared-library
8643 Generate code that supports shared libraries via the library ID method,
8644 but assumes that this library or executable won't link against any other
8645 ID shared libraries.  That allows the compiler to use faster code for jumps
8646 and calls.
8648 @item -mno-leaf-id-shared-library
8649 @opindex mno-leaf-id-shared-library
8650 Do not assume that the code being compiled won't link against any ID shared
8651 libraries.  Slower code will be generated for jump and call insns.
8653 @item -mshared-library-id=n
8654 @opindex mshared-library-id
8655 Specified the identification number of the ID based shared library being
8656 compiled.  Specifying a value of 0 will generate more compact code, specifying
8657 other values will force the allocation of that number to the current
8658 library but is no more space or time efficient than omitting this option.
8660 @item -msep-data
8661 @opindex msep-data
8662 Generate code that allows the data segment to be located in a different
8663 area of memory from the text segment.  This allows for execute in place in
8664 an environment without virtual memory management by eliminating relocations
8665 against the text section.
8667 @item -mno-sep-data
8668 @opindex mno-sep-data
8669 Generate code that assumes that the data segment follows the text segment.
8670 This is the default.
8672 @item -mlong-calls
8673 @itemx -mno-long-calls
8674 @opindex mlong-calls
8675 @opindex mno-long-calls
8676 Tells the compiler to perform function calls by first loading the
8677 address of the function into a register and then performing a subroutine
8678 call on this register.  This switch is needed if the target function
8679 will lie outside of the 24 bit addressing range of the offset based
8680 version of subroutine call instruction.
8682 This feature is not enabled by default.  Specifying
8683 @option{-mno-long-calls} will restore the default behavior.  Note these
8684 switches have no effect on how the compiler generates code to handle
8685 function calls via function pointers.
8687 @item -mfast-fp
8688 @opindex mfast-fp
8689 Link with the fast floating-point library. This library relaxes some of
8690 the IEEE floating-point standard's rules for checking inputs against
8691 Not-a-Number (NAN), in the interest of performance.
8693 @item -minline-plt
8694 @opindex minline-plt
8695 Enable inlining of PLT entries in function calls to functions that are
8696 not known to bind locally.  It has no effect without @option{-mfdpic}.
8697 @end table
8699 @node CRIS Options
8700 @subsection CRIS Options
8701 @cindex CRIS Options
8703 These options are defined specifically for the CRIS ports.
8705 @table @gcctabopt
8706 @item -march=@var{architecture-type}
8707 @itemx -mcpu=@var{architecture-type}
8708 @opindex march
8709 @opindex mcpu
8710 Generate code for the specified architecture.  The choices for
8711 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8712 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
8713 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
8714 @samp{v10}.
8716 @item -mtune=@var{architecture-type}
8717 @opindex mtune
8718 Tune to @var{architecture-type} everything applicable about the generated
8719 code, except for the ABI and the set of available instructions.  The
8720 choices for @var{architecture-type} are the same as for
8721 @option{-march=@var{architecture-type}}.
8723 @item -mmax-stack-frame=@var{n}
8724 @opindex mmax-stack-frame
8725 Warn when the stack frame of a function exceeds @var{n} bytes.
8727 @item -melinux-stacksize=@var{n}
8728 @opindex melinux-stacksize
8729 Only available with the @samp{cris-axis-aout} target.  Arranges for
8730 indications in the program to the kernel loader that the stack of the
8731 program should be set to @var{n} bytes.
8733 @item -metrax4
8734 @itemx -metrax100
8735 @opindex metrax4
8736 @opindex metrax100
8737 The options @option{-metrax4} and @option{-metrax100} are synonyms for
8738 @option{-march=v3} and @option{-march=v8} respectively.
8740 @item -mmul-bug-workaround
8741 @itemx -mno-mul-bug-workaround
8742 @opindex mmul-bug-workaround
8743 @opindex mno-mul-bug-workaround
8744 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
8745 models where it applies.  This option is active by default.
8747 @item -mpdebug
8748 @opindex mpdebug
8749 Enable CRIS-specific verbose debug-related information in the assembly
8750 code.  This option also has the effect to turn off the @samp{#NO_APP}
8751 formatted-code indicator to the assembler at the beginning of the
8752 assembly file.
8754 @item -mcc-init
8755 @opindex mcc-init
8756 Do not use condition-code results from previous instruction; always emit
8757 compare and test instructions before use of condition codes.
8759 @item -mno-side-effects
8760 @opindex mno-side-effects
8761 Do not emit instructions with side-effects in addressing modes other than
8762 post-increment.
8764 @item -mstack-align
8765 @itemx -mno-stack-align
8766 @itemx -mdata-align
8767 @itemx -mno-data-align
8768 @itemx -mconst-align
8769 @itemx -mno-const-align
8770 @opindex mstack-align
8771 @opindex mno-stack-align
8772 @opindex mdata-align
8773 @opindex mno-data-align
8774 @opindex mconst-align
8775 @opindex mno-const-align
8776 These options (no-options) arranges (eliminate arrangements) for the
8777 stack-frame, individual data and constants to be aligned for the maximum
8778 single data access size for the chosen CPU model.  The default is to
8779 arrange for 32-bit alignment.  ABI details such as structure layout are
8780 not affected by these options.
8782 @item -m32-bit
8783 @itemx -m16-bit
8784 @itemx -m8-bit
8785 @opindex m32-bit
8786 @opindex m16-bit
8787 @opindex m8-bit
8788 Similar to the stack- data- and const-align options above, these options
8789 arrange for stack-frame, writable data and constants to all be 32-bit,
8790 16-bit or 8-bit aligned.  The default is 32-bit alignment.
8792 @item -mno-prologue-epilogue
8793 @itemx -mprologue-epilogue
8794 @opindex mno-prologue-epilogue
8795 @opindex mprologue-epilogue
8796 With @option{-mno-prologue-epilogue}, the normal function prologue and
8797 epilogue that sets up the stack-frame are omitted and no return
8798 instructions or return sequences are generated in the code.  Use this
8799 option only together with visual inspection of the compiled code: no
8800 warnings or errors are generated when call-saved registers must be saved,
8801 or storage for local variable needs to be allocated.
8803 @item -mno-gotplt
8804 @itemx -mgotplt
8805 @opindex mno-gotplt
8806 @opindex mgotplt
8807 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8808 instruction sequences that load addresses for functions from the PLT part
8809 of the GOT rather than (traditional on other architectures) calls to the
8810 PLT@.  The default is @option{-mgotplt}.
8812 @item -maout
8813 @opindex maout
8814 Legacy no-op option only recognized with the cris-axis-aout target.
8816 @item -melf
8817 @opindex melf
8818 Legacy no-op option only recognized with the cris-axis-elf and
8819 cris-axis-linux-gnu targets.
8821 @item -melinux
8822 @opindex melinux
8823 Only recognized with the cris-axis-aout target, where it selects a
8824 GNU/linux-like multilib, include files and instruction set for
8825 @option{-march=v8}.
8827 @item -mlinux
8828 @opindex mlinux
8829 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8831 @item -sim
8832 @opindex sim
8833 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8834 to link with input-output functions from a simulator library.  Code,
8835 initialized data and zero-initialized data are allocated consecutively.
8837 @item -sim2
8838 @opindex sim2
8839 Like @option{-sim}, but pass linker options to locate initialized data at
8840 0x40000000 and zero-initialized data at 0x80000000.
8841 @end table
8843 @node CRX Options
8844 @subsection CRX Options
8845 @cindex CRX Options
8847 These options are defined specifically for the CRX ports.
8849 @table @gcctabopt
8851 @item -mmac
8852 @opindex mmac
8853 Enable the use of multiply-accumulate instructions. Disabled by default.
8855 @item -mpush-args
8856 @opindex mpush-args
8857 Push instructions will be used to pass outgoing arguments when functions
8858 are called. Enabled by default.
8859 @end table
8861 @node Darwin Options
8862 @subsection Darwin Options
8863 @cindex Darwin options
8865 These options are defined for all architectures running the Darwin operating
8866 system.
8868 FSF GCC on Darwin does not create ``fat'' object files; it will create
8869 an object file for the single architecture that it was built to
8870 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8871 @option{-arch} options are used; it does so by running the compiler or
8872 linker multiple times and joining the results together with
8873 @file{lipo}.
8875 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8876 @samp{i686}) is determined by the flags that specify the ISA
8877 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8878 @option{-force_cpusubtype_ALL} option can be used to override this.
8880 The Darwin tools vary in their behavior when presented with an ISA
8881 mismatch.  The assembler, @file{as}, will only permit instructions to
8882 be used that are valid for the subtype of the file it is generating,
8883 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8884 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8885 and print an error if asked to create a shared library with a less
8886 restrictive subtype than its input files (for instance, trying to put
8887 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8888 for executables, @file{ld}, will quietly give the executable the most
8889 restrictive subtype of any of its input files.
8891 @table @gcctabopt
8892 @item -F@var{dir}
8893 @opindex F
8894 Add the framework directory @var{dir} to the head of the list of
8895 directories to be searched for header files.  These directories are
8896 interleaved with those specified by @option{-I} options and are
8897 scanned in a left-to-right order.
8899 A framework directory is a directory with frameworks in it.  A
8900 framework is a directory with a @samp{"Headers"} and/or
8901 @samp{"PrivateHeaders"} directory contained directly in it that ends
8902 in @samp{".framework"}.  The name of a framework is the name of this
8903 directory excluding the @samp{".framework"}.  Headers associated with
8904 the framework are found in one of those two directories, with
8905 @samp{"Headers"} being searched first.  A subframework is a framework
8906 directory that is in a framework's @samp{"Frameworks"} directory.
8907 Includes of subframework headers can only appear in a header of a
8908 framework that contains the subframework, or in a sibling subframework
8909 header.  Two subframeworks are siblings if they occur in the same
8910 framework.  A subframework should not have the same name as a
8911 framework, a warning will be issued if this is violated.  Currently a
8912 subframework cannot have subframeworks, in the future, the mechanism
8913 may be extended to support this.  The standard frameworks can be found
8914 in @samp{"/System/Library/Frameworks"} and
8915 @samp{"/Library/Frameworks"}.  An example include looks like
8916 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8917 the name of the framework and header.h is found in the
8918 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8920 @item -iframework@var{dir}
8921 @opindex iframework
8922 Like @option{-F} except the directory is a treated as a system
8923 directory.  The main difference between this @option{-iframework} and
8924 @option{-F} is that with @option{-iframework} the compiler does not
8925 warn about constructs contained within header files found via
8926 @var{dir}.  This option is valid only for the C family of languages.
8928 @item -gused
8929 @opindex gused
8930 Emit debugging information for symbols that are used.  For STABS
8931 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8932 This is by default ON@.
8934 @item -gfull
8935 @opindex gfull
8936 Emit debugging information for all symbols and types.
8938 @item -mmacosx-version-min=@var{version}
8939 The earliest version of MacOS X that this executable will run on
8940 is @var{version}.  Typical values of @var{version} include @code{10.1},
8941 @code{10.2}, and @code{10.3.9}.
8943 If the compiler was built to use the system's headers by default,
8944 then the default for this option is the system version on which the
8945 compiler is running, otherwise the default is to make choices which
8946 are compatible with as many systems and code bases as possible.
8948 @item -mkernel
8949 @opindex mkernel
8950 Enable kernel development mode.  The @option{-mkernel} option sets
8951 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8952 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8953 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8954 applicable.  This mode also sets @option{-mno-altivec},
8955 @option{-msoft-float}, @option{-fno-builtin} and
8956 @option{-mlong-branch} for PowerPC targets.
8958 @item -mone-byte-bool
8959 @opindex mone-byte-bool
8960 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8961 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8962 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8963 option has no effect on x86.
8965 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8966 to generate code that is not binary compatible with code generated
8967 without that switch.  Using this switch may require recompiling all
8968 other modules in a program, including system libraries.  Use this
8969 switch to conform to a non-default data model.
8971 @item -mfix-and-continue
8972 @itemx -ffix-and-continue
8973 @itemx -findirect-data
8974 @opindex mfix-and-continue
8975 @opindex ffix-and-continue
8976 @opindex findirect-data
8977 Generate code suitable for fast turn around development.  Needed to
8978 enable gdb to dynamically load @code{.o} files into already running
8979 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8980 are provided for backwards compatibility.
8982 @item -all_load
8983 @opindex all_load
8984 Loads all members of static archive libraries.
8985 See man ld(1) for more information.
8987 @item -arch_errors_fatal
8988 @opindex arch_errors_fatal
8989 Cause the errors having to do with files that have the wrong architecture
8990 to be fatal.
8992 @item -bind_at_load
8993 @opindex bind_at_load
8994 Causes the output file to be marked such that the dynamic linker will
8995 bind all undefined references when the file is loaded or launched.
8997 @item -bundle
8998 @opindex bundle
8999 Produce a Mach-o bundle format file.
9000 See man ld(1) for more information.
9002 @item -bundle_loader @var{executable}
9003 @opindex bundle_loader
9004 This option specifies the @var{executable} that will be loading the build
9005 output file being linked.  See man ld(1) for more information.
9007 @item -dynamiclib
9008 @opindex dynamiclib
9009 When passed this option, GCC will produce a dynamic library instead of
9010 an executable when linking, using the Darwin @file{libtool} command.
9012 @item -force_cpusubtype_ALL
9013 @opindex force_cpusubtype_ALL
9014 This causes GCC's output file to have the @var{ALL} subtype, instead of
9015 one controlled by the @option{-mcpu} or @option{-march} option.
9017 @item -allowable_client  @var{client_name}
9018 @itemx -client_name
9019 @itemx -compatibility_version
9020 @itemx -current_version
9021 @itemx -dead_strip
9022 @itemx -dependency-file
9023 @itemx -dylib_file
9024 @itemx -dylinker_install_name
9025 @itemx -dynamic
9026 @itemx -exported_symbols_list
9027 @itemx -filelist
9028 @itemx -flat_namespace
9029 @itemx -force_flat_namespace
9030 @itemx -headerpad_max_install_names
9031 @itemx -image_base
9032 @itemx -init
9033 @itemx -install_name
9034 @itemx -keep_private_externs
9035 @itemx -multi_module
9036 @itemx -multiply_defined
9037 @itemx -multiply_defined_unused
9038 @itemx -noall_load
9039 @itemx -no_dead_strip_inits_and_terms
9040 @itemx -nofixprebinding
9041 @itemx -nomultidefs
9042 @itemx -noprebind
9043 @itemx -noseglinkedit
9044 @itemx -pagezero_size
9045 @itemx -prebind
9046 @itemx -prebind_all_twolevel_modules
9047 @itemx -private_bundle
9048 @itemx -read_only_relocs
9049 @itemx -sectalign
9050 @itemx -sectobjectsymbols
9051 @itemx -whyload
9052 @itemx -seg1addr
9053 @itemx -sectcreate
9054 @itemx -sectobjectsymbols
9055 @itemx -sectorder
9056 @itemx -segaddr
9057 @itemx -segs_read_only_addr
9058 @itemx -segs_read_write_addr
9059 @itemx -seg_addr_table
9060 @itemx -seg_addr_table_filename
9061 @itemx -seglinkedit
9062 @itemx -segprot
9063 @itemx -segs_read_only_addr
9064 @itemx -segs_read_write_addr
9065 @itemx -single_module
9066 @itemx -static
9067 @itemx -sub_library
9068 @itemx -sub_umbrella
9069 @itemx -twolevel_namespace
9070 @itemx -umbrella
9071 @itemx -undefined
9072 @itemx -unexported_symbols_list
9073 @itemx -weak_reference_mismatches
9074 @itemx -whatsloaded
9076 @opindex allowable_client
9077 @opindex client_name
9078 @opindex compatibility_version
9079 @opindex current_version
9080 @opindex dead_strip
9081 @opindex dependency-file
9082 @opindex dylib_file
9083 @opindex dylinker_install_name
9084 @opindex dynamic
9085 @opindex exported_symbols_list
9086 @opindex filelist
9087 @opindex flat_namespace
9088 @opindex force_flat_namespace
9089 @opindex headerpad_max_install_names
9090 @opindex image_base
9091 @opindex init
9092 @opindex install_name
9093 @opindex keep_private_externs
9094 @opindex multi_module
9095 @opindex multiply_defined
9096 @opindex multiply_defined_unused
9097 @opindex noall_load
9098 @opindex no_dead_strip_inits_and_terms
9099 @opindex nofixprebinding
9100 @opindex nomultidefs
9101 @opindex noprebind
9102 @opindex noseglinkedit
9103 @opindex pagezero_size
9104 @opindex prebind
9105 @opindex prebind_all_twolevel_modules
9106 @opindex private_bundle
9107 @opindex read_only_relocs
9108 @opindex sectalign
9109 @opindex sectobjectsymbols
9110 @opindex whyload
9111 @opindex seg1addr
9112 @opindex sectcreate
9113 @opindex sectobjectsymbols
9114 @opindex sectorder
9115 @opindex segaddr
9116 @opindex segs_read_only_addr
9117 @opindex segs_read_write_addr
9118 @opindex seg_addr_table
9119 @opindex seg_addr_table_filename
9120 @opindex seglinkedit
9121 @opindex segprot
9122 @opindex segs_read_only_addr
9123 @opindex segs_read_write_addr
9124 @opindex single_module
9125 @opindex static
9126 @opindex sub_library
9127 @opindex sub_umbrella
9128 @opindex twolevel_namespace
9129 @opindex umbrella
9130 @opindex undefined
9131 @opindex unexported_symbols_list
9132 @opindex weak_reference_mismatches
9133 @opindex whatsloaded
9135 These options are passed to the Darwin linker.  The Darwin linker man page
9136 describes them in detail.
9137 @end table
9139 @node DEC Alpha Options
9140 @subsection DEC Alpha Options
9142 These @samp{-m} options are defined for the DEC Alpha implementations:
9144 @table @gcctabopt
9145 @item -mno-soft-float
9146 @itemx -msoft-float
9147 @opindex mno-soft-float
9148 @opindex msoft-float
9149 Use (do not use) the hardware floating-point instructions for
9150 floating-point operations.  When @option{-msoft-float} is specified,
9151 functions in @file{libgcc.a} will be used to perform floating-point
9152 operations.  Unless they are replaced by routines that emulate the
9153 floating-point operations, or compiled in such a way as to call such
9154 emulations routines, these routines will issue floating-point
9155 operations.   If you are compiling for an Alpha without floating-point
9156 operations, you must ensure that the library is built so as not to call
9157 them.
9159 Note that Alpha implementations without floating-point operations are
9160 required to have floating-point registers.
9162 @item -mfp-reg
9163 @itemx -mno-fp-regs
9164 @opindex mfp-reg
9165 @opindex mno-fp-regs
9166 Generate code that uses (does not use) the floating-point register set.
9167 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9168 register set is not used, floating point operands are passed in integer
9169 registers as if they were integers and floating-point results are passed
9170 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9171 so any function with a floating-point argument or return value called by code
9172 compiled with @option{-mno-fp-regs} must also be compiled with that
9173 option.
9175 A typical use of this option is building a kernel that does not use,
9176 and hence need not save and restore, any floating-point registers.
9178 @item -mieee
9179 @opindex mieee
9180 The Alpha architecture implements floating-point hardware optimized for
9181 maximum performance.  It is mostly compliant with the IEEE floating
9182 point standard.  However, for full compliance, software assistance is
9183 required.  This option generates code fully IEEE compliant code
9184 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9185 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9186 defined during compilation.  The resulting code is less efficient but is
9187 able to correctly support denormalized numbers and exceptional IEEE
9188 values such as not-a-number and plus/minus infinity.  Other Alpha
9189 compilers call this option @option{-ieee_with_no_inexact}.
9191 @item -mieee-with-inexact
9192 @opindex mieee-with-inexact
9193 This is like @option{-mieee} except the generated code also maintains
9194 the IEEE @var{inexact-flag}.  Turning on this option causes the
9195 generated code to implement fully-compliant IEEE math.  In addition to
9196 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9197 macro.  On some Alpha implementations the resulting code may execute
9198 significantly slower than the code generated by default.  Since there is
9199 very little code that depends on the @var{inexact-flag}, you should
9200 normally not specify this option.  Other Alpha compilers call this
9201 option @option{-ieee_with_inexact}.
9203 @item -mfp-trap-mode=@var{trap-mode}
9204 @opindex mfp-trap-mode
9205 This option controls what floating-point related traps are enabled.
9206 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9207 The trap mode can be set to one of four values:
9209 @table @samp
9210 @item n
9211 This is the default (normal) setting.  The only traps that are enabled
9212 are the ones that cannot be disabled in software (e.g., division by zero
9213 trap).
9215 @item u
9216 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9217 as well.
9219 @item su
9220 Like @samp{u}, but the instructions are marked to be safe for software
9221 completion (see Alpha architecture manual for details).
9223 @item sui
9224 Like @samp{su}, but inexact traps are enabled as well.
9225 @end table
9227 @item -mfp-rounding-mode=@var{rounding-mode}
9228 @opindex mfp-rounding-mode
9229 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9230 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9233 @table @samp
9234 @item n
9235 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9236 the nearest machine number or towards the even machine number in case
9237 of a tie.
9239 @item m
9240 Round towards minus infinity.
9242 @item c
9243 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9245 @item d
9246 Dynamic rounding mode.  A field in the floating point control register
9247 (@var{fpcr}, see Alpha architecture reference manual) controls the
9248 rounding mode in effect.  The C library initializes this register for
9249 rounding towards plus infinity.  Thus, unless your program modifies the
9250 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9251 @end table
9253 @item -mtrap-precision=@var{trap-precision}
9254 @opindex mtrap-precision
9255 In the Alpha architecture, floating point traps are imprecise.  This
9256 means without software assistance it is impossible to recover from a
9257 floating trap and program execution normally needs to be terminated.
9258 GCC can generate code that can assist operating system trap handlers
9259 in determining the exact location that caused a floating point trap.
9260 Depending on the requirements of an application, different levels of
9261 precisions can be selected:
9263 @table @samp
9264 @item p
9265 Program precision.  This option is the default and means a trap handler
9266 can only identify which program caused a floating point exception.
9268 @item f
9269 Function precision.  The trap handler can determine the function that
9270 caused a floating point exception.
9272 @item i
9273 Instruction precision.  The trap handler can determine the exact
9274 instruction that caused a floating point exception.
9275 @end table
9277 Other Alpha compilers provide the equivalent options called
9278 @option{-scope_safe} and @option{-resumption_safe}.
9280 @item -mieee-conformant
9281 @opindex mieee-conformant
9282 This option marks the generated code as IEEE conformant.  You must not
9283 use this option unless you also specify @option{-mtrap-precision=i} and either
9284 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9285 is to emit the line @samp{.eflag 48} in the function prologue of the
9286 generated assembly file.  Under DEC Unix, this has the effect that
9287 IEEE-conformant math library routines will be linked in.
9289 @item -mbuild-constants
9290 @opindex mbuild-constants
9291 Normally GCC examines a 32- or 64-bit integer constant to
9292 see if it can construct it from smaller constants in two or three
9293 instructions.  If it cannot, it will output the constant as a literal and
9294 generate code to load it from the data segment at runtime.
9296 Use this option to require GCC to construct @emph{all} integer constants
9297 using code, even if it takes more instructions (the maximum is six).
9299 You would typically use this option to build a shared library dynamic
9300 loader.  Itself a shared library, it must relocate itself in memory
9301 before it can find the variables and constants in its own data segment.
9303 @item -malpha-as
9304 @itemx -mgas
9305 @opindex malpha-as
9306 @opindex mgas
9307 Select whether to generate code to be assembled by the vendor-supplied
9308 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9310 @item -mbwx
9311 @itemx -mno-bwx
9312 @itemx -mcix
9313 @itemx -mno-cix
9314 @itemx -mfix
9315 @itemx -mno-fix
9316 @itemx -mmax
9317 @itemx -mno-max
9318 @opindex mbwx
9319 @opindex mno-bwx
9320 @opindex mcix
9321 @opindex mno-cix
9322 @opindex mfix
9323 @opindex mno-fix
9324 @opindex mmax
9325 @opindex mno-max
9326 Indicate whether GCC should generate code to use the optional BWX,
9327 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9328 sets supported by the CPU type specified via @option{-mcpu=} option or that
9329 of the CPU on which GCC was built if none was specified.
9331 @item -mfloat-vax
9332 @itemx -mfloat-ieee
9333 @opindex mfloat-vax
9334 @opindex mfloat-ieee
9335 Generate code that uses (does not use) VAX F and G floating point
9336 arithmetic instead of IEEE single and double precision.
9338 @item -mexplicit-relocs
9339 @itemx -mno-explicit-relocs
9340 @opindex mexplicit-relocs
9341 @opindex mno-explicit-relocs
9342 Older Alpha assemblers provided no way to generate symbol relocations
9343 except via assembler macros.  Use of these macros does not allow
9344 optimal instruction scheduling.  GNU binutils as of version 2.12
9345 supports a new syntax that allows the compiler to explicitly mark
9346 which relocations should apply to which instructions.  This option
9347 is mostly useful for debugging, as GCC detects the capabilities of
9348 the assembler when it is built and sets the default accordingly.
9350 @item -msmall-data
9351 @itemx -mlarge-data
9352 @opindex msmall-data
9353 @opindex mlarge-data
9354 When @option{-mexplicit-relocs} is in effect, static data is
9355 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9356 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9357 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9358 16-bit relocations off of the @code{$gp} register.  This limits the
9359 size of the small data area to 64KB, but allows the variables to be
9360 directly accessed via a single instruction.
9362 The default is @option{-mlarge-data}.  With this option the data area
9363 is limited to just below 2GB@.  Programs that require more than 2GB of
9364 data must use @code{malloc} or @code{mmap} to allocate the data in the
9365 heap instead of in the program's data segment.
9367 When generating code for shared libraries, @option{-fpic} implies
9368 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9370 @item -msmall-text
9371 @itemx -mlarge-text
9372 @opindex msmall-text
9373 @opindex mlarge-text
9374 When @option{-msmall-text} is used, the compiler assumes that the
9375 code of the entire program (or shared library) fits in 4MB, and is
9376 thus reachable with a branch instruction.  When @option{-msmall-data}
9377 is used, the compiler can assume that all local symbols share the
9378 same @code{$gp} value, and thus reduce the number of instructions
9379 required for a function call from 4 to 1.
9381 The default is @option{-mlarge-text}.
9383 @item -mcpu=@var{cpu_type}
9384 @opindex mcpu
9385 Set the instruction set and instruction scheduling parameters for
9386 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9387 style name or the corresponding chip number.  GCC supports scheduling
9388 parameters for the EV4, EV5 and EV6 family of processors and will
9389 choose the default values for the instruction set from the processor
9390 you specify.  If you do not specify a processor type, GCC will default
9391 to the processor on which the compiler was built.
9393 Supported values for @var{cpu_type} are
9395 @table @samp
9396 @item ev4
9397 @itemx ev45
9398 @itemx 21064
9399 Schedules as an EV4 and has no instruction set extensions.
9401 @item ev5
9402 @itemx 21164
9403 Schedules as an EV5 and has no instruction set extensions.
9405 @item ev56
9406 @itemx 21164a
9407 Schedules as an EV5 and supports the BWX extension.
9409 @item pca56
9410 @itemx 21164pc
9411 @itemx 21164PC
9412 Schedules as an EV5 and supports the BWX and MAX extensions.
9414 @item ev6
9415 @itemx 21264
9416 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9418 @item ev67
9419 @itemx 21264a
9420 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9421 @end table
9423 @item -mtune=@var{cpu_type}
9424 @opindex mtune
9425 Set only the instruction scheduling parameters for machine type
9426 @var{cpu_type}.  The instruction set is not changed.
9428 @item -mmemory-latency=@var{time}
9429 @opindex mmemory-latency
9430 Sets the latency the scheduler should assume for typical memory
9431 references as seen by the application.  This number is highly
9432 dependent on the memory access patterns used by the application
9433 and the size of the external cache on the machine.
9435 Valid options for @var{time} are
9437 @table @samp
9438 @item @var{number}
9439 A decimal number representing clock cycles.
9441 @item L1
9442 @itemx L2
9443 @itemx L3
9444 @itemx main
9445 The compiler contains estimates of the number of clock cycles for
9446 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9447 (also called Dcache, Scache, and Bcache), as well as to main memory.
9448 Note that L3 is only valid for EV5.
9450 @end table
9451 @end table
9453 @node DEC Alpha/VMS Options
9454 @subsection DEC Alpha/VMS Options
9456 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9458 @table @gcctabopt
9459 @item -mvms-return-codes
9460 @opindex mvms-return-codes
9461 Return VMS condition codes from main.  The default is to return POSIX
9462 style condition (e.g.@: error) codes.
9463 @end table
9465 @node FRV Options
9466 @subsection FRV Options
9467 @cindex FRV Options
9469 @table @gcctabopt
9470 @item -mgpr-32
9471 @opindex mgpr-32
9473 Only use the first 32 general purpose registers.
9475 @item -mgpr-64
9476 @opindex mgpr-64
9478 Use all 64 general purpose registers.
9480 @item -mfpr-32
9481 @opindex mfpr-32
9483 Use only the first 32 floating point registers.
9485 @item -mfpr-64
9486 @opindex mfpr-64
9488 Use all 64 floating point registers
9490 @item -mhard-float
9491 @opindex mhard-float
9493 Use hardware instructions for floating point operations.
9495 @item -msoft-float
9496 @opindex msoft-float
9498 Use library routines for floating point operations.
9500 @item -malloc-cc
9501 @opindex malloc-cc
9503 Dynamically allocate condition code registers.
9505 @item -mfixed-cc
9506 @opindex mfixed-cc
9508 Do not try to dynamically allocate condition code registers, only
9509 use @code{icc0} and @code{fcc0}.
9511 @item -mdword
9512 @opindex mdword
9514 Change ABI to use double word insns.
9516 @item -mno-dword
9517 @opindex mno-dword
9519 Do not use double word instructions.
9521 @item -mdouble
9522 @opindex mdouble
9524 Use floating point double instructions.
9526 @item -mno-double
9527 @opindex mno-double
9529 Do not use floating point double instructions.
9531 @item -mmedia
9532 @opindex mmedia
9534 Use media instructions.
9536 @item -mno-media
9537 @opindex mno-media
9539 Do not use media instructions.
9541 @item -mmuladd
9542 @opindex mmuladd
9544 Use multiply and add/subtract instructions.
9546 @item -mno-muladd
9547 @opindex mno-muladd
9549 Do not use multiply and add/subtract instructions.
9551 @item -mfdpic
9552 @opindex mfdpic
9554 Select the FDPIC ABI, that uses function descriptors to represent
9555 pointers to functions.  Without any PIC/PIE-related options, it
9556 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
9557 assumes GOT entries and small data are within a 12-bit range from the
9558 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
9559 are computed with 32 bits.
9561 @item -minline-plt
9562 @opindex minline-plt
9564 Enable inlining of PLT entries in function calls to functions that are
9565 not known to bind locally.  It has no effect without @option{-mfdpic}.
9566 It's enabled by default if optimizing for speed and compiling for
9567 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
9568 optimization option such as @option{-O3} or above is present in the
9569 command line.
9571 @item -mTLS
9572 @opindex TLS
9574 Assume a large TLS segment when generating thread-local code.
9576 @item -mtls
9577 @opindex tls
9579 Do not assume a large TLS segment when generating thread-local code.
9581 @item -mgprel-ro
9582 @opindex mgprel-ro
9584 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
9585 that is known to be in read-only sections.  It's enabled by default,
9586 except for @option{-fpic} or @option{-fpie}: even though it may help
9587 make the global offset table smaller, it trades 1 instruction for 4.
9588 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
9589 one of which may be shared by multiple symbols, and it avoids the need
9590 for a GOT entry for the referenced symbol, so it's more likely to be a
9591 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
9593 @item -multilib-library-pic
9594 @opindex multilib-library-pic
9596 Link with the (library, not FD) pic libraries.  It's implied by
9597 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
9598 @option{-fpic} without @option{-mfdpic}.  You should never have to use
9599 it explicitly.
9601 @item -mlinked-fp
9602 @opindex mlinked-fp
9604 Follow the EABI requirement of always creating a frame pointer whenever
9605 a stack frame is allocated.  This option is enabled by default and can
9606 be disabled with @option{-mno-linked-fp}.
9608 @item -mlong-calls
9609 @opindex mlong-calls
9611 Use indirect addressing to call functions outside the current
9612 compilation unit.  This allows the functions to be placed anywhere
9613 within the 32-bit address space.
9615 @item -malign-labels
9616 @opindex malign-labels
9618 Try to align labels to an 8-byte boundary by inserting nops into the
9619 previous packet.  This option only has an effect when VLIW packing
9620 is enabled.  It doesn't create new packets; it merely adds nops to
9621 existing ones.
9623 @item -mlibrary-pic
9624 @opindex mlibrary-pic
9626 Generate position-independent EABI code.
9628 @item -macc-4
9629 @opindex macc-4
9631 Use only the first four media accumulator registers.
9633 @item -macc-8
9634 @opindex macc-8
9636 Use all eight media accumulator registers.
9638 @item -mpack
9639 @opindex mpack
9641 Pack VLIW instructions.
9643 @item -mno-pack
9644 @opindex mno-pack
9646 Do not pack VLIW instructions.
9648 @item -mno-eflags
9649 @opindex mno-eflags
9651 Do not mark ABI switches in e_flags.
9653 @item -mcond-move
9654 @opindex mcond-move
9656 Enable the use of conditional-move instructions (default).
9658 This switch is mainly for debugging the compiler and will likely be removed
9659 in a future version.
9661 @item -mno-cond-move
9662 @opindex mno-cond-move
9664 Disable the use of conditional-move instructions.
9666 This switch is mainly for debugging the compiler and will likely be removed
9667 in a future version.
9669 @item -mscc
9670 @opindex mscc
9672 Enable the use of conditional set instructions (default).
9674 This switch is mainly for debugging the compiler and will likely be removed
9675 in a future version.
9677 @item -mno-scc
9678 @opindex mno-scc
9680 Disable the use of conditional set instructions.
9682 This switch is mainly for debugging the compiler and will likely be removed
9683 in a future version.
9685 @item -mcond-exec
9686 @opindex mcond-exec
9688 Enable the use of conditional execution (default).
9690 This switch is mainly for debugging the compiler and will likely be removed
9691 in a future version.
9693 @item -mno-cond-exec
9694 @opindex mno-cond-exec
9696 Disable the use of conditional execution.
9698 This switch is mainly for debugging the compiler and will likely be removed
9699 in a future version.
9701 @item -mvliw-branch
9702 @opindex mvliw-branch
9704 Run a pass to pack branches into VLIW instructions (default).
9706 This switch is mainly for debugging the compiler and will likely be removed
9707 in a future version.
9709 @item -mno-vliw-branch
9710 @opindex mno-vliw-branch
9712 Do not run a pass to pack branches into VLIW instructions.
9714 This switch is mainly for debugging the compiler and will likely be removed
9715 in a future version.
9717 @item -mmulti-cond-exec
9718 @opindex mmulti-cond-exec
9720 Enable optimization of @code{&&} and @code{||} in conditional execution
9721 (default).
9723 This switch is mainly for debugging the compiler and will likely be removed
9724 in a future version.
9726 @item -mno-multi-cond-exec
9727 @opindex mno-multi-cond-exec
9729 Disable optimization of @code{&&} and @code{||} in conditional execution.
9731 This switch is mainly for debugging the compiler and will likely be removed
9732 in a future version.
9734 @item -mnested-cond-exec
9735 @opindex mnested-cond-exec
9737 Enable nested conditional execution optimizations (default).
9739 This switch is mainly for debugging the compiler and will likely be removed
9740 in a future version.
9742 @item -mno-nested-cond-exec
9743 @opindex mno-nested-cond-exec
9745 Disable nested conditional execution optimizations.
9747 This switch is mainly for debugging the compiler and will likely be removed
9748 in a future version.
9750 @item -moptimize-membar
9751 @opindex moptimize-membar
9753 This switch removes redundant @code{membar} instructions from the
9754 compiler generated code.  It is enabled by default.
9756 @item -mno-optimize-membar
9757 @opindex mno-optimize-membar
9759 This switch disables the automatic removal of redundant @code{membar}
9760 instructions from the generated code.
9762 @item -mtomcat-stats
9763 @opindex mtomcat-stats
9765 Cause gas to print out tomcat statistics.
9767 @item -mcpu=@var{cpu}
9768 @opindex mcpu
9770 Select the processor type for which to generate code.  Possible values are
9771 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9772 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9774 @end table
9776 @node GNU/Linux Options
9777 @subsection GNU/Linux Options
9779 These @samp{-m} options are defined for GNU/Linux targets:
9781 @table @gcctabopt
9782 @item -mglibc
9783 @opindex mglibc
9784 Use the GNU C library instead of uClibc.  This is the default except
9785 on @samp{*-*-linux-*uclibc*} targets.
9787 @item -muclibc
9788 @opindex muclibc
9789 Use uClibc instead of the GNU C library.  This is the default on
9790 @samp{*-*-linux-*uclibc*} targets.
9791 @end table
9793 @node H8/300 Options
9794 @subsection H8/300 Options
9796 These @samp{-m} options are defined for the H8/300 implementations:
9798 @table @gcctabopt
9799 @item -mrelax
9800 @opindex mrelax
9801 Shorten some address references at link time, when possible; uses the
9802 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9803 ld, Using ld}, for a fuller description.
9805 @item -mh
9806 @opindex mh
9807 Generate code for the H8/300H@.
9809 @item -ms
9810 @opindex ms
9811 Generate code for the H8S@.
9813 @item -mn
9814 @opindex mn
9815 Generate code for the H8S and H8/300H in the normal mode.  This switch
9816 must be used either with @option{-mh} or @option{-ms}.
9818 @item -ms2600
9819 @opindex ms2600
9820 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9822 @item -mint32
9823 @opindex mint32
9824 Make @code{int} data 32 bits by default.
9826 @item -malign-300
9827 @opindex malign-300
9828 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9829 The default for the H8/300H and H8S is to align longs and floats on 4
9830 byte boundaries.
9831 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9832 This option has no effect on the H8/300.
9833 @end table
9835 @node HPPA Options
9836 @subsection HPPA Options
9837 @cindex HPPA Options
9839 These @samp{-m} options are defined for the HPPA family of computers:
9841 @table @gcctabopt
9842 @item -march=@var{architecture-type}
9843 @opindex march
9844 Generate code for the specified architecture.  The choices for
9845 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9846 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9847 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9848 architecture option for your machine.  Code compiled for lower numbered
9849 architectures will run on higher numbered architectures, but not the
9850 other way around.
9852 @item -mpa-risc-1-0
9853 @itemx -mpa-risc-1-1
9854 @itemx -mpa-risc-2-0
9855 @opindex mpa-risc-1-0
9856 @opindex mpa-risc-1-1
9857 @opindex mpa-risc-2-0
9858 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9860 @item -mbig-switch
9861 @opindex mbig-switch
9862 Generate code suitable for big switch tables.  Use this option only if
9863 the assembler/linker complain about out of range branches within a switch
9864 table.
9866 @item -mjump-in-delay
9867 @opindex mjump-in-delay
9868 Fill delay slots of function calls with unconditional jump instructions
9869 by modifying the return pointer for the function call to be the target
9870 of the conditional jump.
9872 @item -mdisable-fpregs
9873 @opindex mdisable-fpregs
9874 Prevent floating point registers from being used in any manner.  This is
9875 necessary for compiling kernels which perform lazy context switching of
9876 floating point registers.  If you use this option and attempt to perform
9877 floating point operations, the compiler will abort.
9879 @item -mdisable-indexing
9880 @opindex mdisable-indexing
9881 Prevent the compiler from using indexing address modes.  This avoids some
9882 rather obscure problems when compiling MIG generated code under MACH@.
9884 @item -mno-space-regs
9885 @opindex mno-space-regs
9886 Generate code that assumes the target has no space registers.  This allows
9887 GCC to generate faster indirect calls and use unscaled index address modes.
9889 Such code is suitable for level 0 PA systems and kernels.
9891 @item -mfast-indirect-calls
9892 @opindex mfast-indirect-calls
9893 Generate code that assumes calls never cross space boundaries.  This
9894 allows GCC to emit code which performs faster indirect calls.
9896 This option will not work in the presence of shared libraries or nested
9897 functions.
9899 @item -mfixed-range=@var{register-range}
9900 @opindex mfixed-range
9901 Generate code treating the given register range as fixed registers.
9902 A fixed register is one that the register allocator can not use.  This is
9903 useful when compiling kernel code.  A register range is specified as
9904 two registers separated by a dash.  Multiple register ranges can be
9905 specified separated by a comma.
9907 @item -mlong-load-store
9908 @opindex mlong-load-store
9909 Generate 3-instruction load and store sequences as sometimes required by
9910 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9911 the HP compilers.
9913 @item -mportable-runtime
9914 @opindex mportable-runtime
9915 Use the portable calling conventions proposed by HP for ELF systems.
9917 @item -mgas
9918 @opindex mgas
9919 Enable the use of assembler directives only GAS understands.
9921 @item -mschedule=@var{cpu-type}
9922 @opindex mschedule
9923 Schedule code according to the constraints for the machine type
9924 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9925 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9926 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9927 proper scheduling option for your machine.  The default scheduling is
9928 @samp{8000}.
9930 @item -mlinker-opt
9931 @opindex mlinker-opt
9932 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9933 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9934 linkers in which they give bogus error messages when linking some programs.
9936 @item -msoft-float
9937 @opindex msoft-float
9938 Generate output containing library calls for floating point.
9939 @strong{Warning:} the requisite libraries are not available for all HPPA
9940 targets.  Normally the facilities of the machine's usual C compiler are
9941 used, but this cannot be done directly in cross-compilation.  You must make
9942 your own arrangements to provide suitable library functions for
9943 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9944 does provide software floating point support.
9946 @option{-msoft-float} changes the calling convention in the output file;
9947 therefore, it is only useful if you compile @emph{all} of a program with
9948 this option.  In particular, you need to compile @file{libgcc.a}, the
9949 library that comes with GCC, with @option{-msoft-float} in order for
9950 this to work.
9952 @item -msio
9953 @opindex msio
9954 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9955 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9956 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9957 options are available under HP-UX and HI-UX@.
9959 @item -mgnu-ld
9960 @opindex gnu-ld
9961 Use GNU ld specific options.  This passes @option{-shared} to ld when
9962 building a shared library.  It is the default when GCC is configured,
9963 explicitly or implicitly, with the GNU linker.  This option does not
9964 have any affect on which ld is called, it only changes what parameters
9965 are passed to that ld.  The ld that is called is determined by the
9966 @option{--with-ld} configure option, GCC's program search path, and
9967 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9968 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9969 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9971 @item -mhp-ld
9972 @opindex hp-ld
9973 Use HP ld specific options.  This passes @option{-b} to ld when building
9974 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9975 links.  It is the default when GCC is configured, explicitly or
9976 implicitly, with the HP linker.  This option does not have any affect on
9977 which ld is called, it only changes what parameters are passed to that
9978 ld.  The ld that is called is determined by the @option{--with-ld}
9979 configure option, GCC's program search path, and finally by the user's
9980 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9981 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9982 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9984 @item -mlong-calls
9985 @opindex mno-long-calls
9986 Generate code that uses long call sequences.  This ensures that a call
9987 is always able to reach linker generated stubs.  The default is to generate
9988 long calls only when the distance from the call site to the beginning
9989 of the function or translation unit, as the case may be, exceeds a
9990 predefined limit set by the branch type being used.  The limits for
9991 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9992 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9993 240,000 bytes.
9995 Distances are measured from the beginning of functions when using the
9996 @option{-ffunction-sections} option, or when using the @option{-mgas}
9997 and @option{-mno-portable-runtime} options together under HP-UX with
9998 the SOM linker.
10000 It is normally not desirable to use this option as it will degrade
10001 performance.  However, it may be useful in large applications,
10002 particularly when partial linking is used to build the application.
10004 The types of long calls used depends on the capabilities of the
10005 assembler and linker, and the type of code being generated.  The
10006 impact on systems that support long absolute calls, and long pic
10007 symbol-difference or pc-relative calls should be relatively small.
10008 However, an indirect call is used on 32-bit ELF systems in pic code
10009 and it is quite long.
10011 @item -munix=@var{unix-std}
10012 @opindex march
10013 Generate compiler predefines and select a startfile for the specified
10014 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
10015 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
10016 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
10017 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
10018 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
10019 and later.
10021 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
10022 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
10023 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
10024 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
10025 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
10026 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
10028 It is @emph{important} to note that this option changes the interfaces
10029 for various library routines.  It also affects the operational behavior
10030 of the C library.  Thus, @emph{extreme} care is needed in using this
10031 option.
10033 Library code that is intended to operate with more than one UNIX
10034 standard must test, set and restore the variable @var{__xpg4_extended_mask}
10035 as appropriate.  Most GNU software doesn't provide this capability.
10037 @item -nolibdld
10038 @opindex nolibdld
10039 Suppress the generation of link options to search libdld.sl when the
10040 @option{-static} option is specified on HP-UX 10 and later.
10042 @item -static
10043 @opindex static
10044 The HP-UX implementation of setlocale in libc has a dependency on
10045 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
10046 when the @option{-static} option is specified, special link options
10047 are needed to resolve this dependency.
10049 On HP-UX 10 and later, the GCC driver adds the necessary options to
10050 link with libdld.sl when the @option{-static} option is specified.
10051 This causes the resulting binary to be dynamic.  On the 64-bit port,
10052 the linkers generate dynamic binaries by default in any case.  The
10053 @option{-nolibdld} option can be used to prevent the GCC driver from
10054 adding these link options.
10056 @item -threads
10057 @opindex threads
10058 Add support for multithreading with the @dfn{dce thread} library
10059 under HP-UX@.  This option sets flags for both the preprocessor and
10060 linker.
10061 @end table
10063 @node i386 and x86-64 Options
10064 @subsection Intel 386 and AMD x86-64 Options
10065 @cindex i386 Options
10066 @cindex x86-64 Options
10067 @cindex Intel 386 Options
10068 @cindex AMD x86-64 Options
10070 These @samp{-m} options are defined for the i386 and x86-64 family of
10071 computers:
10073 @table @gcctabopt
10074 @item -mtune=@var{cpu-type}
10075 @opindex mtune
10076 Tune to @var{cpu-type} everything applicable about the generated code, except
10077 for the ABI and the set of available instructions.  The choices for
10078 @var{cpu-type} are:
10079 @table @emph
10080 @item generic
10081 Produce code optimized for the most common IA32/AMD64/EM64T processors.
10082 If you know the CPU on which your code will run, then you should use
10083 the corresponding @option{-mtune} option instead of
10084 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
10085 of your application will have, then you should use this option.
10087 As new processors are deployed in the marketplace, the behavior of this
10088 option will change.  Therefore, if you upgrade to a newer version of
10089 GCC, the code generated option will change to reflect the processors
10090 that were most common when that version of GCC was released.
10092 There is no @option{-march=generic} option because @option{-march}
10093 indicates the instruction set the compiler can use, and there is no
10094 generic instruction set applicable to all processors.  In contrast,
10095 @option{-mtune} indicates the processor (or, in this case, collection of
10096 processors) for which the code is optimized.
10097 @item native
10098 This selects the CPU to tune for at compilation time by determining
10099 the processor type of the compiling machine.  Using @option{-mtune=native}
10100 will produce code optimized for the local machine under the constraints
10101 of the selected instruction set.  Using @option{-march=native} will
10102 enable all instruction subsets supported by the local machine (hence
10103 the result might not run on different machines).
10104 @item i386
10105 Original Intel's i386 CPU@.
10106 @item i486
10107 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
10108 @item i586, pentium
10109 Intel Pentium CPU with no MMX support.
10110 @item pentium-mmx
10111 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
10112 @item pentiumpro
10113 Intel PentiumPro CPU@.
10114 @item i686
10115 Same as @code{generic}, but when used as @code{march} option, PentiumPro
10116 instruction set will be used, so the code will run on all i686 family chips.
10117 @item pentium2
10118 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
10119 @item pentium3, pentium3m
10120 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
10121 support.
10122 @item pentium-m
10123 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
10124 support.  Used by Centrino notebooks.
10125 @item pentium4, pentium4m
10126 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
10127 @item prescott
10128 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
10129 set support.
10130 @item nocona
10131 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
10132 SSE2 and SSE3 instruction set support.
10133 @item core2
10134 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
10135 instruction set support.
10136 @item k6
10137 AMD K6 CPU with MMX instruction set support.
10138 @item k6-2, k6-3
10139 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
10140 @item athlon, athlon-tbird
10141 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
10142 support.
10143 @item athlon-4, athlon-xp, athlon-mp
10144 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
10145 instruction set support.
10146 @item k8, opteron, athlon64, athlon-fx
10147 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
10148 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
10149 @item k8-sse3, opteron-sse3, athlon64-sse3
10150 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
10151 @item amdfam10, barcelona
10152 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
10153 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
10154 instruction set extensions.)
10155 @item winchip-c6
10156 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
10157 set support.
10158 @item winchip2
10159 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
10160 instruction set support.
10161 @item c3
10162 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
10163 implemented for this chip.)
10164 @item c3-2
10165 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
10166 implemented for this chip.)
10167 @item geode
10168 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
10169 @end table
10171 While picking a specific @var{cpu-type} will schedule things appropriately
10172 for that particular chip, the compiler will not generate any code that
10173 does not run on the i386 without the @option{-march=@var{cpu-type}} option
10174 being used.
10176 @item -march=@var{cpu-type}
10177 @opindex march
10178 Generate instructions for the machine type @var{cpu-type}.  The choices
10179 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
10180 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
10182 @item -mcpu=@var{cpu-type}
10183 @opindex mcpu
10184 A deprecated synonym for @option{-mtune}.
10186 @item -mfpmath=@var{unit}
10187 @opindex march
10188 Generate floating point arithmetics for selected unit @var{unit}.  The choices
10189 for @var{unit} are:
10191 @table @samp
10192 @item 387
10193 Use the standard 387 floating point coprocessor present majority of chips and
10194 emulated otherwise.  Code compiled with this option will run almost everywhere.
10195 The temporary results are computed in 80bit precision instead of precision
10196 specified by the type resulting in slightly different results compared to most
10197 of other chips.  See @option{-ffloat-store} for more detailed description.
10199 This is the default choice for i386 compiler.
10201 @item sse
10202 Use scalar floating point instructions present in the SSE instruction set.
10203 This instruction set is supported by Pentium3 and newer chips, in the AMD line
10204 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
10205 instruction set supports only single precision arithmetics, thus the double and
10206 extended precision arithmetics is still done using 387.  Later version, present
10207 only in Pentium4 and the future AMD x86-64 chips supports double precision
10208 arithmetics too.
10210 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
10211 or @option{-msse2} switches to enable SSE extensions and make this option
10212 effective.  For the x86-64 compiler, these extensions are enabled by default.
10214 The resulting code should be considerably faster in the majority of cases and avoid
10215 the numerical instability problems of 387 code, but may break some existing
10216 code that expects temporaries to be 80bit.
10218 This is the default choice for the x86-64 compiler.
10220 @item sse,387
10221 Attempt to utilize both instruction sets at once.  This effectively double the
10222 amount of available registers and on chips with separate execution units for
10223 387 and SSE the execution resources too.  Use this option with care, as it is
10224 still experimental, because the GCC register allocator does not model separate
10225 functional units well resulting in instable performance.
10226 @end table
10228 @item -masm=@var{dialect}
10229 @opindex masm=@var{dialect}
10230 Output asm instructions using selected @var{dialect}.  Supported
10231 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
10232 not support @samp{intel}.
10234 @item -mieee-fp
10235 @itemx -mno-ieee-fp
10236 @opindex mieee-fp
10237 @opindex mno-ieee-fp
10238 Control whether or not the compiler uses IEEE floating point
10239 comparisons.  These handle correctly the case where the result of a
10240 comparison is unordered.
10242 @item -msoft-float
10243 @opindex msoft-float
10244 Generate output containing library calls for floating point.
10245 @strong{Warning:} the requisite libraries are not part of GCC@.
10246 Normally the facilities of the machine's usual C compiler are used, but
10247 this can't be done directly in cross-compilation.  You must make your
10248 own arrangements to provide suitable library functions for
10249 cross-compilation.
10251 On machines where a function returns floating point results in the 80387
10252 register stack, some floating point opcodes may be emitted even if
10253 @option{-msoft-float} is used.
10255 @item -mno-fp-ret-in-387
10256 @opindex mno-fp-ret-in-387
10257 Do not use the FPU registers for return values of functions.
10259 The usual calling convention has functions return values of types
10260 @code{float} and @code{double} in an FPU register, even if there
10261 is no FPU@.  The idea is that the operating system should emulate
10262 an FPU@.
10264 The option @option{-mno-fp-ret-in-387} causes such values to be returned
10265 in ordinary CPU registers instead.
10267 @item -mno-fancy-math-387
10268 @opindex mno-fancy-math-387
10269 Some 387 emulators do not support the @code{sin}, @code{cos} and
10270 @code{sqrt} instructions for the 387.  Specify this option to avoid
10271 generating those instructions.  This option is the default on FreeBSD,
10272 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
10273 indicates that the target cpu will always have an FPU and so the
10274 instruction will not need emulation.  As of revision 2.6.1, these
10275 instructions are not generated unless you also use the
10276 @option{-funsafe-math-optimizations} switch.
10278 @item -malign-double
10279 @itemx -mno-align-double
10280 @opindex malign-double
10281 @opindex mno-align-double
10282 Control whether GCC aligns @code{double}, @code{long double}, and
10283 @code{long long} variables on a two word boundary or a one word
10284 boundary.  Aligning @code{double} variables on a two word boundary will
10285 produce code that runs somewhat faster on a @samp{Pentium} at the
10286 expense of more memory.
10288 On x86-64, @option{-malign-double} is enabled by default.
10290 @strong{Warning:} if you use the @option{-malign-double} switch,
10291 structures containing the above types will be aligned differently than
10292 the published application binary interface specifications for the 386
10293 and will not be binary compatible with structures in code compiled
10294 without that switch.
10296 @item -m96bit-long-double
10297 @itemx -m128bit-long-double
10298 @opindex m96bit-long-double
10299 @opindex m128bit-long-double
10300 These switches control the size of @code{long double} type.  The i386
10301 application binary interface specifies the size to be 96 bits,
10302 so @option{-m96bit-long-double} is the default in 32 bit mode.
10304 Modern architectures (Pentium and newer) would prefer @code{long double}
10305 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
10306 conforming to the ABI, this would not be possible.  So specifying a
10307 @option{-m128bit-long-double} will align @code{long double}
10308 to a 16 byte boundary by padding the @code{long double} with an additional
10309 32 bit zero.
10311 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
10312 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
10314 Notice that neither of these options enable any extra precision over the x87
10315 standard of 80 bits for a @code{long double}.
10317 @strong{Warning:} if you override the default value for your target ABI, the
10318 structures and arrays containing @code{long double} variables will change
10319 their size as well as function calling convention for function taking
10320 @code{long double} will be modified.  Hence they will not be binary
10321 compatible with arrays or structures in code compiled without that switch.
10323 @item -mmlarge-data-threshold=@var{number}
10324 @opindex mlarge-data-threshold=@var{number}
10325 When @option{-mcmodel=medium} is specified, the data greater than
10326 @var{threshold} are placed in large data section.  This value must be the
10327 same across all object linked into the binary and defaults to 65535.
10329 @item -mrtd
10330 @opindex mrtd
10331 Use a different function-calling convention, in which functions that
10332 take a fixed number of arguments return with the @code{ret} @var{num}
10333 instruction, which pops their arguments while returning.  This saves one
10334 instruction in the caller since there is no need to pop the arguments
10335 there.
10337 You can specify that an individual function is called with this calling
10338 sequence with the function attribute @samp{stdcall}.  You can also
10339 override the @option{-mrtd} option by using the function attribute
10340 @samp{cdecl}.  @xref{Function Attributes}.
10342 @strong{Warning:} this calling convention is incompatible with the one
10343 normally used on Unix, so you cannot use it if you need to call
10344 libraries compiled with the Unix compiler.
10346 Also, you must provide function prototypes for all functions that
10347 take variable numbers of arguments (including @code{printf});
10348 otherwise incorrect code will be generated for calls to those
10349 functions.
10351 In addition, seriously incorrect code will result if you call a
10352 function with too many arguments.  (Normally, extra arguments are
10353 harmlessly ignored.)
10355 @item -mregparm=@var{num}
10356 @opindex mregparm
10357 Control how many registers are used to pass integer arguments.  By
10358 default, no registers are used to pass arguments, and at most 3
10359 registers can be used.  You can control this behavior for a specific
10360 function by using the function attribute @samp{regparm}.
10361 @xref{Function Attributes}.
10363 @strong{Warning:} if you use this switch, and
10364 @var{num} is nonzero, then you must build all modules with the same
10365 value, including any libraries.  This includes the system libraries and
10366 startup modules.
10368 @item -msseregparm
10369 @opindex msseregparm
10370 Use SSE register passing conventions for float and double arguments
10371 and return values.  You can control this behavior for a specific
10372 function by using the function attribute @samp{sseregparm}.
10373 @xref{Function Attributes}.
10375 @strong{Warning:} if you use this switch then you must build all
10376 modules with the same value, including any libraries.  This includes
10377 the system libraries and startup modules.
10379 @item -mpc32
10380 @itemx -mpc64
10381 @itemx -mpc80
10382 @opindex mpc32
10383 @opindex mpc64
10384 @opindex mpc80
10386 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
10387 is specified, the significands of results of floating-point operations are
10388 rounded to 24 bits (single precision); @option{-mpc64} rounds the the
10389 significands of results of floating-point operations to 53 bits (double
10390 precision) and @option{-mpc80} rounds the significands of results of
10391 floating-point operations to 64 bits (extended double precision), which is
10392 the default.  When this option is used, floating-point operations in higher
10393 precisions are not available to the programmer without setting the FPU
10394 control word explicitly.
10396 Setting the rounding of floating-point operations to less than the default
10397 80 bits can speed some programs by 2% or more.  Note that some mathematical
10398 libraries assume that extended precision (80 bit) floating-point operations
10399 are enabled by default; routines in such libraries could suffer significant
10400 loss of accuracy, typically through so-called "catastrophic cancellation",
10401 when this option is used to set the precision to less than extended precision. 
10403 @item -mstackrealign
10404 @opindex mstackrealign
10405 Realign the stack at entry.  On the Intel x86, the
10406 @option{-mstackrealign} option will generate an alternate prologue and
10407 epilogue that realigns the runtime stack.  This supports mixing legacy
10408 codes that keep a 4-byte aligned stack with modern codes that keep a
10409 16-byte stack for SSE compatibility.  The alternate prologue and
10410 epilogue are slower and bigger than the regular ones, and the
10411 alternate prologue requires an extra scratch register; this lowers the
10412 number of registers available if used in conjunction with the
10413 @code{regparm} attribute.  The @option{-mstackrealign} option is
10414 incompatible with the nested function prologue; this is considered a
10415 hard error.  See also the attribute @code{force_align_arg_pointer},
10416 applicable to individual functions.
10418 @item -mpreferred-stack-boundary=@var{num}
10419 @opindex mpreferred-stack-boundary
10420 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
10421 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
10422 the default is 4 (16 bytes or 128 bits).
10424 On Pentium and PentiumPro, @code{double} and @code{long double} values
10425 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
10426 suffer significant run time performance penalties.  On Pentium III, the
10427 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
10428 properly if it is not 16 byte aligned.
10430 To ensure proper alignment of this values on the stack, the stack boundary
10431 must be as aligned as that required by any value stored on the stack.
10432 Further, every function must be generated such that it keeps the stack
10433 aligned.  Thus calling a function compiled with a higher preferred
10434 stack boundary from a function compiled with a lower preferred stack
10435 boundary will most likely misalign the stack.  It is recommended that
10436 libraries that use callbacks always use the default setting.
10438 This extra alignment does consume extra stack space, and generally
10439 increases code size.  Code that is sensitive to stack space usage, such
10440 as embedded systems and operating system kernels, may want to reduce the
10441 preferred alignment to @option{-mpreferred-stack-boundary=2}.
10443 @item -mmmx
10444 @itemx -mno-mmx
10445 @item -msse
10446 @itemx -mno-sse
10447 @item -msse2
10448 @itemx -mno-sse2
10449 @item -msse3
10450 @itemx -mno-sse3
10451 @item -mssse3
10452 @itemx -mno-ssse3
10453 @item -msse4.1
10454 @itemx -mno-sse4.1
10455 @item -msse4.2
10456 @itemx -mno-sse4.2
10457 @item -msse4
10458 @itemx -mno-sse4
10459 @item -msse4a
10460 @item -mno-sse4a
10461 @item -m3dnow
10462 @itemx -mno-3dnow
10463 @item -mpopcnt
10464 @itemx -mno-popcnt
10465 @item -mabm
10466 @itemx -mno-abm
10467 @opindex mmmx
10468 @opindex mno-mmx
10469 @opindex msse
10470 @opindex mno-sse
10471 @opindex m3dnow
10472 @opindex mno-3dnow
10473 These switches enable or disable the use of instructions in the MMX,
10474 SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4A, ABM or 3DNow! extended
10475 instruction sets.
10476 These extensions are also available as built-in functions: see
10477 @ref{X86 Built-in Functions}, for details of the functions enabled and
10478 disabled by these switches.
10480 To have SSE/SSE2 instructions generated automatically from floating-point
10481 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
10483 These options will enable GCC to use these extended instructions in
10484 generated code, even without @option{-mfpmath=sse}.  Applications which
10485 perform runtime CPU detection must compile separate files for each
10486 supported architecture, using the appropriate flags.  In particular,
10487 the file containing the CPU detection code should be compiled without
10488 these options.
10490 @item -mcx16
10491 @opindex mcx16
10492 This option will enable GCC to use CMPXCHG16B instruction in generated code.
10493 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
10494 data types.  This is useful for high resolution counters that could be updated
10495 by multiple processors (or cores).  This instruction is generated as part of
10496 atomic built-in functions: see @ref{Atomic Builtins} for details.
10498 @item -msahf
10499 @opindex msahf
10500 This option will enable GCC to use SAHF instruction in generated 64-bit code.
10501 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
10502 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
10503 SAHF are load and store instructions, respectively, for certain status flags.
10504 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
10505 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
10507 @item -mrecip
10508 @opindex mrecip
10509 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
10510 vectorized variants RCPPS and RSQRTPS) instead of DIVSS and SQRTSS (and their
10511 vectorized variants).  These instructions will be generated only when
10512 @option{-funsafe-math-optimizations} is enabled.
10514 @item -mveclibabi=@var{type}
10515 @opindex mveclibabi
10516 Specifies the ABI type to use for vectorizing intrinsics using an
10517 external library.  Supported types are @code{acml} for the AMD
10518 math core library style of interfacing.  GCC will currently emit
10519 calls to @code{__vrd2_sin}, @code{__vrd2_cos}, @code{__vrd2_exp},
10520 @code{__vrd2_log}, @code{__vrd2_log2}, @code{__vrd2_log10},
10521 @code{__vrs4_sinf}, @code{__vrs4_cosf}, @code{__vrs4_expf},
10522 @code{__vrs4_logf}, @code{__vrs4_log2f}, @code{__vrs4_log10f}
10523 and @code{__vrs4_powf} when using this type and @option{-ftree-vectorize}
10524 is enabled.  A ACML ABI compatible library will have to be specified
10525 at link time.
10527 @item -mpush-args
10528 @itemx -mno-push-args
10529 @opindex mpush-args
10530 @opindex mno-push-args
10531 Use PUSH operations to store outgoing parameters.  This method is shorter
10532 and usually equally fast as method using SUB/MOV operations and is enabled
10533 by default.  In some cases disabling it may improve performance because of
10534 improved scheduling and reduced dependencies.
10536 @item -maccumulate-outgoing-args
10537 @opindex maccumulate-outgoing-args
10538 If enabled, the maximum amount of space required for outgoing arguments will be
10539 computed in the function prologue.  This is faster on most modern CPUs
10540 because of reduced dependencies, improved scheduling and reduced stack usage
10541 when preferred stack boundary is not equal to 2.  The drawback is a notable
10542 increase in code size.  This switch implies @option{-mno-push-args}.
10544 @item -mthreads
10545 @opindex mthreads
10546 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
10547 on thread-safe exception handling must compile and link all code with the
10548 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
10549 @option{-D_MT}; when linking, it links in a special thread helper library
10550 @option{-lmingwthrd} which cleans up per thread exception handling data.
10552 @item -mno-align-stringops
10553 @opindex mno-align-stringops
10554 Do not align destination of inlined string operations.  This switch reduces
10555 code size and improves performance in case the destination is already aligned,
10556 but GCC doesn't know about it.
10558 @item -minline-all-stringops
10559 @opindex minline-all-stringops
10560 By default GCC inlines string operations only when destination is known to be
10561 aligned at least to 4 byte boundary.  This enables more inlining, increase code
10562 size, but may improve performance of code that depends on fast memcpy, strlen
10563 and memset for short lengths.
10565 @item -minline-stringops-dynamically
10566 @opindex minline-stringops-dynamically
10567 For string operation of unknown size, inline runtime checks so for small
10568 blocks inline code is used, while for large blocks library call is used.
10570 @item -mstringop-strategy=@var{alg}
10571 @opindex mstringop-strategy=@var{alg}
10572 Overwrite internal decision heuristic about particular algorithm to inline
10573 string operation with.  The allowed values are @code{rep_byte},
10574 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
10575 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
10576 expanding inline loop, @code{libcall} for always expanding library call.
10578 @item -momit-leaf-frame-pointer
10579 @opindex momit-leaf-frame-pointer
10580 Don't keep the frame pointer in a register for leaf functions.  This
10581 avoids the instructions to save, set up and restore frame pointers and
10582 makes an extra register available in leaf functions.  The option
10583 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10584 which might make debugging harder.
10586 @item -mtls-direct-seg-refs
10587 @itemx -mno-tls-direct-seg-refs
10588 @opindex mtls-direct-seg-refs
10589 Controls whether TLS variables may be accessed with offsets from the
10590 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
10591 or whether the thread base pointer must be added.  Whether or not this
10592 is legal depends on the operating system, and whether it maps the
10593 segment to cover the entire TLS area.
10595 For systems that use GNU libc, the default is on.
10596 @end table
10598 These @samp{-m} switches are supported in addition to the above
10599 on AMD x86-64 processors in 64-bit environments.
10601 @table @gcctabopt
10602 @item -m32
10603 @itemx -m64
10604 @opindex m32
10605 @opindex m64
10606 Generate code for a 32-bit or 64-bit environment.
10607 The 32-bit environment sets int, long and pointer to 32 bits and
10608 generates code that runs on any i386 system.
10609 The 64-bit environment sets int to 32 bits and long and pointer
10610 to 64 bits and generates code for AMD's x86-64 architecture. For
10611 darwin only the -m64 option turns off the @option{-fno-pic} and
10612 @option{-mdynamic-no-pic} options.
10614 @item -mno-red-zone
10615 @opindex no-red-zone
10616 Do not use a so called red zone for x86-64 code.  The red zone is mandated
10617 by the x86-64 ABI, it is a 128-byte area beyond the location of the
10618 stack pointer that will not be modified by signal or interrupt handlers
10619 and therefore can be used for temporary data without adjusting the stack
10620 pointer.  The flag @option{-mno-red-zone} disables this red zone.
10622 @item -mcmodel=small
10623 @opindex mcmodel=small
10624 Generate code for the small code model: the program and its symbols must
10625 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
10626 Programs can be statically or dynamically linked.  This is the default
10627 code model.
10629 @item -mcmodel=kernel
10630 @opindex mcmodel=kernel
10631 Generate code for the kernel code model.  The kernel runs in the
10632 negative 2 GB of the address space.
10633 This model has to be used for Linux kernel code.
10635 @item -mcmodel=medium
10636 @opindex mcmodel=medium
10637 Generate code for the medium model: The program is linked in the lower 2
10638 GB of the address space but symbols can be located anywhere in the
10639 address space.  Programs can be statically or dynamically linked, but
10640 building of shared libraries are not supported with the medium model.
10642 @item -mcmodel=large
10643 @opindex mcmodel=large
10644 Generate code for the large model: This model makes no assumptions
10645 about addresses and sizes of sections.
10646 @end table
10648 @node IA-64 Options
10649 @subsection IA-64 Options
10650 @cindex IA-64 Options
10652 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10654 @table @gcctabopt
10655 @item -mbig-endian
10656 @opindex mbig-endian
10657 Generate code for a big endian target.  This is the default for HP-UX@.
10659 @item -mlittle-endian
10660 @opindex mlittle-endian
10661 Generate code for a little endian target.  This is the default for AIX5
10662 and GNU/Linux.
10664 @item -mgnu-as
10665 @itemx -mno-gnu-as
10666 @opindex mgnu-as
10667 @opindex mno-gnu-as
10668 Generate (or don't) code for the GNU assembler.  This is the default.
10669 @c Also, this is the default if the configure option @option{--with-gnu-as}
10670 @c is used.
10672 @item -mgnu-ld
10673 @itemx -mno-gnu-ld
10674 @opindex mgnu-ld
10675 @opindex mno-gnu-ld
10676 Generate (or don't) code for the GNU linker.  This is the default.
10677 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10678 @c is used.
10680 @item -mno-pic
10681 @opindex mno-pic
10682 Generate code that does not use a global pointer register.  The result
10683 is not position independent code, and violates the IA-64 ABI@.
10685 @item -mvolatile-asm-stop
10686 @itemx -mno-volatile-asm-stop
10687 @opindex mvolatile-asm-stop
10688 @opindex mno-volatile-asm-stop
10689 Generate (or don't) a stop bit immediately before and after volatile asm
10690 statements.
10692 @item -mregister-names
10693 @itemx -mno-register-names
10694 @opindex mregister-names
10695 @opindex mno-register-names
10696 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10697 the stacked registers.  This may make assembler output more readable.
10699 @item -mno-sdata
10700 @itemx -msdata
10701 @opindex mno-sdata
10702 @opindex msdata
10703 Disable (or enable) optimizations that use the small data section.  This may
10704 be useful for working around optimizer bugs.
10706 @item -mconstant-gp
10707 @opindex mconstant-gp
10708 Generate code that uses a single constant global pointer value.  This is
10709 useful when compiling kernel code.
10711 @item -mauto-pic
10712 @opindex mauto-pic
10713 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10714 This is useful when compiling firmware code.
10716 @item -minline-float-divide-min-latency
10717 @opindex minline-float-divide-min-latency
10718 Generate code for inline divides of floating point values
10719 using the minimum latency algorithm.
10721 @item -minline-float-divide-max-throughput
10722 @opindex minline-float-divide-max-throughput
10723 Generate code for inline divides of floating point values
10724 using the maximum throughput algorithm.
10726 @item -minline-int-divide-min-latency
10727 @opindex minline-int-divide-min-latency
10728 Generate code for inline divides of integer values
10729 using the minimum latency algorithm.
10731 @item -minline-int-divide-max-throughput
10732 @opindex minline-int-divide-max-throughput
10733 Generate code for inline divides of integer values
10734 using the maximum throughput algorithm.
10736 @item -minline-sqrt-min-latency
10737 @opindex minline-sqrt-min-latency
10738 Generate code for inline square roots
10739 using the minimum latency algorithm.
10741 @item -minline-sqrt-max-throughput
10742 @opindex minline-sqrt-max-throughput
10743 Generate code for inline square roots
10744 using the maximum throughput algorithm.
10746 @item -mno-dwarf2-asm
10747 @itemx -mdwarf2-asm
10748 @opindex mno-dwarf2-asm
10749 @opindex mdwarf2-asm
10750 Don't (or do) generate assembler code for the DWARF2 line number debugging
10751 info.  This may be useful when not using the GNU assembler.
10753 @item -mearly-stop-bits
10754 @itemx -mno-early-stop-bits
10755 @opindex mearly-stop-bits
10756 @opindex mno-early-stop-bits
10757 Allow stop bits to be placed earlier than immediately preceding the
10758 instruction that triggered the stop bit.  This can improve instruction
10759 scheduling, but does not always do so.
10761 @item -mfixed-range=@var{register-range}
10762 @opindex mfixed-range
10763 Generate code treating the given register range as fixed registers.
10764 A fixed register is one that the register allocator can not use.  This is
10765 useful when compiling kernel code.  A register range is specified as
10766 two registers separated by a dash.  Multiple register ranges can be
10767 specified separated by a comma.
10769 @item -mtls-size=@var{tls-size}
10770 @opindex mtls-size
10771 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
10774 @item -mtune=@var{cpu-type}
10775 @opindex mtune
10776 Tune the instruction scheduling for a particular CPU, Valid values are
10777 itanium, itanium1, merced, itanium2, and mckinley.
10779 @item -mt
10780 @itemx -pthread
10781 @opindex mt
10782 @opindex pthread
10783 Add support for multithreading using the POSIX threads library.  This
10784 option sets flags for both the preprocessor and linker.  It does
10785 not affect the thread safety of object code produced by the compiler or
10786 that of libraries supplied with it.  These are HP-UX specific flags.
10788 @item -milp32
10789 @itemx -mlp64
10790 @opindex milp32
10791 @opindex mlp64
10792 Generate code for a 32-bit or 64-bit environment.
10793 The 32-bit environment sets int, long and pointer to 32 bits.
10794 The 64-bit environment sets int to 32 bits and long and pointer
10795 to 64 bits.  These are HP-UX specific flags.
10797 @item -mno-sched-br-data-spec
10798 @itemx -msched-br-data-spec
10799 @opindex mno-sched-br-data-spec
10800 @opindex msched-br-data-spec
10801 (Dis/En)able data speculative scheduling before reload.
10802 This will result in generation of the ld.a instructions and
10803 the corresponding check instructions (ld.c / chk.a).
10804 The default is 'disable'.
10806 @item -msched-ar-data-spec
10807 @itemx -mno-sched-ar-data-spec
10808 @opindex msched-ar-data-spec
10809 @opindex mno-sched-ar-data-spec
10810 (En/Dis)able data speculative scheduling after reload.
10811 This will result in generation of the ld.a instructions and
10812 the corresponding check instructions (ld.c / chk.a).
10813 The default is 'enable'.
10815 @item -mno-sched-control-spec
10816 @itemx -msched-control-spec
10817 @opindex mno-sched-control-spec
10818 @opindex msched-control-spec
10819 (Dis/En)able control speculative scheduling.  This feature is
10820 available only during region scheduling (i.e. before reload).
10821 This will result in generation of the ld.s instructions and
10822 the corresponding check instructions chk.s .
10823 The default is 'disable'.
10825 @item -msched-br-in-data-spec
10826 @itemx -mno-sched-br-in-data-spec
10827 @opindex msched-br-in-data-spec
10828 @opindex mno-sched-br-in-data-spec
10829 (En/Dis)able speculative scheduling of the instructions that
10830 are dependent on the data speculative loads before reload.
10831 This is effective only with @option{-msched-br-data-spec} enabled.
10832 The default is 'enable'.
10834 @item -msched-ar-in-data-spec
10835 @itemx -mno-sched-ar-in-data-spec
10836 @opindex msched-ar-in-data-spec
10837 @opindex mno-sched-ar-in-data-spec
10838 (En/Dis)able speculative scheduling of the instructions that
10839 are dependent on the data speculative loads after reload.
10840 This is effective only with @option{-msched-ar-data-spec} enabled.
10841 The default is 'enable'.
10843 @item -msched-in-control-spec
10844 @itemx -mno-sched-in-control-spec
10845 @opindex msched-in-control-spec
10846 @opindex mno-sched-in-control-spec
10847 (En/Dis)able speculative scheduling of the instructions that
10848 are dependent on the control speculative loads.
10849 This is effective only with @option{-msched-control-spec} enabled.
10850 The default is 'enable'.
10852 @item -msched-ldc
10853 @itemx -mno-sched-ldc
10854 @opindex msched-ldc
10855 @opindex mno-sched-ldc
10856 (En/Dis)able use of simple data speculation checks ld.c .
10857 If disabled, only chk.a instructions will be emitted to check
10858 data speculative loads.
10859 The default is 'enable'.
10861 @item -mno-sched-control-ldc
10862 @itemx -msched-control-ldc
10863 @opindex mno-sched-control-ldc
10864 @opindex msched-control-ldc
10865 (Dis/En)able use of ld.c instructions to check control speculative loads.
10866 If enabled, in case of control speculative load with no speculatively
10867 scheduled dependent instructions this load will be emitted as ld.sa and
10868 ld.c will be used to check it.
10869 The default is 'disable'.
10871 @item -mno-sched-spec-verbose
10872 @itemx -msched-spec-verbose
10873 @opindex mno-sched-spec-verbose
10874 @opindex msched-spec-verbose
10875 (Dis/En)able printing of the information about speculative motions.
10877 @item -mno-sched-prefer-non-data-spec-insns
10878 @itemx -msched-prefer-non-data-spec-insns
10879 @opindex mno-sched-prefer-non-data-spec-insns
10880 @opindex msched-prefer-non-data-spec-insns
10881 If enabled, data speculative instructions will be chosen for schedule
10882 only if there are no other choices at the moment.  This will make
10883 the use of the data speculation much more conservative.
10884 The default is 'disable'.
10886 @item -mno-sched-prefer-non-control-spec-insns
10887 @itemx -msched-prefer-non-control-spec-insns
10888 @opindex mno-sched-prefer-non-control-spec-insns
10889 @opindex msched-prefer-non-control-spec-insns
10890 If enabled, control speculative instructions will be chosen for schedule
10891 only if there are no other choices at the moment.  This will make
10892 the use of the control speculation much more conservative.
10893 The default is 'disable'.
10895 @item -mno-sched-count-spec-in-critical-path
10896 @itemx -msched-count-spec-in-critical-path
10897 @opindex mno-sched-count-spec-in-critical-path
10898 @opindex msched-count-spec-in-critical-path
10899 If enabled, speculative dependencies will be considered during
10900 computation of the instructions priorities.  This will make the use of the
10901 speculation a bit more conservative.
10902 The default is 'disable'.
10904 @end table
10906 @node M32C Options
10907 @subsection M32C Options
10908 @cindex M32C options
10910 @table @gcctabopt
10911 @item -mcpu=@var{name}
10912 @opindex mcpu=
10913 Select the CPU for which code is generated.  @var{name} may be one of
10914 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10915 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10916 the M32C/80 series.
10918 @item -msim
10919 @opindex msim
10920 Specifies that the program will be run on the simulator.  This causes
10921 an alternate runtime library to be linked in which supports, for
10922 example, file I/O.  You must not use this option when generating
10923 programs that will run on real hardware; you must provide your own
10924 runtime library for whatever I/O functions are needed.
10926 @item -memregs=@var{number}
10927 @opindex memregs=
10928 Specifies the number of memory-based pseudo-registers GCC will use
10929 during code generation.  These pseudo-registers will be used like real
10930 registers, so there is a tradeoff between GCC's ability to fit the
10931 code into available registers, and the performance penalty of using
10932 memory instead of registers.  Note that all modules in a program must
10933 be compiled with the same value for this option.  Because of that, you
10934 must not use this option with the default runtime libraries gcc
10935 builds.
10937 @end table
10939 @node M32R/D Options
10940 @subsection M32R/D Options
10941 @cindex M32R/D options
10943 These @option{-m} options are defined for Renesas M32R/D architectures:
10945 @table @gcctabopt
10946 @item -m32r2
10947 @opindex m32r2
10948 Generate code for the M32R/2@.
10950 @item -m32rx
10951 @opindex m32rx
10952 Generate code for the M32R/X@.
10954 @item -m32r
10955 @opindex m32r
10956 Generate code for the M32R@.  This is the default.
10958 @item -mmodel=small
10959 @opindex mmodel=small
10960 Assume all objects live in the lower 16MB of memory (so that their addresses
10961 can be loaded with the @code{ld24} instruction), and assume all subroutines
10962 are reachable with the @code{bl} instruction.
10963 This is the default.
10965 The addressability of a particular object can be set with the
10966 @code{model} attribute.
10968 @item -mmodel=medium
10969 @opindex mmodel=medium
10970 Assume objects may be anywhere in the 32-bit address space (the compiler
10971 will generate @code{seth/add3} instructions to load their addresses), and
10972 assume all subroutines are reachable with the @code{bl} instruction.
10974 @item -mmodel=large
10975 @opindex mmodel=large
10976 Assume objects may be anywhere in the 32-bit address space (the compiler
10977 will generate @code{seth/add3} instructions to load their addresses), and
10978 assume subroutines may not be reachable with the @code{bl} instruction
10979 (the compiler will generate the much slower @code{seth/add3/jl}
10980 instruction sequence).
10982 @item -msdata=none
10983 @opindex msdata=none
10984 Disable use of the small data area.  Variables will be put into
10985 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10986 @code{section} attribute has been specified).
10987 This is the default.
10989 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10990 Objects may be explicitly put in the small data area with the
10991 @code{section} attribute using one of these sections.
10993 @item -msdata=sdata
10994 @opindex msdata=sdata
10995 Put small global and static data in the small data area, but do not
10996 generate special code to reference them.
10998 @item -msdata=use
10999 @opindex msdata=use
11000 Put small global and static data in the small data area, and generate
11001 special instructions to reference them.
11003 @item -G @var{num}
11004 @opindex G
11005 @cindex smaller data references
11006 Put global and static objects less than or equal to @var{num} bytes
11007 into the small data or bss sections instead of the normal data or bss
11008 sections.  The default value of @var{num} is 8.
11009 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
11010 for this option to have any effect.
11012 All modules should be compiled with the same @option{-G @var{num}} value.
11013 Compiling with different values of @var{num} may or may not work; if it
11014 doesn't the linker will give an error message---incorrect code will not be
11015 generated.
11017 @item -mdebug
11018 @opindex mdebug
11019 Makes the M32R specific code in the compiler display some statistics
11020 that might help in debugging programs.
11022 @item -malign-loops
11023 @opindex malign-loops
11024 Align all loops to a 32-byte boundary.
11026 @item -mno-align-loops
11027 @opindex mno-align-loops
11028 Do not enforce a 32-byte alignment for loops.  This is the default.
11030 @item -missue-rate=@var{number}
11031 @opindex missue-rate=@var{number}
11032 Issue @var{number} instructions per cycle.  @var{number} can only be 1
11033 or 2.
11035 @item -mbranch-cost=@var{number}
11036 @opindex mbranch-cost=@var{number}
11037 @var{number} can only be 1 or 2.  If it is 1 then branches will be
11038 preferred over conditional code, if it is 2, then the opposite will
11039 apply.
11041 @item -mflush-trap=@var{number}
11042 @opindex mflush-trap=@var{number}
11043 Specifies the trap number to use to flush the cache.  The default is
11044 12.  Valid numbers are between 0 and 15 inclusive.
11046 @item -mno-flush-trap
11047 @opindex mno-flush-trap
11048 Specifies that the cache cannot be flushed by using a trap.
11050 @item -mflush-func=@var{name}
11051 @opindex mflush-func=@var{name}
11052 Specifies the name of the operating system function to call to flush
11053 the cache.  The default is @emph{_flush_cache}, but a function call
11054 will only be used if a trap is not available.
11056 @item -mno-flush-func
11057 @opindex mno-flush-func
11058 Indicates that there is no OS function for flushing the cache.
11060 @end table
11062 @node M680x0 Options
11063 @subsection M680x0 Options
11064 @cindex M680x0 options
11066 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
11067 The default settings depend on which architecture was selected when
11068 the compiler was configured; the defaults for the most common choices
11069 are given below.
11071 @table @gcctabopt
11072 @item -march=@var{arch}
11073 @opindex march
11074 Generate code for a specific M680x0 or ColdFire instruction set
11075 architecture.  Permissible values of @var{arch} for M680x0
11076 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
11077 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
11078 architectures are selected according to Freescale's ISA classification
11079 and the permissible values are: @samp{isaa}, @samp{isaaplus},
11080 @samp{isab} and @samp{isac}.
11082 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
11083 code for a ColdFire target.  The @var{arch} in this macro is one of the
11084 @option{-march} arguments given above.
11086 When used together, @option{-march} and @option{-mtune} select code
11087 that runs on a family of similar processors but that is optimized
11088 for a particular microarchitecture.
11090 @item -mcpu=@var{cpu}
11091 @opindex mcpu
11092 Generate code for a specific M680x0 or ColdFire processor.
11093 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
11094 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
11095 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
11096 below, which also classifies the CPUs into families:
11098 @multitable @columnfractions 0.20 0.80
11099 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
11100 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
11101 @item @samp{5206e} @tab @samp{5206e}
11102 @item @samp{5208} @tab @samp{5207} @samp{5208}
11103 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
11104 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
11105 @item @samp{5216} @tab @samp{5214} @samp{5216}
11106 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
11107 @item @samp{5225} @tab @samp{5224} @samp{5225}
11108 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
11109 @item @samp{5249} @tab @samp{5249}
11110 @item @samp{5250} @tab @samp{5250}
11111 @item @samp{5271} @tab @samp{5270} @samp{5271}
11112 @item @samp{5272} @tab @samp{5272}
11113 @item @samp{5275} @tab @samp{5274} @samp{5275}
11114 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
11115 @item @samp{5307} @tab @samp{5307}
11116 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
11117 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
11118 @item @samp{5407} @tab @samp{5407}
11119 @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}
11120 @end multitable
11122 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
11123 @var{arch} is compatible with @var{cpu}.  Other combinations of
11124 @option{-mcpu} and @option{-march} are rejected.
11126 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
11127 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
11128 where the value of @var{family} is given by the table above.
11130 @item -mtune=@var{tune}
11131 @opindex mtune
11132 Tune the code for a particular microarchitecture, within the
11133 constraints set by @option{-march} and @option{-mcpu}.
11134 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
11135 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
11136 and @samp{cpu32}.  The ColdFire microarchitectures
11137 are: @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
11139 You can also use @option{-mtune=68020-40} for code that needs
11140 to run relatively well on 68020, 68030 and 68040 targets.
11141 @option{-mtune=68020-60} is similar but includes 68060 targets
11142 as well.  These two options select the same tuning decisions as
11143 @option{-m68020-40} and @option{-m68020-60} respectively.
11145 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
11146 when tuning for 680x0 architecture @var{arch}.  It also defines
11147 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
11148 option is used.  If gcc is tuning for a range of architectures,
11149 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
11150 it defines the macros for every architecture in the range.
11152 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
11153 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
11154 of the arguments given above.
11156 @item -m68000
11157 @itemx -mc68000
11158 @opindex m68000
11159 @opindex mc68000
11160 Generate output for a 68000.  This is the default
11161 when the compiler is configured for 68000-based systems.
11162 It is equivalent to @option{-march=68000}.
11164 Use this option for microcontrollers with a 68000 or EC000 core,
11165 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
11167 @item -m68010
11168 @opindex m68010
11169 Generate output for a 68010.  This is the default
11170 when the compiler is configured for 68010-based systems.
11171 It is equivalent to @option{-march=68010}.
11173 @item -m68020
11174 @itemx -mc68020
11175 @opindex m68020
11176 @opindex mc68020
11177 Generate output for a 68020.  This is the default
11178 when the compiler is configured for 68020-based systems.
11179 It is equivalent to @option{-march=68020}.
11181 @item -m68030
11182 @opindex m68030
11183 Generate output for a 68030.  This is the default when the compiler is
11184 configured for 68030-based systems.  It is equivalent to
11185 @option{-march=68030}.
11187 @item -m68040
11188 @opindex m68040
11189 Generate output for a 68040.  This is the default when the compiler is
11190 configured for 68040-based systems.  It is equivalent to
11191 @option{-march=68040}.
11193 This option inhibits the use of 68881/68882 instructions that have to be
11194 emulated by software on the 68040.  Use this option if your 68040 does not
11195 have code to emulate those instructions.
11197 @item -m68060
11198 @opindex m68060
11199 Generate output for a 68060.  This is the default when the compiler is
11200 configured for 68060-based systems.  It is equivalent to
11201 @option{-march=68060}.
11203 This option inhibits the use of 68020 and 68881/68882 instructions that
11204 have to be emulated by software on the 68060.  Use this option if your 68060
11205 does not have code to emulate those instructions.
11207 @item -mcpu32
11208 @opindex mcpu32
11209 Generate output for a CPU32.  This is the default
11210 when the compiler is configured for CPU32-based systems.
11211 It is equivalent to @option{-march=cpu32}.
11213 Use this option for microcontrollers with a
11214 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
11215 68336, 68340, 68341, 68349 and 68360.
11217 @item -m5200
11218 @opindex m5200
11219 Generate output for a 520X ColdFire CPU.  This is the default
11220 when the compiler is configured for 520X-based systems.
11221 It is equivalent to @option{-mcpu=5206}, and is now deprecated
11222 in favor of that option.
11224 Use this option for microcontroller with a 5200 core, including
11225 the MCF5202, MCF5203, MCF5204 and MCF5206.
11227 @item -m5206e
11228 @opindex m5206e
11229 Generate output for a 5206e ColdFire CPU.  The option is now
11230 deprecated in favor of the equivalent @option{-mcpu=5206e}.
11232 @item -m528x
11233 @opindex m528x
11234 Generate output for a member of the ColdFire 528X family.
11235 The option is now deprecated in favor of the equivalent
11236 @option{-mcpu=528x}.
11238 @item -m5307
11239 @opindex m5307
11240 Generate output for a ColdFire 5307 CPU.  The option is now deprecated
11241 in favor of the equivalent @option{-mcpu=5307}.
11243 @item -m5407
11244 @opindex m5407
11245 Generate output for a ColdFire 5407 CPU.  The option is now deprecated
11246 in favor of the equivalent @option{-mcpu=5407}.
11248 @item -mcfv4e
11249 @opindex mcfv4e
11250 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
11251 This includes use of hardware floating point instructions.
11252 The option is equivalent to @option{-mcpu=547x}, and is now
11253 deprecated in favor of that option.
11255 @item -m68020-40
11256 @opindex m68020-40
11257 Generate output for a 68040, without using any of the new instructions.
11258 This results in code which can run relatively efficiently on either a
11259 68020/68881 or a 68030 or a 68040.  The generated code does use the
11260 68881 instructions that are emulated on the 68040.
11262 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
11264 @item -m68020-60
11265 @opindex m68020-60
11266 Generate output for a 68060, without using any of the new instructions.
11267 This results in code which can run relatively efficiently on either a
11268 68020/68881 or a 68030 or a 68040.  The generated code does use the
11269 68881 instructions that are emulated on the 68060.
11271 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
11273 @item -mhard-float
11274 @itemx -m68881
11275 @opindex mhard-float
11276 @opindex m68881
11277 Generate floating-point instructions.  This is the default for 68020
11278 and above, and for ColdFire devices that have an FPU.  It defines the
11279 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
11280 on ColdFire targets.
11282 @item -msoft-float
11283 @opindex msoft-float
11284 Do not generate floating-point instructions; use library calls instead.
11285 This is the default for 68000, 68010, and 68832 targets.  It is also
11286 the default for ColdFire devices that have no FPU.
11288 @item -mdiv
11289 @itemx -mno-div
11290 @opindex mdiv
11291 @opindex mno-div
11292 Generate (do not generate) ColdFire hardware divide and remainder
11293 instructions.  If @option{-march} is used without @option{-mcpu},
11294 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
11295 architectures.  Otherwise, the default is taken from the target CPU
11296 (either the default CPU, or the one specified by @option{-mcpu}).  For
11297 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
11298 @option{-mcpu=5206e}.
11300 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
11302 @item -mshort
11303 @opindex mshort
11304 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11305 Additionally, parameters passed on the stack are also aligned to a
11306 16-bit boundary even on targets whose API mandates promotion to 32-bit.
11308 @item -mno-short
11309 @opindex mno-short
11310 Do not consider type @code{int} to be 16 bits wide.  This is the default.
11312 @item -mnobitfield
11313 @itemx -mno-bitfield
11314 @opindex mnobitfield
11315 @opindex mno-bitfield
11316 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
11317 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
11319 @item -mbitfield
11320 @opindex mbitfield
11321 Do use the bit-field instructions.  The @option{-m68020} option implies
11322 @option{-mbitfield}.  This is the default if you use a configuration
11323 designed for a 68020.
11325 @item -mrtd
11326 @opindex mrtd
11327 Use a different function-calling convention, in which functions
11328 that take a fixed number of arguments return with the @code{rtd}
11329 instruction, which pops their arguments while returning.  This
11330 saves one instruction in the caller since there is no need to pop
11331 the arguments there.
11333 This calling convention is incompatible with the one normally
11334 used on Unix, so you cannot use it if you need to call libraries
11335 compiled with the Unix compiler.
11337 Also, you must provide function prototypes for all functions that
11338 take variable numbers of arguments (including @code{printf});
11339 otherwise incorrect code will be generated for calls to those
11340 functions.
11342 In addition, seriously incorrect code will result if you call a
11343 function with too many arguments.  (Normally, extra arguments are
11344 harmlessly ignored.)
11346 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
11347 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
11349 @item -mno-rtd
11350 @opindex mno-rtd
11351 Do not use the calling conventions selected by @option{-mrtd}.
11352 This is the default.
11354 @item -malign-int
11355 @itemx -mno-align-int
11356 @opindex malign-int
11357 @opindex mno-align-int
11358 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
11359 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
11360 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
11361 Aligning variables on 32-bit boundaries produces code that runs somewhat
11362 faster on processors with 32-bit busses at the expense of more memory.
11364 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
11365 align structures containing the above types  differently than
11366 most published application binary interface specifications for the m68k.
11368 @item -mpcrel
11369 @opindex mpcrel
11370 Use the pc-relative addressing mode of the 68000 directly, instead of
11371 using a global offset table.  At present, this option implies @option{-fpic},
11372 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
11373 not presently supported with @option{-mpcrel}, though this could be supported for
11374 68020 and higher processors.
11376 @item -mno-strict-align
11377 @itemx -mstrict-align
11378 @opindex mno-strict-align
11379 @opindex mstrict-align
11380 Do not (do) assume that unaligned memory references will be handled by
11381 the system.
11383 @item -msep-data
11384 Generate code that allows the data segment to be located in a different
11385 area of memory from the text segment.  This allows for execute in place in
11386 an environment without virtual memory management.  This option implies
11387 @option{-fPIC}.
11389 @item -mno-sep-data
11390 Generate code that assumes that the data segment follows the text segment.
11391 This is the default.
11393 @item -mid-shared-library
11394 Generate code that supports shared libraries via the library ID method.
11395 This allows for execute in place and shared libraries in an environment
11396 without virtual memory management.  This option implies @option{-fPIC}.
11398 @item -mno-id-shared-library
11399 Generate code that doesn't assume ID based shared libraries are being used.
11400 This is the default.
11402 @item -mshared-library-id=n
11403 Specified the identification number of the ID based shared library being
11404 compiled.  Specifying a value of 0 will generate more compact code, specifying
11405 other values will force the allocation of that number to the current
11406 library but is no more space or time efficient than omitting this option.
11408 @end table
11410 @node M68hc1x Options
11411 @subsection M68hc1x Options
11412 @cindex M68hc1x options
11414 These are the @samp{-m} options defined for the 68hc11 and 68hc12
11415 microcontrollers.  The default values for these options depends on
11416 which style of microcontroller was selected when the compiler was configured;
11417 the defaults for the most common choices are given below.
11419 @table @gcctabopt
11420 @item -m6811
11421 @itemx -m68hc11
11422 @opindex m6811
11423 @opindex m68hc11
11424 Generate output for a 68HC11.  This is the default
11425 when the compiler is configured for 68HC11-based systems.
11427 @item -m6812
11428 @itemx -m68hc12
11429 @opindex m6812
11430 @opindex m68hc12
11431 Generate output for a 68HC12.  This is the default
11432 when the compiler is configured for 68HC12-based systems.
11434 @item -m68S12
11435 @itemx -m68hcs12
11436 @opindex m68S12
11437 @opindex m68hcs12
11438 Generate output for a 68HCS12.
11440 @item -mauto-incdec
11441 @opindex mauto-incdec
11442 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
11443 addressing modes.
11445 @item -minmax
11446 @itemx -nominmax
11447 @opindex minmax
11448 @opindex mnominmax
11449 Enable the use of 68HC12 min and max instructions.
11451 @item -mlong-calls
11452 @itemx -mno-long-calls
11453 @opindex mlong-calls
11454 @opindex mno-long-calls
11455 Treat all calls as being far away (near).  If calls are assumed to be
11456 far away, the compiler will use the @code{call} instruction to
11457 call a function and the @code{rtc} instruction for returning.
11459 @item -mshort
11460 @opindex mshort
11461 Consider type @code{int} to be 16 bits wide, like @code{short int}.
11463 @item -msoft-reg-count=@var{count}
11464 @opindex msoft-reg-count
11465 Specify the number of pseudo-soft registers which are used for the
11466 code generation.  The maximum number is 32.  Using more pseudo-soft
11467 register may or may not result in better code depending on the program.
11468 The default is 4 for 68HC11 and 2 for 68HC12.
11470 @end table
11472 @node MCore Options
11473 @subsection MCore Options
11474 @cindex MCore options
11476 These are the @samp{-m} options defined for the Motorola M*Core
11477 processors.
11479 @table @gcctabopt
11481 @item -mhardlit
11482 @itemx -mno-hardlit
11483 @opindex mhardlit
11484 @opindex mno-hardlit
11485 Inline constants into the code stream if it can be done in two
11486 instructions or less.
11488 @item -mdiv
11489 @itemx -mno-div
11490 @opindex mdiv
11491 @opindex mno-div
11492 Use the divide instruction.  (Enabled by default).
11494 @item -mrelax-immediate
11495 @itemx -mno-relax-immediate
11496 @opindex mrelax-immediate
11497 @opindex mno-relax-immediate
11498 Allow arbitrary sized immediates in bit operations.
11500 @item -mwide-bitfields
11501 @itemx -mno-wide-bitfields
11502 @opindex mwide-bitfields
11503 @opindex mno-wide-bitfields
11504 Always treat bit-fields as int-sized.
11506 @item -m4byte-functions
11507 @itemx -mno-4byte-functions
11508 @opindex m4byte-functions
11509 @opindex mno-4byte-functions
11510 Force all functions to be aligned to a four byte boundary.
11512 @item -mcallgraph-data
11513 @itemx -mno-callgraph-data
11514 @opindex mcallgraph-data
11515 @opindex mno-callgraph-data
11516 Emit callgraph information.
11518 @item -mslow-bytes
11519 @itemx -mno-slow-bytes
11520 @opindex mslow-bytes
11521 @opindex mno-slow-bytes
11522 Prefer word access when reading byte quantities.
11524 @item -mlittle-endian
11525 @itemx -mbig-endian
11526 @opindex mlittle-endian
11527 @opindex mbig-endian
11528 Generate code for a little endian target.
11530 @item -m210
11531 @itemx -m340
11532 @opindex m210
11533 @opindex m340
11534 Generate code for the 210 processor.
11535 @end table
11537 @node MIPS Options
11538 @subsection MIPS Options
11539 @cindex MIPS options
11541 @table @gcctabopt
11543 @item -EB
11544 @opindex EB
11545 Generate big-endian code.
11547 @item -EL
11548 @opindex EL
11549 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
11550 configurations.
11552 @item -march=@var{arch}
11553 @opindex march
11554 Generate code that will run on @var{arch}, which can be the name of a
11555 generic MIPS ISA, or the name of a particular processor.
11556 The ISA names are:
11557 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
11558 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
11559 The processor names are:
11560 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
11561 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
11562 @samp{5kc}, @samp{5kf},
11563 @samp{20kc},
11564 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
11565 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
11566 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
11567 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
11568 @samp{m4k},
11569 @samp{orion},
11570 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
11571 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
11572 @samp{rm7000}, @samp{rm9000},
11573 @samp{sb1},
11574 @samp{sr71000},
11575 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
11576 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
11577 The special value @samp{from-abi} selects the
11578 most compatible architecture for the selected ABI (that is,
11579 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
11581 In processor names, a final @samp{000} can be abbreviated as @samp{k}
11582 (for example, @samp{-march=r2k}).  Prefixes are optional, and
11583 @samp{vr} may be written @samp{r}.
11585 Names of the form @samp{@var{n}f2_1} refer to processors with
11586 FPUs clocked at half the rate of the core, names of the form
11587 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
11588 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
11589 processors with FPUs clocked a ratio of 3:2 with respect to the core.
11590 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
11591 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
11592 accepted as synonyms for @samp{@var{n}f1_1}.
11594 GCC defines two macros based on the value of this option.  The first
11595 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
11596 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
11597 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
11598 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
11599 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
11601 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
11602 above.  In other words, it will have the full prefix and will not
11603 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
11604 the macro names the resolved architecture (either @samp{"mips1"} or
11605 @samp{"mips3"}).  It names the default architecture when no
11606 @option{-march} option is given.
11608 @item -mtune=@var{arch}
11609 @opindex mtune
11610 Optimize for @var{arch}.  Among other things, this option controls
11611 the way instructions are scheduled, and the perceived cost of arithmetic
11612 operations.  The list of @var{arch} values is the same as for
11613 @option{-march}.
11615 When this option is not used, GCC will optimize for the processor
11616 specified by @option{-march}.  By using @option{-march} and
11617 @option{-mtune} together, it is possible to generate code that will
11618 run on a family of processors, but optimize the code for one
11619 particular member of that family.
11621 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
11622 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
11623 @samp{-march} ones described above.
11625 @item -mips1
11626 @opindex mips1
11627 Equivalent to @samp{-march=mips1}.
11629 @item -mips2
11630 @opindex mips2
11631 Equivalent to @samp{-march=mips2}.
11633 @item -mips3
11634 @opindex mips3
11635 Equivalent to @samp{-march=mips3}.
11637 @item -mips4
11638 @opindex mips4
11639 Equivalent to @samp{-march=mips4}.
11641 @item -mips32
11642 @opindex mips32
11643 Equivalent to @samp{-march=mips32}.
11645 @item -mips32r2
11646 @opindex mips32r2
11647 Equivalent to @samp{-march=mips32r2}.
11649 @item -mips64
11650 @opindex mips64
11651 Equivalent to @samp{-march=mips64}.
11653 @item -mips16
11654 @itemx -mno-mips16
11655 @opindex mips16
11656 @opindex mno-mips16
11657 Generate (do not generate) MIPS16 code.  If GCC is targetting a
11658 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
11660 @item -mabi=32
11661 @itemx -mabi=o64
11662 @itemx -mabi=n32
11663 @itemx -mabi=64
11664 @itemx -mabi=eabi
11665 @opindex mabi=32
11666 @opindex mabi=o64
11667 @opindex mabi=n32
11668 @opindex mabi=64
11669 @opindex mabi=eabi
11670 Generate code for the given ABI@.
11672 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
11673 generates 64-bit code when you select a 64-bit architecture, but you
11674 can use @option{-mgp32} to get 32-bit code instead.
11676 For information about the O64 ABI, see
11677 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
11679 GCC supports a variant of the o32 ABI in which floating-point registers
11680 are 64 rather than 32 bits wide.  You can select this combination with
11681 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
11682 and @samp{mfhc1} instructions and is therefore only supported for
11683 MIPS32R2 processors.
11685 The register assignments for arguments and return values remain the
11686 same, but each scalar value is passed in a single 64-bit register
11687 rather than a pair of 32-bit registers.  For example, scalar
11688 floating-point values are returned in @samp{$f0} only, not a
11689 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
11690 remains the same, but all 64 bits are saved.
11692 @item -mabicalls
11693 @itemx -mno-abicalls
11694 @opindex mabicalls
11695 @opindex mno-abicalls
11696 Generate (do not generate) code that is suitable for SVR4-style
11697 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
11698 systems.
11700 @item -mshared
11701 @itemx -mno-shared
11702 Generate (do not generate) code that is fully position-independent,
11703 and that can therefore be linked into shared libraries.  This option
11704 only affects @option{-mabicalls}.
11706 All @option{-mabicalls} code has traditionally been position-independent,
11707 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
11708 as an extension, the GNU toolchain allows executables to use absolute
11709 accesses for locally-binding symbols.  It can also use shorter GP
11710 initialization sequences and generate direct calls to locally-defined
11711 functions.  This mode is selected by @option{-mno-shared}.
11713 @option{-mno-shared} depends on binutils 2.16 or higher and generates
11714 objects that can only be linked by the GNU linker.  However, the option
11715 does not affect the ABI of the final executable; it only affects the ABI
11716 of relocatable objects.  Using @option{-mno-shared} will generally make
11717 executables both smaller and quicker.
11719 @option{-mshared} is the default.
11721 @item -mxgot
11722 @itemx -mno-xgot
11723 @opindex mxgot
11724 @opindex mno-xgot
11725 Lift (do not lift) the usual restrictions on the size of the global
11726 offset table.
11728 GCC normally uses a single instruction to load values from the GOT@.
11729 While this is relatively efficient, it will only work if the GOT
11730 is smaller than about 64k.  Anything larger will cause the linker
11731 to report an error such as:
11733 @cindex relocation truncated to fit (MIPS)
11734 @smallexample
11735 relocation truncated to fit: R_MIPS_GOT16 foobar
11736 @end smallexample
11738 If this happens, you should recompile your code with @option{-mxgot}.
11739 It should then work with very large GOTs, although it will also be
11740 less efficient, since it will take three instructions to fetch the
11741 value of a global symbol.
11743 Note that some linkers can create multiple GOTs.  If you have such a
11744 linker, you should only need to use @option{-mxgot} when a single object
11745 file accesses more than 64k's worth of GOT entries.  Very few do.
11747 These options have no effect unless GCC is generating position
11748 independent code.
11750 @item -mgp32
11751 @opindex mgp32
11752 Assume that general-purpose registers are 32 bits wide.
11754 @item -mgp64
11755 @opindex mgp64
11756 Assume that general-purpose registers are 64 bits wide.
11758 @item -mfp32
11759 @opindex mfp32
11760 Assume that floating-point registers are 32 bits wide.
11762 @item -mfp64
11763 @opindex mfp64
11764 Assume that floating-point registers are 64 bits wide.
11766 @item -mhard-float
11767 @opindex mhard-float
11768 Use floating-point coprocessor instructions.
11770 @item -msoft-float
11771 @opindex msoft-float
11772 Do not use floating-point coprocessor instructions.  Implement
11773 floating-point calculations using library calls instead.
11775 @item -msingle-float
11776 @opindex msingle-float
11777 Assume that the floating-point coprocessor only supports single-precision
11778 operations.
11780 @item -mdouble-float
11781 @opindex mdouble-float
11782 Assume that the floating-point coprocessor supports double-precision
11783 operations.  This is the default.
11785 @item -mdsp
11786 @itemx -mno-dsp
11787 @opindex mdsp
11788 @opindex mno-dsp
11789 Use (do not use) revision 1 of the MIPS DSP ASE.
11790 @xref{MIPS DSP Built-in Functions}.  This option defines the
11791 preprocessor macro @samp{__mips_dsp}.  It also defines
11792 @samp{__mips_dsp_rev} to 1.
11794 @item -mdspr2
11795 @itemx -mno-dspr2
11796 @opindex mdspr2
11797 @opindex mno-dspr2
11798 Use (do not use) revision 2 of the MIPS DSP ASE.
11799 @xref{MIPS DSP Built-in Functions}.  This option defines the
11800 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
11801 It also defines @samp{__mips_dsp_rev} to 2.
11803 @item -msmartmips
11804 @itemx -mno-smartmips
11805 @opindex msmartmips
11806 @opindex mno-smartmips
11807 Use (do not use) the MIPS SmartMIPS ASE.
11809 @item -mpaired-single
11810 @itemx -mno-paired-single
11811 @opindex mpaired-single
11812 @opindex mno-paired-single
11813 Use (do not use) paired-single floating-point instructions.
11814 @xref{MIPS Paired-Single Support}.  This option can only be used
11815 when generating 64-bit code and requires hardware floating-point
11816 support to be enabled.
11818 @item -mdmx
11819 @itemx -mno-mdmx
11820 @opindex mdmx
11821 @opindex mno-mdmx
11822 Use (do not use) MIPS Digital Media Extension instructions.
11823 This option can only be used when generating 64-bit code and requires
11824 hardware floating-point support to be enabled.
11826 @item -mips3d
11827 @itemx -mno-mips3d
11828 @opindex mips3d
11829 @opindex mno-mips3d
11830 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
11831 The option @option{-mips3d} implies @option{-mpaired-single}.
11833 @item -mmt
11834 @itemx -mno-mt
11835 @opindex mmt
11836 @opindex mno-mt
11837 Use (do not use) MT Multithreading instructions.
11839 @item -mlong64
11840 @opindex mlong64
11841 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
11842 an explanation of the default and the way that the pointer size is
11843 determined.
11845 @item -mlong32
11846 @opindex mlong32
11847 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
11849 The default size of @code{int}s, @code{long}s and pointers depends on
11850 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
11851 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
11852 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
11853 or the same size as integer registers, whichever is smaller.
11855 @item -msym32
11856 @itemx -mno-sym32
11857 @opindex msym32
11858 @opindex mno-sym32
11859 Assume (do not assume) that all symbols have 32-bit values, regardless
11860 of the selected ABI@.  This option is useful in combination with
11861 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
11862 to generate shorter and faster references to symbolic addresses.
11864 @item -G @var{num}
11865 @opindex G
11866 @cindex smaller data references (MIPS)
11867 @cindex gp-relative references (MIPS)
11868 Put global and static items less than or equal to @var{num} bytes into
11869 the small data or bss section instead of the normal data or bss section.
11870 This allows the data to be accessed using a single instruction.
11872 All modules should be compiled with the same @option{-G @var{num}}
11873 value.
11875 @item -membedded-data
11876 @itemx -mno-embedded-data
11877 @opindex membedded-data
11878 @opindex mno-embedded-data
11879 Allocate variables to the read-only data section first if possible, then
11880 next in the small data section if possible, otherwise in data.  This gives
11881 slightly slower code than the default, but reduces the amount of RAM required
11882 when executing, and thus may be preferred for some embedded systems.
11884 @item -muninit-const-in-rodata
11885 @itemx -mno-uninit-const-in-rodata
11886 @opindex muninit-const-in-rodata
11887 @opindex mno-uninit-const-in-rodata
11888 Put uninitialized @code{const} variables in the read-only data section.
11889 This option is only meaningful in conjunction with @option{-membedded-data}.
11891 @item -mcode-readable=@var{setting}
11892 @opindex mcode-readable
11893 Specify whether GCC may generate code that reads from executable sections.
11894 There are three possible settings:
11896 @table @gcctabopt
11897 @item -mcode-readable=yes
11898 Instructions may freely access executable sections.  This is the
11899 default setting.
11901 @item -mcode-readable=pcrel
11902 MIPS16 PC-relative load instructions can access executable sections,
11903 but other instructions must not do so.  This option is useful on 4KSc
11904 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
11905 It is also useful on processors that can be configured to have a dual
11906 instruction/data SRAM interface and that, like the M4K, automatically
11907 redirect PC-relative loads to the instruction RAM.
11909 @item -mcode-readable=no
11910 Instructions must not access executable sections.  This option can be
11911 useful on targets that are configured to have a dual instruction/data
11912 SRAM interface but that (unlike the M4K) do not automatically redirect
11913 PC-relative loads to the instruction RAM.
11914 @end table
11916 @item -msplit-addresses
11917 @itemx -mno-split-addresses
11918 @opindex msplit-addresses
11919 @opindex mno-split-addresses
11920 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
11921 relocation operators.  This option has been superseded by
11922 @option{-mexplicit-relocs} but is retained for backwards compatibility.
11924 @item -mexplicit-relocs
11925 @itemx -mno-explicit-relocs
11926 @opindex mexplicit-relocs
11927 @opindex mno-explicit-relocs
11928 Use (do not use) assembler relocation operators when dealing with symbolic
11929 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
11930 is to use assembler macros instead.
11932 @option{-mexplicit-relocs} is the default if GCC was configured
11933 to use an assembler that supports relocation operators.
11935 @item -mcheck-zero-division
11936 @itemx -mno-check-zero-division
11937 @opindex mcheck-zero-division
11938 @opindex mno-check-zero-division
11939 Trap (do not trap) on integer division by zero.
11941 The default is @option{-mcheck-zero-division}.
11943 @item -mdivide-traps
11944 @itemx -mdivide-breaks
11945 @opindex mdivide-traps
11946 @opindex mdivide-breaks
11947 MIPS systems check for division by zero by generating either a
11948 conditional trap or a break instruction.  Using traps results in
11949 smaller code, but is only supported on MIPS II and later.  Also, some
11950 versions of the Linux kernel have a bug that prevents trap from
11951 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
11952 allow conditional traps on architectures that support them and
11953 @option{-mdivide-breaks} to force the use of breaks.
11955 The default is usually @option{-mdivide-traps}, but this can be
11956 overridden at configure time using @option{--with-divide=breaks}.
11957 Divide-by-zero checks can be completely disabled using
11958 @option{-mno-check-zero-division}.
11960 @item -mmemcpy
11961 @itemx -mno-memcpy
11962 @opindex mmemcpy
11963 @opindex mno-memcpy
11964 Force (do not force) the use of @code{memcpy()} for non-trivial block
11965 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
11966 most constant-sized copies.
11968 @item -mlong-calls
11969 @itemx -mno-long-calls
11970 @opindex mlong-calls
11971 @opindex mno-long-calls
11972 Disable (do not disable) use of the @code{jal} instruction.  Calling
11973 functions using @code{jal} is more efficient but requires the caller
11974 and callee to be in the same 256 megabyte segment.
11976 This option has no effect on abicalls code.  The default is
11977 @option{-mno-long-calls}.
11979 @item -mmad
11980 @itemx -mno-mad
11981 @opindex mmad
11982 @opindex mno-mad
11983 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
11984 instructions, as provided by the R4650 ISA@.
11986 @item -mfused-madd
11987 @itemx -mno-fused-madd
11988 @opindex mfused-madd
11989 @opindex mno-fused-madd
11990 Enable (disable) use of the floating point multiply-accumulate
11991 instructions, when they are available.  The default is
11992 @option{-mfused-madd}.
11994 When multiply-accumulate instructions are used, the intermediate
11995 product is calculated to infinite precision and is not subject to
11996 the FCSR Flush to Zero bit.  This may be undesirable in some
11997 circumstances.
11999 @item -nocpp
12000 @opindex nocpp
12001 Tell the MIPS assembler to not run its preprocessor over user
12002 assembler files (with a @samp{.s} suffix) when assembling them.
12004 @item -mfix-r4000
12005 @itemx -mno-fix-r4000
12006 @opindex mfix-r4000
12007 @opindex mno-fix-r4000
12008 Work around certain R4000 CPU errata:
12009 @itemize @minus
12010 @item
12011 A double-word or a variable shift may give an incorrect result if executed
12012 immediately after starting an integer division.
12013 @item
12014 A double-word or a variable shift may give an incorrect result if executed
12015 while an integer multiplication is in progress.
12016 @item
12017 An integer division may give an incorrect result if started in a delay slot
12018 of a taken branch or a jump.
12019 @end itemize
12021 @item -mfix-r4400
12022 @itemx -mno-fix-r4400
12023 @opindex mfix-r4400
12024 @opindex mno-fix-r4400
12025 Work around certain R4400 CPU errata:
12026 @itemize @minus
12027 @item
12028 A double-word or a variable shift may give an incorrect result if executed
12029 immediately after starting an integer division.
12030 @end itemize
12032 @item -mfix-vr4120
12033 @itemx -mno-fix-vr4120
12034 @opindex mfix-vr4120
12035 Work around certain VR4120 errata:
12036 @itemize @minus
12037 @item
12038 @code{dmultu} does not always produce the correct result.
12039 @item
12040 @code{div} and @code{ddiv} do not always produce the correct result if one
12041 of the operands is negative.
12042 @end itemize
12043 The workarounds for the division errata rely on special functions in
12044 @file{libgcc.a}.  At present, these functions are only provided by
12045 the @code{mips64vr*-elf} configurations.
12047 Other VR4120 errata require a nop to be inserted between certain pairs of
12048 instructions.  These errata are handled by the assembler, not by GCC itself.
12050 @item -mfix-vr4130
12051 @opindex mfix-vr4130
12052 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
12053 workarounds are implemented by the assembler rather than by GCC,
12054 although GCC will avoid using @code{mflo} and @code{mfhi} if the
12055 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
12056 instructions are available instead.
12058 @item -mfix-sb1
12059 @itemx -mno-fix-sb1
12060 @opindex mfix-sb1
12061 Work around certain SB-1 CPU core errata.
12062 (This flag currently works around the SB-1 revision 2
12063 ``F1'' and ``F2'' floating point errata.)
12065 @item -mflush-func=@var{func}
12066 @itemx -mno-flush-func
12067 @opindex mflush-func
12068 Specifies the function to call to flush the I and D caches, or to not
12069 call any such function.  If called, the function must take the same
12070 arguments as the common @code{_flush_func()}, that is, the address of the
12071 memory range for which the cache is being flushed, the size of the
12072 memory range, and the number 3 (to flush both caches).  The default
12073 depends on the target GCC was configured for, but commonly is either
12074 @samp{_flush_func} or @samp{__cpu_flush}.
12076 @item mbranch-cost=@var{num}
12077 @opindex mbranch-cost
12078 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12079 This cost is only a heuristic and is not guaranteed to produce
12080 consistent results across releases.  A zero cost redundantly selects
12081 the default, which is based on the @option{-mtune} setting.
12083 @item -mbranch-likely
12084 @itemx -mno-branch-likely
12085 @opindex mbranch-likely
12086 @opindex mno-branch-likely
12087 Enable or disable use of Branch Likely instructions, regardless of the
12088 default for the selected architecture.  By default, Branch Likely
12089 instructions may be generated if they are supported by the selected
12090 architecture.  An exception is for the MIPS32 and MIPS64 architectures
12091 and processors which implement those architectures; for those, Branch
12092 Likely instructions will not be generated by default because the MIPS32
12093 and MIPS64 architectures specifically deprecate their use.
12095 @item -mfp-exceptions
12096 @itemx -mno-fp-exceptions
12097 @opindex mfp-exceptions
12098 Specifies whether FP exceptions are enabled.  This affects how we schedule
12099 FP instructions for some processors.  The default is that FP exceptions are
12100 enabled.
12102 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
12103 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
12104 FP pipe.
12106 @item -mvr4130-align
12107 @itemx -mno-vr4130-align
12108 @opindex mvr4130-align
12109 The VR4130 pipeline is two-way superscalar, but can only issue two
12110 instructions together if the first one is 8-byte aligned.  When this
12111 option is enabled, GCC will align pairs of instructions that it
12112 thinks should execute in parallel.
12114 This option only has an effect when optimizing for the VR4130.
12115 It normally makes code faster, but at the expense of making it bigger.
12116 It is enabled by default at optimization level @option{-O3}.
12117 @end table
12119 @node MMIX Options
12120 @subsection MMIX Options
12121 @cindex MMIX Options
12123 These options are defined for the MMIX:
12125 @table @gcctabopt
12126 @item -mlibfuncs
12127 @itemx -mno-libfuncs
12128 @opindex mlibfuncs
12129 @opindex mno-libfuncs
12130 Specify that intrinsic library functions are being compiled, passing all
12131 values in registers, no matter the size.
12133 @item -mepsilon
12134 @itemx -mno-epsilon
12135 @opindex mepsilon
12136 @opindex mno-epsilon
12137 Generate floating-point comparison instructions that compare with respect
12138 to the @code{rE} epsilon register.
12140 @item -mabi=mmixware
12141 @itemx -mabi=gnu
12142 @opindex mabi-mmixware
12143 @opindex mabi=gnu
12144 Generate code that passes function parameters and return values that (in
12145 the called function) are seen as registers @code{$0} and up, as opposed to
12146 the GNU ABI which uses global registers @code{$231} and up.
12148 @item -mzero-extend
12149 @itemx -mno-zero-extend
12150 @opindex mzero-extend
12151 @opindex mno-zero-extend
12152 When reading data from memory in sizes shorter than 64 bits, use (do not
12153 use) zero-extending load instructions by default, rather than
12154 sign-extending ones.
12156 @item -mknuthdiv
12157 @itemx -mno-knuthdiv
12158 @opindex mknuthdiv
12159 @opindex mno-knuthdiv
12160 Make the result of a division yielding a remainder have the same sign as
12161 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
12162 remainder follows the sign of the dividend.  Both methods are
12163 arithmetically valid, the latter being almost exclusively used.
12165 @item -mtoplevel-symbols
12166 @itemx -mno-toplevel-symbols
12167 @opindex mtoplevel-symbols
12168 @opindex mno-toplevel-symbols
12169 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
12170 code can be used with the @code{PREFIX} assembly directive.
12172 @item -melf
12173 @opindex melf
12174 Generate an executable in the ELF format, rather than the default
12175 @samp{mmo} format used by the @command{mmix} simulator.
12177 @item -mbranch-predict
12178 @itemx -mno-branch-predict
12179 @opindex mbranch-predict
12180 @opindex mno-branch-predict
12181 Use (do not use) the probable-branch instructions, when static branch
12182 prediction indicates a probable branch.
12184 @item -mbase-addresses
12185 @itemx -mno-base-addresses
12186 @opindex mbase-addresses
12187 @opindex mno-base-addresses
12188 Generate (do not generate) code that uses @emph{base addresses}.  Using a
12189 base address automatically generates a request (handled by the assembler
12190 and the linker) for a constant to be set up in a global register.  The
12191 register is used for one or more base address requests within the range 0
12192 to 255 from the value held in the register.  The generally leads to short
12193 and fast code, but the number of different data items that can be
12194 addressed is limited.  This means that a program that uses lots of static
12195 data may require @option{-mno-base-addresses}.
12197 @item -msingle-exit
12198 @itemx -mno-single-exit
12199 @opindex msingle-exit
12200 @opindex mno-single-exit
12201 Force (do not force) generated code to have a single exit point in each
12202 function.
12203 @end table
12205 @node MN10300 Options
12206 @subsection MN10300 Options
12207 @cindex MN10300 options
12209 These @option{-m} options are defined for Matsushita MN10300 architectures:
12211 @table @gcctabopt
12212 @item -mmult-bug
12213 @opindex mmult-bug
12214 Generate code to avoid bugs in the multiply instructions for the MN10300
12215 processors.  This is the default.
12217 @item -mno-mult-bug
12218 @opindex mno-mult-bug
12219 Do not generate code to avoid bugs in the multiply instructions for the
12220 MN10300 processors.
12222 @item -mam33
12223 @opindex mam33
12224 Generate code which uses features specific to the AM33 processor.
12226 @item -mno-am33
12227 @opindex mno-am33
12228 Do not generate code which uses features specific to the AM33 processor.  This
12229 is the default.
12231 @item -mreturn-pointer-on-d0
12232 @opindex mreturn-pointer-on-d0
12233 When generating a function which returns a pointer, return the pointer
12234 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
12235 only in a0, and attempts to call such functions without a prototype
12236 would result in errors.  Note that this option is on by default; use
12237 @option{-mno-return-pointer-on-d0} to disable it.
12239 @item -mno-crt0
12240 @opindex mno-crt0
12241 Do not link in the C run-time initialization object file.
12243 @item -mrelax
12244 @opindex mrelax
12245 Indicate to the linker that it should perform a relaxation optimization pass
12246 to shorten branches, calls and absolute memory addresses.  This option only
12247 has an effect when used on the command line for the final link step.
12249 This option makes symbolic debugging impossible.
12250 @end table
12252 @node MT Options
12253 @subsection MT Options
12254 @cindex MT options
12256 These @option{-m} options are defined for Morpho MT architectures:
12258 @table @gcctabopt
12260 @item -march=@var{cpu-type}
12261 @opindex march
12262 Generate code that will run on @var{cpu-type}, which is the name of a system
12263 representing a certain processor type.  Possible values for
12264 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
12265 @samp{ms1-16-003} and @samp{ms2}.
12267 When this option is not used, the default is @option{-march=ms1-16-002}.
12269 @item -mbacc
12270 @opindex mbacc
12271 Use byte loads and stores when generating code.
12273 @item -mno-bacc
12274 @opindex mno-bacc
12275 Do not use byte loads and stores when generating code.
12277 @item -msim
12278 @opindex msim
12279 Use simulator runtime
12281 @item -mno-crt0
12282 @opindex mno-crt0
12283 Do not link in the C run-time initialization object file
12284 @file{crti.o}.  Other run-time initialization and termination files
12285 such as @file{startup.o} and @file{exit.o} are still included on the
12286 linker command line.
12288 @end table
12290 @node PDP-11 Options
12291 @subsection PDP-11 Options
12292 @cindex PDP-11 Options
12294 These options are defined for the PDP-11:
12296 @table @gcctabopt
12297 @item -mfpu
12298 @opindex mfpu
12299 Use hardware FPP floating point.  This is the default.  (FIS floating
12300 point on the PDP-11/40 is not supported.)
12302 @item -msoft-float
12303 @opindex msoft-float
12304 Do not use hardware floating point.
12306 @item -mac0
12307 @opindex mac0
12308 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
12310 @item -mno-ac0
12311 @opindex mno-ac0
12312 Return floating-point results in memory.  This is the default.
12314 @item -m40
12315 @opindex m40
12316 Generate code for a PDP-11/40.
12318 @item -m45
12319 @opindex m45
12320 Generate code for a PDP-11/45.  This is the default.
12322 @item -m10
12323 @opindex m10
12324 Generate code for a PDP-11/10.
12326 @item -mbcopy-builtin
12327 @opindex bcopy-builtin
12328 Use inline @code{movmemhi} patterns for copying memory.  This is the
12329 default.
12331 @item -mbcopy
12332 @opindex mbcopy
12333 Do not use inline @code{movmemhi} patterns for copying memory.
12335 @item -mint16
12336 @itemx -mno-int32
12337 @opindex mint16
12338 @opindex mno-int32
12339 Use 16-bit @code{int}.  This is the default.
12341 @item -mint32
12342 @itemx -mno-int16
12343 @opindex mint32
12344 @opindex mno-int16
12345 Use 32-bit @code{int}.
12347 @item -mfloat64
12348 @itemx -mno-float32
12349 @opindex mfloat64
12350 @opindex mno-float32
12351 Use 64-bit @code{float}.  This is the default.
12353 @item -mfloat32
12354 @itemx -mno-float64
12355 @opindex mfloat32
12356 @opindex mno-float64
12357 Use 32-bit @code{float}.
12359 @item -mabshi
12360 @opindex mabshi
12361 Use @code{abshi2} pattern.  This is the default.
12363 @item -mno-abshi
12364 @opindex mno-abshi
12365 Do not use @code{abshi2} pattern.
12367 @item -mbranch-expensive
12368 @opindex mbranch-expensive
12369 Pretend that branches are expensive.  This is for experimenting with
12370 code generation only.
12372 @item -mbranch-cheap
12373 @opindex mbranch-cheap
12374 Do not pretend that branches are expensive.  This is the default.
12376 @item -msplit
12377 @opindex msplit
12378 Generate code for a system with split I&D@.
12380 @item -mno-split
12381 @opindex mno-split
12382 Generate code for a system without split I&D@.  This is the default.
12384 @item -munix-asm
12385 @opindex munix-asm
12386 Use Unix assembler syntax.  This is the default when configured for
12387 @samp{pdp11-*-bsd}.
12389 @item -mdec-asm
12390 @opindex mdec-asm
12391 Use DEC assembler syntax.  This is the default when configured for any
12392 PDP-11 target other than @samp{pdp11-*-bsd}.
12393 @end table
12395 @node PowerPC Options
12396 @subsection PowerPC Options
12397 @cindex PowerPC options
12399 These are listed under @xref{RS/6000 and PowerPC Options}.
12401 @node RS/6000 and PowerPC Options
12402 @subsection IBM RS/6000 and PowerPC Options
12403 @cindex RS/6000 and PowerPC Options
12404 @cindex IBM RS/6000 and PowerPC Options
12406 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
12407 @table @gcctabopt
12408 @item -mpower
12409 @itemx -mno-power
12410 @itemx -mpower2
12411 @itemx -mno-power2
12412 @itemx -mpowerpc
12413 @itemx -mno-powerpc
12414 @itemx -mpowerpc-gpopt
12415 @itemx -mno-powerpc-gpopt
12416 @itemx -mpowerpc-gfxopt
12417 @itemx -mno-powerpc-gfxopt
12418 @itemx -mpowerpc64
12419 @itemx -mno-powerpc64
12420 @itemx -mmfcrf
12421 @itemx -mno-mfcrf
12422 @itemx -mpopcntb
12423 @itemx -mno-popcntb
12424 @itemx -mfprnd
12425 @itemx -mno-fprnd
12426 @itemx -mcmpb
12427 @itemx -mno-cmpb
12428 @itemx -mmfpgpr
12429 @itemx -mno-mfpgpr
12430 @itemx -mdfp
12431 @itemx -mno-dfp
12432 @opindex mpower
12433 @opindex mno-power
12434 @opindex mpower2
12435 @opindex mno-power2
12436 @opindex mpowerpc
12437 @opindex mno-powerpc
12438 @opindex mpowerpc-gpopt
12439 @opindex mno-powerpc-gpopt
12440 @opindex mpowerpc-gfxopt
12441 @opindex mno-powerpc-gfxopt
12442 @opindex mpowerpc64
12443 @opindex mno-powerpc64
12444 @opindex mmfcrf
12445 @opindex mno-mfcrf
12446 @opindex mpopcntb
12447 @opindex mno-popcntb
12448 @opindex mfprnd
12449 @opindex mno-fprnd
12450 @opindex mcmpb
12451 @opindex mno-cmpb
12452 @opindex mmfpgpr
12453 @opindex mno-mfpgpr
12454 @opindex mdfp
12455 @opindex mno-dfp
12456 GCC supports two related instruction set architectures for the
12457 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
12458 instructions supported by the @samp{rios} chip set used in the original
12459 RS/6000 systems and the @dfn{PowerPC} instruction set is the
12460 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
12461 the IBM 4xx, 6xx, and follow-on microprocessors.
12463 Neither architecture is a subset of the other.  However there is a
12464 large common subset of instructions supported by both.  An MQ
12465 register is included in processors supporting the POWER architecture.
12467 You use these options to specify which instructions are available on the
12468 processor you are using.  The default value of these options is
12469 determined when configuring GCC@.  Specifying the
12470 @option{-mcpu=@var{cpu_type}} overrides the specification of these
12471 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
12472 rather than the options listed above.
12474 The @option{-mpower} option allows GCC to generate instructions that
12475 are found only in the POWER architecture and to use the MQ register.
12476 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
12477 to generate instructions that are present in the POWER2 architecture but
12478 not the original POWER architecture.
12480 The @option{-mpowerpc} option allows GCC to generate instructions that
12481 are found only in the 32-bit subset of the PowerPC architecture.
12482 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
12483 GCC to use the optional PowerPC architecture instructions in the
12484 General Purpose group, including floating-point square root.  Specifying
12485 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
12486 use the optional PowerPC architecture instructions in the Graphics
12487 group, including floating-point select.
12489 The @option{-mmfcrf} option allows GCC to generate the move from
12490 condition register field instruction implemented on the POWER4
12491 processor and other processors that support the PowerPC V2.01
12492 architecture.
12493 The @option{-mpopcntb} option allows GCC to generate the popcount and
12494 double precision FP reciprocal estimate instruction implemented on the
12495 POWER5 processor and other processors that support the PowerPC V2.02
12496 architecture.
12497 The @option{-mfprnd} option allows GCC to generate the FP round to
12498 integer instructions implemented on the POWER5+ processor and other
12499 processors that support the PowerPC V2.03 architecture.
12500 The @option{-mcmpb} option allows GCC to generate the compare bytes
12501 instruction implemented on the POWER6 processor and other processors
12502 that support the PowerPC V2.05 architecture.
12503 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
12504 general purpose register instructions implemented on the POWER6X
12505 processor and other processors that support the extended PowerPC V2.05
12506 architecture.
12507 The @option{-mdfp} option allows GCC to generate the decimal floating
12508 point instructions implemented on some POWER processors.
12510 The @option{-mpowerpc64} option allows GCC to generate the additional
12511 64-bit instructions that are found in the full PowerPC64 architecture
12512 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
12513 @option{-mno-powerpc64}.
12515 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
12516 will use only the instructions in the common subset of both
12517 architectures plus some special AIX common-mode calls, and will not use
12518 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
12519 permits GCC to use any instruction from either architecture and to
12520 allow use of the MQ register; specify this for the Motorola MPC601.
12522 @item -mnew-mnemonics
12523 @itemx -mold-mnemonics
12524 @opindex mnew-mnemonics
12525 @opindex mold-mnemonics
12526 Select which mnemonics to use in the generated assembler code.  With
12527 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
12528 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
12529 assembler mnemonics defined for the POWER architecture.  Instructions
12530 defined in only one architecture have only one mnemonic; GCC uses that
12531 mnemonic irrespective of which of these options is specified.
12533 GCC defaults to the mnemonics appropriate for the architecture in
12534 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
12535 value of these option.  Unless you are building a cross-compiler, you
12536 should normally not specify either @option{-mnew-mnemonics} or
12537 @option{-mold-mnemonics}, but should instead accept the default.
12539 @item -mcpu=@var{cpu_type}
12540 @opindex mcpu
12541 Set architecture type, register usage, choice of mnemonics, and
12542 instruction scheduling parameters for machine type @var{cpu_type}.
12543 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
12544 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
12545 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
12546 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
12547 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
12548 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
12549 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
12550 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
12551 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
12552 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
12554 @option{-mcpu=common} selects a completely generic processor.  Code
12555 generated under this option will run on any POWER or PowerPC processor.
12556 GCC will use only the instructions in the common subset of both
12557 architectures, and will not use the MQ register.  GCC assumes a generic
12558 processor model for scheduling purposes.
12560 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
12561 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
12562 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
12563 types, with an appropriate, generic processor model assumed for
12564 scheduling purposes.
12566 The other options specify a specific processor.  Code generated under
12567 those options will run best on that processor, and may not run at all on
12568 others.
12570 The @option{-mcpu} options automatically enable or disable the
12571 following options:
12573 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
12574 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
12575 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
12577 The particular options set for any particular CPU will vary between
12578 compiler versions, depending on what setting seems to produce optimal
12579 code for that CPU; it doesn't necessarily reflect the actual hardware's
12580 capabilities.  If you wish to set an individual option to a particular
12581 value, you may specify it after the @option{-mcpu} option, like
12582 @samp{-mcpu=970 -mno-altivec}.
12584 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
12585 not enabled or disabled by the @option{-mcpu} option at present because
12586 AIX does not have full support for these options.  You may still
12587 enable or disable them individually if you're sure it'll work in your
12588 environment.
12590 @item -mtune=@var{cpu_type}
12591 @opindex mtune
12592 Set the instruction scheduling parameters for machine type
12593 @var{cpu_type}, but do not set the architecture type, register usage, or
12594 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
12595 values for @var{cpu_type} are used for @option{-mtune} as for
12596 @option{-mcpu}.  If both are specified, the code generated will use the
12597 architecture, registers, and mnemonics set by @option{-mcpu}, but the
12598 scheduling parameters set by @option{-mtune}.
12600 @item -mswdiv
12601 @itemx -mno-swdiv
12602 @opindex mswdiv
12603 @opindex mno-swdiv
12604 Generate code to compute division as reciprocal estimate and iterative
12605 refinement, creating opportunities for increased throughput.  This
12606 feature requires: optional PowerPC Graphics instruction set for single
12607 precision and FRE instruction for double precision, assuming divides
12608 cannot generate user-visible traps, and the domain values not include
12609 Infinities, denormals or zero denominator.
12611 @item -maltivec
12612 @itemx -mno-altivec
12613 @opindex maltivec
12614 @opindex mno-altivec
12615 Generate code that uses (does not use) AltiVec instructions, and also
12616 enable the use of built-in functions that allow more direct access to
12617 the AltiVec instruction set.  You may also need to set
12618 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
12619 enhancements.
12621 @item -mvrsave
12622 @item -mno-vrsave
12623 @opindex mvrsave
12624 @opindex mno-vrsave
12625 Generate VRSAVE instructions when generating AltiVec code.
12627 @item -msecure-plt
12628 @opindex msecure-plt
12629 Generate code that allows ld and ld.so to build executables and shared
12630 libraries with non-exec .plt and .got sections.  This is a PowerPC
12631 32-bit SYSV ABI option.
12633 @item -mbss-plt
12634 @opindex mbss-plt
12635 Generate code that uses a BSS .plt section that ld.so fills in, and
12636 requires .plt and .got sections that are both writable and executable.
12637 This is a PowerPC 32-bit SYSV ABI option.
12639 @item -misel
12640 @itemx -mno-isel
12641 @opindex misel
12642 @opindex mno-isel
12643 This switch enables or disables the generation of ISEL instructions.
12645 @item -misel=@var{yes/no}
12646 This switch has been deprecated.  Use @option{-misel} and
12647 @option{-mno-isel} instead.
12649 @item -mspe
12650 @itemx -mno-spe
12651 @opindex mspe
12652 @opindex mno-spe
12653 This switch enables or disables the generation of SPE simd
12654 instructions.
12656 @item -mspe=@var{yes/no}
12657 This option has been deprecated.  Use @option{-mspe} and
12658 @option{-mno-spe} instead.
12660 @item -mfloat-gprs=@var{yes/single/double/no}
12661 @itemx -mfloat-gprs
12662 @opindex mfloat-gprs
12663 This switch enables or disables the generation of floating point
12664 operations on the general purpose registers for architectures that
12665 support it.
12667 The argument @var{yes} or @var{single} enables the use of
12668 single-precision floating point operations.
12670 The argument @var{double} enables the use of single and
12671 double-precision floating point operations.
12673 The argument @var{no} disables floating point operations on the
12674 general purpose registers.
12676 This option is currently only available on the MPC854x.
12678 @item -m32
12679 @itemx -m64
12680 @opindex m32
12681 @opindex m64
12682 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
12683 targets (including GNU/Linux).  The 32-bit environment sets int, long
12684 and pointer to 32 bits and generates code that runs on any PowerPC
12685 variant.  The 64-bit environment sets int to 32 bits and long and
12686 pointer to 64 bits, and generates code for PowerPC64, as for
12687 @option{-mpowerpc64}.
12689 @item -mfull-toc
12690 @itemx -mno-fp-in-toc
12691 @itemx -mno-sum-in-toc
12692 @itemx -mminimal-toc
12693 @opindex mfull-toc
12694 @opindex mno-fp-in-toc
12695 @opindex mno-sum-in-toc
12696 @opindex mminimal-toc
12697 Modify generation of the TOC (Table Of Contents), which is created for
12698 every executable file.  The @option{-mfull-toc} option is selected by
12699 default.  In that case, GCC will allocate at least one TOC entry for
12700 each unique non-automatic variable reference in your program.  GCC
12701 will also place floating-point constants in the TOC@.  However, only
12702 16,384 entries are available in the TOC@.
12704 If you receive a linker error message that saying you have overflowed
12705 the available TOC space, you can reduce the amount of TOC space used
12706 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
12707 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
12708 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
12709 generate code to calculate the sum of an address and a constant at
12710 run-time instead of putting that sum into the TOC@.  You may specify one
12711 or both of these options.  Each causes GCC to produce very slightly
12712 slower and larger code at the expense of conserving TOC space.
12714 If you still run out of space in the TOC even when you specify both of
12715 these options, specify @option{-mminimal-toc} instead.  This option causes
12716 GCC to make only one TOC entry for every file.  When you specify this
12717 option, GCC will produce code that is slower and larger but which
12718 uses extremely little TOC space.  You may wish to use this option
12719 only on files that contain less frequently executed code.
12721 @item -maix64
12722 @itemx -maix32
12723 @opindex maix64
12724 @opindex maix32
12725 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
12726 @code{long} type, and the infrastructure needed to support them.
12727 Specifying @option{-maix64} implies @option{-mpowerpc64} and
12728 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
12729 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
12731 @item -mxl-compat
12732 @itemx -mno-xl-compat
12733 @opindex mxl-compat
12734 @opindex mno-xl-compat
12735 Produce code that conforms more closely to IBM XL compiler semantics
12736 when using AIX-compatible ABI.  Pass floating-point arguments to
12737 prototyped functions beyond the register save area (RSA) on the stack
12738 in addition to argument FPRs.  Do not assume that most significant
12739 double in 128-bit long double value is properly rounded when comparing
12740 values and converting to double.  Use XL symbol names for long double
12741 support routines.
12743 The AIX calling convention was extended but not initially documented to
12744 handle an obscure K&R C case of calling a function that takes the
12745 address of its arguments with fewer arguments than declared.  IBM XL
12746 compilers access floating point arguments which do not fit in the
12747 RSA from the stack when a subroutine is compiled without
12748 optimization.  Because always storing floating-point arguments on the
12749 stack is inefficient and rarely needed, this option is not enabled by
12750 default and only is necessary when calling subroutines compiled by IBM
12751 XL compilers without optimization.
12753 @item -mpe
12754 @opindex mpe
12755 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
12756 application written to use message passing with special startup code to
12757 enable the application to run.  The system must have PE installed in the
12758 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
12759 must be overridden with the @option{-specs=} option to specify the
12760 appropriate directory location.  The Parallel Environment does not
12761 support threads, so the @option{-mpe} option and the @option{-pthread}
12762 option are incompatible.
12764 @item -malign-natural
12765 @itemx -malign-power
12766 @opindex malign-natural
12767 @opindex malign-power
12768 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
12769 @option{-malign-natural} overrides the ABI-defined alignment of larger
12770 types, such as floating-point doubles, on their natural size-based boundary.
12771 The option @option{-malign-power} instructs GCC to follow the ABI-specified
12772 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
12774 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
12775 is not supported.
12777 @item -msoft-float
12778 @itemx -mhard-float
12779 @opindex msoft-float
12780 @opindex mhard-float
12781 Generate code that does not use (uses) the floating-point register set.
12782 Software floating point emulation is provided if you use the
12783 @option{-msoft-float} option, and pass the option to GCC when linking.
12785 @item -mmultiple
12786 @itemx -mno-multiple
12787 @opindex mmultiple
12788 @opindex mno-multiple
12789 Generate code that uses (does not use) the load multiple word
12790 instructions and the store multiple word instructions.  These
12791 instructions are generated by default on POWER systems, and not
12792 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
12793 endian PowerPC systems, since those instructions do not work when the
12794 processor is in little endian mode.  The exceptions are PPC740 and
12795 PPC750 which permit the instructions usage in little endian mode.
12797 @item -mstring
12798 @itemx -mno-string
12799 @opindex mstring
12800 @opindex mno-string
12801 Generate code that uses (does not use) the load string instructions
12802 and the store string word instructions to save multiple registers and
12803 do small block moves.  These instructions are generated by default on
12804 POWER systems, and not generated on PowerPC systems.  Do not use
12805 @option{-mstring} on little endian PowerPC systems, since those
12806 instructions do not work when the processor is in little endian mode.
12807 The exceptions are PPC740 and PPC750 which permit the instructions
12808 usage in little endian mode.
12810 @item -mupdate
12811 @itemx -mno-update
12812 @opindex mupdate
12813 @opindex mno-update
12814 Generate code that uses (does not use) the load or store instructions
12815 that update the base register to the address of the calculated memory
12816 location.  These instructions are generated by default.  If you use
12817 @option{-mno-update}, there is a small window between the time that the
12818 stack pointer is updated and the address of the previous frame is
12819 stored, which means code that walks the stack frame across interrupts or
12820 signals may get corrupted data.
12822 @item -mfused-madd
12823 @itemx -mno-fused-madd
12824 @opindex mfused-madd
12825 @opindex mno-fused-madd
12826 Generate code that uses (does not use) the floating point multiply and
12827 accumulate instructions.  These instructions are generated by default if
12828 hardware floating is used.
12830 @item -mmulhw
12831 @itemx -mno-mulhw
12832 @opindex mmulhw
12833 @opindex mno-mulhw
12834 Generate code that uses (does not use) the half-word multiply and
12835 multiply-accumulate instructions on the IBM 405 and 440 processors.
12836 These instructions are generated by default when targetting those
12837 processors.
12839 @item -mdlmzb
12840 @itemx -mno-dlmzb
12841 @opindex mdlmzb
12842 @opindex mno-dlmzb
12843 Generate code that uses (does not use) the string-search @samp{dlmzb}
12844 instruction on the IBM 405 and 440 processors.  This instruction is
12845 generated by default when targetting those processors.
12847 @item -mno-bit-align
12848 @itemx -mbit-align
12849 @opindex mno-bit-align
12850 @opindex mbit-align
12851 On System V.4 and embedded PowerPC systems do not (do) force structures
12852 and unions that contain bit-fields to be aligned to the base type of the
12853 bit-field.
12855 For example, by default a structure containing nothing but 8
12856 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
12857 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
12858 the structure would be aligned to a 1 byte boundary and be one byte in
12859 size.
12861 @item -mno-strict-align
12862 @itemx -mstrict-align
12863 @opindex mno-strict-align
12864 @opindex mstrict-align
12865 On System V.4 and embedded PowerPC systems do not (do) assume that
12866 unaligned memory references will be handled by the system.
12868 @item -mrelocatable
12869 @itemx -mno-relocatable
12870 @opindex mrelocatable
12871 @opindex mno-relocatable
12872 On embedded PowerPC systems generate code that allows (does not allow)
12873 the program to be relocated to a different address at runtime.  If you
12874 use @option{-mrelocatable} on any module, all objects linked together must
12875 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
12877 @item -mrelocatable-lib
12878 @itemx -mno-relocatable-lib
12879 @opindex mrelocatable-lib
12880 @opindex mno-relocatable-lib
12881 On embedded PowerPC systems generate code that allows (does not allow)
12882 the program to be relocated to a different address at runtime.  Modules
12883 compiled with @option{-mrelocatable-lib} can be linked with either modules
12884 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
12885 with modules compiled with the @option{-mrelocatable} options.
12887 @item -mno-toc
12888 @itemx -mtoc
12889 @opindex mno-toc
12890 @opindex mtoc
12891 On System V.4 and embedded PowerPC systems do not (do) assume that
12892 register 2 contains a pointer to a global area pointing to the addresses
12893 used in the program.
12895 @item -mlittle
12896 @itemx -mlittle-endian
12897 @opindex mlittle
12898 @opindex mlittle-endian
12899 On System V.4 and embedded PowerPC systems compile code for the
12900 processor in little endian mode.  The @option{-mlittle-endian} option is
12901 the same as @option{-mlittle}.
12903 @item -mbig
12904 @itemx -mbig-endian
12905 @opindex mbig
12906 @opindex mbig-endian
12907 On System V.4 and embedded PowerPC systems compile code for the
12908 processor in big endian mode.  The @option{-mbig-endian} option is
12909 the same as @option{-mbig}.
12911 @item -mdynamic-no-pic
12912 @opindex mdynamic-no-pic
12913 On Darwin and Mac OS X systems, compile code so that it is not
12914 relocatable, but that its external references are relocatable.  The
12915 resulting code is suitable for applications, but not shared
12916 libraries.
12918 @item -mprioritize-restricted-insns=@var{priority}
12919 @opindex mprioritize-restricted-insns
12920 This option controls the priority that is assigned to
12921 dispatch-slot restricted instructions during the second scheduling
12922 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
12923 @var{no/highest/second-highest} priority to dispatch slot restricted
12924 instructions.
12926 @item -msched-costly-dep=@var{dependence_type}
12927 @opindex msched-costly-dep
12928 This option controls which dependences are considered costly
12929 by the target during instruction scheduling.  The argument
12930 @var{dependence_type} takes one of the following values:
12931 @var{no}: no dependence is costly,
12932 @var{all}: all dependences are costly,
12933 @var{true_store_to_load}: a true dependence from store to load is costly,
12934 @var{store_to_load}: any dependence from store to load is costly,
12935 @var{number}: any dependence which latency >= @var{number} is costly.
12937 @item -minsert-sched-nops=@var{scheme}
12938 @opindex minsert-sched-nops
12939 This option controls which nop insertion scheme will be used during
12940 the second scheduling pass.  The argument @var{scheme} takes one of the
12941 following values:
12942 @var{no}: Don't insert nops.
12943 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
12944 according to the scheduler's grouping.
12945 @var{regroup_exact}: Insert nops to force costly dependent insns into
12946 separate groups.  Insert exactly as many nops as needed to force an insn
12947 to a new group, according to the estimated processor grouping.
12948 @var{number}: Insert nops to force costly dependent insns into
12949 separate groups.  Insert @var{number} nops to force an insn to a new group.
12951 @item -mcall-sysv
12952 @opindex mcall-sysv
12953 On System V.4 and embedded PowerPC systems compile code using calling
12954 conventions that adheres to the March 1995 draft of the System V
12955 Application Binary Interface, PowerPC processor supplement.  This is the
12956 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
12958 @item -mcall-sysv-eabi
12959 @opindex mcall-sysv-eabi
12960 Specify both @option{-mcall-sysv} and @option{-meabi} options.
12962 @item -mcall-sysv-noeabi
12963 @opindex mcall-sysv-noeabi
12964 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
12966 @item -mcall-solaris
12967 @opindex mcall-solaris
12968 On System V.4 and embedded PowerPC systems compile code for the Solaris
12969 operating system.
12971 @item -mcall-linux
12972 @opindex mcall-linux
12973 On System V.4 and embedded PowerPC systems compile code for the
12974 Linux-based GNU system.
12976 @item -mcall-gnu
12977 @opindex mcall-gnu
12978 On System V.4 and embedded PowerPC systems compile code for the
12979 Hurd-based GNU system.
12981 @item -mcall-netbsd
12982 @opindex mcall-netbsd
12983 On System V.4 and embedded PowerPC systems compile code for the
12984 NetBSD operating system.
12986 @item -maix-struct-return
12987 @opindex maix-struct-return
12988 Return all structures in memory (as specified by the AIX ABI)@.
12990 @item -msvr4-struct-return
12991 @opindex msvr4-struct-return
12992 Return structures smaller than 8 bytes in registers (as specified by the
12993 SVR4 ABI)@.
12995 @item -mabi=@var{abi-type}
12996 @opindex mabi
12997 Extend the current ABI with a particular extension, or remove such extension.
12998 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
12999 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
13001 @item -mabi=spe
13002 @opindex mabi=spe
13003 Extend the current ABI with SPE ABI extensions.  This does not change
13004 the default ABI, instead it adds the SPE ABI extensions to the current
13005 ABI@.
13007 @item -mabi=no-spe
13008 @opindex mabi=no-spe
13009 Disable Booke SPE ABI extensions for the current ABI@.
13011 @item -mabi=ibmlongdouble
13012 @opindex mabi=ibmlongdouble
13013 Change the current ABI to use IBM extended precision long double.
13014 This is a PowerPC 32-bit SYSV ABI option.
13016 @item -mabi=ieeelongdouble
13017 @opindex mabi=ieeelongdouble
13018 Change the current ABI to use IEEE extended precision long double.
13019 This is a PowerPC 32-bit Linux ABI option.
13021 @item -mprototype
13022 @itemx -mno-prototype
13023 @opindex mprototype
13024 @opindex mno-prototype
13025 On System V.4 and embedded PowerPC systems assume that all calls to
13026 variable argument functions are properly prototyped.  Otherwise, the
13027 compiler must insert an instruction before every non prototyped call to
13028 set or clear bit 6 of the condition code register (@var{CR}) to
13029 indicate whether floating point values were passed in the floating point
13030 registers in case the function takes a variable arguments.  With
13031 @option{-mprototype}, only calls to prototyped variable argument functions
13032 will set or clear the bit.
13034 @item -msim
13035 @opindex msim
13036 On embedded PowerPC systems, assume that the startup module is called
13037 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
13038 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
13039 configurations.
13041 @item -mmvme
13042 @opindex mmvme
13043 On embedded PowerPC systems, assume that the startup module is called
13044 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
13045 @file{libc.a}.
13047 @item -mads
13048 @opindex mads
13049 On embedded PowerPC systems, assume that the startup module is called
13050 @file{crt0.o} and the standard C libraries are @file{libads.a} and
13051 @file{libc.a}.
13053 @item -myellowknife
13054 @opindex myellowknife
13055 On embedded PowerPC systems, assume that the startup module is called
13056 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
13057 @file{libc.a}.
13059 @item -mvxworks
13060 @opindex mvxworks
13061 On System V.4 and embedded PowerPC systems, specify that you are
13062 compiling for a VxWorks system.
13064 @item -mwindiss
13065 @opindex mwindiss
13066 Specify that you are compiling for the WindISS simulation environment.
13068 @item -memb
13069 @opindex memb
13070 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
13071 header to indicate that @samp{eabi} extended relocations are used.
13073 @item -meabi
13074 @itemx -mno-eabi
13075 @opindex meabi
13076 @opindex mno-eabi
13077 On System V.4 and embedded PowerPC systems do (do not) adhere to the
13078 Embedded Applications Binary Interface (eabi) which is a set of
13079 modifications to the System V.4 specifications.  Selecting @option{-meabi}
13080 means that the stack is aligned to an 8 byte boundary, a function
13081 @code{__eabi} is called to from @code{main} to set up the eabi
13082 environment, and the @option{-msdata} option can use both @code{r2} and
13083 @code{r13} to point to two separate small data areas.  Selecting
13084 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
13085 do not call an initialization function from @code{main}, and the
13086 @option{-msdata} option will only use @code{r13} to point to a single
13087 small data area.  The @option{-meabi} option is on by default if you
13088 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
13090 @item -msdata=eabi
13091 @opindex msdata=eabi
13092 On System V.4 and embedded PowerPC systems, put small initialized
13093 @code{const} global and static data in the @samp{.sdata2} section, which
13094 is pointed to by register @code{r2}.  Put small initialized
13095 non-@code{const} global and static data in the @samp{.sdata} section,
13096 which is pointed to by register @code{r13}.  Put small uninitialized
13097 global and static data in the @samp{.sbss} section, which is adjacent to
13098 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
13099 incompatible with the @option{-mrelocatable} option.  The
13100 @option{-msdata=eabi} option also sets the @option{-memb} option.
13102 @item -msdata=sysv
13103 @opindex msdata=sysv
13104 On System V.4 and embedded PowerPC systems, put small global and static
13105 data in the @samp{.sdata} section, which is pointed to by register
13106 @code{r13}.  Put small uninitialized global and static data in the
13107 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
13108 The @option{-msdata=sysv} option is incompatible with the
13109 @option{-mrelocatable} option.
13111 @item -msdata=default
13112 @itemx -msdata
13113 @opindex msdata=default
13114 @opindex msdata
13115 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
13116 compile code the same as @option{-msdata=eabi}, otherwise compile code the
13117 same as @option{-msdata=sysv}.
13119 @item -msdata-data
13120 @opindex msdata-data
13121 On System V.4 and embedded PowerPC systems, put small global
13122 data in the @samp{.sdata} section.  Put small uninitialized global
13123 data in the @samp{.sbss} section.  Do not use register @code{r13}
13124 to address small data however.  This is the default behavior unless
13125 other @option{-msdata} options are used.
13127 @item -msdata=none
13128 @itemx -mno-sdata
13129 @opindex msdata=none
13130 @opindex mno-sdata
13131 On embedded PowerPC systems, put all initialized global and static data
13132 in the @samp{.data} section, and all uninitialized data in the
13133 @samp{.bss} section.
13135 @item -G @var{num}
13136 @opindex G
13137 @cindex smaller data references (PowerPC)
13138 @cindex .sdata/.sdata2 references (PowerPC)
13139 On embedded PowerPC systems, put global and static items less than or
13140 equal to @var{num} bytes into the small data or bss sections instead of
13141 the normal data or bss section.  By default, @var{num} is 8.  The
13142 @option{-G @var{num}} switch is also passed to the linker.
13143 All modules should be compiled with the same @option{-G @var{num}} value.
13145 @item -mregnames
13146 @itemx -mno-regnames
13147 @opindex mregnames
13148 @opindex mno-regnames
13149 On System V.4 and embedded PowerPC systems do (do not) emit register
13150 names in the assembly language output using symbolic forms.
13152 @item -mlongcall
13153 @itemx -mno-longcall
13154 @opindex mlongcall
13155 @opindex mno-longcall
13156 By default assume that all calls are far away so that a longer more
13157 expensive calling sequence is required.  This is required for calls
13158 further than 32 megabytes (33,554,432 bytes) from the current location.
13159 A short call will be generated if the compiler knows
13160 the call cannot be that far away.  This setting can be overridden by
13161 the @code{shortcall} function attribute, or by @code{#pragma
13162 longcall(0)}.
13164 Some linkers are capable of detecting out-of-range calls and generating
13165 glue code on the fly.  On these systems, long calls are unnecessary and
13166 generate slower code.  As of this writing, the AIX linker can do this,
13167 as can the GNU linker for PowerPC/64.  It is planned to add this feature
13168 to the GNU linker for 32-bit PowerPC systems as well.
13170 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
13171 callee, L42'', plus a ``branch island'' (glue code).  The two target
13172 addresses represent the callee and the ``branch island''.  The
13173 Darwin/PPC linker will prefer the first address and generate a ``bl
13174 callee'' if the PPC ``bl'' instruction will reach the callee directly;
13175 otherwise, the linker will generate ``bl L42'' to call the ``branch
13176 island''.  The ``branch island'' is appended to the body of the
13177 calling function; it computes the full 32-bit address of the callee
13178 and jumps to it.
13180 On Mach-O (Darwin) systems, this option directs the compiler emit to
13181 the glue for every direct call, and the Darwin linker decides whether
13182 to use or discard it.
13184 In the future, we may cause GCC to ignore all longcall specifications
13185 when the linker is known to generate glue.
13187 @item -pthread
13188 @opindex pthread
13189 Adds support for multithreading with the @dfn{pthreads} library.
13190 This option sets flags for both the preprocessor and linker.
13192 @end table
13194 @node S/390 and zSeries Options
13195 @subsection S/390 and zSeries Options
13196 @cindex S/390 and zSeries Options
13198 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
13200 @table @gcctabopt
13201 @item -mhard-float
13202 @itemx -msoft-float
13203 @opindex mhard-float
13204 @opindex msoft-float
13205 Use (do not use) the hardware floating-point instructions and registers
13206 for floating-point operations.  When @option{-msoft-float} is specified,
13207 functions in @file{libgcc.a} will be used to perform floating-point
13208 operations.  When @option{-mhard-float} is specified, the compiler
13209 generates IEEE floating-point instructions.  This is the default.
13211 @item -mlong-double-64
13212 @itemx -mlong-double-128
13213 @opindex mlong-double-64
13214 @opindex mlong-double-128
13215 These switches control the size of @code{long double} type. A size
13216 of 64bit makes the @code{long double} type equivalent to the @code{double}
13217 type. This is the default.
13219 @item -mbackchain
13220 @itemx -mno-backchain
13221 @opindex mbackchain
13222 @opindex mno-backchain
13223 Store (do not store) the address of the caller's frame as backchain pointer
13224 into the callee's stack frame.
13225 A backchain may be needed to allow debugging using tools that do not understand
13226 DWARF-2 call frame information.
13227 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
13228 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
13229 the backchain is placed into the topmost word of the 96/160 byte register
13230 save area.
13232 In general, code compiled with @option{-mbackchain} is call-compatible with
13233 code compiled with @option{-mmo-backchain}; however, use of the backchain
13234 for debugging purposes usually requires that the whole binary is built with
13235 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
13236 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13237 to build a linux kernel use @option{-msoft-float}.
13239 The default is to not maintain the backchain.
13241 @item -mpacked-stack
13242 @item -mno-packed-stack
13243 @opindex mpacked-stack
13244 @opindex mno-packed-stack
13245 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
13246 specified, the compiler uses the all fields of the 96/160 byte register save
13247 area only for their default purpose; unused fields still take up stack space.
13248 When @option{-mpacked-stack} is specified, register save slots are densely
13249 packed at the top of the register save area; unused space is reused for other
13250 purposes, allowing for more efficient use of the available stack space.
13251 However, when @option{-mbackchain} is also in effect, the topmost word of
13252 the save area is always used to store the backchain, and the return address
13253 register is always saved two words below the backchain.
13255 As long as the stack frame backchain is not used, code generated with
13256 @option{-mpacked-stack} is call-compatible with code generated with
13257 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
13258 S/390 or zSeries generated code that uses the stack frame backchain at run
13259 time, not just for debugging purposes.  Such code is not call-compatible
13260 with code compiled with @option{-mpacked-stack}.  Also, note that the
13261 combination of @option{-mbackchain},
13262 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
13263 to build a linux kernel use @option{-msoft-float}.
13265 The default is to not use the packed stack layout.
13267 @item -msmall-exec
13268 @itemx -mno-small-exec
13269 @opindex msmall-exec
13270 @opindex mno-small-exec
13271 Generate (or do not generate) code using the @code{bras} instruction
13272 to do subroutine calls.
13273 This only works reliably if the total executable size does not
13274 exceed 64k.  The default is to use the @code{basr} instruction instead,
13275 which does not have this limitation.
13277 @item -m64
13278 @itemx -m31
13279 @opindex m64
13280 @opindex m31
13281 When @option{-m31} is specified, generate code compliant to the
13282 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
13283 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
13284 particular to generate 64-bit instructions.  For the @samp{s390}
13285 targets, the default is @option{-m31}, while the @samp{s390x}
13286 targets default to @option{-m64}.
13288 @item -mzarch
13289 @itemx -mesa
13290 @opindex mzarch
13291 @opindex mesa
13292 When @option{-mzarch} is specified, generate code using the
13293 instructions available on z/Architecture.
13294 When @option{-mesa} is specified, generate code using the
13295 instructions available on ESA/390.  Note that @option{-mesa} is
13296 not possible with @option{-m64}.
13297 When generating code compliant to the GNU/Linux for S/390 ABI,
13298 the default is @option{-mesa}.  When generating code compliant
13299 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
13301 @item -mmvcle
13302 @itemx -mno-mvcle
13303 @opindex mmvcle
13304 @opindex mno-mvcle
13305 Generate (or do not generate) code using the @code{mvcle} instruction
13306 to perform block moves.  When @option{-mno-mvcle} is specified,
13307 use a @code{mvc} loop instead.  This is the default unless optimizing for
13308 size.
13310 @item -mdebug
13311 @itemx -mno-debug
13312 @opindex mdebug
13313 @opindex mno-debug
13314 Print (or do not print) additional debug information when compiling.
13315 The default is to not print debug information.
13317 @item -march=@var{cpu-type}
13318 @opindex march
13319 Generate code that will run on @var{cpu-type}, which is the name of a system
13320 representing a certain processor type.  Possible values for
13321 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
13322 When generating code using the instructions available on z/Architecture,
13323 the default is @option{-march=z900}.  Otherwise, the default is
13324 @option{-march=g5}.
13326 @item -mtune=@var{cpu-type}
13327 @opindex mtune
13328 Tune to @var{cpu-type} everything applicable about the generated code,
13329 except for the ABI and the set of available instructions.
13330 The list of @var{cpu-type} values is the same as for @option{-march}.
13331 The default is the value used for @option{-march}.
13333 @item -mtpf-trace
13334 @itemx -mno-tpf-trace
13335 @opindex mtpf-trace
13336 @opindex mno-tpf-trace
13337 Generate code that adds (does not add) in TPF OS specific branches to trace
13338 routines in the operating system.  This option is off by default, even
13339 when compiling for the TPF OS@.
13341 @item -mfused-madd
13342 @itemx -mno-fused-madd
13343 @opindex mfused-madd
13344 @opindex mno-fused-madd
13345 Generate code that uses (does not use) the floating point multiply and
13346 accumulate instructions.  These instructions are generated by default if
13347 hardware floating point is used.
13349 @item -mwarn-framesize=@var{framesize}
13350 @opindex mwarn-framesize
13351 Emit a warning if the current function exceeds the given frame size.  Because
13352 this is a compile time check it doesn't need to be a real problem when the program
13353 runs.  It is intended to identify functions which most probably cause
13354 a stack overflow.  It is useful to be used in an environment with limited stack
13355 size e.g.@: the linux kernel.
13357 @item -mwarn-dynamicstack
13358 @opindex mwarn-dynamicstack
13359 Emit a warning if the function calls alloca or uses dynamically
13360 sized arrays.  This is generally a bad idea with a limited stack size.
13362 @item -mstack-guard=@var{stack-guard}
13363 @item -mstack-size=@var{stack-size}
13364 @opindex mstack-guard
13365 @opindex mstack-size
13366 If these options are provided the s390 back end emits additional instructions in
13367 the function prologue which trigger a trap if the stack size is @var{stack-guard}
13368 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
13369 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
13370 the frame size of the compiled function is chosen.
13371 These options are intended to be used to help debugging stack overflow problems.
13372 The additionally emitted code causes only little overhead and hence can also be
13373 used in production like systems without greater performance degradation.  The given
13374 values have to be exact powers of 2 and @var{stack-size} has to be greater than
13375 @var{stack-guard} without exceeding 64k.
13376 In order to be efficient the extra code makes the assumption that the stack starts
13377 at an address aligned to the value given by @var{stack-size}.
13378 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
13379 @end table
13381 @node Score Options
13382 @subsection Score Options
13383 @cindex Score Options
13385 These options are defined for Score implementations:
13387 @table @gcctabopt
13388 @item -meb
13389 @opindex meb
13390 Compile code for big endian mode.  This is the default.
13392 @item -mel
13393 @opindex mel
13394 Compile code for little endian mode. 
13396 @item -mnhwloop
13397 @opindex mnhwloop
13398 Disable generate bcnz instruction.
13400 @item -muls
13401 @opindex muls
13402 Enable generate unaligned load and store instruction.
13404 @item -mmac
13405 @opindex mmac
13406 Enable the use of multiply-accumulate instructions. Disabled by default. 
13408 @item -mscore5
13409 @opindex mscore5
13410 Specify the SCORE5 as the target architecture.
13412 @item -mscore5u
13413 @opindex mscore5u
13414 Specify the SCORE5U of the target architecture.
13416 @item -mscore7
13417 @opindex mscore7
13418 Specify the SCORE7 as the target architecture. This is the default.
13420 @item -mscore7d
13421 @opindex mscore7d
13422 Specify the SCORE7D as the target architecture.
13423 @end table
13425 @node SH Options
13426 @subsection SH Options
13428 These @samp{-m} options are defined for the SH implementations:
13430 @table @gcctabopt
13431 @item -m1
13432 @opindex m1
13433 Generate code for the SH1.
13435 @item -m2
13436 @opindex m2
13437 Generate code for the SH2.
13439 @item -m2e
13440 Generate code for the SH2e.
13442 @item -m3
13443 @opindex m3
13444 Generate code for the SH3.
13446 @item -m3e
13447 @opindex m3e
13448 Generate code for the SH3e.
13450 @item -m4-nofpu
13451 @opindex m4-nofpu
13452 Generate code for the SH4 without a floating-point unit.
13454 @item -m4-single-only
13455 @opindex m4-single-only
13456 Generate code for the SH4 with a floating-point unit that only
13457 supports single-precision arithmetic.
13459 @item -m4-single
13460 @opindex m4-single
13461 Generate code for the SH4 assuming the floating-point unit is in
13462 single-precision mode by default.
13464 @item -m4
13465 @opindex m4
13466 Generate code for the SH4.
13468 @item -m4a-nofpu
13469 @opindex m4a-nofpu
13470 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
13471 floating-point unit is not used.
13473 @item -m4a-single-only
13474 @opindex m4a-single-only
13475 Generate code for the SH4a, in such a way that no double-precision
13476 floating point operations are used.
13478 @item -m4a-single
13479 @opindex m4a-single
13480 Generate code for the SH4a assuming the floating-point unit is in
13481 single-precision mode by default.
13483 @item -m4a
13484 @opindex m4a
13485 Generate code for the SH4a.
13487 @item -m4al
13488 @opindex m4al
13489 Same as @option{-m4a-nofpu}, except that it implicitly passes
13490 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
13491 instructions at the moment.
13493 @item -mb
13494 @opindex mb
13495 Compile code for the processor in big endian mode.
13497 @item -ml
13498 @opindex ml
13499 Compile code for the processor in little endian mode.
13501 @item -mdalign
13502 @opindex mdalign
13503 Align doubles at 64-bit boundaries.  Note that this changes the calling
13504 conventions, and thus some functions from the standard C library will
13505 not work unless you recompile it first with @option{-mdalign}.
13507 @item -mrelax
13508 @opindex mrelax
13509 Shorten some address references at link time, when possible; uses the
13510 linker option @option{-relax}.
13512 @item -mbigtable
13513 @opindex mbigtable
13514 Use 32-bit offsets in @code{switch} tables.  The default is to use
13515 16-bit offsets.
13517 @item -mfmovd
13518 @opindex mfmovd
13519 Enable the use of the instruction @code{fmovd}.
13521 @item -mhitachi
13522 @opindex mhitachi
13523 Comply with the calling conventions defined by Renesas.
13525 @item -mrenesas
13526 @opindex mhitachi
13527 Comply with the calling conventions defined by Renesas.
13529 @item -mno-renesas
13530 @opindex mhitachi
13531 Comply with the calling conventions defined for GCC before the Renesas
13532 conventions were available.  This option is the default for all
13533 targets of the SH toolchain except for @samp{sh-symbianelf}.
13535 @item -mnomacsave
13536 @opindex mnomacsave
13537 Mark the @code{MAC} register as call-clobbered, even if
13538 @option{-mhitachi} is given.
13540 @item -mieee
13541 @opindex mieee
13542 Increase IEEE-compliance of floating-point code.
13543 At the moment, this is equivalent to @option{-fno-finite-math-only}.
13544 When generating 16 bit SH opcodes, getting IEEE-conforming results for
13545 comparisons of NANs / infinities incurs extra overhead in every
13546 floating point comparison, therefore the default is set to
13547 @option{-ffinite-math-only}.
13549 @item -minline-ic_invalidate
13550 @opindex minline-ic_invalidate
13551 Inline code to invalidate instruction cache entries after setting up
13552 nested function trampolines.
13553 This option has no effect if -musermode is in effect and the selected
13554 code generation option (e.g. -m4) does not allow the use of the icbi
13555 instruction.
13556 If the selected code generation option does not allow the use of the icbi
13557 instruction, and -musermode is not in effect, the inlined code will
13558 manipulate the instruction cache address array directly with an associative
13559 write.  This not only requires privileged mode, but it will also
13560 fail if the cache line had been mapped via the TLB and has become unmapped.
13562 @item -misize
13563 @opindex misize
13564 Dump instruction size and location in the assembly code.
13566 @item -mpadstruct
13567 @opindex mpadstruct
13568 This option is deprecated.  It pads structures to multiple of 4 bytes,
13569 which is incompatible with the SH ABI@.
13571 @item -mspace
13572 @opindex mspace
13573 Optimize for space instead of speed.  Implied by @option{-Os}.
13575 @item -mprefergot
13576 @opindex mprefergot
13577 When generating position-independent code, emit function calls using
13578 the Global Offset Table instead of the Procedure Linkage Table.
13580 @item -musermode
13581 @opindex musermode
13582 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
13583 if the inlined code would not work in user mode.
13584 This is the default when the target is @code{sh-*-linux*}.
13586 @item -multcost=@var{number}
13587 @opindex multcost=@var{number}
13588 Set the cost to assume for a multiply insn.
13590 @item -mdiv=@var{strategy}
13591 @opindex mdiv=@var{strategy}
13592 Set the division strategy to use for SHmedia code.  @var{strategy} must be
13593 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
13594 inv:call2, inv:fp .
13595 "fp" performs the operation in floating point.  This has a very high latency,
13596 but needs only a few instructions, so it might be a good choice if
13597 your code has enough easily exploitable ILP to allow the compiler to
13598 schedule the floating point instructions together with other instructions.
13599 Division by zero causes a floating point exception.
13600 "inv" uses integer operations to calculate the inverse of the divisor,
13601 and then multiplies the dividend with the inverse.  This strategy allows
13602 cse and hoisting of the inverse calculation.  Division by zero calculates
13603 an unspecified result, but does not trap.
13604 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
13605 have been found, or if the entire operation has been hoisted to the same
13606 place, the last stages of the inverse calculation are intertwined with the
13607 final multiply to reduce the overall latency, at the expense of using a few
13608 more instructions, and thus offering fewer scheduling opportunities with
13609 other code.
13610 "call" calls a library function that usually implements the inv:minlat
13611 strategy.
13612 This gives high code density for m5-*media-nofpu compilations.
13613 "call2" uses a different entry point of the same library function, where it
13614 assumes that a pointer to a lookup table has already been set up, which
13615 exposes the pointer load to cse / code hoisting optimizations.
13616 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
13617 code generation, but if the code stays unoptimized, revert to the "call",
13618 "call2", or "fp" strategies, respectively.  Note that the
13619 potentially-trapping side effect of division by zero is carried by a
13620 separate instruction, so it is possible that all the integer instructions
13621 are hoisted out, but the marker for the side effect stays where it is.
13622 A recombination to fp operations or a call is not possible in that case.
13623 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
13624 that the inverse calculation was nor separated from the multiply, they speed
13625 up division where the dividend fits into 20 bits (plus sign where applicable),
13626 by inserting a test to skip a number of operations in this case; this test
13627 slows down the case of larger dividends.  inv20u assumes the case of a such
13628 a small dividend to be unlikely, and inv20l assumes it to be likely.
13630 @item -mdivsi3_libfunc=@var{name}
13631 @opindex mdivsi3_libfunc=@var{name}
13632 Set the name of the library function used for 32 bit signed division to
13633 @var{name}.  This only affect the name used in the call and inv:call
13634 division strategies, and the compiler will still expect the same
13635 sets of input/output/clobbered registers as if this option was not present.
13637 @item -madjust-unroll
13638 @opindex madjust-unroll
13639 Throttle unrolling to avoid thrashing target registers.
13640 This option only has an effect if the gcc code base supports the
13641 TARGET_ADJUST_UNROLL_MAX target hook.
13643 @item -mindexed-addressing
13644 @opindex mindexed-addressing
13645 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
13646 This is only safe if the hardware and/or OS implement 32 bit wrap-around
13647 semantics for the indexed addressing mode.  The architecture allows the
13648 implementation of processors with 64 bit MMU, which the OS could use to
13649 get 32 bit addressing, but since no current hardware implementation supports
13650 this or any other way to make the indexed addressing mode safe to use in
13651 the 32 bit ABI, the default is -mno-indexed-addressing.
13653 @item -mgettrcost=@var{number}
13654 @opindex mgettrcost=@var{number}
13655 Set the cost assumed for the gettr instruction to @var{number}.
13656 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
13658 @item -mpt-fixed
13659 @opindex mpt-fixed
13660 Assume pt* instructions won't trap.  This will generally generate better
13661 scheduled code, but is unsafe on current hardware.  The current architecture
13662 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
13663 This has the unintentional effect of making it unsafe to schedule ptabs /
13664 ptrel before a branch, or hoist it out of a loop.  For example,
13665 __do_global_ctors, a part of libgcc that runs constructors at program
13666 startup, calls functions in a list which is delimited by @minus{}1.  With the
13667 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
13668 That means that all the constructors will be run a bit quicker, but when
13669 the loop comes to the end of the list, the program crashes because ptabs
13670 loads @minus{}1 into a target register.  Since this option is unsafe for any
13671 hardware implementing the current architecture specification, the default
13672 is -mno-pt-fixed.  Unless the user specifies a specific cost with
13673 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
13674 this deters register allocation using target registers for storing
13675 ordinary integers.
13677 @item -minvalid-symbols
13678 @opindex minvalid-symbols
13679 Assume symbols might be invalid.  Ordinary function symbols generated by
13680 the compiler will always be valid to load with movi/shori/ptabs or
13681 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
13682 to generate symbols that will cause ptabs / ptrel to trap.
13683 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
13684 It will then prevent cross-basic-block cse, hoisting and most scheduling
13685 of symbol loads.  The default is @option{-mno-invalid-symbols}.
13686 @end table
13688 @node SPARC Options
13689 @subsection SPARC Options
13690 @cindex SPARC options
13692 These @samp{-m} options are supported on the SPARC:
13694 @table @gcctabopt
13695 @item -mno-app-regs
13696 @itemx -mapp-regs
13697 @opindex mno-app-regs
13698 @opindex mapp-regs
13699 Specify @option{-mapp-regs} to generate output using the global registers
13700 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
13701 is the default.
13703 To be fully SVR4 ABI compliant at the cost of some performance loss,
13704 specify @option{-mno-app-regs}.  You should compile libraries and system
13705 software with this option.
13707 @item -mfpu
13708 @itemx -mhard-float
13709 @opindex mfpu
13710 @opindex mhard-float
13711 Generate output containing floating point instructions.  This is the
13712 default.
13714 @item -mno-fpu
13715 @itemx -msoft-float
13716 @opindex mno-fpu
13717 @opindex msoft-float
13718 Generate output containing library calls for floating point.
13719 @strong{Warning:} the requisite libraries are not available for all SPARC
13720 targets.  Normally the facilities of the machine's usual C compiler are
13721 used, but this cannot be done directly in cross-compilation.  You must make
13722 your own arrangements to provide suitable library functions for
13723 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
13724 @samp{sparclite-*-*} do provide software floating point support.
13726 @option{-msoft-float} changes the calling convention in the output file;
13727 therefore, it is only useful if you compile @emph{all} of a program with
13728 this option.  In particular, you need to compile @file{libgcc.a}, the
13729 library that comes with GCC, with @option{-msoft-float} in order for
13730 this to work.
13732 @item -mhard-quad-float
13733 @opindex mhard-quad-float
13734 Generate output containing quad-word (long double) floating point
13735 instructions.
13737 @item -msoft-quad-float
13738 @opindex msoft-quad-float
13739 Generate output containing library calls for quad-word (long double)
13740 floating point instructions.  The functions called are those specified
13741 in the SPARC ABI@.  This is the default.
13743 As of this writing, there are no SPARC implementations that have hardware
13744 support for the quad-word floating point instructions.  They all invoke
13745 a trap handler for one of these instructions, and then the trap handler
13746 emulates the effect of the instruction.  Because of the trap handler overhead,
13747 this is much slower than calling the ABI library routines.  Thus the
13748 @option{-msoft-quad-float} option is the default.
13750 @item -mno-unaligned-doubles
13751 @itemx -munaligned-doubles
13752 @opindex mno-unaligned-doubles
13753 @opindex munaligned-doubles
13754 Assume that doubles have 8 byte alignment.  This is the default.
13756 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
13757 alignment only if they are contained in another type, or if they have an
13758 absolute address.  Otherwise, it assumes they have 4 byte alignment.
13759 Specifying this option avoids some rare compatibility problems with code
13760 generated by other compilers.  It is not the default because it results
13761 in a performance loss, especially for floating point code.
13763 @item -mno-faster-structs
13764 @itemx -mfaster-structs
13765 @opindex mno-faster-structs
13766 @opindex mfaster-structs
13767 With @option{-mfaster-structs}, the compiler assumes that structures
13768 should have 8 byte alignment.  This enables the use of pairs of
13769 @code{ldd} and @code{std} instructions for copies in structure
13770 assignment, in place of twice as many @code{ld} and @code{st} pairs.
13771 However, the use of this changed alignment directly violates the SPARC
13772 ABI@.  Thus, it's intended only for use on targets where the developer
13773 acknowledges that their resulting code will not be directly in line with
13774 the rules of the ABI@.
13776 @item -mimpure-text
13777 @opindex mimpure-text
13778 @option{-mimpure-text}, used in addition to @option{-shared}, tells
13779 the compiler to not pass @option{-z text} to the linker when linking a
13780 shared object.  Using this option, you can link position-dependent
13781 code into a shared object.
13783 @option{-mimpure-text} suppresses the ``relocations remain against
13784 allocatable but non-writable sections'' linker error message.
13785 However, the necessary relocations will trigger copy-on-write, and the
13786 shared object is not actually shared across processes.  Instead of
13787 using @option{-mimpure-text}, you should compile all source code with
13788 @option{-fpic} or @option{-fPIC}.
13790 This option is only available on SunOS and Solaris.
13792 @item -mcpu=@var{cpu_type}
13793 @opindex mcpu
13794 Set the instruction set, register set, and instruction scheduling parameters
13795 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
13796 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
13797 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
13798 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
13799 @samp{ultrasparc3}, and @samp{niagara}.
13801 Default instruction scheduling parameters are used for values that select
13802 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
13803 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
13805 Here is a list of each supported architecture and their supported
13806 implementations.
13808 @smallexample
13809     v7:             cypress
13810     v8:             supersparc, hypersparc
13811     sparclite:      f930, f934, sparclite86x
13812     sparclet:       tsc701
13813     v9:             ultrasparc, ultrasparc3, niagara
13814 @end smallexample
13816 By default (unless configured otherwise), GCC generates code for the V7
13817 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
13818 additionally optimizes it for the Cypress CY7C602 chip, as used in the
13819 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
13820 SPARCStation 1, 2, IPX etc.
13822 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
13823 architecture.  The only difference from V7 code is that the compiler emits
13824 the integer multiply and integer divide instructions which exist in SPARC-V8
13825 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
13826 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
13827 2000 series.
13829 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
13830 the SPARC architecture.  This adds the integer multiply, integer divide step
13831 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
13832 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
13833 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
13834 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
13835 MB86934 chip, which is the more recent SPARClite with FPU@.
13837 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
13838 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
13839 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
13840 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
13841 optimizes it for the TEMIC SPARClet chip.
13843 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
13844 architecture.  This adds 64-bit integer and floating-point move instructions,
13845 3 additional floating-point condition code registers and conditional move
13846 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
13847 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
13848 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
13849 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
13850 @option{-mcpu=niagara}, the compiler additionally optimizes it for
13851 Sun UltraSPARC T1 chips.
13853 @item -mtune=@var{cpu_type}
13854 @opindex mtune
13855 Set the instruction scheduling parameters for machine type
13856 @var{cpu_type}, but do not set the instruction set or register set that the
13857 option @option{-mcpu=@var{cpu_type}} would.
13859 The same values for @option{-mcpu=@var{cpu_type}} can be used for
13860 @option{-mtune=@var{cpu_type}}, but the only useful values are those
13861 that select a particular cpu implementation.  Those are @samp{cypress},
13862 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
13863 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
13864 @samp{ultrasparc3}, and @samp{niagara}.
13866 @item -mv8plus
13867 @itemx -mno-v8plus
13868 @opindex mv8plus
13869 @opindex mno-v8plus
13870 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
13871 difference from the V8 ABI is that the global and out registers are
13872 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
13873 mode for all SPARC-V9 processors.
13875 @item -mvis
13876 @itemx -mno-vis
13877 @opindex mvis
13878 @opindex mno-vis
13879 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
13880 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
13881 @end table
13883 These @samp{-m} options are supported in addition to the above
13884 on SPARC-V9 processors in 64-bit environments:
13886 @table @gcctabopt
13887 @item -mlittle-endian
13888 @opindex mlittle-endian
13889 Generate code for a processor running in little-endian mode.  It is only
13890 available for a few configurations and most notably not on Solaris and Linux.
13892 @item -m32
13893 @itemx -m64
13894 @opindex m32
13895 @opindex m64
13896 Generate code for a 32-bit or 64-bit environment.
13897 The 32-bit environment sets int, long and pointer to 32 bits.
13898 The 64-bit environment sets int to 32 bits and long and pointer
13899 to 64 bits.
13901 @item -mcmodel=medlow
13902 @opindex mcmodel=medlow
13903 Generate code for the Medium/Low code model: 64-bit addresses, programs
13904 must be linked in the low 32 bits of memory.  Programs can be statically
13905 or dynamically linked.
13907 @item -mcmodel=medmid
13908 @opindex mcmodel=medmid
13909 Generate code for the Medium/Middle code model: 64-bit addresses, programs
13910 must be linked in the low 44 bits of memory, the text and data segments must
13911 be less than 2GB in size and the data segment must be located within 2GB of
13912 the text segment.
13914 @item -mcmodel=medany
13915 @opindex mcmodel=medany
13916 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
13917 may be linked anywhere in memory, the text and data segments must be less
13918 than 2GB in size and the data segment must be located within 2GB of the
13919 text segment.
13921 @item -mcmodel=embmedany
13922 @opindex mcmodel=embmedany
13923 Generate code for the Medium/Anywhere code model for embedded systems:
13924 64-bit addresses, the text and data segments must be less than 2GB in
13925 size, both starting anywhere in memory (determined at link time).  The
13926 global register %g4 points to the base of the data segment.  Programs
13927 are statically linked and PIC is not supported.
13929 @item -mstack-bias
13930 @itemx -mno-stack-bias
13931 @opindex mstack-bias
13932 @opindex mno-stack-bias
13933 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
13934 frame pointer if present, are offset by @minus{}2047 which must be added back
13935 when making stack frame references.  This is the default in 64-bit mode.
13936 Otherwise, assume no such offset is present.
13937 @end table
13939 These switches are supported in addition to the above on Solaris:
13941 @table @gcctabopt
13942 @item -threads
13943 @opindex threads
13944 Add support for multithreading using the Solaris threads library.  This
13945 option sets flags for both the preprocessor and linker.  This option does
13946 not affect the thread safety of object code produced by the compiler or
13947 that of libraries supplied with it.
13949 @item -pthreads
13950 @opindex pthreads
13951 Add support for multithreading using the POSIX threads library.  This
13952 option sets flags for both the preprocessor and linker.  This option does
13953 not affect the thread safety of object code produced  by the compiler or
13954 that of libraries supplied with it.
13956 @item -pthread
13957 @opindex pthread
13958 This is a synonym for @option{-pthreads}.
13959 @end table
13961 @node SPU Options
13962 @subsection SPU Options
13963 @cindex SPU options
13965 These @samp{-m} options are supported on the SPU:
13967 @table @gcctabopt
13968 @item -mwarn-reloc
13969 @itemx -merror-reloc
13970 @opindex mwarn-reloc
13971 @opindex merror-reloc
13973 The loader for SPU does not handle dynamic relocations.  By default, GCC
13974 will give an error when it generates code that requires a dynamic
13975 relocation.  @option{-mno-error-reloc} disables the error,
13976 @option{-mwarn-reloc} will generate a warning instead.
13978 @item -msafe-dma
13979 @itemx -munsafe-dma
13980 @opindex msafe-dma
13981 @opindex munsafe-dma
13983 Instructions which initiate or test completion of DMA must not be
13984 reordered with respect to loads and stores of the memory which is being
13985 accessed.  Users typically address this problem using the volatile
13986 keyword, but that can lead to inefficient code in places where the
13987 memory is known to not change.  Rather than mark the memory as volatile
13988 we treat the DMA instructions as potentially effecting all memory.  With
13989 @option{-munsafe-dma} users must use the volatile keyword to protect
13990 memory accesses.
13992 @item -mbranch-hints
13993 @opindex mbranch-hints
13995 By default, GCC will generate a branch hint instruction to avoid
13996 pipeline stalls for always taken or probably taken branches.  A hint
13997 will not be generated closer than 8 instructions away from its branch.
13998 There is little reason to disable them, except for debugging purposes,
13999 or to make an object a little bit smaller.
14001 @item -msmall-mem
14002 @itemx -mlarge-mem
14003 @opindex msmall-mem
14004 @opindex mlarge-mem
14006 By default, GCC generates code assuming that addresses are never larger
14007 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
14008 a full 32 bit address.
14010 @item -mstdmain
14011 @opindex mstdmain
14013 By default, GCC links against startup code that assumes the SPU-style
14014 main function interface (which has an unconventional parameter list).
14015 With @option{-mstdmain}, GCC will link your program against startup
14016 code that assumes a C99-style interface to @code{main}, including a
14017 local copy of @code{argv} strings.
14019 @item -mfixed-range=@var{register-range}
14020 @opindex mfixed-range
14021 Generate code treating the given register range as fixed registers.
14022 A fixed register is one that the register allocator can not use.  This is
14023 useful when compiling kernel code.  A register range is specified as
14024 two registers separated by a dash.  Multiple register ranges can be
14025 specified separated by a comma.
14027 @end table
14029 @node System V Options
14030 @subsection Options for System V
14032 These additional options are available on System V Release 4 for
14033 compatibility with other compilers on those systems:
14035 @table @gcctabopt
14036 @item -G
14037 @opindex G
14038 Create a shared object.
14039 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
14041 @item -Qy
14042 @opindex Qy
14043 Identify the versions of each tool used by the compiler, in a
14044 @code{.ident} assembler directive in the output.
14046 @item -Qn
14047 @opindex Qn
14048 Refrain from adding @code{.ident} directives to the output file (this is
14049 the default).
14051 @item -YP,@var{dirs}
14052 @opindex YP
14053 Search the directories @var{dirs}, and no others, for libraries
14054 specified with @option{-l}.
14056 @item -Ym,@var{dir}
14057 @opindex Ym
14058 Look in the directory @var{dir} to find the M4 preprocessor.
14059 The assembler uses this option.
14060 @c This is supposed to go with a -Yd for predefined M4 macro files, but
14061 @c the generic assembler that comes with Solaris takes just -Ym.
14062 @end table
14064 @node TMS320C3x/C4x Options
14065 @subsection TMS320C3x/C4x Options
14066 @cindex TMS320C3x/C4x Options
14068 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
14070 @table @gcctabopt
14072 @item -mcpu=@var{cpu_type}
14073 @opindex mcpu
14074 Set the instruction set, register set, and instruction scheduling
14075 parameters for machine type @var{cpu_type}.  Supported values for
14076 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
14077 @samp{c44}.  The default is @samp{c40} to generate code for the
14078 TMS320C40.
14080 @item -mbig-memory
14081 @itemx -mbig
14082 @itemx -msmall-memory
14083 @itemx -msmall
14084 @opindex mbig-memory
14085 @opindex mbig
14086 @opindex msmall-memory
14087 @opindex msmall
14088 Generates code for the big or small memory model.  The small memory
14089 model assumed that all data fits into one 64K word page.  At run-time
14090 the data page (DP) register must be set to point to the 64K page
14091 containing the .bss and .data program sections.  The big memory model is
14092 the default and requires reloading of the DP register for every direct
14093 memory access.
14095 @item -mbk
14096 @itemx -mno-bk
14097 @opindex mbk
14098 @opindex mno-bk
14099 Allow (disallow) allocation of general integer operands into the block
14100 count register BK@.
14102 @item -mdb
14103 @itemx -mno-db
14104 @opindex mdb
14105 @opindex mno-db
14106 Enable (disable) generation of code using decrement and branch,
14107 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
14108 on the safe side, this is disabled for the C3x, since the maximum
14109 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
14110 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
14111 that it can utilize the decrement and branch instruction, but will give
14112 up if there is more than one memory reference in the loop.  Thus a loop
14113 where the loop counter is decremented can generate slightly more
14114 efficient code, in cases where the RPTB instruction cannot be utilized.
14116 @item -mdp-isr-reload
14117 @itemx -mparanoid
14118 @opindex mdp-isr-reload
14119 @opindex mparanoid
14120 Force the DP register to be saved on entry to an interrupt service
14121 routine (ISR), reloaded to point to the data section, and restored on
14122 exit from the ISR@.  This should not be required unless someone has
14123 violated the small memory model by modifying the DP register, say within
14124 an object library.
14126 @item -mmpyi
14127 @itemx -mno-mpyi
14128 @opindex mmpyi
14129 @opindex mno-mpyi
14130 For the C3x use the 24-bit MPYI instruction for integer multiplies
14131 instead of a library call to guarantee 32-bit results.  Note that if one
14132 of the operands is a constant, then the multiplication will be performed
14133 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
14134 then squaring operations are performed inline instead of a library call.
14136 @item -mfast-fix
14137 @itemx -mno-fast-fix
14138 @opindex mfast-fix
14139 @opindex mno-fast-fix
14140 The C3x/C4x FIX instruction to convert a floating point value to an
14141 integer value chooses the nearest integer less than or equal to the
14142 floating point value rather than to the nearest integer.  Thus if the
14143 floating point number is negative, the result will be incorrectly
14144 truncated an additional code is necessary to detect and correct this
14145 case.  This option can be used to disable generation of the additional
14146 code required to correct the result.
14148 @item -mrptb
14149 @itemx -mno-rptb
14150 @opindex mrptb
14151 @opindex mno-rptb
14152 Enable (disable) generation of repeat block sequences using the RPTB
14153 instruction for zero overhead looping.  The RPTB construct is only used
14154 for innermost loops that do not call functions or jump across the loop
14155 boundaries.  There is no advantage having nested RPTB loops due to the
14156 overhead required to save and restore the RC, RS, and RE registers.
14157 This is enabled by default with @option{-O2}.
14159 @item -mrpts=@var{count}
14160 @itemx -mno-rpts
14161 @opindex mrpts
14162 @opindex mno-rpts
14163 Enable (disable) the use of the single instruction repeat instruction
14164 RPTS@.  If a repeat block contains a single instruction, and the loop
14165 count can be guaranteed to be less than the value @var{count}, GCC will
14166 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
14167 then a RPTS will be emitted even if the loop count cannot be determined
14168 at compile time.  Note that the repeated instruction following RPTS does
14169 not have to be reloaded from memory each iteration, thus freeing up the
14170 CPU buses for operands.  However, since interrupts are blocked by this
14171 instruction, it is disabled by default.
14173 @item -mloop-unsigned
14174 @itemx -mno-loop-unsigned
14175 @opindex mloop-unsigned
14176 @opindex mno-loop-unsigned
14177 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
14178 is @math{2^{31} + 1} since these instructions test if the iteration count is
14179 negative to terminate the loop.  If the iteration count is unsigned
14180 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
14181 exceeded.  This switch allows an unsigned iteration count.
14183 @item -mti
14184 @opindex mti
14185 Try to emit an assembler syntax that the TI assembler (asm30) is happy
14186 with.  This also enforces compatibility with the API employed by the TI
14187 C3x C compiler.  For example, long doubles are passed as structures
14188 rather than in floating point registers.
14190 @item -mregparm
14191 @itemx -mmemparm
14192 @opindex mregparm
14193 @opindex mmemparm
14194 Generate code that uses registers (stack) for passing arguments to functions.
14195 By default, arguments are passed in registers where possible rather
14196 than by pushing arguments on to the stack.
14198 @item -mparallel-insns
14199 @itemx -mno-parallel-insns
14200 @opindex mparallel-insns
14201 @opindex mno-parallel-insns
14202 Allow the generation of parallel instructions.  This is enabled by
14203 default with @option{-O2}.
14205 @item -mparallel-mpy
14206 @itemx -mno-parallel-mpy
14207 @opindex mparallel-mpy
14208 @opindex mno-parallel-mpy
14209 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
14210 provided @option{-mparallel-insns} is also specified.  These instructions have
14211 tight register constraints which can pessimize the code generation
14212 of large functions.
14214 @end table
14216 @node V850 Options
14217 @subsection V850 Options
14218 @cindex V850 Options
14220 These @samp{-m} options are defined for V850 implementations:
14222 @table @gcctabopt
14223 @item -mlong-calls
14224 @itemx -mno-long-calls
14225 @opindex mlong-calls
14226 @opindex mno-long-calls
14227 Treat all calls as being far away (near).  If calls are assumed to be
14228 far away, the compiler will always load the functions address up into a
14229 register, and call indirect through the pointer.
14231 @item -mno-ep
14232 @itemx -mep
14233 @opindex mno-ep
14234 @opindex mep
14235 Do not optimize (do optimize) basic blocks that use the same index
14236 pointer 4 or more times to copy pointer into the @code{ep} register, and
14237 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
14238 option is on by default if you optimize.
14240 @item -mno-prolog-function
14241 @itemx -mprolog-function
14242 @opindex mno-prolog-function
14243 @opindex mprolog-function
14244 Do not use (do use) external functions to save and restore registers
14245 at the prologue and epilogue of a function.  The external functions
14246 are slower, but use less code space if more than one function saves
14247 the same number of registers.  The @option{-mprolog-function} option
14248 is on by default if you optimize.
14250 @item -mspace
14251 @opindex mspace
14252 Try to make the code as small as possible.  At present, this just turns
14253 on the @option{-mep} and @option{-mprolog-function} options.
14255 @item -mtda=@var{n}
14256 @opindex mtda
14257 Put static or global variables whose size is @var{n} bytes or less into
14258 the tiny data area that register @code{ep} points to.  The tiny data
14259 area can hold up to 256 bytes in total (128 bytes for byte references).
14261 @item -msda=@var{n}
14262 @opindex msda
14263 Put static or global variables whose size is @var{n} bytes or less into
14264 the small data area that register @code{gp} points to.  The small data
14265 area can hold up to 64 kilobytes.
14267 @item -mzda=@var{n}
14268 @opindex mzda
14269 Put static or global variables whose size is @var{n} bytes or less into
14270 the first 32 kilobytes of memory.
14272 @item -mv850
14273 @opindex mv850
14274 Specify that the target processor is the V850.
14276 @item -mbig-switch
14277 @opindex mbig-switch
14278 Generate code suitable for big switch tables.  Use this option only if
14279 the assembler/linker complain about out of range branches within a switch
14280 table.
14282 @item -mapp-regs
14283 @opindex mapp-regs
14284 This option will cause r2 and r5 to be used in the code generated by
14285 the compiler.  This setting is the default.
14287 @item -mno-app-regs
14288 @opindex mno-app-regs
14289 This option will cause r2 and r5 to be treated as fixed registers.
14291 @item -mv850e1
14292 @opindex mv850e1
14293 Specify that the target processor is the V850E1.  The preprocessor
14294 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
14295 this option is used.
14297 @item -mv850e
14298 @opindex mv850e
14299 Specify that the target processor is the V850E@.  The preprocessor
14300 constant @samp{__v850e__} will be defined if this option is used.
14302 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
14303 are defined then a default target processor will be chosen and the
14304 relevant @samp{__v850*__} preprocessor constant will be defined.
14306 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
14307 defined, regardless of which processor variant is the target.
14309 @item -mdisable-callt
14310 @opindex mdisable-callt
14311 This option will suppress generation of the CALLT instruction for the
14312 v850e and v850e1 flavors of the v850 architecture.  The default is
14313 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
14315 @end table
14317 @node VAX Options
14318 @subsection VAX Options
14319 @cindex VAX options
14321 These @samp{-m} options are defined for the VAX:
14323 @table @gcctabopt
14324 @item -munix
14325 @opindex munix
14326 Do not output certain jump instructions (@code{aobleq} and so on)
14327 that the Unix assembler for the VAX cannot handle across long
14328 ranges.
14330 @item -mgnu
14331 @opindex mgnu
14332 Do output those jump instructions, on the assumption that you
14333 will assemble with the GNU assembler.
14335 @item -mg
14336 @opindex mg
14337 Output code for g-format floating point numbers instead of d-format.
14338 @end table
14340 @node VxWorks Options
14341 @subsection VxWorks Options
14342 @cindex VxWorks Options
14344 The options in this section are defined for all VxWorks targets.
14345 Options specific to the target hardware are listed with the other
14346 options for that target.
14348 @table @gcctabopt
14349 @item -mrtp
14350 @opindex mrtp
14351 GCC can generate code for both VxWorks kernels and real time processes
14352 (RTPs).  This option switches from the former to the latter.  It also
14353 defines the preprocessor macro @code{__RTP__}.
14355 @item -non-static
14356 @opindex non-static
14357 Link an RTP executable against shared libraries rather than static
14358 libraries.  The options @option{-static} and @option{-shared} can
14359 also be used for RTPs (@pxref{Link Options}); @option{-static}
14360 is the default.
14362 @item -Bstatic
14363 @itemx -Bdynamic
14364 @opindex Bstatic
14365 @opindex Bdynamic
14366 These options are passed down to the linker.  They are defined for
14367 compatibility with Diab.
14369 @item -Xbind-lazy
14370 @opindex Xbind-lazy
14371 Enable lazy binding of function calls.  This option is equivalent to
14372 @option{-Wl,-z,now} and is defined for compatibility with Diab.
14374 @item -Xbind-now
14375 @opindex Xbind-now
14376 Disable lazy binding of function calls.  This option is the default and
14377 is defined for compatibility with Diab.
14378 @end table
14380 @node x86-64 Options
14381 @subsection x86-64 Options
14382 @cindex x86-64 options
14384 These are listed under @xref{i386 and x86-64 Options}.
14386 @node Xstormy16 Options
14387 @subsection Xstormy16 Options
14388 @cindex Xstormy16 Options
14390 These options are defined for Xstormy16:
14392 @table @gcctabopt
14393 @item -msim
14394 @opindex msim
14395 Choose startup files and linker script suitable for the simulator.
14396 @end table
14398 @node Xtensa Options
14399 @subsection Xtensa Options
14400 @cindex Xtensa Options
14402 These options are supported for Xtensa targets:
14404 @table @gcctabopt
14405 @item -mconst16
14406 @itemx -mno-const16
14407 @opindex mconst16
14408 @opindex mno-const16
14409 Enable or disable use of @code{CONST16} instructions for loading
14410 constant values.  The @code{CONST16} instruction is currently not a
14411 standard option from Tensilica.  When enabled, @code{CONST16}
14412 instructions are always used in place of the standard @code{L32R}
14413 instructions.  The use of @code{CONST16} is enabled by default only if
14414 the @code{L32R} instruction is not available.
14416 @item -mfused-madd
14417 @itemx -mno-fused-madd
14418 @opindex mfused-madd
14419 @opindex mno-fused-madd
14420 Enable or disable use of fused multiply/add and multiply/subtract
14421 instructions in the floating-point option.  This has no effect if the
14422 floating-point option is not also enabled.  Disabling fused multiply/add
14423 and multiply/subtract instructions forces the compiler to use separate
14424 instructions for the multiply and add/subtract operations.  This may be
14425 desirable in some cases where strict IEEE 754-compliant results are
14426 required: the fused multiply add/subtract instructions do not round the
14427 intermediate result, thereby producing results with @emph{more} bits of
14428 precision than specified by the IEEE standard.  Disabling fused multiply
14429 add/subtract instructions also ensures that the program output is not
14430 sensitive to the compiler's ability to combine multiply and add/subtract
14431 operations.
14433 @item -mtext-section-literals
14434 @itemx -mno-text-section-literals
14435 @opindex mtext-section-literals
14436 @opindex mno-text-section-literals
14437 Control the treatment of literal pools.  The default is
14438 @option{-mno-text-section-literals}, which places literals in a separate
14439 section in the output file.  This allows the literal pool to be placed
14440 in a data RAM/ROM, and it also allows the linker to combine literal
14441 pools from separate object files to remove redundant literals and
14442 improve code size.  With @option{-mtext-section-literals}, the literals
14443 are interspersed in the text section in order to keep them as close as
14444 possible to their references.  This may be necessary for large assembly
14445 files.
14447 @item -mtarget-align
14448 @itemx -mno-target-align
14449 @opindex mtarget-align
14450 @opindex mno-target-align
14451 When this option is enabled, GCC instructs the assembler to
14452 automatically align instructions to reduce branch penalties at the
14453 expense of some code density.  The assembler attempts to widen density
14454 instructions to align branch targets and the instructions following call
14455 instructions.  If there are not enough preceding safe density
14456 instructions to align a target, no widening will be performed.  The
14457 default is @option{-mtarget-align}.  These options do not affect the
14458 treatment of auto-aligned instructions like @code{LOOP}, which the
14459 assembler will always align, either by widening density instructions or
14460 by inserting no-op instructions.
14462 @item -mlongcalls
14463 @itemx -mno-longcalls
14464 @opindex mlongcalls
14465 @opindex mno-longcalls
14466 When this option is enabled, GCC instructs the assembler to translate
14467 direct calls to indirect calls unless it can determine that the target
14468 of a direct call is in the range allowed by the call instruction.  This
14469 translation typically occurs for calls to functions in other source
14470 files.  Specifically, the assembler translates a direct @code{CALL}
14471 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
14472 The default is @option{-mno-longcalls}.  This option should be used in
14473 programs where the call target can potentially be out of range.  This
14474 option is implemented in the assembler, not the compiler, so the
14475 assembly code generated by GCC will still show direct call
14476 instructions---look at the disassembled object code to see the actual
14477 instructions.  Note that the assembler will use an indirect call for
14478 every cross-file call, not just those that really will be out of range.
14479 @end table
14481 @node zSeries Options
14482 @subsection zSeries Options
14483 @cindex zSeries options
14485 These are listed under @xref{S/390 and zSeries Options}.
14487 @node Code Gen Options
14488 @section Options for Code Generation Conventions
14489 @cindex code generation conventions
14490 @cindex options, code generation
14491 @cindex run-time options
14493 These machine-independent options control the interface conventions
14494 used in code generation.
14496 Most of them have both positive and negative forms; the negative form
14497 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
14498 one of the forms is listed---the one which is not the default.  You
14499 can figure out the other form by either removing @samp{no-} or adding
14502 @table @gcctabopt
14503 @item -fbounds-check
14504 @opindex fbounds-check
14505 For front-ends that support it, generate additional code to check that
14506 indices used to access arrays are within the declared range.  This is
14507 currently only supported by the Java and Fortran front-ends, where
14508 this option defaults to true and false respectively.
14510 @item -ftrapv
14511 @opindex ftrapv
14512 This option generates traps for signed overflow on addition, subtraction,
14513 multiplication operations.
14515 @item -fwrapv
14516 @opindex fwrapv
14517 This option instructs the compiler to assume that signed arithmetic
14518 overflow of addition, subtraction and multiplication wraps around
14519 using twos-complement representation.  This flag enables some optimizations
14520 and disables others.  This option is enabled by default for the Java
14521 front-end, as required by the Java language specification.
14523 @item -fexceptions
14524 @opindex fexceptions
14525 Enable exception handling.  Generates extra code needed to propagate
14526 exceptions.  For some targets, this implies GCC will generate frame
14527 unwind information for all functions, which can produce significant data
14528 size overhead, although it does not affect execution.  If you do not
14529 specify this option, GCC will enable it by default for languages like
14530 C++ which normally require exception handling, and disable it for
14531 languages like C that do not normally require it.  However, you may need
14532 to enable this option when compiling C code that needs to interoperate
14533 properly with exception handlers written in C++.  You may also wish to
14534 disable this option if you are compiling older C++ programs that don't
14535 use exception handling.
14537 @item -fnon-call-exceptions
14538 @opindex fnon-call-exceptions
14539 Generate code that allows trapping instructions to throw exceptions.
14540 Note that this requires platform-specific runtime support that does
14541 not exist everywhere.  Moreover, it only allows @emph{trapping}
14542 instructions to throw exceptions, i.e.@: memory references or floating
14543 point instructions.  It does not allow exceptions to be thrown from
14544 arbitrary signal handlers such as @code{SIGALRM}.
14546 @item -funwind-tables
14547 @opindex funwind-tables
14548 Similar to @option{-fexceptions}, except that it will just generate any needed
14549 static data, but will not affect the generated code in any other way.
14550 You will normally not enable this option; instead, a language processor
14551 that needs this handling would enable it on your behalf.
14553 @item -fasynchronous-unwind-tables
14554 @opindex fasynchronous-unwind-tables
14555 Generate unwind table in dwarf2 format, if supported by target machine.  The
14556 table is exact at each instruction boundary, so it can be used for stack
14557 unwinding from asynchronous events (such as debugger or garbage collector).
14559 @item -fpcc-struct-return
14560 @opindex fpcc-struct-return
14561 Return ``short'' @code{struct} and @code{union} values in memory like
14562 longer ones, rather than in registers.  This convention is less
14563 efficient, but it has the advantage of allowing intercallability between
14564 GCC-compiled files and files compiled with other compilers, particularly
14565 the Portable C Compiler (pcc).
14567 The precise convention for returning structures in memory depends
14568 on the target configuration macros.
14570 Short structures and unions are those whose size and alignment match
14571 that of some integer type.
14573 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
14574 switch is not binary compatible with code compiled with the
14575 @option{-freg-struct-return} switch.
14576 Use it to conform to a non-default application binary interface.
14578 @item -freg-struct-return
14579 @opindex freg-struct-return
14580 Return @code{struct} and @code{union} values in registers when possible.
14581 This is more efficient for small structures than
14582 @option{-fpcc-struct-return}.
14584 If you specify neither @option{-fpcc-struct-return} nor
14585 @option{-freg-struct-return}, GCC defaults to whichever convention is
14586 standard for the target.  If there is no standard convention, GCC
14587 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
14588 the principal compiler.  In those cases, we can choose the standard, and
14589 we chose the more efficient register return alternative.
14591 @strong{Warning:} code compiled with the @option{-freg-struct-return}
14592 switch is not binary compatible with code compiled with the
14593 @option{-fpcc-struct-return} switch.
14594 Use it to conform to a non-default application binary interface.
14596 @item -fshort-enums
14597 @opindex fshort-enums
14598 Allocate to an @code{enum} type only as many bytes as it needs for the
14599 declared range of possible values.  Specifically, the @code{enum} type
14600 will be equivalent to the smallest integer type which has enough room.
14602 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
14603 code that is not binary compatible with code generated without that switch.
14604 Use it to conform to a non-default application binary interface.
14606 @item -fshort-double
14607 @opindex fshort-double
14608 Use the same size for @code{double} as for @code{float}.
14610 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
14611 code that is not binary compatible with code generated without that switch.
14612 Use it to conform to a non-default application binary interface.
14614 @item -fshort-wchar
14615 @opindex fshort-wchar
14616 Override the underlying type for @samp{wchar_t} to be @samp{short
14617 unsigned int} instead of the default for the target.  This option is
14618 useful for building programs to run under WINE@.
14620 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
14621 code that is not binary compatible with code generated without that switch.
14622 Use it to conform to a non-default application binary interface.
14624 @item -fno-common
14625 @opindex fno-common
14626 In C, allocate even uninitialized global variables in the data section of the
14627 object file, rather than generating them as common blocks.  This has the
14628 effect that if the same variable is declared (without @code{extern}) in
14629 two different compilations, you will get an error when you link them.
14630 The only reason this might be useful is if you wish to verify that the
14631 program will work on other systems which always work this way.
14633 @item -fno-ident
14634 @opindex fno-ident
14635 Ignore the @samp{#ident} directive.
14637 @item -finhibit-size-directive
14638 @opindex finhibit-size-directive
14639 Don't output a @code{.size} assembler directive, or anything else that
14640 would cause trouble if the function is split in the middle, and the
14641 two halves are placed at locations far apart in memory.  This option is
14642 used when compiling @file{crtstuff.c}; you should not need to use it
14643 for anything else.
14645 @item -fverbose-asm
14646 @opindex fverbose-asm
14647 Put extra commentary information in the generated assembly code to
14648 make it more readable.  This option is generally only of use to those
14649 who actually need to read the generated assembly code (perhaps while
14650 debugging the compiler itself).
14652 @option{-fno-verbose-asm}, the default, causes the
14653 extra information to be omitted and is useful when comparing two assembler
14654 files.
14656 @item -frecord-gcc-switches
14657 @opindex frecord-gcc-switches
14658 This switch causes the command line that was used to invoke the
14659 compiler to be recorded into the object file that is being created.
14660 This switch is only implemented on some targets and the exact format
14661 of the recording is target and binary file format dependent, but it
14662 usually takes the form of a section containing ASCII text.  This
14663 switch is related to the @option{-fverbose-asm} switch, but that
14664 switch only records information in the assembler output file as
14665 comments, so it never reaches the object file.
14667 @item -fpic
14668 @opindex fpic
14669 @cindex global offset table
14670 @cindex PIC
14671 Generate position-independent code (PIC) suitable for use in a shared
14672 library, if supported for the target machine.  Such code accesses all
14673 constant addresses through a global offset table (GOT)@.  The dynamic
14674 loader resolves the GOT entries when the program starts (the dynamic
14675 loader is not part of GCC; it is part of the operating system).  If
14676 the GOT size for the linked executable exceeds a machine-specific
14677 maximum size, you get an error message from the linker indicating that
14678 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
14679 instead.  (These maximums are 8k on the SPARC and 32k
14680 on the m68k and RS/6000.  The 386 has no such limit.)
14682 Position-independent code requires special support, and therefore works
14683 only on certain machines.  For the 386, GCC supports PIC for System V
14684 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
14685 position-independent.
14687 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14688 are defined to 1.
14690 @item -fPIC
14691 @opindex fPIC
14692 If supported for the target machine, emit position-independent code,
14693 suitable for dynamic linking and avoiding any limit on the size of the
14694 global offset table.  This option makes a difference on the m68k,
14695 PowerPC and SPARC@.
14697 Position-independent code requires special support, and therefore works
14698 only on certain machines.
14700 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
14701 are defined to 2.
14703 @item -fpie
14704 @itemx -fPIE
14705 @opindex fpie
14706 @opindex fPIE
14707 These options are similar to @option{-fpic} and @option{-fPIC}, but
14708 generated position independent code can be only linked into executables.
14709 Usually these options are used when @option{-pie} GCC option will be
14710 used during linking.
14712 @option{-fpie} and @option{-fPIE} both define the macros
14713 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
14714 for @option{-fpie} and 2 for @option{-fPIE}.
14716 @item -fno-jump-tables
14717 @opindex fno-jump-tables
14718 Do not use jump tables for switch statements even where it would be
14719 more efficient than other code generation strategies.  This option is
14720 of use in conjunction with @option{-fpic} or @option{-fPIC} for
14721 building code which forms part of a dynamic linker and cannot
14722 reference the address of a jump table.  On some targets, jump tables
14723 do not require a GOT and this option is not needed.
14725 @item -ffixed-@var{reg}
14726 @opindex ffixed
14727 Treat the register named @var{reg} as a fixed register; generated code
14728 should never refer to it (except perhaps as a stack pointer, frame
14729 pointer or in some other fixed role).
14731 @var{reg} must be the name of a register.  The register names accepted
14732 are machine-specific and are defined in the @code{REGISTER_NAMES}
14733 macro in the machine description macro file.
14735 This flag does not have a negative form, because it specifies a
14736 three-way choice.
14738 @item -fcall-used-@var{reg}
14739 @opindex fcall-used
14740 Treat the register named @var{reg} as an allocable register that is
14741 clobbered by function calls.  It may be allocated for temporaries or
14742 variables that do not live across a call.  Functions compiled this way
14743 will not save and restore the register @var{reg}.
14745 It is an error to used this flag with the frame pointer or stack pointer.
14746 Use of this flag for other registers that have fixed pervasive roles in
14747 the machine's execution model will produce disastrous results.
14749 This flag does not have a negative form, because it specifies a
14750 three-way choice.
14752 @item -fcall-saved-@var{reg}
14753 @opindex fcall-saved
14754 Treat the register named @var{reg} as an allocable register saved by
14755 functions.  It may be allocated even for temporaries or variables that
14756 live across a call.  Functions compiled this way will save and restore
14757 the register @var{reg} if they use it.
14759 It is an error to used this flag with the frame pointer or stack pointer.
14760 Use of this flag for other registers that have fixed pervasive roles in
14761 the machine's execution model will produce disastrous results.
14763 A different sort of disaster will result from the use of this flag for
14764 a register in which function values may be returned.
14766 This flag does not have a negative form, because it specifies a
14767 three-way choice.
14769 @item -fpack-struct[=@var{n}]
14770 @opindex fpack-struct
14771 Without a value specified, pack all structure members together without
14772 holes.  When a value is specified (which must be a small power of two), pack
14773 structure members according to this value, representing the maximum
14774 alignment (that is, objects with default alignment requirements larger than
14775 this will be output potentially unaligned at the next fitting location.
14777 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
14778 code that is not binary compatible with code generated without that switch.
14779 Additionally, it makes the code suboptimal.
14780 Use it to conform to a non-default application binary interface.
14782 @item -finstrument-functions
14783 @opindex finstrument-functions
14784 Generate instrumentation calls for entry and exit to functions.  Just
14785 after function entry and just before function exit, the following
14786 profiling functions will be called with the address of the current
14787 function and its call site.  (On some platforms,
14788 @code{__builtin_return_address} does not work beyond the current
14789 function, so the call site information may not be available to the
14790 profiling functions otherwise.)
14792 @smallexample
14793 void __cyg_profile_func_enter (void *this_fn,
14794                                void *call_site);
14795 void __cyg_profile_func_exit  (void *this_fn,
14796                                void *call_site);
14797 @end smallexample
14799 The first argument is the address of the start of the current function,
14800 which may be looked up exactly in the symbol table.
14802 This instrumentation is also done for functions expanded inline in other
14803 functions.  The profiling calls will indicate where, conceptually, the
14804 inline function is entered and exited.  This means that addressable
14805 versions of such functions must be available.  If all your uses of a
14806 function are expanded inline, this may mean an additional expansion of
14807 code size.  If you use @samp{extern inline} in your C code, an
14808 addressable version of such functions must be provided.  (This is
14809 normally the case anyways, but if you get lucky and the optimizer always
14810 expands the functions inline, you might have gotten away without
14811 providing static copies.)
14813 A function may be given the attribute @code{no_instrument_function}, in
14814 which case this instrumentation will not be done.  This can be used, for
14815 example, for the profiling functions listed above, high-priority
14816 interrupt routines, and any functions from which the profiling functions
14817 cannot safely be called (perhaps signal handlers, if the profiling
14818 routines generate output or allocate memory).
14820 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
14821 @opindex finstrument-functions-exclude-file-list
14823 Set the list of functions that are excluded from instrumentation (see
14824 the description of @code{-finstrument-functions}).  If the file that
14825 contains a function definition matches with one of @var{file}, then
14826 that function is not instrumented.  The match is done on substrings:
14827 if the @var{file} parameter is a substring of the file name, it is
14828 considered to be a match.
14830 For example,
14831 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
14832 will exclude any inline function defined in files whose pathnames
14833 contain @code{/bits/stl} or @code{include/sys}.
14835 If, for some reason, you want to include letter @code{','} in one of
14836 @var{sym}, write @code{'\,'}. For example,
14837 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
14838 (note the single quote surrounding the option).
14840 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
14841 @opindex finstrument-functions-exclude-function-list
14843 This is similar to @code{-finstrument-functions-exclude-file-list},
14844 but this option sets the list of function names to be excluded from
14845 instrumentation.  The function name to be matched is its user-visible
14846 name, such as @code{vector<int> blah(const vector<int> &)}, not the
14847 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
14848 match is done on substrings: if the @var{sym} parameter is a substring
14849 of the function name, it is considered to be a match.
14851 @item -fstack-check
14852 @opindex fstack-check
14853 Generate code to verify that you do not go beyond the boundary of the
14854 stack.  You should specify this flag if you are running in an
14855 environment with multiple threads, but only rarely need to specify it in
14856 a single-threaded environment since stack overflow is automatically
14857 detected on nearly all systems if there is only one stack.
14859 Note that this switch does not actually cause checking to be done; the
14860 operating system must do that.  The switch causes generation of code
14861 to ensure that the operating system sees the stack being extended.
14863 @item -fstack-limit-register=@var{reg}
14864 @itemx -fstack-limit-symbol=@var{sym}
14865 @itemx -fno-stack-limit
14866 @opindex fstack-limit-register
14867 @opindex fstack-limit-symbol
14868 @opindex fno-stack-limit
14869 Generate code to ensure that the stack does not grow beyond a certain value,
14870 either the value of a register or the address of a symbol.  If the stack
14871 would grow beyond the value, a signal is raised.  For most targets,
14872 the signal is raised before the stack overruns the boundary, so
14873 it is possible to catch the signal without taking special precautions.
14875 For instance, if the stack starts at absolute address @samp{0x80000000}
14876 and grows downwards, you can use the flags
14877 @option{-fstack-limit-symbol=__stack_limit} and
14878 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
14879 of 128KB@.  Note that this may only work with the GNU linker.
14881 @cindex aliasing of parameters
14882 @cindex parameters, aliased
14883 @item -fargument-alias
14884 @itemx -fargument-noalias
14885 @itemx -fargument-noalias-global
14886 @itemx -fargument-noalias-anything
14887 @opindex fargument-alias
14888 @opindex fargument-noalias
14889 @opindex fargument-noalias-global
14890 @opindex fargument-noalias-anything
14891 Specify the possible relationships among parameters and between
14892 parameters and global data.
14894 @option{-fargument-alias} specifies that arguments (parameters) may
14895 alias each other and may alias global storage.@*
14896 @option{-fargument-noalias} specifies that arguments do not alias
14897 each other, but may alias global storage.@*
14898 @option{-fargument-noalias-global} specifies that arguments do not
14899 alias each other and do not alias global storage.
14900 @option{-fargument-noalias-anything} specifies that arguments do not
14901 alias any other storage.
14903 Each language will automatically use whatever option is required by
14904 the language standard.  You should not need to use these options yourself.
14906 @item -fleading-underscore
14907 @opindex fleading-underscore
14908 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
14909 change the way C symbols are represented in the object file.  One use
14910 is to help link with legacy assembly code.
14912 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
14913 generate code that is not binary compatible with code generated without that
14914 switch.  Use it to conform to a non-default application binary interface.
14915 Not all targets provide complete support for this switch.
14917 @item -ftls-model=@var{model}
14918 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
14919 The @var{model} argument should be one of @code{global-dynamic},
14920 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
14922 The default without @option{-fpic} is @code{initial-exec}; with
14923 @option{-fpic} the default is @code{global-dynamic}.
14925 @item -fvisibility=@var{default|internal|hidden|protected}
14926 @opindex fvisibility
14927 Set the default ELF image symbol visibility to the specified option---all
14928 symbols will be marked with this unless overridden within the code.
14929 Using this feature can very substantially improve linking and
14930 load times of shared object libraries, produce more optimized
14931 code, provide near-perfect API export and prevent symbol clashes.
14932 It is @strong{strongly} recommended that you use this in any shared objects
14933 you distribute.
14935 Despite the nomenclature, @code{default} always means public ie;
14936 available to be linked against from outside the shared object.
14937 @code{protected} and @code{internal} are pretty useless in real-world
14938 usage so the only other commonly used option will be @code{hidden}.
14939 The default if @option{-fvisibility} isn't specified is
14940 @code{default}, i.e., make every
14941 symbol public---this causes the same behavior as previous versions of
14942 GCC@.
14944 A good explanation of the benefits offered by ensuring ELF
14945 symbols have the correct visibility is given by ``How To Write
14946 Shared Libraries'' by Ulrich Drepper (which can be found at
14947 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
14948 solution made possible by this option to marking things hidden when
14949 the default is public is to make the default hidden and mark things
14950 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
14951 and @code{__attribute__ ((visibility("default")))} instead of
14952 @code{__declspec(dllexport)} you get almost identical semantics with
14953 identical syntax.  This is a great boon to those working with
14954 cross-platform projects.
14956 For those adding visibility support to existing code, you may find
14957 @samp{#pragma GCC visibility} of use.  This works by you enclosing
14958 the declarations you wish to set visibility for with (for example)
14959 @samp{#pragma GCC visibility push(hidden)} and
14960 @samp{#pragma GCC visibility pop}.
14961 Bear in mind that symbol visibility should be viewed @strong{as
14962 part of the API interface contract} and thus all new code should
14963 always specify visibility when it is not the default ie; declarations
14964 only for use within the local DSO should @strong{always} be marked explicitly
14965 as hidden as so to avoid PLT indirection overheads---making this
14966 abundantly clear also aids readability and self-documentation of the code.
14967 Note that due to ISO C++ specification requirements, operator new and
14968 operator delete must always be of default visibility.
14970 Be aware that headers from outside your project, in particular system
14971 headers and headers from any other library you use, may not be
14972 expecting to be compiled with visibility other than the default.  You
14973 may need to explicitly say @samp{#pragma GCC visibility push(default)}
14974 before including any such headers.
14976 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
14977 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
14978 no modifications.  However, this means that calls to @samp{extern}
14979 functions with no explicit visibility will use the PLT, so it is more
14980 effective to use @samp{__attribute ((visibility))} and/or
14981 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
14982 declarations should be treated as hidden.
14984 Note that @samp{-fvisibility} does affect C++ vague linkage
14985 entities. This means that, for instance, an exception class that will
14986 be thrown between DSOs must be explicitly marked with default
14987 visibility so that the @samp{type_info} nodes will be unified between
14988 the DSOs.
14990 An overview of these techniques, their benefits and how to use them
14991 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
14993 @end table
14995 @c man end
14997 @node Environment Variables
14998 @section Environment Variables Affecting GCC
14999 @cindex environment variables
15001 @c man begin ENVIRONMENT
15002 This section describes several environment variables that affect how GCC
15003 operates.  Some of them work by specifying directories or prefixes to use
15004 when searching for various kinds of files.  Some are used to specify other
15005 aspects of the compilation environment.
15007 Note that you can also specify places to search using options such as
15008 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
15009 take precedence over places specified using environment variables, which
15010 in turn take precedence over those specified by the configuration of GCC@.
15011 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
15012 GNU Compiler Collection (GCC) Internals}.
15014 @table @env
15015 @item LANG
15016 @itemx LC_CTYPE
15017 @c @itemx LC_COLLATE
15018 @itemx LC_MESSAGES
15019 @c @itemx LC_MONETARY
15020 @c @itemx LC_NUMERIC
15021 @c @itemx LC_TIME
15022 @itemx LC_ALL
15023 @findex LANG
15024 @findex LC_CTYPE
15025 @c @findex LC_COLLATE
15026 @findex LC_MESSAGES
15027 @c @findex LC_MONETARY
15028 @c @findex LC_NUMERIC
15029 @c @findex LC_TIME
15030 @findex LC_ALL
15031 @cindex locale
15032 These environment variables control the way that GCC uses
15033 localization information that allow GCC to work with different
15034 national conventions.  GCC inspects the locale categories
15035 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
15036 so.  These locale categories can be set to any value supported by your
15037 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
15038 Kingdom encoded in UTF-8.
15040 The @env{LC_CTYPE} environment variable specifies character
15041 classification.  GCC uses it to determine the character boundaries in
15042 a string; this is needed for some multibyte encodings that contain quote
15043 and escape characters that would otherwise be interpreted as a string
15044 end or escape.
15046 The @env{LC_MESSAGES} environment variable specifies the language to
15047 use in diagnostic messages.
15049 If the @env{LC_ALL} environment variable is set, it overrides the value
15050 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
15051 and @env{LC_MESSAGES} default to the value of the @env{LANG}
15052 environment variable.  If none of these variables are set, GCC
15053 defaults to traditional C English behavior.
15055 @item TMPDIR
15056 @findex TMPDIR
15057 If @env{TMPDIR} is set, it specifies the directory to use for temporary
15058 files.  GCC uses temporary files to hold the output of one stage of
15059 compilation which is to be used as input to the next stage: for example,
15060 the output of the preprocessor, which is the input to the compiler
15061 proper.
15063 @item GCC_EXEC_PREFIX
15064 @findex GCC_EXEC_PREFIX
15065 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
15066 names of the subprograms executed by the compiler.  No slash is added
15067 when this prefix is combined with the name of a subprogram, but you can
15068 specify a prefix that ends with a slash if you wish.
15070 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
15071 an appropriate prefix to use based on the pathname it was invoked with.
15073 If GCC cannot find the subprogram using the specified prefix, it
15074 tries looking in the usual places for the subprogram.
15076 The default value of @env{GCC_EXEC_PREFIX} is
15077 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
15078 the installed compiler. In many cases @var{prefix} is the value
15079 of @code{prefix} when you ran the @file{configure} script.
15081 Other prefixes specified with @option{-B} take precedence over this prefix.
15083 This prefix is also used for finding files such as @file{crt0.o} that are
15084 used for linking.
15086 In addition, the prefix is used in an unusual way in finding the
15087 directories to search for header files.  For each of the standard
15088 directories whose name normally begins with @samp{/usr/local/lib/gcc}
15089 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
15090 replacing that beginning with the specified prefix to produce an
15091 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
15092 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
15093 These alternate directories are searched first; the standard directories
15094 come next. If a standard directory begins with the configured
15095 @var{prefix} then the value of @var{prefix} is replaced by
15096 @env{GCC_EXEC_PREFIX} when looking for header files.
15098 @item COMPILER_PATH
15099 @findex COMPILER_PATH
15100 The value of @env{COMPILER_PATH} is a colon-separated list of
15101 directories, much like @env{PATH}.  GCC tries the directories thus
15102 specified when searching for subprograms, if it can't find the
15103 subprograms using @env{GCC_EXEC_PREFIX}.
15105 @item LIBRARY_PATH
15106 @findex LIBRARY_PATH
15107 The value of @env{LIBRARY_PATH} is a colon-separated list of
15108 directories, much like @env{PATH}.  When configured as a native compiler,
15109 GCC tries the directories thus specified when searching for special
15110 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
15111 using GCC also uses these directories when searching for ordinary
15112 libraries for the @option{-l} option (but directories specified with
15113 @option{-L} come first).
15115 @item LANG
15116 @findex LANG
15117 @cindex locale definition
15118 This variable is used to pass locale information to the compiler.  One way in
15119 which this information is used is to determine the character set to be used
15120 when character literals, string literals and comments are parsed in C and C++.
15121 When the compiler is configured to allow multibyte characters,
15122 the following values for @env{LANG} are recognized:
15124 @table @samp
15125 @item C-JIS
15126 Recognize JIS characters.
15127 @item C-SJIS
15128 Recognize SJIS characters.
15129 @item C-EUCJP
15130 Recognize EUCJP characters.
15131 @end table
15133 If @env{LANG} is not defined, or if it has some other value, then the
15134 compiler will use mblen and mbtowc as defined by the default locale to
15135 recognize and translate multibyte characters.
15136 @end table
15138 @noindent
15139 Some additional environments variables affect the behavior of the
15140 preprocessor.
15142 @include cppenv.texi
15144 @c man end
15146 @node Precompiled Headers
15147 @section Using Precompiled Headers
15148 @cindex precompiled headers
15149 @cindex speed of compilation
15151 Often large projects have many header files that are included in every
15152 source file.  The time the compiler takes to process these header files
15153 over and over again can account for nearly all of the time required to
15154 build the project.  To make builds faster, GCC allows users to
15155 `precompile' a header file; then, if builds can use the precompiled
15156 header file they will be much faster.
15158 To create a precompiled header file, simply compile it as you would any
15159 other file, if necessary using the @option{-x} option to make the driver
15160 treat it as a C or C++ header file.  You will probably want to use a
15161 tool like @command{make} to keep the precompiled header up-to-date when
15162 the headers it contains change.
15164 A precompiled header file will be searched for when @code{#include} is
15165 seen in the compilation.  As it searches for the included file
15166 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
15167 compiler looks for a precompiled header in each directory just before it
15168 looks for the include file in that directory.  The name searched for is
15169 the name specified in the @code{#include} with @samp{.gch} appended.  If
15170 the precompiled header file can't be used, it is ignored.
15172 For instance, if you have @code{#include "all.h"}, and you have
15173 @file{all.h.gch} in the same directory as @file{all.h}, then the
15174 precompiled header file will be used if possible, and the original
15175 header will be used otherwise.
15177 Alternatively, you might decide to put the precompiled header file in a
15178 directory and use @option{-I} to ensure that directory is searched
15179 before (or instead of) the directory containing the original header.
15180 Then, if you want to check that the precompiled header file is always
15181 used, you can put a file of the same name as the original header in this
15182 directory containing an @code{#error} command.
15184 This also works with @option{-include}.  So yet another way to use
15185 precompiled headers, good for projects not designed with precompiled
15186 header files in mind, is to simply take most of the header files used by
15187 a project, include them from another header file, precompile that header
15188 file, and @option{-include} the precompiled header.  If the header files
15189 have guards against multiple inclusion, they will be skipped because
15190 they've already been included (in the precompiled header).
15192 If you need to precompile the same header file for different
15193 languages, targets, or compiler options, you can instead make a
15194 @emph{directory} named like @file{all.h.gch}, and put each precompiled
15195 header in the directory, perhaps using @option{-o}.  It doesn't matter
15196 what you call the files in the directory, every precompiled header in
15197 the directory will be considered.  The first precompiled header
15198 encountered in the directory that is valid for this compilation will
15199 be used; they're searched in no particular order.
15201 There are many other possibilities, limited only by your imagination,
15202 good sense, and the constraints of your build system.
15204 A precompiled header file can be used only when these conditions apply:
15206 @itemize
15207 @item
15208 Only one precompiled header can be used in a particular compilation.
15210 @item
15211 A precompiled header can't be used once the first C token is seen.  You
15212 can have preprocessor directives before a precompiled header; you can
15213 even include a precompiled header from inside another header, so long as
15214 there are no C tokens before the @code{#include}.
15216 @item
15217 The precompiled header file must be produced for the same language as
15218 the current compilation.  You can't use a C precompiled header for a C++
15219 compilation.
15221 @item
15222 The precompiled header file must have been produced by the same compiler
15223 binary as the current compilation is using.
15225 @item
15226 Any macros defined before the precompiled header is included must
15227 either be defined in the same way as when the precompiled header was
15228 generated, or must not affect the precompiled header, which usually
15229 means that they don't appear in the precompiled header at all.
15231 The @option{-D} option is one way to define a macro before a
15232 precompiled header is included; using a @code{#define} can also do it.
15233 There are also some options that define macros implicitly, like
15234 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
15235 defined this way.
15237 @item If debugging information is output when using the precompiled
15238 header, using @option{-g} or similar, the same kind of debugging information
15239 must have been output when building the precompiled header.  However,
15240 a precompiled header built using @option{-g} can be used in a compilation
15241 when no debugging information is being output.
15243 @item The same @option{-m} options must generally be used when building
15244 and using the precompiled header.  @xref{Submodel Options},
15245 for any cases where this rule is relaxed.
15247 @item Each of the following options must be the same when building and using
15248 the precompiled header:
15250 @gccoptlist{-fexceptions -funit-at-a-time}
15252 @item
15253 Some other command-line options starting with @option{-f},
15254 @option{-p}, or @option{-O} must be defined in the same way as when
15255 the precompiled header was generated.  At present, it's not clear
15256 which options are safe to change and which are not; the safest choice
15257 is to use exactly the same options when generating and using the
15258 precompiled header.  The following are known to be safe:
15260 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
15261 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
15262 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
15263 -pedantic-errors}
15265 @end itemize
15267 For all of these except the last, the compiler will automatically
15268 ignore the precompiled header if the conditions aren't met.  If you
15269 find an option combination that doesn't work and doesn't cause the
15270 precompiled header to be ignored, please consider filing a bug report,
15271 see @ref{Bugs}.
15273 If you do use differing options when generating and using the
15274 precompiled header, the actual behavior will be a mixture of the
15275 behavior for the options.  For instance, if you use @option{-g} to
15276 generate the precompiled header but not when using it, you may or may
15277 not get debugging information for routines in the precompiled header.
15279 @node Running Protoize
15280 @section Running Protoize
15282 The program @code{protoize} is an optional part of GCC@.  You can use
15283 it to add prototypes to a program, thus converting the program to ISO
15284 C in one respect.  The companion program @code{unprotoize} does the
15285 reverse: it removes argument types from any prototypes that are found.
15287 When you run these programs, you must specify a set of source files as
15288 command line arguments.  The conversion programs start out by compiling
15289 these files to see what functions they define.  The information gathered
15290 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
15292 After scanning comes actual conversion.  The specified files are all
15293 eligible to be converted; any files they include (whether sources or
15294 just headers) are eligible as well.
15296 But not all the eligible files are converted.  By default,
15297 @code{protoize} and @code{unprotoize} convert only source and header
15298 files in the current directory.  You can specify additional directories
15299 whose files should be converted with the @option{-d @var{directory}}
15300 option.  You can also specify particular files to exclude with the
15301 @option{-x @var{file}} option.  A file is converted if it is eligible, its
15302 directory name matches one of the specified directory names, and its
15303 name within the directory has not been excluded.
15305 Basic conversion with @code{protoize} consists of rewriting most
15306 function definitions and function declarations to specify the types of
15307 the arguments.  The only ones not rewritten are those for varargs
15308 functions.
15310 @code{protoize} optionally inserts prototype declarations at the
15311 beginning of the source file, to make them available for any calls that
15312 precede the function's definition.  Or it can insert prototype
15313 declarations with block scope in the blocks where undeclared functions
15314 are called.
15316 Basic conversion with @code{unprotoize} consists of rewriting most
15317 function declarations to remove any argument types, and rewriting
15318 function definitions to the old-style pre-ISO form.
15320 Both conversion programs print a warning for any function declaration or
15321 definition that they can't convert.  You can suppress these warnings
15322 with @option{-q}.
15324 The output from @code{protoize} or @code{unprotoize} replaces the
15325 original source file.  The original file is renamed to a name ending
15326 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
15327 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
15328 for DOS) file already exists, then the source file is simply discarded.
15330 @code{protoize} and @code{unprotoize} both depend on GCC itself to
15331 scan the program and collect information about the functions it uses.
15332 So neither of these programs will work until GCC is installed.
15334 Here is a table of the options you can use with @code{protoize} and
15335 @code{unprotoize}.  Each option works with both programs unless
15336 otherwise stated.
15338 @table @code
15339 @item -B @var{directory}
15340 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
15341 usual directory (normally @file{/usr/local/lib}).  This file contains
15342 prototype information about standard system functions.  This option
15343 applies only to @code{protoize}.
15345 @item -c @var{compilation-options}
15346 Use @var{compilation-options} as the options when running @command{gcc} to
15347 produce the @samp{.X} files.  The special option @option{-aux-info} is
15348 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
15350 Note that the compilation options must be given as a single argument to
15351 @code{protoize} or @code{unprotoize}.  If you want to specify several
15352 @command{gcc} options, you must quote the entire set of compilation options
15353 to make them a single word in the shell.
15355 There are certain @command{gcc} arguments that you cannot use, because they
15356 would produce the wrong kind of output.  These include @option{-g},
15357 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
15358 the @var{compilation-options}, they are ignored.
15360 @item -C
15361 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
15362 systems) instead of @samp{.c}.  This is convenient if you are converting
15363 a C program to C++.  This option applies only to @code{protoize}.
15365 @item -g
15366 Add explicit global declarations.  This means inserting explicit
15367 declarations at the beginning of each source file for each function
15368 that is called in the file and was not declared.  These declarations
15369 precede the first function definition that contains a call to an
15370 undeclared function.  This option applies only to @code{protoize}.
15372 @item -i @var{string}
15373 Indent old-style parameter declarations with the string @var{string}.
15374 This option applies only to @code{protoize}.
15376 @code{unprotoize} converts prototyped function definitions to old-style
15377 function definitions, where the arguments are declared between the
15378 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
15379 uses five spaces as the indentation.  If you want to indent with just
15380 one space instead, use @option{-i " "}.
15382 @item -k
15383 Keep the @samp{.X} files.  Normally, they are deleted after conversion
15384 is finished.
15386 @item -l
15387 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
15388 a prototype declaration for each function in each block which calls the
15389 function without any declaration.  This option applies only to
15390 @code{protoize}.
15392 @item -n
15393 Make no real changes.  This mode just prints information about the conversions
15394 that would have been done without @option{-n}.
15396 @item -N
15397 Make no @samp{.save} files.  The original files are simply deleted.
15398 Use this option with caution.
15400 @item -p @var{program}
15401 Use the program @var{program} as the compiler.  Normally, the name
15402 @file{gcc} is used.
15404 @item -q
15405 Work quietly.  Most warnings are suppressed.
15407 @item -v
15408 Print the version number, just like @option{-v} for @command{gcc}.
15409 @end table
15411 If you need special compiler options to compile one of your program's
15412 source files, then you should generate that file's @samp{.X} file
15413 specially, by running @command{gcc} on that source file with the
15414 appropriate options and the option @option{-aux-info}.  Then run
15415 @code{protoize} on the entire set of files.  @code{protoize} will use
15416 the existing @samp{.X} file because it is newer than the source file.
15417 For example:
15419 @smallexample
15420 gcc -Dfoo=bar file1.c -aux-info file1.X
15421 protoize *.c
15422 @end smallexample
15424 @noindent
15425 You need to include the special files along with the rest in the
15426 @code{protoize} command, even though their @samp{.X} files already
15427 exist, because otherwise they won't get converted.
15429 @xref{Protoize Caveats}, for more information on how to use
15430 @code{protoize} successfully.