OSDN Git Service

2007-02-12 Manuel Lopez-Ibanez <manu@gcc.gnu.org>
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
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.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
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 Free Software Foundation, Inc.
15
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with the
19 Invariant Sections being ``GNU General Public License'' and ``Funding
20 Free Software'', the Front-Cover texts being (a) (see below), and with
21 the Back-Cover Texts being (b) (see below).  A copy of the license is
22 included in the gfdl(7) man page.
23
24 (a) The FSF's Front-Cover Text is:
25
26      A GNU Manual
27
28 (b) The FSF's Back-Cover Text is:
29
30      You have freedom to copy and modify this GNU Manual, like GNU
31      software.  Copies published by the Free Software Foundation raise
32      funds for GNU development.
33 @c man end
34 @c Set file name and title for the man page.
35 @setfilename gcc
36 @settitle GNU project C and C++ compiler
37 @c man begin SYNOPSIS
38 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
39     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
40     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
41     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
42     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
43     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
44     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45
46 Only the most useful options are listed here; see below for the
47 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
48 @c man end
49 @c man begin SEEALSO
50 gpl(7), gfdl(7), fsf-funding(7),
51 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
52 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
53 @file{ld}, @file{binutils} and @file{gdb}.
54 @c man end
55 @c man begin BUGS
56 For instructions on reporting bugs, see
57 @w{@uref{http://gcc.gnu.org/bugs.html}}.
58 @c man end
59 @c man begin AUTHOR
60 See the Info entry for @command{gcc}, or
61 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
62 for contributors to GCC@.
63 @c man end
64 @end ignore
65
66 @node Invoking GCC
67 @chapter GCC Command Options
68 @cindex GCC command options
69 @cindex command options
70 @cindex options, GCC command
71
72 @c man begin DESCRIPTION
73 When you invoke GCC, it normally does preprocessing, compilation,
74 assembly and linking.  The ``overall options'' allow you to stop this
75 process at an intermediate stage.  For example, the @option{-c} option
76 says not to run the linker.  Then the output consists of object files
77 output by the assembler.
78
79 Other options are passed on to one stage of processing.  Some options
80 control the preprocessor and others the compiler itself.  Yet other
81 options control the assembler and linker; most of these are not
82 documented here, since you rarely need to use any of them.
83
84 @cindex C compilation options
85 Most of the command line options that you can use with GCC are useful
86 for C programs; when an option is only useful with another language
87 (usually C++), the explanation says so explicitly.  If the description
88 for a particular option does not mention a source language, you can use
89 that option with all supported languages.
90
91 @cindex C++ compilation options
92 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
93 options for compiling C++ programs.
94
95 @cindex grouping options
96 @cindex options, grouping
97 The @command{gcc} program accepts options and file names as operands.  Many
98 options have multi-letter names; therefore multiple single-letter options
99 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
100 -r}}.
101
102 @cindex order of options
103 @cindex options, order
104 You can mix options and other arguments.  For the most part, the order
105 you use doesn't matter.  Order does matter when you use several options
106 of the same kind; for example, if you specify @option{-L} more than once,
107 the directories are searched in the order specified.
108
109 Many options have long names starting with @samp{-f} or with
110 @samp{-W}---for example, 
111 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
112 these have both positive and negative forms; the negative form of
113 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
114 only one of these two forms, whichever one is not the default.
115
116 @c man end
117
118 @xref{Option Index}, for an index to GCC's options.
119
120 @menu
121 * Option Summary::      Brief list of all options, without explanations.
122 * Overall Options::     Controlling the kind of output:
123                         an executable, object files, assembler files,
124                         or preprocessed source.
125 * Invoking G++::        Compiling C++ programs.
126 * C Dialect Options::   Controlling the variant of C language compiled.
127 * C++ Dialect Options:: Variations on C++.
128 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
129                         and Objective-C++.
130 * Language Independent Options:: Controlling how diagnostics should be
131                         formatted.
132 * Warning Options::     How picky should the compiler be?
133 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
134 * Optimize Options::    How much optimization?
135 * Preprocessor Options:: Controlling header files and macro definitions.
136                          Also, getting dependency information for Make.
137 * Assembler Options::   Passing options to the assembler.
138 * Link Options::        Specifying libraries and so on.
139 * Directory Options::   Where to find header files and libraries.
140                         Where to find the compiler executable files.
141 * Spec Files::          How to pass switches to sub-processes.
142 * Target Options::      Running a cross-compiler, or an old version of GCC.
143 * Submodel Options::    Specifying minor hardware or convention variations,
144                         such as 68010 vs 68020.
145 * Code Gen Options::    Specifying conventions for function calls, data layout
146                         and register usage.
147 * Environment Variables:: Env vars that affect GCC.
148 * Precompiled Headers:: Compiling a header once, and using it many times.
149 * Running Protoize::    Automatically adding or removing function prototypes.
150 @end menu
151
152 @c man begin OPTIONS
153
154 @node Option Summary
155 @section Option Summary
156
157 Here is a summary of all the options, grouped by type.  Explanations are
158 in the following sections.
159
160 @table @emph
161 @item Overall Options
162 @xref{Overall Options,,Options Controlling the Kind of Output}.
163 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
164 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
165
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
169 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
170 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
171 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
172 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
173 -fsigned-bitfields  -fsigned-char @gol
174 -funsigned-bitfields  -funsigned-char}
175
176 @item C++ Language Options
177 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
178 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
179 -fconserve-space  -ffriend-injection @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs @gol
182 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
183 -fno-implicit-templates @gol
184 -fno-implicit-inline-templates @gol
185 -fno-implement-inlines  -fms-extensions @gol
186 -fno-nonansi-builtins  -fno-operator-names @gol
187 -fno-optional-diags  -fpermissive @gol
188 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
189 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
190 -fno-default-inline  -fvisibility-inlines-hidden @gol
191 -Wabi  -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor  -Wreorder @gol
193 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
194 -Wno-non-template-friend  -Wold-style-cast @gol
195 -Woverloaded-virtual  -Wno-pmf-conversions @gol
196 -Wsign-promo}
197
198 @item Objective-C and Objective-C++ Language Options
199 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
200 Objective-C and Objective-C++ Dialects}.
201 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol  -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
215
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n}  @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
220 -fdiagnostics-show-option}
221
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Warray-bounds @gol
226 -Wno-attributes -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
227 -Wchar-subscripts -Wclobbered  -Wcomment @gol
228 -Wconversion -Wcoverage-mismatch -Wno-deprecated-declarations @gol
229 -Wdisabled-optimization  -Wno-div-by-zero  @gol
230 -Wempty-body  -Wno-endif-labels @gol
231 -Werror  -Werror-* -Werror-implicit-function-declaration @gol
232 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
233 -Wno-format-extra-args -Wformat-nonliteral @gol
234 -Wformat-security  -Wformat-y2k @gol
235 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
236 -Wimport  -Wno-import  -Winit-self  -Winline @gol
237 -Wno-int-to-pointer-cast @gol
238 -Wno-invalid-offsetof  -Winvalid-pch @gol
239 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
240 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
241 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
242 -Wmissing-noreturn @gol
243 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
244 -Woverlength-strings  -Wpacked  -Wpadded @gol
245 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
246 -Wredundant-decls @gol
247 -Wreturn-type  -Wsequence-point  -Wshadow @gol
248 -Wsign-compare  -Wstack-protector @gol
249 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
250 -Wstring-literal-comparison @gol
251 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
252 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
253 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
254 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
255 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
256 -Wvolatile-register-var  -Wwrite-strings}
257
258 @item C-only Warning Options
259 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
260 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
261 -Wold-style-declaration  -Wold-style-definition @gol
262 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
263 -Wdeclaration-after-statement -Wpointer-sign}
264
265 @item Debugging Options
266 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
267 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
268 -fdump-noaddr -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
269 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
270 -fdump-ipa-all -fdump-ipa-cgraph @gol
271 -fdump-tree-all @gol
272 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
273 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
276 -fdump-tree-ch @gol
277 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-nrv -fdump-tree-vect @gol
286 -fdump-tree-sink @gol
287 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-salias @gol
289 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
291 -ftree-vectorizer-verbose=@var{n} @gol
292 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
293 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
294 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
295 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
296 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
297 -ftest-coverage  -ftime-report -fvar-tracking @gol
298 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
299 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
300 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
301 -print-multi-directory  -print-multi-lib @gol
302 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
303 -save-temps  -time}
304
305 @item Optimization Options
306 @xref{Optimize Options,,Options that Control Optimization}.
307 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
308 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
309 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
310 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
311 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
312 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
313 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
314 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
315 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
316 -fforce-addr  -fforward-propagate  -ffunction-sections @gol
317 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
318 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
319 -finline-functions  -finline-functions-called-once @gol
320 -finline-limit=@var{n}  -fkeep-inline-functions @gol
321 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
322 -fmodulo-sched -fno-branch-count-reg @gol
323 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
324 -fno-function-cse  -fno-guess-branch-probability @gol
325 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
326 -funsafe-math-optimizations  -funsafe-loop-optimizations @gol
327 -ffinite-math-only  -fno-signed-zeros @gol
328 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
329 -fomit-frame-pointer  -foptimize-register-move @gol
330 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
331 -fprofile-generate -fprofile-use @gol
332 -fregmove  -frename-registers @gol
333 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
334 -frerun-cse-after-loop @gol
335 -frounding-math -frtl-abstract-sequences @gol
336 -fschedule-insns  -fschedule-insns2 @gol
337 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
338 -fsched-spec-load-dangerous  @gol
339 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
340 -fsched2-use-superblocks @gol
341 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
342 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
343 -fno-split-wide-types -fstack-protector  -fstack-protector-all @gol
344 -fstrict-aliasing  -fstrict-overflow  -ftracer  -fthread-jumps @gol
345 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
346 -fsplit-ivs-in-unroller -funswitch-loops @gol
347 -fvariable-expansion-in-unroller @gol
348 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
349 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
350 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
351 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
352 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
353 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
354 --param @var{name}=@var{value}
355 -O  -O0  -O1  -O2  -O3  -Os}
356
357 @item Preprocessor Options
358 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
359 @gccoptlist{-A@var{question}=@var{answer} @gol
360 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
361 -C  -dD  -dI  -dM  -dN @gol
362 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
363 -idirafter @var{dir} @gol
364 -include @var{file}  -imacros @var{file} @gol
365 -iprefix @var{file}  -iwithprefix @var{dir} @gol
366 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
367 -imultilib @var{dir} -isysroot @var{dir} @gol
368 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
369 -P  -fworking-directory  -remap @gol
370 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
371 -Xpreprocessor @var{option}}
372
373 @item Assembler Option
374 @xref{Assembler Options,,Passing Options to the Assembler}.
375 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
376
377 @item Linker Options
378 @xref{Link Options,,Options for Linking}.
379 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
380 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
381 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
382 -Wl,@var{option}  -Xlinker @var{option} @gol
383 -u @var{symbol}}
384
385 @item Directory Options
386 @xref{Directory Options,,Options for Directory Search}.
387 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
388 -specs=@var{file}  -I- --sysroot=@var{dir}}
389
390 @item Target Options
391 @c I wrote this xref this way to avoid overfull hbox. -- rms
392 @xref{Target Options}.
393 @gccoptlist{-V @var{version}  -b @var{machine}}
394
395 @item Machine Dependent Options
396 @xref{Submodel Options,,Hardware Models and Configurations}.
397 @c This list is ordered alphanumerically by subsection name.
398 @c Try and put the significant identifier (CPU or system) first,
399 @c so users have a clue at guessing where the ones they want will be.
400
401 @emph{ARC Options}
402 @gccoptlist{-EB  -EL @gol
403 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
404 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
405
406 @emph{ARM Options}
407 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
408 -mabi=@var{name} @gol
409 -mapcs-stack-check  -mno-apcs-stack-check @gol
410 -mapcs-float  -mno-apcs-float @gol
411 -mapcs-reentrant  -mno-apcs-reentrant @gol
412 -msched-prolog  -mno-sched-prolog @gol
413 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
414 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
415 -mthumb-interwork  -mno-thumb-interwork @gol
416 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
417 -mstructure-size-boundary=@var{n} @gol
418 -mabort-on-noreturn @gol
419 -mlong-calls  -mno-long-calls @gol
420 -msingle-pic-base  -mno-single-pic-base @gol
421 -mpic-register=@var{reg} @gol
422 -mnop-fun-dllimport @gol
423 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
424 -mpoke-function-name @gol
425 -mthumb  -marm @gol
426 -mtpcs-frame  -mtpcs-leaf-frame @gol
427 -mcaller-super-interworking  -mcallee-super-interworking @gol
428 -mtp=@var{name}}
429
430 @emph{AVR Options}
431 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
432 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
433
434 @emph{Blackfin Options}
435 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
436 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
437 -mlow-64k  -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
438 -mno-id-shared-library -mshared-library-id=@var{n} @gol
439 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
440 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls}
441
442 @emph{CRIS Options}
443 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
444 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
445 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
446 -mstack-align  -mdata-align  -mconst-align @gol
447 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
448 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
449 -mmul-bug-workaround  -mno-mul-bug-workaround}
450
451 @emph{CRX Options}
452 @gccoptlist{-mmac -mpush-args}
453
454 @emph{Darwin Options}
455 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
456 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
457 -client_name  -compatibility_version  -current_version @gol
458 -dead_strip @gol
459 -dependency-file  -dylib_file  -dylinker_install_name @gol
460 -dynamic  -dynamiclib  -exported_symbols_list @gol
461 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
462 -force_flat_namespace  -headerpad_max_install_names @gol
463 -image_base  -init  -install_name  -keep_private_externs @gol
464 -multi_module  -multiply_defined  -multiply_defined_unused @gol
465 -noall_load   -no_dead_strip_inits_and_terms @gol
466 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
467 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
468 -private_bundle  -read_only_relocs  -sectalign @gol
469 -sectobjectsymbols  -whyload  -seg1addr @gol
470 -sectcreate  -sectobjectsymbols  -sectorder @gol
471 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
472 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
473 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
474 -single_module  -static  -sub_library  -sub_umbrella @gol
475 -twolevel_namespace  -umbrella  -undefined @gol
476 -unexported_symbols_list  -weak_reference_mismatches @gol
477 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
478 -mkernel -mone-byte-bool}
479
480 @emph{DEC Alpha Options}
481 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
482 -mieee  -mieee-with-inexact  -mieee-conformant @gol
483 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
484 -mtrap-precision=@var{mode}  -mbuild-constants @gol
485 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
486 -mbwx  -mmax  -mfix  -mcix @gol
487 -mfloat-vax  -mfloat-ieee @gol
488 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
489 -msmall-text  -mlarge-text @gol
490 -mmemory-latency=@var{time}}
491
492 @emph{DEC Alpha/VMS Options}
493 @gccoptlist{-mvms-return-codes}
494
495 @emph{FRV Options}
496 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
497 -mhard-float  -msoft-float @gol
498 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
499 -mdouble  -mno-double @gol
500 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
501 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
502 -mlinked-fp  -mlong-calls  -malign-labels @gol
503 -mlibrary-pic  -macc-4  -macc-8 @gol
504 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
505 -moptimize-membar -mno-optimize-membar @gol
506 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
507 -mvliw-branch  -mno-vliw-branch @gol
508 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
509 -mno-nested-cond-exec  -mtomcat-stats @gol
510 -mTLS -mtls @gol
511 -mcpu=@var{cpu}}
512
513 @emph{GNU/Linux Options}
514 @gccoptlist{-muclibc}
515
516 @emph{H8/300 Options}
517 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
518
519 @emph{HPPA Options}
520 @gccoptlist{-march=@var{architecture-type} @gol
521 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
522 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
523 -mfixed-range=@var{register-range} @gol
524 -mjump-in-delay -mlinker-opt -mlong-calls @gol
525 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
526 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
527 -mno-jump-in-delay  -mno-long-load-store @gol
528 -mno-portable-runtime  -mno-soft-float @gol
529 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
530 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
531 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
532 -munix=@var{unix-std}  -nolibdld  -static  -threads}
533
534 @emph{i386 and x86-64 Options}
535 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
536 -mfpmath=@var{unit} @gol
537 -masm=@var{dialect}  -mno-fancy-math-387 @gol
538 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
539 -mno-wide-multiply  -mrtd  -malign-double @gol
540 -mpreferred-stack-boundary=@var{num} @gol
541 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4a -m3dnow -mpopcnt -mabm @gol
542 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
543 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
544 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
545 -mstackrealign @gol
546 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
547 -mcmodel=@var{code-model} @gol
548 -m32  -m64 -mlarge-data-threshold=@var{num}}
549
550 @emph{IA-64 Options}
551 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
552 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
553 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
554 -minline-float-divide-max-throughput @gol
555 -minline-int-divide-min-latency @gol
556 -minline-int-divide-max-throughput  @gol
557 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
558 -mno-dwarf2-asm -mearly-stop-bits @gol
559 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
560 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
561 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
562 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
563 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
564 -mno-sched-prefer-non-data-spec-insns @gol
565 -mno-sched-prefer-non-control-spec-insns @gol
566 -mno-sched-count-spec-in-critical-path}
567
568 @emph{M32R/D Options}
569 @gccoptlist{-m32r2 -m32rx -m32r @gol
570 -mdebug @gol
571 -malign-loops -mno-align-loops @gol
572 -missue-rate=@var{number} @gol
573 -mbranch-cost=@var{number} @gol
574 -mmodel=@var{code-size-model-type} @gol
575 -msdata=@var{sdata-type} @gol
576 -mno-flush-func -mflush-func=@var{name} @gol
577 -mno-flush-trap -mflush-trap=@var{number} @gol
578 -G @var{num}}
579
580 @emph{M32C Options}
581 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
582
583 @emph{M680x0 Options}
584 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
585 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
586 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
587 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
588 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
589 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
590 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
591 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
592
593 @emph{M68hc1x Options}
594 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
595 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
596 -msoft-reg-count=@var{count}}
597
598 @emph{MCore Options}
599 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
600 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
601 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
602 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
603 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
604
605 @emph{MIPS Options}
606 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
607 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
608 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
609 -mshared  -mno-shared  -mxgot  -mno-xgot  -mgp32  -mgp64  @gol
610 -mfp32  -mfp64  -mhard-float  -msoft-float  @gol
611 -msingle-float  -mdouble-float  -mdsp  -mpaired-single  -mips3d @gol
612 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
613 -G@var{num}  -membedded-data  -mno-embedded-data @gol
614 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
615 -msplit-addresses  -mno-split-addresses  @gol
616 -mexplicit-relocs  -mno-explicit-relocs  @gol
617 -mcheck-zero-division  -mno-check-zero-division @gol
618 -mdivide-traps  -mdivide-breaks @gol
619 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
620 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
621 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
622 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
623 -mfix-sb1  -mno-fix-sb1 @gol
624 -mflush-func=@var{func}  -mno-flush-func @gol
625 -mbranch-likely  -mno-branch-likely @gol
626 -mfp-exceptions -mno-fp-exceptions @gol
627 -mvr4130-align -mno-vr4130-align}
628
629 @emph{MMIX Options}
630 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
631 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
632 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
633 -mno-base-addresses  -msingle-exit  -mno-single-exit}
634
635 @emph{MN10300 Options}
636 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
637 -mam33  -mno-am33 @gol
638 -mam33-2  -mno-am33-2 @gol
639 -mreturn-pointer-on-d0 @gol
640 -mno-crt0  -mrelax}
641
642 @emph{MT Options}
643 @gccoptlist{-mno-crt0 -mbacc -msim @gol
644 -march=@var{cpu-type} }
645
646 @emph{PDP-11 Options}
647 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
648 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
649 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
650 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
651 -mbranch-expensive  -mbranch-cheap @gol
652 -msplit  -mno-split  -munix-asm  -mdec-asm}
653
654 @emph{PowerPC Options}
655 See RS/6000 and PowerPC Options.
656
657 @emph{RS/6000 and PowerPC Options}
658 @gccoptlist{-mcpu=@var{cpu-type} @gol
659 -mtune=@var{cpu-type} @gol
660 -mpower  -mno-power  -mpower2  -mno-power2 @gol
661 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
662 -maltivec  -mno-altivec @gol
663 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
664 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
665 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
666 -mmfpgpr -mno-mfpgpr @gol
667 -mnew-mnemonics  -mold-mnemonics @gol
668 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
669 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
670 -malign-power  -malign-natural @gol
671 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
672 -mstring  -mno-string  -mupdate  -mno-update @gol
673 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
674 -mstrict-align  -mno-strict-align  -mrelocatable @gol
675 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
676 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
677 -mdynamic-no-pic  -maltivec  -mswdiv @gol
678 -mprioritize-restricted-insns=@var{priority} @gol
679 -msched-costly-dep=@var{dependence_type} @gol
680 -minsert-sched-nops=@var{scheme} @gol
681 -mcall-sysv  -mcall-netbsd @gol
682 -maix-struct-return  -msvr4-struct-return @gol
683 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
684 -misel -mno-isel @gol
685 -misel=yes  -misel=no @gol
686 -mspe -mno-spe @gol
687 -mspe=yes  -mspe=no @gol
688 -mvrsave -mno-vrsave @gol
689 -mmulhw -mno-mulhw @gol
690 -mdlmzb -mno-dlmzb @gol
691 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
692 -mprototype  -mno-prototype @gol
693 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
694 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
695
696 @emph{S/390 and zSeries Options}
697 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
698 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
699 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
700 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
701 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
702 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
703 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
704
705 @emph{Score Options}
706 @gccoptlist{-mel -mel @gol
707 -mmac @gol
708 -mscore5u -mscore7}
709  
710 @emph{SH Options}
711 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
712 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
713 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
714 -m5-64media  -m5-64media-nofpu @gol
715 -m5-32media  -m5-32media-nofpu @gol
716 -m5-compact  -m5-compact-nofpu @gol
717 -mb  -ml  -mdalign  -mrelax @gol
718 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
719 -mieee  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
720 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
721 -mdivsi3_libfunc=@var{name}  @gol
722 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
723  -minvalid-symbols}
724
725 @emph{SPARC Options}
726 @gccoptlist{-mcpu=@var{cpu-type} @gol
727 -mtune=@var{cpu-type} @gol
728 -mcmodel=@var{code-model} @gol
729 -m32  -m64  -mapp-regs  -mno-app-regs @gol
730 -mfaster-structs  -mno-faster-structs @gol
731 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
732 -mhard-quad-float  -msoft-quad-float @gol
733 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
734 -mstack-bias  -mno-stack-bias @gol
735 -munaligned-doubles  -mno-unaligned-doubles @gol
736 -mv8plus  -mno-v8plus  -mvis  -mno-vis
737 -threads -pthreads -pthread}
738
739 @emph{SPU Options}
740 @gccoptlist{-mwarn-reloc -merror-reloc @gol
741 -msafe-dma -munsafe-dma @gol
742 -mbranch-hints @gol
743 -msmall-mem -mlarge-mem -mstdmain @gol
744 -mfixed-range=@var{register-range}}
745
746 @emph{System V Options}
747 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
748
749 @emph{TMS320C3x/C4x Options}
750 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
751 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
752 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
753 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
754
755 @emph{V850 Options}
756 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
757 -mprolog-function  -mno-prolog-function  -mspace @gol
758 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
759 -mapp-regs  -mno-app-regs @gol
760 -mdisable-callt  -mno-disable-callt @gol
761 -mv850e1 @gol
762 -mv850e @gol
763 -mv850  -mbig-switch}
764
765 @emph{VAX Options}
766 @gccoptlist{-mg  -mgnu  -munix}
767
768 @emph{x86-64 Options}
769 See i386 and x86-64 Options.
770
771 @emph{Xstormy16 Options}
772 @gccoptlist{-msim}
773
774 @emph{Xtensa Options}
775 @gccoptlist{-mconst16 -mno-const16 @gol
776 -mfused-madd  -mno-fused-madd @gol
777 -mtext-section-literals  -mno-text-section-literals @gol
778 -mtarget-align  -mno-target-align @gol
779 -mlongcalls  -mno-longcalls}
780
781 @emph{zSeries Options}
782 See S/390 and zSeries Options.
783
784 @item Code Generation Options
785 @xref{Code Gen Options,,Options for Code Generation Conventions}.
786 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
787 -ffixed-@var{reg}  -fexceptions @gol
788 -fnon-call-exceptions  -funwind-tables @gol
789 -fasynchronous-unwind-tables @gol
790 -finhibit-size-directive  -finstrument-functions @gol
791 -fno-common  -fno-ident @gol
792 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
793 -fno-jump-tables @gol
794 -frecord-gcc-switches @gol
795 -freg-struct-return  -fshort-enums @gol
796 -fshort-double  -fshort-wchar @gol
797 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
798 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
799 -fargument-alias  -fargument-noalias @gol
800 -fargument-noalias-global  -fargument-noalias-anything
801 -fleading-underscore  -ftls-model=@var{model} @gol
802 -ftrapv  -fwrapv  -fbounds-check @gol
803 -fvisibility}
804 @end table
805
806 @menu
807 * Overall Options::     Controlling the kind of output:
808                         an executable, object files, assembler files,
809                         or preprocessed source.
810 * C Dialect Options::   Controlling the variant of C language compiled.
811 * C++ Dialect Options:: Variations on C++.
812 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
813                         and Objective-C++.
814 * Language Independent Options:: Controlling how diagnostics should be
815                         formatted.
816 * Warning Options::     How picky should the compiler be?
817 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
818 * Optimize Options::    How much optimization?
819 * Preprocessor Options:: Controlling header files and macro definitions.
820                          Also, getting dependency information for Make.
821 * Assembler Options::   Passing options to the assembler.
822 * Link Options::        Specifying libraries and so on.
823 * Directory Options::   Where to find header files and libraries.
824                         Where to find the compiler executable files.
825 * Spec Files::          How to pass switches to sub-processes.
826 * Target Options::      Running a cross-compiler, or an old version of GCC.
827 @end menu
828
829 @node Overall Options
830 @section Options Controlling the Kind of Output
831
832 Compilation can involve up to four stages: preprocessing, compilation
833 proper, assembly and linking, always in that order.  GCC is capable of
834 preprocessing and compiling several files either into several
835 assembler input files, or into one assembler input file; then each
836 assembler input file produces an object file, and linking combines all
837 the object files (those newly compiled, and those specified as input)
838 into an executable file.
839
840 @cindex file name suffix
841 For any given input file, the file name suffix determines what kind of
842 compilation is done:
843
844 @table @gcctabopt
845 @item @var{file}.c
846 C source code which must be preprocessed.
847
848 @item @var{file}.i
849 C source code which should not be preprocessed.
850
851 @item @var{file}.ii
852 C++ source code which should not be preprocessed.
853
854 @item @var{file}.m
855 Objective-C source code.  Note that you must link with the @file{libobjc}
856 library to make an Objective-C program work.
857
858 @item @var{file}.mi
859 Objective-C source code which should not be preprocessed.
860
861 @item @var{file}.mm
862 @itemx @var{file}.M
863 Objective-C++ source code.  Note that you must link with the @file{libobjc}
864 library to make an Objective-C++ program work.  Note that @samp{.M} refers
865 to a literal capital M@.
866
867 @item @var{file}.mii
868 Objective-C++ source code which should not be preprocessed.
869
870 @item @var{file}.h
871 C, C++, Objective-C or Objective-C++ header file to be turned into a
872 precompiled header.
873
874 @item @var{file}.cc
875 @itemx @var{file}.cp
876 @itemx @var{file}.cxx
877 @itemx @var{file}.cpp
878 @itemx @var{file}.CPP
879 @itemx @var{file}.c++
880 @itemx @var{file}.C
881 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
882 the last two letters must both be literally @samp{x}.  Likewise,
883 @samp{.C} refers to a literal capital C@.
884
885 @item @var{file}.mm
886 @itemx @var{file}.M
887 Objective-C++ source code which must be preprocessed.
888
889 @item @var{file}.mii
890 Objective-C++ source code which should not be preprocessed.
891
892 @item @var{file}.hh
893 @itemx @var{file}.H
894 C++ header file to be turned into a precompiled header.
895
896 @item @var{file}.f
897 @itemx @var{file}.for
898 @itemx @var{file}.FOR
899 Fixed form Fortran source code which should not be preprocessed.
900
901 @item @var{file}.F
902 @itemx @var{file}.fpp
903 @itemx @var{file}.FPP
904 Fixed form Fortran source code which must be preprocessed (with the traditional
905 preprocessor).
906
907 @item @var{file}.f90
908 @itemx @var{file}.f95
909 Free form Fortran source code which should not be preprocessed.
910
911 @item @var{file}.F90
912 @itemx @var{file}.F95
913 Free form Fortran source code which must be preprocessed (with the
914 traditional preprocessor).
915
916 @c FIXME: Descriptions of Java file types.
917 @c @var{file}.java
918 @c @var{file}.class
919 @c @var{file}.zip
920 @c @var{file}.jar
921
922 @item @var{file}.ads
923 Ada source code file which contains a library unit declaration (a
924 declaration of a package, subprogram, or generic, or a generic
925 instantiation), or a library unit renaming declaration (a package,
926 generic, or subprogram renaming declaration).  Such files are also
927 called @dfn{specs}.
928
929 @itemx @var{file}.adb
930 Ada source code file containing a library unit body (a subprogram or
931 package body).  Such files are also called @dfn{bodies}.
932
933 @c GCC also knows about some suffixes for languages not yet included:
934 @c Pascal:
935 @c @var{file}.p
936 @c @var{file}.pas
937 @c Ratfor:
938 @c @var{file}.r
939
940 @item @var{file}.s
941 Assembler code.
942
943 @item @var{file}.S
944 Assembler code which must be preprocessed.
945
946 @item @var{other}
947 An object file to be fed straight into linking.
948 Any file name with no recognized suffix is treated this way.
949 @end table
950
951 @opindex x
952 You can specify the input language explicitly with the @option{-x} option:
953
954 @table @gcctabopt
955 @item -x @var{language}
956 Specify explicitly the @var{language} for the following input files
957 (rather than letting the compiler choose a default based on the file
958 name suffix).  This option applies to all following input files until
959 the next @option{-x} option.  Possible values for @var{language} are:
960 @smallexample
961 c  c-header  c-cpp-output
962 c++  c++-header  c++-cpp-output
963 objective-c  objective-c-header  objective-c-cpp-output
964 objective-c++ objective-c++-header objective-c++-cpp-output
965 assembler  assembler-with-cpp
966 ada
967 f95  f95-cpp-input
968 java
969 treelang
970 @end smallexample
971
972 @item -x none
973 Turn off any specification of a language, so that subsequent files are
974 handled according to their file name suffixes (as they are if @option{-x}
975 has not been used at all).
976
977 @item -pass-exit-codes
978 @opindex pass-exit-codes
979 Normally the @command{gcc} program will exit with the code of 1 if any
980 phase of the compiler returns a non-success return code.  If you specify
981 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
982 numerically highest error produced by any phase that returned an error
983 indication.  The C, C++, and Fortran frontends return 4, if an internal
984 compiler error is encountered.
985 @end table
986
987 If you only want some of the stages of compilation, you can use
988 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
989 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
990 @command{gcc} is to stop.  Note that some combinations (for example,
991 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
992
993 @table @gcctabopt
994 @item -c
995 @opindex c
996 Compile or assemble the source files, but do not link.  The linking
997 stage simply is not done.  The ultimate output is in the form of an
998 object file for each source file.
999
1000 By default, the object file name for a source file is made by replacing
1001 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1002
1003 Unrecognized input files, not requiring compilation or assembly, are
1004 ignored.
1005
1006 @item -S
1007 @opindex S
1008 Stop after the stage of compilation proper; do not assemble.  The output
1009 is in the form of an assembler code file for each non-assembler input
1010 file specified.
1011
1012 By default, the assembler file name for a source file is made by
1013 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1014
1015 Input files that don't require compilation are ignored.
1016
1017 @item -E
1018 @opindex E
1019 Stop after the preprocessing stage; do not run the compiler proper.  The
1020 output is in the form of preprocessed source code, which is sent to the
1021 standard output.
1022
1023 Input files which don't require preprocessing are ignored.
1024
1025 @cindex output file option
1026 @item -o @var{file}
1027 @opindex o
1028 Place output in file @var{file}.  This applies regardless to whatever
1029 sort of output is being produced, whether it be an executable file,
1030 an object file, an assembler file or preprocessed C code.
1031
1032 If @option{-o} is not specified, the default is to put an executable
1033 file in @file{a.out}, the object file for
1034 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1035 assembler file in @file{@var{source}.s}, a precompiled header file in
1036 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1037 standard output.
1038
1039 @item -v
1040 @opindex v
1041 Print (on standard error output) the commands executed to run the stages
1042 of compilation.  Also print the version number of the compiler driver
1043 program and of the preprocessor and the compiler proper.
1044
1045 @item -###
1046 @opindex ###
1047 Like @option{-v} except the commands are not executed and all command
1048 arguments are quoted.  This is useful for shell scripts to capture the
1049 driver-generated command lines.
1050
1051 @item -pipe
1052 @opindex pipe
1053 Use pipes rather than temporary files for communication between the
1054 various stages of compilation.  This fails to work on some systems where
1055 the assembler is unable to read from a pipe; but the GNU assembler has
1056 no trouble.
1057
1058 @item -combine
1059 @opindex combine
1060 If you are compiling multiple source files, this option tells the driver
1061 to pass all the source files to the compiler at once (for those
1062 languages for which the compiler can handle this).  This will allow
1063 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1064 language for which this is supported is C@.  If you pass source files for
1065 multiple languages to the driver, using this option, the driver will invoke
1066 the compiler(s) that support IMA once each, passing each compiler all the
1067 source files appropriate for it.  For those languages that do not support
1068 IMA this option will be ignored, and the compiler will be invoked once for
1069 each source file in that language.  If you use this option in conjunction
1070 with @option{-save-temps}, the compiler will generate multiple
1071 pre-processed files
1072 (one for each source file), but only one (combined) @file{.o} or
1073 @file{.s} file.
1074
1075 @item --help
1076 @opindex help
1077 Print (on the standard output) a description of the command line options
1078 understood by @command{gcc}.  If the @option{-v} option is also specified
1079 then @option{--help} will also be passed on to the various processes
1080 invoked by @command{gcc}, so that they can display the command line options
1081 they accept.  If the @option{-Wextra} option is also specified then command
1082 line options which have no documentation associated with them will also
1083 be displayed.
1084
1085 @item --target-help
1086 @opindex target-help
1087 Print (on the standard output) a description of target specific command
1088 line options for each tool.
1089
1090 @item --version
1091 @opindex version
1092 Display the version number and copyrights of the invoked GCC@.
1093
1094 @include @value{srcdir}/../libiberty/at-file.texi
1095 @end table
1096
1097 @node Invoking G++
1098 @section Compiling C++ Programs
1099
1100 @cindex suffixes for C++ source
1101 @cindex C++ source file suffixes
1102 C++ source files conventionally use one of the suffixes @samp{.C},
1103 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1104 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1105 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1106 files with these names and compiles them as C++ programs even if you
1107 call the compiler the same way as for compiling C programs (usually
1108 with the name @command{gcc}).
1109
1110 @findex g++
1111 @findex c++
1112 However, the use of @command{gcc} does not add the C++ library.
1113 @command{g++} is a program that calls GCC and treats @samp{.c},
1114 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1115 files unless @option{-x} is used, and automatically specifies linking
1116 against the C++ library.  This program is also useful when
1117 precompiling a C header file with a @samp{.h} extension for use in C++
1118 compilations.  On many systems, @command{g++} is also installed with
1119 the name @command{c++}.
1120
1121 @cindex invoking @command{g++}
1122 When you compile C++ programs, you may specify many of the same
1123 command-line options that you use for compiling programs in any
1124 language; or command-line options meaningful for C and related
1125 languages; or options that are meaningful only for C++ programs.
1126 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1127 explanations of options for languages related to C@.
1128 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1129 explanations of options that are meaningful only for C++ programs.
1130
1131 @node C Dialect Options
1132 @section Options Controlling C Dialect
1133 @cindex dialect options
1134 @cindex language dialect options
1135 @cindex options, dialect
1136
1137 The following options control the dialect of C (or languages derived
1138 from C, such as C++, Objective-C and Objective-C++) that the compiler
1139 accepts:
1140
1141 @table @gcctabopt
1142 @cindex ANSI support
1143 @cindex ISO support
1144 @item -ansi
1145 @opindex ansi
1146 In C mode, support all ISO C90 programs.  In C++ mode,
1147 remove GNU extensions that conflict with ISO C++.
1148
1149 This turns off certain features of GCC that are incompatible with ISO
1150 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1151 such as the @code{asm} and @code{typeof} keywords, and
1152 predefined macros such as @code{unix} and @code{vax} that identify the
1153 type of system you are using.  It also enables the undesirable and
1154 rarely used ISO trigraph feature.  For the C compiler,
1155 it disables recognition of C++ style @samp{//} comments as well as
1156 the @code{inline} keyword.
1157
1158 The alternate keywords @code{__asm__}, @code{__extension__},
1159 @code{__inline__} and @code{__typeof__} continue to work despite
1160 @option{-ansi}.  You would not want to use them in an ISO C program, of
1161 course, but it is useful to put them in header files that might be included
1162 in compilations done with @option{-ansi}.  Alternate predefined macros
1163 such as @code{__unix__} and @code{__vax__} are also available, with or
1164 without @option{-ansi}.
1165
1166 The @option{-ansi} option does not cause non-ISO programs to be
1167 rejected gratuitously.  For that, @option{-pedantic} is required in
1168 addition to @option{-ansi}.  @xref{Warning Options}.
1169
1170 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1171 option is used.  Some header files may notice this macro and refrain
1172 from declaring certain functions or defining certain macros that the
1173 ISO standard doesn't call for; this is to avoid interfering with any
1174 programs that might use these names for other things.
1175
1176 Functions which would normally be built in but do not have semantics
1177 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1178 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1179 built-in functions provided by GCC}, for details of the functions
1180 affected.
1181
1182 @item -std=
1183 @opindex std
1184 Determine the language standard.  This option is currently only
1185 supported when compiling C or C++.  A value for this option must be
1186 provided; possible values are
1187
1188 @table @samp
1189 @item c89
1190 @itemx iso9899:1990
1191 ISO C90 (same as @option{-ansi}).
1192
1193 @item iso9899:199409
1194 ISO C90 as modified in amendment 1.
1195
1196 @item c99
1197 @itemx c9x
1198 @itemx iso9899:1999
1199 @itemx iso9899:199x
1200 ISO C99.  Note that this standard is not yet fully supported; see
1201 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1202 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1203
1204 @item gnu89
1205 Default, ISO C90 plus GNU extensions (including some C99 features).
1206
1207 @item gnu99
1208 @itemx gnu9x
1209 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1210 this will become the default.  The name @samp{gnu9x} is deprecated.
1211
1212 @item c++98
1213 The 1998 ISO C++ standard plus amendments.
1214
1215 @item gnu++98
1216 The same as @option{-std=c++98} plus GNU extensions.  This is the
1217 default for C++ code.
1218
1219 @item c++0x
1220 The working draft of the upcoming ISO C++0x standard. This option
1221 enables experimental features that are likely to be included in
1222 C++0x. The working draft is constantly changing, and any feature that is
1223 enabled by this flag may be removed from future versions of GCC if it is
1224 not part of the C++0x standard.
1225
1226 @item gnu++0x
1227 The same as @option{-std=c++0x} plus GNU extensions. As with
1228 @option{-std=c++0x}, this option enables experimental features that may
1229 be removed in future versions of GCC.
1230 @end table
1231
1232 Even when this option is not specified, you can still use some of the
1233 features of newer standards in so far as they do not conflict with
1234 previous C standards.  For example, you may use @code{__restrict__} even
1235 when @option{-std=c99} is not specified.
1236
1237 The @option{-std} options specifying some version of ISO C have the same
1238 effects as @option{-ansi}, except that features that were not in ISO C90
1239 but are in the specified version (for example, @samp{//} comments and
1240 the @code{inline} keyword in ISO C99) are not disabled.
1241
1242 @xref{Standards,,Language Standards Supported by GCC}, for details of
1243 these standard versions.
1244
1245 @item -aux-info @var{filename}
1246 @opindex aux-info
1247 Output to the given filename prototyped declarations for all functions
1248 declared and/or defined in a translation unit, including those in header
1249 files.  This option is silently ignored in any language other than C@.
1250
1251 Besides declarations, the file indicates, in comments, the origin of
1252 each declaration (source file and line), whether the declaration was
1253 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1254 @samp{O} for old, respectively, in the first character after the line
1255 number and the colon), and whether it came from a declaration or a
1256 definition (@samp{C} or @samp{F}, respectively, in the following
1257 character).  In the case of function definitions, a K&R-style list of
1258 arguments followed by their declarations is also provided, inside
1259 comments, after the declaration.
1260
1261 @item -fno-asm
1262 @opindex fno-asm
1263 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1264 keyword, so that code can use these words as identifiers.  You can use
1265 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1266 instead.  @option{-ansi} implies @option{-fno-asm}.
1267
1268 In C++, this switch only affects the @code{typeof} keyword, since
1269 @code{asm} and @code{inline} are standard keywords.  You may want to
1270 use the @option{-fno-gnu-keywords} flag instead, which has the same
1271 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1272 switch only affects the @code{asm} and @code{typeof} keywords, since
1273 @code{inline} is a standard keyword in ISO C99.
1274
1275 @item -fno-builtin
1276 @itemx -fno-builtin-@var{function}
1277 @opindex fno-builtin
1278 @cindex built-in functions
1279 Don't recognize built-in functions that do not begin with
1280 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1281 functions provided by GCC}, for details of the functions affected,
1282 including those which are not built-in functions when @option{-ansi} or
1283 @option{-std} options for strict ISO C conformance are used because they
1284 do not have an ISO standard meaning.
1285
1286 GCC normally generates special code to handle certain built-in functions
1287 more efficiently; for instance, calls to @code{alloca} may become single
1288 instructions that adjust the stack directly, and calls to @code{memcpy}
1289 may become inline copy loops.  The resulting code is often both smaller
1290 and faster, but since the function calls no longer appear as such, you
1291 cannot set a breakpoint on those calls, nor can you change the behavior
1292 of the functions by linking with a different library.  In addition,
1293 when a function is recognized as a built-in function, GCC may use
1294 information about that function to warn about problems with calls to
1295 that function, or to generate more efficient code, even if the
1296 resulting code still contains calls to that function.  For example,
1297 warnings are given with @option{-Wformat} for bad calls to
1298 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1299 known not to modify global memory.
1300
1301 With the @option{-fno-builtin-@var{function}} option
1302 only the built-in function @var{function} is
1303 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1304 function is named this is not built-in in this version of GCC, this
1305 option is ignored.  There is no corresponding
1306 @option{-fbuiltin-@var{function}} option; if you wish to enable
1307 built-in functions selectively when using @option{-fno-builtin} or
1308 @option{-ffreestanding}, you may define macros such as:
1309
1310 @smallexample
1311 #define abs(n)          __builtin_abs ((n))
1312 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1313 @end smallexample
1314
1315 @item -fhosted
1316 @opindex fhosted
1317 @cindex hosted environment
1318
1319 Assert that compilation takes place in a hosted environment.  This implies
1320 @option{-fbuiltin}.  A hosted environment is one in which the
1321 entire standard library is available, and in which @code{main} has a return
1322 type of @code{int}.  Examples are nearly everything except a kernel.
1323 This is equivalent to @option{-fno-freestanding}.
1324
1325 @item -ffreestanding
1326 @opindex ffreestanding
1327 @cindex hosted environment
1328
1329 Assert that compilation takes place in a freestanding environment.  This
1330 implies @option{-fno-builtin}.  A freestanding environment
1331 is one in which the standard library may not exist, and program startup may
1332 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1333 This is equivalent to @option{-fno-hosted}.
1334
1335 @xref{Standards,,Language Standards Supported by GCC}, for details of
1336 freestanding and hosted environments.
1337
1338 @item -fopenmp
1339 @opindex fopenmp
1340 @cindex openmp parallel
1341 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1342 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1343 compiler generates parallel code according to the OpenMP Application
1344 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1345
1346 @item -fms-extensions
1347 @opindex fms-extensions
1348 Accept some non-standard constructs used in Microsoft header files.
1349
1350 Some cases of unnamed fields in structures and unions are only
1351 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1352 fields within structs/unions}, for details.
1353
1354 @item -trigraphs
1355 @opindex trigraphs
1356 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1357 options for strict ISO C conformance) implies @option{-trigraphs}.
1358
1359 @item -no-integrated-cpp
1360 @opindex no-integrated-cpp
1361 Performs a compilation in two passes: preprocessing and compiling.  This
1362 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1363 @option{-B} option.  The user supplied compilation step can then add in
1364 an additional preprocessing step after normal preprocessing but before
1365 compiling.  The default is to use the integrated cpp (internal cpp)
1366
1367 The semantics of this option will change if "cc1", "cc1plus", and
1368 "cc1obj" are merged.
1369
1370 @cindex traditional C language
1371 @cindex C language, traditional
1372 @item -traditional
1373 @itemx -traditional-cpp
1374 @opindex traditional-cpp
1375 @opindex traditional
1376 Formerly, these options caused GCC to attempt to emulate a pre-standard
1377 C compiler.  They are now only supported with the @option{-E} switch.
1378 The preprocessor continues to support a pre-standard mode.  See the GNU
1379 CPP manual for details.
1380
1381 @item -fcond-mismatch
1382 @opindex fcond-mismatch
1383 Allow conditional expressions with mismatched types in the second and
1384 third arguments.  The value of such an expression is void.  This option
1385 is not supported for C++.
1386
1387 @item -flax-vector-conversions
1388 @opindex flax-vector-conversions
1389 Allow implicit conversions between vectors with differing numbers of
1390 elements and/or incompatible element types.  This option should not be
1391 used for new code.
1392
1393 @item -funsigned-char
1394 @opindex funsigned-char
1395 Let the type @code{char} be unsigned, like @code{unsigned char}.
1396
1397 Each kind of machine has a default for what @code{char} should
1398 be.  It is either like @code{unsigned char} by default or like
1399 @code{signed char} by default.
1400
1401 Ideally, a portable program should always use @code{signed char} or
1402 @code{unsigned char} when it depends on the signedness of an object.
1403 But many programs have been written to use plain @code{char} and
1404 expect it to be signed, or expect it to be unsigned, depending on the
1405 machines they were written for.  This option, and its inverse, let you
1406 make such a program work with the opposite default.
1407
1408 The type @code{char} is always a distinct type from each of
1409 @code{signed char} or @code{unsigned char}, even though its behavior
1410 is always just like one of those two.
1411
1412 @item -fsigned-char
1413 @opindex fsigned-char
1414 Let the type @code{char} be signed, like @code{signed char}.
1415
1416 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1417 the negative form of @option{-funsigned-char}.  Likewise, the option
1418 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1419
1420 @item -fsigned-bitfields
1421 @itemx -funsigned-bitfields
1422 @itemx -fno-signed-bitfields
1423 @itemx -fno-unsigned-bitfields
1424 @opindex fsigned-bitfields
1425 @opindex funsigned-bitfields
1426 @opindex fno-signed-bitfields
1427 @opindex fno-unsigned-bitfields
1428 These options control whether a bit-field is signed or unsigned, when the
1429 declaration does not use either @code{signed} or @code{unsigned}.  By
1430 default, such a bit-field is signed, because this is consistent: the
1431 basic integer types such as @code{int} are signed types.
1432 @end table
1433
1434 @node C++ Dialect Options
1435 @section Options Controlling C++ Dialect
1436
1437 @cindex compiler options, C++
1438 @cindex C++ options, command line
1439 @cindex options, C++
1440 This section describes the command-line options that are only meaningful
1441 for C++ programs; but you can also use most of the GNU compiler options
1442 regardless of what language your program is in.  For example, you
1443 might compile a file @code{firstClass.C} like this:
1444
1445 @smallexample
1446 g++ -g -frepo -O -c firstClass.C
1447 @end smallexample
1448
1449 @noindent
1450 In this example, only @option{-frepo} is an option meant
1451 only for C++ programs; you can use the other options with any
1452 language supported by GCC@.
1453
1454 Here is a list of options that are @emph{only} for compiling C++ programs:
1455
1456 @table @gcctabopt
1457
1458 @item -fabi-version=@var{n}
1459 @opindex fabi-version
1460 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1461 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1462 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1463 the version that conforms most closely to the C++ ABI specification.
1464 Therefore, the ABI obtained using version 0 will change as ABI bugs
1465 are fixed.
1466
1467 The default is version 2.
1468
1469 @item -fno-access-control
1470 @opindex fno-access-control
1471 Turn off all access checking.  This switch is mainly useful for working
1472 around bugs in the access control code.
1473
1474 @item -fcheck-new
1475 @opindex fcheck-new
1476 Check that the pointer returned by @code{operator new} is non-null
1477 before attempting to modify the storage allocated.  This check is
1478 normally unnecessary because the C++ standard specifies that
1479 @code{operator new} will only return @code{0} if it is declared
1480 @samp{throw()}, in which case the compiler will always check the
1481 return value even without this option.  In all other cases, when
1482 @code{operator new} has a non-empty exception specification, memory
1483 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1484 @samp{new (nothrow)}.
1485
1486 @item -fconserve-space
1487 @opindex fconserve-space
1488 Put uninitialized or runtime-initialized global variables into the
1489 common segment, as C does.  This saves space in the executable at the
1490 cost of not diagnosing duplicate definitions.  If you compile with this
1491 flag and your program mysteriously crashes after @code{main()} has
1492 completed, you may have an object that is being destroyed twice because
1493 two definitions were merged.
1494
1495 This option is no longer useful on most targets, now that support has
1496 been added for putting variables into BSS without making them common.
1497
1498 @item -ffriend-injection
1499 @opindex ffriend-injection
1500 Inject friend functions into the enclosing namespace, so that they are
1501 visible outside the scope of the class in which they are declared.
1502 Friend functions were documented to work this way in the old Annotated
1503 C++ Reference Manual, and versions of G++ before 4.1 always worked
1504 that way.  However, in ISO C++ a friend function which is not declared
1505 in an enclosing scope can only be found using argument dependent
1506 lookup.  This option causes friends to be injected as they were in
1507 earlier releases.
1508
1509 This option is for compatibility, and may be removed in a future
1510 release of G++.
1511
1512 @item -fno-elide-constructors
1513 @opindex fno-elide-constructors
1514 The C++ standard allows an implementation to omit creating a temporary
1515 which is only used to initialize another object of the same type.
1516 Specifying this option disables that optimization, and forces G++ to
1517 call the copy constructor in all cases.
1518
1519 @item -fno-enforce-eh-specs
1520 @opindex fno-enforce-eh-specs
1521 Don't generate code to check for violation of exception specifications
1522 at runtime.  This option violates the C++ standard, but may be useful
1523 for reducing code size in production builds, much like defining
1524 @samp{NDEBUG}.  This does not give user code permission to throw
1525 exceptions in violation of the exception specifications; the compiler
1526 will still optimize based on the specifications, so throwing an
1527 unexpected exception will result in undefined behavior.
1528
1529 @item -ffor-scope
1530 @itemx -fno-for-scope
1531 @opindex ffor-scope
1532 @opindex fno-for-scope
1533 If @option{-ffor-scope} is specified, the scope of variables declared in
1534 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1535 as specified by the C++ standard.
1536 If @option{-fno-for-scope} is specified, the scope of variables declared in
1537 a @i{for-init-statement} extends to the end of the enclosing scope,
1538 as was the case in old versions of G++, and other (traditional)
1539 implementations of C++.
1540
1541 The default if neither flag is given to follow the standard,
1542 but to allow and give a warning for old-style code that would
1543 otherwise be invalid, or have different behavior.
1544
1545 @item -fno-gnu-keywords
1546 @opindex fno-gnu-keywords
1547 Do not recognize @code{typeof} as a keyword, so that code can use this
1548 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1549 @option{-ansi} implies @option{-fno-gnu-keywords}.
1550
1551 @item -fno-implicit-templates
1552 @opindex fno-implicit-templates
1553 Never emit code for non-inline templates which are instantiated
1554 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1555 @xref{Template Instantiation}, for more information.
1556
1557 @item -fno-implicit-inline-templates
1558 @opindex fno-implicit-inline-templates
1559 Don't emit code for implicit instantiations of inline templates, either.
1560 The default is to handle inlines differently so that compiles with and
1561 without optimization will need the same set of explicit instantiations.
1562
1563 @item -fno-implement-inlines
1564 @opindex fno-implement-inlines
1565 To save space, do not emit out-of-line copies of inline functions
1566 controlled by @samp{#pragma implementation}.  This will cause linker
1567 errors if these functions are not inlined everywhere they are called.
1568
1569 @item -fms-extensions
1570 @opindex fms-extensions
1571 Disable pedantic warnings about constructs used in MFC, such as implicit
1572 int and getting a pointer to member function via non-standard syntax.
1573
1574 @item -fno-nonansi-builtins
1575 @opindex fno-nonansi-builtins
1576 Disable built-in declarations of functions that are not mandated by
1577 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1578 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1579
1580 @item -fno-operator-names
1581 @opindex fno-operator-names
1582 Do not treat the operator name keywords @code{and}, @code{bitand},
1583 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1584 synonyms as keywords.
1585
1586 @item -fno-optional-diags
1587 @opindex fno-optional-diags
1588 Disable diagnostics that the standard says a compiler does not need to
1589 issue.  Currently, the only such diagnostic issued by G++ is the one for
1590 a name having multiple meanings within a class.
1591
1592 @item -fpermissive
1593 @opindex fpermissive
1594 Downgrade some diagnostics about nonconformant code from errors to
1595 warnings.  Thus, using @option{-fpermissive} will allow some
1596 nonconforming code to compile.
1597
1598 @item -frepo
1599 @opindex frepo
1600 Enable automatic template instantiation at link time.  This option also
1601 implies @option{-fno-implicit-templates}.  @xref{Template
1602 Instantiation}, for more information.
1603
1604 @item -fno-rtti
1605 @opindex fno-rtti
1606 Disable generation of information about every class with virtual
1607 functions for use by the C++ runtime type identification features
1608 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1609 of the language, you can save some space by using this flag.  Note that
1610 exception handling uses the same information, but it will generate it as
1611 needed. The @samp{dynamic_cast} operator can still be used for casts that
1612 do not require runtime type information, i.e. casts to @code{void *} or to
1613 unambiguous base classes.
1614
1615 @item -fstats
1616 @opindex fstats
1617 Emit statistics about front-end processing at the end of the compilation.
1618 This information is generally only useful to the G++ development team.
1619
1620 @item -ftemplate-depth-@var{n}
1621 @opindex ftemplate-depth
1622 Set the maximum instantiation depth for template classes to @var{n}.
1623 A limit on the template instantiation depth is needed to detect
1624 endless recursions during template class instantiation.  ANSI/ISO C++
1625 conforming programs must not rely on a maximum depth greater than 17.
1626
1627 @item -fno-threadsafe-statics
1628 @opindex fno-threadsafe-statics
1629 Do not emit the extra code to use the routines specified in the C++
1630 ABI for thread-safe initialization of local statics.  You can use this
1631 option to reduce code size slightly in code that doesn't need to be
1632 thread-safe.
1633
1634 @item -fuse-cxa-atexit
1635 @opindex fuse-cxa-atexit
1636 Register destructors for objects with static storage duration with the
1637 @code{__cxa_atexit} function rather than the @code{atexit} function.
1638 This option is required for fully standards-compliant handling of static
1639 destructors, but will only work if your C library supports
1640 @code{__cxa_atexit}.
1641
1642 @item -fno-use-cxa-get-exception-ptr
1643 @opindex fno-use-cxa-get-exception-ptr
1644 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1645 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1646 if the runtime routine is not available.
1647
1648 @item -fvisibility-inlines-hidden
1649 @opindex fvisibility-inlines-hidden
1650 This switch declares that the user does not attempt to compare
1651 pointers to inline methods where the addresses of the two functions
1652 were taken in different shared objects.
1653
1654 The effect of this is that GCC may, effectively, mark inline methods with
1655 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1656 appear in the export table of a DSO and do not require a PLT indirection
1657 when used within the DSO@.  Enabling this option can have a dramatic effect
1658 on load and link times of a DSO as it massively reduces the size of the
1659 dynamic export table when the library makes heavy use of templates.
1660
1661 The behavior of this switch is not quite the same as marking the
1662 methods as hidden directly, because it does not affect static variables
1663 local to the function or cause the compiler to deduce that
1664 the function is defined in only one shared object.
1665
1666 You may mark a method as having a visibility explicitly to negate the
1667 effect of the switch for that method.  For example, if you do want to
1668 compare pointers to a particular inline method, you might mark it as
1669 having default visibility.  Marking the enclosing class with explicit
1670 visibility will have no effect.
1671
1672 Explicitly instantiated inline methods are unaffected by this option
1673 as their linkage might otherwise cross a shared library boundary.
1674 @xref{Template Instantiation}.
1675
1676 @item -fno-weak
1677 @opindex fno-weak
1678 Do not use weak symbol support, even if it is provided by the linker.
1679 By default, G++ will use weak symbols if they are available.  This
1680 option exists only for testing, and should not be used by end-users;
1681 it will result in inferior code and has no benefits.  This option may
1682 be removed in a future release of G++.
1683
1684 @item -nostdinc++
1685 @opindex nostdinc++
1686 Do not search for header files in the standard directories specific to
1687 C++, but do still search the other standard directories.  (This option
1688 is used when building the C++ library.)
1689 @end table
1690
1691 In addition, these optimization, warning, and code generation options
1692 have meanings only for C++ programs:
1693
1694 @table @gcctabopt
1695 @item -fno-default-inline
1696 @opindex fno-default-inline
1697 Do not assume @samp{inline} for functions defined inside a class scope.
1698 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1699 functions will have linkage like inline functions; they just won't be
1700 inlined by default.
1701
1702 @item -Wabi @r{(C++ only)}
1703 @opindex Wabi
1704 Warn when G++ generates code that is probably not compatible with the
1705 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1706 all such cases, there are probably some cases that are not warned about,
1707 even though G++ is generating incompatible code.  There may also be
1708 cases where warnings are emitted even though the code that is generated
1709 will be compatible.
1710
1711 You should rewrite your code to avoid these warnings if you are
1712 concerned about the fact that code generated by G++ may not be binary
1713 compatible with code generated by other compilers.
1714
1715 The known incompatibilities at this point include:
1716
1717 @itemize @bullet
1718
1719 @item
1720 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1721 pack data into the same byte as a base class.  For example:
1722
1723 @smallexample
1724 struct A @{ virtual void f(); int f1 : 1; @};
1725 struct B : public A @{ int f2 : 1; @};
1726 @end smallexample
1727
1728 @noindent
1729 In this case, G++ will place @code{B::f2} into the same byte
1730 as@code{A::f1}; other compilers will not.  You can avoid this problem
1731 by explicitly padding @code{A} so that its size is a multiple of the
1732 byte size on your platform; that will cause G++ and other compilers to
1733 layout @code{B} identically.
1734
1735 @item
1736 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1737 tail padding when laying out virtual bases.  For example:
1738
1739 @smallexample
1740 struct A @{ virtual void f(); char c1; @};
1741 struct B @{ B(); char c2; @};
1742 struct C : public A, public virtual B @{@};
1743 @end smallexample
1744
1745 @noindent
1746 In this case, G++ will not place @code{B} into the tail-padding for
1747 @code{A}; other compilers will.  You can avoid this problem by
1748 explicitly padding @code{A} so that its size is a multiple of its
1749 alignment (ignoring virtual base classes); that will cause G++ and other
1750 compilers to layout @code{C} identically.
1751
1752 @item
1753 Incorrect handling of bit-fields with declared widths greater than that
1754 of their underlying types, when the bit-fields appear in a union.  For
1755 example:
1756
1757 @smallexample
1758 union U @{ int i : 4096; @};
1759 @end smallexample
1760
1761 @noindent
1762 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1763 union too small by the number of bits in an @code{int}.
1764
1765 @item
1766 Empty classes can be placed at incorrect offsets.  For example:
1767
1768 @smallexample
1769 struct A @{@};
1770
1771 struct B @{
1772   A a;
1773   virtual void f ();
1774 @};
1775
1776 struct C : public B, public A @{@};
1777 @end smallexample
1778
1779 @noindent
1780 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1781 it should be placed at offset zero.  G++ mistakenly believes that the
1782 @code{A} data member of @code{B} is already at offset zero.
1783
1784 @item
1785 Names of template functions whose types involve @code{typename} or
1786 template template parameters can be mangled incorrectly.
1787
1788 @smallexample
1789 template <typename Q>
1790 void f(typename Q::X) @{@}
1791
1792 template <template <typename> class Q>
1793 void f(typename Q<int>::X) @{@}
1794 @end smallexample
1795
1796 @noindent
1797 Instantiations of these templates may be mangled incorrectly.
1798
1799 @end itemize
1800
1801 @item -Wctor-dtor-privacy @r{(C++ only)}
1802 @opindex Wctor-dtor-privacy
1803 Warn when a class seems unusable because all the constructors or
1804 destructors in that class are private, and it has neither friends nor
1805 public static member functions.
1806
1807 @item -Wnon-virtual-dtor @r{(C++ only)}
1808 @opindex Wnon-virtual-dtor
1809 Warn when a class appears to be polymorphic, thereby requiring a virtual
1810 destructor, yet it declares a non-virtual one.  This warning is also
1811 enabled if -Weffc++ is specified.
1812
1813 @item -Wreorder @r{(C++ only)}
1814 @opindex Wreorder
1815 @cindex reordering, warning
1816 @cindex warning for reordering of member initializers
1817 Warn when the order of member initializers given in the code does not
1818 match the order in which they must be executed.  For instance:
1819
1820 @smallexample
1821 struct A @{
1822   int i;
1823   int j;
1824   A(): j (0), i (1) @{ @}
1825 @};
1826 @end smallexample
1827
1828 The compiler will rearrange the member initializers for @samp{i}
1829 and @samp{j} to match the declaration order of the members, emitting
1830 a warning to that effect.  This warning is enabled by @option{-Wall}.
1831 @end table
1832
1833 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1834
1835 @table @gcctabopt
1836 @item -Weffc++ @r{(C++ only)}
1837 @opindex Weffc++
1838 Warn about violations of the following style guidelines from Scott Meyers'
1839 @cite{Effective C++} book:
1840
1841 @itemize @bullet
1842 @item
1843 Item 11:  Define a copy constructor and an assignment operator for classes
1844 with dynamically allocated memory.
1845
1846 @item
1847 Item 12:  Prefer initialization to assignment in constructors.
1848
1849 @item
1850 Item 14:  Make destructors virtual in base classes.
1851
1852 @item
1853 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1854
1855 @item
1856 Item 23:  Don't try to return a reference when you must return an object.
1857
1858 @end itemize
1859
1860 Also warn about violations of the following style guidelines from
1861 Scott Meyers' @cite{More Effective C++} book:
1862
1863 @itemize @bullet
1864 @item
1865 Item 6:  Distinguish between prefix and postfix forms of increment and
1866 decrement operators.
1867
1868 @item
1869 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1870
1871 @end itemize
1872
1873 When selecting this option, be aware that the standard library
1874 headers do not obey all of these guidelines; use @samp{grep -v}
1875 to filter out those warnings.
1876
1877 @item -Wno-deprecated @r{(C++ only)}
1878 @opindex Wno-deprecated
1879 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1880
1881 @item -Wstrict-null-sentinel @r{(C++ only)}
1882 @opindex Wstrict-null-sentinel
1883 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1884 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1885 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1886 it is guaranteed to of the same size as a pointer.  But this use is
1887 not portable across different compilers.
1888
1889 @item -Wno-non-template-friend @r{(C++ only)}
1890 @opindex Wno-non-template-friend
1891 Disable warnings when non-templatized friend functions are declared
1892 within a template.  Since the advent of explicit template specification
1893 support in G++, if the name of the friend is an unqualified-id (i.e.,
1894 @samp{friend foo(int)}), the C++ language specification demands that the
1895 friend declare or define an ordinary, nontemplate function.  (Section
1896 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1897 could be interpreted as a particular specialization of a templatized
1898 function.  Because this non-conforming behavior is no longer the default
1899 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1900 check existing code for potential trouble spots and is on by default.
1901 This new compiler behavior can be turned off with
1902 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1903 but disables the helpful warning.
1904
1905 @item -Wold-style-cast @r{(C++ only)}
1906 @opindex Wold-style-cast
1907 Warn if an old-style (C-style) cast to a non-void type is used within
1908 a C++ program.  The new-style casts (@samp{dynamic_cast},
1909 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1910 less vulnerable to unintended effects and much easier to search for.
1911
1912 @item -Woverloaded-virtual @r{(C++ only)}
1913 @opindex Woverloaded-virtual
1914 @cindex overloaded virtual fn, warning
1915 @cindex warning for overloaded virtual fn
1916 Warn when a function declaration hides virtual functions from a
1917 base class.  For example, in:
1918
1919 @smallexample
1920 struct A @{
1921   virtual void f();
1922 @};
1923
1924 struct B: public A @{
1925   void f(int);
1926 @};
1927 @end smallexample
1928
1929 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1930 like:
1931
1932 @smallexample
1933 B* b;
1934 b->f();
1935 @end smallexample
1936
1937 will fail to compile.
1938
1939 @item -Wno-pmf-conversions @r{(C++ only)}
1940 @opindex Wno-pmf-conversions
1941 Disable the diagnostic for converting a bound pointer to member function
1942 to a plain pointer.
1943
1944 @item -Wsign-promo @r{(C++ only)}
1945 @opindex Wsign-promo
1946 Warn when overload resolution chooses a promotion from unsigned or
1947 enumerated type to a signed type, over a conversion to an unsigned type of
1948 the same size.  Previous versions of G++ would try to preserve
1949 unsignedness, but the standard mandates the current behavior.
1950
1951 @smallexample
1952 struct A @{
1953   operator int ();
1954   A& operator = (int);
1955 @};
1956
1957 main ()
1958 @{
1959   A a,b;
1960   a = b;
1961 @}
1962 @end smallexample
1963
1964 In this example, G++ will synthesize a default @samp{A& operator =
1965 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1966 @end table
1967
1968 @node Objective-C and Objective-C++ Dialect Options
1969 @section Options Controlling Objective-C and Objective-C++ Dialects
1970
1971 @cindex compiler options, Objective-C and Objective-C++
1972 @cindex Objective-C and Objective-C++ options, command line
1973 @cindex options, Objective-C and Objective-C++
1974 (NOTE: This manual does not describe the Objective-C and Objective-C++
1975 languages themselves.  See @xref{Standards,,Language Standards
1976 Supported by GCC}, for references.)
1977
1978 This section describes the command-line options that are only meaningful
1979 for Objective-C and Objective-C++ programs, but you can also use most of
1980 the language-independent GNU compiler options.
1981 For example, you might compile a file @code{some_class.m} like this:
1982
1983 @smallexample
1984 gcc -g -fgnu-runtime -O -c some_class.m
1985 @end smallexample
1986
1987 @noindent
1988 In this example, @option{-fgnu-runtime} is an option meant only for
1989 Objective-C and Objective-C++ programs; you can use the other options with
1990 any language supported by GCC@.
1991
1992 Note that since Objective-C is an extension of the C language, Objective-C
1993 compilations may also use options specific to the C front-end (e.g.,
1994 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1995 C++-specific options (e.g., @option{-Wabi}).
1996
1997 Here is a list of options that are @emph{only} for compiling Objective-C
1998 and Objective-C++ programs:
1999
2000 @table @gcctabopt
2001 @item -fconstant-string-class=@var{class-name}
2002 @opindex fconstant-string-class
2003 Use @var{class-name} as the name of the class to instantiate for each
2004 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2005 class name is @code{NXConstantString} if the GNU runtime is being used, and
2006 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2007 @option{-fconstant-cfstrings} option, if also present, will override the
2008 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2009 to be laid out as constant CoreFoundation strings.
2010
2011 @item -fgnu-runtime
2012 @opindex fgnu-runtime
2013 Generate object code compatible with the standard GNU Objective-C
2014 runtime.  This is the default for most types of systems.
2015
2016 @item -fnext-runtime
2017 @opindex fnext-runtime
2018 Generate output compatible with the NeXT runtime.  This is the default
2019 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2020 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2021 used.
2022
2023 @item -fno-nil-receivers
2024 @opindex fno-nil-receivers
2025 Assume that all Objective-C message dispatches (e.g.,
2026 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2027 is not @code{nil}.  This allows for more efficient entry points in the runtime
2028 to be used.  Currently, this option is only available in conjunction with
2029 the NeXT runtime on Mac OS X 10.3 and later.
2030
2031 @item -fobjc-call-cxx-cdtors
2032 @opindex fobjc-call-cxx-cdtors
2033 For each Objective-C class, check if any of its instance variables is a
2034 C++ object with a non-trivial default constructor.  If so, synthesize a
2035 special @code{- (id) .cxx_construct} instance method that will run
2036 non-trivial default constructors on any such instance variables, in order,
2037 and then return @code{self}.  Similarly, check if any instance variable
2038 is a C++ object with a non-trivial destructor, and if so, synthesize a
2039 special @code{- (void) .cxx_destruct} method that will run
2040 all such default destructors, in reverse order.
2041
2042 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2043 thusly generated will only operate on instance variables declared in the
2044 current Objective-C class, and not those inherited from superclasses.  It
2045 is the responsibility of the Objective-C runtime to invoke all such methods
2046 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2047 will be invoked by the runtime immediately after a new object
2048 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2049 be invoked immediately before the runtime deallocates an object instance.
2050
2051 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2052 support for invoking the @code{- (id) .cxx_construct} and
2053 @code{- (void) .cxx_destruct} methods.
2054
2055 @item -fobjc-direct-dispatch
2056 @opindex fobjc-direct-dispatch
2057 Allow fast jumps to the message dispatcher.  On Darwin this is
2058 accomplished via the comm page.
2059
2060 @item -fobjc-exceptions
2061 @opindex fobjc-exceptions
2062 Enable syntactic support for structured exception handling in Objective-C,
2063 similar to what is offered by C++ and Java.  This option is
2064 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2065 earlier.
2066
2067 @smallexample
2068   @@try @{
2069     @dots{}
2070        @@throw expr;
2071     @dots{}
2072   @}
2073   @@catch (AnObjCClass *exc) @{
2074     @dots{}
2075       @@throw expr;
2076     @dots{}
2077       @@throw;
2078     @dots{}
2079   @}
2080   @@catch (AnotherClass *exc) @{
2081     @dots{}
2082   @}
2083   @@catch (id allOthers) @{
2084     @dots{}
2085   @}
2086   @@finally @{
2087     @dots{}
2088       @@throw expr;
2089     @dots{}
2090   @}
2091 @end smallexample
2092
2093 The @code{@@throw} statement may appear anywhere in an Objective-C or
2094 Objective-C++ program; when used inside of a @code{@@catch} block, the
2095 @code{@@throw} may appear without an argument (as shown above), in which case
2096 the object caught by the @code{@@catch} will be rethrown.
2097
2098 Note that only (pointers to) Objective-C objects may be thrown and
2099 caught using this scheme.  When an object is thrown, it will be caught
2100 by the nearest @code{@@catch} clause capable of handling objects of that type,
2101 analogously to how @code{catch} blocks work in C++ and Java.  A
2102 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2103 any and all Objective-C exceptions not caught by previous @code{@@catch}
2104 clauses (if any).
2105
2106 The @code{@@finally} clause, if present, will be executed upon exit from the
2107 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2108 regardless of whether any exceptions are thrown, caught or rethrown
2109 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2110 of the @code{finally} clause in Java.
2111
2112 There are several caveats to using the new exception mechanism:
2113
2114 @itemize @bullet
2115 @item
2116 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2117 idioms provided by the @code{NSException} class, the new
2118 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2119 systems, due to additional functionality needed in the (NeXT) Objective-C
2120 runtime.
2121
2122 @item
2123 As mentioned above, the new exceptions do not support handling
2124 types other than Objective-C objects.   Furthermore, when used from
2125 Objective-C++, the Objective-C exception model does not interoperate with C++
2126 exceptions at this time.  This means you cannot @code{@@throw} an exception
2127 from Objective-C and @code{catch} it in C++, or vice versa
2128 (i.e., @code{throw @dots{} @@catch}).
2129 @end itemize
2130
2131 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2132 blocks for thread-safe execution:
2133
2134 @smallexample
2135   @@synchronized (ObjCClass *guard) @{
2136     @dots{}
2137   @}
2138 @end smallexample
2139
2140 Upon entering the @code{@@synchronized} block, a thread of execution shall
2141 first check whether a lock has been placed on the corresponding @code{guard}
2142 object by another thread.  If it has, the current thread shall wait until
2143 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2144 the current thread will place its own lock on it, execute the code contained in
2145 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2146 making @code{guard} available to other threads).
2147
2148 Unlike Java, Objective-C does not allow for entire methods to be marked
2149 @code{@@synchronized}.  Note that throwing exceptions out of
2150 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2151 to be unlocked properly.
2152
2153 @item -fobjc-gc
2154 @opindex fobjc-gc
2155 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2156
2157 @item -freplace-objc-classes
2158 @opindex freplace-objc-classes
2159 Emit a special marker instructing @command{ld(1)} not to statically link in
2160 the resulting object file, and allow @command{dyld(1)} to load it in at
2161 run time instead.  This is used in conjunction with the Fix-and-Continue
2162 debugging mode, where the object file in question may be recompiled and
2163 dynamically reloaded in the course of program execution, without the need
2164 to restart the program itself.  Currently, Fix-and-Continue functionality
2165 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2166 and later.
2167
2168 @item -fzero-link
2169 @opindex fzero-link
2170 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2171 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2172 compile time) with static class references that get initialized at load time,
2173 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2174 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2175 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2176 for individual class implementations to be modified during program execution.
2177
2178 @item -gen-decls
2179 @opindex gen-decls
2180 Dump interface declarations for all classes seen in the source file to a
2181 file named @file{@var{sourcename}.decl}.
2182
2183 @item -Wassign-intercept
2184 @opindex Wassign-intercept
2185 Warn whenever an Objective-C assignment is being intercepted by the
2186 garbage collector.
2187
2188 @item -Wno-protocol
2189 @opindex Wno-protocol
2190 If a class is declared to implement a protocol, a warning is issued for
2191 every method in the protocol that is not implemented by the class.  The
2192 default behavior is to issue a warning for every method not explicitly
2193 implemented in the class, even if a method implementation is inherited
2194 from the superclass.  If you use the @option{-Wno-protocol} option, then
2195 methods inherited from the superclass are considered to be implemented,
2196 and no warning is issued for them.
2197
2198 @item -Wselector
2199 @opindex Wselector
2200 Warn if multiple methods of different types for the same selector are
2201 found during compilation.  The check is performed on the list of methods
2202 in the final stage of compilation.  Additionally, a check is performed
2203 for each selector appearing in a @code{@@selector(@dots{})}
2204 expression, and a corresponding method for that selector has been found
2205 during compilation.  Because these checks scan the method table only at
2206 the end of compilation, these warnings are not produced if the final
2207 stage of compilation is not reached, for example because an error is
2208 found during compilation, or because the @option{-fsyntax-only} option is
2209 being used.
2210
2211 @item -Wstrict-selector-match
2212 @opindex Wstrict-selector-match
2213 Warn if multiple methods with differing argument and/or return types are
2214 found for a given selector when attempting to send a message using this
2215 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2216 is off (which is the default behavior), the compiler will omit such warnings
2217 if any differences found are confined to types which share the same size
2218 and alignment.
2219
2220 @item -Wundeclared-selector
2221 @opindex Wundeclared-selector
2222 Warn if a @code{@@selector(@dots{})} expression referring to an
2223 undeclared selector is found.  A selector is considered undeclared if no
2224 method with that name has been declared before the
2225 @code{@@selector(@dots{})} expression, either explicitly in an
2226 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2227 an @code{@@implementation} section.  This option always performs its
2228 checks as soon as a @code{@@selector(@dots{})} expression is found,
2229 while @option{-Wselector} only performs its checks in the final stage of
2230 compilation.  This also enforces the coding style convention
2231 that methods and selectors must be declared before being used.
2232
2233 @item -print-objc-runtime-info
2234 @opindex print-objc-runtime-info
2235 Generate C header describing the largest structure that is passed by
2236 value, if any.
2237
2238 @end table
2239
2240 @node Language Independent Options
2241 @section Options to Control Diagnostic Messages Formatting
2242 @cindex options to control diagnostics formatting
2243 @cindex diagnostic messages
2244 @cindex message formatting
2245
2246 Traditionally, diagnostic messages have been formatted irrespective of
2247 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2248 below can be used to control the diagnostic messages formatting
2249 algorithm, e.g.@: how many characters per line, how often source location
2250 information should be reported.  Right now, only the C++ front end can
2251 honor these options.  However it is expected, in the near future, that
2252 the remaining front ends would be able to digest them correctly.
2253
2254 @table @gcctabopt
2255 @item -fmessage-length=@var{n}
2256 @opindex fmessage-length
2257 Try to format error messages so that they fit on lines of about @var{n}
2258 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2259 the front ends supported by GCC@.  If @var{n} is zero, then no
2260 line-wrapping will be done; each error message will appear on a single
2261 line.
2262
2263 @opindex fdiagnostics-show-location
2264 @item -fdiagnostics-show-location=once
2265 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2266 reporter to emit @emph{once} source location information; that is, in
2267 case the message is too long to fit on a single physical line and has to
2268 be wrapped, the source location won't be emitted (as prefix) again,
2269 over and over, in subsequent continuation lines.  This is the default
2270 behavior.
2271
2272 @item -fdiagnostics-show-location=every-line
2273 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2274 messages reporter to emit the same source location information (as
2275 prefix) for physical lines that result from the process of breaking
2276 a message which is too long to fit on a single line.
2277
2278 @item -fdiagnostics-show-option
2279 @opindex fdiagnostics-show-option
2280 This option instructs the diagnostic machinery to add text to each
2281 diagnostic emitted, which indicates which command line option directly
2282 controls that diagnostic, when such an option is known to the
2283 diagnostic machinery.
2284
2285 @item -Wcoverage-mismatch
2286 @opindex Wcoverage-mismatch
2287 Warn if feedback profiles do not match when using the
2288 @option{-fprofile-use} option.
2289 If a source file was changed between @option{-fprofile-gen} and
2290 @option{-fprofile-use}, the files with the profile feedback can fail
2291 to match the source file and GCC can not use the profile feedback
2292 information.  By default, GCC emits an error message in this case.
2293 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2294 error.  GCC does not use appropriate feedback profiles, so using this
2295 option can result in poorly optimized code.  This option is useful
2296 only in the case of very minor changes such as bug fixes to an
2297 existing code-base.
2298
2299 @end table
2300
2301 @node Warning Options
2302 @section Options to Request or Suppress Warnings
2303 @cindex options to control warnings
2304 @cindex warning messages
2305 @cindex messages, warning
2306 @cindex suppressing warnings
2307
2308 Warnings are diagnostic messages that report constructions which
2309 are not inherently erroneous but which are risky or suggest there
2310 may have been an error.
2311
2312 You can request many specific warnings with options beginning @samp{-W},
2313 for example @option{-Wimplicit} to request warnings on implicit
2314 declarations.  Each of these specific warning options also has a
2315 negative form beginning @samp{-Wno-} to turn off warnings;
2316 for example, @option{-Wno-implicit}.  This manual lists only one of the
2317 two forms, whichever is not the default.
2318
2319 The following options control the amount and kinds of warnings produced
2320 by GCC; for further, language-specific options also refer to
2321 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2322 Options}.
2323
2324 @table @gcctabopt
2325 @cindex syntax checking
2326 @item -fsyntax-only
2327 @opindex fsyntax-only
2328 Check the code for syntax errors, but don't do anything beyond that.
2329
2330 @item -pedantic
2331 @opindex pedantic
2332 Issue all the warnings demanded by strict ISO C and ISO C++;
2333 reject all programs that use forbidden extensions, and some other
2334 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2335 version of the ISO C standard specified by any @option{-std} option used.
2336
2337 Valid ISO C and ISO C++ programs should compile properly with or without
2338 this option (though a rare few will require @option{-ansi} or a
2339 @option{-std} option specifying the required version of ISO C)@.  However,
2340 without this option, certain GNU extensions and traditional C and C++
2341 features are supported as well.  With this option, they are rejected.
2342
2343 @option{-pedantic} does not cause warning messages for use of the
2344 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2345 warnings are also disabled in the expression that follows
2346 @code{__extension__}.  However, only system header files should use
2347 these escape routes; application programs should avoid them.
2348 @xref{Alternate Keywords}.
2349
2350 Some users try to use @option{-pedantic} to check programs for strict ISO
2351 C conformance.  They soon find that it does not do quite what they want:
2352 it finds some non-ISO practices, but not all---only those for which
2353 ISO C @emph{requires} a diagnostic, and some others for which
2354 diagnostics have been added.
2355
2356 A feature to report any failure to conform to ISO C might be useful in
2357 some instances, but would require considerable additional work and would
2358 be quite different from @option{-pedantic}.  We don't have plans to
2359 support such a feature in the near future.
2360
2361 Where the standard specified with @option{-std} represents a GNU
2362 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2363 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2364 extended dialect is based.  Warnings from @option{-pedantic} are given
2365 where they are required by the base standard.  (It would not make sense
2366 for such warnings to be given only for features not in the specified GNU
2367 C dialect, since by definition the GNU dialects of C include all
2368 features the compiler supports with the given option, and there would be
2369 nothing to warn about.)
2370
2371 @item -pedantic-errors
2372 @opindex pedantic-errors
2373 Like @option{-pedantic}, except that errors are produced rather than
2374 warnings.
2375
2376 @item -w
2377 @opindex w
2378 Inhibit all warning messages.
2379
2380 @item -Wno-import
2381 @opindex Wno-import
2382 Inhibit warning messages about the use of @samp{#import}.
2383
2384 @item -Wchar-subscripts
2385 @opindex Wchar-subscripts
2386 Warn if an array subscript has type @code{char}.  This is a common cause
2387 of error, as programmers often forget that this type is signed on some
2388 machines.
2389 This warning is enabled by @option{-Wall}.
2390
2391 @item -Wcomment
2392 @opindex Wcomment
2393 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2394 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2395 This warning is enabled by @option{-Wall}.
2396
2397 @item -Wfatal-errors
2398 @opindex Wfatal-errors
2399 This option causes the compiler to abort compilation on the first error
2400 occurred rather than trying to keep going and printing further error
2401 messages.
2402
2403 @item -Wformat
2404 @opindex Wformat
2405 @opindex ffreestanding
2406 @opindex fno-builtin
2407 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2408 the arguments supplied have types appropriate to the format string
2409 specified, and that the conversions specified in the format string make
2410 sense.  This includes standard functions, and others specified by format
2411 attributes (@pxref{Function Attributes}), in the @code{printf},
2412 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2413 not in the C standard) families (or other target-specific families).
2414 Which functions are checked without format attributes having been
2415 specified depends on the standard version selected, and such checks of
2416 functions without the attribute specified are disabled by
2417 @option{-ffreestanding} or @option{-fno-builtin}.
2418
2419 The formats are checked against the format features supported by GNU
2420 libc version 2.2.  These include all ISO C90 and C99 features, as well
2421 as features from the Single Unix Specification and some BSD and GNU
2422 extensions.  Other library implementations may not support all these
2423 features; GCC does not support warning about features that go beyond a
2424 particular library's limitations.  However, if @option{-pedantic} is used
2425 with @option{-Wformat}, warnings will be given about format features not
2426 in the selected standard version (but not for @code{strfmon} formats,
2427 since those are not in any version of the C standard).  @xref{C Dialect
2428 Options,,Options Controlling C Dialect}.
2429
2430 Since @option{-Wformat} also checks for null format arguments for
2431 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2432
2433 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2434 aspects of format checking, the options @option{-Wformat-y2k},
2435 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2436 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2437 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2438
2439 @item -Wformat-y2k
2440 @opindex Wformat-y2k
2441 If @option{-Wformat} is specified, also warn about @code{strftime}
2442 formats which may yield only a two-digit year.
2443
2444 @item -Wno-format-extra-args
2445 @opindex Wno-format-extra-args
2446 If @option{-Wformat} is specified, do not warn about excess arguments to a
2447 @code{printf} or @code{scanf} format function.  The C standard specifies
2448 that such arguments are ignored.
2449
2450 Where the unused arguments lie between used arguments that are
2451 specified with @samp{$} operand number specifications, normally
2452 warnings are still given, since the implementation could not know what
2453 type to pass to @code{va_arg} to skip the unused arguments.  However,
2454 in the case of @code{scanf} formats, this option will suppress the
2455 warning if the unused arguments are all pointers, since the Single
2456 Unix Specification says that such unused arguments are allowed.
2457
2458 @item -Wno-format-zero-length
2459 @opindex Wno-format-zero-length
2460 If @option{-Wformat} is specified, do not warn about zero-length formats.
2461 The C standard specifies that zero-length formats are allowed.
2462
2463 @item -Wformat-nonliteral
2464 @opindex Wformat-nonliteral
2465 If @option{-Wformat} is specified, also warn if the format string is not a
2466 string literal and so cannot be checked, unless the format function
2467 takes its format arguments as a @code{va_list}.
2468
2469 @item -Wformat-security
2470 @opindex Wformat-security
2471 If @option{-Wformat} is specified, also warn about uses of format
2472 functions that represent possible security problems.  At present, this
2473 warns about calls to @code{printf} and @code{scanf} functions where the
2474 format string is not a string literal and there are no format arguments,
2475 as in @code{printf (foo);}.  This may be a security hole if the format
2476 string came from untrusted input and contains @samp{%n}.  (This is
2477 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2478 in future warnings may be added to @option{-Wformat-security} that are not
2479 included in @option{-Wformat-nonliteral}.)
2480
2481 @item -Wformat=2
2482 @opindex Wformat=2
2483 Enable @option{-Wformat} plus format checks not included in
2484 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2485 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2486
2487 @item -Wnonnull
2488 @opindex Wnonnull
2489 Warn about passing a null pointer for arguments marked as
2490 requiring a non-null value by the @code{nonnull} function attribute.
2491
2492 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2493 can be disabled with the @option{-Wno-nonnull} option.
2494
2495 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2496 @opindex Winit-self
2497 Warn about uninitialized variables which are initialized with themselves.
2498 Note this option can only be used with the @option{-Wuninitialized} option,
2499 which in turn only works with @option{-O1} and above.
2500
2501 For example, GCC will warn about @code{i} being uninitialized in the
2502 following snippet only when @option{-Winit-self} has been specified:
2503 @smallexample
2504 @group
2505 int f()
2506 @{
2507   int i = i;
2508   return i;
2509 @}
2510 @end group
2511 @end smallexample
2512
2513 @item -Wimplicit-int
2514 @opindex Wimplicit-int
2515 Warn when a declaration does not specify a type.
2516 This warning is enabled by @option{-Wall}.
2517
2518 @item -Wimplicit-function-declaration
2519 @itemx -Werror-implicit-function-declaration
2520 @opindex Wimplicit-function-declaration
2521 @opindex Werror-implicit-function-declaration
2522 Give a warning (or error) whenever a function is used before being
2523 declared.  The form @option{-Wno-error-implicit-function-declaration}
2524 is not supported.
2525 This warning is enabled by @option{-Wall} (as a warning, not an error).
2526
2527 @item -Wimplicit
2528 @opindex Wimplicit
2529 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2530 This warning is enabled by @option{-Wall}.
2531
2532 @item -Wmain
2533 @opindex Wmain
2534 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2535 function with external linkage, returning int, taking either zero
2536 arguments, two, or three arguments of appropriate types.
2537 This warning is enabled by @option{-Wall}.
2538
2539 @item -Wmissing-braces
2540 @opindex Wmissing-braces
2541 Warn if an aggregate or union initializer is not fully bracketed.  In
2542 the following example, the initializer for @samp{a} is not fully
2543 bracketed, but that for @samp{b} is fully bracketed.
2544
2545 @smallexample
2546 int a[2][2] = @{ 0, 1, 2, 3 @};
2547 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2548 @end smallexample
2549
2550 This warning is enabled by @option{-Wall}.
2551
2552 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2553 @opindex Wmissing-include-dirs
2554 Warn if a user-supplied include directory does not exist.
2555
2556 @item -Wparentheses
2557 @opindex Wparentheses
2558 Warn if parentheses are omitted in certain contexts, such
2559 as when there is an assignment in a context where a truth value
2560 is expected, or when operators are nested whose precedence people
2561 often get confused about.
2562
2563 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2564 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2565 interpretation from that of ordinary mathematical notation.
2566
2567 Also warn about constructions where there may be confusion to which
2568 @code{if} statement an @code{else} branch belongs.  Here is an example of
2569 such a case:
2570
2571 @smallexample
2572 @group
2573 @{
2574   if (a)
2575     if (b)
2576       foo ();
2577   else
2578     bar ();
2579 @}
2580 @end group
2581 @end smallexample
2582
2583 In C/C++, every @code{else} branch belongs to the innermost possible
2584 @code{if} statement, which in this example is @code{if (b)}.  This is
2585 often not what the programmer expected, as illustrated in the above
2586 example by indentation the programmer chose.  When there is the
2587 potential for this confusion, GCC will issue a warning when this flag
2588 is specified.  To eliminate the warning, add explicit braces around
2589 the innermost @code{if} statement so there is no way the @code{else}
2590 could belong to the enclosing @code{if}.  The resulting code would
2591 look like this:
2592
2593 @smallexample
2594 @group
2595 @{
2596   if (a)
2597     @{
2598       if (b)
2599         foo ();
2600       else
2601         bar ();
2602     @}
2603 @}
2604 @end group
2605 @end smallexample
2606
2607 This warning is enabled by @option{-Wall}.
2608
2609 @item -Wsequence-point
2610 @opindex Wsequence-point
2611 Warn about code that may have undefined semantics because of violations
2612 of sequence point rules in the C and C++ standards.
2613
2614 The C and C++ standards defines the order in which expressions in a C/C++
2615 program are evaluated in terms of @dfn{sequence points}, which represent
2616 a partial ordering between the execution of parts of the program: those
2617 executed before the sequence point, and those executed after it.  These
2618 occur after the evaluation of a full expression (one which is not part
2619 of a larger expression), after the evaluation of the first operand of a
2620 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2621 function is called (but after the evaluation of its arguments and the
2622 expression denoting the called function), and in certain other places.
2623 Other than as expressed by the sequence point rules, the order of
2624 evaluation of subexpressions of an expression is not specified.  All
2625 these rules describe only a partial order rather than a total order,
2626 since, for example, if two functions are called within one expression
2627 with no sequence point between them, the order in which the functions
2628 are called is not specified.  However, the standards committee have
2629 ruled that function calls do not overlap.
2630
2631 It is not specified when between sequence points modifications to the
2632 values of objects take effect.  Programs whose behavior depends on this
2633 have undefined behavior; the C and C++ standards specify that ``Between
2634 the previous and next sequence point an object shall have its stored
2635 value modified at most once by the evaluation of an expression.  
2636 Furthermore, the prior value shall be read only to determine the value
2637 to be stored.''.  If a program breaks these rules, the results on any
2638 particular implementation are entirely unpredictable.
2639
2640 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2641 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2642 diagnosed by this option, and it may give an occasional false positive
2643 result, but in general it has been found fairly effective at detecting
2644 this sort of problem in programs.
2645
2646 The standard is worded confusingly, therefore there is some debate
2647 over the precise meaning of the sequence point rules in subtle cases.
2648 Links to discussions of the problem, including proposed formal
2649 definitions, may be found on the GCC readings page, at
2650 @w{@uref{http://gcc.gnu.org/readings.html}}.
2651
2652 This warning is enabled by @option{-Wall} for C and C++.
2653
2654 @item -Wreturn-type
2655 @opindex Wreturn-type
2656 Warn whenever a function is defined with a return-type that defaults to
2657 @code{int}.  Also warn about any @code{return} statement with no
2658 return-value in a function whose return-type is not @code{void}.
2659
2660 Also warn if the return type of a function has a type qualifier
2661 such as @code{const}.  For ISO C such a type qualifier has no effect,
2662 since the value returned by a function is not an lvalue.
2663 For C++, the warning is only emitted for scalar types or @code{void}.
2664 ISO C prohibits qualified @code{void} return types on function
2665 definitions, so such return types always receive a warning
2666 even without this option.
2667
2668 For C++, a function without return type always produces a diagnostic
2669 message, even when @option{-Wno-return-type} is specified.  The only
2670 exceptions are @samp{main} and functions defined in system headers.
2671
2672 This warning is enabled by @option{-Wall}.
2673
2674 @item -Wswitch
2675 @opindex Wswitch
2676 Warn whenever a @code{switch} statement has an index of enumerated type
2677 and lacks a @code{case} for one or more of the named codes of that
2678 enumeration.  (The presence of a @code{default} label prevents this
2679 warning.)  @code{case} labels outside the enumeration range also
2680 provoke warnings when this option is used.
2681 This warning is enabled by @option{-Wall}.
2682
2683 @item -Wswitch-default
2684 @opindex Wswitch-switch
2685 Warn whenever a @code{switch} statement does not have a @code{default}
2686 case.
2687
2688 @item -Wswitch-enum
2689 @opindex Wswitch-enum
2690 Warn whenever a @code{switch} statement has an index of enumerated type
2691 and lacks a @code{case} for one or more of the named codes of that
2692 enumeration.  @code{case} labels outside the enumeration range also
2693 provoke warnings when this option is used.
2694
2695 @item -Wtrigraphs
2696 @opindex Wtrigraphs
2697 Warn if any trigraphs are encountered that might change the meaning of
2698 the program (trigraphs within comments are not warned about).
2699 This warning is enabled by @option{-Wall}.
2700
2701 @item -Wunused-function
2702 @opindex Wunused-function
2703 Warn whenever a static function is declared but not defined or a
2704 non-inline static function is unused.
2705 This warning is enabled by @option{-Wall}.
2706
2707 @item -Wunused-label
2708 @opindex Wunused-label
2709 Warn whenever a label is declared but not used.
2710 This warning is enabled by @option{-Wall}.
2711
2712 To suppress this warning use the @samp{unused} attribute
2713 (@pxref{Variable Attributes}).
2714
2715 @item -Wunused-parameter
2716 @opindex Wunused-parameter
2717 Warn whenever a function parameter is unused aside from its declaration.
2718
2719 To suppress this warning use the @samp{unused} attribute
2720 (@pxref{Variable Attributes}).
2721
2722 @item -Wunused-variable
2723 @opindex Wunused-variable
2724 Warn whenever a local variable or non-constant static variable is unused
2725 aside from its declaration.
2726 This warning is enabled by @option{-Wall}.
2727
2728 To suppress this warning use the @samp{unused} attribute
2729 (@pxref{Variable Attributes}).
2730
2731 @item -Wunused-value
2732 @opindex Wunused-value
2733 Warn whenever a statement computes a result that is explicitly not
2734 used. To suppress this warning cast the unused expression to
2735 @samp{void}. This includes an expression-statement or the left-hand
2736 side of a comma expression that contains no side effects. For example,
2737 an expression such as @samp{x[i,j]} will cause a warning, while
2738 @samp{x[(void)i,j]} will not.
2739
2740 This warning is enabled by @option{-Wall}.
2741
2742 @item -Wunused
2743 @opindex Wunused
2744 All the above @option{-Wunused} options combined.
2745
2746 In order to get a warning about an unused function parameter, you must
2747 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2748 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2749
2750 @item -Wuninitialized
2751 @opindex Wuninitialized
2752 Warn if an automatic variable is used without first being initialized or
2753 if a variable may be clobbered by a @code{setjmp} call.
2754
2755 These warnings are possible only in optimizing compilation,
2756 because they require data flow information that is computed only
2757 when optimizing.  If you do not specify @option{-O}, you will not get 
2758 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2759 requiring @option{-O}.
2760
2761 If you want to warn about code which uses the uninitialized value of the
2762 variable in its own initializer, use the @option{-Winit-self} option.
2763
2764 These warnings occur for individual uninitialized or clobbered
2765 elements of structure, union or array variables as well as for
2766 variables which are uninitialized or clobbered as a whole.  They do
2767 not occur for variables or elements declared @code{volatile}.  Because
2768 these warnings depend on optimization, the exact variables or elements
2769 for which there are warnings will depend on the precise optimization
2770 options and version of GCC used.
2771
2772 Note that there may be no warning about a variable that is used only
2773 to compute a value that itself is never used, because such
2774 computations may be deleted by data flow analysis before the warnings
2775 are printed.
2776
2777 These warnings are made optional because GCC is not smart
2778 enough to see all the reasons why the code might be correct
2779 despite appearing to have an error.  Here is one example of how
2780 this can happen:
2781
2782 @smallexample
2783 @group
2784 @{
2785   int x;
2786   switch (y)
2787     @{
2788     case 1: x = 1;
2789       break;
2790     case 2: x = 4;
2791       break;
2792     case 3: x = 5;
2793     @}
2794   foo (x);
2795 @}
2796 @end group
2797 @end smallexample
2798
2799 @noindent
2800 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2801 always initialized, but GCC doesn't know this.  Here is
2802 another common case:
2803
2804 @smallexample
2805 @{
2806   int save_y;
2807   if (change_y) save_y = y, y = new_y;
2808   @dots{}
2809   if (change_y) y = save_y;
2810 @}
2811 @end smallexample
2812
2813 @noindent
2814 This has no bug because @code{save_y} is used only if it is set.
2815
2816 @cindex @code{longjmp} warnings
2817 This option also warns when a non-volatile automatic variable might be
2818 changed by a call to @code{longjmp}.  These warnings as well are possible
2819 only in optimizing compilation.
2820
2821 The compiler sees only the calls to @code{setjmp}.  It cannot know
2822 where @code{longjmp} will be called; in fact, a signal handler could
2823 call it at any point in the code.  As a result, you may get a warning
2824 even when there is in fact no problem because @code{longjmp} cannot
2825 in fact be called at the place which would cause a problem.
2826
2827 Some spurious warnings can be avoided if you declare all the functions
2828 you use that never return as @code{noreturn}.  @xref{Function
2829 Attributes}.
2830
2831 This warning is enabled by @option{-Wall}.
2832
2833 @item -Wunknown-pragmas
2834 @opindex Wunknown-pragmas
2835 @cindex warning for unknown pragmas
2836 @cindex unknown pragmas, warning
2837 @cindex pragmas, warning of unknown
2838 Warn when a #pragma directive is encountered which is not understood by
2839 GCC@.  If this command line option is used, warnings will even be issued
2840 for unknown pragmas in system header files.  This is not the case if
2841 the warnings were only enabled by the @option{-Wall} command line option.
2842
2843 @item -Wno-pragmas
2844 @opindex Wno-pragmas
2845 @opindex Wpragmas
2846 Do not warn about misuses of pragmas, such as incorrect parameters,
2847 invalid syntax, or conflicts between pragmas.  See also
2848 @samp{-Wunknown-pragmas}.
2849
2850 @item -Wstrict-aliasing
2851 @opindex Wstrict-aliasing
2852 This option is only active when @option{-fstrict-aliasing} is active.
2853 It warns about code which might break the strict aliasing rules that the
2854 compiler is using for optimization.  The warning does not catch all
2855 cases, but does attempt to catch the more common pitfalls.  It is
2856 included in @option{-Wall}.
2857
2858 @item -Wstrict-aliasing=2
2859 @opindex Wstrict-aliasing=2
2860 This option is only active when @option{-fstrict-aliasing} is active.
2861 It warns about code which might break the strict aliasing rules that the
2862 compiler is using for optimization.  This warning catches more cases than
2863 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2864 cases that are safe.
2865
2866 @item -Warray-bounds
2867 @opindex Wno-array-bounds
2868 @opindex Warray-bounds
2869 This option is only active when @option{-ftree-vrp} is active
2870 (default for -O2 and above). It warns about subscripts to arrays
2871 that are always out of bounds. This warning is enabled by @option{-Wall}.
2872
2873 @item -Wall
2874 @opindex Wall
2875 All of the above @samp{-W} options combined.  This enables all the
2876 warnings about constructions that some users consider questionable, and
2877 that are easy to avoid (or modify to prevent the warning), even in
2878 conjunction with macros.  This also enables some language-specific
2879 warnings described in @ref{C++ Dialect Options} and
2880 @ref{Objective-C and Objective-C++ Dialect Options}.
2881 @end table
2882
2883 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2884 Some of them warn about constructions that users generally do not
2885 consider questionable, but which occasionally you might wish to check
2886 for; others warn about constructions that are necessary or hard to avoid
2887 in some cases, and there is no simple way to modify the code to suppress
2888 the warning.
2889
2890 @table @gcctabopt
2891 @item -Wextra
2892 @opindex W
2893 @opindex Wextra
2894 (This option used to be called @option{-W}.  The older name is still
2895 supported, but the newer name is more descriptive.)  Print extra warning
2896 messages for these events:
2897
2898 @itemize @bullet
2899 @item
2900 A function can return either with or without a value.  (Falling
2901 off the end of the function body is considered returning without
2902 a value.)  For example, this function would evoke such a
2903 warning:
2904
2905 @smallexample
2906 @group
2907 foo (a)
2908 @{
2909   if (a > 0)
2910     return a;
2911 @}
2912 @end group
2913 @end smallexample
2914
2915 @item
2916 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2917
2918 @item @r{(C only)}
2919 Storage-class specifiers like @code{static} are not the first things
2920 in a declaration.  According to the C Standard, this usage is
2921 obsolescent.  This warning can be independently controlled by
2922 @option{-Wold-style-declaration}.
2923
2924 @item
2925 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2926 arguments.
2927
2928 @item
2929 A comparison between signed and unsigned values could produce an
2930 incorrect result when the signed value is converted to unsigned.
2931 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2932
2933 @item
2934 An aggregate has an initializer which does not initialize all members.
2935 This warning can be independently controlled by
2936 @option{-Wmissing-field-initializers}.
2937
2938 @item
2939 An initialized field without side effects is overridden when using
2940 designated initializers (@pxref{Designated Inits, , Designated
2941 Initializers}).  This warning can be independently controlled by
2942 @option{-Woverride-init}.
2943
2944 @item @r{(C only)}
2945 A function parameter is declared without a type specifier in K&R-style
2946 functions.  This warning can be independently controlled by
2947 @option{-Wmissing-parameter-type}.
2948
2949 @item
2950 An empty body occurs in an @samp{if} or @samp{else} statement. This
2951 warning can be independently controlled by @option{-Wempty-body}.
2952
2953 @item
2954 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2955 @samp{>}, or @samp{>=}.
2956
2957 @item
2958 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2959 This warning can be independently controlled by @option{-Wclobbered}.
2960
2961 @item @r{(C++ only)}
2962 An enumerator and a non-enumerator both appear in a conditional expression.
2963
2964 @item @r{(C++ only)}
2965 A non-static reference or non-static @samp{const} member appears in a
2966 class without constructors.
2967
2968 @item @r{(C++ only)}
2969 Ambiguous virtual bases.
2970
2971 @item @r{(C++ only)}
2972 Subscripting an array which has been declared @samp{register}.
2973
2974 @item @r{(C++ only)}
2975 Taking the address of a variable which has been declared @samp{register}.
2976
2977 @item @r{(C++ only)}
2978 A base class is not initialized in a derived class' copy constructor.
2979 @end itemize
2980
2981 @item -Wno-div-by-zero
2982 @opindex Wno-div-by-zero
2983 @opindex Wdiv-by-zero
2984 Do not warn about compile-time integer division by zero.  Floating point
2985 division by zero is not warned about, as it can be a legitimate way of
2986 obtaining infinities and NaNs.
2987
2988 @item -Wsystem-headers
2989 @opindex Wsystem-headers
2990 @cindex warnings from system headers
2991 @cindex system headers, warnings from
2992 Print warning messages for constructs found in system header files.
2993 Warnings from system headers are normally suppressed, on the assumption
2994 that they usually do not indicate real problems and would only make the
2995 compiler output harder to read.  Using this command line option tells
2996 GCC to emit warnings from system headers as if they occurred in user
2997 code.  However, note that using @option{-Wall} in conjunction with this
2998 option will @emph{not} warn about unknown pragmas in system
2999 headers---for that, @option{-Wunknown-pragmas} must also be used.
3000
3001 @item -Wfloat-equal
3002 @opindex Wfloat-equal
3003 Warn if floating point values are used in equality comparisons.
3004
3005 The idea behind this is that sometimes it is convenient (for the
3006 programmer) to consider floating-point values as approximations to
3007 infinitely precise real numbers.  If you are doing this, then you need
3008 to compute (by analyzing the code, or in some other way) the maximum or
3009 likely maximum error that the computation introduces, and allow for it
3010 when performing comparisons (and when producing output, but that's a
3011 different problem).  In particular, instead of testing for equality, you
3012 would check to see whether the two values have ranges that overlap; and
3013 this is done with the relational operators, so equality comparisons are
3014 probably mistaken.
3015
3016 @item -Wtraditional @r{(C only)}
3017 @opindex Wtraditional
3018 Warn about certain constructs that behave differently in traditional and
3019 ISO C@.  Also warn about ISO C constructs that have no traditional C
3020 equivalent, and/or problematic constructs which should be avoided.
3021
3022 @itemize @bullet
3023 @item
3024 Macro parameters that appear within string literals in the macro body.
3025 In traditional C macro replacement takes place within string literals,
3026 but does not in ISO C@.
3027
3028 @item
3029 In traditional C, some preprocessor directives did not exist.
3030 Traditional preprocessors would only consider a line to be a directive
3031 if the @samp{#} appeared in column 1 on the line.  Therefore
3032 @option{-Wtraditional} warns about directives that traditional C
3033 understands but would ignore because the @samp{#} does not appear as the
3034 first character on the line.  It also suggests you hide directives like
3035 @samp{#pragma} not understood by traditional C by indenting them.  Some
3036 traditional implementations would not recognize @samp{#elif}, so it
3037 suggests avoiding it altogether.
3038
3039 @item
3040 A function-like macro that appears without arguments.
3041
3042 @item
3043 The unary plus operator.
3044
3045 @item
3046 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3047 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3048 constants.)  Note, these suffixes appear in macros defined in the system
3049 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3050 Use of these macros in user code might normally lead to spurious
3051 warnings, however GCC's integrated preprocessor has enough context to
3052 avoid warning in these cases.
3053
3054 @item
3055 A function declared external in one block and then used after the end of
3056 the block.
3057
3058 @item
3059 A @code{switch} statement has an operand of type @code{long}.
3060
3061 @item
3062 A non-@code{static} function declaration follows a @code{static} one.
3063 This construct is not accepted by some traditional C compilers.
3064
3065 @item
3066 The ISO type of an integer constant has a different width or
3067 signedness from its traditional type.  This warning is only issued if
3068 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3069 typically represent bit patterns, are not warned about.
3070
3071 @item
3072 Usage of ISO string concatenation is detected.
3073
3074 @item
3075 Initialization of automatic aggregates.
3076
3077 @item
3078 Identifier conflicts with labels.  Traditional C lacks a separate
3079 namespace for labels.
3080
3081 @item
3082 Initialization of unions.  If the initializer is zero, the warning is
3083 omitted.  This is done under the assumption that the zero initializer in
3084 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3085 initializer warnings and relies on default initialization to zero in the
3086 traditional C case.
3087
3088 @item
3089 Conversions by prototypes between fixed/floating point values and vice
3090 versa.  The absence of these prototypes when compiling with traditional
3091 C would cause serious problems.  This is a subset of the possible
3092 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3093
3094 @item
3095 Use of ISO C style function definitions.  This warning intentionally is
3096 @emph{not} issued for prototype declarations or variadic functions
3097 because these ISO C features will appear in your code when using
3098 libiberty's traditional C compatibility macros, @code{PARAMS} and
3099 @code{VPARAMS}.  This warning is also bypassed for nested functions
3100 because that feature is already a GCC extension and thus not relevant to
3101 traditional C compatibility.
3102 @end itemize
3103
3104 @item -Wtraditional-conversion @r{(C only)}
3105 @opindex Wtraditional-conversion
3106 Warn if a prototype causes a type conversion that is different from what
3107 would happen to the same argument in the absence of a prototype.  This
3108 includes conversions of fixed point to floating and vice versa, and
3109 conversions changing the width or signedness of a fixed point argument
3110 except when the same as the default promotion.
3111
3112 @item -Wdeclaration-after-statement @r{(C only)}
3113 @opindex Wdeclaration-after-statement
3114 Warn when a declaration is found after a statement in a block.  This
3115 construct, known from C++, was introduced with ISO C99 and is by default
3116 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3117 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3118
3119 @item -Wundef
3120 @opindex Wundef
3121 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3122
3123 @item -Wno-endif-labels
3124 @opindex Wno-endif-labels
3125 @opindex Wendif-labels
3126 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3127
3128 @item -Wshadow
3129 @opindex Wshadow
3130 Warn whenever a local variable shadows another local variable, parameter or
3131 global variable or whenever a built-in function is shadowed.
3132
3133 @item -Wlarger-than-@var{len}
3134 @opindex Wlarger-than
3135 Warn whenever an object of larger than @var{len} bytes is defined.
3136
3137 @item -Wunsafe-loop-optimizations
3138 @opindex Wunsafe-loop-optimizations
3139 Warn if the loop cannot be optimized because the compiler could not
3140 assume anything on the bounds of the loop indices.  With
3141 @option{-funsafe-loop-optimizations} warn if the compiler made
3142 such assumptions.
3143
3144 @item -Wpointer-arith
3145 @opindex Wpointer-arith
3146 Warn about anything that depends on the ``size of'' a function type or
3147 of @code{void}.  GNU C assigns these types a size of 1, for
3148 convenience in calculations with @code{void *} pointers and pointers
3149 to functions.  In C++, warn also when an arithmetic operation involves
3150 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3151
3152 @item -Wbad-function-cast @r{(C only)}
3153 @opindex Wbad-function-cast
3154 Warn whenever a function call is cast to a non-matching type.
3155 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3156
3157 @item -Wc++-compat
3158 Warn about ISO C constructs that are outside of the common subset of
3159 ISO C and ISO C++, e.g.@: request for implicit conversion from
3160 @code{void *} to a pointer to non-@code{void} type.
3161
3162 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3163 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3164 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords 
3165 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3166
3167 @item -Wcast-qual
3168 @opindex Wcast-qual
3169 Warn whenever a pointer is cast so as to remove a type qualifier from
3170 the target type.  For example, warn if a @code{const char *} is cast
3171 to an ordinary @code{char *}.
3172
3173 @item -Wcast-align
3174 @opindex Wcast-align
3175 Warn whenever a pointer is cast such that the required alignment of the
3176 target is increased.  For example, warn if a @code{char *} is cast to
3177 an @code{int *} on machines where integers can only be accessed at
3178 two- or four-byte boundaries.
3179
3180 @item -Wwrite-strings
3181 @opindex Wwrite-strings
3182 When compiling C, give string constants the type @code{const
3183 char[@var{length}]} so that
3184 copying the address of one into a non-@code{const} @code{char *}
3185 pointer will get a warning; when compiling C++, warn about the
3186 deprecated conversion from string literals to @code{char *}.  This
3187 warning, by default, is enabled for C++ programs.
3188 These warnings will help you find at
3189 compile time code that can try to write into a string constant, but
3190 only if you have been very careful about using @code{const} in
3191 declarations and prototypes.  Otherwise, it will just be a nuisance;
3192 this is why we did not make @option{-Wall} request these warnings.
3193
3194 @item -Wclobbered
3195 @opindex Wclobbered
3196 Warn for variables that might be changed by @samp{longjmp} or
3197 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3198
3199 @item -Wconversion
3200 @opindex Wconversion
3201 Warn for implicit conversions that may alter a value. This includes
3202 conversions between real and integer, like @code{abs (x)} when
3203 @code{x} is @code{double}; conversions between signed and unsigned,
3204 like @code{unsigned ui = -1}; and conversions to smaller types, like
3205 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3206 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3207 changed by the conversion like in @code{abs (2.0)}.
3208
3209 @item -Wempty-body
3210 @opindex Wempty-body
3211 An empty body occurs in an @samp{if} or @samp{else} statement. 
3212 This warning is also enabled by @option{-Wextra}.
3213
3214 @item -Wsign-compare
3215 @opindex Wsign-compare
3216 @cindex warning for comparison of signed and unsigned values
3217 @cindex comparison of signed and unsigned values, warning
3218 @cindex signed and unsigned values, comparison warning
3219 Warn when a comparison between signed and unsigned values could produce
3220 an incorrect result when the signed value is converted to unsigned.
3221 This warning is also enabled by @option{-Wextra}; to get the other warnings
3222 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3223
3224 @item -Waggregate-return
3225 @opindex Waggregate-return
3226 Warn if any functions that return structures or unions are defined or
3227 called.  (In languages where you can return an array, this also elicits
3228 a warning.)
3229
3230 @item -Walways-true
3231 @opindex Walways-true
3232 Warn about comparisons which are always true such as testing if
3233 unsigned values are greater than or equal to zero.  This warning is
3234 enabled by @option{-Wall}.
3235
3236 @item -Wno-attributes
3237 @opindex Wno-attributes
3238 @opindex Wattributes
3239 Do not warn if an unexpected @code{__attribute__} is used, such as
3240 unrecognized attributes, function attributes applied to variables,
3241 etc.  This will not stop errors for incorrect use of supported
3242 attributes.
3243
3244 @item -Wstrict-prototypes @r{(C only)}
3245 @opindex Wstrict-prototypes
3246 Warn if a function is declared or defined without specifying the
3247 argument types.  (An old-style function definition is permitted without
3248 a warning if preceded by a declaration which specifies the argument
3249 types.)
3250
3251 @item -Wold-style-declaration @r{(C only)}
3252 @opindex Wold-style-declaration
3253 Warn for obsolescent usages, according to the C Standard, in a
3254 declaration. For example, warn if storage-class specifiers like
3255 @code{static} are not the first things in a declaration.  This warning
3256 is also enabled by @option{-Wextra}.
3257
3258 @item -Wold-style-definition @r{(C only)}
3259 @opindex Wold-style-definition
3260 Warn if an old-style function definition is used.  A warning is given
3261 even if there is a previous prototype.
3262
3263 @item -Wmissing-parameter-type @r{(C only)}
3264 @opindex Wmissing-parameter-type
3265 A function parameter is declared without a type specifier in K&R-style
3266 functions:
3267
3268 @smallexample
3269 void foo(bar) @{ @}
3270 @end smallexample
3271
3272 This warning is also enabled by @option{-Wextra}.
3273
3274 @item -Wmissing-prototypes @r{(C only)}
3275 @opindex Wmissing-prototypes
3276 Warn if a global function is defined without a previous prototype
3277 declaration.  This warning is issued even if the definition itself
3278 provides a prototype.  The aim is to detect global functions that fail
3279 to be declared in header files.
3280
3281 @item -Wmissing-declarations @r{(C and C++ only)}
3282 @opindex Wmissing-declarations
3283 Warn if a global function is defined without a previous declaration.
3284 Do so even if the definition itself provides a prototype.
3285 Use this option to detect global functions that are not declared in
3286 header files.  In C++, no warnings are issued for function templates,
3287 or for inline functions, or for functions in anonymous namespaces.
3288
3289 @item -Wmissing-field-initializers
3290 @opindex Wmissing-field-initializers
3291 @opindex W
3292 @opindex Wextra
3293 Warn if a structure's initializer has some fields missing.  For
3294 example, the following code would cause such a warning, because
3295 @code{x.h} is implicitly zero:
3296
3297 @smallexample
3298 struct s @{ int f, g, h; @};
3299 struct s x = @{ 3, 4 @};
3300 @end smallexample
3301
3302 This option does not warn about designated initializers, so the following
3303 modification would not trigger a warning:
3304
3305 @smallexample
3306 struct s @{ int f, g, h; @};
3307 struct s x = @{ .f = 3, .g = 4 @};
3308 @end smallexample
3309
3310 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3311 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3312
3313 @item -Wmissing-noreturn
3314 @opindex Wmissing-noreturn
3315 Warn about functions which might be candidates for attribute @code{noreturn}.
3316 Note these are only possible candidates, not absolute ones.  Care should
3317 be taken to manually verify functions actually do not ever return before
3318 adding the @code{noreturn} attribute, otherwise subtle code generation
3319 bugs could be introduced.  You will not get a warning for @code{main} in
3320 hosted C environments.
3321
3322 @item -Wmissing-format-attribute
3323 @opindex Wmissing-format-attribute
3324 @opindex Wformat
3325 Warn about function pointers which might be candidates for @code{format}
3326 attributes.  Note these are only possible candidates, not absolute ones.
3327 GCC will guess that function pointers with @code{format} attributes that
3328 are used in assignment, initialization, parameter passing or return
3329 statements should have a corresponding @code{format} attribute in the
3330 resulting type.  I.e.@: the left-hand side of the assignment or
3331 initialization, the type of the parameter variable, or the return type
3332 of the containing function respectively should also have a @code{format}
3333 attribute to avoid the warning.
3334
3335 GCC will also warn about function definitions which might be
3336 candidates for @code{format} attributes.  Again, these are only
3337 possible candidates.  GCC will guess that @code{format} attributes
3338 might be appropriate for any function that calls a function like
3339 @code{vprintf} or @code{vscanf}, but this might not always be the
3340 case, and some functions for which @code{format} attributes are
3341 appropriate may not be detected.
3342
3343 @item -Wno-multichar
3344 @opindex Wno-multichar
3345 @opindex Wmultichar
3346 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3347 Usually they indicate a typo in the user's code, as they have
3348 implementation-defined values, and should not be used in portable code.
3349
3350 @item -Wnormalized=<none|id|nfc|nfkc>
3351 @opindex Wnormalized
3352 @cindex NFC
3353 @cindex NFKC
3354 @cindex character set, input normalization
3355 In ISO C and ISO C++, two identifiers are different if they are
3356 different sequences of characters.  However, sometimes when characters
3357 outside the basic ASCII character set are used, you can have two
3358 different character sequences that look the same.  To avoid confusion,
3359 the ISO 10646 standard sets out some @dfn{normalization rules} which
3360 when applied ensure that two sequences that look the same are turned into
3361 the same sequence.  GCC can warn you if you are using identifiers which
3362 have not been normalized; this option controls that warning.
3363
3364 There are four levels of warning that GCC supports.  The default is
3365 @option{-Wnormalized=nfc}, which warns about any identifier which is
3366 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3367 recommended form for most uses.
3368
3369 Unfortunately, there are some characters which ISO C and ISO C++ allow
3370 in identifiers that when turned into NFC aren't allowable as
3371 identifiers.  That is, there's no way to use these symbols in portable
3372 ISO C or C++ and have all your identifiers in NFC.
3373 @option{-Wnormalized=id} suppresses the warning for these characters.
3374 It is hoped that future versions of the standards involved will correct
3375 this, which is why this option is not the default.
3376
3377 You can switch the warning off for all characters by writing
3378 @option{-Wnormalized=none}.  You would only want to do this if you
3379 were using some other normalization scheme (like ``D''), because
3380 otherwise you can easily create bugs that are literally impossible to see.
3381
3382 Some characters in ISO 10646 have distinct meanings but look identical
3383 in some fonts or display methodologies, especially once formatting has
3384 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3385 LETTER N'', will display just like a regular @code{n} which has been
3386 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3387 normalization scheme to convert all these into a standard form as
3388 well, and GCC will warn if your code is not in NFKC if you use
3389 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3390 about every identifier that contains the letter O because it might be
3391 confused with the digit 0, and so is not the default, but may be
3392 useful as a local coding convention if the programming environment is
3393 unable to be fixed to display these characters distinctly.
3394
3395 @item -Wno-deprecated-declarations
3396 @opindex Wno-deprecated-declarations
3397 Do not warn about uses of functions (@pxref{Function Attributes}),
3398 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3399 Attributes}) marked as deprecated by using the @code{deprecated}
3400 attribute.
3401
3402 @item -Wno-overflow
3403 @opindex Wno-overflow
3404 Do not warn about compile-time overflow in constant expressions.
3405
3406 @item -Woverride-init
3407 @opindex Woverride-init
3408 @opindex W
3409 @opindex Wextra
3410 Warn if an initialized field without side effects is overridden when
3411 using designated initializers (@pxref{Designated Inits, , Designated
3412 Initializers}).
3413
3414 This warning is included in @option{-Wextra}.  To get other
3415 @option{-Wextra} warnings without this one, use @samp{-Wextra
3416 -Wno-override-init}.
3417
3418 @item -Wpacked
3419 @opindex Wpacked
3420 Warn if a structure is given the packed attribute, but the packed
3421 attribute has no effect on the layout or size of the structure.
3422 Such structures may be mis-aligned for little benefit.  For
3423 instance, in this code, the variable @code{f.x} in @code{struct bar}
3424 will be misaligned even though @code{struct bar} does not itself
3425 have the packed attribute:
3426
3427 @smallexample
3428 @group
3429 struct foo @{
3430   int x;
3431   char a, b, c, d;
3432 @} __attribute__((packed));
3433 struct bar @{
3434   char z;
3435   struct foo f;
3436 @};
3437 @end group
3438 @end smallexample
3439
3440 @item -Wpadded
3441 @opindex Wpadded
3442 Warn if padding is included in a structure, either to align an element
3443 of the structure or to align the whole structure.  Sometimes when this
3444 happens it is possible to rearrange the fields of the structure to
3445 reduce the padding and so make the structure smaller.
3446
3447 @item -Wredundant-decls
3448 @opindex Wredundant-decls
3449 Warn if anything is declared more than once in the same scope, even in
3450 cases where multiple declaration is valid and changes nothing.
3451
3452 @item -Wnested-externs @r{(C only)}
3453 @opindex Wnested-externs
3454 Warn if an @code{extern} declaration is encountered within a function.
3455
3456 @item -Wunreachable-code
3457 @opindex Wunreachable-code
3458 Warn if the compiler detects that code will never be executed.
3459
3460 This option is intended to warn when the compiler detects that at
3461 least a whole line of source code will never be executed, because
3462 some condition is never satisfied or because it is after a
3463 procedure that never returns.
3464
3465 It is possible for this option to produce a warning even though there
3466 are circumstances under which part of the affected line can be executed,
3467 so care should be taken when removing apparently-unreachable code.
3468
3469 For instance, when a function is inlined, a warning may mean that the
3470 line is unreachable in only one inlined copy of the function.
3471
3472 This option is not made part of @option{-Wall} because in a debugging
3473 version of a program there is often substantial code which checks
3474 correct functioning of the program and is, hopefully, unreachable
3475 because the program does work.  Another common use of unreachable
3476 code is to provide behavior which is selectable at compile-time.
3477
3478 @item -Winline
3479 @opindex Winline
3480 Warn if a function can not be inlined and it was declared as inline.
3481 Even with this option, the compiler will not warn about failures to
3482 inline functions declared in system headers.
3483
3484 The compiler uses a variety of heuristics to determine whether or not
3485 to inline a function.  For example, the compiler takes into account
3486 the size of the function being inlined and the amount of inlining
3487 that has already been done in the current function.  Therefore,
3488 seemingly insignificant changes in the source program can cause the
3489 warnings produced by @option{-Winline} to appear or disappear.
3490
3491 @item -Wno-invalid-offsetof @r{(C++ only)}
3492 @opindex Wno-invalid-offsetof
3493 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3494 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3495 to a non-POD type is undefined.  In existing C++ implementations,
3496 however, @samp{offsetof} typically gives meaningful results even when
3497 applied to certain kinds of non-POD types. (Such as a simple
3498 @samp{struct} that fails to be a POD type only by virtue of having a
3499 constructor.)  This flag is for users who are aware that they are
3500 writing nonportable code and who have deliberately chosen to ignore the
3501 warning about it.
3502
3503 The restrictions on @samp{offsetof} may be relaxed in a future version
3504 of the C++ standard.
3505
3506 @item -Wno-int-to-pointer-cast @r{(C only)}
3507 @opindex Wno-int-to-pointer-cast
3508 Suppress warnings from casts to pointer type of an integer of a
3509 different size.
3510
3511 @item -Wno-pointer-to-int-cast @r{(C only)}
3512 @opindex Wno-pointer-to-int-cast
3513 Suppress warnings from casts from a pointer to an integer type of a
3514 different size.
3515
3516 @item -Winvalid-pch
3517 @opindex Winvalid-pch
3518 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3519 the search path but can't be used.
3520
3521 @item -Wlong-long
3522 @opindex Wlong-long
3523 @opindex Wno-long-long
3524 Warn if @samp{long long} type is used.  This is default.  To inhibit
3525 the warning messages, use @option{-Wno-long-long}.  Flags
3526 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3527 only when @option{-pedantic} flag is used.
3528
3529 @item -Wvariadic-macros
3530 @opindex Wvariadic-macros
3531 @opindex Wno-variadic-macros
3532 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3533 alternate syntax when in pedantic ISO C99 mode.  This is default.
3534 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3535
3536 @item -Wvolatile-register-var
3537 @opindex Wvolatile-register-var
3538 @opindex Wno-volatile-register-var
3539 Warn if a register variable is declared volatile.  The volatile
3540 modifier does not inhibit all optimizations that may eliminate reads
3541 and/or writes to register variables.
3542
3543 @item -Wdisabled-optimization
3544 @opindex Wdisabled-optimization
3545 Warn if a requested optimization pass is disabled.  This warning does
3546 not generally indicate that there is anything wrong with your code; it
3547 merely indicates that GCC's optimizers were unable to handle the code
3548 effectively.  Often, the problem is that your code is too big or too
3549 complex; GCC will refuse to optimize programs when the optimization
3550 itself is likely to take inordinate amounts of time.
3551
3552 @item -Wpointer-sign
3553 @opindex Wpointer-sign
3554 @opindex Wno-pointer-sign
3555 Warn for pointer argument passing or assignment with different signedness.
3556 This option is only supported for C and Objective-C@.  It is implied by
3557 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3558 @option{-Wno-pointer-sign}.
3559
3560 @item -Werror
3561 @opindex Werror
3562 Make all warnings into errors.
3563
3564 @item -Werror=
3565 @opindex Werror=
3566 Make the specified warning into an errors.  The specifier for a
3567 warning is appended, for example @option{-Werror=switch} turns the
3568 warnings controlled by @option{-Wswitch} into errors.  This switch
3569 takes a negative form, to be used to negate @option{-Werror} for
3570 specific warnings, for example @option{-Wno-error=switch} makes
3571 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3572 is in effect.  You can use the @option{-fdiagnostics-show-option}
3573 option to have each controllable warning amended with the option which
3574 controls it, to determine what to use with this option.
3575
3576 Note that specifying @option{-Werror=}@var{foo} automatically implies
3577 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3578 imply anything.
3579
3580 @item -Wstack-protector
3581 @opindex Wstack-protector
3582 This option is only active when @option{-fstack-protector} is active.  It
3583 warns about functions that will not be protected against stack smashing.
3584
3585 @item -Wstring-literal-comparison
3586 @opindex Wstring-literal-comparison
3587 Warn about suspicious comparisons to string literal constants.  In C,
3588 direct comparisons against the memory address of a string literal, such
3589 as @code{if (x == "abc")}, typically indicate a programmer error, and
3590 even when intentional, result in unspecified behavior and are not portable.
3591 Usually these warnings alert that the programmer intended to use
3592 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3593
3594 @item -Woverlength-strings
3595 @opindex Woverlength-strings
3596 Warn about string constants which are longer than the ``minimum
3597 maximum'' length specified in the C standard.  Modern compilers
3598 generally allow string constants which are much longer than the
3599 standard's minimum limit, but very portable programs should avoid
3600 using longer strings.
3601
3602 The limit applies @emph{after} string constant concatenation, and does
3603 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3604 C99, it was raised to 4095.  C++98 does not specify a normative
3605 minimum maximum, so we do not diagnose overlength strings in C++@.
3606
3607 This option is implied by @option{-pedantic}, and can be disabled with
3608 @option{-Wno-overlength-strings}.
3609 @end table
3610
3611 @node Debugging Options
3612 @section Options for Debugging Your Program or GCC
3613 @cindex options, debugging
3614 @cindex debugging information options
3615
3616 GCC has various special options that are used for debugging
3617 either your program or GCC:
3618
3619 @table @gcctabopt
3620 @item -g
3621 @opindex g
3622 Produce debugging information in the operating system's native format
3623 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3624 information.
3625
3626 On most systems that use stabs format, @option{-g} enables use of extra
3627 debugging information that only GDB can use; this extra information
3628 makes debugging work better in GDB but will probably make other debuggers
3629 crash or
3630 refuse to read the program.  If you want to control for certain whether
3631 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3632 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3633
3634 GCC allows you to use @option{-g} with
3635 @option{-O}.  The shortcuts taken by optimized code may occasionally
3636 produce surprising results: some variables you declared may not exist
3637 at all; flow of control may briefly move where you did not expect it;
3638 some statements may not be executed because they compute constant
3639 results or their values were already at hand; some statements may
3640 execute in different places because they were moved out of loops.
3641
3642 Nevertheless it proves possible to debug optimized output.  This makes
3643 it reasonable to use the optimizer for programs that might have bugs.
3644
3645 The following options are useful when GCC is generated with the
3646 capability for more than one debugging format.
3647
3648 @item -ggdb
3649 @opindex ggdb
3650 Produce debugging information for use by GDB@.  This means to use the
3651 most expressive format available (DWARF 2, stabs, or the native format
3652 if neither of those are supported), including GDB extensions if at all
3653 possible.
3654
3655 @item -gstabs
3656 @opindex gstabs
3657 Produce debugging information in stabs format (if that is supported),
3658 without GDB extensions.  This is the format used by DBX on most BSD
3659 systems.  On MIPS, Alpha and System V Release 4 systems this option
3660 produces stabs debugging output which is not understood by DBX or SDB@.
3661 On System V Release 4 systems this option requires the GNU assembler.
3662
3663 @item -feliminate-unused-debug-symbols
3664 @opindex feliminate-unused-debug-symbols
3665 Produce debugging information in stabs format (if that is supported),
3666 for only symbols that are actually used.
3667
3668 @item -femit-class-debug-always
3669 Instead of emitting debugging information for a C++ class in only one
3670 object file, emit it in all object files using the class.  This option
3671 should be used only with debuggers that are unable to handle the way GCC
3672 normally emits debugging information for classes because using this
3673 option will increase the size of debugging information by as much as a
3674 factor of two.
3675
3676 @item -gstabs+
3677 @opindex gstabs+
3678 Produce debugging information in stabs format (if that is supported),
3679 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3680 use of these extensions is likely to make other debuggers crash or
3681 refuse to read the program.
3682
3683 @item -gcoff
3684 @opindex gcoff
3685 Produce debugging information in COFF format (if that is supported).
3686 This is the format used by SDB on most System V systems prior to
3687 System V Release 4.
3688
3689 @item -gxcoff
3690 @opindex gxcoff
3691 Produce debugging information in XCOFF format (if that is supported).
3692 This is the format used by the DBX debugger on IBM RS/6000 systems.
3693
3694 @item -gxcoff+
3695 @opindex gxcoff+
3696 Produce debugging information in XCOFF format (if that is supported),
3697 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3698 use of these extensions is likely to make other debuggers crash or
3699 refuse to read the program, and may cause assemblers other than the GNU
3700 assembler (GAS) to fail with an error.
3701
3702 @item -gdwarf-2
3703 @opindex gdwarf-2
3704 Produce debugging information in DWARF version 2 format (if that is
3705 supported).  This is the format used by DBX on IRIX 6.  With this
3706 option, GCC uses features of DWARF version 3 when they are useful;
3707 version 3 is upward compatible with version 2, but may still cause
3708 problems for older debuggers.
3709
3710 @item -gvms
3711 @opindex gvms
3712 Produce debugging information in VMS debug format (if that is
3713 supported).  This is the format used by DEBUG on VMS systems.
3714
3715 @item -g@var{level}
3716 @itemx -ggdb@var{level}
3717 @itemx -gstabs@var{level}
3718 @itemx -gcoff@var{level}
3719 @itemx -gxcoff@var{level}
3720 @itemx -gvms@var{level}
3721 Request debugging information and also use @var{level} to specify how
3722 much information.  The default level is 2.
3723
3724 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
3725 @option{-g}.
3726
3727 Level 1 produces minimal information, enough for making backtraces in
3728 parts of the program that you don't plan to debug.  This includes
3729 descriptions of functions and external variables, but no information
3730 about local variables and no line numbers.
3731
3732 Level 3 includes extra information, such as all the macro definitions
3733 present in the program.  Some debuggers support macro expansion when
3734 you use @option{-g3}.
3735
3736 @option{-gdwarf-2} does not accept a concatenated debug level, because
3737 GCC used to support an option @option{-gdwarf} that meant to generate
3738 debug information in version 1 of the DWARF format (which is very
3739 different from version 2), and it would have been too confusing.  That
3740 debug format is long obsolete, but the option cannot be changed now.
3741 Instead use an additional @option{-g@var{level}} option to change the
3742 debug level for DWARF2.
3743
3744 @item -feliminate-dwarf2-dups
3745 @opindex feliminate-dwarf2-dups
3746 Compress DWARF2 debugging information by eliminating duplicated
3747 information about each symbol.  This option only makes sense when
3748 generating DWARF2 debugging information with @option{-gdwarf-2}.
3749
3750 @cindex @command{prof}
3751 @item -p
3752 @opindex p
3753 Generate extra code to write profile information suitable for the
3754 analysis program @command{prof}.  You must use this option when compiling
3755 the source files you want data about, and you must also use it when
3756 linking.
3757
3758 @cindex @command{gprof}
3759 @item -pg
3760 @opindex pg
3761 Generate extra code to write profile information suitable for the
3762 analysis program @command{gprof}.  You must use this option when compiling
3763 the source files you want data about, and you must also use it when
3764 linking.
3765
3766 @item -Q
3767 @opindex Q
3768 Makes the compiler print out each function name as it is compiled, and
3769 print some statistics about each pass when it finishes.
3770
3771 @item -ftime-report
3772 @opindex ftime-report
3773 Makes the compiler print some statistics about the time consumed by each
3774 pass when it finishes.
3775
3776 @item -fmem-report
3777 @opindex fmem-report
3778 Makes the compiler print some statistics about permanent memory
3779 allocation when it finishes.
3780
3781 @item -fpre-ipa-mem-report
3782 @opindex fpre-ipa-mem-report
3783 @item -fpost-ipa-mem-report
3784 @opindex fpost-ipa-mem-report
3785 Makes the compiler print some statistics about permanent memory
3786 allocation before or after interprocedural optimization.
3787
3788 @item -fprofile-arcs
3789 @opindex fprofile-arcs
3790 Add code so that program flow @dfn{arcs} are instrumented.  During
3791 execution the program records how many times each branch and call is
3792 executed and how many times it is taken or returns.  When the compiled
3793 program exits it saves this data to a file called
3794 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3795 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3796 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3797 @var{auxname} is generated from the name of the output file, if
3798 explicitly specified and it is not the final executable, otherwise it is
3799 the basename of the source file.  In both cases any suffix is removed
3800 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3801 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3802 @xref{Cross-profiling}.
3803
3804 @cindex @command{gcov}
3805 @item --coverage
3806 @opindex coverage
3807
3808 This option is used to compile and link code instrumented for coverage
3809 analysis.  The option is a synonym for @option{-fprofile-arcs}
3810 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3811 linking).  See the documentation for those options for more details.
3812
3813 @itemize
3814
3815 @item
3816 Compile the source files with @option{-fprofile-arcs} plus optimization
3817 and code generation options.  For test coverage analysis, use the
3818 additional @option{-ftest-coverage} option.  You do not need to profile
3819 every source file in a program.
3820
3821 @item
3822 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3823 (the latter implies the former).
3824
3825 @item
3826 Run the program on a representative workload to generate the arc profile
3827 information.  This may be repeated any number of times.  You can run
3828 concurrent instances of your program, and provided that the file system
3829 supports locking, the data files will be correctly updated.  Also
3830 @code{fork} calls are detected and correctly handled (double counting
3831 will not happen).
3832
3833 @item
3834 For profile-directed optimizations, compile the source files again with
3835 the same optimization and code generation options plus
3836 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3837 Control Optimization}).
3838
3839 @item
3840 For test coverage analysis, use @command{gcov} to produce human readable
3841 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3842 @command{gcov} documentation for further information.
3843
3844 @end itemize
3845
3846 With @option{-fprofile-arcs}, for each function of your program GCC
3847 creates a program flow graph, then finds a spanning tree for the graph.
3848 Only arcs that are not on the spanning tree have to be instrumented: the
3849 compiler adds code to count the number of times that these arcs are
3850 executed.  When an arc is the only exit or only entrance to a block, the
3851 instrumentation code can be added to the block; otherwise, a new basic
3852 block must be created to hold the instrumentation code.
3853
3854 @need 2000
3855 @item -ftest-coverage
3856 @opindex ftest-coverage
3857 Produce a notes file that the @command{gcov} code-coverage utility
3858 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3859 show program coverage.  Each source file's note file is called
3860 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3861 above for a description of @var{auxname} and instructions on how to
3862 generate test coverage data.  Coverage data will match the source files
3863 more closely, if you do not optimize.
3864
3865 @item -d@var{letters}
3866 @item -fdump-rtl-@var{pass}
3867 @opindex d
3868 Says to make debugging dumps during compilation at times specified by
3869 @var{letters}.    This is used for debugging the RTL-based passes of the
3870 compiler.  The file names for most of the dumps are made by appending a
3871 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3872 from the name of the output file, if explicitly specified and it is not
3873 an executable, otherwise it is the basename of the source file.
3874
3875 Most debug dumps can be enabled either passing a letter to the @option{-d}
3876 option, or with a long @option{-fdump-rtl} switch; here are the possible
3877 letters for use in @var{letters} and @var{pass}, and their meanings:
3878
3879 @table @gcctabopt
3880 @item -dA
3881 @opindex dA
3882 Annotate the assembler output with miscellaneous debugging information.
3883
3884 @item -dB
3885 @itemx -fdump-rtl-bbro
3886 @opindex dB
3887 @opindex fdump-rtl-bbro
3888 Dump after block reordering, to @file{@var{file}.148r.bbro}.
3889
3890 @item -dc
3891 @itemx -fdump-rtl-combine
3892 @opindex dc
3893 @opindex fdump-rtl-combine
3894 Dump after the RTL instruction combination pass, to the file
3895 @file{@var{file}.129r.combine}.
3896
3897 @item -dC
3898 @itemx -fdump-rtl-ce1
3899 @itemx -fdump-rtl-ce2
3900 @opindex dC
3901 @opindex fdump-rtl-ce1
3902 @opindex fdump-rtl-ce2
3903 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3904 first if conversion, to the file @file{@var{file}.117r.ce1}.  @option{-dC}
3905 and @option{-fdump-rtl-ce2} enable dumping after the second if
3906 conversion, to the file @file{@var{file}.130r.ce2}.
3907
3908 @item -dd
3909 @itemx -fdump-rtl-btl
3910 @itemx -fdump-rtl-dbr
3911 @opindex dd
3912 @opindex fdump-rtl-btl
3913 @opindex fdump-rtl-dbr
3914 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3915 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3916 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3917 scheduling, to @file{@var{file}.36.dbr}.
3918
3919 @item -dD
3920 @opindex dD
3921 Dump all macro definitions, at the end of preprocessing, in addition to
3922 normal output.
3923
3924 @item -dE
3925 @itemx -fdump-rtl-ce3
3926 @opindex dE
3927 @opindex fdump-rtl-ce3
3928 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3929
3930 @item -df
3931 @itemx -fdump-rtl-cfg
3932 @itemx -fdump-rtl-life
3933 @opindex df
3934 @opindex fdump-rtl-cfg
3935 @opindex fdump-rtl-life
3936 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3937 and data flow analysis, to @file{@var{file}.116r.cfg}.  @option{-df}
3938 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3939 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3940
3941 @item -dg
3942 @itemx -fdump-rtl-greg
3943 @opindex dg
3944 @opindex fdump-rtl-greg
3945 Dump after global register allocation, to @file{@var{file}.139r.greg}.
3946
3947 @item -dG
3948 @itemx -fdump-rtl-gcse
3949 @itemx -fdump-rtl-bypass
3950 @opindex dG
3951 @opindex fdump-rtl-gcse
3952 @opindex fdump-rtl-bypass
3953 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3954 @file{@var{file}.114r.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3955 enable dumping after jump bypassing and control flow optimizations, to
3956 @file{@var{file}.115r.bypass}.
3957
3958 @item -dh
3959 @itemx -fdump-rtl-eh
3960 @opindex dh
3961 @opindex fdump-rtl-eh
3962 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3963
3964 @item -di
3965 @itemx -fdump-rtl-sibling
3966 @opindex di
3967 @opindex fdump-rtl-sibling
3968 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3969
3970 @item -dj
3971 @itemx -fdump-rtl-jump
3972 @opindex dj
3973 @opindex fdump-rtl-jump
3974 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3975
3976 @item -dk
3977 @itemx -fdump-rtl-stack
3978 @opindex dk
3979 @opindex fdump-rtl-stack
3980 Dump after conversion from GCC's "flat register file" registers to the
3981 x87's stack-like registers, to @file{@var{file}.152r.stack}.
3982
3983 @item -dl
3984 @itemx -fdump-rtl-lreg
3985 @opindex dl
3986 @opindex fdump-rtl-lreg
3987 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3988
3989 @item -dL
3990 @itemx -fdump-rtl-loop2
3991 @opindex dL
3992 @opindex fdump-rtl-loop2
3993 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
3994 loop optimization pass, to @file{@var{file}.119r.loop2},
3995 @file{@var{file}.120r.loop2_init},
3996 @file{@var{file}.121r.loop2_invariant}, and
3997 @file{@var{file}.125r.loop2_done}.
3998
3999 @item -dm
4000 @itemx -fdump-rtl-sms
4001 @opindex dm
4002 @opindex fdump-rtl-sms
4003 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
4004
4005 @item -dM
4006 @itemx -fdump-rtl-mach
4007 @opindex dM
4008 @opindex fdump-rtl-mach
4009 Dump after performing the machine dependent reorganization pass, to
4010 @file{@var{file}.155r.mach}.
4011
4012 @item -dn
4013 @itemx -fdump-rtl-rnreg
4014 @opindex dn
4015 @opindex fdump-rtl-rnreg
4016 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
4017
4018 @item -dN
4019 @itemx -fdump-rtl-regmove
4020 @opindex dN
4021 @opindex fdump-rtl-regmove
4022 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
4023
4024 @item -do
4025 @itemx -fdump-rtl-postreload
4026 @opindex do
4027 @opindex fdump-rtl-postreload
4028 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4029
4030 @item -dr
4031 @itemx -fdump-rtl-expand
4032 @opindex dr
4033 @opindex fdump-rtl-expand
4034 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4035
4036 @item -dR
4037 @itemx -fdump-rtl-sched2
4038 @opindex dR
4039 @opindex fdump-rtl-sched2
4040 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4041
4042 @item -ds
4043 @itemx -fdump-rtl-cse
4044 @opindex ds
4045 @opindex fdump-rtl-cse
4046 Dump after CSE (including the jump optimization that sometimes follows
4047 CSE), to @file{@var{file}.113r.cse}.
4048
4049 @item -dS
4050 @itemx -fdump-rtl-sched1
4051 @opindex dS
4052 @opindex fdump-rtl-sched1
4053 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4054
4055 @item -dt
4056 @itemx -fdump-rtl-cse2
4057 @opindex dt
4058 @opindex fdump-rtl-cse2
4059 Dump after the second CSE pass (including the jump optimization that
4060 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4061
4062 @item -dT
4063 @itemx -fdump-rtl-tracer
4064 @opindex dT
4065 @opindex fdump-rtl-tracer
4066 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4067
4068 @item -dV
4069 @itemx -fdump-rtl-vpt
4070 @itemx -fdump-rtl-vartrack
4071 @opindex dV
4072 @opindex fdump-rtl-vpt
4073 @opindex fdump-rtl-vartrack
4074 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4075 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
4076 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4077 to @file{@var{file}.154r.vartrack}.
4078
4079 @item -dw
4080 @itemx -fdump-rtl-flow2
4081 @opindex dw
4082 @opindex fdump-rtl-flow2
4083 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4084
4085 @item -dz
4086 @itemx -fdump-rtl-peephole2
4087 @opindex dz
4088 @opindex fdump-rtl-peephole2
4089 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4090
4091 @item -dZ
4092 @itemx -fdump-rtl-web
4093 @opindex dZ
4094 @opindex fdump-rtl-web
4095 Dump after live range splitting, to @file{@var{file}.126r.web}.
4096
4097 @item -da
4098 @itemx -fdump-rtl-all
4099 @opindex da
4100 @opindex fdump-rtl-all
4101 Produce all the dumps listed above.
4102
4103 @item -dH
4104 @opindex dH
4105 Produce a core dump whenever an error occurs.
4106
4107 @item -dm
4108 @opindex dm
4109 Print statistics on memory usage, at the end of the run, to
4110 standard error.
4111
4112 @item -dp
4113 @opindex dp
4114 Annotate the assembler output with a comment indicating which
4115 pattern and alternative was used.  The length of each instruction is
4116 also printed.
4117
4118 @item -dP
4119 @opindex dP
4120 Dump the RTL in the assembler output as a comment before each instruction.
4121 Also turns on @option{-dp} annotation.
4122
4123 @item -dv
4124 @opindex dv
4125 For each of the other indicated dump files (either with @option{-d} or
4126 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4127 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4128
4129 @item -dx
4130 @opindex dx
4131 Just generate RTL for a function instead of compiling it.  Usually used
4132 with @samp{r} (@option{-fdump-rtl-expand}).
4133
4134 @item -dy
4135 @opindex dy
4136 Dump debugging information during parsing, to standard error.
4137 @end table
4138
4139 @item -fdump-noaddr
4140 @opindex fdump-noaddr
4141 When doing debugging dumps (see @option{-d} option above), suppress
4142 address output.  This makes it more feasible to use diff on debugging
4143 dumps for compiler invocations with different compiler binaries and/or
4144 different text / bss / data / heap / stack / dso start locations.
4145
4146 @item -fdump-unnumbered
4147 @opindex fdump-unnumbered
4148 When doing debugging dumps (see @option{-d} option above), suppress instruction
4149 numbers, line number note and address output.  This makes it more feasible to
4150 use diff on debugging dumps for compiler invocations with different
4151 options, in particular with and without @option{-g}.
4152
4153 @item -fdump-translation-unit @r{(C++ only)}
4154 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4155 @opindex fdump-translation-unit
4156 Dump a representation of the tree structure for the entire translation
4157 unit to a file.  The file name is made by appending @file{.tu} to the
4158 source file name.  If the @samp{-@var{options}} form is used, @var{options}
4159 controls the details of the dump as described for the
4160 @option{-fdump-tree} options.
4161
4162 @item -fdump-class-hierarchy @r{(C++ only)}
4163 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4164 @opindex fdump-class-hierarchy
4165 Dump a representation of each class's hierarchy and virtual function
4166 table layout to a file.  The file name is made by appending @file{.class}
4167 to the source file name.  If the @samp{-@var{options}} form is used,
4168 @var{options} controls the details of the dump as described for the
4169 @option{-fdump-tree} options.
4170
4171 @item -fdump-ipa-@var{switch}
4172 @opindex fdump-ipa
4173 Control the dumping at various stages of inter-procedural analysis
4174 language tree to a file.  The file name is generated by appending a switch
4175 specific suffix to the source file name.  The following dumps are possible:
4176
4177 @table @samp
4178 @item all
4179 Enables all inter-procedural analysis dumps; currently the only produced
4180 dump is the @samp{cgraph} dump.
4181
4182 @item cgraph
4183 Dumps information about call-graph optimization, unused function removal,
4184 and inlining decisions.
4185 @end table
4186
4187 @item -fdump-tree-@var{switch}
4188 @itemx -fdump-tree-@var{switch}-@var{options}
4189 @opindex fdump-tree
4190 Control the dumping at various stages of processing the intermediate
4191 language tree to a file.  The file name is generated by appending a switch
4192 specific suffix to the source file name.  If the @samp{-@var{options}}
4193 form is used, @var{options} is a list of @samp{-} separated options that
4194 control the details of the dump.  Not all options are applicable to all
4195 dumps, those which are not meaningful will be ignored.  The following
4196 options are available
4197
4198 @table @samp
4199 @item address
4200 Print the address of each node.  Usually this is not meaningful as it
4201 changes according to the environment and source file.  Its primary use
4202 is for tying up a dump file with a debug environment.
4203 @item slim
4204 Inhibit dumping of members of a scope or body of a function merely
4205 because that scope has been reached.  Only dump such items when they
4206 are directly reachable by some other path.  When dumping pretty-printed
4207 trees, this option inhibits dumping the bodies of control structures.
4208 @item raw
4209 Print a raw representation of the tree.  By default, trees are
4210 pretty-printed into a C-like representation.
4211 @item details
4212 Enable more detailed dumps (not honored by every dump option).
4213 @item stats
4214 Enable dumping various statistics about the pass (not honored by every dump
4215 option).
4216 @item blocks
4217 Enable showing basic block boundaries (disabled in raw dumps).
4218 @item vops
4219 Enable showing virtual operands for every statement.
4220 @item lineno
4221 Enable showing line numbers for statements.
4222 @item uid
4223 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4224 @item all
4225 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4226 @end table
4227
4228 The following tree dumps are possible:
4229 @table @samp
4230
4231 @item original
4232 Dump before any tree based optimization, to @file{@var{file}.original}.
4233
4234 @item optimized
4235 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4236
4237 @item inlined
4238 Dump after function inlining, to @file{@var{file}.inlined}.
4239
4240 @item gimple
4241 @opindex fdump-tree-gimple
4242 Dump each function before and after the gimplification pass to a file.  The
4243 file name is made by appending @file{.gimple} to the source file name.
4244
4245 @item cfg
4246 @opindex fdump-tree-cfg
4247 Dump the control flow graph of each function to a file.  The file name is
4248 made by appending @file{.cfg} to the source file name.
4249
4250 @item vcg
4251 @opindex fdump-tree-vcg
4252 Dump the control flow graph of each function to a file in VCG format.  The
4253 file name is made by appending @file{.vcg} to the source file name.  Note
4254 that if the file contains more than one function, the generated file cannot
4255 be used directly by VCG@.  You will need to cut and paste each function's
4256 graph into its own separate file first.
4257
4258 @item ch
4259 @opindex fdump-tree-ch
4260 Dump each function after copying loop headers.  The file name is made by
4261 appending @file{.ch} to the source file name.
4262
4263 @item ssa
4264 @opindex fdump-tree-ssa
4265 Dump SSA related information to a file.  The file name is made by appending
4266 @file{.ssa} to the source file name.
4267
4268 @item salias
4269 @opindex fdump-tree-salias
4270 Dump structure aliasing variable information to a file.  This file name
4271 is made by appending @file{.salias} to the source file name.
4272
4273 @item alias
4274 @opindex fdump-tree-alias
4275 Dump aliasing information for each function.  The file name is made by
4276 appending @file{.alias} to the source file name.
4277
4278 @item ccp
4279 @opindex fdump-tree-ccp
4280 Dump each function after CCP@.  The file name is made by appending
4281 @file{.ccp} to the source file name.
4282
4283 @item storeccp
4284 @opindex fdump-tree-storeccp
4285 Dump each function after STORE-CCP.  The file name is made by appending
4286 @file{.storeccp} to the source file name.
4287
4288 @item pre
4289 @opindex fdump-tree-pre
4290 Dump trees after partial redundancy elimination.  The file name is made
4291 by appending @file{.pre} to the source file name.
4292
4293 @item fre
4294 @opindex fdump-tree-fre
4295 Dump trees after full redundancy elimination.  The file name is made
4296 by appending @file{.fre} to the source file name.
4297
4298 @item copyprop
4299 @opindex fdump-tree-copyprop
4300 Dump trees after copy propagation.  The file name is made
4301 by appending @file{.copyprop} to the source file name.
4302
4303 @item store_copyprop
4304 @opindex fdump-tree-store_copyprop
4305 Dump trees after store copy-propagation.  The file name is made
4306 by appending @file{.store_copyprop} to the source file name.
4307
4308 @item dce
4309 @opindex fdump-tree-dce
4310 Dump each function after dead code elimination.  The file name is made by
4311 appending @file{.dce} to the source file name.
4312
4313 @item mudflap
4314 @opindex fdump-tree-mudflap
4315 Dump each function after adding mudflap instrumentation.  The file name is
4316 made by appending @file{.mudflap} to the source file name.
4317
4318 @item sra
4319 @opindex fdump-tree-sra
4320 Dump each function after performing scalar replacement of aggregates.  The
4321 file name is made by appending @file{.sra} to the source file name.
4322
4323 @item sink
4324 @opindex fdump-tree-sink
4325 Dump each function after performing code sinking.  The file name is made
4326 by appending @file{.sink} to the source file name. 
4327
4328 @item dom
4329 @opindex fdump-tree-dom
4330 Dump each function after applying dominator tree optimizations.  The file
4331 name is made by appending @file{.dom} to the source file name.
4332
4333 @item dse
4334 @opindex fdump-tree-dse
4335 Dump each function after applying dead store elimination.  The file
4336 name is made by appending @file{.dse} to the source file name.
4337
4338 @item phiopt
4339 @opindex fdump-tree-phiopt
4340 Dump each function after optimizing PHI nodes into straightline code.  The file
4341 name is made by appending @file{.phiopt} to the source file name.
4342
4343 @item forwprop
4344 @opindex fdump-tree-forwprop
4345 Dump each function after forward propagating single use variables.  The file
4346 name is made by appending @file{.forwprop} to the source file name.
4347
4348 @item copyrename
4349 @opindex fdump-tree-copyrename
4350 Dump each function after applying the copy rename optimization.  The file
4351 name is made by appending @file{.copyrename} to the source file name.
4352
4353 @item nrv
4354 @opindex fdump-tree-nrv
4355 Dump each function after applying the named return value optimization on
4356 generic trees.  The file name is made by appending @file{.nrv} to the source
4357 file name.
4358
4359 @item vect
4360 @opindex fdump-tree-vect
4361 Dump each function after applying vectorization of loops.  The file name is
4362 made by appending @file{.vect} to the source file name.
4363
4364 @item vrp
4365 @opindex fdump-tree-vrp
4366 Dump each function after Value Range Propagation (VRP).  The file name
4367 is made by appending @file{.vrp} to the source file name.
4368
4369 @item all
4370 @opindex fdump-tree-all
4371 Enable all the available tree dumps with the flags provided in this option.
4372 @end table
4373
4374 @item -ftree-vectorizer-verbose=@var{n}
4375 @opindex ftree-vectorizer-verbose
4376 This option controls the amount of debugging output the vectorizer prints.
4377 This information is written to standard error, unless 
4378 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified, 
4379 in which case it is output to the usual dump listing file, @file{.vect}.
4380 For @var{n}=0 no diagnostic information is reported.
4381 If @var{n}=1 the vectorizer reports each loop that got vectorized, 
4382 and the total number of loops that got vectorized.
4383 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed 
4384 the first analysis phase (vect_analyze_loop_form) - i.e. countable, 
4385 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity 
4386 level that @option{-fdump-tree-vect-stats} uses.
4387 Higher verbosity levels mean either more information dumped for each 
4388 reported loop, or same amount of information reported for more loops:
4389 If @var{n}=3, alignment related information is added to the reports.
4390 If @var{n}=4, data-references related information (e.g. memory dependences, 
4391 memory access-patterns) is added to the reports.
4392 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops 
4393 that did not pass the first analysis phase (i.e. may not be countable, or 
4394 may have complicated control-flow).
4395 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4396 For @var{n}=7, all the information the vectorizer generates during its 
4397 analysis and transformation is reported.  This is the same verbosity level
4398 that @option{-fdump-tree-vect-details} uses.
4399
4400 @item -frandom-seed=@var{string}
4401 @opindex frandom-string
4402 This option provides a seed that GCC uses when it would otherwise use
4403 random numbers.  It is used to generate certain symbol names
4404 that have to be different in every compiled file.  It is also used to
4405 place unique stamps in coverage data files and the object files that
4406 produce them.  You can use the @option{-frandom-seed} option to produce
4407 reproducibly identical object files.
4408
4409 The @var{string} should be different for every file you compile.
4410
4411 @item -fsched-verbose=@var{n}
4412 @opindex fsched-verbose
4413 On targets that use instruction scheduling, this option controls the
4414 amount of debugging output the scheduler prints.  This information is
4415 written to standard error, unless @option{-dS} or @option{-dR} is
4416 specified, in which case it is output to the usual dump
4417 listing file, @file{.sched} or @file{.sched2} respectively.  However
4418 for @var{n} greater than nine, the output is always printed to standard
4419 error.
4420
4421 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4422 same information as @option{-dRS}.  For @var{n} greater than one, it
4423 also output basic block probabilities, detailed ready list information
4424 and unit/insn info.  For @var{n} greater than two, it includes RTL
4425 at abort point, control-flow and regions info.  And for @var{n} over
4426 four, @option{-fsched-verbose} also includes dependence info.
4427
4428 @item -save-temps
4429 @opindex save-temps
4430 Store the usual ``temporary'' intermediate files permanently; place them
4431 in the current directory and name them based on the source file.  Thus,
4432 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4433 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4434 preprocessed @file{foo.i} output file even though the compiler now
4435 normally uses an integrated preprocessor.
4436
4437 When used in combination with the @option{-x} command line option,
4438 @option{-save-temps} is sensible enough to avoid over writing an
4439 input source file with the same extension as an intermediate file.
4440 The corresponding intermediate file may be obtained by renaming the
4441 source file before using @option{-save-temps}.
4442
4443 @item -time
4444 @opindex time
4445 Report the CPU time taken by each subprocess in the compilation
4446 sequence.  For C source files, this is the compiler proper and assembler
4447 (plus the linker if linking is done).  The output looks like this:
4448
4449 @smallexample
4450 # cc1 0.12 0.01
4451 # as 0.00 0.01
4452 @end smallexample
4453
4454 The first number on each line is the ``user time'', that is time spent
4455 executing the program itself.  The second number is ``system time'',
4456 time spent executing operating system routines on behalf of the program.
4457 Both numbers are in seconds.
4458
4459 @item -fvar-tracking
4460 @opindex fvar-tracking
4461 Run variable tracking pass.  It computes where variables are stored at each
4462 position in code.  Better debugging information is then generated
4463 (if the debugging information format supports this information).
4464
4465 It is enabled by default when compiling with optimization (@option{-Os},
4466 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4467 the debug info format supports it.
4468
4469 @item -print-file-name=@var{library}
4470 @opindex print-file-name
4471 Print the full absolute name of the library file @var{library} that
4472 would be used when linking---and don't do anything else.  With this
4473 option, GCC does not compile or link anything; it just prints the
4474 file name.
4475
4476 @item -print-multi-directory
4477 @opindex print-multi-directory
4478 Print the directory name corresponding to the multilib selected by any
4479 other switches present in the command line.  This directory is supposed
4480 to exist in @env{GCC_EXEC_PREFIX}.
4481
4482 @item -print-multi-lib
4483 @opindex print-multi-lib
4484 Print the mapping from multilib directory names to compiler switches
4485 that enable them.  The directory name is separated from the switches by
4486 @samp{;}, and each switch starts with an @samp{@@} instead of the
4487 @samp{-}, without spaces between multiple switches.  This is supposed to
4488 ease shell-processing.
4489
4490 @item -print-prog-name=@var{program}
4491 @opindex print-prog-name
4492 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4493
4494 @item -print-libgcc-file-name
4495 @opindex print-libgcc-file-name
4496 Same as @option{-print-file-name=libgcc.a}.
4497
4498 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4499 but you do want to link with @file{libgcc.a}.  You can do
4500
4501 @smallexample
4502 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4503 @end smallexample
4504
4505 @item -print-search-dirs
4506 @opindex print-search-dirs
4507 Print the name of the configured installation directory and a list of
4508 program and library directories @command{gcc} will search---and don't do anything else.
4509
4510 This is useful when @command{gcc} prints the error message
4511 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4512 To resolve this you either need to put @file{cpp0} and the other compiler
4513 components where @command{gcc} expects to find them, or you can set the environment
4514 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4515 Don't forget the trailing @samp{/}.
4516 @xref{Environment Variables}.
4517
4518 @item -dumpmachine
4519 @opindex dumpmachine
4520 Print the compiler's target machine (for example,
4521 @samp{i686-pc-linux-gnu})---and don't do anything else.
4522
4523 @item -dumpversion
4524 @opindex dumpversion
4525 Print the compiler version (for example, @samp{3.0})---and don't do
4526 anything else.
4527
4528 @item -dumpspecs
4529 @opindex dumpspecs
4530 Print the compiler's built-in specs---and don't do anything else.  (This
4531 is used when GCC itself is being built.)  @xref{Spec Files}.
4532
4533 @item -feliminate-unused-debug-types
4534 @opindex feliminate-unused-debug-types
4535 Normally, when producing DWARF2 output, GCC will emit debugging
4536 information for all types declared in a compilation
4537 unit, regardless of whether or not they are actually used
4538 in that compilation unit.  Sometimes this is useful, such as
4539 if, in the debugger, you want to cast a value to a type that is
4540 not actually used in your program (but is declared).  More often,
4541 however, this results in a significant amount of wasted space.
4542 With this option, GCC will avoid producing debug symbol output
4543 for types that are nowhere used in the source file being compiled.
4544 @end table
4545
4546 @node Optimize Options
4547 @section Options That Control Optimization
4548 @cindex optimize options
4549 @cindex options, optimization
4550
4551 These options control various sorts of optimizations.
4552
4553 Without any optimization option, the compiler's goal is to reduce the
4554 cost of compilation and to make debugging produce the expected
4555 results.  Statements are independent: if you stop the program with a
4556 breakpoint between statements, you can then assign a new value to any
4557 variable or change the program counter to any other statement in the
4558 function and get exactly the results you would expect from the source
4559 code.
4560
4561 Turning on optimization flags makes the compiler attempt to improve
4562 the performance and/or code size at the expense of compilation time
4563 and possibly the ability to debug the program.
4564
4565 The compiler performs optimization based on the knowledge it has of
4566 the program.  Optimization levels @option{-O} and above, in
4567 particular, enable @emph{unit-at-a-time} mode, which allows the
4568 compiler to consider information gained from later functions in
4569 the file when compiling a function.  Compiling multiple files at
4570 once to a single output file in @emph{unit-at-a-time} mode allows
4571 the compiler to use information gained from all of the files when
4572 compiling each of them.
4573
4574 Not all optimizations are controlled directly by a flag.  Only
4575 optimizations that have a flag are listed.
4576
4577 @table @gcctabopt
4578 @item -O
4579 @itemx -O1
4580 @opindex O
4581 @opindex O1
4582 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4583 more memory for a large function.
4584
4585 With @option{-O}, the compiler tries to reduce code size and execution
4586 time, without performing any optimizations that take a great deal of
4587 compilation time.
4588
4589 @option{-O} turns on the following optimization flags:
4590 @gccoptlist{-fdefer-pop @gol
4591 -fdelayed-branch @gol
4592 -fguess-branch-probability @gol
4593 -fcprop-registers @gol
4594 -fif-conversion @gol
4595 -fif-conversion2 @gol
4596 -fsplit-wide-types @gol
4597 -ftree-ccp @gol
4598 -ftree-dce @gol
4599 -ftree-dominator-opts @gol
4600 -ftree-dse @gol
4601 -ftree-ter @gol
4602 -ftree-lrs @gol
4603 -ftree-sra @gol
4604 -ftree-copyrename @gol
4605 -ftree-fre @gol
4606 -ftree-ch @gol
4607 -funit-at-a-time @gol
4608 -fmerge-constants}
4609
4610 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4611 where doing so does not interfere with debugging.
4612
4613 @item -O2
4614 @opindex O2
4615 Optimize even more.  GCC performs nearly all supported optimizations
4616 that do not involve a space-speed tradeoff.  The compiler does not
4617 perform loop unrolling or function inlining when you specify @option{-O2}.
4618 As compared to @option{-O}, this option increases both compilation time
4619 and the performance of the generated code.
4620
4621 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4622 also turns on the following optimization flags:
4623 @gccoptlist{-fthread-jumps @gol
4624 -fcrossjumping @gol
4625 -foptimize-sibling-calls @gol
4626 -fcse-follow-jumps  -fcse-skip-blocks @gol
4627 -fgcse  -fgcse-lm  @gol
4628 -fexpensive-optimizations @gol
4629 -frerun-cse-after-loop  @gol
4630 -fcaller-saves @gol
4631 -fpeephole2 @gol
4632 -fschedule-insns  -fschedule-insns2 @gol
4633 -fsched-interblock  -fsched-spec @gol
4634 -fregmove @gol
4635 -fstrict-aliasing -fstrict-overflow @gol
4636 -fdelete-null-pointer-checks @gol
4637 -freorder-blocks  -freorder-functions @gol
4638 -falign-functions  -falign-jumps @gol
4639 -falign-loops  -falign-labels @gol
4640 -ftree-vrp @gol
4641 -ftree-pre}
4642
4643 Please note the warning under @option{-fgcse} about
4644 invoking @option{-O2} on programs that use computed gotos.
4645
4646 @item -O3
4647 @opindex O3
4648 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4649 @option{-O2} and also turns on the @option{-finline-functions},
4650 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4651
4652 @item -O0
4653 @opindex O0
4654 Reduce compilation time and make debugging produce the expected
4655 results.  This is the default.
4656
4657 @item -Os
4658 @opindex Os
4659 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4660 do not typically increase code size.  It also performs further
4661 optimizations designed to reduce code size.
4662
4663 @option{-Os} disables the following optimization flags:
4664 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4665 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4666 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4667
4668 If you use multiple @option{-O} options, with or without level numbers,
4669 the last such option is the one that is effective.
4670 @end table
4671
4672 Options of the form @option{-f@var{flag}} specify machine-independent
4673 flags.  Most flags have both positive and negative forms; the negative
4674 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4675 below, only one of the forms is listed---the one you typically will
4676 use.  You can figure out the other form by either removing @samp{no-}
4677 or adding it.
4678
4679 The following options control specific optimizations.  They are either
4680 activated by @option{-O} options or are related to ones that are.  You
4681 can use the following flags in the rare cases when ``fine-tuning'' of
4682 optimizations to be performed is desired.
4683
4684 @table @gcctabopt
4685 @item -fno-default-inline
4686 @opindex fno-default-inline
4687 Do not make member functions inline by default merely because they are
4688 defined inside the class scope (C++ only).  Otherwise, when you specify
4689 @w{@option{-O}}, member functions defined inside class scope are compiled
4690 inline by default; i.e., you don't need to add @samp{inline} in front of
4691 the member function name.
4692
4693 @item -fno-defer-pop
4694 @opindex fno-defer-pop
4695 Always pop the arguments to each function call as soon as that function
4696 returns.  For machines which must pop arguments after a function call,
4697 the compiler normally lets arguments accumulate on the stack for several
4698 function calls and pops them all at once.
4699
4700 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4701
4702 @item -fforce-addr
4703 @opindex fforce-addr
4704 Force memory address constants to be copied into registers before
4705 doing arithmetic on them.
4706
4707 @item -fforward-propagate
4708 @opindex fforward-propagate
4709 Perform a forward propagation pass on RTL.  The pass tries to combine two
4710 instructions and checks if the result can be simplified.  If loop unrolling
4711 is active, two passes are performed and the second is scheduled after
4712 loop unrolling.
4713
4714 This option is enabled by default at optimization levels @option{-O2},
4715 @option{-O3}, @option{-Os}.
4716
4717 @item -fomit-frame-pointer
4718 @opindex fomit-frame-pointer
4719 Don't keep the frame pointer in a register for functions that
4720 don't need one.  This avoids the instructions to save, set up and
4721 restore frame pointers; it also makes an extra register available
4722 in many functions.  @strong{It also makes debugging impossible on
4723 some machines.}
4724
4725 On some machines, such as the VAX, this flag has no effect, because
4726 the standard calling sequence automatically handles the frame pointer
4727 and nothing is saved by pretending it doesn't exist.  The
4728 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4729 whether a target machine supports this flag.  @xref{Registers,,Register
4730 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4731
4732 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4733
4734 @item -foptimize-sibling-calls
4735 @opindex foptimize-sibling-calls
4736 Optimize sibling and tail recursive calls.
4737
4738 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4739
4740 @item -fno-inline
4741 @opindex fno-inline
4742 Don't pay attention to the @code{inline} keyword.  Normally this option
4743 is used to keep the compiler from expanding any functions inline.
4744 Note that if you are not optimizing, no functions can be expanded inline.
4745
4746 @item -finline-functions
4747 @opindex finline-functions
4748 Integrate all simple functions into their callers.  The compiler
4749 heuristically decides which functions are simple enough to be worth
4750 integrating in this way.
4751
4752 If all calls to a given function are integrated, and the function is
4753 declared @code{static}, then the function is normally not output as
4754 assembler code in its own right.
4755
4756 Enabled at level @option{-O3}.
4757
4758 @item -finline-functions-called-once
4759 @opindex finline-functions-called-once
4760 Consider all @code{static} functions called once for inlining into their
4761 caller even if they are not marked @code{inline}.  If a call to a given
4762 function is integrated, then the function is not output as assembler code
4763 in its own right.
4764
4765 Enabled if @option{-funit-at-a-time} is enabled.
4766
4767 @item -fearly-inlining
4768 @opindex fearly-inlining
4769 Inline functions marked by @code{always_inline} and functions whose body seems
4770 smaller than the function call overhead early before doing
4771 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4772 makes profiling significantly cheaper and usually inlining faster on programs
4773 having large chains of nested wrapper functions.
4774
4775 Enabled by default.
4776
4777 @item -finline-limit=@var{n}
4778 @opindex finline-limit
4779 By default, GCC limits the size of functions that can be inlined.  This flag
4780 allows the control of this limit for functions that are explicitly marked as
4781 inline (i.e., marked with the inline keyword or defined within the class
4782 definition in c++).  @var{n} is the size of functions that can be inlined in
4783 number of pseudo instructions (not counting parameter handling).  The default
4784 value of @var{n} is 600.
4785 Increasing this value can result in more inlined code at
4786 the cost of compilation time and memory consumption.  Decreasing usually makes
4787 the compilation faster and less code will be inlined (which presumably
4788 means slower programs).  This option is particularly useful for programs that
4789 use inlining heavily such as those based on recursive templates with C++.
4790
4791 Inlining is actually controlled by a number of parameters, which may be
4792 specified individually by using @option{--param @var{name}=@var{value}}.
4793 The @option{-finline-limit=@var{n}} option sets some of these parameters
4794 as follows:
4795
4796 @table @gcctabopt
4797 @item max-inline-insns-single
4798  is set to @var{n}/2.
4799 @item max-inline-insns-auto
4800  is set to @var{n}/2.
4801 @item min-inline-insns
4802  is set to 130 or @var{n}/4, whichever is smaller.
4803 @item max-inline-insns-rtl
4804  is set to @var{n}.
4805 @end table
4806
4807 See below for a documentation of the individual
4808 parameters controlling inlining.
4809
4810 @emph{Note:} pseudo instruction represents, in this particular context, an
4811 abstract measurement of function's size.  In no way does it represent a count
4812 of assembly instructions and as such its exact meaning might change from one
4813 release to an another.
4814
4815 @item -fkeep-inline-functions
4816 @opindex fkeep-inline-functions
4817 In C, emit @code{static} functions that are declared @code{inline}
4818 into the object file, even if the function has been inlined into all
4819 of its callers.  This switch does not affect functions using the
4820 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
4821 inline functions into the object file.
4822
4823 @item -fkeep-static-consts
4824 @opindex fkeep-static-consts
4825 Emit variables declared @code{static const} when optimization isn't turned
4826 on, even if the variables aren't referenced.
4827
4828 GCC enables this option by default.  If you want to force the compiler to
4829 check if the variable was referenced, regardless of whether or not
4830 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4831
4832 @item -fmerge-constants
4833 Attempt to merge identical constants (string constants and floating point
4834 constants) across compilation units.
4835
4836 This option is the default for optimized compilation if the assembler and
4837 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4838 behavior.
4839
4840 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4841
4842 @item -fmerge-all-constants
4843 Attempt to merge identical constants and identical variables.
4844
4845 This option implies @option{-fmerge-constants}.  In addition to
4846 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4847 arrays or initialized constant variables with integral or floating point
4848 types.  Languages like C or C++ require each non-automatic variable to
4849 have distinct location, so using this option will result in non-conforming
4850 behavior.
4851
4852 @item -fmodulo-sched
4853 @opindex fmodulo-sched
4854 Perform swing modulo scheduling immediately before the first scheduling
4855 pass.  This pass looks at innermost loops and reorders their
4856 instructions by overlapping different iterations.
4857
4858 @item -fno-branch-count-reg
4859 @opindex fno-branch-count-reg
4860 Do not use ``decrement and branch'' instructions on a count register,
4861 but instead generate a sequence of instructions that decrement a
4862 register, compare it against zero, then branch based upon the result.
4863 This option is only meaningful on architectures that support such
4864 instructions, which include x86, PowerPC, IA-64 and S/390.
4865
4866 The default is @option{-fbranch-count-reg}.
4867
4868 @item -fno-function-cse
4869 @opindex fno-function-cse
4870 Do not put function addresses in registers; make each instruction that
4871 calls a constant function contain the function's address explicitly.
4872
4873 This option results in less efficient code, but some strange hacks
4874 that alter the assembler output may be confused by the optimizations
4875 performed when this option is not used.
4876
4877 The default is @option{-ffunction-cse}
4878
4879 @item -fno-zero-initialized-in-bss
4880 @opindex fno-zero-initialized-in-bss
4881 If the target supports a BSS section, GCC by default puts variables that
4882 are initialized to zero into BSS@.  This can save space in the resulting
4883 code.
4884
4885 This option turns off this behavior because some programs explicitly
4886 rely on variables going to the data section.  E.g., so that the
4887 resulting executable can find the beginning of that section and/or make
4888 assumptions based on that.
4889
4890 The default is @option{-fzero-initialized-in-bss}.
4891
4892 @item -fbounds-check
4893 @opindex fbounds-check
4894 For front-ends that support it, generate additional code to check that
4895 indices used to access arrays are within the declared range.  This is
4896 currently only supported by the Java and Fortran front-ends, where
4897 this option defaults to true and false respectively.
4898
4899 @item -fmudflap -fmudflapth -fmudflapir
4900 @opindex fmudflap
4901 @opindex fmudflapth
4902 @opindex fmudflapir
4903 @cindex bounds checking
4904 @cindex mudflap
4905 For front-ends that support it (C and C++), instrument all risky
4906 pointer/array dereferencing operations, some standard library
4907 string/heap functions, and some other associated constructs with
4908 range/validity tests.  Modules so instrumented should be immune to
4909 buffer overflows, invalid heap use, and some other classes of C/C++
4910 programming errors.  The instrumentation relies on a separate runtime
4911 library (@file{libmudflap}), which will be linked into a program if
4912 @option{-fmudflap} is given at link time.  Run-time behavior of the
4913 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4914 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4915 for its options.
4916
4917 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4918 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4919 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4920 instrumentation should ignore pointer reads.  This produces less
4921 instrumentation (and therefore faster execution) and still provides
4922 some protection against outright memory corrupting writes, but allows
4923 erroneously read data to propagate within a program.
4924
4925 @item -fthread-jumps
4926 @opindex fthread-jumps
4927 Perform optimizations where we check to see if a jump branches to a
4928 location where another comparison subsumed by the first is found.  If
4929 so, the first branch is redirected to either the destination of the
4930 second branch or a point immediately following it, depending on whether
4931 the condition is known to be true or false.
4932
4933 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4934
4935 @item -fsplit-wide-types
4936 @opindex -fsplit-wide-types
4937 When using a type that occupies multiple registers, such as @code{long
4938 long} on a 32-bit system, split the registers apart and allocate them
4939 independently.  This normally generates better code for those types,
4940 but may make debugging more difficult.
4941
4942 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
4943 @option{-Os}.
4944
4945 @item -fcse-follow-jumps
4946 @opindex fcse-follow-jumps
4947 In common subexpression elimination, scan through jump instructions
4948 when the target of the jump is not reached by any other path.  For
4949 example, when CSE encounters an @code{if} statement with an
4950 @code{else} clause, CSE will follow the jump when the condition
4951 tested is false.
4952
4953 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4954
4955 @item -fcse-skip-blocks
4956 @opindex fcse-skip-blocks
4957 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4958 follow jumps which conditionally skip over blocks.  When CSE
4959 encounters a simple @code{if} statement with no else clause,
4960 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4961 body of the @code{if}.
4962
4963 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4964
4965 @item -frerun-cse-after-loop
4966 @opindex frerun-cse-after-loop
4967 Re-run common subexpression elimination after loop optimizations has been
4968 performed.
4969
4970 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4971
4972 @item -fgcse
4973 @opindex fgcse
4974 Perform a global common subexpression elimination pass.
4975 This pass also performs global constant and copy propagation.
4976
4977 @emph{Note:} When compiling a program using computed gotos, a GCC
4978 extension, you may get better runtime performance if you disable
4979 the global common subexpression elimination pass by adding
4980 @option{-fno-gcse} to the command line.
4981
4982 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4983
4984 @item -fgcse-lm
4985 @opindex fgcse-lm
4986 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4987 attempt to move loads which are only killed by stores into themselves.  This
4988 allows a loop containing a load/store sequence to be changed to a load outside
4989 the loop, and a copy/store within the loop.
4990
4991 Enabled by default when gcse is enabled.
4992
4993 @item -fgcse-sm
4994 @opindex fgcse-sm
4995 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4996 global common subexpression elimination.  This pass will attempt to move
4997 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4998 loops containing a load/store sequence can be changed to a load before
4999 the loop and a store after the loop.
5000
5001 Not enabled at any optimization level.
5002
5003 @item -fgcse-las
5004 @opindex fgcse-las
5005 When @option{-fgcse-las} is enabled, the global common subexpression
5006 elimination pass eliminates redundant loads that come after stores to the
5007 same memory location (both partial and full redundancies).
5008
5009 Not enabled at any optimization level.
5010
5011 @item -fgcse-after-reload
5012 @opindex fgcse-after-reload
5013 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
5014 pass is performed after reload.  The purpose of this pass is to cleanup
5015 redundant spilling.
5016
5017 @item -funsafe-loop-optimizations
5018 @opindex funsafe-loop-optimizations
5019 If given, the loop optimizer will assume that loop indices do not
5020 overflow, and that the loops with nontrivial exit condition are not
5021 infinite.  This enables a wider range of loop optimizations even if
5022 the loop optimizer itself cannot prove that these assumptions are valid.
5023 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
5024 if it finds this kind of loop.
5025
5026 @item -fcrossjumping
5027 @opindex crossjumping
5028 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
5029 resulting code may or may not perform better than without cross-jumping.
5030
5031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5032
5033 @item -fif-conversion
5034 @opindex if-conversion
5035 Attempt to transform conditional jumps into branch-less equivalents.  This
5036 include use of conditional moves, min, max, set flags and abs instructions, and
5037 some tricks doable by standard arithmetics.  The use of conditional execution
5038 on chips where it is available is controlled by @code{if-conversion2}.
5039
5040 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5041
5042 @item -fif-conversion2
5043 @opindex if-conversion2
5044 Use conditional execution (where available) to transform conditional jumps into
5045 branch-less equivalents.
5046
5047 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5048
5049 @item -fdelete-null-pointer-checks
5050 @opindex fdelete-null-pointer-checks
5051 Use global dataflow analysis to identify and eliminate useless checks
5052 for null pointers.  The compiler assumes that dereferencing a null
5053 pointer would have halted the program.  If a pointer is checked after
5054 it has already been dereferenced, it cannot be null.
5055
5056 In some environments, this assumption is not true, and programs can
5057 safely dereference null pointers.  Use
5058 @option{-fno-delete-null-pointer-checks} to disable this optimization
5059 for programs which depend on that behavior.
5060
5061 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5062
5063 @item -fexpensive-optimizations
5064 @opindex fexpensive-optimizations
5065 Perform a number of minor optimizations that are relatively expensive.
5066
5067 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5068
5069 @item -foptimize-register-move
5070 @itemx -fregmove
5071 @opindex foptimize-register-move
5072 @opindex fregmove
5073 Attempt to reassign register numbers in move instructions and as
5074 operands of other simple instructions in order to maximize the amount of
5075 register tying.  This is especially helpful on machines with two-operand
5076 instructions.
5077
5078 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5079 optimization.
5080
5081 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5082
5083 @item -fdelayed-branch
5084 @opindex fdelayed-branch
5085 If supported for the target machine, attempt to reorder instructions
5086 to exploit instruction slots available after delayed branch
5087 instructions.
5088
5089 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5090
5091 @item -fschedule-insns
5092 @opindex fschedule-insns
5093 If supported for the target machine, attempt to reorder instructions to
5094 eliminate execution stalls due to required data being unavailable.  This
5095 helps machines that have slow floating point or memory load instructions
5096 by allowing other instructions to be issued until the result of the load
5097 or floating point instruction is required.
5098
5099 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5100
5101 @item -fschedule-insns2
5102 @opindex fschedule-insns2
5103 Similar to @option{-fschedule-insns}, but requests an additional pass of
5104 instruction scheduling after register allocation has been done.  This is
5105 especially useful on machines with a relatively small number of
5106 registers and where memory load instructions take more than one cycle.
5107
5108 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5109
5110 @item -fno-sched-interblock
5111 @opindex fno-sched-interblock
5112 Don't schedule instructions across basic blocks.  This is normally
5113 enabled by default when scheduling before register allocation, i.e.@:
5114 with @option{-fschedule-insns} or at @option{-O2} or higher.
5115
5116 @item -fno-sched-spec
5117 @opindex fno-sched-spec
5118 Don't allow speculative motion of non-load instructions.  This is normally
5119 enabled by default when scheduling before register allocation, i.e.@:
5120 with @option{-fschedule-insns} or at @option{-O2} or higher.
5121
5122 @item -fsched-spec-load
5123 @opindex fsched-spec-load
5124 Allow speculative motion of some load instructions.  This only makes
5125 sense when scheduling before register allocation, i.e.@: with
5126 @option{-fschedule-insns} or at @option{-O2} or higher.
5127
5128 @item -fsched-spec-load-dangerous
5129 @opindex fsched-spec-load-dangerous
5130 Allow speculative motion of more load instructions.  This only makes
5131 sense when scheduling before register allocation, i.e.@: with
5132 @option{-fschedule-insns} or at @option{-O2} or higher.
5133
5134 @item -fsched-stalled-insns=@var{n}
5135 @opindex fsched-stalled-insns
5136 Define how many insns (if any) can be moved prematurely from the queue
5137 of stalled insns into the ready list, during the second scheduling pass.
5138
5139 @item -fsched-stalled-insns-dep=@var{n}
5140 @opindex fsched-stalled-insns-dep
5141 Define how many insn groups (cycles) will be examined for a dependency
5142 on a stalled insn that is candidate for premature removal from the queue
5143 of stalled insns.  Has an effect only during the second scheduling pass,
5144 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5145
5146 @item -fsched2-use-superblocks
5147 @opindex fsched2-use-superblocks
5148 When scheduling after register allocation, do use superblock scheduling
5149 algorithm.  Superblock scheduling allows motion across basic block boundaries
5150 resulting on faster schedules.  This option is experimental, as not all machine
5151 descriptions used by GCC model the CPU closely enough to avoid unreliable
5152 results from the algorithm.
5153
5154 This only makes sense when scheduling after register allocation, i.e.@: with
5155 @option{-fschedule-insns2} or at @option{-O2} or higher.
5156
5157 @item -fsched2-use-traces
5158 @opindex fsched2-use-traces
5159 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5160 allocation and additionally perform code duplication in order to increase the
5161 size of superblocks using tracer pass.  See @option{-ftracer} for details on
5162 trace formation.
5163
5164 This mode should produce faster but significantly longer programs.  Also
5165 without @option{-fbranch-probabilities} the traces constructed may not
5166 match the reality and hurt the performance.  This only makes
5167 sense when scheduling after register allocation, i.e.@: with
5168 @option{-fschedule-insns2} or at @option{-O2} or higher.
5169
5170 @item -fsee
5171 @opindex fsee
5172 Eliminates redundant extension instructions and move the non redundant
5173 ones to optimal placement using LCM.
5174
5175 @item -freschedule-modulo-scheduled-loops
5176 @opindex fscheduling-in-modulo-scheduled-loops
5177 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5178 we may want to prevent the later scheduling passes from changing its schedule, we use this
5179 option to control that.
5180
5181 @item -fcaller-saves
5182 @opindex fcaller-saves
5183 Enable values to be allocated in registers that will be clobbered by
5184 function calls, by emitting extra instructions to save and restore the
5185 registers around such calls.  Such allocation is done only when it
5186 seems to result in better code than would otherwise be produced.
5187
5188 This option is always enabled by default on certain machines, usually
5189 those which have no call-preserved registers to use instead.
5190
5191 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5192
5193 @item -ftree-pre
5194 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
5195 enabled by default at @option{-O2} and @option{-O3}.
5196
5197 @item -ftree-fre
5198 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5199 between FRE and PRE is that FRE only considers expressions
5200 that are computed on all paths leading to the redundant computation.
5201 This analysis faster than PRE, though it exposes fewer redundancies.
5202 This flag is enabled by default at @option{-O} and higher.
5203
5204 @item -ftree-copy-prop
5205 Perform copy propagation on trees.  This pass eliminates unnecessary
5206 copy operations.  This flag is enabled by default at @option{-O} and
5207 higher.
5208
5209 @item -ftree-store-copy-prop
5210 Perform copy propagation of memory loads and stores.  This pass
5211 eliminates unnecessary copy operations in memory references
5212 (structures, global variables, arrays, etc).  This flag is enabled by
5213 default at @option{-O2} and higher.
5214
5215 @item -ftree-salias
5216 Perform structural alias analysis on trees.  This flag
5217 is enabled by default at @option{-O} and higher.
5218
5219 @item -fipa-pta
5220 Perform interprocedural pointer analysis.
5221
5222 @item -ftree-sink
5223 Perform forward store motion  on trees.  This flag is
5224 enabled by default at @option{-O} and higher.
5225
5226 @item -ftree-ccp
5227 Perform sparse conditional constant propagation (CCP) on trees.  This
5228 pass only operates on local scalar variables and is enabled by default
5229 at @option{-O} and higher.
5230
5231 @item -ftree-store-ccp
5232 Perform sparse conditional constant propagation (CCP) on trees.  This
5233 pass operates on both local scalar variables and memory stores and
5234 loads (global variables, structures, arrays, etc).  This flag is
5235 enabled by default at @option{-O2} and higher.
5236
5237 @item -ftree-dce
5238 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5239 default at @option{-O} and higher.
5240
5241 @item -ftree-dominator-opts
5242 Perform a variety of simple scalar cleanups (constant/copy
5243 propagation, redundancy elimination, range propagation and expression
5244 simplification) based on a dominator tree traversal.  This also
5245 performs jump threading (to reduce jumps to jumps). This flag is
5246 enabled by default at @option{-O} and higher.
5247
5248 @item -ftree-ch
5249 Perform loop header copying on trees.  This is beneficial since it increases
5250 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5251 is enabled by default at @option{-O} and higher.  It is not enabled
5252 for @option{-Os}, since it usually increases code size.
5253
5254 @item -ftree-loop-optimize
5255 Perform loop optimizations on trees.  This flag is enabled by default
5256 at @option{-O} and higher.
5257
5258 @item -ftree-loop-linear
5259 Perform linear loop transformations on tree.  This flag can improve cache
5260 performance and allow further loop optimizations to take place.
5261
5262 @item -ftree-loop-im
5263 Perform loop invariant motion on trees.  This pass moves only invariants that
5264 would be hard to handle at RTL level (function calls, operations that expand to
5265 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5266 operands of conditions that are invariant out of the loop, so that we can use
5267 just trivial invariantness analysis in loop unswitching.  The pass also includes
5268 store motion.
5269
5270 @item -ftree-loop-ivcanon
5271 Create a canonical counter for number of iterations in the loop for that
5272 determining number of iterations requires complicated analysis.  Later
5273 optimizations then may determine the number easily.  Useful especially
5274 in connection with unrolling.
5275
5276 @item -fivopts
5277 Perform induction variable optimizations (strength reduction, induction
5278 variable merging and induction variable elimination) on trees.
5279
5280 @item -ftree-sra
5281 Perform scalar replacement of aggregates.  This pass replaces structure
5282 references with scalars to prevent committing structures to memory too
5283 early.  This flag is enabled by default at @option{-O} and higher.
5284
5285 @item -ftree-copyrename
5286 Perform copy renaming on trees.  This pass attempts to rename compiler
5287 temporaries to other variables at copy locations, usually resulting in
5288 variable names which more closely resemble the original variables.  This flag
5289 is enabled by default at @option{-O} and higher.
5290
5291 @item -ftree-ter
5292 Perform temporary expression replacement during the SSA->normal phase.  Single
5293 use/single def temporaries are replaced at their use location with their
5294 defining expression.  This results in non-GIMPLE code, but gives the expanders
5295 much more complex trees to work on resulting in better RTL generation.  This is
5296 enabled by default at @option{-O} and higher.
5297
5298 @item -ftree-lrs
5299 Perform live range splitting during the SSA->normal phase.  Distinct live
5300 ranges of a variable are split into unique variables, allowing for better
5301 optimization later.  This is enabled by default at @option{-O} and higher.
5302
5303 @item -ftree-vectorize
5304 Perform loop vectorization on trees.
5305
5306 @item -ftree-vect-loop-version
5307 @opindex ftree-vect-loop-version
5308 Perform loop versioning when doing loop vectorization on trees.  When a loop
5309 appears to be vectorizable except that data alignment or data dependence cannot
5310 be determined at compile time then vectorized and non-vectorized versions of
5311 the loop are generated along with runtime checks for alignment or dependence
5312 to control which version is executed.  This option is enabled by default
5313 except at level @option{-Os} where it is disabled.
5314
5315 @item -ftree-vrp
5316 Perform Value Range Propagation on trees.  This is similar to the
5317 constant propagation pass, but instead of values, ranges of values are
5318 propagated.  This allows the optimizers to remove unnecessary range
5319 checks like array bound checks and null pointer checks.  This is
5320 enabled by default at @option{-O2} and higher.  Null pointer check
5321 elimination is only done if @option{-fdelete-null-pointer-checks} is
5322 enabled.
5323
5324 @item -ftracer
5325 @opindex ftracer
5326 Perform tail duplication to enlarge superblock size.  This transformation
5327 simplifies the control flow of the function allowing other optimizations to do
5328 better job.
5329
5330 @item -funroll-loops
5331 @opindex funroll-loops
5332 Unroll loops whose number of iterations can be determined at compile
5333 time or upon entry to the loop.  @option{-funroll-loops} implies
5334 @option{-frerun-cse-after-loop}.  This option makes code larger,
5335 and may or may not make it run faster.
5336
5337 @item -funroll-all-loops
5338 @opindex funroll-all-loops
5339 Unroll all loops, even if their number of iterations is uncertain when
5340 the loop is entered.  This usually makes programs run more slowly.
5341 @option{-funroll-all-loops} implies the same options as
5342 @option{-funroll-loops},
5343
5344 @item -fsplit-ivs-in-unroller
5345 @opindex -fsplit-ivs-in-unroller
5346 Enables expressing of values of induction variables in later iterations
5347 of the unrolled loop using the value in the first iteration.  This breaks
5348 long dependency chains, thus improving efficiency of the scheduling passes.
5349
5350 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5351 same effect.  However in cases the loop body is more complicated than
5352 a single basic block, this is not reliable.  It also does not work at all
5353 on some of the architectures due to restrictions in the CSE pass.
5354
5355 This optimization is enabled by default.
5356
5357 @item -fvariable-expansion-in-unroller
5358 @opindex -fvariable-expansion-in-unroller
5359 With this option, the compiler will create multiple copies of some
5360 local variables when unrolling a loop which can result in superior code.
5361
5362 @item -fprefetch-loop-arrays
5363 @opindex fprefetch-loop-arrays
5364 If supported by the target machine, generate instructions to prefetch
5365 memory to improve the performance of loops that access large arrays.
5366
5367 This option may generate better or worse code; results are highly
5368 dependent on the structure of loops within the source code.
5369
5370 Disabled at level @option{-Os}.
5371
5372 @item -fno-peephole
5373 @itemx -fno-peephole2
5374 @opindex fno-peephole
5375 @opindex fno-peephole2
5376 Disable any machine-specific peephole optimizations.  The difference
5377 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5378 are implemented in the compiler; some targets use one, some use the
5379 other, a few use both.
5380
5381 @option{-fpeephole} is enabled by default.
5382 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5383
5384 @item -fno-guess-branch-probability
5385 @opindex fno-guess-branch-probability
5386 Do not guess branch probabilities using heuristics.
5387
5388 GCC will use heuristics to guess branch probabilities if they are
5389 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5390 heuristics are based on the control flow graph.  If some branch probabilities
5391 are specified by @samp{__builtin_expect}, then the heuristics will be
5392 used to guess branch probabilities for the rest of the control flow graph,
5393 taking the @samp{__builtin_expect} info into account.  The interactions
5394 between the heuristics and @samp{__builtin_expect} can be complex, and in
5395 some cases, it may be useful to disable the heuristics so that the effects
5396 of @samp{__builtin_expect} are easier to understand.
5397
5398 The default is @option{-fguess-branch-probability} at levels
5399 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5400
5401 @item -freorder-blocks
5402 @opindex freorder-blocks
5403 Reorder basic blocks in the compiled function in order to reduce number of
5404 taken branches and improve code locality.
5405
5406 Enabled at levels @option{-O2}, @option{-O3}.
5407
5408 @item -freorder-blocks-and-partition
5409 @opindex freorder-blocks-and-partition
5410 In addition to reordering basic blocks in the compiled function, in order
5411 to reduce number of taken branches, partitions hot and cold basic blocks
5412 into separate sections of the assembly and .o files, to improve
5413 paging and cache locality performance.
5414
5415 This optimization is automatically turned off in the presence of
5416 exception handling, for linkonce sections, for functions with a user-defined
5417 section attribute and on any architecture that does not support named
5418 sections.
5419
5420 @item -freorder-functions
5421 @opindex freorder-functions
5422 Reorder functions in the object file in order to
5423 improve code locality.  This is implemented by using special
5424 subsections @code{.text.hot} for most frequently executed functions and
5425 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5426 the linker so object file format must support named sections and linker must
5427 place them in a reasonable way.
5428
5429 Also profile feedback must be available in to make this option effective.  See
5430 @option{-fprofile-arcs} for details.
5431
5432 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5433
5434 @item -fstrict-aliasing
5435 @opindex fstrict-aliasing
5436 Allows the compiler to assume the strictest aliasing rules applicable to
5437 the language being compiled.  For C (and C++), this activates
5438 optimizations based on the type of expressions.  In particular, an
5439 object of one type is assumed never to reside at the same address as an
5440 object of a different type, unless the types are almost the same.  For
5441 example, an @code{unsigned int} can alias an @code{int}, but not a
5442 @code{void*} or a @code{double}.  A character type may alias any other
5443 type.
5444
5445 Pay special attention to code like this:
5446 @smallexample
5447 union a_union @{
5448   int i;
5449   double d;
5450 @};
5451
5452 int f() @{
5453   a_union t;
5454   t.d = 3.0;
5455   return t.i;
5456 @}
5457 @end smallexample
5458 The practice of reading from a different union member than the one most
5459 recently written to (called ``type-punning'') is common.  Even with
5460 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5461 is accessed through the union type.  So, the code above will work as
5462 expected.  However, this code might not:
5463 @smallexample
5464 int f() @{
5465   a_union t;
5466   int* ip;
5467   t.d = 3.0;
5468   ip = &t.i;
5469   return *ip;
5470 @}
5471 @end smallexample
5472
5473 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5474
5475 @item -fstrict-overflow
5476 @opindex fstrict-overflow
5477 Allow the compiler to assume strict signed overflow rules, depending
5478 on the language being compiled.  For C (and C++) this means that
5479 overflow when doing arithmetic with signed numbers is undefined, which
5480 means that the compiler may assume that it will not happen.  This
5481 permits various optimizations.  For example, the compiler will assume
5482 that an expression like @code{i + 10 > i} will always be true for
5483 signed @code{i}.  This assumption is only valid if signed overflow is
5484 undefined, as the expression is false if @code{i + 10} overflows when
5485 using twos complement arithmetic.  When this option is in effect any
5486 attempt to determine whether an operation on signed numbers will
5487 overflow must be written carefully to not actually involve overflow.
5488
5489 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
5490 that signed overflow is fully defined: it wraps.  When
5491 @option{-fwrapv} is used, there is no difference between
5492 @option{-fstrict-overflow} and @option{-fno-strict-overflow}.  With
5493 @option{-fwrapv} certain types of overflow are permitted.  For
5494 example, if the compiler gets an overflow when doing arithmetic on
5495 constants, the overflowed value can still be used with
5496 @option{-fwrapv}, but not otherwise.
5497
5498 The @option{-fstrict-overflow} option is enabled at levels
5499 @option{-O2}, @option{-O3}, @option{-Os}.
5500
5501 @item -falign-functions
5502 @itemx -falign-functions=@var{n}
5503 @opindex falign-functions
5504 Align the start of functions to the next power-of-two greater than
5505 @var{n}, skipping up to @var{n} bytes.  For instance,
5506 @option{-falign-functions=32} aligns functions to the next 32-byte
5507 boundary, but @option{-falign-functions=24} would align to the next
5508 32-byte boundary only if this can be done by skipping 23 bytes or less.
5509
5510 @option{-fno-align-functions} and @option{-falign-functions=1} are
5511 equivalent and mean that functions will not be aligned.
5512
5513 Some assemblers only support this flag when @var{n} is a power of two;
5514 in that case, it is rounded up.
5515
5516 If @var{n} is not specified or is zero, use a machine-dependent default.
5517
5518 Enabled at levels @option{-O2}, @option{-O3}.
5519
5520 @item -falign-labels
5521 @itemx -falign-labels=@var{n}
5522 @opindex falign-labels
5523 Align all branch targets to a power-of-two boundary, skipping up to
5524 @var{n} bytes like @option{-falign-functions}.  This option can easily
5525 make code slower, because it must insert dummy operations for when the
5526 branch target is reached in the usual flow of the code.
5527
5528 @option{-fno-align-labels} and @option{-falign-labels=1} are
5529 equivalent and mean that labels will not be aligned.
5530
5531 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5532 are greater than this value, then their values are used instead.
5533
5534 If @var{n} is not specified or is zero, use a machine-dependent default
5535 which is very likely to be @samp{1}, meaning no alignment.
5536
5537 Enabled at levels @option{-O2}, @option{-O3}.
5538
5539 @item -falign-loops
5540 @itemx -falign-loops=@var{n}
5541 @opindex falign-loops
5542 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5543 like @option{-falign-functions}.  The hope is that the loop will be
5544 executed many times, which will make up for any execution of the dummy
5545 operations.
5546
5547 @option{-fno-align-loops} and @option{-falign-loops=1} are
5548 equivalent and mean that loops will not be aligned.
5549
5550 If @var{n} is not specified or is zero, use a machine-dependent default.
5551
5552 Enabled at levels @option{-O2}, @option{-O3}.
5553
5554 @item -falign-jumps
5555 @itemx -falign-jumps=@var{n}
5556 @opindex falign-jumps
5557 Align branch targets to a power-of-two boundary, for branch targets
5558 where the targets can only be reached by jumping, skipping up to @var{n}
5559 bytes like @option{-falign-functions}.  In this case, no dummy operations
5560 need be executed.
5561
5562 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5563 equivalent and mean that loops will not be aligned.
5564
5565 If @var{n} is not specified or is zero, use a machine-dependent default.
5566
5567 Enabled at levels @option{-O2}, @option{-O3}.
5568
5569 @item -funit-at-a-time
5570 @opindex funit-at-a-time
5571 Parse the whole compilation unit before starting to produce code.
5572 This allows some extra optimizations to take place but consumes
5573 more memory (in general).  There are some compatibility issues
5574 with @emph{unit-at-a-time} mode:
5575 @itemize @bullet
5576 @item
5577 enabling @emph{unit-at-a-time} mode may change the order
5578 in which functions, variables, and top-level @code{asm} statements
5579 are emitted, and will likely break code relying on some particular
5580 ordering.  The majority of such top-level @code{asm} statements,
5581 though, can be replaced by @code{section} attributes.  The
5582 @option{fno-toplevel-reorder} option may be used to keep the ordering
5583 used in the input file, at the cost of some optimizations.
5584
5585 @item
5586 @emph{unit-at-a-time} mode removes unreferenced static variables
5587 and functions.  This may result in undefined references
5588 when an @code{asm} statement refers directly to variables or functions
5589 that are otherwise unused.  In that case either the variable/function
5590 shall be listed as an operand of the @code{asm} statement operand or,
5591 in the case of top-level @code{asm} statements the attribute @code{used}
5592 shall be used on the declaration.
5593
5594 @item
5595 Static functions now can use non-standard passing conventions that
5596 may break @code{asm} statements calling functions directly.  Again,
5597 attribute @code{used} will prevent this behavior.
5598 @end itemize
5599
5600 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5601 but this scheme may not be supported by future releases of GCC@.
5602
5603 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5604
5605 @item -fno-toplevel-reorder
5606 Do not reorder top-level functions, variables, and @code{asm}
5607 statements.  Output them in the same order that they appear in the
5608 input file.  When this option is used, unreferenced static variables
5609 will not be removed.  This option is intended to support existing code
5610 which relies on a particular ordering.  For new code, it is better to
5611 use attributes.
5612
5613 @item -fweb
5614 @opindex fweb
5615 Constructs webs as commonly used for register allocation purposes and assign
5616 each web individual pseudo register.  This allows the register allocation pass
5617 to operate on pseudos directly, but also strengthens several other optimization
5618 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5619 however, make debugging impossible, since variables will no longer stay in a
5620 ``home register''.
5621
5622 Enabled by default with @option{-funroll-loops}.
5623
5624 @item -fwhole-program
5625 @opindex fwhole-program
5626 Assume that the current compilation unit represents whole program being
5627 compiled.  All public functions and variables with the exception of @code{main}
5628 and those merged by attribute @code{externally_visible} become static functions
5629 and in a affect gets more aggressively optimized by interprocedural optimizers.
5630 While this option is equivalent to proper use of @code{static} keyword for
5631 programs consisting of single file, in combination with option
5632 @option{--combine} this flag can be used to compile most of smaller scale C
5633 programs since the functions and variables become local for the whole combined
5634 compilation unit, not for the single source file itself.
5635
5636
5637 @item -fno-cprop-registers
5638 @opindex fno-cprop-registers
5639 After register allocation and post-register allocation instruction splitting,
5640 we perform a copy-propagation pass to try to reduce scheduling dependencies
5641 and occasionally eliminate the copy.
5642
5643 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5644
5645 @item -fprofile-generate
5646 @opindex fprofile-generate
5647
5648 Enable options usually used for instrumenting application to produce
5649 profile useful for later recompilation with profile feedback based
5650 optimization.  You must use @option{-fprofile-generate} both when
5651 compiling and when linking your program.
5652
5653 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5654
5655 @item -fprofile-use
5656 @opindex fprofile-use
5657 Enable profile feedback directed optimizations, and optimizations
5658 generally profitable only with profile feedback available.
5659
5660 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5661 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5662
5663 By default, GCC emits an error message if the feedback profiles do not
5664 match the source code.  This error can be turned into a warning by using
5665 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
5666 code.
5667 @end table
5668
5669 The following options control compiler behavior regarding floating
5670 point arithmetic.  These options trade off between speed and
5671 correctness.  All must be specifically enabled.
5672
5673 @table @gcctabopt
5674 @item -ffloat-store
5675 @opindex ffloat-store
5676 Do not store floating point variables in registers, and inhibit other
5677 options that might change whether a floating point value is taken from a
5678 register or memory.
5679
5680 @cindex floating point precision
5681 This option prevents undesirable excess precision on machines such as
5682 the 68000 where the floating registers (of the 68881) keep more
5683 precision than a @code{double} is supposed to have.  Similarly for the
5684 x86 architecture.  For most programs, the excess precision does only
5685 good, but a few programs rely on the precise definition of IEEE floating
5686 point.  Use @option{-ffloat-store} for such programs, after modifying
5687 them to store all pertinent intermediate computations into variables.
5688
5689 @item -ffast-math
5690 @opindex ffast-math
5691 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5692 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5693 @option{-fno-rounding-math}, @option{-fno-signaling-nans},
5694 @option{-fno-signed-zeros} and @option{fcx-limited-range}.
5695
5696 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5697
5698 This option should never be turned on by any @option{-O} option since
5699 it can result in incorrect output for programs which depend on
5700 an exact implementation of IEEE or ISO rules/specifications for
5701 math functions.
5702
5703 @item -fno-math-errno
5704 @opindex fno-math-errno
5705 Do not set ERRNO after calling math functions that are executed
5706 with a single instruction, e.g., sqrt.  A program that relies on
5707 IEEE exceptions for math error handling may want to use this flag
5708 for speed while maintaining IEEE arithmetic compatibility.
5709
5710 This option should never be turned on by any @option{-O} option since
5711 it can result in incorrect output for programs which depend on
5712 an exact implementation of IEEE or ISO rules/specifications for
5713 math functions.
5714
5715 The default is @option{-fmath-errno}.
5716
5717 On Darwin systems, the math library never sets @code{errno}.  There is
5718 therefore no reason for the compiler to consider the possibility that
5719 it might, and @option{-fno-math-errno} is the default.
5720
5721 @item -funsafe-math-optimizations
5722 @opindex funsafe-math-optimizations
5723 Allow optimizations for floating-point arithmetic that (a) assume
5724 that arguments and results are valid and (b) may violate IEEE or
5725 ANSI standards.  When used at link-time, it may include libraries
5726 or startup files that change the default FPU control word or other
5727 similar optimizations.
5728
5729 This option should never be turned on by any @option{-O} option since
5730 it can result in incorrect output for programs which depend on
5731 an exact implementation of IEEE or ISO rules/specifications for
5732 math functions.
5733
5734 The default is @option{-fno-unsafe-math-optimizations}.
5735
5736 @item -ffinite-math-only
5737 @opindex ffinite-math-only
5738 Allow optimizations for floating-point arithmetic that assume
5739 that arguments and results are not NaNs or +-Infs.
5740
5741 This option should never be turned on by any @option{-O} option since
5742 it can result in incorrect output for programs which depend on
5743 an exact implementation of IEEE or ISO rules/specifications.
5744
5745 The default is @option{-fno-finite-math-only}.
5746
5747 @item -fno-signed-zeros
5748 @opindex fno-signed-zeros
5749 Allow optimizations for floating point arithmetic that ignore the
5750 signedness of zero.  IEEE arithmetic specifies the behavior of
5751 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
5752 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
5753 This option implies that the sign of a zero result isn't significant.
5754
5755 The default is @option{-fsigned-zeros}.
5756
5757 @item -fno-trapping-math
5758 @opindex fno-trapping-math
5759 Compile code assuming that floating-point operations cannot generate
5760 user-visible traps.  These traps include division by zero, overflow,
5761 underflow, inexact result and invalid operation.  This option implies
5762 @option{-fno-signaling-nans}.  Setting this option may allow faster
5763 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5764
5765 This option should never be turned on by any @option{-O} option since
5766 it can result in incorrect output for programs which depend on
5767 an exact implementation of IEEE or ISO rules/specifications for
5768 math functions.
5769
5770 The default is @option{-ftrapping-math}.
5771
5772 @item -frounding-math
5773 @opindex frounding-math
5774 Disable transformations and optimizations that assume default floating
5775 point rounding behavior.  This is round-to-zero for all floating point
5776 to integer conversions, and round-to-nearest for all other arithmetic
5777 truncations.  This option should be specified for programs that change
5778 the FP rounding mode dynamically, or that may be executed with a
5779 non-default rounding mode.  This option disables constant folding of
5780 floating point expressions at compile-time (which may be affected by
5781 rounding mode) and arithmetic transformations that are unsafe in the
5782 presence of sign-dependent rounding modes.
5783
5784 The default is @option{-fno-rounding-math}.
5785
5786 This option is experimental and does not currently guarantee to
5787 disable all GCC optimizations that are affected by rounding mode.
5788 Future versions of GCC may provide finer control of this setting
5789 using C99's @code{FENV_ACCESS} pragma.  This command line option
5790 will be used to specify the default state for @code{FENV_ACCESS}.
5791
5792 @item -frtl-abstract-sequences
5793 @opindex frtl-abstract-sequences
5794 It is a size optimization method. This option is to find identical
5795 sequences of code, which can be turned into pseudo-procedures  and
5796 then  replace  all  occurrences with  calls to  the  newly created
5797 subroutine. It is kind of an opposite of @option{-finline-functions}.
5798 This optimization runs at RTL level.
5799
5800 @item -fsignaling-nans
5801 @opindex fsignaling-nans
5802 Compile code assuming that IEEE signaling NaNs may generate user-visible
5803 traps during floating-point operations.  Setting this option disables
5804 optimizations that may change the number of exceptions visible with
5805 signaling NaNs.  This option implies @option{-ftrapping-math}.
5806
5807 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5808 be defined.
5809
5810 The default is @option{-fno-signaling-nans}.
5811
5812 This option is experimental and does not currently guarantee to
5813 disable all GCC optimizations that affect signaling NaN behavior.
5814
5815 @item -fsingle-precision-constant
5816 @opindex fsingle-precision-constant
5817 Treat floating point constant as single precision constant instead of
5818 implicitly converting it to double precision constant.
5819
5820 @item -fcx-limited-range
5821 @itemx -fno-cx-limited-range
5822 @opindex fcx-limited-range
5823 @opindex fno-cx-limited-range
5824 When enabled, this option states that a range reduction step is not
5825 needed when performing complex division.  The default is
5826 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5827
5828 This option controls the default setting of the ISO C99 
5829 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5830 all languages.
5831
5832 @end table
5833
5834 The following options control optimizations that may improve
5835 performance, but are not enabled by any @option{-O} options.  This
5836 section includes experimental options that may produce broken code.
5837
5838 @table @gcctabopt
5839 @item -fbranch-probabilities
5840 @opindex fbranch-probabilities
5841 After running a program compiled with @option{-fprofile-arcs}
5842 (@pxref{Debugging Options,, Options for Debugging Your Program or
5843 @command{gcc}}), you can compile it a second time using
5844 @option{-fbranch-probabilities}, to improve optimizations based on
5845 the number of times each branch was taken.  When the program
5846 compiled with @option{-fprofile-arcs} exits it saves arc execution
5847 counts to a file called @file{@var{sourcename}.gcda} for each source
5848 file.  The information in this data file is very dependent on the
5849 structure of the generated code, so you must use the same source code
5850 and the same optimization options for both compilations.
5851
5852 With @option{-fbranch-probabilities}, GCC puts a
5853 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5854 These can be used to improve optimization.  Currently, they are only
5855 used in one place: in @file{reorg.c}, instead of guessing which path a
5856 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5857 exactly determine which path is taken more often.
5858
5859 @item -fprofile-values
5860 @opindex fprofile-values
5861 If combined with @option{-fprofile-arcs}, it adds code so that some
5862 data about values of expressions in the program is gathered.
5863
5864 With @option{-fbranch-probabilities}, it reads back the data gathered
5865 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5866 notes to instructions for their later usage in optimizations.
5867
5868 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5869
5870 @item -fvpt
5871 @opindex fvpt
5872 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5873 a code to gather information about values of expressions.
5874
5875 With @option{-fbranch-probabilities}, it reads back the data gathered
5876 and actually performs the optimizations based on them.
5877 Currently the optimizations include specialization of division operation
5878 using the knowledge about the value of the denominator.
5879
5880 @item -frename-registers
5881 @opindex frename-registers
5882 Attempt to avoid false dependencies in scheduled code by making use
5883 of registers left over after register allocation.  This optimization
5884 will most benefit processors with lots of registers.  Depending on the
5885 debug information format adopted by the target, however, it can
5886 make debugging impossible, since variables will no longer stay in
5887 a ``home register''.
5888
5889 Enabled by default with @option{-funroll-loops}.
5890
5891 @item -ftracer
5892 @opindex ftracer
5893 Perform tail duplication to enlarge superblock size.  This transformation
5894 simplifies the control flow of the function allowing other optimizations to do
5895 better job.
5896
5897 Enabled with @option{-fprofile-use}.
5898
5899 @item -funroll-loops
5900 @opindex funroll-loops
5901 Unroll loops whose number of iterations can be determined at compile time or
5902 upon entry to the loop.  @option{-funroll-loops} implies
5903 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5904 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5905 small constant number of iterations).  This option makes code larger, and may
5906 or may not make it run faster.
5907
5908 Enabled with @option{-fprofile-use}.
5909
5910 @item -funroll-all-loops
5911 @opindex funroll-all-loops
5912 Unroll all loops, even if their number of iterations is uncertain when
5913 the loop is entered.  This usually makes programs run more slowly.
5914 @option{-funroll-all-loops} implies the same options as
5915 @option{-funroll-loops}.
5916
5917 @item -fpeel-loops
5918 @opindex fpeel-loops
5919 Peels the loops for that there is enough information that they do not
5920 roll much (from profile feedback).  It also turns on complete loop peeling
5921 (i.e.@: complete removal of loops with small constant number of iterations).
5922
5923 Enabled with @option{-fprofile-use}.
5924
5925 @item -fmove-loop-invariants
5926 @opindex fmove-loop-invariants
5927 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5928 at level @option{-O1}
5929
5930 @item -funswitch-loops
5931 @opindex funswitch-loops
5932 Move branches with loop invariant conditions out of the loop, with duplicates
5933 of the loop on both branches (modified according to result of the condition).
5934
5935 @item -ffunction-sections
5936 @itemx -fdata-sections
5937 @opindex ffunction-sections
5938 @opindex fdata-sections
5939 Place each function or data item into its own section in the output
5940 file if the target supports arbitrary sections.  The name of the
5941 function or the name of the data item determines the section's name
5942 in the output file.
5943
5944 Use these options on systems where the linker can perform optimizations
5945 to improve locality of reference in the instruction space.  Most systems
5946 using the ELF object format and SPARC processors running Solaris 2 have
5947 linkers with such optimizations.  AIX may have these optimizations in
5948 the future.
5949
5950 Only use these options when there are significant benefits from doing
5951 so.  When you specify these options, the assembler and linker will
5952 create larger object and executable files and will also be slower.
5953 You will not be able to use @code{gprof} on all systems if you
5954 specify this option and you may have problems with debugging if
5955 you specify both this option and @option{-g}.
5956
5957 @item -fbranch-target-load-optimize
5958 @opindex fbranch-target-load-optimize
5959 Perform branch target register load optimization before prologue / epilogue
5960 threading.
5961 The use of target registers can typically be exposed only during reload,
5962 thus hoisting loads out of loops and doing inter-block scheduling needs
5963 a separate optimization pass.
5964
5965 @item -fbranch-target-load-optimize2
5966 @opindex fbranch-target-load-optimize2
5967 Perform branch target register load optimization after prologue / epilogue
5968 threading.
5969
5970 @item -fbtr-bb-exclusive
5971 @opindex fbtr-bb-exclusive
5972 When performing branch target register load optimization, don't reuse
5973 branch target registers in within any basic block.
5974
5975 @item -fstack-protector
5976 Emit extra code to check for buffer overflows, such as stack smashing
5977 attacks.  This is done by adding a guard variable to functions with
5978 vulnerable objects.  This includes functions that call alloca, and
5979 functions with buffers larger than 8 bytes.  The guards are initialized
5980 when a function is entered and then checked when the function exits.
5981 If a guard check fails, an error message is printed and the program exits.
5982
5983 @item -fstack-protector-all
5984 Like @option{-fstack-protector} except that all functions are protected.
5985
5986 @item -fsection-anchors
5987 @opindex fsection-anchors
5988 Try to reduce the number of symbolic address calculations by using
5989 shared ``anchor'' symbols to address nearby objects.  This transformation
5990 can help to reduce the number of GOT entries and GOT accesses on some
5991 targets.
5992
5993 For example, the implementation of the following function @code{foo}:
5994
5995 @smallexample
5996 static int a, b, c;
5997 int foo (void) @{ return a + b + c; @}
5998 @end smallexample
5999
6000 would usually calculate the addresses of all three variables, but if you
6001 compile it with @option{-fsection-anchors}, it will access the variables
6002 from a common anchor point instead.  The effect is similar to the
6003 following pseudocode (which isn't valid C):
6004
6005 @smallexample
6006 int foo (void)
6007 @{
6008   register int *xr = &x;
6009   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
6010 @}
6011 @end smallexample
6012
6013 Not all targets support this option.
6014
6015 @item --param @var{name}=@var{value}
6016 @opindex param
6017 In some places, GCC uses various constants to control the amount of
6018 optimization that is done.  For example, GCC will not inline functions
6019 that contain more that a certain number of instructions.  You can
6020 control some of these constants on the command-line using the
6021 @option{--param} option.
6022
6023 The names of specific parameters, and the meaning of the values, are
6024 tied to the internals of the compiler, and are subject to change
6025 without notice in future releases.
6026
6027 In each case, the @var{value} is an integer.  The allowable choices for
6028 @var{name} are given in the following table:
6029
6030 @table @gcctabopt
6031 @item salias-max-implicit-fields
6032 The maximum number of fields in a variable without direct
6033 structure accesses for which structure aliasing will consider trying 
6034 to track each field.  The default is 5
6035
6036 @item salias-max-array-elements
6037 The maximum number of elements an array can have and its elements
6038 still be tracked individually by structure aliasing. The default is 4
6039
6040 @item sra-max-structure-size
6041 The maximum structure size, in bytes, at which the scalar replacement
6042 of aggregates (SRA) optimization will perform block copies.  The
6043 default value, 0, implies that GCC will select the most appropriate
6044 size itself.
6045
6046 @item sra-field-structure-ratio
6047 The threshold ratio (as a percentage) between instantiated fields and
6048 the complete structure size.  We say that if the ratio of the number
6049 of bytes in instantiated fields to the number of bytes in the complete
6050 structure exceeds this parameter, then block copies are not used.  The
6051 default is 75.
6052
6053 @item max-crossjump-edges
6054 The maximum number of incoming edges to consider for crossjumping.
6055 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
6056 the number of edges incoming to each block.  Increasing values mean
6057 more aggressive optimization, making the compile time increase with
6058 probably small improvement in executable size.
6059
6060 @item min-crossjump-insns
6061 The minimum number of instructions which must be matched at the end
6062 of two blocks before crossjumping will be performed on them.  This
6063 value is ignored in the case where all instructions in the block being
6064 crossjumped from are matched.  The default value is 5.
6065
6066 @item max-grow-copy-bb-insns
6067 The maximum code size expansion factor when copying basic blocks
6068 instead of jumping.  The expansion is relative to a jump instruction.
6069 The default value is 8.
6070
6071 @item max-goto-duplication-insns
6072 The maximum number of instructions to duplicate to a block that jumps
6073 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
6074 passes, GCC factors computed gotos early in the compilation process,
6075 and unfactors them as late as possible.  Only computed jumps at the
6076 end of a basic blocks with no more than max-goto-duplication-insns are
6077 unfactored.  The default value is 8.
6078
6079 @item max-delay-slot-insn-search
6080 The maximum number of instructions to consider when looking for an
6081 instruction to fill a delay slot.  If more than this arbitrary number of
6082 instructions is searched, the time savings from filling the delay slot
6083 will be minimal so stop searching.  Increasing values mean more
6084 aggressive optimization, making the compile time increase with probably
6085 small improvement in executable run time.
6086
6087 @item max-delay-slot-live-search
6088 When trying to fill delay slots, the maximum number of instructions to
6089 consider when searching for a block with valid live register
6090 information.  Increasing this arbitrarily chosen value means more
6091 aggressive optimization, increasing the compile time.  This parameter
6092 should be removed when the delay slot code is rewritten to maintain the
6093 control-flow graph.
6094
6095 @item max-gcse-memory
6096 The approximate maximum amount of memory that will be allocated in
6097 order to perform the global common subexpression elimination
6098 optimization.  If more memory than specified is required, the
6099 optimization will not be done.
6100
6101 @item max-gcse-passes
6102 The maximum number of passes of GCSE to run.  The default is 1.
6103
6104 @item max-pending-list-length
6105 The maximum number of pending dependencies scheduling will allow
6106 before flushing the current state and starting over.  Large functions
6107 with few branches or calls can create excessively large lists which
6108 needlessly consume memory and resources.
6109
6110 @item max-inline-insns-single
6111 Several parameters control the tree inliner used in gcc.
6112 This number sets the maximum number of instructions (counted in GCC's
6113 internal representation) in a single function that the tree inliner
6114 will consider for inlining.  This only affects functions declared
6115 inline and methods implemented in a class declaration (C++).
6116 The default value is 450.
6117
6118 @item max-inline-insns-auto
6119 When you use @option{-finline-functions} (included in @option{-O3}),
6120 a lot of functions that would otherwise not be considered for inlining
6121 by the compiler will be investigated.  To those functions, a different
6122 (more restrictive) limit compared to functions declared inline can
6123 be applied.
6124 The default value is 90.
6125
6126 @item large-function-insns
6127 The limit specifying really large functions.  For functions larger than this
6128 limit after inlining inlining is constrained by
6129 @option{--param large-function-growth}.  This parameter is useful primarily
6130 to avoid extreme compilation time caused by non-linear algorithms used by the
6131 backend.
6132 This parameter is ignored when @option{-funit-at-a-time} is not used.
6133 The default value is 2700.
6134
6135 @item large-function-growth
6136 Specifies maximal growth of large function caused by inlining in percents.
6137 This parameter is ignored when @option{-funit-at-a-time} is not used.
6138 The default value is 100 which limits large function growth to 2.0 times
6139 the original size.
6140
6141 @item large-unit-insns
6142 The limit specifying large translation unit.  Growth caused by inlining of
6143 units larger than this limit is limited by @option{--param inline-unit-growth}.
6144 For small units this might be too tight (consider unit consisting of function A
6145 that is inline and B that just calls A three time.  If B is small relative to
6146 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
6147 large units consisting of small inlininable functions however the overall unit
6148 growth limit is needed to avoid exponential explosion of code size.  Thus for
6149 smaller units, the size is increased to @option{--param large-unit-insns}
6150 before applying @option{--param inline-unit-growth}.  The default is 10000
6151
6152 @item inline-unit-growth
6153 Specifies maximal overall growth of the compilation unit caused by inlining.
6154 This parameter is ignored when @option{-funit-at-a-time} is not used.
6155 The default value is 30 which limits unit growth to 1.3 times the original
6156 size.
6157
6158 @item large-stack-frame
6159 The limit specifying large stack frames.  While inlining the algorithm is trying
6160 to not grow past this limit too much.  Default value is 256 bytes.
6161
6162 @item large-stack-frame-growth
6163 Specifies maximal growth of large stack frames caused by inlining in percents.
6164 The default value is 1000 which limits large stack frame growth to 11 times
6165 the original size.
6166
6167 @item max-inline-insns-recursive
6168 @itemx max-inline-insns-recursive-auto
6169 Specifies maximum number of instructions out-of-line copy of self recursive inline
6170 function can grow into by performing recursive inlining.
6171
6172 For functions declared inline @option{--param max-inline-insns-recursive} is
6173 taken into account.  For function not declared inline, recursive inlining
6174 happens only when @option{-finline-functions} (included in @option{-O3}) is
6175 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
6176 default value is 450.
6177
6178 @item max-inline-recursive-depth
6179 @itemx max-inline-recursive-depth-auto
6180 Specifies maximum recursion depth used by the recursive inlining.
6181
6182 For functions declared inline @option{--param max-inline-recursive-depth} is
6183 taken into account.  For function not declared inline, recursive inlining
6184 happens only when @option{-finline-functions} (included in @option{-O3}) is
6185 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
6186 default value is 450.
6187
6188 @item min-inline-recursive-probability
6189 Recursive inlining is profitable only for function having deep recursion
6190 in average and can hurt for function having little recursion depth by
6191 increasing the prologue size or complexity of function body to other
6192 optimizers.
6193
6194 When profile feedback is available (see @option{-fprofile-generate}) the actual
6195 recursion depth can be guessed from probability that function will recurse via
6196 given call expression.  This parameter limits inlining only to call expression
6197 whose probability exceeds given threshold (in percents).  The default value is
6198 10.
6199
6200 @item inline-call-cost
6201 Specify cost of call instruction relative to simple arithmetics operations
6202 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
6203 functions and at the same time increases size of leaf function that is believed to
6204 reduce function size by being inlined.  In effect it increases amount of
6205 inlining for code having large abstraction penalty (many functions that just
6206 pass the arguments to other functions) and decrease inlining for code with low
6207 abstraction penalty.  The default value is 16.
6208
6209 @item min-vect-loop-bound
6210 The minimum number of iterations under which a loop will not get vectorized 
6211 when @option{-ftree-vectorize} is used.  The number of iterations after 
6212 vectorization needs to be greater than the value specified by this option
6213 to allow vectorization.  The default value is 0.
6214
6215 @item max-unrolled-insns
6216 The maximum number of instructions that a loop should have if that loop
6217 is unrolled, and if the loop is unrolled, it determines how many times
6218 the loop code is unrolled.
6219
6220 @item max-average-unrolled-insns
6221 The maximum number of instructions biased by probabilities of their execution
6222 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6223 it determines how many times the loop code is unrolled.
6224
6225 @item max-unroll-times
6226 The maximum number of unrollings of a single loop.
6227
6228 @item max-peeled-insns
6229 The maximum number of instructions that a loop should have if that loop
6230 is peeled, and if the loop is peeled, it determines how many times
6231 the loop code is peeled.
6232
6233 @item max-peel-times
6234 The maximum number of peelings of a single loop.
6235
6236 @item max-completely-peeled-insns
6237 The maximum number of insns of a completely peeled loop.
6238
6239 @item max-completely-peel-times
6240 The maximum number of iterations of a loop to be suitable for complete peeling.
6241
6242 @item max-unswitch-insns
6243 The maximum number of insns of an unswitched loop.
6244
6245 @item max-unswitch-level
6246 The maximum number of branches unswitched in a single loop.
6247
6248 @item lim-expensive
6249 The minimum cost of an expensive expression in the loop invariant motion.
6250
6251 @item iv-consider-all-candidates-bound
6252 Bound on number of candidates for induction variables below that
6253 all candidates are considered for each use in induction variable
6254 optimizations.  Only the most relevant candidates are considered
6255 if there are more candidates, to avoid quadratic time complexity.
6256
6257 @item iv-max-considered-uses
6258 The induction variable optimizations give up on loops that contain more
6259 induction variable uses.
6260
6261 @item iv-always-prune-cand-set-bound
6262 If number of candidates in the set is smaller than this value,
6263 we always try to remove unnecessary ivs from the set during its
6264 optimization when a new iv is added to the set.
6265
6266 @item scev-max-expr-size
6267 Bound on size of expressions used in the scalar evolutions analyzer.
6268 Large expressions slow the analyzer.
6269
6270 @item vect-max-version-checks
6271 The maximum number of runtime checks that can be performed when doing
6272 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6273 for more information.
6274
6275 @item max-iterations-to-track
6276
6277 The maximum number of iterations of a loop the brute force algorithm
6278 for analysis of # of iterations of the loop tries to evaluate.
6279
6280 @item hot-bb-count-fraction
6281 Select fraction of the maximal count of repetitions of basic block in program
6282 given basic block needs to have to be considered hot.
6283
6284 @item hot-bb-frequency-fraction
6285 Select fraction of the maximal frequency of executions of basic block in
6286 function given basic block needs to have to be considered hot
6287
6288 @item max-predicted-iterations
6289 The maximum number of loop iterations we predict statically.  This is useful
6290 in cases where function contain single loop with known bound and other loop
6291 with unknown.  We predict the known number of iterations correctly, while
6292 the unknown number of iterations average to roughly 10.  This means that the
6293 loop without bounds would appear artificially cold relative to the other one.
6294
6295 @item tracer-dynamic-coverage
6296 @itemx tracer-dynamic-coverage-feedback
6297
6298 This value is used to limit superblock formation once the given percentage of
6299 executed instructions is covered.  This limits unnecessary code size
6300 expansion.
6301
6302 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6303 feedback is available.  The real profiles (as opposed to statically estimated
6304 ones) are much less balanced allowing the threshold to be larger value.
6305
6306 @item tracer-max-code-growth
6307 Stop tail duplication once code growth has reached given percentage.  This is
6308 rather hokey argument, as most of the duplicates will be eliminated later in
6309 cross jumping, so it may be set to much higher values than is the desired code
6310 growth.
6311
6312 @item tracer-min-branch-ratio
6313
6314 Stop reverse growth when the reverse probability of best edge is less than this
6315 threshold (in percent).
6316
6317 @item tracer-min-branch-ratio
6318 @itemx tracer-min-branch-ratio-feedback
6319
6320 Stop forward growth if the best edge do have probability lower than this
6321 threshold.
6322
6323 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6324 compilation for profile feedback and one for compilation without.  The value
6325 for compilation with profile feedback needs to be more conservative (higher) in
6326 order to make tracer effective.
6327
6328 @item max-cse-path-length
6329
6330 Maximum number of basic blocks on path that cse considers.  The default is 10.
6331
6332 @item max-cse-insns
6333 The maximum instructions CSE process before flushing. The default is 1000.
6334
6335 @item max-aliased-vops
6336
6337 Maximum number of virtual operands per statement allowed to represent
6338 aliases before triggering the alias grouping heuristic.  Alias
6339 grouping reduces compile times and memory consumption needed for
6340 aliasing at the expense of precision loss in alias information.
6341
6342 @item ggc-min-expand
6343
6344 GCC uses a garbage collector to manage its own memory allocation.  This
6345 parameter specifies the minimum percentage by which the garbage
6346 collector's heap should be allowed to expand between collections.
6347 Tuning this may improve compilation speed; it has no effect on code
6348 generation.
6349
6350 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6351 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6352 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6353 GCC is not able to calculate RAM on a particular platform, the lower
6354 bound of 30% is used.  Setting this parameter and
6355 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6356 every opportunity.  This is extremely slow, but can be useful for
6357 debugging.
6358
6359 @item ggc-min-heapsize
6360
6361 Minimum size of the garbage collector's heap before it begins bothering
6362 to collect garbage.  The first collection occurs after the heap expands
6363 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6364 tuning this may improve compilation speed, and has no effect on code
6365 generation.
6366
6367 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6368 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6369 with a lower bound of 4096 (four megabytes) and an upper bound of
6370 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6371 particular platform, the lower bound is used.  Setting this parameter
6372 very large effectively disables garbage collection.  Setting this
6373 parameter and @option{ggc-min-expand} to zero causes a full collection
6374 to occur at every opportunity.
6375
6376 @item max-reload-search-insns
6377 The maximum number of instruction reload should look backward for equivalent
6378 register.  Increasing values mean more aggressive optimization, making the
6379 compile time increase with probably slightly better performance.  The default
6380 value is 100.
6381
6382 @item max-cselib-memory-locations
6383 The maximum number of memory locations cselib should take into account.
6384 Increasing values mean more aggressive optimization, making the compile time
6385 increase with probably slightly better performance.  The default value is 500.
6386
6387 @item max-flow-memory-locations
6388 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6389 The default value is 100.
6390
6391 @item reorder-blocks-duplicate
6392 @itemx reorder-blocks-duplicate-feedback
6393
6394 Used by basic block reordering pass to decide whether to use unconditional
6395 branch or duplicate the code on its destination.  Code is duplicated when its
6396 estimated size is smaller than this value multiplied by the estimated size of
6397 unconditional jump in the hot spots of the program.
6398
6399 The @option{reorder-block-duplicate-feedback} is used only when profile
6400 feedback is available and may be set to higher values than
6401 @option{reorder-block-duplicate} since information about the hot spots is more
6402 accurate.
6403
6404 @item max-sched-ready-insns
6405 The maximum number of instructions ready to be issued the scheduler should
6406 consider at any given time during the first scheduling pass.  Increasing
6407 values mean more thorough searches, making the compilation time increase
6408 with probably little benefit.  The default value is 100.
6409
6410 @item max-sched-region-blocks
6411 The maximum number of blocks in a region to be considered for
6412 interblock scheduling.  The default value is 10.
6413
6414 @item max-sched-region-insns
6415 The maximum number of insns in a region to be considered for
6416 interblock scheduling.  The default value is 100.
6417
6418 @item min-spec-prob
6419 The minimum probability (in percents) of reaching a source block
6420 for interblock speculative scheduling.  The default value is 40.
6421
6422 @item max-sched-extend-regions-iters
6423 The maximum number of iterations through CFG to extend regions.
6424 0 - disable region extension,
6425 N - do at most N iterations.
6426 The default value is 0.
6427
6428 @item max-sched-insn-conflict-delay
6429 The maximum conflict delay for an insn to be considered for speculative motion.
6430 The default value is 3.
6431
6432 @item sched-spec-prob-cutoff
6433 The minimal probability of speculation success (in percents), so that
6434 speculative insn will be scheduled.
6435 The default value is 40.
6436
6437 @item max-last-value-rtl
6438
6439 The maximum size measured as number of RTLs that can be recorded in an expression
6440 in combiner for a pseudo register as last known value of that register.  The default
6441 is 10000.
6442
6443 @item integer-share-limit
6444 Small integer constants can use a shared data structure, reducing the
6445 compiler's memory usage and increasing its speed.  This sets the maximum
6446 value of a shared integer constant's.  The default value is 256.
6447
6448 @item min-virtual-mappings
6449 Specifies the minimum number of virtual mappings in the incremental
6450 SSA updater that should be registered to trigger the virtual mappings
6451 heuristic defined by virtual-mappings-ratio.  The default value is
6452 100.
6453
6454 @item virtual-mappings-ratio
6455 If the number of virtual mappings is virtual-mappings-ratio bigger
6456 than the number of virtual symbols to be updated, then the incremental
6457 SSA updater switches to a full update for those symbols.  The default
6458 ratio is 3.
6459
6460 @item ssp-buffer-size
6461 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6462 protection when @option{-fstack-protection} is used.
6463
6464 @item max-jump-thread-duplication-stmts
6465 Maximum number of statements allowed in a block that needs to be
6466 duplicated when threading jumps.
6467
6468 @item max-fields-for-field-sensitive
6469 Maximum number of fields in a structure we will treat in
6470 a field sensitive manner during pointer analysis.
6471
6472 @item prefetch-latency
6473 Estimate on average number of instructions that are executed before
6474 prefetch finishes.  The distance we prefetch ahead is proportional
6475 to this constant.  Increasing this number may also lead to less
6476 streams being prefetched (see @option{simultaneous-prefetches}).
6477
6478 @item simultaneous-prefetches
6479 Maximum number of prefetches that can run at the same time.
6480
6481 @item l1-cache-line-size
6482 The size of cache line in L1 cache, in bytes.
6483
6484 @item l1-cache-size
6485 The number of cache lines in L1 cache.
6486
6487 @item verify-canonical-types
6488 Whether the compiler should verify the ``canonical'' types used for
6489 type equality comparisons within the C++ and Objective-C++ front
6490 ends. Set to 1 (the default when GCC is configured with
6491 --enable-checking) to enable verification, 0 to disable verification
6492 (the default when GCC is configured with --disable-checking).
6493
6494 @end table
6495 @end table
6496
6497 @node Preprocessor Options
6498 @section Options Controlling the Preprocessor
6499 @cindex preprocessor options
6500 @cindex options, preprocessor
6501
6502 These options control the C preprocessor, which is run on each C source
6503 file before actual compilation.
6504
6505 If you use the @option{-E} option, nothing is done except preprocessing.
6506 Some of these options make sense only together with @option{-E} because
6507 they cause the preprocessor output to be unsuitable for actual
6508 compilation.
6509
6510 @table @gcctabopt
6511 @opindex Wp
6512 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6513 and pass @var{option} directly through to the preprocessor.  If
6514 @var{option} contains commas, it is split into multiple options at the
6515 commas.  However, many options are modified, translated or interpreted
6516 by the compiler driver before being passed to the preprocessor, and
6517 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6518 interface is undocumented and subject to change, so whenever possible
6519 you should avoid using @option{-Wp} and let the driver handle the
6520 options instead.
6521
6522 @item -Xpreprocessor @var{option}
6523 @opindex preprocessor
6524 Pass @var{option} as an option to the preprocessor.  You can use this to
6525 supply system-specific preprocessor options which GCC does not know how to
6526 recognize.
6527
6528 If you want to pass an option that takes an argument, you must use
6529 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6530 @end table
6531
6532 @include cppopts.texi
6533
6534 @node Assembler Options
6535 @section Passing Options to the Assembler
6536
6537 @c prevent bad page break with this line
6538 You can pass options to the assembler.
6539
6540 @table @gcctabopt
6541 @item -Wa,@var{option}
6542 @opindex Wa
6543 Pass @var{option} as an option to the assembler.  If @var{option}
6544 contains commas, it is split into multiple options at the commas.
6545
6546 @item -Xassembler @var{option}
6547 @opindex Xassembler
6548 Pass @var{option} as an option to the assembler.  You can use this to
6549 supply system-specific assembler options which GCC does not know how to
6550 recognize.
6551
6552 If you want to pass an option that takes an argument, you must use
6553 @option{-Xassembler} twice, once for the option and once for the argument.
6554
6555 @end table
6556
6557 @node Link Options
6558 @section Options for Linking
6559 @cindex link options
6560 @cindex options, linking
6561
6562 These options come into play when the compiler links object files into
6563 an executable output file.  They are meaningless if the compiler is
6564 not doing a link step.
6565
6566 @table @gcctabopt
6567 @cindex file names
6568 @item @var{object-file-name}
6569 A file name that does not end in a special recognized suffix is
6570 considered to name an object file or library.  (Object files are
6571 distinguished from libraries by the linker according to the file
6572 contents.)  If linking is done, these object files are used as input
6573 to the linker.
6574
6575 @item -c
6576 @itemx -S
6577 @itemx -E
6578 @opindex c
6579 @opindex S
6580 @opindex E
6581 If any of these options is used, then the linker is not run, and
6582 object file names should not be used as arguments.  @xref{Overall
6583 Options}.
6584
6585 @cindex Libraries
6586 @item -l@var{library}
6587 @itemx -l @var{library}
6588 @opindex l
6589 Search the library named @var{library} when linking.  (The second
6590 alternative with the library as a separate argument is only for
6591 POSIX compliance and is not recommended.)
6592
6593 It makes a difference where in the command you write this option; the
6594 linker searches and processes libraries and object files in the order they
6595 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6596 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6597 to functions in @samp{z}, those functions may not be loaded.
6598
6599 The linker searches a standard list of directories for the library,
6600 which is actually a file named @file{lib@var{library}.a}.  The linker
6601 then uses this file as if it had been specified precisely by name.
6602
6603 The directories searched include several standard system directories
6604 plus any that you specify with @option{-L}.
6605
6606 Normally the files found this way are library files---archive files
6607 whose members are object files.  The linker handles an archive file by
6608 scanning through it for members which define symbols that have so far
6609 been referenced but not defined.  But if the file that is found is an
6610 ordinary object file, it is linked in the usual fashion.  The only
6611 difference between using an @option{-l} option and specifying a file name
6612 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6613 and searches several directories.
6614
6615 @item -lobjc
6616 @opindex lobjc
6617 You need this special case of the @option{-l} option in order to
6618 link an Objective-C or Objective-C++ program.
6619
6620 @item -nostartfiles
6621 @opindex nostartfiles
6622 Do not use the standard system startup files when linking.
6623 The standard system libraries are used normally, unless @option{-nostdlib}
6624 or @option{-nodefaultlibs} is used.
6625
6626 @item -nodefaultlibs
6627 @opindex nodefaultlibs
6628 Do not use the standard system libraries when linking.
6629 Only the libraries you specify will be passed to the linker.
6630 The standard startup files are used normally, unless @option{-nostartfiles}
6631 is used.  The compiler may generate calls to @code{memcmp},
6632 @code{memset}, @code{memcpy} and @code{memmove}.
6633 These entries are usually resolved by entries in
6634 libc.  These entry points should be supplied through some other
6635 mechanism when this option is specified.
6636
6637 @item -nostdlib
6638 @opindex nostdlib
6639 Do not use the standard system startup files or libraries when linking.
6640 No startup files and only the libraries you specify will be passed to
6641 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6642 @code{memcpy} and @code{memmove}.
6643 These entries are usually resolved by entries in
6644 libc.  These entry points should be supplied through some other
6645 mechanism when this option is specified.
6646
6647 @cindex @option{-lgcc}, use with @option{-nostdlib}
6648 @cindex @option{-nostdlib} and unresolved references
6649 @cindex unresolved references and @option{-nostdlib}
6650 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6651 @cindex @option{-nodefaultlibs} and unresolved references
6652 @cindex unresolved references and @option{-nodefaultlibs}
6653 One of the standard libraries bypassed by @option{-nostdlib} and
6654 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6655 that GCC uses to overcome shortcomings of particular machines, or special
6656 needs for some languages.
6657 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6658 Collection (GCC) Internals},
6659 for more discussion of @file{libgcc.a}.)
6660 In most cases, you need @file{libgcc.a} even when you want to avoid
6661 other standard libraries.  In other words, when you specify @option{-nostdlib}
6662 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6663 This ensures that you have no unresolved references to internal GCC
6664 library subroutines.  (For example, @samp{__main}, used to ensure C++
6665 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6666 GNU Compiler Collection (GCC) Internals}.)
6667
6668 @item -pie
6669 @opindex pie
6670 Produce a position independent executable on targets which support it.
6671 For predictable results, you must also specify the same set of options
6672 that were used to generate code (@option{-fpie}, @option{-fPIE},
6673 or model suboptions) when you specify this option.
6674
6675 @item -rdynamic
6676 @opindex rdynamic
6677 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6678 that support it. This instructs the linker to add all symbols, not
6679 only used ones, to the dynamic symbol table. This option is needed
6680 for some uses of @code{dlopen} or to allow obtaining backtraces
6681 from within a program.
6682
6683 @item -s
6684 @opindex s
6685 Remove all symbol table and relocation information from the executable.
6686
6687 @item -static
6688 @opindex static
6689 On systems that support dynamic linking, this prevents linking with the shared
6690 libraries.  On other systems, this option has no effect.
6691
6692 @item -shared
6693 @opindex shared
6694 Produce a shared object which can then be linked with other objects to
6695 form an executable.  Not all systems support this option.  For predictable
6696 results, you must also specify the same set of options that were used to
6697 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6698 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6699 needs to build supplementary stub code for constructors to work.  On
6700 multi-libbed systems, @samp{gcc -shared} must select the correct support
6701 libraries to link against.  Failing to supply the correct flags may lead
6702 to subtle defects.  Supplying them in cases where they are not necessary
6703 is innocuous.}
6704
6705 @item -shared-libgcc
6706 @itemx -static-libgcc
6707 @opindex shared-libgcc
6708 @opindex static-libgcc
6709 On systems that provide @file{libgcc} as a shared library, these options
6710 force the use of either the shared or static version respectively.
6711 If no shared version of @file{libgcc} was built when the compiler was
6712 configured, these options have no effect.
6713
6714 There are several situations in which an application should use the
6715 shared @file{libgcc} instead of the static version.  The most common
6716 of these is when the application wishes to throw and catch exceptions
6717 across different shared libraries.  In that case, each of the libraries
6718 as well as the application itself should use the shared @file{libgcc}.
6719
6720 Therefore, the G++ and GCJ drivers automatically add
6721 @option{-shared-libgcc} whenever you build a shared library or a main
6722 executable, because C++ and Java programs typically use exceptions, so
6723 this is the right thing to do.
6724
6725 If, instead, you use the GCC driver to create shared libraries, you may
6726 find that they will not always be linked with the shared @file{libgcc}.
6727 If GCC finds, at its configuration time, that you have a non-GNU linker
6728 or a GNU linker that does not support option @option{--eh-frame-hdr},
6729 it will link the shared version of @file{libgcc} into shared libraries
6730 by default.  Otherwise, it will take advantage of the linker and optimize
6731 away the linking with the shared version of @file{libgcc}, linking with
6732 the static version of libgcc by default.  This allows exceptions to
6733 propagate through such shared libraries, without incurring relocation
6734 costs at library load time.
6735
6736 However, if a library or main executable is supposed to throw or catch
6737 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6738 for the languages used in the program, or using the option
6739 @option{-shared-libgcc}, such that it is linked with the shared
6740 @file{libgcc}.
6741
6742 @item -symbolic
6743 @opindex symbolic
6744 Bind references to global symbols when building a shared object.  Warn
6745 about any unresolved references (unless overridden by the link editor
6746 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6747 this option.
6748
6749 @item -Xlinker @var{option}
6750 @opindex Xlinker
6751 Pass @var{option} as an option to the linker.  You can use this to
6752 supply system-specific linker options which GCC does not know how to
6753 recognize.
6754
6755 If you want to pass an option that takes an argument, you must use
6756 @option{-Xlinker} twice, once for the option and once for the argument.
6757 For example, to pass @option{-assert definitions}, you must write
6758 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6759 @option{-Xlinker "-assert definitions"}, because this passes the entire
6760 string as a single argument, which is not what the linker expects.
6761
6762 @item -Wl,@var{option}
6763 @opindex Wl
6764 Pass @var{option} as an option to the linker.  If @var{option} contains
6765 commas, it is split into multiple options at the commas.
6766
6767 @item -u @var{symbol}
6768 @opindex u
6769 Pretend the symbol @var{symbol} is undefined, to force linking of
6770 library modules to define it.  You can use @option{-u} multiple times with
6771 different symbols to force loading of additional library modules.
6772 @end table
6773
6774 @node Directory Options
6775 @section Options for Directory Search
6776 @cindex directory options
6777 @cindex options, directory search
6778 @cindex search path
6779
6780 These options specify directories to search for header files, for
6781 libraries and for parts of the compiler:
6782
6783 @table @gcctabopt
6784 @item -I@var{dir}
6785 @opindex I
6786 Add the directory @var{dir} to the head of the list of directories to be
6787 searched for header files.  This can be used to override a system header
6788 file, substituting your own version, since these directories are
6789 searched before the system header file directories.  However, you should
6790 not use this option to add directories that contain vendor-supplied
6791 system header files (use @option{-isystem} for that).  If you use more than
6792 one @option{-I} option, the directories are scanned in left-to-right
6793 order; the standard system directories come after.
6794
6795 If a standard system include directory, or a directory specified with
6796 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6797 option will be ignored.  The directory will still be searched but as a
6798 system directory at its normal position in the system include chain.
6799 This is to ensure that GCC's procedure to fix buggy system headers and
6800 the ordering for the include_next directive are not inadvertently changed.
6801 If you really need to change the search order for system directories,
6802 use the @option{-nostdinc} and/or @option{-isystem} options.
6803
6804 @item -iquote@var{dir}
6805 @opindex iquote
6806 Add the directory @var{dir} to the head of the list of directories to
6807 be searched for header files only for the case of @samp{#include
6808 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6809 otherwise just like @option{-I}.
6810
6811 @item -L@var{dir}
6812 @opindex L
6813 Add directory @var{dir} to the list of directories to be searched
6814 for @option{-l}.
6815
6816 @item -B@var{prefix}
6817 @opindex B
6818 This option specifies where to find the executables, libraries,
6819 include files, and data files of the compiler itself.
6820
6821 The compiler driver program runs one or more of the subprograms
6822 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6823 @var{prefix} as a prefix for each program it tries to run, both with and
6824 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6825
6826 For each subprogram to be run, the compiler driver first tries the
6827 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6828 was not specified, the driver tries two standard prefixes, which are
6829 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6830 those results in a file name that is found, the unmodified program
6831 name is searched for using the directories specified in your
6832 @env{PATH} environment variable.
6833
6834 The compiler will check to see if the path provided by the @option{-B}
6835 refers to a directory, and if necessary it will add a directory
6836 separator character at the end of the path.
6837
6838 @option{-B} prefixes that effectively specify directory names also apply
6839 to libraries in the linker, because the compiler translates these
6840 options into @option{-L} options for the linker.  They also apply to
6841 includes files in the preprocessor, because the compiler translates these
6842 options into @option{-isystem} options for the preprocessor.  In this case,
6843 the compiler appends @samp{include} to the prefix.
6844
6845 The run-time support file @file{libgcc.a} can also be searched for using
6846 the @option{-B} prefix, if needed.  If it is not found there, the two
6847 standard prefixes above are tried, and that is all.  The file is left
6848 out of the link if it is not found by those means.
6849
6850 Another way to specify a prefix much like the @option{-B} prefix is to use
6851 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6852 Variables}.
6853
6854 As a special kludge, if the path provided by @option{-B} is
6855 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6856 9, then it will be replaced by @file{[dir/]include}.  This is to help
6857 with boot-strapping the compiler.
6858
6859 @item -specs=@var{file}
6860 @opindex specs
6861 Process @var{file} after the compiler reads in the standard @file{specs}
6862 file, in order to override the defaults that the @file{gcc} driver
6863 program uses when determining what switches to pass to @file{cc1},
6864 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6865 @option{-specs=@var{file}} can be specified on the command line, and they
6866 are processed in order, from left to right.
6867
6868 @item --sysroot=@var{dir}
6869 @opindex sysroot
6870 Use @var{dir} as the logical root directory for headers and libraries.
6871 For example, if the compiler would normally search for headers in
6872 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6873 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6874
6875 If you use both this option and the @option{-isysroot} option, then
6876 the @option{--sysroot} option will apply to libraries, but the
6877 @option{-isysroot} option will apply to header files.
6878
6879 The GNU linker (beginning with version 2.16) has the necessary support
6880 for this option.  If your linker does not support this option, the
6881 header file aspect of @option{--sysroot} will still work, but the
6882 library aspect will not.
6883
6884 @item -I-
6885 @opindex I-
6886 This option has been deprecated.  Please use @option{-iquote} instead for
6887 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6888 Any directories you specify with @option{-I} options before the @option{-I-}
6889 option are searched only for the case of @samp{#include "@var{file}"};
6890 they are not searched for @samp{#include <@var{file}>}.
6891
6892 If additional directories are specified with @option{-I} options after
6893 the @option{-I-}, these directories are searched for all @samp{#include}
6894 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6895 this way.)
6896
6897 In addition, the @option{-I-} option inhibits the use of the current
6898 directory (where the current input file came from) as the first search
6899 directory for @samp{#include "@var{file}"}.  There is no way to
6900 override this effect of @option{-I-}.  With @option{-I.} you can specify
6901 searching the directory which was current when the compiler was
6902 invoked.  That is not exactly the same as what the preprocessor does
6903 by default, but it is often satisfactory.
6904
6905 @option{-I-} does not inhibit the use of the standard system directories
6906 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6907 independent.
6908 @end table
6909
6910 @c man end
6911
6912 @node Spec Files
6913 @section Specifying subprocesses and the switches to pass to them
6914 @cindex Spec Files
6915
6916 @command{gcc} is a driver program.  It performs its job by invoking a
6917 sequence of other programs to do the work of compiling, assembling and
6918 linking.  GCC interprets its command-line parameters and uses these to
6919 deduce which programs it should invoke, and which command-line options
6920 it ought to place on their command lines.  This behavior is controlled
6921 by @dfn{spec strings}.  In most cases there is one spec string for each
6922 program that GCC can invoke, but a few programs have multiple spec
6923 strings to control their behavior.  The spec strings built into GCC can
6924 be overridden by using the @option{-specs=} command-line switch to specify
6925 a spec file.
6926
6927 @dfn{Spec files} are plaintext files that are used to construct spec
6928 strings.  They consist of a sequence of directives separated by blank
6929 lines.  The type of directive is determined by the first non-whitespace
6930 character on the line and it can be one of the following:
6931
6932 @table @code
6933 @item %@var{command}
6934 Issues a @var{command} to the spec file processor.  The commands that can
6935 appear here are:
6936
6937 @table @code
6938 @item %include <@var{file}>
6939 @cindex %include
6940 Search for @var{file} and insert its text at the current point in the
6941 specs file.
6942
6943 @item %include_noerr <@var{file}>
6944 @cindex %include_noerr
6945 Just like @samp{%include}, but do not generate an error message if the include
6946 file cannot be found.
6947
6948 @item %rename @var{old_name} @var{new_name}
6949 @cindex %rename
6950 Rename the spec string @var{old_name} to @var{new_name}.
6951
6952 @end table
6953
6954 @item *[@var{spec_name}]:
6955 This tells the compiler to create, override or delete the named spec
6956 string.  All lines after this directive up to the next directive or
6957 blank line are considered to be the text for the spec string.  If this
6958 results in an empty string then the spec will be deleted.  (Or, if the
6959 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6960 does not currently exist a new spec will be created.  If the spec does
6961 exist then its contents will be overridden by the text of this
6962 directive, unless the first character of that text is the @samp{+}
6963 character, in which case the text will be appended to the spec.
6964
6965 @item [@var{suffix}]:
6966 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6967 and up to the next directive or blank line are considered to make up the
6968 spec string for the indicated suffix.  When the compiler encounters an
6969 input file with the named suffix, it will processes the spec string in
6970 order to work out how to compile that file.  For example:
6971
6972 @smallexample
6973 .ZZ:
6974 z-compile -input %i
6975 @end smallexample
6976
6977 This says that any input file whose name ends in @samp{.ZZ} should be
6978 passed to the program @samp{z-compile}, which should be invoked with the
6979 command-line switch @option{-input} and with the result of performing the
6980 @samp{%i} substitution.  (See below.)
6981
6982 As an alternative to providing a spec string, the text that follows a
6983 suffix directive can be one of the following:
6984
6985 @table @code
6986 @item @@@var{language}
6987 This says that the suffix is an alias for a known @var{language}.  This is
6988 similar to using the @option{-x} command-line switch to GCC to specify a
6989 language explicitly.  For example:
6990
6991 @smallexample
6992 .ZZ:
6993 @@c++
6994 @end smallexample
6995
6996 Says that .ZZ files are, in fact, C++ source files.
6997
6998 @item #@var{name}
6999 This causes an error messages saying:
7000
7001 @smallexample
7002 @var{name} compiler not installed on this system.
7003 @end smallexample
7004 @end table
7005
7006 GCC already has an extensive list of suffixes built into it.
7007 This directive will add an entry to the end of the list of suffixes, but
7008 since the list is searched from the end backwards, it is effectively
7009 possible to override earlier entries using this technique.
7010
7011 @end table
7012
7013 GCC has the following spec strings built into it.  Spec files can
7014 override these strings or create their own.  Note that individual
7015 targets can also add their own spec strings to this list.
7016
7017 @smallexample
7018 asm          Options to pass to the assembler
7019 asm_final    Options to pass to the assembler post-processor
7020 cpp          Options to pass to the C preprocessor
7021 cc1          Options to pass to the C compiler
7022 cc1plus      Options to pass to the C++ compiler
7023 endfile      Object files to include at the end of the link
7024 link         Options to pass to the linker
7025 lib          Libraries to include on the command line to the linker
7026 libgcc       Decides which GCC support library to pass to the linker
7027 linker       Sets the name of the linker
7028 predefines   Defines to be passed to the C preprocessor
7029 signed_char  Defines to pass to CPP to say whether @code{char} is signed
7030              by default
7031 startfile    Object files to include at the start of the link
7032 @end smallexample
7033
7034 Here is a small example of a spec file:
7035
7036 @smallexample
7037 %rename lib                 old_lib
7038
7039 *lib:
7040 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
7041 @end smallexample
7042
7043 This example renames the spec called @samp{lib} to @samp{old_lib} and
7044 then overrides the previous definition of @samp{lib} with a new one.
7045 The new definition adds in some extra command-line options before
7046 including the text of the old definition.
7047
7048 @dfn{Spec strings} are a list of command-line options to be passed to their
7049 corresponding program.  In addition, the spec strings can contain
7050 @samp{%}-prefixed sequences to substitute variable text or to
7051 conditionally insert text into the command line.  Using these constructs
7052 it is possible to generate quite complex command lines.
7053
7054 Here is a table of all defined @samp{%}-sequences for spec
7055 strings.  Note that spaces are not generated automatically around the
7056 results of expanding these sequences.  Therefore you can concatenate them
7057 together or combine them with constant text in a single argument.
7058
7059 @table @code
7060 @item %%
7061 Substitute one @samp{%} into the program name or argument.
7062
7063 @item %i
7064 Substitute the name of the input file being processed.
7065
7066 @item %b
7067 Substitute the basename of the input file being processed.
7068 This is the substring up to (and not including) the last period
7069 and not including the directory.
7070
7071 @item %B
7072 This is the same as @samp{%b}, but include the file suffix (text after
7073 the last period).
7074
7075 @item %d
7076 Marks the argument containing or following the @samp{%d} as a
7077 temporary file name, so that that file will be deleted if GCC exits
7078 successfully.  Unlike @samp{%g}, this contributes no text to the
7079 argument.
7080
7081 @item %g@var{suffix}
7082 Substitute a file name that has suffix @var{suffix} and is chosen
7083 once per compilation, and mark the argument in the same way as
7084 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
7085 name is now chosen in a way that is hard to predict even when previously
7086 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7087 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
7088 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7089 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
7090 was simply substituted with a file name chosen once per compilation,
7091 without regard to any appended suffix (which was therefore treated
7092 just like ordinary text), making such attacks more likely to succeed.
7093
7094 @item %u@var{suffix}
7095 Like @samp{%g}, but generates a new temporary file name even if
7096 @samp{%u@var{suffix}} was already seen.
7097
7098 @item %U@var{suffix}
7099 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7100 new one if there is no such last file name.  In the absence of any
7101 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7102 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7103 would involve the generation of two distinct file names, one
7104 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
7105 simply substituted with a file name chosen for the previous @samp{%u},
7106 without regard to any appended suffix.
7107
7108 @item %j@var{suffix}
7109 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7110 writable, and if save-temps is off; otherwise, substitute the name
7111 of a temporary file, just like @samp{%u}.  This temporary file is not
7112 meant for communication between processes, but rather as a junk
7113 disposal mechanism.
7114
7115 @item %|@var{suffix}
7116 @itemx %m@var{suffix}
7117 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
7118 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7119 all.  These are the two most common ways to instruct a program that it
7120 should read from standard input or write to standard output.  If you
7121 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7122 construct: see for example @file{f/lang-specs.h}.
7123
7124 @item %.@var{SUFFIX}
7125 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7126 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
7127 terminated by the next space or %.
7128
7129 @item %w
7130 Marks the argument containing or following the @samp{%w} as the
7131 designated output file of this compilation.  This puts the argument
7132 into the sequence of arguments that @samp{%o} will substitute later.
7133
7134 @item %o
7135 Substitutes the names of all the output files, with spaces
7136 automatically placed around them.  You should write spaces
7137 around the @samp{%o} as well or the results are undefined.
7138 @samp{%o} is for use in the specs for running the linker.
7139 Input files whose names have no recognized suffix are not compiled
7140 at all, but they are included among the output files, so they will
7141 be linked.
7142
7143 @item %O
7144 Substitutes the suffix for object files.  Note that this is
7145 handled specially when it immediately follows @samp{%g, %u, or %U},
7146 because of the need for those to form complete file names.  The
7147 handling is such that @samp{%O} is treated exactly as if it had already
7148 been substituted, except that @samp{%g, %u, and %U} do not currently
7149 support additional @var{suffix} characters following @samp{%O} as they would
7150 following, for example, @samp{.o}.
7151
7152 @item %p
7153 Substitutes the standard macro predefinitions for the
7154 current target machine.  Use this when running @code{cpp}.
7155
7156 @item %P
7157 Like @samp{%p}, but puts @samp{__} before and after the name of each
7158 predefined macro, except for macros that start with @samp{__} or with
7159 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
7160 C@.
7161
7162 @item %I
7163 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7164 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7165 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7166 and @option{-imultilib} as necessary.
7167
7168 @item %s
7169 Current argument is the name of a library or startup file of some sort.
7170 Search for that file in a standard list of directories and substitute
7171 the full name found.
7172
7173 @item %e@var{str}
7174 Print @var{str} as an error message.  @var{str} is terminated by a newline.
7175 Use this when inconsistent options are detected.
7176
7177 @item %(@var{name})
7178 Substitute the contents of spec string @var{name} at this point.
7179
7180 @item %[@var{name}]
7181 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7182
7183 @item %x@{@var{option}@}
7184 Accumulate an option for @samp{%X}.
7185
7186 @item %X
7187 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7188 spec string.
7189
7190 @item %Y
7191 Output the accumulated assembler options specified by @option{-Wa}.
7192
7193 @item %Z
7194 Output the accumulated preprocessor options specified by @option{-Wp}.
7195
7196 @item %a
7197 Process the @code{asm} spec.  This is used to compute the
7198 switches to be passed to the assembler.
7199
7200 @item %A
7201 Process the @code{asm_final} spec.  This is a spec string for
7202 passing switches to an assembler post-processor, if such a program is
7203 needed.
7204
7205 @item %l
7206 Process the @code{link} spec.  This is the spec for computing the
7207 command line passed to the linker.  Typically it will make use of the
7208 @samp{%L %G %S %D and %E} sequences.
7209
7210 @item %D
7211 Dump out a @option{-L} option for each directory that GCC believes might
7212 contain startup files.  If the target supports multilibs then the
7213 current multilib directory will be prepended to each of these paths.
7214
7215 @item %L
7216 Process the @code{lib} spec.  This is a spec string for deciding which
7217 libraries should be included on the command line to the linker.
7218
7219 @item %G
7220 Process the @code{libgcc} spec.  This is a spec string for deciding
7221 which GCC support library should be included on the command line to the linker.
7222
7223 @item %S
7224 Process the @code{startfile} spec.  This is a spec for deciding which
7225 object files should be the first ones passed to the linker.  Typically
7226 this might be a file named @file{crt0.o}.
7227
7228 @item %E
7229 Process the @code{endfile} spec.  This is a spec string that specifies
7230 the last object files that will be passed to the linker.
7231
7232 @item %C
7233 Process the @code{cpp} spec.  This is used to construct the arguments
7234 to be passed to the C preprocessor.
7235
7236 @item %1
7237 Process the @code{cc1} spec.  This is used to construct the options to be
7238 passed to the actual C compiler (@samp{cc1}).
7239
7240 @item %2
7241 Process the @code{cc1plus} spec.  This is used to construct the options to be
7242 passed to the actual C++ compiler (@samp{cc1plus}).
7243
7244 @item %*
7245 Substitute the variable part of a matched option.  See below.
7246 Note that each comma in the substituted string is replaced by
7247 a single space.
7248
7249 @item %<@code{S}
7250 Remove all occurrences of @code{-S} from the command line.  Note---this
7251 command is position dependent.  @samp{%} commands in the spec string
7252 before this one will see @code{-S}, @samp{%} commands in the spec string
7253 after this one will not.
7254
7255 @item %:@var{function}(@var{args})
7256 Call the named function @var{function}, passing it @var{args}.
7257 @var{args} is first processed as a nested spec string, then split
7258 into an argument vector in the usual fashion.  The function returns
7259 a string which is processed as if it had appeared literally as part
7260 of the current spec.
7261
7262 The following built-in spec functions are provided:
7263
7264 @table @code
7265 @item @code{if-exists}
7266 The @code{if-exists} spec function takes one argument, an absolute
7267 pathname to a file.  If the file exists, @code{if-exists} returns the
7268 pathname.  Here is a small example of its usage:
7269
7270 @smallexample
7271 *startfile:
7272 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7273 @end smallexample
7274
7275 @item @code{if-exists-else}
7276 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7277 spec function, except that it takes two arguments.  The first argument is
7278 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7279 returns the pathname.  If it does not exist, it returns the second argument.
7280 This way, @code{if-exists-else} can be used to select one file or another,
7281 based on the existence of the first.  Here is a small example of its usage:
7282
7283 @smallexample
7284 *startfile:
7285 crt0%O%s %:if-exists(crti%O%s) \
7286 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7287 @end smallexample
7288
7289 @item @code{replace-outfile}
7290 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7291 first argument in the outfiles array and replaces it with the second argument.  Here
7292 is a small example of its usage:
7293
7294 @smallexample
7295 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7296 @end smallexample
7297
7298 @end table
7299
7300 @item %@{@code{S}@}
7301 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7302 If that switch was not specified, this substitutes nothing.  Note that
7303 the leading dash is omitted when specifying this option, and it is
7304 automatically inserted if the substitution is performed.  Thus the spec
7305 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7306 and would output the command line option @option{-foo}.
7307
7308 @item %W@{@code{S}@}
7309 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7310 deleted on failure.
7311
7312 @item %@{@code{S}*@}
7313 Substitutes all the switches specified to GCC whose names start
7314 with @code{-S}, but which also take an argument.  This is used for
7315 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7316 GCC considers @option{-o foo} as being
7317 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7318 text, including the space.  Thus two arguments would be generated.
7319
7320 @item %@{@code{S}*&@code{T}*@}
7321 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7322 (the order of @code{S} and @code{T} in the spec is not significant).
7323 There can be any number of ampersand-separated variables; for each the
7324 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7325
7326 @item %@{@code{S}:@code{X}@}
7327 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7328
7329 @item %@{!@code{S}:@code{X}@}
7330 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7331
7332 @item %@{@code{S}*:@code{X}@}
7333 Substitutes @code{X} if one or more switches whose names start with
7334 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7335 once, no matter how many such switches appeared.  However, if @code{%*}
7336 appears somewhere in @code{X}, then @code{X} will be substituted once
7337 for each matching switch, with the @code{%*} replaced by the part of
7338 that switch that matched the @code{*}.
7339
7340 @item %@{.@code{S}:@code{X}@}
7341 Substitutes @code{X}, if processing a file with suffix @code{S}.
7342
7343 @item %@{!.@code{S}:@code{X}@}
7344 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7345
7346 @item %@{@code{S}|@code{P}:@code{X}@}
7347 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7348 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7349 although they have a stronger binding than the @samp{|}.  If @code{%*}
7350 appears in @code{X}, all of the alternatives must be starred, and only
7351 the first matching alternative is substituted.
7352
7353 For example, a spec string like this:
7354
7355 @smallexample
7356 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7357 @end smallexample
7358
7359 will output the following command-line options from the following input
7360 command-line options:
7361
7362 @smallexample
7363 fred.c        -foo -baz
7364 jim.d         -bar -boggle
7365 -d fred.c     -foo -baz -boggle
7366 -d jim.d      -bar -baz -boggle
7367 @end smallexample
7368
7369 @item %@{S:X; T:Y; :D@}
7370
7371 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7372 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7373 be as many clauses as you need.  This may be combined with @code{.},
7374 @code{!}, @code{|}, and @code{*} as needed.
7375
7376
7377 @end table
7378
7379 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7380 construct may contain other nested @samp{%} constructs or spaces, or
7381 even newlines.  They are processed as usual, as described above.
7382 Trailing white space in @code{X} is ignored.  White space may also
7383 appear anywhere on the left side of the colon in these constructs,
7384 except between @code{.} or @code{*} and the corresponding word.
7385
7386 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7387 handled specifically in these constructs.  If another value of
7388 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7389 @option{-W} switch is found later in the command line, the earlier
7390 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7391 just one letter, which passes all matching options.
7392
7393 The character @samp{|} at the beginning of the predicate text is used to
7394 indicate that a command should be piped to the following command, but
7395 only if @option{-pipe} is specified.
7396
7397 It is built into GCC which switches take arguments and which do not.
7398 (You might think it would be useful to generalize this to allow each
7399 compiler's spec to say which switches take arguments.  But this cannot
7400 be done in a consistent fashion.  GCC cannot even decide which input
7401 files have been specified without knowing which switches take arguments,
7402 and it must know which input files to compile in order to tell which
7403 compilers to run).
7404
7405 GCC also knows implicitly that arguments starting in @option{-l} are to be
7406 treated as compiler output files, and passed to the linker in their
7407 proper position among the other output files.
7408
7409 @c man begin OPTIONS
7410
7411 @node Target Options
7412 @section Specifying Target Machine and Compiler Version
7413 @cindex target options
7414 @cindex cross compiling
7415 @cindex specifying machine version
7416 @cindex specifying compiler version and target machine
7417 @cindex compiler version, specifying
7418 @cindex target machine, specifying
7419
7420 The usual way to run GCC is to run the executable called @file{gcc}, or
7421 @file{<machine>-gcc} when cross-compiling, or
7422 @file{<machine>-gcc-<version>} to run a version other than the one that
7423 was installed last.  Sometimes this is inconvenient, so GCC provides
7424 options that will switch to another cross-compiler or version.
7425
7426 @table @gcctabopt
7427 @item -b @var{machine}
7428 @opindex b
7429 The argument @var{machine} specifies the target machine for compilation.
7430
7431 The value to use for @var{machine} is the same as was specified as the
7432 machine type when configuring GCC as a cross-compiler.  For
7433 example, if a cross-compiler was configured with @samp{configure
7434 arm-elf}, meaning to compile for an arm processor with elf binaries,
7435 then you would specify @option{-b arm-elf} to run that cross compiler.
7436 Because there are other options beginning with @option{-b}, the
7437 configuration must contain a hyphen. 
7438
7439 @item -V @var{version}
7440 @opindex V
7441 The argument @var{version} specifies which version of GCC to run.
7442 This is useful when multiple versions are installed.  For example,
7443 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7444 @end table
7445
7446 The @option{-V} and @option{-b} options work by running the
7447 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7448 use them if you can just run that directly.
7449
7450 @node Submodel Options
7451 @section Hardware Models and Configurations
7452 @cindex submodel options
7453 @cindex specifying hardware config
7454 @cindex hardware models and configurations, specifying
7455 @cindex machine dependent options
7456
7457 Earlier we discussed the standard option @option{-b} which chooses among
7458 different installed compilers for completely different target
7459 machines, such as VAX vs.@: 68000 vs.@: 80386.
7460
7461 In addition, each of these target machine types can have its own
7462 special options, starting with @samp{-m}, to choose among various
7463 hardware models or configurations---for example, 68010 vs 68020,
7464 floating coprocessor or none.  A single installed version of the
7465 compiler can compile for any model or configuration, according to the
7466 options specified.
7467
7468 Some configurations of the compiler also support additional special
7469 options, usually for compatibility with other compilers on the same
7470 platform.
7471
7472 @c This list is ordered alphanumerically by subsection name.
7473 @c It should be the same order and spelling as these options are listed
7474 @c in Machine Dependent Options
7475
7476 @menu
7477 * ARC Options::
7478 * ARM Options::
7479 * AVR Options::
7480 * Blackfin Options::
7481 * CRIS Options::
7482 * CRX Options::
7483 * Darwin Options::
7484 * DEC Alpha Options::
7485 * DEC Alpha/VMS Options::
7486 * FRV Options::
7487 * GNU/Linux Options::
7488 * H8/300 Options::
7489 * HPPA Options::
7490 * i386 and x86-64 Options::
7491 * IA-64 Options::
7492 * M32C Options::
7493 * M32R/D Options::
7494 * M680x0 Options::
7495 * M68hc1x Options::
7496 * MCore Options::
7497 * MIPS Options::
7498 * MMIX Options::
7499 * MN10300 Options::
7500 * MT Options::
7501 * PDP-11 Options::
7502 * PowerPC Options::
7503 * RS/6000 and PowerPC Options::
7504 * S/390 and zSeries Options::
7505 * Score Options::
7506 * SH Options::
7507 * SPARC Options::
7508 * SPU Options::
7509 * System V Options::
7510 * TMS320C3x/C4x Options::
7511 * V850 Options::
7512 * VAX Options::
7513 * x86-64 Options::
7514 * Xstormy16 Options::
7515 * Xtensa Options::
7516 * zSeries Options::
7517 @end menu
7518
7519 @node ARC Options
7520 @subsection ARC Options
7521 @cindex ARC Options
7522
7523 These options are defined for ARC implementations:
7524
7525 @table @gcctabopt
7526 @item -EL
7527 @opindex EL
7528 Compile code for little endian mode.  This is the default.
7529
7530 @item -EB
7531 @opindex EB
7532 Compile code for big endian mode.
7533
7534 @item -mmangle-cpu
7535 @opindex mmangle-cpu
7536 Prepend the name of the cpu to all public symbol names.
7537 In multiple-processor systems, there are many ARC variants with different
7538 instruction and register set characteristics.  This flag prevents code
7539 compiled for one cpu to be linked with code compiled for another.
7540 No facility exists for handling variants that are ``almost identical''.
7541 This is an all or nothing option.
7542
7543 @item -mcpu=@var{cpu}
7544 @opindex mcpu
7545 Compile code for ARC variant @var{cpu}.
7546 Which variants are supported depend on the configuration.
7547 All variants support @option{-mcpu=base}, this is the default.
7548
7549 @item -mtext=@var{text-section}
7550 @itemx -mdata=@var{data-section}
7551 @itemx -mrodata=@var{readonly-data-section}
7552 @opindex mtext
7553 @opindex mdata
7554 @opindex mrodata
7555 Put functions, data, and readonly data in @var{text-section},
7556 @var{data-section}, and @var{readonly-data-section} respectively
7557 by default.  This can be overridden with the @code{section} attribute.
7558 @xref{Variable Attributes}.
7559
7560 @end table
7561
7562 @node ARM Options
7563 @subsection ARM Options
7564 @cindex ARM options
7565
7566 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7567 architectures:
7568
7569 @table @gcctabopt
7570 @item -mabi=@var{name}
7571 @opindex mabi
7572 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7573 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7574
7575 @item -mapcs-frame
7576 @opindex mapcs-frame
7577 Generate a stack frame that is compliant with the ARM Procedure Call
7578 Standard for all functions, even if this is not strictly necessary for
7579 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7580 with this option will cause the stack frames not to be generated for
7581 leaf functions.  The default is @option{-mno-apcs-frame}.
7582
7583 @item -mapcs
7584 @opindex mapcs
7585 This is a synonym for @option{-mapcs-frame}.
7586
7587 @ignore
7588 @c not currently implemented
7589 @item -mapcs-stack-check
7590 @opindex mapcs-stack-check
7591 Generate code to check the amount of stack space available upon entry to
7592 every function (that actually uses some stack space).  If there is
7593 insufficient space available then either the function
7594 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7595 called, depending upon the amount of stack space required.  The run time
7596 system is required to provide these functions.  The default is
7597 @option{-mno-apcs-stack-check}, since this produces smaller code.
7598
7599 @c not currently implemented
7600 @item -mapcs-float
7601 @opindex mapcs-float
7602 Pass floating point arguments using the float point registers.  This is
7603 one of the variants of the APCS@.  This option is recommended if the
7604 target hardware has a floating point unit or if a lot of floating point
7605 arithmetic is going to be performed by the code.  The default is
7606 @option{-mno-apcs-float}, since integer only code is slightly increased in
7607 size if @option{-mapcs-float} is used.
7608
7609 @c not currently implemented
7610 @item -mapcs-reentrant
7611 @opindex mapcs-reentrant
7612 Generate reentrant, position independent code.  The default is
7613 @option{-mno-apcs-reentrant}.
7614 @end ignore
7615
7616 @item -mthumb-interwork
7617 @opindex mthumb-interwork
7618 Generate code which supports calling between the ARM and Thumb
7619 instruction sets.  Without this option the two instruction sets cannot
7620 be reliably used inside one program.  The default is
7621 @option{-mno-thumb-interwork}, since slightly larger code is generated
7622 when @option{-mthumb-interwork} is specified.
7623
7624 @item -mno-sched-prolog
7625 @opindex mno-sched-prolog
7626 Prevent the reordering of instructions in the function prolog, or the
7627 merging of those instruction with the instructions in the function's
7628 body.  This means that all functions will start with a recognizable set
7629 of instructions (or in fact one of a choice from a small set of
7630 different function prologues), and this information can be used to
7631 locate the start if functions inside an executable piece of code.  The
7632 default is @option{-msched-prolog}.
7633
7634 @item -mhard-float
7635 @opindex mhard-float
7636 Generate output containing floating point instructions.  This is the
7637 default.
7638
7639 @item -msoft-float
7640 @opindex msoft-float
7641 Generate output containing library calls for floating point.
7642 @strong{Warning:} the requisite libraries are not available for all ARM
7643 targets.  Normally the facilities of the machine's usual C compiler are
7644 used, but this cannot be done directly in cross-compilation.  You must make
7645 your own arrangements to provide suitable library functions for
7646 cross-compilation.
7647
7648 @option{-msoft-float} changes the calling convention in the output file;
7649 therefore, it is only useful if you compile @emph{all} of a program with
7650 this option.  In particular, you need to compile @file{libgcc.a}, the
7651 library that comes with GCC, with @option{-msoft-float} in order for
7652 this to work.
7653
7654 @item -mfloat-abi=@var{name}
7655 @opindex mfloat-abi
7656 Specifies which ABI to use for floating point values.  Permissible values
7657 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7658
7659 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7660 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7661 of floating point instructions, but still uses the soft-float calling
7662 conventions.
7663
7664 @item -mlittle-endian
7665 @opindex mlittle-endian
7666 Generate code for a processor running in little-endian mode.  This is
7667 the default for all standard configurations.
7668
7669 @item -mbig-endian
7670 @opindex mbig-endian
7671 Generate code for a processor running in big-endian mode; the default is
7672 to compile code for a little-endian processor.
7673
7674 @item -mwords-little-endian
7675 @opindex mwords-little-endian
7676 This option only applies when generating code for big-endian processors.
7677 Generate code for a little-endian word order but a big-endian byte
7678 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7679 option should only be used if you require compatibility with code for
7680 big-endian ARM processors generated by versions of the compiler prior to
7681 2.8.
7682
7683 @item -mcpu=@var{name}
7684 @opindex mcpu
7685 This specifies the name of the target ARM processor.  GCC uses this name
7686 to determine what kind of instructions it can emit when generating
7687 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7688 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7689 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7690 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7691 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7692 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7693 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7694 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7695 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7696 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7697 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7698 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7699 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7700 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
7701 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
7702 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
7703
7704 @itemx -mtune=@var{name}
7705 @opindex mtune
7706 This option is very similar to the @option{-mcpu=} option, except that
7707 instead of specifying the actual target processor type, and hence
7708 restricting which instructions can be used, it specifies that GCC should
7709 tune the performance of the code as if the target were of the type
7710 specified in this option, but still choosing the instructions that it
7711 will generate based on the cpu specified by a @option{-mcpu=} option.
7712 For some ARM implementations better performance can be obtained by using
7713 this option.
7714
7715 @item -march=@var{name}
7716 @opindex march
7717 This specifies the name of the target ARM architecture.  GCC uses this
7718 name to determine what kind of instructions it can emit when generating
7719 assembly code.  This option can be used in conjunction with or instead
7720 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7721 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7722 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7723 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
7724 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
7725
7726 @item -mfpu=@var{name}
7727 @itemx -mfpe=@var{number}
7728 @itemx -mfp=@var{number}
7729 @opindex mfpu
7730 @opindex mfpe
7731 @opindex mfp
7732 This specifies what floating point hardware (or hardware emulation) is
7733 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7734 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7735 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7736 with older versions of GCC@.
7737
7738 If @option{-msoft-float} is specified this specifies the format of
7739 floating point values.
7740
7741 @item -mstructure-size-boundary=@var{n}
7742 @opindex mstructure-size-boundary
7743 The size of all structures and unions will be rounded up to a multiple
7744 of the number of bits set by this option.  Permissible values are 8, 32
7745 and 64.  The default value varies for different toolchains.  For the COFF
7746 targeted toolchain the default value is 8.  A value of 64 is only allowed
7747 if the underlying ABI supports it.
7748
7749 Specifying the larger number can produce faster, more efficient code, but
7750 can also increase the size of the program.  Different values are potentially
7751 incompatible.  Code compiled with one value cannot necessarily expect to
7752 work with code or libraries compiled with another value, if they exchange
7753 information using structures or unions.
7754
7755 @item -mabort-on-noreturn
7756 @opindex mabort-on-noreturn
7757 Generate a call to the function @code{abort} at the end of a
7758 @code{noreturn} function.  It will be executed if the function tries to
7759 return.
7760
7761 @item -mlong-calls
7762 @itemx -mno-long-calls
7763 @opindex mlong-calls
7764 @opindex mno-long-calls
7765 Tells the compiler to perform function calls by first loading the
7766 address of the function into a register and then performing a subroutine
7767 call on this register.  This switch is needed if the target function
7768 will lie outside of the 64 megabyte addressing range of the offset based
7769 version of subroutine call instruction.
7770
7771 Even if this switch is enabled, not all function calls will be turned
7772 into long calls.  The heuristic is that static functions, functions
7773 which have the @samp{short-call} attribute, functions that are inside
7774 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7775 definitions have already been compiled within the current compilation
7776 unit, will not be turned into long calls.  The exception to this rule is
7777 that weak function definitions, functions with the @samp{long-call}
7778 attribute or the @samp{section} attribute, and functions that are within
7779 the scope of a @samp{#pragma long_calls} directive, will always be
7780 turned into long calls.
7781
7782 This feature is not enabled by default.  Specifying
7783 @option{-mno-long-calls} will restore the default behavior, as will
7784 placing the function calls within the scope of a @samp{#pragma
7785 long_calls_off} directive.  Note these switches have no effect on how
7786 the compiler generates code to handle function calls via function
7787 pointers.
7788
7789 @item -mnop-fun-dllimport
7790 @opindex mnop-fun-dllimport
7791 Disable support for the @code{dllimport} attribute.
7792
7793 @item -msingle-pic-base
7794 @opindex msingle-pic-base
7795 Treat the register used for PIC addressing as read-only, rather than
7796 loading it in the prologue for each function.  The run-time system is
7797 responsible for initializing this register with an appropriate value
7798 before execution begins.
7799
7800 @item -mpic-register=@var{reg}
7801 @opindex mpic-register
7802 Specify the register to be used for PIC addressing.  The default is R10
7803 unless stack-checking is enabled, when R9 is used.
7804
7805 @item -mcirrus-fix-invalid-insns
7806 @opindex mcirrus-fix-invalid-insns
7807 @opindex mno-cirrus-fix-invalid-insns
7808 Insert NOPs into the instruction stream to in order to work around
7809 problems with invalid Maverick instruction combinations.  This option
7810 is only valid if the @option{-mcpu=ep9312} option has been used to
7811 enable generation of instructions for the Cirrus Maverick floating
7812 point co-processor.  This option is not enabled by default, since the
7813 problem is only present in older Maverick implementations.  The default
7814 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7815 switch.
7816
7817 @item -mpoke-function-name
7818 @opindex mpoke-function-name
7819 Write the name of each function into the text section, directly
7820 preceding the function prologue.  The generated code is similar to this:
7821
7822 @smallexample
7823      t0
7824          .ascii "arm_poke_function_name", 0
7825          .align
7826      t1
7827          .word 0xff000000 + (t1 - t0)
7828      arm_poke_function_name
7829          mov     ip, sp
7830          stmfd   sp!, @{fp, ip, lr, pc@}
7831          sub     fp, ip, #4
7832 @end smallexample
7833
7834 When performing a stack backtrace, code can inspect the value of
7835 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7836 location @code{pc - 12} and the top 8 bits are set, then we know that
7837 there is a function name embedded immediately preceding this location
7838 and has length @code{((pc[-3]) & 0xff000000)}.
7839
7840 @item -mthumb
7841 @opindex mthumb
7842 Generate code for the Thumb instruction set.  The default is to
7843 use the 32-bit ARM instruction set.
7844 This option automatically enables either 16-bit Thumb-1 or
7845 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
7846 and @option{-march=@var{name}} options.
7847
7848 @item -mtpcs-frame
7849 @opindex mtpcs-frame
7850 Generate a stack frame that is compliant with the Thumb Procedure Call
7851 Standard for all non-leaf functions.  (A leaf function is one that does
7852 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7853
7854 @item -mtpcs-leaf-frame
7855 @opindex mtpcs-leaf-frame
7856 Generate a stack frame that is compliant with the Thumb Procedure Call
7857 Standard for all leaf functions.  (A leaf function is one that does
7858 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7859
7860 @item -mcallee-super-interworking
7861 @opindex mcallee-super-interworking
7862 Gives all externally visible functions in the file being compiled an ARM
7863 instruction set header which switches to Thumb mode before executing the
7864 rest of the function.  This allows these functions to be called from
7865 non-interworking code.
7866
7867 @item -mcaller-super-interworking
7868 @opindex mcaller-super-interworking
7869 Allows calls via function pointers (including virtual functions) to
7870 execute correctly regardless of whether the target code has been
7871 compiled for interworking or not.  There is a small overhead in the cost
7872 of executing a function pointer if this option is enabled.
7873
7874 @item -mtp=@var{name}
7875 @opindex mtp
7876 Specify the access model for the thread local storage pointer.  The valid
7877 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7878 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7879 (supported in the arm6k architecture), and @option{auto}, which uses the
7880 best available method for the selected processor.  The default setting is
7881 @option{auto}.
7882
7883 @end table
7884
7885 @node AVR Options
7886 @subsection AVR Options
7887 @cindex AVR Options
7888
7889 These options are defined for AVR implementations:
7890
7891 @table @gcctabopt
7892 @item -mmcu=@var{mcu}
7893 @opindex mmcu
7894 Specify ATMEL AVR instruction set or MCU type.
7895
7896 Instruction set avr1 is for the minimal AVR core, not supported by the C
7897 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7898 attiny11, attiny12, attiny15, attiny28).
7899
7900 Instruction set avr2 (default) is for the classic AVR core with up to
7901 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7902 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7903 at90c8534, at90s8535).
7904
7905 Instruction set avr3 is for the classic AVR core with up to 128K program
7906 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7907
7908 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7909 memory space (MCU types: atmega8, atmega83, atmega85).
7910
7911 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7912 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7913 atmega64, atmega128, at43usb355, at94k).
7914
7915 @item -msize
7916 @opindex msize
7917 Output instruction sizes to the asm file.
7918
7919 @item -minit-stack=@var{N}
7920 @opindex minit-stack
7921 Specify the initial stack address, which may be a symbol or numeric value,
7922 @samp{__stack} is the default.
7923
7924 @item -mno-interrupts
7925 @opindex mno-interrupts
7926 Generated code is not compatible with hardware interrupts.
7927 Code size will be smaller.
7928
7929 @item -mcall-prologues
7930 @opindex mcall-prologues
7931 Functions prologues/epilogues expanded as call to appropriate
7932 subroutines.  Code size will be smaller.
7933
7934 @item -mno-tablejump
7935 @opindex mno-tablejump
7936 Do not generate tablejump insns which sometimes increase code size.
7937
7938 @item -mtiny-stack
7939 @opindex mtiny-stack
7940 Change only the low 8 bits of the stack pointer.
7941
7942 @item -mint8
7943 @opindex mint8
7944 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7945 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7946 and long long will be 4 bytes.  Please note that this option does not
7947 comply to the C standards, but it will provide you with smaller code
7948 size.
7949 @end table
7950
7951 @node Blackfin Options
7952 @subsection Blackfin Options
7953 @cindex Blackfin Options
7954
7955 @table @gcctabopt
7956 @item -momit-leaf-frame-pointer
7957 @opindex momit-leaf-frame-pointer
7958 Don't keep the frame pointer in a register for leaf functions.  This
7959 avoids the instructions to save, set up and restore frame pointers and
7960 makes an extra register available in leaf functions.  The option
7961 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7962 which might make debugging harder.
7963
7964 @item -mspecld-anomaly
7965 @opindex mspecld-anomaly
7966 When enabled, the compiler will ensure that the generated code does not
7967 contain speculative loads after jump instructions.  This option is enabled
7968 by default.
7969
7970 @item -mno-specld-anomaly
7971 @opindex mno-specld-anomaly
7972 Don't generate extra code to prevent speculative loads from occurring.
7973
7974 @item -mcsync-anomaly
7975 @opindex mcsync-anomaly
7976 When enabled, the compiler will ensure that the generated code does not
7977 contain CSYNC or SSYNC instructions too soon after conditional branches.
7978 This option is enabled by default.
7979
7980 @item -mno-csync-anomaly
7981 @opindex mno-csync-anomaly
7982 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7983 occurring too soon after a conditional branch.
7984
7985 @item -mlow-64k
7986 @opindex mlow-64k
7987 When enabled, the compiler is free to take advantage of the knowledge that
7988 the entire program fits into the low 64k of memory.
7989
7990 @item -mno-low-64k
7991 @opindex mno-low-64k
7992 Assume that the program is arbitrarily large.  This is the default.
7993
7994 @item -mstack-check-l1
7995 @opindex mstack-check-l1
7996 Do stack checking using information placed into L1 scratchpad memory by the
7997 uClinux kernel.
7998
7999 @item -mid-shared-library
8000 @opindex mid-shared-library
8001 Generate code that supports shared libraries via the library ID method.
8002 This allows for execute in place and shared libraries in an environment
8003 without virtual memory management.  This option implies @option{-fPIC}.
8004
8005 @item -mno-id-shared-library
8006 @opindex mno-id-shared-library
8007 Generate code that doesn't assume ID based shared libraries are being used.
8008 This is the default.
8009
8010 @item -mleaf-id-shared-library
8011 @opindex mleaf-id-shared-library
8012 Generate code that supports shared libraries via the library ID method,
8013 but assumes that this library or executable won't link against any other
8014 ID shared libraries.  That allows the compiler to use faster code for jumps
8015 and calls.
8016
8017 @item -mno-leaf-id-shared-library
8018 @opindex mno-leaf-id-shared-library
8019 Do not assume that the code being compiled won't link against any ID shared
8020 libraries.  Slower code will be generated for jump and call insns.
8021
8022 @item -mshared-library-id=n
8023 @opindex mshared-library-id
8024 Specified the identification number of the ID based shared library being
8025 compiled.  Specifying a value of 0 will generate more compact code, specifying
8026 other values will force the allocation of that number to the current
8027 library but is no more space or time efficient than omitting this option.
8028
8029 @item -msep-data
8030 @opindex msep-data
8031 Generate code that allows the data segment to be located in a different
8032 area of memory from the text segment.  This allows for execute in place in
8033 an environment without virtual memory management by eliminating relocations
8034 against the text section.
8035
8036 @item -mno-sep-data
8037 @opindex mno-sep-data
8038 Generate code that assumes that the data segment follows the text segment.
8039 This is the default.
8040
8041 @item -mlong-calls
8042 @itemx -mno-long-calls
8043 @opindex mlong-calls
8044 @opindex mno-long-calls
8045 Tells the compiler to perform function calls by first loading the
8046 address of the function into a register and then performing a subroutine
8047 call on this register.  This switch is needed if the target function
8048 will lie outside of the 24 bit addressing range of the offset based
8049 version of subroutine call instruction.
8050
8051 This feature is not enabled by default.  Specifying
8052 @option{-mno-long-calls} will restore the default behavior.  Note these
8053 switches have no effect on how the compiler generates code to handle
8054 function calls via function pointers.
8055 @end table
8056
8057 @node CRIS Options
8058 @subsection CRIS Options
8059 @cindex CRIS Options
8060
8061 These options are defined specifically for the CRIS ports.
8062
8063 @table @gcctabopt
8064 @item -march=@var{architecture-type}
8065 @itemx -mcpu=@var{architecture-type}
8066 @opindex march
8067 @opindex mcpu
8068 Generate code for the specified architecture.  The choices for
8069 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8070 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
8071 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
8072 @samp{v10}.
8073
8074 @item -mtune=@var{architecture-type}
8075 @opindex mtune
8076 Tune to @var{architecture-type} everything applicable about the generated
8077 code, except for the ABI and the set of available instructions.  The
8078 choices for @var{architecture-type} are the same as for
8079 @option{-march=@var{architecture-type}}.
8080
8081 @item -mmax-stack-frame=@var{n}
8082 @opindex mmax-stack-frame
8083 Warn when the stack frame of a function exceeds @var{n} bytes.
8084
8085 @item -melinux-stacksize=@var{n}
8086 @opindex melinux-stacksize
8087 Only available with the @samp{cris-axis-aout} target.  Arranges for
8088 indications in the program to the kernel loader that the stack of the
8089 program should be set to @var{n} bytes.
8090
8091 @item -metrax4
8092 @itemx -metrax100
8093 @opindex metrax4
8094 @opindex metrax100
8095 The options @option{-metrax4} and @option{-metrax100} are synonyms for
8096 @option{-march=v3} and @option{-march=v8} respectively.
8097
8098 @item -mmul-bug-workaround
8099 @itemx -mno-mul-bug-workaround
8100 @opindex mmul-bug-workaround
8101 @opindex mno-mul-bug-workaround
8102 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
8103 models where it applies.  This option is active by default.
8104
8105 @item -mpdebug
8106 @opindex mpdebug
8107 Enable CRIS-specific verbose debug-related information in the assembly
8108 code.  This option also has the effect to turn off the @samp{#NO_APP}
8109 formatted-code indicator to the assembler at the beginning of the
8110 assembly file.
8111
8112 @item -mcc-init
8113 @opindex mcc-init
8114 Do not use condition-code results from previous instruction; always emit
8115 compare and test instructions before use of condition codes.
8116
8117 @item -mno-side-effects
8118 @opindex mno-side-effects
8119 Do not emit instructions with side-effects in addressing modes other than
8120 post-increment.
8121
8122 @item -mstack-align
8123 @itemx -mno-stack-align
8124 @itemx -mdata-align
8125 @itemx -mno-data-align
8126 @itemx -mconst-align
8127 @itemx -mno-const-align
8128 @opindex mstack-align
8129 @opindex mno-stack-align
8130 @opindex mdata-align
8131 @opindex mno-data-align
8132 @opindex mconst-align
8133 @opindex mno-const-align
8134 These options (no-options) arranges (eliminate arrangements) for the
8135 stack-frame, individual data and constants to be aligned for the maximum
8136 single data access size for the chosen CPU model.  The default is to
8137 arrange for 32-bit alignment.  ABI details such as structure layout are
8138 not affected by these options.
8139
8140 @item -m32-bit
8141 @itemx -m16-bit
8142 @itemx -m8-bit
8143 @opindex m32-bit
8144 @opindex m16-bit
8145 @opindex m8-bit
8146 Similar to the stack- data- and const-align options above, these options
8147 arrange for stack-frame, writable data and constants to all be 32-bit,
8148 16-bit or 8-bit aligned.  The default is 32-bit alignment.
8149
8150 @item -mno-prologue-epilogue
8151 @itemx -mprologue-epilogue
8152 @opindex mno-prologue-epilogue
8153 @opindex mprologue-epilogue
8154 With @option{-mno-prologue-epilogue}, the normal function prologue and
8155 epilogue that sets up the stack-frame are omitted and no return
8156 instructions or return sequences are generated in the code.  Use this
8157 option only together with visual inspection of the compiled code: no
8158 warnings or errors are generated when call-saved registers must be saved,
8159 or storage for local variable needs to be allocated.
8160
8161 @item -mno-gotplt
8162 @itemx -mgotplt
8163 @opindex mno-gotplt
8164 @opindex mgotplt
8165 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8166 instruction sequences that load addresses for functions from the PLT part
8167 of the GOT rather than (traditional on other architectures) calls to the
8168 PLT@.  The default is @option{-mgotplt}.
8169
8170 @item -maout
8171 @opindex maout
8172 Legacy no-op option only recognized with the cris-axis-aout target.
8173
8174 @item -melf
8175 @opindex melf
8176 Legacy no-op option only recognized with the cris-axis-elf and
8177 cris-axis-linux-gnu targets.
8178
8179 @item -melinux
8180 @opindex melinux
8181 Only recognized with the cris-axis-aout target, where it selects a
8182 GNU/linux-like multilib, include files and instruction set for
8183 @option{-march=v8}.
8184
8185 @item -mlinux
8186 @opindex mlinux
8187 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8188
8189 @item -sim
8190 @opindex sim
8191 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8192 to link with input-output functions from a simulator library.  Code,
8193 initialized data and zero-initialized data are allocated consecutively.
8194
8195 @item -sim2
8196 @opindex sim2
8197 Like @option{-sim}, but pass linker options to locate initialized data at
8198 0x40000000 and zero-initialized data at 0x80000000.
8199 @end table
8200
8201 @node CRX Options
8202 @subsection CRX Options
8203 @cindex CRX Options
8204
8205 These options are defined specifically for the CRX ports.
8206
8207 @table @gcctabopt
8208
8209 @item -mmac
8210 @opindex mmac
8211 Enable the use of multiply-accumulate instructions. Disabled by default.
8212
8213 @item -mpush-args
8214 @opindex mpush-args
8215 Push instructions will be used to pass outgoing arguments when functions
8216 are called. Enabled by default.
8217 @end table
8218
8219 @node Darwin Options
8220 @subsection Darwin Options
8221 @cindex Darwin options
8222
8223 These options are defined for all architectures running the Darwin operating
8224 system.
8225
8226 FSF GCC on Darwin does not create ``fat'' object files; it will create
8227 an object file for the single architecture that it was built to
8228 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
8229 @option{-arch} options are used; it does so by running the compiler or
8230 linker multiple times and joining the results together with
8231 @file{lipo}.
8232
8233 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8234 @samp{i686}) is determined by the flags that specify the ISA
8235 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
8236 @option{-force_cpusubtype_ALL} option can be used to override this.
8237
8238 The Darwin tools vary in their behavior when presented with an ISA
8239 mismatch.  The assembler, @file{as}, will only permit instructions to
8240 be used that are valid for the subtype of the file it is generating,
8241 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8242 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8243 and print an error if asked to create a shared library with a less
8244 restrictive subtype than its input files (for instance, trying to put
8245 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
8246 for executables, @file{ld}, will quietly give the executable the most
8247 restrictive subtype of any of its input files.
8248
8249 @table @gcctabopt
8250 @item -F@var{dir}
8251 @opindex F
8252 Add the framework directory @var{dir} to the head of the list of
8253 directories to be searched for header files.  These directories are
8254 interleaved with those specified by @option{-I} options and are
8255 scanned in a left-to-right order.
8256
8257 A framework directory is a directory with frameworks in it.  A
8258 framework is a directory with a @samp{"Headers"} and/or
8259 @samp{"PrivateHeaders"} directory contained directly in it that ends
8260 in @samp{".framework"}.  The name of a framework is the name of this
8261 directory excluding the @samp{".framework"}.  Headers associated with
8262 the framework are found in one of those two directories, with
8263 @samp{"Headers"} being searched first.  A subframework is a framework
8264 directory that is in a framework's @samp{"Frameworks"} directory.
8265 Includes of subframework headers can only appear in a header of a
8266 framework that contains the subframework, or in a sibling subframework
8267 header.  Two subframeworks are siblings if they occur in the same
8268 framework.  A subframework should not have the same name as a
8269 framework, a warning will be issued if this is violated.  Currently a
8270 subframework cannot have subframeworks, in the future, the mechanism
8271 may be extended to support this.  The standard frameworks can be found
8272 in @samp{"/System/Library/Frameworks"} and
8273 @samp{"/Library/Frameworks"}.  An example include looks like
8274 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8275 the name of the framework and header.h is found in the
8276 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8277
8278 @item -gused
8279 @opindex -gused
8280 Emit debugging information for symbols that are used.  For STABS
8281 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8282 This is by default ON@.
8283
8284 @item -gfull
8285 @opindex -gfull
8286 Emit debugging information for all symbols and types.
8287
8288 @item -mmacosx-version-min=@var{version}
8289 The earliest version of MacOS X that this executable will run on
8290 is @var{version}.  Typical values of @var{version} include @code{10.1},
8291 @code{10.2}, and @code{10.3.9}.
8292
8293 The default for this option is to make choices that seem to be most
8294 useful.  
8295
8296 @item -mkernel
8297 @opindex mkernel
8298 Enable kernel development mode.  The @option{-mkernel} option sets
8299 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8300 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8301 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8302 applicable.  This mode also sets @option{-mno-altivec},
8303 @option{-msoft-float}, @option{-fno-builtin} and
8304 @option{-mlong-branch} for PowerPC targets.
8305
8306 @item -mone-byte-bool
8307 @opindex -mone-byte-bool
8308 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8309 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8310 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8311 option has no effect on x86.
8312
8313 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8314 to generate code that is not binary compatible with code generated
8315 without that switch.  Using this switch may require recompiling all
8316 other modules in a program, including system libraries.  Use this
8317 switch to conform to a non-default data model.
8318
8319 @item -mfix-and-continue
8320 @itemx -ffix-and-continue
8321 @itemx -findirect-data
8322 @opindex mfix-and-continue
8323 @opindex ffix-and-continue
8324 @opindex findirect-data
8325 Generate code suitable for fast turn around development.  Needed to
8326 enable gdb to dynamically load @code{.o} files into already running
8327 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8328 are provided for backwards compatibility.
8329
8330 @item -all_load
8331 @opindex all_load
8332 Loads all members of static archive libraries.
8333 See man ld(1) for more information.
8334
8335 @item -arch_errors_fatal
8336 @opindex arch_errors_fatal
8337 Cause the errors having to do with files that have the wrong architecture
8338 to be fatal.
8339
8340 @item -bind_at_load
8341 @opindex bind_at_load
8342 Causes the output file to be marked such that the dynamic linker will
8343 bind all undefined references when the file is loaded or launched.
8344
8345 @item -bundle
8346 @opindex bundle
8347 Produce a Mach-o bundle format file.
8348 See man ld(1) for more information.
8349
8350 @item -bundle_loader @var{executable}
8351 @opindex bundle_loader
8352 This option specifies the @var{executable} that will be loading the build
8353 output file being linked.  See man ld(1) for more information.
8354
8355 @item -dynamiclib
8356 @opindex -dynamiclib
8357 When passed this option, GCC will produce a dynamic library instead of
8358 an executable when linking, using the Darwin @file{libtool} command.
8359
8360 @item -force_cpusubtype_ALL
8361 @opindex -force_cpusubtype_ALL
8362 This causes GCC's output file to have the @var{ALL} subtype, instead of
8363 one controlled by the @option{-mcpu} or @option{-march} option.
8364
8365 @item -allowable_client  @var{client_name}
8366 @itemx -client_name
8367 @itemx -compatibility_version
8368 @itemx -current_version
8369 @itemx -dead_strip
8370 @itemx -dependency-file
8371 @itemx -dylib_file
8372 @itemx -dylinker_install_name
8373 @itemx -dynamic
8374 @itemx -exported_symbols_list
8375 @itemx -filelist
8376 @itemx -flat_namespace
8377 @itemx -force_flat_namespace
8378 @itemx -headerpad_max_install_names
8379 @itemx -image_base
8380 @itemx -init
8381 @itemx -install_name
8382 @itemx -keep_private_externs
8383 @itemx -multi_module
8384 @itemx -multiply_defined
8385 @itemx -multiply_defined_unused
8386 @itemx -noall_load
8387 @itemx -no_dead_strip_inits_and_terms
8388 @itemx -nofixprebinding
8389 @itemx -nomultidefs
8390 @itemx -noprebind
8391 @itemx -noseglinkedit
8392 @itemx -pagezero_size
8393 @itemx -prebind
8394 @itemx -prebind_all_twolevel_modules
8395 @itemx -private_bundle
8396 @itemx -read_only_relocs
8397 @itemx -sectalign
8398 @itemx -sectobjectsymbols
8399 @itemx -whyload
8400 @itemx -seg1addr
8401 @itemx -sectcreate
8402 @itemx -sectobjectsymbols
8403 @itemx -sectorder
8404 @itemx -segaddr
8405 @itemx -segs_read_only_addr
8406 @itemx -segs_read_write_addr
8407 @itemx -seg_addr_table
8408 @itemx -seg_addr_table_filename
8409 @itemx -seglinkedit
8410 @itemx -segprot
8411 @itemx -segs_read_only_addr
8412 @itemx -segs_read_write_addr
8413 @itemx -single_module
8414 @itemx -static
8415 @itemx -sub_library
8416 @itemx -sub_umbrella
8417 @itemx -twolevel_namespace
8418 @itemx -umbrella
8419 @itemx -undefined
8420 @itemx -unexported_symbols_list
8421 @itemx -weak_reference_mismatches
8422 @itemx -whatsloaded
8423
8424 @opindex allowable_client
8425 @opindex client_name
8426 @opindex compatibility_version
8427 @opindex current_version
8428 @opindex dead_strip
8429 @opindex dependency-file
8430 @opindex dylib_file
8431 @opindex dylinker_install_name
8432 @opindex dynamic
8433 @opindex exported_symbols_list
8434 @opindex filelist
8435 @opindex flat_namespace
8436 @opindex force_flat_namespace
8437 @opindex headerpad_max_install_names
8438 @opindex image_base
8439 @opindex init
8440 @opindex install_name
8441 @opindex keep_private_externs
8442 @opindex multi_module
8443 @opindex multiply_defined
8444 @opindex multiply_defined_unused
8445 @opindex noall_load
8446 @opindex no_dead_strip_inits_and_terms
8447 @opindex nofixprebinding
8448 @opindex nomultidefs
8449 @opindex noprebind
8450 @opindex noseglinkedit
8451 @opindex pagezero_size
8452 @opindex prebind
8453 @opindex prebind_all_twolevel_modules
8454 @opindex private_bundle
8455 @opindex read_only_relocs
8456 @opindex sectalign
8457 @opindex sectobjectsymbols
8458 @opindex whyload
8459 @opindex seg1addr
8460 @opindex sectcreate
8461 @opindex sectobjectsymbols
8462 @opindex sectorder
8463 @opindex segaddr
8464 @opindex segs_read_only_addr
8465 @opindex segs_read_write_addr
8466 @opindex seg_addr_table
8467 @opindex seg_addr_table_filename
8468 @opindex seglinkedit
8469 @opindex segprot
8470 @opindex segs_read_only_addr
8471 @opindex segs_read_write_addr
8472 @opindex single_module
8473 @opindex static
8474 @opindex sub_library
8475 @opindex sub_umbrella
8476 @opindex twolevel_namespace
8477 @opindex umbrella
8478 @opindex undefined
8479 @opindex unexported_symbols_list
8480 @opindex weak_reference_mismatches
8481 @opindex whatsloaded
8482
8483 These options are passed to the Darwin linker.  The Darwin linker man page
8484 describes them in detail.
8485 @end table
8486
8487 @node DEC Alpha Options
8488 @subsection DEC Alpha Options
8489
8490 These @samp{-m} options are defined for the DEC Alpha implementations:
8491
8492 @table @gcctabopt
8493 @item -mno-soft-float
8494 @itemx -msoft-float
8495 @opindex mno-soft-float
8496 @opindex msoft-float
8497 Use (do not use) the hardware floating-point instructions for
8498 floating-point operations.  When @option{-msoft-float} is specified,
8499 functions in @file{libgcc.a} will be used to perform floating-point
8500 operations.  Unless they are replaced by routines that emulate the
8501 floating-point operations, or compiled in such a way as to call such
8502 emulations routines, these routines will issue floating-point
8503 operations.   If you are compiling for an Alpha without floating-point
8504 operations, you must ensure that the library is built so as not to call
8505 them.
8506
8507 Note that Alpha implementations without floating-point operations are
8508 required to have floating-point registers.
8509
8510 @item -mfp-reg
8511 @itemx -mno-fp-regs
8512 @opindex mfp-reg
8513 @opindex mno-fp-regs
8514 Generate code that uses (does not use) the floating-point register set.
8515 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8516 register set is not used, floating point operands are passed in integer
8517 registers as if they were integers and floating-point results are passed
8518 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8519 so any function with a floating-point argument or return value called by code
8520 compiled with @option{-mno-fp-regs} must also be compiled with that
8521 option.
8522
8523 A typical use of this option is building a kernel that does not use,
8524 and hence need not save and restore, any floating-point registers.
8525
8526 @item -mieee
8527 @opindex mieee
8528 The Alpha architecture implements floating-point hardware optimized for
8529 maximum performance.  It is mostly compliant with the IEEE floating
8530 point standard.  However, for full compliance, software assistance is
8531 required.  This option generates code fully IEEE compliant code
8532 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8533 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8534 defined during compilation.  The resulting code is less efficient but is
8535 able to correctly support denormalized numbers and exceptional IEEE
8536 values such as not-a-number and plus/minus infinity.  Other Alpha
8537 compilers call this option @option{-ieee_with_no_inexact}.
8538
8539 @item -mieee-with-inexact
8540 @opindex mieee-with-inexact
8541 This is like @option{-mieee} except the generated code also maintains
8542 the IEEE @var{inexact-flag}.  Turning on this option causes the
8543 generated code to implement fully-compliant IEEE math.  In addition to
8544 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8545 macro.  On some Alpha implementations the resulting code may execute
8546 significantly slower than the code generated by default.  Since there is
8547 very little code that depends on the @var{inexact-flag}, you should
8548 normally not specify this option.  Other Alpha compilers call this
8549 option @option{-ieee_with_inexact}.
8550
8551 @item -mfp-trap-mode=@var{trap-mode}
8552 @opindex mfp-trap-mode
8553 This option controls what floating-point related traps are enabled.
8554 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8555 The trap mode can be set to one of four values:
8556
8557 @table @samp
8558 @item n
8559 This is the default (normal) setting.  The only traps that are enabled
8560 are the ones that cannot be disabled in software (e.g., division by zero
8561 trap).
8562
8563 @item u
8564 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8565 as well.
8566
8567 @item su
8568 Like @samp{u}, but the instructions are marked to be safe for software
8569 completion (see Alpha architecture manual for details).
8570
8571 @item sui
8572 Like @samp{su}, but inexact traps are enabled as well.
8573 @end table
8574
8575 @item -mfp-rounding-mode=@var{rounding-mode}
8576 @opindex mfp-rounding-mode
8577 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8578 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8579 of:
8580
8581 @table @samp
8582 @item n
8583 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8584 the nearest machine number or towards the even machine number in case
8585 of a tie.
8586
8587 @item m
8588 Round towards minus infinity.
8589
8590 @item c
8591 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8592
8593 @item d
8594 Dynamic rounding mode.  A field in the floating point control register
8595 (@var{fpcr}, see Alpha architecture reference manual) controls the
8596 rounding mode in effect.  The C library initializes this register for
8597 rounding towards plus infinity.  Thus, unless your program modifies the
8598 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8599 @end table
8600
8601 @item -mtrap-precision=@var{trap-precision}
8602 @opindex mtrap-precision
8603 In the Alpha architecture, floating point traps are imprecise.  This
8604 means without software assistance it is impossible to recover from a
8605 floating trap and program execution normally needs to be terminated.
8606 GCC can generate code that can assist operating system trap handlers
8607 in determining the exact location that caused a floating point trap.
8608 Depending on the requirements of an application, different levels of
8609 precisions can be selected:
8610
8611 @table @samp
8612 @item p
8613 Program precision.  This option is the default and means a trap handler
8614 can only identify which program caused a floating point exception.
8615
8616 @item f
8617 Function precision.  The trap handler can determine the function that
8618 caused a floating point exception.
8619
8620 @item i
8621 Instruction precision.  The trap handler can determine the exact
8622 instruction that caused a floating point exception.
8623 @end table
8624
8625 Other Alpha compilers provide the equivalent options called
8626 @option{-scope_safe} and @option{-resumption_safe}.
8627
8628 @item -mieee-conformant
8629 @opindex mieee-conformant
8630 This option marks the generated code as IEEE conformant.  You must not
8631 use this option unless you also specify @option{-mtrap-precision=i} and either
8632 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8633 is to emit the line @samp{.eflag 48} in the function prologue of the
8634 generated assembly file.  Under DEC Unix, this has the effect that
8635 IEEE-conformant math library routines will be linked in.
8636
8637 @item -mbuild-constants
8638 @opindex mbuild-constants
8639 Normally GCC examines a 32- or 64-bit integer constant to
8640 see if it can construct it from smaller constants in two or three
8641 instructions.  If it cannot, it will output the constant as a literal and
8642 generate code to load it from the data segment at runtime.
8643
8644 Use this option to require GCC to construct @emph{all} integer constants
8645 using code, even if it takes more instructions (the maximum is six).
8646
8647 You would typically use this option to build a shared library dynamic
8648 loader.  Itself a shared library, it must relocate itself in memory
8649 before it can find the variables and constants in its own data segment.
8650
8651 @item -malpha-as
8652 @itemx -mgas
8653 @opindex malpha-as
8654 @opindex mgas
8655 Select whether to generate code to be assembled by the vendor-supplied
8656 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8657
8658 @item -mbwx
8659 @itemx -mno-bwx
8660 @itemx -mcix
8661 @itemx -mno-cix
8662 @itemx -mfix
8663 @itemx -mno-fix
8664 @itemx -mmax
8665 @itemx -mno-max
8666 @opindex mbwx
8667 @opindex mno-bwx
8668 @opindex mcix
8669 @opindex mno-cix
8670 @opindex mfix
8671 @opindex mno-fix
8672 @opindex mmax
8673 @opindex mno-max
8674 Indicate whether GCC should generate code to use the optional BWX,
8675 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8676 sets supported by the CPU type specified via @option{-mcpu=} option or that
8677 of the CPU on which GCC was built if none was specified.
8678
8679 @item -mfloat-vax
8680 @itemx -mfloat-ieee
8681 @opindex mfloat-vax
8682 @opindex mfloat-ieee
8683 Generate code that uses (does not use) VAX F and G floating point
8684 arithmetic instead of IEEE single and double precision.
8685
8686 @item -mexplicit-relocs
8687 @itemx -mno-explicit-relocs
8688 @opindex mexplicit-relocs
8689 @opindex mno-explicit-relocs
8690 Older Alpha assemblers provided no way to generate symbol relocations
8691 except via assembler macros.  Use of these macros does not allow
8692 optimal instruction scheduling.  GNU binutils as of version 2.12
8693 supports a new syntax that allows the compiler to explicitly mark
8694 which relocations should apply to which instructions.  This option
8695 is mostly useful for debugging, as GCC detects the capabilities of
8696 the assembler when it is built and sets the default accordingly.
8697
8698 @item -msmall-data
8699 @itemx -mlarge-data
8700 @opindex msmall-data
8701 @opindex mlarge-data
8702 When @option{-mexplicit-relocs} is in effect, static data is
8703 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8704 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8705 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8706 16-bit relocations off of the @code{$gp} register.  This limits the
8707 size of the small data area to 64KB, but allows the variables to be
8708 directly accessed via a single instruction.
8709
8710 The default is @option{-mlarge-data}.  With this option the data area
8711 is limited to just below 2GB@.  Programs that require more than 2GB of
8712 data must use @code{malloc} or @code{mmap} to allocate the data in the
8713 heap instead of in the program's data segment.
8714
8715 When generating code for shared libraries, @option{-fpic} implies
8716 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8717
8718 @item -msmall-text
8719 @itemx -mlarge-text
8720 @opindex msmall-text
8721 @opindex mlarge-text
8722 When @option{-msmall-text} is used, the compiler assumes that the
8723 code of the entire program (or shared library) fits in 4MB, and is
8724 thus reachable with a branch instruction.  When @option{-msmall-data}
8725 is used, the compiler can assume that all local symbols share the
8726 same @code{$gp} value, and thus reduce the number of instructions
8727 required for a function call from 4 to 1.
8728
8729 The default is @option{-mlarge-text}.
8730
8731 @item -mcpu=@var{cpu_type}
8732 @opindex mcpu
8733 Set the instruction set and instruction scheduling parameters for
8734 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8735 style name or the corresponding chip number.  GCC supports scheduling
8736 parameters for the EV4, EV5 and EV6 family of processors and will
8737 choose the default values for the instruction set from the processor
8738 you specify.  If you do not specify a processor type, GCC will default
8739 to the processor on which the compiler was built.
8740
8741 Supported values for @var{cpu_type} are
8742
8743 @table @samp
8744 @item ev4
8745 @itemx ev45
8746 @itemx 21064
8747 Schedules as an EV4 and has no instruction set extensions.
8748
8749 @item ev5
8750 @itemx 21164
8751 Schedules as an EV5 and has no instruction set extensions.
8752
8753 @item ev56
8754 @itemx 21164a
8755 Schedules as an EV5 and supports the BWX extension.
8756
8757 @item pca56
8758 @itemx 21164pc
8759 @itemx 21164PC
8760 Schedules as an EV5 and supports the BWX and MAX extensions.
8761
8762 @item ev6
8763 @itemx 21264
8764 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8765
8766 @item ev67
8767 @itemx 21264a
8768 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8769 @end table
8770
8771 @item -mtune=@var{cpu_type}
8772 @opindex mtune
8773 Set only the instruction scheduling parameters for machine type
8774 @var{cpu_type}.  The instruction set is not changed.
8775
8776 @item -mmemory-latency=@var{time}
8777 @opindex mmemory-latency
8778 Sets the latency the scheduler should assume for typical memory
8779 references as seen by the application.  This number is highly
8780 dependent on the memory access patterns used by the application
8781 and the size of the external cache on the machine.
8782
8783 Valid options for @var{time} are
8784
8785 @table @samp
8786 @item @var{number}
8787 A decimal number representing clock cycles.
8788
8789 @item L1
8790 @itemx L2
8791 @itemx L3
8792 @itemx main
8793 The compiler contains estimates of the number of clock cycles for
8794 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8795 (also called Dcache, Scache, and Bcache), as well as to main memory.
8796 Note that L3 is only valid for EV5.
8797
8798 @end table
8799 @end table
8800
8801 @node DEC Alpha/VMS Options
8802 @subsection DEC Alpha/VMS Options
8803
8804 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8805
8806 @table @gcctabopt
8807 @item -mvms-return-codes
8808 @opindex mvms-return-codes
8809 Return VMS condition codes from main.  The default is to return POSIX
8810 style condition (e.g.@ error) codes.
8811 @end table
8812
8813 @node FRV Options
8814 @subsection FRV Options
8815 @cindex FRV Options
8816
8817 @table @gcctabopt
8818 @item -mgpr-32
8819 @opindex mgpr-32
8820
8821 Only use the first 32 general purpose registers.
8822
8823 @item -mgpr-64
8824 @opindex mgpr-64
8825
8826 Use all 64 general purpose registers.
8827
8828 @item -mfpr-32
8829 @opindex mfpr-32
8830
8831 Use only the first 32 floating point registers.
8832
8833 @item -mfpr-64
8834 @opindex mfpr-64
8835
8836 Use all 64 floating point registers
8837
8838 @item -mhard-float
8839 @opindex mhard-float
8840
8841 Use hardware instructions for floating point operations.
8842
8843 @item -msoft-float
8844 @opindex msoft-float
8845
8846 Use library routines for floating point operations.
8847
8848 @item -malloc-cc
8849 @opindex malloc-cc
8850
8851 Dynamically allocate condition code registers.
8852
8853 @item -mfixed-cc
8854 @opindex mfixed-cc
8855
8856 Do not try to dynamically allocate condition code registers, only
8857 use @code{icc0} and @code{fcc0}.
8858
8859 @item -mdword
8860 @opindex mdword
8861
8862 Change ABI to use double word insns.
8863
8864 @item -mno-dword
8865 @opindex mno-dword
8866
8867 Do not use double word instructions.
8868
8869 @item -mdouble
8870 @opindex mdouble
8871
8872 Use floating point double instructions.
8873
8874 @item -mno-double
8875 @opindex mno-double
8876
8877 Do not use floating point double instructions.
8878
8879 @item -mmedia
8880 @opindex mmedia
8881
8882 Use media instructions.
8883
8884 @item -mno-media
8885 @opindex mno-media
8886
8887 Do not use media instructions.
8888
8889 @item -mmuladd
8890 @opindex mmuladd
8891
8892 Use multiply and add/subtract instructions.
8893
8894 @item -mno-muladd
8895 @opindex mno-muladd
8896
8897 Do not use multiply and add/subtract instructions.
8898
8899 @item -mfdpic
8900 @opindex mfdpic
8901
8902 Select the FDPIC ABI, that uses function descriptors to represent
8903 pointers to functions.  Without any PIC/PIE-related options, it
8904 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8905 assumes GOT entries and small data are within a 12-bit range from the
8906 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8907 are computed with 32 bits.
8908
8909 @item -minline-plt
8910 @opindex minline-plt
8911
8912 Enable inlining of PLT entries in function calls to functions that are
8913 not known to bind locally.  It has no effect without @option{-mfdpic}.
8914 It's enabled by default if optimizing for speed and compiling for
8915 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8916 optimization option such as @option{-O3} or above is present in the
8917 command line.
8918
8919 @item -mTLS
8920 @opindex TLS
8921
8922 Assume a large TLS segment when generating thread-local code.
8923
8924 @item -mtls
8925 @opindex tls
8926
8927 Do not assume a large TLS segment when generating thread-local code.
8928
8929 @item -mgprel-ro
8930 @opindex mgprel-ro
8931
8932 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8933 that is known to be in read-only sections.  It's enabled by default,
8934 except for @option{-fpic} or @option{-fpie}: even though it may help
8935 make the global offset table smaller, it trades 1 instruction for 4.
8936 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8937 one of which may be shared by multiple symbols, and it avoids the need
8938 for a GOT entry for the referenced symbol, so it's more likely to be a
8939 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8940
8941 @item -multilib-library-pic
8942 @opindex multilib-library-pic
8943
8944 Link with the (library, not FD) pic libraries.  It's implied by
8945 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8946 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8947 it explicitly.
8948
8949 @item -mlinked-fp
8950 @opindex mlinked-fp
8951
8952 Follow the EABI requirement of always creating a frame pointer whenever
8953 a stack frame is allocated.  This option is enabled by default and can
8954 be disabled with @option{-mno-linked-fp}.
8955
8956 @item -mlong-calls
8957 @opindex mlong-calls
8958
8959 Use indirect addressing to call functions outside the current
8960 compilation unit.  This allows the functions to be placed anywhere
8961 within the 32-bit address space.
8962
8963 @item -malign-labels
8964 @opindex malign-labels
8965
8966 Try to align labels to an 8-byte boundary by inserting nops into the
8967 previous packet.  This option only has an effect when VLIW packing
8968 is enabled.  It doesn't create new packets; it merely adds nops to
8969 existing ones.
8970
8971 @item -mlibrary-pic
8972 @opindex mlibrary-pic
8973
8974 Generate position-independent EABI code.
8975
8976 @item -macc-4
8977 @opindex macc-4
8978
8979 Use only the first four media accumulator registers.
8980
8981 @item -macc-8
8982 @opindex macc-8
8983
8984 Use all eight media accumulator registers.
8985
8986 @item -mpack
8987 @opindex mpack
8988
8989 Pack VLIW instructions.
8990
8991 @item -mno-pack
8992 @opindex mno-pack
8993
8994 Do not pack VLIW instructions.
8995
8996 @item -mno-eflags
8997 @opindex mno-eflags
8998
8999 Do not mark ABI switches in e_flags.
9000
9001 @item -mcond-move
9002 @opindex mcond-move
9003
9004 Enable the use of conditional-move instructions (default).
9005
9006 This switch is mainly for debugging the compiler and will likely be removed
9007 in a future version.
9008
9009 @item -mno-cond-move
9010 @opindex mno-cond-move
9011
9012 Disable the use of conditional-move instructions.
9013
9014 This switch is mainly for debugging the compiler and will likely be removed
9015 in a future version.
9016
9017 @item -mscc
9018 @opindex mscc
9019
9020 Enable the use of conditional set instructions (default).
9021
9022 This switch is mainly for debugging the compiler and will likely be removed
9023 in a future version.
9024
9025 @item -mno-scc
9026 @opindex mno-scc
9027
9028 Disable the use of conditional set instructions.
9029
9030 This switch is mainly for debugging the compiler and will likely be removed
9031 in a future version.
9032
9033 @item -mcond-exec
9034 @opindex mcond-exec
9035
9036 Enable the use of conditional execution (default).
9037
9038 This switch is mainly for debugging the compiler and will likely be removed
9039 in a future version.
9040
9041 @item -mno-cond-exec
9042 @opindex mno-cond-exec
9043
9044 Disable the use of conditional execution.
9045
9046 This switch is mainly for debugging the compiler and will likely be removed
9047 in a future version.
9048
9049 @item -mvliw-branch
9050 @opindex mvliw-branch
9051
9052 Run a pass to pack branches into VLIW instructions (default).
9053
9054 This switch is mainly for debugging the compiler and will likely be removed
9055 in a future version.
9056
9057 @item -mno-vliw-branch
9058 @opindex mno-vliw-branch
9059
9060 Do not run a pass to pack branches into VLIW instructions.
9061
9062 This switch is mainly for debugging the compiler and will likely be removed
9063 in a future version.
9064
9065 @item -mmulti-cond-exec
9066 @opindex mmulti-cond-exec
9067
9068 Enable optimization of @code{&&} and @code{||} in conditional execution
9069 (default).
9070
9071 This switch is mainly for debugging the compiler and will likely be removed
9072 in a future version.
9073
9074 @item -mno-multi-cond-exec
9075 @opindex mno-multi-cond-exec
9076
9077 Disable optimization of @code{&&} and @code{||} in conditional execution.
9078
9079 This switch is mainly for debugging the compiler and will likely be removed
9080 in a future version.
9081
9082 @item -mnested-cond-exec
9083 @opindex mnested-cond-exec
9084
9085 Enable nested conditional execution optimizations (default).
9086
9087 This switch is mainly for debugging the compiler and will likely be removed
9088 in a future version.
9089
9090 @item -mno-nested-cond-exec
9091 @opindex mno-nested-cond-exec
9092
9093 Disable nested conditional execution optimizations.
9094
9095 This switch is mainly for debugging the compiler and will likely be removed
9096 in a future version.
9097
9098 @item -moptimize-membar
9099 @opindex moptimize-membar
9100
9101 This switch removes redundant @code{membar} instructions from the
9102 compiler generated code.  It is enabled by default.
9103
9104 @item -mno-optimize-membar
9105 @opindex mno-optimize-membar
9106
9107 This switch disables the automatic removal of redundant @code{membar}
9108 instructions from the generated code.
9109
9110 @item -mtomcat-stats
9111 @opindex mtomcat-stats
9112
9113 Cause gas to print out tomcat statistics.
9114
9115 @item -mcpu=@var{cpu}
9116 @opindex mcpu
9117
9118 Select the processor type for which to generate code.  Possible values are
9119 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9120 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9121
9122 @end table
9123
9124 @node GNU/Linux Options
9125 @subsection GNU/Linux Options
9126
9127 These @samp{-m} options are defined for GNU/Linux targets:
9128
9129 @table @gcctabopt
9130 @item -mglibc
9131 @opindex mglibc
9132 Use the GNU C library instead of uClibc.  This is the default except
9133 on @samp{*-*-linux-*uclibc*} targets.
9134
9135 @item -muclibc
9136 @opindex muclibc
9137 Use uClibc instead of the GNU C library.  This is the default on
9138 @samp{*-*-linux-*uclibc*} targets.
9139 @end table
9140
9141 @node H8/300 Options
9142 @subsection H8/300 Options
9143
9144 These @samp{-m} options are defined for the H8/300 implementations:
9145
9146 @table @gcctabopt
9147 @item -mrelax
9148 @opindex mrelax
9149 Shorten some address references at link time, when possible; uses the
9150 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9151 ld, Using ld}, for a fuller description.
9152
9153 @item -mh
9154 @opindex mh
9155 Generate code for the H8/300H@.
9156
9157 @item -ms
9158 @opindex ms
9159 Generate code for the H8S@.
9160
9161 @item -mn
9162 @opindex mn
9163 Generate code for the H8S and H8/300H in the normal mode.  This switch
9164 must be used either with @option{-mh} or @option{-ms}.
9165
9166 @item -ms2600
9167 @opindex ms2600
9168 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9169
9170 @item -mint32
9171 @opindex mint32
9172 Make @code{int} data 32 bits by default.
9173
9174 @item -malign-300
9175 @opindex malign-300
9176 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9177 The default for the H8/300H and H8S is to align longs and floats on 4
9178 byte boundaries.
9179 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9180 This option has no effect on the H8/300.
9181 @end table
9182
9183 @node HPPA Options
9184 @subsection HPPA Options
9185 @cindex HPPA Options
9186
9187 These @samp{-m} options are defined for the HPPA family of computers:
9188
9189 @table @gcctabopt
9190 @item -march=@var{architecture-type}
9191 @opindex march
9192 Generate code for the specified architecture.  The choices for
9193 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9194 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
9195 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9196 architecture option for your machine.  Code compiled for lower numbered
9197 architectures will run on higher numbered architectures, but not the
9198 other way around.
9199
9200 @item -mpa-risc-1-0
9201 @itemx -mpa-risc-1-1
9202 @itemx -mpa-risc-2-0
9203 @opindex mpa-risc-1-0
9204 @opindex mpa-risc-1-1
9205 @opindex mpa-risc-2-0
9206 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9207
9208 @item -mbig-switch
9209 @opindex mbig-switch
9210 Generate code suitable for big switch tables.  Use this option only if
9211 the assembler/linker complain about out of range branches within a switch
9212 table.
9213
9214 @item -mjump-in-delay
9215 @opindex mjump-in-delay
9216 Fill delay slots of function calls with unconditional jump instructions
9217 by modifying the return pointer for the function call to be the target
9218 of the conditional jump.
9219
9220 @item -mdisable-fpregs
9221 @opindex mdisable-fpregs
9222 Prevent floating point registers from being used in any manner.  This is
9223 necessary for compiling kernels which perform lazy context switching of
9224 floating point registers.  If you use this option and attempt to perform
9225 floating point operations, the compiler will abort.
9226
9227 @item -mdisable-indexing
9228 @opindex mdisable-indexing
9229 Prevent the compiler from using indexing address modes.  This avoids some
9230 rather obscure problems when compiling MIG generated code under MACH@.
9231
9232 @item -mno-space-regs
9233 @opindex mno-space-regs
9234 Generate code that assumes the target has no space registers.  This allows
9235 GCC to generate faster indirect calls and use unscaled index address modes.
9236
9237 Such code is suitable for level 0 PA systems and kernels.
9238
9239 @item -mfast-indirect-calls
9240 @opindex mfast-indirect-calls
9241 Generate code that assumes calls never cross space boundaries.  This
9242 allows GCC to emit code which performs faster indirect calls.
9243
9244 This option will not work in the presence of shared libraries or nested
9245 functions.
9246
9247 @item -mfixed-range=@var{register-range}
9248 @opindex mfixed-range
9249 Generate code treating the given register range as fixed registers.
9250 A fixed register is one that the register allocator can not use.  This is
9251 useful when compiling kernel code.  A register range is specified as
9252 two registers separated by a dash.  Multiple register ranges can be
9253 specified separated by a comma.
9254
9255 @item -mlong-load-store
9256 @opindex mlong-load-store
9257 Generate 3-instruction load and store sequences as sometimes required by
9258 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
9259 the HP compilers.
9260
9261 @item -mportable-runtime
9262 @opindex mportable-runtime
9263 Use the portable calling conventions proposed by HP for ELF systems.
9264
9265 @item -mgas
9266 @opindex mgas
9267 Enable the use of assembler directives only GAS understands.
9268
9269 @item -mschedule=@var{cpu-type}
9270 @opindex mschedule
9271 Schedule code according to the constraints for the machine type
9272 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
9273 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
9274 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9275 proper scheduling option for your machine.  The default scheduling is
9276 @samp{8000}.
9277
9278 @item -mlinker-opt
9279 @opindex mlinker-opt
9280 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
9281 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
9282 linkers in which they give bogus error messages when linking some programs.
9283
9284 @item -msoft-float
9285 @opindex msoft-float
9286 Generate output containing library calls for floating point.
9287 @strong{Warning:} the requisite libraries are not available for all HPPA
9288 targets.  Normally the facilities of the machine's usual C compiler are
9289 used, but this cannot be done directly in cross-compilation.  You must make
9290 your own arrangements to provide suitable library functions for
9291 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
9292 does provide software floating point support.
9293
9294 @option{-msoft-float} changes the calling convention in the output file;
9295 therefore, it is only useful if you compile @emph{all} of a program with
9296 this option.  In particular, you need to compile @file{libgcc.a}, the
9297 library that comes with GCC, with @option{-msoft-float} in order for
9298 this to work.
9299
9300 @item -msio
9301 @opindex msio
9302 Generate the predefine, @code{_SIO}, for server IO@.  The default is
9303 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
9304 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
9305 options are available under HP-UX and HI-UX@.
9306
9307 @item -mgnu-ld
9308 @opindex gnu-ld
9309 Use GNU ld specific options.  This passes @option{-shared} to ld when
9310 building a shared library.  It is the default when GCC is configured,
9311 explicitly or implicitly, with the GNU linker.  This option does not
9312 have any affect on which ld is called, it only changes what parameters
9313 are passed to that ld.  The ld that is called is determined by the
9314 @option{--with-ld} configure option, GCC's program search path, and
9315 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9316 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
9317 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9318
9319 @item -mhp-ld
9320 @opindex hp-ld
9321 Use HP ld specific options.  This passes @option{-b} to ld when building
9322 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9323 links.  It is the default when GCC is configured, explicitly or
9324 implicitly, with the HP linker.  This option does not have any affect on
9325 which ld is called, it only changes what parameters are passed to that
9326 ld.  The ld that is called is determined by the @option{--with-ld}
9327 configure option, GCC's program search path, and finally by the user's
9328 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9329 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9330 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9331
9332 @item -mlong-calls
9333 @opindex mno-long-calls
9334 Generate code that uses long call sequences.  This ensures that a call
9335 is always able to reach linker generated stubs.  The default is to generate
9336 long calls only when the distance from the call site to the beginning
9337 of the function or translation unit, as the case may be, exceeds a
9338 predefined limit set by the branch type being used.  The limits for
9339 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9340 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9341 240,000 bytes.
9342
9343 Distances are measured from the beginning of functions when using the
9344 @option{-ffunction-sections} option, or when using the @option{-mgas}
9345 and @option{-mno-portable-runtime} options together under HP-UX with
9346 the SOM linker.
9347
9348 It is normally not desirable to use this option as it will degrade
9349 performance.  However, it may be useful in large applications,
9350 particularly when partial linking is used to build the application.
9351
9352 The types of long calls used depends on the capabilities of the
9353 assembler and linker, and the type of code being generated.  The
9354 impact on systems that support long absolute calls, and long pic
9355 symbol-difference or pc-relative calls should be relatively small.
9356 However, an indirect call is used on 32-bit ELF systems in pic code
9357 and it is quite long.
9358
9359 @item -munix=@var{unix-std}
9360 @opindex march
9361 Generate compiler predefines and select a startfile for the specified
9362 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9363 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9364 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9365 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9366 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9367 and later.
9368
9369 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9370 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9371 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9372 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9373 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9374 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9375
9376 It is @emph{important} to note that this option changes the interfaces
9377 for various library routines.  It also affects the operational behavior
9378 of the C library.  Thus, @emph{extreme} care is needed in using this
9379 option.
9380
9381 Library code that is intended to operate with more than one UNIX
9382 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9383 as appropriate.  Most GNU software doesn't provide this capability.
9384
9385 @item -nolibdld
9386 @opindex nolibdld
9387 Suppress the generation of link options to search libdld.sl when the
9388 @option{-static} option is specified on HP-UX 10 and later.
9389
9390 @item -static
9391 @opindex static
9392 The HP-UX implementation of setlocale in libc has a dependency on
9393 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9394 when the @option{-static} option is specified, special link options
9395 are needed to resolve this dependency.
9396
9397 On HP-UX 10 and later, the GCC driver adds the necessary options to
9398 link with libdld.sl when the @option{-static} option is specified.
9399 This causes the resulting binary to be dynamic.  On the 64-bit port,
9400 the linkers generate dynamic binaries by default in any case.  The
9401 @option{-nolibdld} option can be used to prevent the GCC driver from
9402 adding these link options.
9403
9404 @item -threads
9405 @opindex threads
9406 Add support for multithreading with the @dfn{dce thread} library
9407 under HP-UX@.  This option sets flags for both the preprocessor and
9408 linker.
9409 @end table
9410
9411 @node i386 and x86-64 Options
9412 @subsection Intel 386 and AMD x86-64 Options
9413 @cindex i386 Options
9414 @cindex x86-64 Options
9415 @cindex Intel 386 Options
9416 @cindex AMD x86-64 Options
9417
9418 These @samp{-m} options are defined for the i386 and x86-64 family of
9419 computers:
9420
9421 @table @gcctabopt
9422 @item -mtune=@var{cpu-type}
9423 @opindex mtune
9424 Tune to @var{cpu-type} everything applicable about the generated code, except
9425 for the ABI and the set of available instructions.  The choices for
9426 @var{cpu-type} are:
9427 @table @emph
9428 @item generic
9429 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9430 If you know the CPU on which your code will run, then you should use
9431 the corresponding @option{-mtune} option instead of
9432 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9433 of your application will have, then you should use this option.
9434
9435 As new processors are deployed in the marketplace, the behavior of this
9436 option will change.  Therefore, if you upgrade to a newer version of
9437 GCC, the code generated option will change to reflect the processors
9438 that were most common when that version of GCC was released.
9439
9440 There is no @option{-march=generic} option because @option{-march}
9441 indicates the instruction set the compiler can use, and there is no
9442 generic instruction set applicable to all processors.  In contrast,
9443 @option{-mtune} indicates the processor (or, in this case, collection of
9444 processors) for which the code is optimized.
9445 @item native
9446 This selects the CPU to tune for at compilation time by determining
9447 the processor type of the compiling machine.  Using @option{-mtune=native}
9448 will produce code optimized for the local machine under the constraints
9449 of the selected instruction set.  Using @option{-march=native} will
9450 enable all instruction subsets supported by the local machine (hence
9451 the result might not run on different machines).
9452 @item i386
9453 Original Intel's i386 CPU@.
9454 @item i486
9455 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9456 @item i586, pentium
9457 Intel Pentium CPU with no MMX support.
9458 @item pentium-mmx
9459 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9460 @item pentiumpro
9461 Intel PentiumPro CPU@.
9462 @item i686
9463 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9464 instruction set will be used, so the code will run on all i686 family chips.
9465 @item pentium2
9466 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9467 @item pentium3, pentium3m
9468 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9469 support.
9470 @item pentium-m
9471 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9472 support.  Used by Centrino notebooks.
9473 @item pentium4, pentium4m
9474 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9475 @item prescott
9476 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9477 set support.
9478 @item nocona
9479 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9480 SSE2 and SSE3 instruction set support.
9481 @item core2
9482 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
9483 instruction set support.
9484 @item k6
9485 AMD K6 CPU with MMX instruction set support.
9486 @item k6-2, k6-3
9487 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9488 @item athlon, athlon-tbird
9489 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9490 support.
9491 @item athlon-4, athlon-xp, athlon-mp
9492 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9493 instruction set support.
9494 @item k8, opteron, athlon64, athlon-fx
9495 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9496 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9497 @item amdfam10
9498 AMD Family 10 core based CPUs with x86-64 instruction set support.  (This
9499 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
9500 instruction set extensions.)
9501 @item winchip-c6
9502 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9503 set support.
9504 @item winchip2
9505 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9506 instruction set support.
9507 @item c3
9508 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9509 implemented for this chip.)
9510 @item c3-2
9511 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9512 implemented for this chip.)
9513 @item geode
9514 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
9515 @end table
9516
9517 While picking a specific @var{cpu-type} will schedule things appropriately
9518 for that particular chip, the compiler will not generate any code that
9519 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9520 being used.
9521
9522 @item -march=@var{cpu-type}
9523 @opindex march
9524 Generate instructions for the machine type @var{cpu-type}.  The choices
9525 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9526 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9527
9528 @item -mcpu=@var{cpu-type}
9529 @opindex mcpu
9530 A deprecated synonym for @option{-mtune}.
9531
9532 @item -m386
9533 @itemx -m486
9534 @itemx -mpentium
9535 @itemx -mpentiumpro
9536 @opindex m386
9537 @opindex m486
9538 @opindex mpentium
9539 @opindex mpentiumpro
9540 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9541 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9542 These synonyms are deprecated.
9543
9544 @item -mfpmath=@var{unit}
9545 @opindex march
9546 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9547 for @var{unit} are:
9548
9549 @table @samp
9550 @item 387
9551 Use the standard 387 floating point coprocessor present majority of chips and
9552 emulated otherwise.  Code compiled with this option will run almost everywhere.
9553 The temporary results are computed in 80bit precision instead of precision
9554 specified by the type resulting in slightly different results compared to most
9555 of other chips.  See @option{-ffloat-store} for more detailed description.
9556
9557 This is the default choice for i386 compiler.
9558
9559 @item sse
9560 Use scalar floating point instructions present in the SSE instruction set.
9561 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9562 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9563 instruction set supports only single precision arithmetics, thus the double and
9564 extended precision arithmetics is still done using 387.  Later version, present
9565 only in Pentium4 and the future AMD x86-64 chips supports double precision
9566 arithmetics too.
9567
9568 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9569 or @option{-msse2} switches to enable SSE extensions and make this option
9570 effective.  For the x86-64 compiler, these extensions are enabled by default.
9571
9572 The resulting code should be considerably faster in the majority of cases and avoid
9573 the numerical instability problems of 387 code, but may break some existing
9574 code that expects temporaries to be 80bit.
9575
9576 This is the default choice for the x86-64 compiler.
9577
9578 @item sse,387
9579 Attempt to utilize both instruction sets at once.  This effectively double the
9580 amount of available registers and on chips with separate execution units for
9581 387 and SSE the execution resources too.  Use this option with care, as it is
9582 still experimental, because the GCC register allocator does not model separate
9583 functional units well resulting in instable performance.
9584 @end table
9585
9586 @item -masm=@var{dialect}
9587 @opindex masm=@var{dialect}
9588 Output asm instructions using selected @var{dialect}.  Supported
9589 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9590 not support @samp{intel}.
9591
9592 @item -mieee-fp
9593 @itemx -mno-ieee-fp
9594 @opindex mieee-fp
9595 @opindex mno-ieee-fp
9596 Control whether or not the compiler uses IEEE floating point
9597 comparisons.  These handle correctly the case where the result of a
9598 comparison is unordered.
9599
9600 @item -msoft-float
9601 @opindex msoft-float
9602 Generate output containing library calls for floating point.
9603 @strong{Warning:} the requisite libraries are not part of GCC@.
9604 Normally the facilities of the machine's usual C compiler are used, but
9605 this can't be done directly in cross-compilation.  You must make your
9606 own arrangements to provide suitable library functions for
9607 cross-compilation.
9608
9609 On machines where a function returns floating point results in the 80387
9610 register stack, some floating point opcodes may be emitted even if
9611 @option{-msoft-float} is used.
9612
9613 @item -mno-fp-ret-in-387
9614 @opindex mno-fp-ret-in-387
9615 Do not use the FPU registers for return values of functions.
9616
9617 The usual calling convention has functions return values of types
9618 @code{float} and @code{double} in an FPU register, even if there
9619 is no FPU@.  The idea is that the operating system should emulate
9620 an FPU@.
9621
9622 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9623 in ordinary CPU registers instead.
9624
9625 @item -mno-fancy-math-387
9626 @opindex mno-fancy-math-387
9627 Some 387 emulators do not support the @code{sin}, @code{cos} and
9628 @code{sqrt} instructions for the 387.  Specify this option to avoid
9629 generating those instructions.  This option is the default on FreeBSD,
9630 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9631 indicates that the target cpu will always have an FPU and so the
9632 instruction will not need emulation.  As of revision 2.6.1, these
9633 instructions are not generated unless you also use the
9634 @option{-funsafe-math-optimizations} switch.
9635
9636 @item -malign-double
9637 @itemx -mno-align-double
9638 @opindex malign-double
9639 @opindex mno-align-double
9640 Control whether GCC aligns @code{double}, @code{long double}, and
9641 @code{long long} variables on a two word boundary or a one word
9642 boundary.  Aligning @code{double} variables on a two word boundary will
9643 produce code that runs somewhat faster on a @samp{Pentium} at the
9644 expense of more memory.
9645
9646 On x86-64, @option{-malign-double} is enabled by default.
9647
9648 @strong{Warning:} if you use the @option{-malign-double} switch,
9649 structures containing the above types will be aligned differently than
9650 the published application binary interface specifications for the 386
9651 and will not be binary compatible with structures in code compiled
9652 without that switch.
9653
9654 @item -m96bit-long-double
9655 @itemx -m128bit-long-double
9656 @opindex m96bit-long-double
9657 @opindex m128bit-long-double
9658 These switches control the size of @code{long double} type.  The i386
9659 application binary interface specifies the size to be 96 bits,
9660 so @option{-m96bit-long-double} is the default in 32 bit mode.
9661
9662 Modern architectures (Pentium and newer) would prefer @code{long double}
9663 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9664 conforming to the ABI, this would not be possible.  So specifying a
9665 @option{-m128bit-long-double} will align @code{long double}
9666 to a 16 byte boundary by padding the @code{long double} with an additional
9667 32 bit zero.
9668
9669 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9670 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9671
9672 Notice that neither of these options enable any extra precision over the x87
9673 standard of 80 bits for a @code{long double}.
9674
9675 @strong{Warning:} if you override the default value for your target ABI, the
9676 structures and arrays containing @code{long double} variables will change
9677 their size as well as function calling convention for function taking
9678 @code{long double} will be modified.  Hence they will not be binary
9679 compatible with arrays or structures in code compiled without that switch.
9680
9681 @item -mmlarge-data-threshold=@var{number}
9682 @opindex mlarge-data-threshold=@var{number}
9683 When @option{-mcmodel=medium} is specified, the data greater than
9684 @var{threshold} are placed in large data section.  This value must be the
9685 same across all object linked into the binary and defaults to 65535.
9686
9687 @item -msvr3-shlib
9688 @itemx -mno-svr3-shlib
9689 @opindex msvr3-shlib
9690 @opindex mno-svr3-shlib
9691 Control whether GCC places uninitialized local variables into the
9692 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9693 into @code{bss}.  These options are meaningful only on System V Release 3.
9694
9695 @item -mrtd
9696 @opindex mrtd
9697 Use a different function-calling convention, in which functions that
9698 take a fixed number of arguments return with the @code{ret} @var{num}
9699 instruction, which pops their arguments while returning.  This saves one
9700 instruction in the caller since there is no need to pop the arguments
9701 there.
9702
9703 You can specify that an individual function is called with this calling
9704 sequence with the function attribute @samp{stdcall}.  You can also
9705 override the @option{-mrtd} option by using the function attribute
9706 @samp{cdecl}.  @xref{Function Attributes}.
9707
9708 @strong{Warning:} this calling convention is incompatible with the one
9709 normally used on Unix, so you cannot use it if you need to call
9710 libraries compiled with the Unix compiler.
9711
9712 Also, you must provide function prototypes for all functions that
9713 take variable numbers of arguments (including @code{printf});
9714 otherwise incorrect code will be generated for calls to those
9715 functions.
9716
9717 In addition, seriously incorrect code will result if you call a
9718 function with too many arguments.  (Normally, extra arguments are
9719 harmlessly ignored.)
9720
9721 @item -mregparm=@var{num}
9722 @opindex mregparm
9723 Control how many registers are used to pass integer arguments.  By
9724 default, no registers are used to pass arguments, and at most 3
9725 registers can be used.  You can control this behavior for a specific
9726 function by using the function attribute @samp{regparm}.
9727 @xref{Function Attributes}.
9728
9729 @strong{Warning:} if you use this switch, and
9730 @var{num} is nonzero, then you must build all modules with the same
9731 value, including any libraries.  This includes the system libraries and
9732 startup modules.
9733
9734 @item -msseregparm
9735 @opindex msseregparm
9736 Use SSE register passing conventions for float and double arguments
9737 and return values.  You can control this behavior for a specific
9738 function by using the function attribute @samp{sseregparm}.
9739 @xref{Function Attributes}.
9740
9741 @strong{Warning:} if you use this switch then you must build all
9742 modules with the same value, including any libraries.  This includes
9743 the system libraries and startup modules.
9744
9745 @item -mstackrealign
9746 @opindex mstackrealign
9747 Realign the stack at entry.  On the Intel x86, the
9748 @option{-mstackrealign} option will generate an alternate prologue and
9749 epilogue that realigns the runtime stack.  This supports mixing legacy
9750 codes that keep a 4-byte aligned stack with modern codes that keep a
9751 16-byte stack for SSE compatibility.  The alternate prologue and
9752 epilogue are slower and bigger than the regular ones, and the
9753 alternate prologue requires an extra scratch register; this lowers the
9754 number of registers available if used in conjunction with the
9755 @code{regparm} attribute.  The @option{-mstackrealign} option is
9756 incompatible with the nested function prologue; this is considered a
9757 hard error.  See also the attribute @code{force_align_arg_pointer},
9758 applicable to individual functions.
9759
9760 @item -mpreferred-stack-boundary=@var{num}
9761 @opindex mpreferred-stack-boundary
9762 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9763 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9764 the default is 4 (16 bytes or 128 bits).
9765
9766 On Pentium and PentiumPro, @code{double} and @code{long double} values
9767 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9768 suffer significant run time performance penalties.  On Pentium III, the
9769 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9770 properly if it is not 16 byte aligned.
9771
9772 To ensure proper alignment of this values on the stack, the stack boundary
9773 must be as aligned as that required by any value stored on the stack.
9774 Further, every function must be generated such that it keeps the stack
9775 aligned.  Thus calling a function compiled with a higher preferred
9776 stack boundary from a function compiled with a lower preferred stack
9777 boundary will most likely misalign the stack.  It is recommended that
9778 libraries that use callbacks always use the default setting.
9779
9780 This extra alignment does consume extra stack space, and generally
9781 increases code size.  Code that is sensitive to stack space usage, such
9782 as embedded systems and operating system kernels, may want to reduce the
9783 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9784
9785 @item -mmmx
9786 @itemx -mno-mmx
9787 @item -msse
9788 @itemx -mno-sse
9789 @item -msse2
9790 @itemx -mno-sse2
9791 @item -msse3
9792 @itemx -mno-sse3
9793 @item -mssse3
9794 @itemx -mno-ssse3
9795 @item -msse4a
9796 @item -mno-sse4a
9797 @item -m3dnow
9798 @itemx -mno-3dnow
9799 @item -mpopcnt
9800 @itemx -mno-popcnt
9801 @item -mabm
9802 @itemx -mno-abm
9803 @opindex mmmx
9804 @opindex mno-mmx
9805 @opindex msse
9806 @opindex mno-sse
9807 @opindex m3dnow
9808 @opindex mno-3dnow
9809 These switches enable or disable the use of instructions in the MMX,
9810 SSE, SSE2, SSE3, SSSE3, SSE4A, ABM or 3DNow! extended instruction sets.
9811 These extensions are also available as built-in functions: see
9812 @ref{X86 Built-in Functions}, for details of the functions enabled and
9813 disabled by these switches.
9814
9815 To have SSE/SSE2 instructions generated automatically from floating-point
9816 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9817
9818 These options will enable GCC to use these extended instructions in
9819 generated code, even without @option{-mfpmath=sse}.  Applications which
9820 perform runtime CPU detection must compile separate files for each
9821 supported architecture, using the appropriate flags.  In particular,
9822 the file containing the CPU detection code should be compiled without
9823 these options.
9824
9825 @item -mpush-args
9826 @itemx -mno-push-args
9827 @opindex mpush-args
9828 @opindex mno-push-args
9829 Use PUSH operations to store outgoing parameters.  This method is shorter
9830 and usually equally fast as method using SUB/MOV operations and is enabled
9831 by default.  In some cases disabling it may improve performance because of
9832 improved scheduling and reduced dependencies.
9833
9834 @item -maccumulate-outgoing-args
9835 @opindex maccumulate-outgoing-args
9836 If enabled, the maximum amount of space required for outgoing arguments will be
9837 computed in the function prologue.  This is faster on most modern CPUs
9838 because of reduced dependencies, improved scheduling and reduced stack usage
9839 when preferred stack boundary is not equal to 2.  The drawback is a notable
9840 increase in code size.  This switch implies @option{-mno-push-args}.
9841
9842 @item -mthreads
9843 @opindex mthreads
9844 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9845 on thread-safe exception handling must compile and link all code with the
9846 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9847 @option{-D_MT}; when linking, it links in a special thread helper library
9848 @option{-lmingwthrd} which cleans up per thread exception handling data.
9849
9850 @item -mno-align-stringops
9851 @opindex mno-align-stringops
9852 Do not align destination of inlined string operations.  This switch reduces
9853 code size and improves performance in case the destination is already aligned,
9854 but GCC doesn't know about it.
9855
9856 @item -minline-all-stringops
9857 @opindex minline-all-stringops
9858 By default GCC inlines string operations only when destination is known to be
9859 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9860 size, but may improve performance of code that depends on fast memcpy, strlen
9861 and memset for short lengths.
9862
9863 @item -minline-stringops-dynamically
9864 @opindex minline-stringops-dynamically
9865 For string operation of unknown size, inline runtime checks so for small
9866 blocks inline code is used, while for large blocks library call is used.
9867
9868 @item -mstringop-strategy=@var{alg}
9869 @opindex mstringop-strategy=@var{alg}
9870 Overwrite internal decision heuristic about particular algorithm to inline
9871 string operation with.  The allowed values are @code{rep_byte},
9872 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
9873 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
9874 expanding inline loop, @code{libcall} for always expanding library call.
9875
9876 @item -momit-leaf-frame-pointer
9877 @opindex momit-leaf-frame-pointer
9878 Don't keep the frame pointer in a register for leaf functions.  This
9879 avoids the instructions to save, set up and restore frame pointers and
9880 makes an extra register available in leaf functions.  The option
9881 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9882 which might make debugging harder.
9883
9884 @item -mtls-direct-seg-refs
9885 @itemx -mno-tls-direct-seg-refs
9886 @opindex mtls-direct-seg-refs
9887 Controls whether TLS variables may be accessed with offsets from the
9888 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9889 or whether the thread base pointer must be added.  Whether or not this
9890 is legal depends on the operating system, and whether it maps the
9891 segment to cover the entire TLS area.
9892
9893 For systems that use GNU libc, the default is on.
9894 @end table
9895
9896 These @samp{-m} switches are supported in addition to the above
9897 on AMD x86-64 processors in 64-bit environments.
9898
9899 @table @gcctabopt
9900 @item -m32
9901 @itemx -m64
9902 @opindex m32
9903 @opindex m64
9904 Generate code for a 32-bit or 64-bit environment.
9905 The 32-bit environment sets int, long and pointer to 32 bits and
9906 generates code that runs on any i386 system.
9907 The 64-bit environment sets int to 32 bits and long and pointer
9908 to 64 bits and generates code for AMD's x86-64 architecture.
9909
9910 @item -mno-red-zone
9911 @opindex no-red-zone
9912 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9913 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9914 stack pointer that will not be modified by signal or interrupt handlers
9915 and therefore can be used for temporary data without adjusting the stack
9916 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9917
9918 @item -mcmodel=small
9919 @opindex mcmodel=small
9920 Generate code for the small code model: the program and its symbols must
9921 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9922 Programs can be statically or dynamically linked.  This is the default
9923 code model.
9924
9925 @item -mcmodel=kernel
9926 @opindex mcmodel=kernel
9927 Generate code for the kernel code model.  The kernel runs in the
9928 negative 2 GB of the address space.
9929 This model has to be used for Linux kernel code.
9930
9931 @item -mcmodel=medium
9932 @opindex mcmodel=medium
9933 Generate code for the medium model: The program is linked in the lower 2
9934 GB of the address space but symbols can be located anywhere in the
9935 address space.  Programs can be statically or dynamically linked, but
9936 building of shared libraries are not supported with the medium model.
9937
9938 @item -mcmodel=large
9939 @opindex mcmodel=large
9940 Generate code for the large model: This model makes no assumptions
9941 about addresses and sizes of sections.  Currently GCC does not implement
9942 this model.
9943 @end table
9944
9945 @node IA-64 Options
9946 @subsection IA-64 Options
9947 @cindex IA-64 Options
9948
9949 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9950
9951 @table @gcctabopt
9952 @item -mbig-endian
9953 @opindex mbig-endian
9954 Generate code for a big endian target.  This is the default for HP-UX@.
9955
9956 @item -mlittle-endian
9957 @opindex mlittle-endian
9958 Generate code for a little endian target.  This is the default for AIX5
9959 and GNU/Linux.
9960
9961 @item -mgnu-as
9962 @itemx -mno-gnu-as
9963 @opindex mgnu-as
9964 @opindex mno-gnu-as
9965 Generate (or don't) code for the GNU assembler.  This is the default.
9966 @c Also, this is the default if the configure option @option{--with-gnu-as}
9967 @c is used.
9968
9969 @item -mgnu-ld
9970 @itemx -mno-gnu-ld
9971 @opindex mgnu-ld
9972 @opindex mno-gnu-ld
9973 Generate (or don't) code for the GNU linker.  This is the default.
9974 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9975 @c is used.
9976
9977 @item -mno-pic
9978 @opindex mno-pic
9979 Generate code that does not use a global pointer register.  The result
9980 is not position independent code, and violates the IA-64 ABI@.
9981
9982 @item -mvolatile-asm-stop
9983 @itemx -mno-volatile-asm-stop
9984 @opindex mvolatile-asm-stop
9985 @opindex mno-volatile-asm-stop
9986 Generate (or don't) a stop bit immediately before and after volatile asm
9987 statements.
9988
9989 @item -mregister-names
9990 @itemx -mno-register-names
9991 @opindex mregister-names
9992 @opindex mno-register-names
9993 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9994 the stacked registers.  This may make assembler output more readable.
9995
9996 @item -mno-sdata
9997 @itemx -msdata
9998 @opindex mno-sdata
9999 @opindex msdata
10000 Disable (or enable) optimizations that use the small data section.  This may
10001 be useful for working around optimizer bugs.
10002
10003 @item -mconstant-gp
10004 @opindex mconstant-gp
10005 Generate code that uses a single constant global pointer value.  This is
10006 useful when compiling kernel code.
10007
10008 @item -mauto-pic
10009 @opindex mauto-pic
10010 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10011 This is useful when compiling firmware code.
10012
10013 @item -minline-float-divide-min-latency
10014 @opindex minline-float-divide-min-latency
10015 Generate code for inline divides of floating point values
10016 using the minimum latency algorithm.
10017
10018 @item -minline-float-divide-max-throughput
10019 @opindex minline-float-divide-max-throughput
10020 Generate code for inline divides of floating point values
10021 using the maximum throughput algorithm.
10022
10023 @item -minline-int-divide-min-latency
10024 @opindex minline-int-divide-min-latency
10025 Generate code for inline divides of integer values
10026 using the minimum latency algorithm.
10027
10028 @item -minline-int-divide-max-throughput
10029 @opindex minline-int-divide-max-throughput
10030 Generate code for inline divides of integer values
10031 using the maximum throughput algorithm.
10032
10033 @item -minline-sqrt-min-latency
10034 @opindex minline-sqrt-min-latency
10035 Generate code for inline square roots
10036 using the minimum latency algorithm.
10037
10038 @item -minline-sqrt-max-throughput
10039 @opindex minline-sqrt-max-throughput
10040 Generate code for inline square roots
10041 using the maximum throughput algorithm.
10042
10043 @item -mno-dwarf2-asm
10044 @itemx -mdwarf2-asm
10045 @opindex mno-dwarf2-asm
10046 @opindex mdwarf2-asm
10047 Don't (or do) generate assembler code for the DWARF2 line number debugging
10048 info.  This may be useful when not using the GNU assembler.
10049
10050 @item -mearly-stop-bits
10051 @itemx -mno-early-stop-bits
10052 @opindex mearly-stop-bits
10053 @opindex mno-early-stop-bits
10054 Allow stop bits to be placed earlier than immediately preceding the
10055 instruction that triggered the stop bit.  This can improve instruction
10056 scheduling, but does not always do so.
10057
10058 @item -mfixed-range=@var{register-range}
10059 @opindex mfixed-range
10060 Generate code treating the given register range as fixed registers.
10061 A fixed register is one that the register allocator can not use.  This is
10062 useful when compiling kernel code.  A register range is specified as
10063 two registers separated by a dash.  Multiple register ranges can be
10064 specified separated by a comma.
10065
10066 @item -mtls-size=@var{tls-size}
10067 @opindex mtls-size
10068 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
10069 64.
10070
10071 @item -mtune=@var{cpu-type}
10072 @opindex mtune
10073 Tune the instruction scheduling for a particular CPU, Valid values are
10074 itanium, itanium1, merced, itanium2, and mckinley.
10075
10076 @item -mt
10077 @itemx -pthread
10078 @opindex mt
10079 @opindex pthread
10080 Add support for multithreading using the POSIX threads library.  This
10081 option sets flags for both the preprocessor and linker.  It does
10082 not affect the thread safety of object code produced by the compiler or
10083 that of libraries supplied with it.  These are HP-UX specific flags.
10084
10085 @item -milp32
10086 @itemx -mlp64
10087 @opindex milp32
10088 @opindex mlp64
10089 Generate code for a 32-bit or 64-bit environment.
10090 The 32-bit environment sets int, long and pointer to 32 bits.
10091 The 64-bit environment sets int to 32 bits and long and pointer
10092 to 64 bits.  These are HP-UX specific flags.
10093
10094 @item -mno-sched-br-data-spec
10095 @itemx -msched-br-data-spec
10096 @opindex -mno-sched-br-data-spec
10097 @opindex -msched-br-data-spec
10098 (Dis/En)able data speculative scheduling before reload.
10099 This will result in generation of the ld.a instructions and
10100 the corresponding check instructions (ld.c / chk.a).
10101 The default is 'disable'.
10102
10103 @item -msched-ar-data-spec
10104 @itemx -mno-sched-ar-data-spec
10105 @opindex -msched-ar-data-spec
10106 @opindex -mno-sched-ar-data-spec
10107 (En/Dis)able data speculative scheduling after reload.
10108 This will result in generation of the ld.a instructions and
10109 the corresponding check instructions (ld.c / chk.a).
10110 The default is 'enable'.
10111
10112 @item -mno-sched-control-spec
10113 @itemx -msched-control-spec
10114 @opindex -mno-sched-control-spec
10115 @opindex -msched-control-spec
10116 (Dis/En)able control speculative scheduling.  This feature is
10117 available only during region scheduling (i.e. before reload).
10118 This will result in generation of the ld.s instructions and
10119 the corresponding check instructions chk.s .
10120 The default is 'disable'.
10121
10122 @item -msched-br-in-data-spec
10123 @itemx -mno-sched-br-in-data-spec
10124 @opindex -msched-br-in-data-spec
10125 @opindex -mno-sched-br-in-data-spec
10126 (En/Dis)able speculative scheduling of the instructions that
10127 are dependent on the data speculative loads before reload.
10128 This is effective only with @option{-msched-br-data-spec} enabled.
10129 The default is 'enable'.
10130
10131 @item -msched-ar-in-data-spec
10132 @itemx -mno-sched-ar-in-data-spec
10133 @opindex -msched-ar-in-data-spec
10134 @opindex -mno-sched-ar-in-data-spec
10135 (En/Dis)able speculative scheduling of the instructions that
10136 are dependent on the data speculative loads after reload.
10137 This is effective only with @option{-msched-ar-data-spec} enabled.
10138 The default is 'enable'.
10139
10140 @item -msched-in-control-spec
10141 @itemx -mno-sched-in-control-spec
10142 @opindex -msched-in-control-spec
10143 @opindex -mno-sched-in-control-spec
10144 (En/Dis)able speculative scheduling of the instructions that
10145 are dependent on the control speculative loads.
10146 This is effective only with @option{-msched-control-spec} enabled.
10147 The default is 'enable'.
10148
10149 @item -msched-ldc
10150 @itemx -mno-sched-ldc
10151 @opindex -msched-ldc
10152 @opindex -mno-sched-ldc
10153 (En/Dis)able use of simple data speculation checks ld.c .
10154 If disabled, only chk.a instructions will be emitted to check
10155 data speculative loads.
10156 The default is 'enable'.
10157
10158 @item -mno-sched-control-ldc
10159 @itemx -msched-control-ldc
10160 @opindex -mno-sched-control-ldc
10161 @opindex -msched-control-ldc 
10162 (Dis/En)able use of ld.c instructions to check control speculative loads.
10163 If enabled, in case of control speculative load with no speculatively
10164 scheduled dependent instructions this load will be emitted as ld.sa and
10165 ld.c will be used to check it.
10166 The default is 'disable'.
10167
10168 @item -mno-sched-spec-verbose
10169 @itemx -msched-spec-verbose
10170 @opindex -mno-sched-spec-verbose
10171 @opindex -msched-spec-verbose
10172 (Dis/En)able printing of the information about speculative motions.
10173
10174 @item -mno-sched-prefer-non-data-spec-insns
10175 @itemx -msched-prefer-non-data-spec-insns
10176 @opindex -mno-sched-prefer-non-data-spec-insns
10177 @opindex -msched-prefer-non-data-spec-insns
10178 If enabled, data speculative instructions will be chosen for schedule
10179 only if there are no other choices at the moment.  This will make
10180 the use of the data speculation much more conservative.
10181 The default is 'disable'.
10182
10183 @item -mno-sched-prefer-non-control-spec-insns
10184 @itemx -msched-prefer-non-control-spec-insns
10185 @opindex -mno-sched-prefer-non-control-spec-insns
10186 @opindex -msched-prefer-non-control-spec-insns
10187 If enabled, control speculative instructions will be chosen for schedule
10188 only if there are no other choices at the moment.  This will make
10189 the use of the control speculation much more conservative.
10190 The default is 'disable'.
10191
10192 @item -mno-sched-count-spec-in-critical-path
10193 @itemx -msched-count-spec-in-critical-path
10194 @opindex -mno-sched-count-spec-in-critical-path
10195 @opindex -msched-count-spec-in-critical-path
10196 If enabled, speculative dependencies will be considered during
10197 computation of the instructions priorities.  This will make the use of the
10198 speculation a bit more conservative.
10199 The default is 'disable'.
10200
10201 @end table
10202
10203 @node M32C Options
10204 @subsection M32C Options
10205 @cindex M32C options
10206
10207 @table @gcctabopt
10208 @item -mcpu=@var{name}
10209 @opindex mcpu=
10210 Select the CPU for which code is generated.  @var{name} may be one of
10211 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10212 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10213 the M32C/80 series.
10214
10215 @item -msim
10216 @opindex msim
10217 Specifies that the program will be run on the simulator.  This causes
10218 an alternate runtime library to be linked in which supports, for
10219 example, file I/O.  You must not use this option when generating
10220 programs that will run on real hardware; you must provide your own
10221 runtime library for whatever I/O functions are needed.
10222
10223 @item -memregs=@var{number}
10224 @opindex memregs=
10225 Specifies the number of memory-based pseudo-registers GCC will use
10226 during code generation.  These pseudo-registers will be used like real
10227 registers, so there is a tradeoff between GCC's ability to fit the
10228 code into available registers, and the performance penalty of using
10229 memory instead of registers.  Note that all modules in a program must
10230 be compiled with the same value for this option.  Because of that, you
10231 must not use this option with the default runtime libraries gcc
10232 builds.
10233
10234 @end table
10235
10236 @node M32R/D Options
10237 @subsection M32R/D Options
10238 @cindex M32R/D options
10239
10240 These @option{-m} options are defined for Renesas M32R/D architectures:
10241
10242 @table @gcctabopt
10243 @item -m32r2
10244 @opindex m32r2
10245 Generate code for the M32R/2@.
10246
10247 @item -m32rx
10248 @opindex m32rx
10249 Generate code for the M32R/X@.
10250
10251 @item -m32r
10252 @opindex m32r
10253 Generate code for the M32R@.  This is the default.
10254
10255 @item -mmodel=small
10256 @opindex mmodel=small
10257 Assume all objects live in the lower 16MB of memory (so that their addresses
10258 can be loaded with the @code{ld24} instruction), and assume all subroutines
10259 are reachable with the @code{bl} instruction.
10260 This is the default.
10261
10262 The addressability of a particular object can be set with the
10263 @code{model} attribute.
10264
10265 @item -mmodel=medium
10266 @opindex mmodel=medium
10267 Assume objects may be anywhere in the 32-bit address space (the compiler
10268 will generate @code{seth/add3} instructions to load their addresses), and
10269 assume all subroutines are reachable with the @code{bl} instruction.
10270
10271 @item -mmodel=large
10272 @opindex mmodel=large
10273 Assume objects may be anywhere in the 32-bit address space (the compiler
10274 will generate @code{seth/add3} instructions to load their addresses), and
10275 assume subroutines may not be reachable with the @code{bl} instruction
10276 (the compiler will generate the much slower @code{seth/add3/jl}
10277 instruction sequence).
10278
10279 @item -msdata=none
10280 @opindex msdata=none
10281 Disable use of the small data area.  Variables will be put into
10282 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10283 @code{section} attribute has been specified).
10284 This is the default.
10285
10286 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10287 Objects may be explicitly put in the small data area with the
10288 @code{section} attribute using one of these sections.
10289
10290 @item -msdata=sdata
10291 @opindex msdata=sdata
10292 Put small global and static data in the small data area, but do not
10293 generate special code to reference them.
10294
10295 @item -msdata=use
10296 @opindex msdata=use
10297 Put small global and static data in the small data area, and generate
10298 special instructions to reference them.
10299
10300 @item -G @var{num}
10301 @opindex G
10302 @cindex smaller data references
10303 Put global and static objects less than or equal to @var{num} bytes
10304 into the small data or bss sections instead of the normal data or bss
10305 sections.  The default value of @var{num} is 8.
10306 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10307 for this option to have any effect.
10308
10309 All modules should be compiled with the same @option{-G @var{num}} value.
10310 Compiling with different values of @var{num} may or may not work; if it
10311 doesn't the linker will give an error message---incorrect code will not be
10312 generated.
10313
10314 @item -mdebug
10315 @opindex mdebug
10316 Makes the M32R specific code in the compiler display some statistics
10317 that might help in debugging programs.
10318
10319 @item -malign-loops
10320 @opindex malign-loops
10321 Align all loops to a 32-byte boundary.
10322
10323 @item -mno-align-loops
10324 @opindex mno-align-loops
10325 Do not enforce a 32-byte alignment for loops.  This is the default.
10326
10327 @item -missue-rate=@var{number}
10328 @opindex missue-rate=@var{number}
10329 Issue @var{number} instructions per cycle.  @var{number} can only be 1
10330 or 2.
10331
10332 @item -mbranch-cost=@var{number}
10333 @opindex mbranch-cost=@var{number}
10334 @var{number} can only be 1 or 2.  If it is 1 then branches will be
10335 preferred over conditional code, if it is 2, then the opposite will
10336 apply.
10337
10338 @item -mflush-trap=@var{number}
10339 @opindex mflush-trap=@var{number}
10340 Specifies the trap number to use to flush the cache.  The default is
10341 12.  Valid numbers are between 0 and 15 inclusive.
10342
10343 @item -mno-flush-trap
10344 @opindex mno-flush-trap
10345 Specifies that the cache cannot be flushed by using a trap.
10346
10347 @item -mflush-func=@var{name}
10348 @opindex mflush-func=@var{name}
10349 Specifies the name of the operating system function to call to flush
10350 the cache.  The default is @emph{_flush_cache}, but a function call
10351 will only be used if a trap is not available.
10352
10353 @item -mno-flush-func
10354 @opindex mno-flush-func
10355 Indicates that there is no OS function for flushing the cache.
10356
10357 @end table
10358
10359 @node M680x0 Options
10360 @subsection M680x0 Options
10361 @cindex M680x0 options
10362
10363 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
10364 The default settings depend on which architecture was selected when
10365 the compiler was configured; the defaults for the most common choices
10366 are given below.
10367
10368 @table @gcctabopt
10369 @item -march=@var{arch}
10370 @opindex march
10371 Generate code for a specific M680x0 or ColdFire instruction set
10372 architecture.  Permissible values of @var{arch} for M680x0
10373 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
10374 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
10375 architectures are selected according to Freescale's ISA classification
10376 and the permissible values are: @samp{isaa}, @samp{isaaplus},
10377 @samp{isab} and @samp{isac}.
10378
10379 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
10380 code for a ColdFire target.  The @var{arch} in this macro is one of the
10381 @option{-march} arguments given above.
10382
10383 When used together, @option{-march} and @option{-mtune} select code
10384 that runs on a family of similar processors but that is optimized
10385 for a particular microarchitecture.
10386
10387 @item -mcpu=@var{cpu}
10388 @opindex mcpu
10389 Generate code for a specific M680x0 or ColdFire processor.
10390 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
10391 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
10392 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
10393 below, which also classifies the CPUs into families:
10394
10395 @multitable @columnfractions 0.20 0.80
10396 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
10397 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
10398 @item @samp{5206e} @tab @samp{5206e}
10399 @item @samp{5208} @tab @samp{5207} @samp{5208}
10400 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
10401 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
10402 @item @samp{5216} @tab @samp{5214} @samp{5216}
10403 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
10404 @item @samp{5225} @tab @samp{5224} @samp{5225}
10405 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
10406 @item @samp{5249} @tab @samp{5249}
10407 @item @samp{5250} @tab @samp{5250}
10408 @item @samp{5271} @tab @samp{5270} @samp{5271}
10409 @item @samp{5272} @tab @samp{5272}
10410 @item @samp{5275} @tab @samp{5274} @samp{5275}
10411 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
10412 @item @samp{5307} @tab @samp{5307}
10413 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
10414 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
10415 @item @samp{5407} @tab @samp{5407}
10416 @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}
10417 @end multitable
10418
10419 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
10420 @var{arch} is compatible with @var{cpu}.  Other combinations of
10421 @option{-mcpu} and @option{-march} are rejected.
10422
10423 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
10424 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
10425 where the value of @var{family} is given by the table above.
10426
10427 @item -mtune=@var{tune}
10428 @opindex mtune
10429 Tune the code for a particular microarchitecture, within the
10430 constraints set by @option{-march} and @option{-mcpu}.
10431 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
10432 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
10433 and @samp{cpu32}.  The ColdFire microarchitectures
10434 are: @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
10435
10436 You can also use @option{-mtune=68020-40} for code that needs
10437 to run relatively well on 68020, 68030 and 68040 targets.
10438 @option{-mtune=68020-60} is similar but includes 68060 targets
10439 as well.  These two options select the same tuning decisions as
10440 @option{-m68020-40} and @option{-m68020-60} respectively.
10441
10442 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
10443 when tuning for 680x0 architecture @var{arch}.  It also defines
10444 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
10445 option is used.  If gcc is tuning for a range of architectures,
10446 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
10447 it defines the macros for every architecture in the range.
10448
10449 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
10450 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
10451 of the arguments given above.
10452
10453 @item -m68000
10454 @itemx -mc68000
10455 @opindex m68000
10456 @opindex mc68000
10457 Generate output for a 68000.  This is the default
10458 when the compiler is configured for 68000-based systems.
10459 It is equivalent to @option{-march=68000}.
10460
10461 Use this option for microcontrollers with a 68000 or EC000 core,
10462 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10463
10464 @item -m68010
10465 @opindex m68010
10466 Generate output for a 68010.  This is the default
10467 when the compiler is configured for 68010-based systems.
10468 It is equivalent to @option{-march=68010}.
10469
10470 @item -m68020
10471 @itemx -mc68020
10472 @opindex m68020
10473 @opindex mc68020
10474 Generate output for a 68020.  This is the default
10475 when the compiler is configured for 68020-based systems.
10476 It is equivalent to @option{-march=68020}.
10477
10478 @item -m68030
10479 @opindex m68030
10480 Generate output for a 68030.  This is the default when the compiler is
10481 configured for 68030-based systems.  It is equivalent to
10482 @option{-march=68030}.
10483
10484 @item -m68040
10485 @opindex m68040
10486 Generate output for a 68040.  This is the default when the compiler is
10487 configured for 68040-based systems.  It is equivalent to
10488 @option{-march=68040}.
10489
10490 This option inhibits the use of 68881/68882 instructions that have to be
10491 emulated by software on the 68040.  Use this option if your 68040 does not
10492 have code to emulate those instructions.
10493
10494 @item -m68060
10495 @opindex m68060
10496 Generate output for a 68060.  This is the default when the compiler is
10497 configured for 68060-based systems.  It is equivalent to
10498 @option{-march=68060}.
10499
10500 This option inhibits the use of 68020 and 68881/68882 instructions that
10501 have to be emulated by software on the 68060.  Use this option if your 68060
10502 does not have code to emulate those instructions.
10503
10504 @item -mcpu32
10505 @opindex mcpu32
10506 Generate output for a CPU32.  This is the default
10507 when the compiler is configured for CPU32-based systems.
10508 It is equivalent to @option{-march=cpu32}.
10509
10510 Use this option for microcontrollers with a
10511 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
10512 68336, 68340, 68341, 68349 and 68360.
10513
10514 @item -m5200
10515 @opindex m5200
10516 Generate output for a 520X ColdFire CPU.  This is the default
10517 when the compiler is configured for 520X-based systems.
10518 It is equivalent to @option{-mcpu=5206}, and is now deprecated
10519 in favor of that option.
10520
10521 Use this option for microcontroller with a 5200 core, including
10522 the MCF5202, MCF5203, MCF5204 and MCF5206.
10523
10524 @item -m5206e
10525 @opindex m5206e
10526 Generate output for a 5206e ColdFire CPU.  The option is now
10527 deprecated in favor of the equivalent @option{-mcpu=5206e}.
10528
10529 @item -m528x
10530 @opindex m528x
10531 Generate output for a member of the ColdFire 528X family.
10532 The option is now deprecated in favor of the equivalent
10533 @option{-mcpu=528x}.
10534
10535 @item -m5307
10536 @opindex m5307
10537 Generate output for a ColdFire 5307 CPU.  The option is now deprecated
10538 in favor of the equivalent @option{-mcpu=5307}.
10539
10540 @item -m5407
10541 @opindex m5407
10542 Generate output for a ColdFire 5407 CPU.  The option is now deprecated
10543 in favor of the equivalent @option{-mcpu=5407}.
10544
10545 @item -mcfv4e
10546 @opindex mcfv4e
10547 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
10548 This includes use of hardware floating point instructions.
10549 The option is equivalent to @option{-mcpu=547x}, and is now
10550 deprecated in favor of that option.
10551
10552 @item -m68020-40
10553 @opindex m68020-40
10554 Generate output for a 68040, without using any of the new instructions.
10555 This results in code which can run relatively efficiently on either a
10556 68020/68881 or a 68030 or a 68040.  The generated code does use the
10557 68881 instructions that are emulated on the 68040.
10558
10559 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
10560
10561 @item -m68020-60
10562 @opindex m68020-60
10563 Generate output for a 68060, without using any of the new instructions.
10564 This results in code which can run relatively efficiently on either a
10565 68020/68881 or a 68030 or a 68040.  The generated code does use the
10566 68881 instructions that are emulated on the 68060.
10567
10568 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
10569
10570 @item -mhard-float
10571 @itemx -m68881
10572 @opindex mhard-float
10573 @opindex m68881
10574 Generate floating-point instructions.  This is the default for 68020
10575 and above, and for ColdFire devices that have an FPU.  It defines the
10576 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
10577 on ColdFire targets.
10578
10579 @item -msoft-float
10580 @opindex msoft-float
10581 Do not generate floating-point instructions; use library calls instead.
10582 This is the default for 68000, 68010, and 68832 targets.  It is also
10583 the default for ColdFire devices that have no FPU.
10584
10585 @item -mdiv
10586 @itemx -mno-div
10587 @opindex mdiv
10588 @opindex mno-div
10589 Generate (do not generate) ColdFire hardware divide and remainder
10590 instructions.  If @option{-march} is used without @option{-mcpu},
10591 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
10592 architectures.  Otherwise, the default is taken from the target CPU
10593 (either the default CPU, or the one specified by @option{-mcpu}).  For
10594 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
10595 @option{-mcpu=5206e}.
10596
10597 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
10598
10599 @item -mshort
10600 @opindex mshort
10601 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10602 Additionally, parameters passed on the stack are also aligned to a
10603 16-bit boundary even on targets whose API mandates promotion to 32-bit.
10604
10605 @item -mno-short
10606 @opindex -mno-short
10607 Do not consider type @code{int} to be 16 bits wide.  This is the default.
10608
10609 @item -mnobitfield
10610 @itemx -mno-bitfield
10611 @opindex mnobitfield
10612 @opindex mno-bitfield
10613 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
10614 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10615
10616 @item -mbitfield
10617 @opindex mbitfield
10618 Do use the bit-field instructions.  The @option{-m68020} option implies
10619 @option{-mbitfield}.  This is the default if you use a configuration
10620 designed for a 68020.
10621
10622 @item -mrtd
10623 @opindex mrtd
10624 Use a different function-calling convention, in which functions
10625 that take a fixed number of arguments return with the @code{rtd}
10626 instruction, which pops their arguments while returning.  This
10627 saves one instruction in the caller since there is no need to pop
10628 the arguments there.
10629
10630 This calling convention is incompatible with the one normally
10631 used on Unix, so you cannot use it if you need to call libraries
10632 compiled with the Unix compiler.
10633
10634 Also, you must provide function prototypes for all functions that
10635 take variable numbers of arguments (including @code{printf});
10636 otherwise incorrect code will be generated for calls to those
10637 functions.
10638
10639 In addition, seriously incorrect code will result if you call a
10640 function with too many arguments.  (Normally, extra arguments are
10641 harmlessly ignored.)
10642
10643 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10644 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10645
10646 @item -mno-rtd
10647 @opindex mno-rtd
10648 Do not use the calling conventions selected by @option{-mrtd}.
10649 This is the default.
10650
10651 @item -malign-int
10652 @itemx -mno-align-int
10653 @opindex malign-int
10654 @opindex mno-align-int
10655 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10656 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10657 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10658 Aligning variables on 32-bit boundaries produces code that runs somewhat
10659 faster on processors with 32-bit busses at the expense of more memory.
10660
10661 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10662 align structures containing the above types  differently than
10663 most published application binary interface specifications for the m68k.
10664
10665 @item -mpcrel
10666 @opindex mpcrel
10667 Use the pc-relative addressing mode of the 68000 directly, instead of
10668 using a global offset table.  At present, this option implies @option{-fpic},
10669 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10670 not presently supported with @option{-mpcrel}, though this could be supported for
10671 68020 and higher processors.
10672
10673 @item -mno-strict-align
10674 @itemx -mstrict-align
10675 @opindex mno-strict-align
10676 @opindex mstrict-align
10677 Do not (do) assume that unaligned memory references will be handled by
10678 the system.
10679
10680 @item -msep-data
10681 Generate code that allows the data segment to be located in a different
10682 area of memory from the text segment.  This allows for execute in place in
10683 an environment without virtual memory management.  This option implies
10684 @option{-fPIC}.
10685
10686 @item -mno-sep-data
10687 Generate code that assumes that the data segment follows the text segment.
10688 This is the default.
10689
10690 @item -mid-shared-library
10691 Generate code that supports shared libraries via the library ID method.
10692 This allows for execute in place and shared libraries in an environment
10693 without virtual memory management.  This option implies @option{-fPIC}.
10694
10695 @item -mno-id-shared-library
10696 Generate code that doesn't assume ID based shared libraries are being used.
10697 This is the default.
10698
10699 @item -mshared-library-id=n
10700 Specified the identification number of the ID based shared library being
10701 compiled.  Specifying a value of 0 will generate more compact code, specifying
10702 other values will force the allocation of that number to the current
10703 library but is no more space or time efficient than omitting this option.
10704
10705 @end table
10706
10707 @node M68hc1x Options
10708 @subsection M68hc1x Options
10709 @cindex M68hc1x options
10710
10711 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10712 microcontrollers.  The default values for these options depends on
10713 which style of microcontroller was selected when the compiler was configured;
10714 the defaults for the most common choices are given below.
10715
10716 @table @gcctabopt
10717 @item -m6811
10718 @itemx -m68hc11
10719 @opindex m6811
10720 @opindex m68hc11
10721 Generate output for a 68HC11.  This is the default
10722 when the compiler is configured for 68HC11-based systems.
10723
10724 @item -m6812
10725 @itemx -m68hc12
10726 @opindex m6812
10727 @opindex m68hc12
10728 Generate output for a 68HC12.  This is the default
10729 when the compiler is configured for 68HC12-based systems.
10730
10731 @item -m68S12
10732 @itemx -m68hcs12
10733 @opindex m68S12
10734 @opindex m68hcs12
10735 Generate output for a 68HCS12.
10736
10737 @item -mauto-incdec
10738 @opindex mauto-incdec
10739 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10740 addressing modes.
10741
10742 @item -minmax
10743 @itemx -nominmax
10744 @opindex minmax
10745 @opindex mnominmax
10746 Enable the use of 68HC12 min and max instructions.
10747
10748 @item -mlong-calls
10749 @itemx -mno-long-calls
10750 @opindex mlong-calls
10751 @opindex mno-long-calls
10752 Treat all calls as being far away (near).  If calls are assumed to be
10753 far away, the compiler will use the @code{call} instruction to
10754 call a function and the @code{rtc} instruction for returning.
10755
10756 @item -mshort
10757 @opindex mshort
10758 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10759
10760 @item -msoft-reg-count=@var{count}
10761 @opindex msoft-reg-count
10762 Specify the number of pseudo-soft registers which are used for the
10763 code generation.  The maximum number is 32.  Using more pseudo-soft
10764 register may or may not result in better code depending on the program.
10765 The default is 4 for 68HC11 and 2 for 68HC12.
10766
10767 @end table
10768
10769 @node MCore Options
10770 @subsection MCore Options
10771 @cindex MCore options
10772
10773 These are the @samp{-m} options defined for the Motorola M*Core
10774 processors.
10775
10776 @table @gcctabopt
10777
10778 @item -mhardlit
10779 @itemx -mno-hardlit
10780 @opindex mhardlit
10781 @opindex mno-hardlit
10782 Inline constants into the code stream if it can be done in two
10783 instructions or less.
10784
10785 @item -mdiv
10786 @itemx -mno-div
10787 @opindex mdiv
10788 @opindex mno-div
10789 Use the divide instruction.  (Enabled by default).
10790
10791 @item -mrelax-immediate
10792 @itemx -mno-relax-immediate
10793 @opindex mrelax-immediate
10794 @opindex mno-relax-immediate
10795 Allow arbitrary sized immediates in bit operations.
10796
10797 @item -mwide-bitfields
10798 @itemx -mno-wide-bitfields
10799 @opindex mwide-bitfields
10800 @opindex mno-wide-bitfields
10801 Always treat bit-fields as int-sized.
10802
10803 @item -m4byte-functions
10804 @itemx -mno-4byte-functions
10805 @opindex m4byte-functions
10806 @opindex mno-4byte-functions
10807 Force all functions to be aligned to a four byte boundary.
10808
10809 @item -mcallgraph-data
10810 @itemx -mno-callgraph-data
10811 @opindex mcallgraph-data
10812 @opindex mno-callgraph-data
10813 Emit callgraph information.
10814
10815 @item -mslow-bytes
10816 @itemx -mno-slow-bytes
10817 @opindex mslow-bytes
10818 @opindex mno-slow-bytes
10819 Prefer word access when reading byte quantities.
10820
10821 @item -mlittle-endian
10822 @itemx -mbig-endian
10823 @opindex mlittle-endian
10824 @opindex mbig-endian
10825 Generate code for a little endian target.
10826
10827 @item -m210
10828 @itemx -m340
10829 @opindex m210
10830 @opindex m340
10831 Generate code for the 210 processor.
10832 @end table
10833
10834 @node MIPS Options
10835 @subsection MIPS Options
10836 @cindex MIPS options
10837
10838 @table @gcctabopt
10839
10840 @item -EB
10841 @opindex EB
10842 Generate big-endian code.
10843
10844 @item -EL
10845 @opindex EL
10846 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10847 configurations.
10848
10849 @item -march=@var{arch}
10850 @opindex march
10851 Generate code that will run on @var{arch}, which can be the name of a
10852 generic MIPS ISA, or the name of a particular processor.
10853 The ISA names are:
10854 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10855 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10856 The processor names are:
10857 @samp{4kc}, @samp{4km}, @samp{4kp},
10858 @samp{4kec}, @samp{4kem}, @samp{4kep},
10859 @samp{5kc}, @samp{5kf},
10860 @samp{20kc},
10861 @samp{24kc}, @samp{24kf}, @samp{24kx},
10862 @samp{24kec}, @samp{24kef}, @samp{24kex},
10863 @samp{34kc}, @samp{34kf}, @samp{34kx},
10864 @samp{m4k},
10865 @samp{orion},
10866 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10867 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10868 @samp{rm7000}, @samp{rm9000},
10869 @samp{sb1},
10870 @samp{sr71000},
10871 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10872 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10873 The special value @samp{from-abi} selects the
10874 most compatible architecture for the selected ABI (that is,
10875 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10876
10877 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10878 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10879 @samp{vr} may be written @samp{r}.
10880
10881 GCC defines two macros based on the value of this option.  The first
10882 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10883 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10884 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10885 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10886 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10887
10888 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10889 above.  In other words, it will have the full prefix and will not
10890 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10891 the macro names the resolved architecture (either @samp{"mips1"} or
10892 @samp{"mips3"}).  It names the default architecture when no
10893 @option{-march} option is given.
10894
10895 @item -mtune=@var{arch}
10896 @opindex mtune
10897 Optimize for @var{arch}.  Among other things, this option controls
10898 the way instructions are scheduled, and the perceived cost of arithmetic
10899 operations.  The list of @var{arch} values is the same as for
10900 @option{-march}.
10901
10902 When this option is not used, GCC will optimize for the processor
10903 specified by @option{-march}.  By using @option{-march} and
10904 @option{-mtune} together, it is possible to generate code that will
10905 run on a family of processors, but optimize the code for one
10906 particular member of that family.
10907
10908 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10909 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10910 @samp{-march} ones described above.
10911
10912 @item -mips1
10913 @opindex mips1
10914 Equivalent to @samp{-march=mips1}.
10915
10916 @item -mips2
10917 @opindex mips2
10918 Equivalent to @samp{-march=mips2}.
10919
10920 @item -mips3
10921 @opindex mips3
10922 Equivalent to @samp{-march=mips3}.
10923
10924 @item -mips4
10925 @opindex mips4
10926 Equivalent to @samp{-march=mips4}.
10927
10928 @item -mips32
10929 @opindex mips32
10930 Equivalent to @samp{-march=mips32}.
10931
10932 @item -mips32r2
10933 @opindex mips32r2
10934 Equivalent to @samp{-march=mips32r2}.
10935
10936 @item -mips64
10937 @opindex mips64
10938 Equivalent to @samp{-march=mips64}.
10939
10940 @item -mips16
10941 @itemx -mno-mips16
10942 @opindex mips16
10943 @opindex mno-mips16
10944 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10945 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10946
10947 @item -mabi=32
10948 @itemx -mabi=o64
10949 @itemx -mabi=n32
10950 @itemx -mabi=64
10951 @itemx -mabi=eabi
10952 @opindex mabi=32
10953 @opindex mabi=o64
10954 @opindex mabi=n32
10955 @opindex mabi=64
10956 @opindex mabi=eabi
10957 Generate code for the given ABI@.
10958
10959 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10960 generates 64-bit code when you select a 64-bit architecture, but you
10961 can use @option{-mgp32} to get 32-bit code instead.
10962
10963 For information about the O64 ABI, see
10964 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10965
10966 GCC supports a variant of the o32 ABI in which floating-point registers
10967 are 64 rather than 32 bits wide.  You can select this combination with
10968 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
10969 and @samp{mfhc1} instructions and is therefore only supported for
10970 MIPS32R2 processors.
10971
10972 The register assignments for arguments and return values remain the
10973 same, but each scalar value is passed in a single 64-bit register
10974 rather than a pair of 32-bit registers.  For example, scalar
10975 floating-point values are returned in @samp{$f0} only, not a
10976 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
10977 remains the same, but all 64 bits are saved.
10978
10979 @item -mabicalls
10980 @itemx -mno-abicalls
10981 @opindex mabicalls
10982 @opindex mno-abicalls
10983 Generate (do not generate) code that is suitable for SVR4-style
10984 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
10985 systems.
10986
10987 @item -mshared
10988 @itemx -mno-shared
10989 Generate (do not generate) code that is fully position-independent,
10990 and that can therefore be linked into shared libraries.  This option
10991 only affects @option{-mabicalls}.
10992
10993 All @option{-mabicalls} code has traditionally been position-independent,
10994 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
10995 as an extension, the GNU toolchain allows executables to use absolute
10996 accesses for locally-binding symbols.  It can also use shorter GP
10997 initialization sequences and generate direct calls to locally-defined
10998 functions.  This mode is selected by @option{-mno-shared}.
10999
11000 @option{-mno-shared} depends on binutils 2.16 or higher and generates
11001 objects that can only be linked by the GNU linker.  However, the option
11002 does not affect the ABI of the final executable; it only affects the ABI
11003 of relocatable objects.  Using @option{-mno-shared} will generally make
11004 executables both smaller and quicker.
11005
11006 @option{-mshared} is the default.
11007
11008 @item -mxgot
11009 @itemx -mno-xgot
11010 @opindex mxgot
11011 @opindex mno-xgot
11012 Lift (do not lift) the usual restrictions on the size of the global
11013 offset table.
11014
11015 GCC normally uses a single instruction to load values from the GOT@.
11016 While this is relatively efficient, it will only work if the GOT
11017 is smaller than about 64k.  Anything larger will cause the linker
11018 to report an error such as:
11019
11020 @cindex relocation truncated to fit (MIPS)
11021 @smallexample
11022 relocation truncated to fit: R_MIPS_GOT16 foobar
11023 @end smallexample
11024
11025 If this happens, you should recompile your code with @option{-mxgot}.
11026 It should then work with very large GOTs, although it will also be
11027 less efficient, since it will take three instructions to fetch the
11028 value of a global symbol.
11029
11030 Note that some linkers can create multiple GOTs.  If you have such a
11031 linker, you should only need to use @option{-mxgot} when a single object
11032 file accesses more than 64k's worth of GOT entries.  Very few do.
11033
11034 These options have no effect unless GCC is generating position
11035 independent code.
11036
11037 @item -mgp32
11038 @opindex mgp32
11039 Assume that general-purpose registers are 32 bits wide.
11040
11041 @item -mgp64
11042 @opindex mgp64
11043 Assume that general-purpose registers are 64 bits wide.
11044
11045 @item -mfp32
11046 @opindex mfp32
11047 Assume that floating-point registers are 32 bits wide.
11048
11049 @item -mfp64
11050 @opindex mfp64
11051 Assume that floating-point registers are 64 bits wide.
11052
11053 @item -mhard-float
11054 @opindex mhard-float
11055 Use floating-point coprocessor instructions.
11056
11057 @item -msoft-float
11058 @opindex msoft-float
11059 Do not use floating-point coprocessor instructions.  Implement
11060 floating-point calculations using library calls instead.
11061
11062 @item -msingle-float
11063 @opindex msingle-float
11064 Assume that the floating-point coprocessor only supports single-precision
11065 operations.
11066
11067 @itemx -mdouble-float
11068 @opindex mdouble-float
11069 Assume that the floating-point coprocessor supports double-precision
11070 operations.  This is the default.
11071
11072 @itemx -mdsp
11073 @itemx -mno-dsp
11074 @opindex mdsp
11075 @opindex mno-dsp
11076 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
11077
11078 @itemx -mpaired-single
11079 @itemx -mno-paired-single
11080 @opindex mpaired-single
11081 @opindex mno-paired-single
11082 Use (do not use) paired-single floating-point instructions.
11083 @xref{MIPS Paired-Single Support}.  This option can only be used
11084 when generating 64-bit code and requires hardware floating-point
11085 support to be enabled.
11086
11087 @itemx -mips3d
11088 @itemx -mno-mips3d
11089 @opindex mips3d
11090 @opindex mno-mips3d
11091 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
11092 The option @option{-mips3d} implies @option{-mpaired-single}.
11093
11094 @item -mlong64
11095 @opindex mlong64
11096 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
11097 an explanation of the default and the way that the pointer size is
11098 determined.
11099
11100 @item -mlong32
11101 @opindex mlong32
11102 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
11103
11104 The default size of @code{int}s, @code{long}s and pointers depends on
11105 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
11106 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
11107 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
11108 or the same size as integer registers, whichever is smaller.
11109
11110 @item -msym32
11111 @itemx -mno-sym32
11112 @opindex msym32
11113 @opindex mno-sym32
11114 Assume (do not assume) that all symbols have 32-bit values, regardless
11115 of the selected ABI@.  This option is useful in combination with
11116 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
11117 to generate shorter and faster references to symbolic addresses.
11118
11119 @item -G @var{num}
11120 @opindex G
11121 @cindex smaller data references (MIPS)
11122 @cindex gp-relative references (MIPS)
11123 Put global and static items less than or equal to @var{num} bytes into
11124 the small data or bss section instead of the normal data or bss section.
11125 This allows the data to be accessed using a single instruction.
11126
11127 All modules should be compiled with the same @option{-G @var{num}}
11128 value.
11129
11130 @item -membedded-data
11131 @itemx -mno-embedded-data
11132 @opindex membedded-data
11133 @opindex mno-embedded-data
11134 Allocate variables to the read-only data section first if possible, then
11135 next in the small data section if possible, otherwise in data.  This gives
11136 slightly slower code than the default, but reduces the amount of RAM required
11137 when executing, and thus may be preferred for some embedded systems.
11138
11139 @item -muninit-const-in-rodata
11140 @itemx -mno-uninit-const-in-rodata
11141 @opindex muninit-const-in-rodata
11142 @opindex mno-uninit-const-in-rodata
11143 Put uninitialized @code{const} variables in the read-only data section.
11144 This option is only meaningful in conjunction with @option{-membedded-data}.
11145
11146 @item -msplit-addresses
11147 @itemx -mno-split-addresses
11148 @opindex msplit-addresses
11149 @opindex mno-split-addresses
11150 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
11151 relocation operators.  This option has been superseded by
11152 @option{-mexplicit-relocs} but is retained for backwards compatibility.
11153
11154 @item -mexplicit-relocs
11155 @itemx -mno-explicit-relocs
11156 @opindex mexplicit-relocs
11157 @opindex mno-explicit-relocs
11158 Use (do not use) assembler relocation operators when dealing with symbolic
11159 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
11160 is to use assembler macros instead.
11161
11162 @option{-mexplicit-relocs} is the default if GCC was configured
11163 to use an assembler that supports relocation operators.
11164
11165 @item -mcheck-zero-division
11166 @itemx -mno-check-zero-division
11167 @opindex mcheck-zero-division
11168 @opindex mno-check-zero-division
11169 Trap (do not trap) on integer division by zero.
11170
11171 The default is @option{-mcheck-zero-division}.
11172
11173 @item -mdivide-traps
11174 @itemx -mdivide-breaks
11175 @opindex mdivide-traps
11176 @opindex mdivide-breaks
11177 MIPS systems check for division by zero by generating either a
11178 conditional trap or a break instruction.  Using traps results in
11179 smaller code, but is only supported on MIPS II and later.  Also, some
11180 versions of the Linux kernel have a bug that prevents trap from
11181 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
11182 allow conditional traps on architectures that support them and
11183 @option{-mdivide-breaks} to force the use of breaks.
11184
11185 The default is usually @option{-mdivide-traps}, but this can be
11186 overridden at configure time using @option{--with-divide=breaks}.
11187 Divide-by-zero checks can be completely disabled using
11188 @option{-mno-check-zero-division}.
11189
11190 @item -mmemcpy
11191 @itemx -mno-memcpy
11192 @opindex mmemcpy
11193 @opindex mno-memcpy
11194 Force (do not force) the use of @code{memcpy()} for non-trivial block
11195 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
11196 most constant-sized copies.
11197
11198 @item -mlong-calls
11199 @itemx -mno-long-calls
11200 @opindex mlong-calls
11201 @opindex mno-long-calls
11202 Disable (do not disable) use of the @code{jal} instruction.  Calling
11203 functions using @code{jal} is more efficient but requires the caller
11204 and callee to be in the same 256 megabyte segment.
11205
11206 This option has no effect on abicalls code.  The default is
11207 @option{-mno-long-calls}.
11208
11209 @item -mmad
11210 @itemx -mno-mad
11211 @opindex mmad
11212 @opindex mno-mad
11213 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
11214 instructions, as provided by the R4650 ISA@.
11215
11216 @item -mfused-madd
11217 @itemx -mno-fused-madd
11218 @opindex mfused-madd
11219 @opindex mno-fused-madd
11220 Enable (disable) use of the floating point multiply-accumulate
11221 instructions, when they are available.  The default is
11222 @option{-mfused-madd}.
11223
11224 When multiply-accumulate instructions are used, the intermediate
11225 product is calculated to infinite precision and is not subject to
11226 the FCSR Flush to Zero bit.  This may be undesirable in some
11227 circumstances.
11228
11229 @item -nocpp
11230 @opindex nocpp
11231 Tell the MIPS assembler to not run its preprocessor over user
11232 assembler files (with a @samp{.s} suffix) when assembling them.
11233
11234 @item -mfix-r4000
11235 @itemx -mno-fix-r4000
11236 @opindex mfix-r4000
11237 @opindex mno-fix-r4000
11238 Work around certain R4000 CPU errata:
11239 @itemize @minus
11240 @item
11241 A double-word or a variable shift may give an incorrect result if executed
11242 immediately after starting an integer division.
11243 @item
11244 A double-word or a variable shift may give an incorrect result if executed
11245 while an integer multiplication is in progress.
11246 @item
11247 An integer division may give an incorrect result if started in a delay slot
11248 of a taken branch or a jump.
11249 @end itemize
11250
11251 @item -mfix-r4400
11252 @itemx -mno-fix-r4400
11253 @opindex mfix-r4400
11254 @opindex mno-fix-r4400
11255 Work around certain R4400 CPU errata:
11256 @itemize @minus
11257 @item
11258 A double-word or a variable shift may give an incorrect result if executed
11259 immediately after starting an integer division.
11260 @end itemize
11261
11262 @item -mfix-vr4120
11263 @itemx -mno-fix-vr4120
11264 @opindex mfix-vr4120
11265 Work around certain VR4120 errata:
11266 @itemize @minus
11267 @item
11268 @code{dmultu} does not always produce the correct result.
11269 @item
11270 @code{div} and @code{ddiv} do not always produce the correct result if one
11271 of the operands is negative.
11272 @end itemize
11273 The workarounds for the division errata rely on special functions in
11274 @file{libgcc.a}.  At present, these functions are only provided by
11275 the @code{mips64vr*-elf} configurations.
11276
11277 Other VR4120 errata require a nop to be inserted between certain pairs of
11278 instructions.  These errata are handled by the assembler, not by GCC itself.
11279
11280 @item -mfix-vr4130
11281 @opindex mfix-vr4130
11282 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
11283 workarounds are implemented by the assembler rather than by GCC,
11284 although GCC will avoid using @code{mflo} and @code{mfhi} if the
11285 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
11286 instructions are available instead.
11287
11288 @item -mfix-sb1
11289 @itemx -mno-fix-sb1
11290 @opindex mfix-sb1
11291 Work around certain SB-1 CPU core errata.
11292 (This flag currently works around the SB-1 revision 2
11293 ``F1'' and ``F2'' floating point errata.)
11294
11295 @item -mflush-func=@var{func}
11296 @itemx -mno-flush-func
11297 @opindex mflush-func
11298 Specifies the function to call to flush the I and D caches, or to not
11299 call any such function.  If called, the function must take the same
11300 arguments as the common @code{_flush_func()}, that is, the address of the
11301 memory range for which the cache is being flushed, the size of the
11302 memory range, and the number 3 (to flush both caches).  The default
11303 depends on the target GCC was configured for, but commonly is either
11304 @samp{_flush_func} or @samp{__cpu_flush}.
11305
11306 @item -mbranch-likely
11307 @itemx -mno-branch-likely
11308 @opindex mbranch-likely
11309 @opindex mno-branch-likely
11310 Enable or disable use of Branch Likely instructions, regardless of the
11311 default for the selected architecture.  By default, Branch Likely
11312 instructions may be generated if they are supported by the selected
11313 architecture.  An exception is for the MIPS32 and MIPS64 architectures
11314 and processors which implement those architectures; for those, Branch
11315 Likely instructions will not be generated by default because the MIPS32
11316 and MIPS64 architectures specifically deprecate their use.
11317
11318 @item -mfp-exceptions
11319 @itemx -mno-fp-exceptions
11320 @opindex mfp-exceptions
11321 Specifies whether FP exceptions are enabled.  This affects how we schedule
11322 FP instructions for some processors.  The default is that FP exceptions are
11323 enabled.
11324
11325 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
11326 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
11327 FP pipe.
11328
11329 @item -mvr4130-align
11330 @itemx -mno-vr4130-align
11331 @opindex mvr4130-align
11332 The VR4130 pipeline is two-way superscalar, but can only issue two
11333 instructions together if the first one is 8-byte aligned.  When this
11334 option is enabled, GCC will align pairs of instructions that it
11335 thinks should execute in parallel.
11336
11337 This option only has an effect when optimizing for the VR4130.
11338 It normally makes code faster, but at the expense of making it bigger.
11339 It is enabled by default at optimization level @option{-O3}.
11340 @end table
11341
11342 @node MMIX Options
11343 @subsection MMIX Options
11344 @cindex MMIX Options
11345
11346 These options are defined for the MMIX:
11347
11348 @table @gcctabopt
11349 @item -mlibfuncs
11350 @itemx -mno-libfuncs
11351 @opindex mlibfuncs
11352 @opindex mno-libfuncs
11353 Specify that intrinsic library functions are being compiled, passing all
11354 values in registers, no matter the size.
11355
11356 @item -mepsilon
11357 @itemx -mno-epsilon
11358 @opindex mepsilon
11359 @opindex mno-epsilon
11360 Generate floating-point comparison instructions that compare with respect
11361 to the @code{rE} epsilon register.
11362
11363 @item -mabi=mmixware
11364 @itemx -mabi=gnu
11365 @opindex mabi-mmixware
11366 @opindex mabi=gnu
11367 Generate code that passes function parameters and return values that (in
11368 the called function) are seen as registers @code{$0} and up, as opposed to
11369 the GNU ABI which uses global registers @code{$231} and up.
11370
11371 @item -mzero-extend
11372 @itemx -mno-zero-extend
11373 @opindex mzero-extend
11374 @opindex mno-zero-extend
11375 When reading data from memory in sizes shorter than 64 bits, use (do not
11376 use) zero-extending load instructions by default, rather than
11377 sign-extending ones.
11378
11379 @item -mknuthdiv
11380 @itemx -mno-knuthdiv
11381 @opindex mknuthdiv
11382 @opindex mno-knuthdiv
11383 Make the result of a division yielding a remainder have the same sign as
11384 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
11385 remainder follows the sign of the dividend.  Both methods are
11386 arithmetically valid, the latter being almost exclusively used.
11387
11388 @item -mtoplevel-symbols
11389 @itemx -mno-toplevel-symbols
11390 @opindex mtoplevel-symbols
11391 @opindex mno-toplevel-symbols
11392 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11393 code can be used with the @code{PREFIX} assembly directive.
11394
11395 @item -melf
11396 @opindex melf
11397 Generate an executable in the ELF format, rather than the default
11398 @samp{mmo} format used by the @command{mmix} simulator.
11399
11400 @item -mbranch-predict
11401 @itemx -mno-branch-predict
11402 @opindex mbranch-predict
11403 @opindex mno-branch-predict
11404 Use (do not use) the probable-branch instructions, when static branch
11405 prediction indicates a probable branch.
11406
11407 @item -mbase-addresses
11408 @itemx -mno-base-addresses
11409 @opindex mbase-addresses
11410 @opindex mno-base-addresses
11411 Generate (do not generate) code that uses @emph{base addresses}.  Using a
11412 base address automatically generates a request (handled by the assembler
11413 and the linker) for a constant to be set up in a global register.  The
11414 register is used for one or more base address requests within the range 0
11415 to 255 from the value held in the register.  The generally leads to short
11416 and fast code, but the number of different data items that can be
11417 addressed is limited.  This means that a program that uses lots of static
11418 data may require @option{-mno-base-addresses}.
11419
11420 @item -msingle-exit
11421 @itemx -mno-single-exit
11422 @opindex msingle-exit
11423 @opindex mno-single-exit
11424 Force (do not force) generated code to have a single exit point in each
11425 function.
11426 @end table
11427
11428 @node MN10300 Options
11429 @subsection MN10300 Options
11430 @cindex MN10300 options
11431
11432 These @option{-m} options are defined for Matsushita MN10300 architectures:
11433
11434 @table @gcctabopt
11435 @item -mmult-bug
11436 @opindex mmult-bug
11437 Generate code to avoid bugs in the multiply instructions for the MN10300
11438 processors.  This is the default.
11439
11440 @item -mno-mult-bug
11441 @opindex mno-mult-bug
11442 Do not generate code to avoid bugs in the multiply instructions for the
11443 MN10300 processors.
11444
11445 @item -mam33
11446 @opindex mam33
11447 Generate code which uses features specific to the AM33 processor.
11448
11449 @item -mno-am33
11450 @opindex mno-am33
11451 Do not generate code which uses features specific to the AM33 processor.  This
11452 is the default.
11453
11454 @item -mreturn-pointer-on-d0
11455 @opindex mreturn-pointer-on-d0
11456 When generating a function which returns a pointer, return the pointer
11457 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
11458 only in a0, and attempts to call such functions without a prototype
11459 would result in errors.  Note that this option is on by default; use
11460 @option{-mno-return-pointer-on-d0} to disable it.
11461
11462 @item -mno-crt0
11463 @opindex mno-crt0
11464 Do not link in the C run-time initialization object file.
11465
11466 @item -mrelax
11467 @opindex mrelax
11468 Indicate to the linker that it should perform a relaxation optimization pass
11469 to shorten branches, calls and absolute memory addresses.  This option only
11470 has an effect when used on the command line for the final link step.
11471
11472 This option makes symbolic debugging impossible.
11473 @end table
11474
11475 @node MT Options
11476 @subsection MT Options
11477 @cindex MT options
11478
11479 These @option{-m} options are defined for Morpho MT architectures:
11480
11481 @table @gcctabopt
11482
11483 @item -march=@var{cpu-type}
11484 @opindex march
11485 Generate code that will run on @var{cpu-type}, which is the name of a system
11486 representing a certain processor type.  Possible values for
11487 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11488 @samp{ms1-16-003} and @samp{ms2}.
11489
11490 When this option is not used, the default is @option{-march=ms1-16-002}.
11491
11492 @item -mbacc
11493 @opindex mbacc
11494 Use byte loads and stores when generating code.
11495
11496 @item -mno-bacc
11497 @opindex mno-bacc
11498 Do not use byte loads and stores when generating code.
11499
11500 @item -msim
11501 @opindex msim
11502 Use simulator runtime
11503
11504 @item -mno-crt0
11505 @opindex mno-crt0
11506 Do not link in the C run-time initialization object file
11507 @file{crti.o}.  Other run-time initialization and termination files
11508 such as @file{startup.o} and @file{exit.o} are still included on the
11509 linker command line.
11510
11511 @end table
11512
11513 @node PDP-11 Options
11514 @subsection PDP-11 Options
11515 @cindex PDP-11 Options
11516
11517 These options are defined for the PDP-11:
11518
11519 @table @gcctabopt
11520 @item -mfpu
11521 @opindex mfpu
11522 Use hardware FPP floating point.  This is the default.  (FIS floating
11523 point on the PDP-11/40 is not supported.)
11524
11525 @item -msoft-float
11526 @opindex msoft-float
11527 Do not use hardware floating point.
11528
11529 @item -mac0
11530 @opindex mac0
11531 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11532
11533 @item -mno-ac0
11534 @opindex mno-ac0
11535 Return floating-point results in memory.  This is the default.
11536
11537 @item -m40
11538 @opindex m40
11539 Generate code for a PDP-11/40.
11540
11541 @item -m45
11542 @opindex m45
11543 Generate code for a PDP-11/45.  This is the default.
11544
11545 @item -m10
11546 @opindex m10
11547 Generate code for a PDP-11/10.
11548
11549 @item -mbcopy-builtin
11550 @opindex bcopy-builtin
11551 Use inline @code{movmemhi} patterns for copying memory.  This is the
11552 default.
11553
11554 @item -mbcopy
11555 @opindex mbcopy
11556 Do not use inline @code{movmemhi} patterns for copying memory.
11557
11558 @item -mint16
11559 @itemx -mno-int32
11560 @opindex mint16
11561 @opindex mno-int32
11562 Use 16-bit @code{int}.  This is the default.
11563
11564 @item -mint32
11565 @itemx -mno-int16
11566 @opindex mint32
11567 @opindex mno-int16
11568 Use 32-bit @code{int}.
11569
11570 @item -mfloat64
11571 @itemx -mno-float32
11572 @opindex mfloat64
11573 @opindex mno-float32
11574 Use 64-bit @code{float}.  This is the default.
11575
11576 @item -mfloat32
11577 @itemx -mno-float64
11578 @opindex mfloat32
11579 @opindex mno-float64
11580 Use 32-bit @code{float}.
11581
11582 @item -mabshi
11583 @opindex mabshi
11584 Use @code{abshi2} pattern.  This is the default.
11585
11586 @item -mno-abshi
11587 @opindex mno-abshi
11588 Do not use @code{abshi2} pattern.
11589
11590 @item -mbranch-expensive
11591 @opindex mbranch-expensive
11592 Pretend that branches are expensive.  This is for experimenting with
11593 code generation only.
11594
11595 @item -mbranch-cheap
11596 @opindex mbranch-cheap
11597 Do not pretend that branches are expensive.  This is the default.
11598
11599 @item -msplit
11600 @opindex msplit
11601 Generate code for a system with split I&D@.
11602
11603 @item -mno-split
11604 @opindex mno-split
11605 Generate code for a system without split I&D@.  This is the default.
11606
11607 @item -munix-asm
11608 @opindex munix-asm
11609 Use Unix assembler syntax.  This is the default when configured for
11610 @samp{pdp11-*-bsd}.
11611
11612 @item -mdec-asm
11613 @opindex mdec-asm
11614 Use DEC assembler syntax.  This is the default when configured for any
11615 PDP-11 target other than @samp{pdp11-*-bsd}.
11616 @end table
11617
11618 @node PowerPC Options
11619 @subsection PowerPC Options
11620 @cindex PowerPC options
11621
11622 These are listed under @xref{RS/6000 and PowerPC Options}.
11623
11624 @node RS/6000 and PowerPC Options
11625 @subsection IBM RS/6000 and PowerPC Options
11626 @cindex RS/6000 and PowerPC Options
11627 @cindex IBM RS/6000 and PowerPC Options
11628
11629 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11630 @table @gcctabopt
11631 @item -mpower
11632 @itemx -mno-power
11633 @itemx -mpower2
11634 @itemx -mno-power2
11635 @itemx -mpowerpc
11636 @itemx -mno-powerpc
11637 @itemx -mpowerpc-gpopt
11638 @itemx -mno-powerpc-gpopt
11639 @itemx -mpowerpc-gfxopt
11640 @itemx -mno-powerpc-gfxopt
11641 @itemx -mpowerpc64
11642 @itemx -mno-powerpc64
11643 @itemx -mmfcrf
11644 @itemx -mno-mfcrf
11645 @itemx -mpopcntb
11646 @itemx -mno-popcntb
11647 @itemx -mfprnd
11648 @itemx -mno-fprnd
11649 @itemx -mmfpgpr
11650 @itemx -mno-mfpgpr
11651 @opindex mpower
11652 @opindex mno-power
11653 @opindex mpower2
11654 @opindex mno-power2
11655 @opindex mpowerpc
11656 @opindex mno-powerpc
11657 @opindex mpowerpc-gpopt
11658 @opindex mno-powerpc-gpopt
11659 @opindex mpowerpc-gfxopt
11660 @opindex mno-powerpc-gfxopt
11661 @opindex mpowerpc64
11662 @opindex mno-powerpc64
11663 @opindex mmfcrf
11664 @opindex mno-mfcrf
11665 @opindex mpopcntb
11666 @opindex mno-popcntb
11667 @opindex mfprnd
11668 @opindex mno-fprnd
11669 @opindex mmfpgpr
11670 @opindex mno-mfpgpr
11671 GCC supports two related instruction set architectures for the
11672 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11673 instructions supported by the @samp{rios} chip set used in the original
11674 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11675 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11676 the IBM 4xx, 6xx, and follow-on microprocessors.
11677
11678 Neither architecture is a subset of the other.  However there is a
11679 large common subset of instructions supported by both.  An MQ
11680 register is included in processors supporting the POWER architecture.
11681
11682 You use these options to specify which instructions are available on the
11683 processor you are using.  The default value of these options is
11684 determined when configuring GCC@.  Specifying the
11685 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11686 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11687 rather than the options listed above.
11688
11689 The @option{-mpower} option allows GCC to generate instructions that
11690 are found only in the POWER architecture and to use the MQ register.
11691 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11692 to generate instructions that are present in the POWER2 architecture but
11693 not the original POWER architecture.
11694
11695 The @option{-mpowerpc} option allows GCC to generate instructions that
11696 are found only in the 32-bit subset of the PowerPC architecture.
11697 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11698 GCC to use the optional PowerPC architecture instructions in the
11699 General Purpose group, including floating-point square root.  Specifying
11700 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11701 use the optional PowerPC architecture instructions in the Graphics
11702 group, including floating-point select.
11703
11704 The @option{-mmfcrf} option allows GCC to generate the move from
11705 condition register field instruction implemented on the POWER4
11706 processor and other processors that support the PowerPC V2.01
11707 architecture.
11708 The @option{-mpopcntb} option allows GCC to generate the popcount and
11709 double precision FP reciprocal estimate instruction implemented on the
11710 POWER5 processor and other processors that support the PowerPC V2.02
11711 architecture.
11712 The @option{-mfprnd} option allows GCC to generate the FP round to
11713 integer instructions implemented on the POWER5+ processor and other
11714 processors that support the PowerPC V2.03 architecture.
11715 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
11716 general purpose register instructions implemented on the POWER6X
11717 processor and other processors that support the extended PowerPC V2.05
11718 architecture.
11719
11720 The @option{-mpowerpc64} option allows GCC to generate the additional
11721 64-bit instructions that are found in the full PowerPC64 architecture
11722 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11723 @option{-mno-powerpc64}.
11724
11725 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11726 will use only the instructions in the common subset of both
11727 architectures plus some special AIX common-mode calls, and will not use
11728 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11729 permits GCC to use any instruction from either architecture and to
11730 allow use of the MQ register; specify this for the Motorola MPC601.
11731
11732 @item -mnew-mnemonics
11733 @itemx -mold-mnemonics
11734 @opindex mnew-mnemonics
11735 @opindex mold-mnemonics
11736 Select which mnemonics to use in the generated assembler code.  With
11737 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11738 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11739 assembler mnemonics defined for the POWER architecture.  Instructions
11740 defined in only one architecture have only one mnemonic; GCC uses that
11741 mnemonic irrespective of which of these options is specified.
11742
11743 GCC defaults to the mnemonics appropriate for the architecture in
11744 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11745 value of these option.  Unless you are building a cross-compiler, you
11746 should normally not specify either @option{-mnew-mnemonics} or
11747 @option{-mold-mnemonics}, but should instead accept the default.
11748
11749 @item -mcpu=@var{cpu_type}
11750 @opindex mcpu
11751 Set architecture type, register usage, choice of mnemonics, and
11752 instruction scheduling parameters for machine type @var{cpu_type}.
11753 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11754 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11755 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11756 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11757 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11758 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11759 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11760 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11761 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
11762 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11763
11764 @option{-mcpu=common} selects a completely generic processor.  Code
11765 generated under this option will run on any POWER or PowerPC processor.
11766 GCC will use only the instructions in the common subset of both
11767 architectures, and will not use the MQ register.  GCC assumes a generic
11768 processor model for scheduling purposes.
11769
11770 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11771 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11772 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11773 types, with an appropriate, generic processor model assumed for
11774 scheduling purposes.
11775
11776 The other options specify a specific processor.  Code generated under
11777 those options will run best on that processor, and may not run at all on
11778 others.
11779
11780 The @option{-mcpu} options automatically enable or disable the
11781 following options:
11782
11783 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
11784 -mnew-mnemonics  -mpopcntb  -mpower  -mpower2  -mpowerpc64 @gol
11785 -mpowerpc-gpopt  -mpowerpc-gfxopt  -mstring  -mmulhw  -mdlmzb  -mmfpgpr}
11786
11787 The particular options set for any particular CPU will vary between
11788 compiler versions, depending on what setting seems to produce optimal
11789 code for that CPU; it doesn't necessarily reflect the actual hardware's
11790 capabilities.  If you wish to set an individual option to a particular
11791 value, you may specify it after the @option{-mcpu} option, like
11792 @samp{-mcpu=970 -mno-altivec}.
11793
11794 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11795 not enabled or disabled by the @option{-mcpu} option at present because
11796 AIX does not have full support for these options.  You may still
11797 enable or disable them individually if you're sure it'll work in your
11798 environment.
11799
11800 @item -mtune=@var{cpu_type}
11801 @opindex mtune
11802 Set the instruction scheduling parameters for machine type
11803 @var{cpu_type}, but do not set the architecture type, register usage, or
11804 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11805 values for @var{cpu_type} are used for @option{-mtune} as for
11806 @option{-mcpu}.  If both are specified, the code generated will use the
11807 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11808 scheduling parameters set by @option{-mtune}.
11809
11810 @item -mswdiv
11811 @itemx -mno-swdiv
11812 @opindex mswdiv
11813 @opindex mno-swdiv
11814 Generate code to compute division as reciprocal estimate and iterative
11815 refinement, creating opportunities for increased throughput.  This
11816 feature requires: optional PowerPC Graphics instruction set for single
11817 precision and FRE instruction for double precision, assuming divides
11818 cannot generate user-visible traps, and the domain values not include
11819 Infinities, denormals or zero denominator.
11820
11821 @item -maltivec
11822 @itemx -mno-altivec
11823 @opindex maltivec
11824 @opindex mno-altivec
11825 Generate code that uses (does not use) AltiVec instructions, and also
11826 enable the use of built-in functions that allow more direct access to
11827 the AltiVec instruction set.  You may also need to set
11828 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11829 enhancements.
11830
11831 @item -mvrsave
11832 @item -mno-vrsave
11833 @opindex mvrsave
11834 @opindex mno-vrsave
11835 Generate VRSAVE instructions when generating AltiVec code.
11836
11837 @item -msecure-plt
11838 @opindex msecure-plt
11839 Generate code that allows ld and ld.so to build executables and shared
11840 libraries with non-exec .plt and .got sections.  This is a PowerPC
11841 32-bit SYSV ABI option.
11842
11843 @item -mbss-plt
11844 @opindex mbss-plt
11845 Generate code that uses a BSS .plt section that ld.so fills in, and
11846 requires .plt and .got sections that are both writable and executable.
11847 This is a PowerPC 32-bit SYSV ABI option.
11848
11849 @item -misel
11850 @itemx -mno-isel
11851 @opindex misel
11852 @opindex mno-isel
11853 This switch enables or disables the generation of ISEL instructions.
11854
11855 @item -misel=@var{yes/no}
11856 This switch has been deprecated.  Use @option{-misel} and
11857 @option{-mno-isel} instead.
11858
11859 @item -mspe
11860 @itemx -mno-spe
11861 @opindex mspe
11862 @opindex mno-spe
11863 This switch enables or disables the generation of SPE simd
11864 instructions.
11865
11866 @item -mspe=@var{yes/no}
11867 This option has been deprecated.  Use @option{-mspe} and
11868 @option{-mno-spe} instead.
11869
11870 @item -mfloat-gprs=@var{yes/single/double/no}
11871 @itemx -mfloat-gprs
11872 @opindex mfloat-gprs
11873 This switch enables or disables the generation of floating point
11874 operations on the general purpose registers for architectures that
11875 support it.
11876
11877 The argument @var{yes} or @var{single} enables the use of
11878 single-precision floating point operations.
11879
11880 The argument @var{double} enables the use of single and
11881 double-precision floating point operations.
11882
11883 The argument @var{no} disables floating point operations on the
11884 general purpose registers.
11885
11886 This option is currently only available on the MPC854x.
11887
11888 @item -m32
11889 @itemx -m64
11890 @opindex m32
11891 @opindex m64
11892 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11893 targets (including GNU/Linux).  The 32-bit environment sets int, long
11894 and pointer to 32 bits and generates code that runs on any PowerPC
11895 variant.  The 64-bit environment sets int to 32 bits and long and
11896 pointer to 64 bits, and generates code for PowerPC64, as for
11897 @option{-mpowerpc64}.
11898
11899 @item -mfull-toc
11900 @itemx -mno-fp-in-toc
11901 @itemx -mno-sum-in-toc
11902 @itemx -mminimal-toc
11903 @opindex mfull-toc
11904 @opindex mno-fp-in-toc
11905 @opindex mno-sum-in-toc
11906 @opindex mminimal-toc
11907 Modify generation of the TOC (Table Of Contents), which is created for
11908 every executable file.  The @option{-mfull-toc} option is selected by
11909 default.  In that case, GCC will allocate at least one TOC entry for
11910 each unique non-automatic variable reference in your program.  GCC
11911 will also place floating-point constants in the TOC@.  However, only
11912 16,384 entries are available in the TOC@.
11913
11914 If you receive a linker error message that saying you have overflowed
11915 the available TOC space, you can reduce the amount of TOC space used
11916 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11917 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11918 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11919 generate code to calculate the sum of an address and a constant at
11920 run-time instead of putting that sum into the TOC@.  You may specify one
11921 or both of these options.  Each causes GCC to produce very slightly
11922 slower and larger code at the expense of conserving TOC space.
11923
11924 If you still run out of space in the TOC even when you specify both of
11925 these options, specify @option{-mminimal-toc} instead.  This option causes
11926 GCC to make only one TOC entry for every file.  When you specify this
11927 option, GCC will produce code that is slower and larger but which
11928 uses extremely little TOC space.  You may wish to use this option
11929 only on files that contain less frequently executed code.
11930
11931 @item -maix64
11932 @itemx -maix32
11933 @opindex maix64
11934 @opindex maix32
11935 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11936 @code{long} type, and the infrastructure needed to support them.
11937 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11938 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11939 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11940
11941 @item -mxl-compat
11942 @itemx -mno-xl-compat
11943 @opindex mxl-compat
11944 @opindex mno-xl-compat
11945 Produce code that conforms more closely to IBM XL compiler semantics
11946 when using AIX-compatible ABI.  Pass floating-point arguments to
11947 prototyped functions beyond the register save area (RSA) on the stack
11948 in addition to argument FPRs.  Do not assume that most significant
11949 double in 128-bit long double value is properly rounded when comparing
11950 values and converting to double.  Use XL symbol names for long double
11951 support routines.
11952
11953 The AIX calling convention was extended but not initially documented to
11954 handle an obscure K&R C case of calling a function that takes the
11955 address of its arguments with fewer arguments than declared.  IBM XL
11956 compilers access floating point arguments which do not fit in the
11957 RSA from the stack when a subroutine is compiled without
11958 optimization.  Because always storing floating-point arguments on the
11959 stack is inefficient and rarely needed, this option is not enabled by
11960 default and only is necessary when calling subroutines compiled by IBM
11961 XL compilers without optimization.
11962
11963 @item -mpe
11964 @opindex mpe
11965 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11966 application written to use message passing with special startup code to
11967 enable the application to run.  The system must have PE installed in the
11968 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11969 must be overridden with the @option{-specs=} option to specify the
11970 appropriate directory location.  The Parallel Environment does not
11971 support threads, so the @option{-mpe} option and the @option{-pthread}
11972 option are incompatible.
11973
11974 @item -malign-natural
11975 @itemx -malign-power
11976 @opindex malign-natural
11977 @opindex malign-power
11978 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11979 @option{-malign-natural} overrides the ABI-defined alignment of larger
11980 types, such as floating-point doubles, on their natural size-based boundary.
11981 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11982 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11983
11984 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11985 is not supported.
11986
11987 @item -msoft-float
11988 @itemx -mhard-float
11989 @opindex msoft-float
11990 @opindex mhard-float
11991 Generate code that does not use (uses) the floating-point register set.
11992 Software floating point emulation is provided if you use the
11993 @option{-msoft-float} option, and pass the option to GCC when linking.
11994
11995 @item -mmultiple
11996 @itemx -mno-multiple
11997 @opindex mmultiple
11998 @opindex mno-multiple
11999 Generate code that uses (does not use) the load multiple word
12000 instructions and the store multiple word instructions.  These
12001 instructions are generated by default on POWER systems, and not
12002 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
12003 endian PowerPC systems, since those instructions do not work when the
12004 processor is in little endian mode.  The exceptions are PPC740 and
12005 PPC750 which permit the instructions usage in little endian mode.
12006
12007 @item -mstring
12008 @itemx -mno-string
12009 @opindex mstring
12010 @opindex mno-string
12011 Generate code that uses (does not use) the load string instructions
12012 and the store string word instructions to save multiple registers and
12013 do small block moves.  These instructions are generated by default on
12014 POWER systems, and not generated on PowerPC systems.  Do not use
12015 @option{-mstring} on little endian PowerPC systems, since those
12016 instructions do not work when the processor is in little endian mode.
12017 The exceptions are PPC740 and PPC750 which permit the instructions
12018 usage in little endian mode.
12019
12020 @item -mupdate
12021 @itemx -mno-update
12022 @opindex mupdate
12023 @opindex mno-update
12024 Generate code that uses (does not use) the load or store instructions
12025 that update the base register to the address of the calculated memory
12026 location.  These instructions are generated by default.  If you use
12027 @option{-mno-update}, there is a small window between the time that the
12028 stack pointer is updated and the address of the previous frame is
12029 stored, which means code that walks the stack frame across interrupts or
12030 signals may get corrupted data.
12031
12032 @item -mfused-madd
12033 @itemx -mno-fused-madd
12034 @opindex mfused-madd
12035 @opindex mno-fused-madd
12036 Generate code that uses (does not use) the floating point multiply and
12037 accumulate instructions.  These instructions are generated by default if
12038 hardware floating is used.
12039
12040 @item -mmulhw
12041 @itemx -mno-mulhw
12042 @opindex mmulhw
12043 @opindex mno-mulhw
12044 Generate code that uses (does not use) the half-word multiply and
12045 multiply-accumulate instructions on the IBM 405 and 440 processors.
12046 These instructions are generated by default when targetting those
12047 processors.
12048
12049 @item -mdlmzb
12050 @itemx -mno-dlmzb
12051 @opindex mdlmzb
12052 @opindex mno-dlmzb
12053 Generate code that uses (does not use) the string-search @samp{dlmzb}
12054 instruction on the IBM 405 and 440 processors.  This instruction is
12055 generated by default when targetting those processors.
12056
12057 @item -mno-bit-align
12058 @itemx -mbit-align
12059 @opindex mno-bit-align
12060 @opindex mbit-align
12061 On System V.4 and embedded PowerPC systems do not (do) force structures
12062 and unions that contain bit-fields to be aligned to the base type of the
12063 bit-field.
12064
12065 For example, by default a structure containing nothing but 8
12066 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
12067 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
12068 the structure would be aligned to a 1 byte boundary and be one byte in
12069 size.
12070
12071 @item -mno-strict-align
12072 @itemx -mstrict-align
12073 @opindex mno-strict-align
12074 @opindex mstrict-align
12075 On System V.4 and embedded PowerPC systems do not (do) assume that
12076 unaligned memory references will be handled by the system.
12077
12078 @item -mrelocatable
12079 @itemx -mno-relocatable
12080 @opindex mrelocatable
12081 @opindex mno-relocatable
12082 On embedded PowerPC systems generate code that allows (does not allow)
12083 the program to be relocated to a different address at runtime.  If you
12084 use @option{-mrelocatable} on any module, all objects linked together must
12085 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
12086
12087 @item -mrelocatable-lib
12088 @itemx -mno-relocatable-lib
12089 @opindex mrelocatable-lib
12090 @opindex mno-relocatable-lib
12091 On embedded PowerPC systems generate code that allows (does not allow)
12092 the program to be relocated to a different address at runtime.  Modules
12093 compiled with @option{-mrelocatable-lib} can be linked with either modules
12094 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
12095 with modules compiled with the @option{-mrelocatable} options.
12096
12097 @item -mno-toc
12098 @itemx -mtoc
12099 @opindex mno-toc
12100 @opindex mtoc
12101 On System V.4 and embedded PowerPC systems do not (do) assume that
12102 register 2 contains a pointer to a global area pointing to the addresses
12103 used in the program.
12104
12105 @item -mlittle
12106 @itemx -mlittle-endian
12107 @opindex mlittle
12108 @opindex mlittle-endian
12109 On System V.4 and embedded PowerPC systems compile code for the
12110 processor in little endian mode.  The @option{-mlittle-endian} option is
12111 the same as @option{-mlittle}.
12112
12113 @item -mbig
12114 @itemx -mbig-endian
12115 @opindex mbig
12116 @opindex mbig-endian
12117 On System V.4 and embedded PowerPC systems compile code for the
12118 processor in big endian mode.  The @option{-mbig-endian} option is
12119 the same as @option{-mbig}.
12120
12121 @item -mdynamic-no-pic
12122 @opindex mdynamic-no-pic
12123 On Darwin and Mac OS X systems, compile code so that it is not
12124 relocatable, but that its external references are relocatable.  The
12125 resulting code is suitable for applications, but not shared
12126 libraries.
12127
12128 @item -mprioritize-restricted-insns=@var{priority}
12129 @opindex mprioritize-restricted-insns
12130 This option controls the priority that is assigned to
12131 dispatch-slot restricted instructions during the second scheduling
12132 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
12133 @var{no/highest/second-highest} priority to dispatch slot restricted
12134 instructions.
12135
12136 @item -msched-costly-dep=@var{dependence_type}
12137 @opindex msched-costly-dep
12138 This option controls which dependences are considered costly
12139 by the target during instruction scheduling.  The argument
12140 @var{dependence_type} takes one of the following values:
12141 @var{no}: no dependence is costly,
12142 @var{all}: all dependences are costly,
12143 @var{true_store_to_load}: a true dependence from store to load is costly,
12144 @var{store_to_load}: any dependence from store to load is costly,
12145 @var{number}: any dependence which latency >= @var{number} is costly.
12146
12147 @item -minsert-sched-nops=@var{scheme}
12148 @opindex minsert-sched-nops
12149 This option controls which nop insertion scheme will be used during
12150 the second scheduling pass.  The argument @var{scheme} takes one of the
12151 following values:
12152 @var{no}: Don't insert nops.
12153 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
12154 according to the scheduler's grouping.
12155 @var{regroup_exact}: Insert nops to force costly dependent insns into
12156 separate groups.  Insert exactly as many nops as needed to force an insn
12157 to a new group, according to the estimated processor grouping.
12158 @var{number}: Insert nops to force costly dependent insns into
12159 separate groups.  Insert @var{number} nops to force an insn to a new group.
12160
12161 @item -mcall-sysv
12162 @opindex mcall-sysv
12163 On System V.4 and embedded PowerPC systems compile code using calling
12164 conventions that adheres to the March 1995 draft of the System V
12165 Application Binary Interface, PowerPC processor supplement.  This is the
12166 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
12167
12168 @item -mcall-sysv-eabi
12169 @opindex mcall-sysv-eabi
12170 Specify both @option{-mcall-sysv} and @option{-meabi} options.
12171
12172 @item -mcall-sysv-noeabi
12173 @opindex mcall-sysv-noeabi
12174 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
12175
12176 @item -mcall-solaris
12177 @opindex mcall-solaris
12178 On System V.4 and embedded PowerPC systems compile code for the Solaris
12179 operating system.
12180
12181 @item -mcall-linux
12182 @opindex mcall-linux
12183 On System V.4 and embedded PowerPC systems compile code for the
12184 Linux-based GNU system.
12185
12186 @item -mcall-gnu
12187 @opindex mcall-gnu
12188 On System V.4 and embedded PowerPC systems compile code for the
12189 Hurd-based GNU system.
12190
12191 @item -mcall-netbsd
12192 @opindex mcall-netbsd
12193 On System V.4 and embedded PowerPC systems compile code for the
12194 NetBSD operating system.
12195
12196 @item -maix-struct-return
12197 @opindex maix-struct-return
12198 Return all structures in memory (as specified by the AIX ABI)@.
12199
12200 @item -msvr4-struct-return
12201 @opindex msvr4-struct-return
12202 Return structures smaller than 8 bytes in registers (as specified by the
12203 SVR4 ABI)@.
12204
12205 @item -mabi=@var{abi-type}
12206 @opindex mabi
12207 Extend the current ABI with a particular extension, or remove such extension.
12208 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
12209 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
12210
12211 @item -mabi=spe
12212 @opindex mabi=spe
12213 Extend the current ABI with SPE ABI extensions.  This does not change
12214 the default ABI, instead it adds the SPE ABI extensions to the current
12215 ABI@.
12216
12217 @item -mabi=no-spe
12218 @opindex mabi=no-spe
12219 Disable Booke SPE ABI extensions for the current ABI@.
12220
12221 @item -mabi=ibmlongdouble
12222 @opindex mabi=ibmlongdouble
12223 Change the current ABI to use IBM extended precision long double.
12224 This is a PowerPC 32-bit SYSV ABI option.
12225
12226 @item -mabi=ieeelongdouble
12227 @opindex mabi=ieeelongdouble
12228 Change the current ABI to use IEEE extended precision long double.
12229 This is a PowerPC 32-bit Linux ABI option.
12230
12231 @item -mprototype
12232 @itemx -mno-prototype
12233 @opindex mprototype
12234 @opindex mno-prototype
12235 On System V.4 and embedded PowerPC systems assume that all calls to
12236 variable argument functions are properly prototyped.  Otherwise, the
12237 compiler must insert an instruction before every non prototyped call to
12238 set or clear bit 6 of the condition code register (@var{CR}) to
12239 indicate whether floating point values were passed in the floating point
12240 registers in case the function takes a variable arguments.  With
12241 @option{-mprototype}, only calls to prototyped variable argument functions
12242 will set or clear the bit.
12243
12244 @item -msim
12245 @opindex msim
12246 On embedded PowerPC systems, assume that the startup module is called
12247 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
12248 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
12249 configurations.
12250
12251 @item -mmvme
12252 @opindex mmvme
12253 On embedded PowerPC systems, assume that the startup module is called
12254 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
12255 @file{libc.a}.
12256
12257 @item -mads
12258 @opindex mads
12259 On embedded PowerPC systems, assume that the startup module is called
12260 @file{crt0.o} and the standard C libraries are @file{libads.a} and
12261 @file{libc.a}.
12262
12263 @item -myellowknife
12264 @opindex myellowknife
12265 On embedded PowerPC systems, assume that the startup module is called
12266 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
12267 @file{libc.a}.
12268
12269 @item -mvxworks
12270 @opindex mvxworks
12271 On System V.4 and embedded PowerPC systems, specify that you are
12272 compiling for a VxWorks system.
12273
12274 @item -mwindiss
12275 @opindex mwindiss
12276 Specify that you are compiling for the WindISS simulation environment.
12277
12278 @item -memb
12279 @opindex memb
12280 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
12281 header to indicate that @samp{eabi} extended relocations are used.
12282
12283 @item -meabi
12284 @itemx -mno-eabi
12285 @opindex meabi
12286 @opindex mno-eabi
12287 On System V.4 and embedded PowerPC systems do (do not) adhere to the
12288 Embedded Applications Binary Interface (eabi) which is a set of
12289 modifications to the System V.4 specifications.  Selecting @option{-meabi}
12290 means that the stack is aligned to an 8 byte boundary, a function
12291 @code{__eabi} is called to from @code{main} to set up the eabi
12292 environment, and the @option{-msdata} option can use both @code{r2} and
12293 @code{r13} to point to two separate small data areas.  Selecting
12294 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
12295 do not call an initialization function from @code{main}, and the
12296 @option{-msdata} option will only use @code{r13} to point to a single
12297 small data area.  The @option{-meabi} option is on by default if you
12298 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
12299
12300 @item -msdata=eabi
12301 @opindex msdata=eabi
12302 On System V.4 and embedded PowerPC systems, put small initialized
12303 @code{const} global and static data in the @samp{.sdata2} section, which
12304 is pointed to by register @code{r2}.  Put small initialized
12305 non-@code{const} global and static data in the @samp{.sdata} section,
12306 which is pointed to by register @code{r13}.  Put small uninitialized
12307 global and static data in the @samp{.sbss} section, which is adjacent to
12308 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
12309 incompatible with the @option{-mrelocatable} option.  The
12310 @option{-msdata=eabi} option also sets the @option{-memb} option.
12311
12312 @item -msdata=sysv
12313 @opindex msdata=sysv
12314 On System V.4 and embedded PowerPC systems, put small global and static
12315 data in the @samp{.sdata} section, which is pointed to by register
12316 @code{r13}.  Put small uninitialized global and static data in the
12317 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12318 The @option{-msdata=sysv} option is incompatible with the
12319 @option{-mrelocatable} option.
12320
12321 @item -msdata=default
12322 @itemx -msdata
12323 @opindex msdata=default
12324 @opindex msdata
12325 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12326 compile code the same as @option{-msdata=eabi}, otherwise compile code the
12327 same as @option{-msdata=sysv}.
12328
12329 @item -msdata-data
12330 @opindex msdata-data
12331 On System V.4 and embedded PowerPC systems, put small global
12332 data in the @samp{.sdata} section.  Put small uninitialized global
12333 data in the @samp{.sbss} section.  Do not use register @code{r13}
12334 to address small data however.  This is the default behavior unless
12335 other @option{-msdata} options are used.
12336
12337 @item -msdata=none
12338 @itemx -mno-sdata
12339 @opindex msdata=none
12340 @opindex mno-sdata
12341 On embedded PowerPC systems, put all initialized global and static data
12342 in the @samp{.data} section, and all uninitialized data in the
12343 @samp{.bss} section.
12344
12345 @item -G @var{num}
12346 @opindex G
12347 @cindex smaller data references (PowerPC)
12348 @cindex .sdata/.sdata2 references (PowerPC)
12349 On embedded PowerPC systems, put global and static items less than or
12350 equal to @var{num} bytes into the small data or bss sections instead of
12351 the normal data or bss section.  By default, @var{num} is 8.  The
12352 @option{-G @var{num}} switch is also passed to the linker.
12353 All modules should be compiled with the same @option{-G @var{num}} value.
12354
12355 @item -mregnames
12356 @itemx -mno-regnames
12357 @opindex mregnames
12358 @opindex mno-regnames
12359 On System V.4 and embedded PowerPC systems do (do not) emit register
12360 names in the assembly language output using symbolic forms.
12361
12362 @item -mlongcall
12363 @itemx -mno-longcall
12364 @opindex mlongcall
12365 @opindex mno-longcall
12366 By default assume that all calls are far away so that a longer more
12367 expensive calling sequence is required.  This is required for calls
12368 further than 32 megabytes (33,554,432 bytes) from the current location.
12369 A short call will be generated if the compiler knows
12370 the call cannot be that far away.  This setting can be overridden by
12371 the @code{shortcall} function attribute, or by @code{#pragma
12372 longcall(0)}.
12373
12374 Some linkers are capable of detecting out-of-range calls and generating
12375 glue code on the fly.  On these systems, long calls are unnecessary and
12376 generate slower code.  As of this writing, the AIX linker can do this,
12377 as can the GNU linker for PowerPC/64.  It is planned to add this feature
12378 to the GNU linker for 32-bit PowerPC systems as well.
12379
12380 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12381 callee, L42'', plus a ``branch island'' (glue code).  The two target
12382 addresses represent the callee and the ``branch island''.  The
12383 Darwin/PPC linker will prefer the first address and generate a ``bl
12384 callee'' if the PPC ``bl'' instruction will reach the callee directly;
12385 otherwise, the linker will generate ``bl L42'' to call the ``branch
12386 island''.  The ``branch island'' is appended to the body of the
12387 calling function; it computes the full 32-bit address of the callee
12388 and jumps to it.
12389
12390 On Mach-O (Darwin) systems, this option directs the compiler emit to
12391 the glue for every direct call, and the Darwin linker decides whether
12392 to use or discard it.
12393
12394 In the future, we may cause GCC to ignore all longcall specifications
12395 when the linker is known to generate glue.
12396
12397 @item -pthread
12398 @opindex pthread
12399 Adds support for multithreading with the @dfn{pthreads} library.
12400 This option sets flags for both the preprocessor and linker.
12401
12402 @end table
12403
12404 @node S/390 and zSeries Options
12405 @subsection S/390 and zSeries Options
12406 @cindex S/390 and zSeries Options
12407
12408 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
12409
12410 @table @gcctabopt
12411 @item -mhard-float
12412 @itemx -msoft-float
12413 @opindex mhard-float
12414 @opindex msoft-float
12415 Use (do not use) the hardware floating-point instructions and registers
12416 for floating-point operations.  When @option{-msoft-float} is specified,
12417 functions in @file{libgcc.a} will be used to perform floating-point
12418 operations.  When @option{-mhard-float} is specified, the compiler
12419 generates IEEE floating-point instructions.  This is the default.
12420
12421 @item -mlong-double-64
12422 @itemx -mlong-double-128
12423 @opindex mlong-double-64
12424 @opindex mlong-double-128
12425 These switches control the size of @code{long double} type. A size
12426 of 64bit makes the @code{long double} type equivalent to the @code{double}
12427 type. This is the default.
12428
12429 @item -mbackchain
12430 @itemx -mno-backchain
12431 @opindex mbackchain
12432 @opindex mno-backchain
12433 Store (do not store) the address of the caller's frame as backchain pointer
12434 into the callee's stack frame.
12435 A backchain may be needed to allow debugging using tools that do not understand
12436 DWARF-2 call frame information.
12437 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12438 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12439 the backchain is placed into the topmost word of the 96/160 byte register
12440 save area.
12441
12442 In general, code compiled with @option{-mbackchain} is call-compatible with
12443 code compiled with @option{-mmo-backchain}; however, use of the backchain
12444 for debugging purposes usually requires that the whole binary is built with
12445 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
12446 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12447 to build a linux kernel use @option{-msoft-float}.
12448
12449 The default is to not maintain the backchain.
12450
12451 @item -mpacked-stack
12452 @item -mno-packed-stack
12453 @opindex mpacked-stack
12454 @opindex mno-packed-stack
12455 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
12456 specified, the compiler uses the all fields of the 96/160 byte register save
12457 area only for their default purpose; unused fields still take up stack space.
12458 When @option{-mpacked-stack} is specified, register save slots are densely
12459 packed at the top of the register save area; unused space is reused for other
12460 purposes, allowing for more efficient use of the available stack space.
12461 However, when @option{-mbackchain} is also in effect, the topmost word of
12462 the save area is always used to store the backchain, and the return address
12463 register is always saved two words below the backchain.
12464
12465 As long as the stack frame backchain is not used, code generated with
12466 @option{-mpacked-stack} is call-compatible with code generated with
12467 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
12468 S/390 or zSeries generated code that uses the stack frame backchain at run
12469 time, not just for debugging purposes.  Such code is not call-compatible
12470 with code compiled with @option{-mpacked-stack}.  Also, note that the
12471 combination of @option{-mbackchain},
12472 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
12473 to build a linux kernel use @option{-msoft-float}.
12474
12475 The default is to not use the packed stack layout.
12476
12477 @item -msmall-exec
12478 @itemx -mno-small-exec
12479 @opindex msmall-exec
12480 @opindex mno-small-exec
12481 Generate (or do not generate) code using the @code{bras} instruction
12482 to do subroutine calls.
12483 This only works reliably if the total executable size does not
12484 exceed 64k.  The default is to use the @code{basr} instruction instead,
12485 which does not have this limitation.
12486
12487 @item -m64
12488 @itemx -m31
12489 @opindex m64
12490 @opindex m31
12491 When @option{-m31} is specified, generate code compliant to the
12492 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
12493 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
12494 particular to generate 64-bit instructions.  For the @samp{s390}
12495 targets, the default is @option{-m31}, while the @samp{s390x}
12496 targets default to @option{-m64}.
12497
12498 @item -mzarch
12499 @itemx -mesa
12500 @opindex mzarch
12501 @opindex mesa
12502 When @option{-mzarch} is specified, generate code using the
12503 instructions available on z/Architecture.
12504 When @option{-mesa} is specified, generate code using the
12505 instructions available on ESA/390.  Note that @option{-mesa} is
12506 not possible with @option{-m64}.
12507 When generating code compliant to the GNU/Linux for S/390 ABI,
12508 the default is @option{-mesa}.  When generating code compliant
12509 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12510
12511 @item -mmvcle
12512 @itemx -mno-mvcle
12513 @opindex mmvcle
12514 @opindex mno-mvcle
12515 Generate (or do not generate) code using the @code{mvcle} instruction
12516 to perform block moves.  When @option{-mno-mvcle} is specified,
12517 use a @code{mvc} loop instead.  This is the default unless optimizing for
12518 size.
12519
12520 @item -mdebug
12521 @itemx -mno-debug
12522 @opindex mdebug
12523 @opindex mno-debug
12524 Print (or do not print) additional debug information when compiling.
12525 The default is to not print debug information.
12526
12527 @item -march=@var{cpu-type}
12528 @opindex march
12529 Generate code that will run on @var{cpu-type}, which is the name of a system
12530 representing a certain processor type.  Possible values for
12531 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12532 When generating code using the instructions available on z/Architecture,
12533 the default is @option{-march=z900}.  Otherwise, the default is
12534 @option{-march=g5}.
12535
12536 @item -mtune=@var{cpu-type}
12537 @opindex mtune
12538 Tune to @var{cpu-type} everything applicable about the generated code,
12539 except for the ABI and the set of available instructions.
12540 The list of @var{cpu-type} values is the same as for @option{-march}.
12541 The default is the value used for @option{-march}.
12542
12543 @item -mtpf-trace
12544 @itemx -mno-tpf-trace
12545 @opindex mtpf-trace
12546 @opindex mno-tpf-trace
12547 Generate code that adds (does not add) in TPF OS specific branches to trace
12548 routines in the operating system.  This option is off by default, even
12549 when compiling for the TPF OS@.
12550
12551 @item -mfused-madd
12552 @itemx -mno-fused-madd
12553 @opindex mfused-madd
12554 @opindex mno-fused-madd
12555 Generate code that uses (does not use) the floating point multiply and
12556 accumulate instructions.  These instructions are generated by default if
12557 hardware floating point is used.
12558
12559 @item -mwarn-framesize=@var{framesize}
12560 @opindex mwarn-framesize
12561 Emit a warning if the current function exceeds the given frame size.  Because
12562 this is a compile time check it doesn't need to be a real problem when the program
12563 runs.  It is intended to identify functions which most probably cause
12564 a stack overflow.  It is useful to be used in an environment with limited stack
12565 size e.g.@: the linux kernel.
12566
12567 @item -mwarn-dynamicstack
12568 @opindex mwarn-dynamicstack
12569 Emit a warning if the function calls alloca or uses dynamically
12570 sized arrays.  This is generally a bad idea with a limited stack size.
12571
12572 @item -mstack-guard=@var{stack-guard}
12573 @item -mstack-size=@var{stack-size}
12574 @opindex mstack-guard
12575 @opindex mstack-size
12576 These arguments always have to be used in conjunction.  If they are present the s390
12577 back end emits additional instructions in the function prologue which trigger a trap
12578 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12579 (remember that the stack on s390 grows downward).  These options are intended to
12580 be used to help debugging stack overflow problems.  The additionally emitted code
12581 causes only little overhead and hence can also be used in production like systems
12582 without greater performance degradation.  The given values have to be exact
12583 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12584 exceeding 64k.
12585 In order to be efficient the extra code makes the assumption that the stack starts
12586 at an address aligned to the value given by @var{stack-size}.
12587 @end table
12588
12589 @node Score Options
12590 @subsection Score Options
12591 @cindex Score Options
12592
12593 These options are defined for Score implementations:
12594
12595 @table @gcctabopt
12596 @item -mel
12597 @opindex -mel
12598 Compile code for little endian mode. 
12599
12600 @item -meb
12601 @opindex meb
12602 Compile code for big endian mode.  This is the default.
12603
12604 @item -mmac
12605 @opindex mmac
12606 Enable the use of multiply-accumulate instructions. Disabled by default. 
12607
12608 @item -mscore5u
12609 @opindex mscore5u
12610 Specify the SCORE5U of the target architecture.
12611
12612 @item -mscore7
12613 @opindex mscore7
12614 Specify the SCORE7 of the target architecture. This is the default.
12615 @end table
12616
12617 @node SH Options
12618 @subsection SH Options
12619
12620 These @samp{-m} options are defined for the SH implementations:
12621
12622 @table @gcctabopt
12623 @item -m1
12624 @opindex m1
12625 Generate code for the SH1.
12626
12627 @item -m2
12628 @opindex m2
12629 Generate code for the SH2.
12630
12631 @item -m2e
12632 Generate code for the SH2e.
12633
12634 @item -m3
12635 @opindex m3
12636 Generate code for the SH3.
12637
12638 @item -m3e
12639 @opindex m3e
12640 Generate code for the SH3e.
12641
12642 @item -m4-nofpu
12643 @opindex m4-nofpu
12644 Generate code for the SH4 without a floating-point unit.
12645
12646 @item -m4-single-only
12647 @opindex m4-single-only
12648 Generate code for the SH4 with a floating-point unit that only
12649 supports single-precision arithmetic.
12650
12651 @item -m4-single
12652 @opindex m4-single
12653 Generate code for the SH4 assuming the floating-point unit is in
12654 single-precision mode by default.
12655
12656 @item -m4
12657 @opindex m4
12658 Generate code for the SH4.
12659
12660 @item -m4a-nofpu
12661 @opindex m4a-nofpu
12662 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12663 floating-point unit is not used.
12664
12665 @item -m4a-single-only
12666 @opindex m4a-single-only
12667 Generate code for the SH4a, in such a way that no double-precision
12668 floating point operations are used.
12669
12670 @item -m4a-single
12671 @opindex m4a-single
12672 Generate code for the SH4a assuming the floating-point unit is in
12673 single-precision mode by default.
12674
12675 @item -m4a
12676 @opindex m4a
12677 Generate code for the SH4a.
12678
12679 @item -m4al
12680 @opindex m4al
12681 Same as @option{-m4a-nofpu}, except that it implicitly passes
12682 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
12683 instructions at the moment.
12684
12685 @item -mb
12686 @opindex mb
12687 Compile code for the processor in big endian mode.
12688
12689 @item -ml
12690 @opindex ml
12691 Compile code for the processor in little endian mode.
12692
12693 @item -mdalign
12694 @opindex mdalign
12695 Align doubles at 64-bit boundaries.  Note that this changes the calling
12696 conventions, and thus some functions from the standard C library will
12697 not work unless you recompile it first with @option{-mdalign}.
12698
12699 @item -mrelax
12700 @opindex mrelax
12701 Shorten some address references at link time, when possible; uses the
12702 linker option @option{-relax}.
12703
12704 @item -mbigtable
12705 @opindex mbigtable
12706 Use 32-bit offsets in @code{switch} tables.  The default is to use
12707 16-bit offsets.
12708
12709 @item -mfmovd
12710 @opindex mfmovd
12711 Enable the use of the instruction @code{fmovd}.
12712
12713 @item -mhitachi
12714 @opindex mhitachi
12715 Comply with the calling conventions defined by Renesas.
12716
12717 @item -mrenesas
12718 @opindex mhitachi
12719 Comply with the calling conventions defined by Renesas.
12720
12721 @item -mno-renesas
12722 @opindex mhitachi
12723 Comply with the calling conventions defined for GCC before the Renesas
12724 conventions were available.  This option is the default for all
12725 targets of the SH toolchain except for @samp{sh-symbianelf}.
12726
12727 @item -mnomacsave
12728 @opindex mnomacsave
12729 Mark the @code{MAC} register as call-clobbered, even if
12730 @option{-mhitachi} is given.
12731
12732 @item -mieee
12733 @opindex mieee
12734 Increase IEEE-compliance of floating-point code.
12735 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12736 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12737 comparisons of NANs / infinities incurs extra overhead in every
12738 floating point comparison, therefore the default is set to
12739 @option{-ffinite-math-only}.
12740
12741 @item -minline-ic_invalidate
12742 @opindex minline-ic_invalidate
12743 Inline code to invalidate instruction cache entries after setting up
12744 nested function trampolines.
12745 This option has no effect if -musermode is in effect and the selected
12746 code generation option (e.g. -m4) does not allow the use of the icbi
12747 instruction.
12748 If the selected code generation option does not allow the use of the icbi
12749 instruction, and -musermode is not in effect, the inlined code will
12750 manipulate the instruction cache address array directly with an associative
12751 write.  This not only requires privileged mode, but it will also
12752 fail if the cache line had been mapped via the TLB and has become unmapped.
12753
12754 @item -misize
12755 @opindex misize
12756 Dump instruction size and location in the assembly code.
12757
12758 @item -mpadstruct
12759 @opindex mpadstruct
12760 This option is deprecated.  It pads structures to multiple of 4 bytes,
12761 which is incompatible with the SH ABI@.
12762
12763 @item -mspace
12764 @opindex mspace
12765 Optimize for space instead of speed.  Implied by @option{-Os}.
12766
12767 @item -mprefergot
12768 @opindex mprefergot
12769 When generating position-independent code, emit function calls using
12770 the Global Offset Table instead of the Procedure Linkage Table.
12771
12772 @item -musermode
12773 @opindex musermode
12774 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
12775 if the inlined code would not work in user mode.
12776 This is the default when the target is @code{sh-*-linux*}.
12777
12778 @item -multcost=@var{number}
12779 @opindex multcost=@var{number}
12780 Set the cost to assume for a multiply insn.
12781
12782 @item -mdiv=@var{strategy}
12783 @opindex mdiv=@var{strategy}
12784 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12785 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12786 inv:call2, inv:fp .
12787 "fp" performs the operation in floating point.  This has a very high latency,
12788 but needs only a few instructions, so it might be a good choice if
12789 your code has enough easily exploitable ILP to allow the compiler to
12790 schedule the floating point instructions together with other instructions.
12791 Division by zero causes a floating point exception.
12792 "inv" uses integer operations to calculate the inverse of the divisor,
12793 and then multiplies the dividend with the inverse.  This strategy allows
12794 cse and hoisting of the inverse calculation.  Division by zero calculates
12795 an unspecified result, but does not trap.
12796 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12797 have been found, or if the entire operation has been hoisted to the same
12798 place, the last stages of the inverse calculation are intertwined with the
12799 final multiply to reduce the overall latency, at the expense of using a few
12800 more instructions, and thus offering fewer scheduling opportunities with
12801 other code.
12802 "call" calls a library function that usually implements the inv:minlat
12803 strategy.
12804 This gives high code density for m5-*media-nofpu compilations.
12805 "call2" uses a different entry point of the same library function, where it
12806 assumes that a pointer to a lookup table has already been set up, which
12807 exposes the pointer load to cse / code hoisting optimizations.
12808 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12809 code generation, but if the code stays unoptimized, revert to the "call",
12810 "call2", or "fp" strategies, respectively.  Note that the
12811 potentially-trapping side effect of division by zero is carried by a
12812 separate instruction, so it is possible that all the integer instructions
12813 are hoisted out, but the marker for the side effect stays where it is.
12814 A recombination to fp operations or a call is not possible in that case.
12815 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12816 that the inverse calculation was nor separated from the multiply, they speed
12817 up division where the dividend fits into 20 bits (plus sign where applicable),
12818 by inserting a test to skip a number of operations in this case; this test
12819 slows down the case of larger dividends.  inv20u assumes the case of a such
12820 a small dividend to be unlikely, and inv20l assumes it to be likely.
12821
12822 @item -mdivsi3_libfunc=@var{name}
12823 @opindex mdivsi3_libfunc=@var{name}
12824 Set the name of the library function used for 32 bit signed division to
12825 @var{name}.  This only affect the name used in the call and inv:call
12826 division strategies, and the compiler will still expect the same
12827 sets of input/output/clobbered registers as if this option was not present.
12828
12829 @item -madjust-unroll
12830 @opindex madjust-unroll
12831 Throttle unrolling to avoid thrashing target registers.
12832 This option only has an effect if the gcc code base supports the
12833 TARGET_ADJUST_UNROLL_MAX target hook.
12834
12835 @item -mindexed-addressing
12836 @opindex mindexed-addressing
12837 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12838 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12839 semantics for the indexed addressing mode.  The architecture allows the
12840 implementation of processors with 64 bit MMU, which the OS could use to
12841 get 32 bit addressing, but since no current hardware implementation supports
12842 this or any other way to make the indexed addressing mode safe to use in
12843 the 32 bit ABI, the default is -mno-indexed-addressing.
12844
12845 @item -mgettrcost=@var{number}
12846 @opindex mgettrcost=@var{number}
12847 Set the cost assumed for the gettr instruction to @var{number}.
12848 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12849
12850 @item -mpt-fixed
12851 @opindex mpt-fixed
12852 Assume pt* instructions won't trap.  This will generally generate better
12853 scheduled code, but is unsafe on current hardware.  The current architecture
12854 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12855 This has the unintentional effect of making it unsafe to schedule ptabs /
12856 ptrel before a branch, or hoist it out of a loop.  For example,
12857 __do_global_ctors, a part of libgcc that runs constructors at program
12858 startup, calls functions in a list which is delimited by @minus{}1.  With the
12859 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
12860 That means that all the constructors will be run a bit quicker, but when
12861 the loop comes to the end of the list, the program crashes because ptabs
12862 loads @minus{}1 into a target register.  Since this option is unsafe for any
12863 hardware implementing the current architecture specification, the default
12864 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12865 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12866 this deters register allocation using target registers for storing
12867 ordinary integers.
12868
12869 @item -minvalid-symbols
12870 @opindex minvalid-symbols
12871 Assume symbols might be invalid.  Ordinary function symbols generated by
12872 the compiler will always be valid to load with movi/shori/ptabs or
12873 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12874 to generate symbols that will cause ptabs / ptrel to trap.
12875 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12876 It will then prevent cross-basic-block cse, hoisting and most scheduling
12877 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12878 @end table
12879
12880 @node SPARC Options
12881 @subsection SPARC Options
12882 @cindex SPARC options
12883
12884 These @samp{-m} options are supported on the SPARC:
12885
12886 @table @gcctabopt
12887 @item -mno-app-regs
12888 @itemx -mapp-regs
12889 @opindex mno-app-regs
12890 @opindex mapp-regs
12891 Specify @option{-mapp-regs} to generate output using the global registers
12892 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12893 is the default.
12894
12895 To be fully SVR4 ABI compliant at the cost of some performance loss,
12896 specify @option{-mno-app-regs}.  You should compile libraries and system
12897 software with this option.
12898
12899 @item -mfpu
12900 @itemx -mhard-float
12901 @opindex mfpu
12902 @opindex mhard-float
12903 Generate output containing floating point instructions.  This is the
12904 default.
12905
12906 @item -mno-fpu
12907 @itemx -msoft-float
12908 @opindex mno-fpu
12909 @opindex msoft-float
12910 Generate output containing library calls for floating point.
12911 @strong{Warning:} the requisite libraries are not available for all SPARC
12912 targets.  Normally the facilities of the machine's usual C compiler are
12913 used, but this cannot be done directly in cross-compilation.  You must make
12914 your own arrangements to provide suitable library functions for
12915 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12916 @samp{sparclite-*-*} do provide software floating point support.
12917
12918 @option{-msoft-float} changes the calling convention in the output file;
12919 therefore, it is only useful if you compile @emph{all} of a program with
12920 this option.  In particular, you need to compile @file{libgcc.a}, the
12921 library that comes with GCC, with @option{-msoft-float} in order for
12922 this to work.
12923
12924 @item -mhard-quad-float
12925 @opindex mhard-quad-float
12926 Generate output containing quad-word (long double) floating point
12927 instructions.
12928
12929 @item -msoft-quad-float
12930 @opindex msoft-quad-float
12931 Generate output containing library calls for quad-word (long double)
12932 floating point instructions.  The functions called are those specified
12933 in the SPARC ABI@.  This is the default.
12934
12935 As of this writing, there are no SPARC implementations that have hardware
12936 support for the quad-word floating point instructions.  They all invoke
12937 a trap handler for one of these instructions, and then the trap handler
12938 emulates the effect of the instruction.  Because of the trap handler overhead,
12939 this is much slower than calling the ABI library routines.  Thus the
12940 @option{-msoft-quad-float} option is the default.
12941
12942 @item -mno-unaligned-doubles
12943 @itemx -munaligned-doubles
12944 @opindex mno-unaligned-doubles
12945 @opindex munaligned-doubles
12946 Assume that doubles have 8 byte alignment.  This is the default.
12947
12948 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12949 alignment only if they are contained in another type, or if they have an
12950 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12951 Specifying this option avoids some rare compatibility problems with code
12952 generated by other compilers.  It is not the default because it results
12953 in a performance loss, especially for floating point code.
12954
12955 @item -mno-faster-structs
12956 @itemx -mfaster-structs
12957 @opindex mno-faster-structs
12958 @opindex mfaster-structs
12959 With @option{-mfaster-structs}, the compiler assumes that structures
12960 should have 8 byte alignment.  This enables the use of pairs of
12961 @code{ldd} and @code{std} instructions for copies in structure
12962 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12963 However, the use of this changed alignment directly violates the SPARC
12964 ABI@.  Thus, it's intended only for use on targets where the developer
12965 acknowledges that their resulting code will not be directly in line with
12966 the rules of the ABI@.
12967
12968 @item -mimpure-text
12969 @opindex mimpure-text
12970 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12971 the compiler to not pass @option{-z text} to the linker when linking a
12972 shared object.  Using this option, you can link position-dependent
12973 code into a shared object.
12974
12975 @option{-mimpure-text} suppresses the ``relocations remain against
12976 allocatable but non-writable sections'' linker error message.
12977 However, the necessary relocations will trigger copy-on-write, and the
12978 shared object is not actually shared across processes.  Instead of
12979 using @option{-mimpure-text}, you should compile all source code with
12980 @option{-fpic} or @option{-fPIC}.
12981
12982 This option is only available on SunOS and Solaris.
12983
12984 @item -mcpu=@var{cpu_type}
12985 @opindex mcpu
12986 Set the instruction set, register set, and instruction scheduling parameters
12987 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12988 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12989 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12990 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12991 @samp{ultrasparc3}, and @samp{niagara}.
12992
12993 Default instruction scheduling parameters are used for values that select
12994 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12995 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12996
12997 Here is a list of each supported architecture and their supported
12998 implementations.
12999
13000 @smallexample
13001     v7:             cypress
13002     v8:             supersparc, hypersparc
13003     sparclite:      f930, f934, sparclite86x
13004     sparclet:       tsc701
13005     v9:             ultrasparc, ultrasparc3, niagara
13006 @end smallexample
13007
13008 By default (unless configured otherwise), GCC generates code for the V7
13009 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
13010 additionally optimizes it for the Cypress CY7C602 chip, as used in the
13011 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
13012 SPARCStation 1, 2, IPX etc.
13013
13014 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
13015 architecture.  The only difference from V7 code is that the compiler emits
13016 the integer multiply and integer divide instructions which exist in SPARC-V8
13017 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
13018 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
13019 2000 series.
13020
13021 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
13022 the SPARC architecture.  This adds the integer multiply, integer divide step
13023 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
13024 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
13025 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
13026 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
13027 MB86934 chip, which is the more recent SPARClite with FPU@.
13028
13029 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
13030 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
13031 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
13032 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
13033 optimizes it for the TEMIC SPARClet chip.
13034
13035 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
13036 architecture.  This adds 64-bit integer and floating-point move instructions,
13037 3 additional floating-point condition code registers and conditional move
13038 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
13039 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
13040 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
13041 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
13042 @option{-mcpu=niagara}, the compiler additionally optimizes it for
13043 Sun UltraSPARC T1 chips.
13044
13045 @item -mtune=@var{cpu_type}
13046 @opindex mtune
13047 Set the instruction scheduling parameters for machine type
13048 @var{cpu_type}, but do not set the instruction set or register set that the
13049 option @option{-mcpu=@var{cpu_type}} would.
13050
13051 The same values for @option{-mcpu=@var{cpu_type}} can be used for
13052 @option{-mtune=@var{cpu_type}}, but the only useful values are those
13053 that select a particular cpu implementation.  Those are @samp{cypress},
13054 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
13055 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
13056 @samp{ultrasparc3}, and @samp{niagara}.
13057
13058 @item -mv8plus
13059 @itemx -mno-v8plus
13060 @opindex mv8plus
13061 @opindex mno-v8plus
13062 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
13063 difference from the V8 ABI is that the global and out registers are
13064 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
13065 mode for all SPARC-V9 processors.
13066
13067 @item -mvis
13068 @itemx -mno-vis
13069 @opindex mvis
13070 @opindex mno-vis
13071 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
13072 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
13073 @end table
13074
13075 These @samp{-m} options are supported in addition to the above
13076 on SPARC-V9 processors in 64-bit environments:
13077
13078 @table @gcctabopt
13079 @item -mlittle-endian
13080 @opindex mlittle-endian
13081 Generate code for a processor running in little-endian mode.  It is only
13082 available for a few configurations and most notably not on Solaris and Linux.
13083
13084 @item -m32
13085 @itemx -m64
13086 @opindex m32
13087 @opindex m64
13088 Generate code for a 32-bit or 64-bit environment.
13089 The 32-bit environment sets int, long and pointer to 32 bits.
13090 The 64-bit environment sets int to 32 bits and long and pointer
13091 to 64 bits.
13092
13093 @item -mcmodel=medlow
13094 @opindex mcmodel=medlow
13095 Generate code for the Medium/Low code model: 64-bit addresses, programs
13096 must be linked in the low 32 bits of memory.  Programs can be statically
13097 or dynamically linked.
13098
13099 @item -mcmodel=medmid
13100 @opindex mcmodel=medmid
13101 Generate code for the Medium/Middle code model: 64-bit addresses, programs
13102 must be linked in the low 44 bits of memory, the text and data segments must
13103 be less than 2GB in size and the data segment must be located within 2GB of
13104 the text segment.
13105
13106 @item -mcmodel=medany
13107 @opindex mcmodel=medany
13108 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
13109 may be linked anywhere in memory, the text and data segments must be less
13110 than 2GB in size and the data segment must be located within 2GB of the
13111 text segment.
13112
13113 @item -mcmodel=embmedany
13114 @opindex mcmodel=embmedany
13115 Generate code for the Medium/Anywhere code model for embedded systems:
13116 64-bit addresses, the text and data segments must be less than 2GB in
13117 size, both starting anywhere in memory (determined at link time).  The
13118 global register %g4 points to the base of the data segment.  Programs
13119 are statically linked and PIC is not supported.
13120
13121 @item -mstack-bias
13122 @itemx -mno-stack-bias
13123 @opindex mstack-bias
13124 @opindex mno-stack-bias
13125 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
13126 frame pointer if present, are offset by @minus{}2047 which must be added back
13127 when making stack frame references.  This is the default in 64-bit mode.
13128 Otherwise, assume no such offset is present.
13129 @end table
13130
13131 These switches are supported in addition to the above on Solaris:
13132
13133 @table @gcctabopt
13134 @item -threads
13135 @opindex threads
13136 Add support for multithreading using the Solaris threads library.  This
13137 option sets flags for both the preprocessor and linker.  This option does
13138 not affect the thread safety of object code produced by the compiler or
13139 that of libraries supplied with it.
13140
13141 @item -pthreads
13142 @opindex pthreads
13143 Add support for multithreading using the POSIX threads library.  This
13144 option sets flags for both the preprocessor and linker.  This option does
13145 not affect the thread safety of object code produced  by the compiler or
13146 that of libraries supplied with it.
13147
13148 @item -pthread
13149 @opindex pthread
13150 This is a synonym for @option{-pthreads}.
13151 @end table
13152
13153 @node SPU Options
13154 @subsection SPU Options
13155 @cindex SPU options
13156
13157 These @samp{-m} options are supported on the SPU:
13158
13159 @table @gcctabopt
13160 @item -mwarn-reloc
13161 @itemx -merror-reloc
13162 @opindex mwarn-reloc
13163 @opindex merror-reloc
13164
13165 The loader for SPU does not handle dynamic relocations.  By default, GCC
13166 will give an error when it generates code that requires a dynamic
13167 relocation.  @option{-mno-error-reloc} disables the error,
13168 @option{-mwarn-reloc} will generate a warning instead.
13169
13170 @item -msafe-dma
13171 @itemx -munsafe-dma
13172 @opindex msafe-dma
13173 @opindex munsafe-dma
13174
13175 Instructions which initiate or test completion of DMA must not be
13176 reordered with respect to loads and stores of the memory which is being
13177 accessed.  Users typically address this problem using the volatile
13178 keyword, but that can lead to inefficient code in places where the
13179 memory is known to not change.  Rather than mark the memory as volatile
13180 we treat the DMA instructions as potentially effecting all memory.  With
13181 @option{-munsafe-dma} users must use the volatile keyword to protect
13182 memory accesses.
13183
13184 @item -mbranch-hints
13185 @opindex mbranch-hints
13186
13187 By default, GCC will generate a branch hint instruction to avoid
13188 pipeline stalls for always taken or probably taken branches.  A hint
13189 will not be generated closer than 8 instructions away from its branch.
13190 There is little reason to disable them, except for debugging purposes,
13191 or to make an object a little bit smaller.
13192
13193 @item -msmall-mem
13194 @itemx -mlarge-mem
13195 @opindex msmall-mem
13196 @opindex mlarge-mem
13197
13198 By default, GCC generates code assuming that addresses are never larger
13199 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
13200 a full 32 bit address.
13201
13202 @item -mstdmain
13203 @opindex mstdmain
13204
13205 By default, GCC links against startup code that assumes the SPU-style
13206 main function interface (which has an unconventional parameter list).
13207 With @option{-mstdmain}, GCC will link your program against startup
13208 code that assumes a C99-style interface to @code{main}, including a
13209 local copy of @code{argv} strings.
13210
13211 @item -mfixed-range=@var{register-range}
13212 @opindex mfixed-range
13213 Generate code treating the given register range as fixed registers.
13214 A fixed register is one that the register allocator can not use.  This is
13215 useful when compiling kernel code.  A register range is specified as
13216 two registers separated by a dash.  Multiple register ranges can be
13217 specified separated by a comma.
13218
13219 @end table
13220
13221 @node System V Options
13222 @subsection Options for System V
13223
13224 These additional options are available on System V Release 4 for
13225 compatibility with other compilers on those systems:
13226
13227 @table @gcctabopt
13228 @item -G
13229 @opindex G
13230 Create a shared object.
13231 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
13232
13233 @item -Qy
13234 @opindex Qy
13235 Identify the versions of each tool used by the compiler, in a
13236 @code{.ident} assembler directive in the output.
13237
13238 @item -Qn
13239 @opindex Qn
13240 Refrain from adding @code{.ident} directives to the output file (this is
13241 the default).
13242
13243 @item -YP,@var{dirs}
13244 @opindex YP
13245 Search the directories @var{dirs}, and no others, for libraries
13246 specified with @option{-l}.
13247
13248 @item -Ym,@var{dir}
13249 @opindex Ym
13250 Look in the directory @var{dir} to find the M4 preprocessor.
13251 The assembler uses this option.
13252 @c This is supposed to go with a -Yd for predefined M4 macro files, but
13253 @c the generic assembler that comes with Solaris takes just -Ym.
13254 @end table
13255
13256 @node TMS320C3x/C4x Options
13257 @subsection TMS320C3x/C4x Options
13258 @cindex TMS320C3x/C4x Options
13259
13260 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
13261
13262 @table @gcctabopt
13263
13264 @item -mcpu=@var{cpu_type}
13265 @opindex mcpu
13266 Set the instruction set, register set, and instruction scheduling
13267 parameters for machine type @var{cpu_type}.  Supported values for
13268 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
13269 @samp{c44}.  The default is @samp{c40} to generate code for the
13270 TMS320C40.
13271
13272 @item -mbig-memory
13273 @itemx -mbig
13274 @itemx -msmall-memory
13275 @itemx -msmall
13276 @opindex mbig-memory
13277 @opindex mbig
13278 @opindex msmall-memory
13279 @opindex msmall
13280 Generates code for the big or small memory model.  The small memory
13281 model assumed that all data fits into one 64K word page.  At run-time
13282 the data page (DP) register must be set to point to the 64K page
13283 containing the .bss and .data program sections.  The big memory model is
13284 the default and requires reloading of the DP register for every direct
13285 memory access.
13286
13287 @item -mbk
13288 @itemx -mno-bk
13289 @opindex mbk
13290 @opindex mno-bk
13291 Allow (disallow) allocation of general integer operands into the block
13292 count register BK@.
13293
13294 @item -mdb
13295 @itemx -mno-db
13296 @opindex mdb
13297 @opindex mno-db
13298 Enable (disable) generation of code using decrement and branch,
13299 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
13300 on the safe side, this is disabled for the C3x, since the maximum
13301 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
13302 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
13303 that it can utilize the decrement and branch instruction, but will give
13304 up if there is more than one memory reference in the loop.  Thus a loop
13305 where the loop counter is decremented can generate slightly more
13306 efficient code, in cases where the RPTB instruction cannot be utilized.
13307
13308 @item -mdp-isr-reload
13309 @itemx -mparanoid
13310 @opindex mdp-isr-reload
13311 @opindex mparanoid
13312 Force the DP register to be saved on entry to an interrupt service
13313 routine (ISR), reloaded to point to the data section, and restored on
13314 exit from the ISR@.  This should not be required unless someone has
13315 violated the small memory model by modifying the DP register, say within
13316 an object library.
13317
13318 @item -mmpyi
13319 @itemx -mno-mpyi
13320 @opindex mmpyi
13321 @opindex mno-mpyi
13322 For the C3x use the 24-bit MPYI instruction for integer multiplies
13323 instead of a library call to guarantee 32-bit results.  Note that if one
13324 of the operands is a constant, then the multiplication will be performed
13325 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
13326 then squaring operations are performed inline instead of a library call.
13327
13328 @item -mfast-fix
13329 @itemx -mno-fast-fix
13330 @opindex mfast-fix
13331 @opindex mno-fast-fix
13332 The C3x/C4x FIX instruction to convert a floating point value to an
13333 integer value chooses the nearest integer less than or equal to the
13334 floating point value rather than to the nearest integer.  Thus if the
13335 floating point number is negative, the result will be incorrectly
13336 truncated an additional code is necessary to detect and correct this
13337 case.  This option can be used to disable generation of the additional
13338 code required to correct the result.
13339
13340 @item -mrptb
13341 @itemx -mno-rptb
13342 @opindex mrptb
13343 @opindex mno-rptb
13344 Enable (disable) generation of repeat block sequences using the RPTB
13345 instruction for zero overhead looping.  The RPTB construct is only used
13346 for innermost loops that do not call functions or jump across the loop
13347 boundaries.  There is no advantage having nested RPTB loops due to the
13348 overhead required to save and restore the RC, RS, and RE registers.
13349 This is enabled by default with @option{-O2}.
13350
13351 @item -mrpts=@var{count}
13352 @itemx -mno-rpts
13353 @opindex mrpts
13354 @opindex mno-rpts
13355 Enable (disable) the use of the single instruction repeat instruction
13356 RPTS@.  If a repeat block contains a single instruction, and the loop
13357 count can be guaranteed to be less than the value @var{count}, GCC will
13358 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
13359 then a RPTS will be emitted even if the loop count cannot be determined
13360 at compile time.  Note that the repeated instruction following RPTS does
13361 not have to be reloaded from memory each iteration, thus freeing up the
13362 CPU buses for operands.  However, since interrupts are blocked by this
13363 instruction, it is disabled by default.
13364
13365 @item -mloop-unsigned
13366 @itemx -mno-loop-unsigned
13367 @opindex mloop-unsigned
13368 @opindex mno-loop-unsigned
13369 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
13370 is @math{2^{31} + 1} since these instructions test if the iteration count is
13371 negative to terminate the loop.  If the iteration count is unsigned
13372 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
13373 exceeded.  This switch allows an unsigned iteration count.
13374
13375 @item -mti
13376 @opindex mti
13377 Try to emit an assembler syntax that the TI assembler (asm30) is happy
13378 with.  This also enforces compatibility with the API employed by the TI
13379 C3x C compiler.  For example, long doubles are passed as structures
13380 rather than in floating point registers.
13381
13382 @item -mregparm
13383 @itemx -mmemparm
13384 @opindex mregparm
13385 @opindex mmemparm
13386 Generate code that uses registers (stack) for passing arguments to functions.
13387 By default, arguments are passed in registers where possible rather
13388 than by pushing arguments on to the stack.
13389
13390 @item -mparallel-insns
13391 @itemx -mno-parallel-insns
13392 @opindex mparallel-insns
13393 @opindex mno-parallel-insns
13394 Allow the generation of parallel instructions.  This is enabled by
13395 default with @option{-O2}.
13396
13397 @item -mparallel-mpy
13398 @itemx -mno-parallel-mpy
13399 @opindex mparallel-mpy
13400 @opindex mno-parallel-mpy
13401 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
13402 provided @option{-mparallel-insns} is also specified.  These instructions have
13403 tight register constraints which can pessimize the code generation
13404 of large functions.
13405
13406 @end table
13407
13408 @node V850 Options
13409 @subsection V850 Options
13410 @cindex V850 Options
13411
13412 These @samp{-m} options are defined for V850 implementations:
13413
13414 @table @gcctabopt
13415 @item -mlong-calls
13416 @itemx -mno-long-calls
13417 @opindex mlong-calls
13418 @opindex mno-long-calls
13419 Treat all calls as being far away (near).  If calls are assumed to be
13420 far away, the compiler will always load the functions address up into a
13421 register, and call indirect through the pointer.
13422
13423 @item -mno-ep
13424 @itemx -mep
13425 @opindex mno-ep
13426 @opindex mep
13427 Do not optimize (do optimize) basic blocks that use the same index
13428 pointer 4 or more times to copy pointer into the @code{ep} register, and
13429 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
13430 option is on by default if you optimize.
13431
13432 @item -mno-prolog-function
13433 @itemx -mprolog-function
13434 @opindex mno-prolog-function
13435 @opindex mprolog-function
13436 Do not use (do use) external functions to save and restore registers
13437 at the prologue and epilogue of a function.  The external functions
13438 are slower, but use less code space if more than one function saves
13439 the same number of registers.  The @option{-mprolog-function} option
13440 is on by default if you optimize.
13441
13442 @item -mspace
13443 @opindex mspace
13444 Try to make the code as small as possible.  At present, this just turns
13445 on the @option{-mep} and @option{-mprolog-function} options.
13446
13447 @item -mtda=@var{n}
13448 @opindex mtda
13449 Put static or global variables whose size is @var{n} bytes or less into
13450 the tiny data area that register @code{ep} points to.  The tiny data
13451 area can hold up to 256 bytes in total (128 bytes for byte references).
13452
13453 @item -msda=@var{n}
13454 @opindex msda
13455 Put static or global variables whose size is @var{n} bytes or less into
13456 the small data area that register @code{gp} points to.  The small data
13457 area can hold up to 64 kilobytes.
13458
13459 @item -mzda=@var{n}
13460 @opindex mzda
13461 Put static or global variables whose size is @var{n} bytes or less into
13462 the first 32 kilobytes of memory.
13463
13464 @item -mv850
13465 @opindex mv850
13466 Specify that the target processor is the V850.
13467
13468 @item -mbig-switch
13469 @opindex mbig-switch
13470 Generate code suitable for big switch tables.  Use this option only if
13471 the assembler/linker complain about out of range branches within a switch
13472 table.
13473
13474 @item -mapp-regs
13475 @opindex mapp-regs
13476 This option will cause r2 and r5 to be used in the code generated by
13477 the compiler.  This setting is the default.
13478
13479 @item -mno-app-regs
13480 @opindex mno-app-regs
13481 This option will cause r2 and r5 to be treated as fixed registers.
13482
13483 @item -mv850e1
13484 @opindex mv850e1
13485 Specify that the target processor is the V850E1.  The preprocessor
13486 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
13487 this option is used.
13488
13489 @item -mv850e
13490 @opindex mv850e
13491 Specify that the target processor is the V850E@.  The preprocessor
13492 constant @samp{__v850e__} will be defined if this option is used.
13493
13494 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13495 are defined then a default target processor will be chosen and the
13496 relevant @samp{__v850*__} preprocessor constant will be defined.
13497
13498 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13499 defined, regardless of which processor variant is the target.
13500
13501 @item -mdisable-callt
13502 @opindex mdisable-callt
13503 This option will suppress generation of the CALLT instruction for the
13504 v850e and v850e1 flavors of the v850 architecture.  The default is
13505 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
13506
13507 @end table
13508
13509 @node VAX Options
13510 @subsection VAX Options
13511 @cindex VAX options
13512
13513 These @samp{-m} options are defined for the VAX:
13514
13515 @table @gcctabopt
13516 @item -munix
13517 @opindex munix
13518 Do not output certain jump instructions (@code{aobleq} and so on)
13519 that the Unix assembler for the VAX cannot handle across long
13520 ranges.
13521
13522 @item -mgnu
13523 @opindex mgnu
13524 Do output those jump instructions, on the assumption that you
13525 will assemble with the GNU assembler.
13526
13527 @item -mg
13528 @opindex mg
13529 Output code for g-format floating point numbers instead of d-format.
13530 @end table
13531
13532 @node x86-64 Options
13533 @subsection x86-64 Options
13534 @cindex x86-64 options
13535
13536 These are listed under @xref{i386 and x86-64 Options}.
13537
13538 @node Xstormy16 Options
13539 @subsection Xstormy16 Options
13540 @cindex Xstormy16 Options
13541
13542 These options are defined for Xstormy16:
13543
13544 @table @gcctabopt
13545 @item -msim
13546 @opindex msim
13547 Choose startup files and linker script suitable for the simulator.
13548 @end table
13549
13550 @node Xtensa Options
13551 @subsection Xtensa Options
13552 @cindex Xtensa Options
13553
13554 These options are supported for Xtensa targets:
13555
13556 @table @gcctabopt
13557 @item -mconst16
13558 @itemx -mno-const16
13559 @opindex mconst16
13560 @opindex mno-const16
13561 Enable or disable use of @code{CONST16} instructions for loading
13562 constant values.  The @code{CONST16} instruction is currently not a
13563 standard option from Tensilica.  When enabled, @code{CONST16}
13564 instructions are always used in place of the standard @code{L32R}
13565 instructions.  The use of @code{CONST16} is enabled by default only if
13566 the @code{L32R} instruction is not available.
13567
13568 @item -mfused-madd
13569 @itemx -mno-fused-madd
13570 @opindex mfused-madd
13571 @opindex mno-fused-madd
13572 Enable or disable use of fused multiply/add and multiply/subtract
13573 instructions in the floating-point option.  This has no effect if the
13574 floating-point option is not also enabled.  Disabling fused multiply/add
13575 and multiply/subtract instructions forces the compiler to use separate
13576 instructions for the multiply and add/subtract operations.  This may be
13577 desirable in some cases where strict IEEE 754-compliant results are
13578 required: the fused multiply add/subtract instructions do not round the
13579 intermediate result, thereby producing results with @emph{more} bits of
13580 precision than specified by the IEEE standard.  Disabling fused multiply
13581 add/subtract instructions also ensures that the program output is not
13582 sensitive to the compiler's ability to combine multiply and add/subtract
13583 operations.
13584
13585 @item -mtext-section-literals
13586 @itemx -mno-text-section-literals
13587 @opindex mtext-section-literals
13588 @opindex mno-text-section-literals
13589 Control the treatment of literal pools.  The default is
13590 @option{-mno-text-section-literals}, which places literals in a separate
13591 section in the output file.  This allows the literal pool to be placed
13592 in a data RAM/ROM, and it also allows the linker to combine literal
13593 pools from separate object files to remove redundant literals and
13594 improve code size.  With @option{-mtext-section-literals}, the literals
13595 are interspersed in the text section in order to keep them as close as
13596 possible to their references.  This may be necessary for large assembly
13597 files.
13598
13599 @item -mtarget-align
13600 @itemx -mno-target-align
13601 @opindex mtarget-align
13602 @opindex mno-target-align
13603 When this option is enabled, GCC instructs the assembler to
13604 automatically align instructions to reduce branch penalties at the
13605 expense of some code density.  The assembler attempts to widen density
13606 instructions to align branch targets and the instructions following call
13607 instructions.  If there are not enough preceding safe density
13608 instructions to align a target, no widening will be performed.  The
13609 default is @option{-mtarget-align}.  These options do not affect the
13610 treatment of auto-aligned instructions like @code{LOOP}, which the
13611 assembler will always align, either by widening density instructions or
13612 by inserting no-op instructions.
13613
13614 @item -mlongcalls
13615 @itemx -mno-longcalls
13616 @opindex mlongcalls
13617 @opindex mno-longcalls
13618 When this option is enabled, GCC instructs the assembler to translate
13619 direct calls to indirect calls unless it can determine that the target
13620 of a direct call is in the range allowed by the call instruction.  This
13621 translation typically occurs for calls to functions in other source
13622 files.  Specifically, the assembler translates a direct @code{CALL}
13623 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13624 The default is @option{-mno-longcalls}.  This option should be used in
13625 programs where the call target can potentially be out of range.  This
13626 option is implemented in the assembler, not the compiler, so the
13627 assembly code generated by GCC will still show direct call
13628 instructions---look at the disassembled object code to see the actual
13629 instructions.  Note that the assembler will use an indirect call for
13630 every cross-file call, not just those that really will be out of range.
13631 @end table
13632
13633 @node zSeries Options
13634 @subsection zSeries Options
13635 @cindex zSeries options
13636
13637 These are listed under @xref{S/390 and zSeries Options}.
13638
13639 @node Code Gen Options
13640 @section Options for Code Generation Conventions
13641 @cindex code generation conventions
13642 @cindex options, code generation
13643 @cindex run-time options
13644
13645 These machine-independent options control the interface conventions
13646 used in code generation.
13647
13648 Most of them have both positive and negative forms; the negative form
13649 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
13650 one of the forms is listed---the one which is not the default.  You
13651 can figure out the other form by either removing @samp{no-} or adding
13652 it.
13653
13654 @table @gcctabopt
13655 @item -fbounds-check
13656 @opindex fbounds-check
13657 For front-ends that support it, generate additional code to check that
13658 indices used to access arrays are within the declared range.  This is
13659 currently only supported by the Java and Fortran front-ends, where
13660 this option defaults to true and false respectively.
13661
13662 @item -ftrapv
13663 @opindex ftrapv
13664 This option generates traps for signed overflow on addition, subtraction,
13665 multiplication operations.
13666
13667 @item -fwrapv
13668 @opindex fwrapv
13669 This option instructs the compiler to assume that signed arithmetic
13670 overflow of addition, subtraction and multiplication wraps around
13671 using twos-complement representation.  This flag enables some optimizations
13672 and disables others.  This option is enabled by default for the Java
13673 front-end, as required by the Java language specification.
13674
13675 @item -fexceptions
13676 @opindex fexceptions
13677 Enable exception handling.  Generates extra code needed to propagate
13678 exceptions.  For some targets, this implies GCC will generate frame
13679 unwind information for all functions, which can produce significant data
13680 size overhead, although it does not affect execution.  If you do not
13681 specify this option, GCC will enable it by default for languages like
13682 C++ which normally require exception handling, and disable it for
13683 languages like C that do not normally require it.  However, you may need
13684 to enable this option when compiling C code that needs to interoperate
13685 properly with exception handlers written in C++.  You may also wish to
13686 disable this option if you are compiling older C++ programs that don't
13687 use exception handling.
13688
13689 @item -fnon-call-exceptions
13690 @opindex fnon-call-exceptions
13691 Generate code that allows trapping instructions to throw exceptions.
13692 Note that this requires platform-specific runtime support that does
13693 not exist everywhere.  Moreover, it only allows @emph{trapping}
13694 instructions to throw exceptions, i.e.@: memory references or floating
13695 point instructions.  It does not allow exceptions to be thrown from
13696 arbitrary signal handlers such as @code{SIGALRM}.
13697
13698 @item -funwind-tables
13699 @opindex funwind-tables
13700 Similar to @option{-fexceptions}, except that it will just generate any needed
13701 static data, but will not affect the generated code in any other way.
13702 You will normally not enable this option; instead, a language processor
13703 that needs this handling would enable it on your behalf.
13704
13705 @item -fasynchronous-unwind-tables
13706 @opindex fasynchronous-unwind-tables
13707 Generate unwind table in dwarf2 format, if supported by target machine.  The
13708 table is exact at each instruction boundary, so it can be used for stack
13709 unwinding from asynchronous events (such as debugger or garbage collector).
13710
13711 @item -fpcc-struct-return
13712 @opindex fpcc-struct-return
13713 Return ``short'' @code{struct} and @code{union} values in memory like
13714 longer ones, rather than in registers.  This convention is less
13715 efficient, but it has the advantage of allowing intercallability between
13716 GCC-compiled files and files compiled with other compilers, particularly
13717 the Portable C Compiler (pcc).
13718
13719 The precise convention for returning structures in memory depends
13720 on the target configuration macros.
13721
13722 Short structures and unions are those whose size and alignment match
13723 that of some integer type.
13724
13725 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13726 switch is not binary compatible with code compiled with the
13727 @option{-freg-struct-return} switch.
13728 Use it to conform to a non-default application binary interface.
13729
13730 @item -freg-struct-return
13731 @opindex freg-struct-return
13732 Return @code{struct} and @code{union} values in registers when possible.
13733 This is more efficient for small structures than
13734 @option{-fpcc-struct-return}.
13735
13736 If you specify neither @option{-fpcc-struct-return} nor
13737 @option{-freg-struct-return}, GCC defaults to whichever convention is
13738 standard for the target.  If there is no standard convention, GCC
13739 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13740 the principal compiler.  In those cases, we can choose the standard, and
13741 we chose the more efficient register return alternative.
13742
13743 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13744 switch is not binary compatible with code compiled with the
13745 @option{-fpcc-struct-return} switch.
13746 Use it to conform to a non-default application binary interface.
13747
13748 @item -fshort-enums
13749 @opindex fshort-enums
13750 Allocate to an @code{enum} type only as many bytes as it needs for the
13751 declared range of possible values.  Specifically, the @code{enum} type
13752 will be equivalent to the smallest integer type which has enough room.
13753
13754 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13755 code that is not binary compatible with code generated without that switch.
13756 Use it to conform to a non-default application binary interface.
13757
13758 @item -fshort-double
13759 @opindex fshort-double
13760 Use the same size for @code{double} as for @code{float}.
13761
13762 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13763 code that is not binary compatible with code generated without that switch.
13764 Use it to conform to a non-default application binary interface.
13765
13766 @item -fshort-wchar
13767 @opindex fshort-wchar
13768 Override the underlying type for @samp{wchar_t} to be @samp{short
13769 unsigned int} instead of the default for the target.  This option is
13770 useful for building programs to run under WINE@.
13771
13772 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13773 code that is not binary compatible with code generated without that switch.
13774 Use it to conform to a non-default application binary interface.
13775
13776 @item -fno-common
13777 @opindex fno-common
13778 In C, allocate even uninitialized global variables in the data section of the
13779 object file, rather than generating them as common blocks.  This has the
13780 effect that if the same variable is declared (without @code{extern}) in
13781 two different compilations, you will get an error when you link them.
13782 The only reason this might be useful is if you wish to verify that the
13783 program will work on other systems which always work this way.
13784
13785 @item -fno-ident
13786 @opindex fno-ident
13787 Ignore the @samp{#ident} directive.
13788
13789 @item -finhibit-size-directive
13790 @opindex finhibit-size-directive
13791 Don't output a @code{.size} assembler directive, or anything else that
13792 would cause trouble if the function is split in the middle, and the
13793 two halves are placed at locations far apart in memory.  This option is
13794 used when compiling @file{crtstuff.c}; you should not need to use it
13795 for anything else.
13796
13797 @item -fverbose-asm
13798 @opindex fverbose-asm
13799 Put extra commentary information in the generated assembly code to
13800 make it more readable.  This option is generally only of use to those
13801 who actually need to read the generated assembly code (perhaps while
13802 debugging the compiler itself).
13803
13804 @option{-fno-verbose-asm}, the default, causes the
13805 extra information to be omitted and is useful when comparing two assembler
13806 files.
13807
13808 @item -frecord-gcc-switches
13809 @opindex frecord-gcc-switches
13810 This switch causes the command line that was used to invoke the
13811 compiler to be recorded into the object file that is being created.
13812 This switch is only implemented on some targets and the exact format
13813 of the recording is target and binary file format dependent, but it
13814 usually takes the form of a section containing ASCII text.  This
13815 switch is related to the @option{-fverbose-asm} switch, but that
13816 switch only records information in the assembler output file as
13817 comments, so it never reaches the object file.
13818
13819 @item -fpic
13820 @opindex fpic
13821 @cindex global offset table
13822 @cindex PIC
13823 Generate position-independent code (PIC) suitable for use in a shared
13824 library, if supported for the target machine.  Such code accesses all
13825 constant addresses through a global offset table (GOT)@.  The dynamic
13826 loader resolves the GOT entries when the program starts (the dynamic
13827 loader is not part of GCC; it is part of the operating system).  If
13828 the GOT size for the linked executable exceeds a machine-specific
13829 maximum size, you get an error message from the linker indicating that
13830 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13831 instead.  (These maximums are 8k on the SPARC and 32k
13832 on the m68k and RS/6000.  The 386 has no such limit.)
13833
13834 Position-independent code requires special support, and therefore works
13835 only on certain machines.  For the 386, GCC supports PIC for System V
13836 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13837 position-independent.
13838
13839 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13840 are defined to 1.
13841
13842 @item -fPIC
13843 @opindex fPIC
13844 If supported for the target machine, emit position-independent code,
13845 suitable for dynamic linking and avoiding any limit on the size of the
13846 global offset table.  This option makes a difference on the m68k,
13847 PowerPC and SPARC@.
13848
13849 Position-independent code requires special support, and therefore works
13850 only on certain machines.
13851
13852 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13853 are defined to 2.
13854
13855 @item -fpie
13856 @itemx -fPIE
13857 @opindex fpie
13858 @opindex fPIE
13859 These options are similar to @option{-fpic} and @option{-fPIC}, but
13860 generated position independent code can be only linked into executables.
13861 Usually these options are used when @option{-pie} GCC option will be
13862 used during linking.
13863
13864 @item -fno-jump-tables
13865 @opindex fno-jump-tables
13866 Do not use jump tables for switch statements even where it would be
13867 more efficient than other code generation strategies.  This option is
13868 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13869 building code which forms part of a dynamic linker and cannot
13870 reference the address of a jump table.  On some targets, jump tables
13871 do not require a GOT and this option is not needed.
13872
13873 @item -ffixed-@var{reg}
13874 @opindex ffixed
13875 Treat the register named @var{reg} as a fixed register; generated code
13876 should never refer to it (except perhaps as a stack pointer, frame
13877 pointer or in some other fixed role).
13878
13879 @var{reg} must be the name of a register.  The register names accepted
13880 are machine-specific and are defined in the @code{REGISTER_NAMES}
13881 macro in the machine description macro file.
13882
13883 This flag does not have a negative form, because it specifies a
13884 three-way choice.
13885
13886 @item -fcall-used-@var{reg}
13887 @opindex fcall-used
13888 Treat the register named @var{reg} as an allocable register that is
13889 clobbered by function calls.  It may be allocated for temporaries or
13890 variables that do not live across a call.  Functions compiled this way
13891 will not save and restore the register @var{reg}.
13892
13893 It is an error to used this flag with the frame pointer or stack pointer.
13894 Use of this flag for other registers that have fixed pervasive roles in
13895 the machine's execution model will produce disastrous results.
13896
13897 This flag does not have a negative form, because it specifies a
13898 three-way choice.
13899
13900 @item -fcall-saved-@var{reg}
13901 @opindex fcall-saved
13902 Treat the register named @var{reg} as an allocable register saved by
13903 functions.  It may be allocated even for temporaries or variables that
13904 live across a call.  Functions compiled this way will save and restore
13905 the register @var{reg} if they use it.
13906
13907 It is an error to used this flag with the frame pointer or stack pointer.
13908 Use of this flag for other registers that have fixed pervasive roles in
13909 the machine's execution model will produce disastrous results.
13910
13911 A different sort of disaster will result from the use of this flag for
13912 a register in which function values may be returned.
13913
13914 This flag does not have a negative form, because it specifies a
13915 three-way choice.
13916
13917 @item -fpack-struct[=@var{n}]
13918 @opindex fpack-struct
13919 Without a value specified, pack all structure members together without
13920 holes.  When a value is specified (which must be a small power of two), pack
13921 structure members according to this value, representing the maximum
13922 alignment (that is, objects with default alignment requirements larger than
13923 this will be output potentially unaligned at the next fitting location.
13924
13925 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13926 code that is not binary compatible with code generated without that switch.
13927 Additionally, it makes the code suboptimal.
13928 Use it to conform to a non-default application binary interface.
13929
13930 @item -finstrument-functions
13931 @opindex finstrument-functions
13932 Generate instrumentation calls for entry and exit to functions.  Just
13933 after function entry and just before function exit, the following
13934 profiling functions will be called with the address of the current
13935 function and its call site.  (On some platforms,
13936 @code{__builtin_return_address} does not work beyond the current
13937 function, so the call site information may not be available to the
13938 profiling functions otherwise.)
13939
13940 @smallexample
13941 void __cyg_profile_func_enter (void *this_fn,
13942                                void *call_site);
13943 void __cyg_profile_func_exit  (void *this_fn,
13944                                void *call_site);
13945 @end smallexample
13946
13947 The first argument is the address of the start of the current function,
13948 which may be looked up exactly in the symbol table.
13949
13950 This instrumentation is also done for functions expanded inline in other
13951 functions.  The profiling calls will indicate where, conceptually, the
13952 inline function is entered and exited.  This means that addressable
13953 versions of such functions must be available.  If all your uses of a
13954 function are expanded inline, this may mean an additional expansion of
13955 code size.  If you use @samp{extern inline} in your C code, an
13956 addressable version of such functions must be provided.  (This is
13957 normally the case anyways, but if you get lucky and the optimizer always
13958 expands the functions inline, you might have gotten away without
13959 providing static copies.)
13960
13961 A function may be given the attribute @code{no_instrument_function}, in
13962 which case this instrumentation will not be done.  This can be used, for
13963 example, for the profiling functions listed above, high-priority
13964 interrupt routines, and any functions from which the profiling functions
13965 cannot safely be called (perhaps signal handlers, if the profiling
13966 routines generate output or allocate memory).
13967
13968 @item -fstack-check
13969 @opindex fstack-check
13970 Generate code to verify that you do not go beyond the boundary of the
13971 stack.  You should specify this flag if you are running in an
13972 environment with multiple threads, but only rarely need to specify it in
13973 a single-threaded environment since stack overflow is automatically
13974 detected on nearly all systems if there is only one stack.
13975
13976 Note that this switch does not actually cause checking to be done; the
13977 operating system must do that.  The switch causes generation of code
13978 to ensure that the operating system sees the stack being extended.
13979
13980 @item -fstack-limit-register=@var{reg}
13981 @itemx -fstack-limit-symbol=@var{sym}
13982 @itemx -fno-stack-limit
13983 @opindex fstack-limit-register
13984 @opindex fstack-limit-symbol
13985 @opindex fno-stack-limit
13986 Generate code to ensure that the stack does not grow beyond a certain value,
13987 either the value of a register or the address of a symbol.  If the stack
13988 would grow beyond the value, a signal is raised.  For most targets,
13989 the signal is raised before the stack overruns the boundary, so
13990 it is possible to catch the signal without taking special precautions.
13991
13992 For instance, if the stack starts at absolute address @samp{0x80000000}
13993 and grows downwards, you can use the flags
13994 @option{-fstack-limit-symbol=__stack_limit} and
13995 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13996 of 128KB@.  Note that this may only work with the GNU linker.
13997
13998 @cindex aliasing of parameters
13999 @cindex parameters, aliased
14000 @item -fargument-alias
14001 @itemx -fargument-noalias
14002 @itemx -fargument-noalias-global
14003 @itemx -fargument-noalias-anything
14004 @opindex fargument-alias
14005 @opindex fargument-noalias
14006 @opindex fargument-noalias-global
14007 @opindex fargument-noalias-anything
14008 Specify the possible relationships among parameters and between
14009 parameters and global data.
14010
14011 @option{-fargument-alias} specifies that arguments (parameters) may
14012 alias each other and may alias global storage.@*
14013 @option{-fargument-noalias} specifies that arguments do not alias
14014 each other, but may alias global storage.@*
14015 @option{-fargument-noalias-global} specifies that arguments do not
14016 alias each other and do not alias global storage.
14017 @option{-fargument-noalias-anything} specifies that arguments do not
14018 alias any other storage.
14019
14020 Each language will automatically use whatever option is required by
14021 the language standard.  You should not need to use these options yourself.
14022
14023 @item -fleading-underscore
14024 @opindex fleading-underscore
14025 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
14026 change the way C symbols are represented in the object file.  One use
14027 is to help link with legacy assembly code.
14028
14029 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
14030 generate code that is not binary compatible with code generated without that
14031 switch.  Use it to conform to a non-default application binary interface.
14032 Not all targets provide complete support for this switch.
14033
14034 @item -ftls-model=@var{model}
14035 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
14036 The @var{model} argument should be one of @code{global-dynamic},
14037 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
14038
14039 The default without @option{-fpic} is @code{initial-exec}; with
14040 @option{-fpic} the default is @code{global-dynamic}.
14041
14042 @item -fvisibility=@var{default|internal|hidden|protected}
14043 @opindex fvisibility
14044 Set the default ELF image symbol visibility to the specified option---all
14045 symbols will be marked with this unless overridden within the code.
14046 Using this feature can very substantially improve linking and
14047 load times of shared object libraries, produce more optimized
14048 code, provide near-perfect API export and prevent symbol clashes.
14049 It is @strong{strongly} recommended that you use this in any shared objects
14050 you distribute.
14051
14052 Despite the nomenclature, @code{default} always means public ie;
14053 available to be linked against from outside the shared object.
14054 @code{protected} and @code{internal} are pretty useless in real-world
14055 usage so the only other commonly used option will be @code{hidden}.
14056 The default if @option{-fvisibility} isn't specified is
14057 @code{default}, i.e., make every
14058 symbol public---this causes the same behavior as previous versions of
14059 GCC@.
14060
14061 A good explanation of the benefits offered by ensuring ELF
14062 symbols have the correct visibility is given by ``How To Write
14063 Shared Libraries'' by Ulrich Drepper (which can be found at
14064 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
14065 solution made possible by this option to marking things hidden when
14066 the default is public is to make the default hidden and mark things
14067 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
14068 and @code{__attribute__ ((visibility("default")))} instead of
14069 @code{__declspec(dllexport)} you get almost identical semantics with
14070 identical syntax.  This is a great boon to those working with
14071 cross-platform projects.
14072
14073 For those adding visibility support to existing code, you may find
14074 @samp{#pragma GCC visibility} of use.  This works by you enclosing
14075 the declarations you wish to set visibility for with (for example)
14076 @samp{#pragma GCC visibility push(hidden)} and
14077 @samp{#pragma GCC visibility pop}.
14078 Bear in mind that symbol visibility should be viewed @strong{as
14079 part of the API interface contract} and thus all new code should
14080 always specify visibility when it is not the default ie; declarations
14081 only for use within the local DSO should @strong{always} be marked explicitly
14082 as hidden as so to avoid PLT indirection overheads---making this
14083 abundantly clear also aids readability and self-documentation of the code.
14084 Note that due to ISO C++ specification requirements, operator new and
14085 operator delete must always be of default visibility.
14086
14087 Be aware that headers from outside your project, in particular system
14088 headers and headers from any other library you use, may not be
14089 expecting to be compiled with visibility other than the default.  You
14090 may need to explicitly say @samp{#pragma GCC visibility push(default)}
14091 before including any such headers.
14092
14093 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
14094 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
14095 no modifications.  However, this means that calls to @samp{extern}
14096 functions with no explicit visibility will use the PLT, so it is more
14097 effective to use @samp{__attribute ((visibility))} and/or
14098 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
14099 declarations should be treated as hidden.
14100
14101 Note that @samp{-fvisibility} does affect C++ vague linkage
14102 entities. This means that, for instance, an exception class that will
14103 be thrown between DSOs must be explicitly marked with default
14104 visibility so that the @samp{type_info} nodes will be unified between
14105 the DSOs.
14106
14107 An overview of these techniques, their benefits and how to use them
14108 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
14109
14110 @end table
14111
14112 @c man end
14113
14114 @node Environment Variables
14115 @section Environment Variables Affecting GCC
14116 @cindex environment variables
14117
14118 @c man begin ENVIRONMENT
14119 This section describes several environment variables that affect how GCC
14120 operates.  Some of them work by specifying directories or prefixes to use
14121 when searching for various kinds of files.  Some are used to specify other
14122 aspects of the compilation environment.
14123
14124 Note that you can also specify places to search using options such as
14125 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
14126 take precedence over places specified using environment variables, which
14127 in turn take precedence over those specified by the configuration of GCC@.
14128 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
14129 GNU Compiler Collection (GCC) Internals}.
14130
14131 @table @env
14132 @item LANG
14133 @itemx LC_CTYPE
14134 @c @itemx LC_COLLATE
14135 @itemx LC_MESSAGES
14136 @c @itemx LC_MONETARY
14137 @c @itemx LC_NUMERIC
14138 @c @itemx LC_TIME
14139 @itemx LC_ALL
14140 @findex LANG
14141 @findex LC_CTYPE
14142 @c @findex LC_COLLATE
14143 @findex LC_MESSAGES
14144 @c @findex LC_MONETARY
14145 @c @findex LC_NUMERIC
14146 @c @findex LC_TIME
14147 @findex LC_ALL
14148 @cindex locale
14149 These environment variables control the way that GCC uses
14150 localization information that allow GCC to work with different
14151 national conventions.  GCC inspects the locale categories
14152 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
14153 so.  These locale categories can be set to any value supported by your
14154 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
14155 Kingdom encoded in UTF-8.
14156
14157 The @env{LC_CTYPE} environment variable specifies character
14158 classification.  GCC uses it to determine the character boundaries in
14159 a string; this is needed for some multibyte encodings that contain quote
14160 and escape characters that would otherwise be interpreted as a string
14161 end or escape.
14162
14163 The @env{LC_MESSAGES} environment variable specifies the language to
14164 use in diagnostic messages.
14165
14166 If the @env{LC_ALL} environment variable is set, it overrides the value
14167 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
14168 and @env{LC_MESSAGES} default to the value of the @env{LANG}
14169 environment variable.  If none of these variables are set, GCC
14170 defaults to traditional C English behavior.
14171
14172 @item TMPDIR
14173 @findex TMPDIR
14174 If @env{TMPDIR} is set, it specifies the directory to use for temporary
14175 files.  GCC uses temporary files to hold the output of one stage of
14176 compilation which is to be used as input to the next stage: for example,
14177 the output of the preprocessor, which is the input to the compiler
14178 proper.
14179
14180 @item GCC_EXEC_PREFIX
14181 @findex GCC_EXEC_PREFIX
14182 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
14183 names of the subprograms executed by the compiler.  No slash is added
14184 when this prefix is combined with the name of a subprogram, but you can
14185 specify a prefix that ends with a slash if you wish.
14186
14187 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
14188 an appropriate prefix to use based on the pathname it was invoked with.
14189
14190 If GCC cannot find the subprogram using the specified prefix, it
14191 tries looking in the usual places for the subprogram.
14192
14193 The default value of @env{GCC_EXEC_PREFIX} is
14194 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
14195 the installed compiler. In many cases @var{prefix} is the value
14196 of @code{prefix} when you ran the @file{configure} script.
14197
14198 Other prefixes specified with @option{-B} take precedence over this prefix.
14199
14200 This prefix is also used for finding files such as @file{crt0.o} that are
14201 used for linking.
14202
14203 In addition, the prefix is used in an unusual way in finding the
14204 directories to search for header files.  For each of the standard
14205 directories whose name normally begins with @samp{/usr/local/lib/gcc}
14206 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
14207 replacing that beginning with the specified prefix to produce an
14208 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
14209 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
14210 These alternate directories are searched first; the standard directories
14211 come next. If a standard directory begins with the configured 
14212 @var{prefix} then the value of @var{prefix} is replaced by 
14213 @env{GCC_EXEC_PREFIX} when looking for header files.
14214
14215 @item COMPILER_PATH
14216 @findex COMPILER_PATH
14217 The value of @env{COMPILER_PATH} is a colon-separated list of
14218 directories, much like @env{PATH}.  GCC tries the directories thus
14219 specified when searching for subprograms, if it can't find the
14220 subprograms using @env{GCC_EXEC_PREFIX}.
14221
14222 @item LIBRARY_PATH
14223 @findex LIBRARY_PATH
14224 The value of @env{LIBRARY_PATH} is a colon-separated list of
14225 directories, much like @env{PATH}.  When configured as a native compiler,
14226 GCC tries the directories thus specified when searching for special
14227 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
14228 using GCC also uses these directories when searching for ordinary
14229 libraries for the @option{-l} option (but directories specified with
14230 @option{-L} come first).
14231
14232 @item LANG
14233 @findex LANG
14234 @cindex locale definition
14235 This variable is used to pass locale information to the compiler.  One way in
14236 which this information is used is to determine the character set to be used
14237 when character literals, string literals and comments are parsed in C and C++.
14238 When the compiler is configured to allow multibyte characters,
14239 the following values for @env{LANG} are recognized:
14240
14241 @table @samp
14242 @item C-JIS
14243 Recognize JIS characters.
14244 @item C-SJIS
14245 Recognize SJIS characters.
14246 @item C-EUCJP
14247 Recognize EUCJP characters.
14248 @end table
14249
14250 If @env{LANG} is not defined, or if it has some other value, then the
14251 compiler will use mblen and mbtowc as defined by the default locale to
14252 recognize and translate multibyte characters.
14253 @end table
14254
14255 @noindent
14256 Some additional environments variables affect the behavior of the
14257 preprocessor.
14258
14259 @include cppenv.texi
14260
14261 @c man end
14262
14263 @node Precompiled Headers
14264 @section Using Precompiled Headers
14265 @cindex precompiled headers
14266 @cindex speed of compilation
14267
14268 Often large projects have many header files that are included in every
14269 source file.  The time the compiler takes to process these header files
14270 over and over again can account for nearly all of the time required to
14271 build the project.  To make builds faster, GCC allows users to
14272 `precompile' a header file; then, if builds can use the precompiled
14273 header file they will be much faster.
14274
14275 To create a precompiled header file, simply compile it as you would any
14276 other file, if necessary using the @option{-x} option to make the driver
14277 treat it as a C or C++ header file.  You will probably want to use a
14278 tool like @command{make} to keep the precompiled header up-to-date when
14279 the headers it contains change.
14280
14281 A precompiled header file will be searched for when @code{#include} is
14282 seen in the compilation.  As it searches for the included file
14283 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
14284 compiler looks for a precompiled header in each directory just before it
14285 looks for the include file in that directory.  The name searched for is
14286 the name specified in the @code{#include} with @samp{.gch} appended.  If
14287 the precompiled header file can't be used, it is ignored.
14288
14289 For instance, if you have @code{#include "all.h"}, and you have
14290 @file{all.h.gch} in the same directory as @file{all.h}, then the
14291 precompiled header file will be used if possible, and the original
14292 header will be used otherwise.
14293
14294 Alternatively, you might decide to put the precompiled header file in a
14295 directory and use @option{-I} to ensure that directory is searched
14296 before (or instead of) the directory containing the original header.
14297 Then, if you want to check that the precompiled header file is always
14298 used, you can put a file of the same name as the original header in this
14299 directory containing an @code{#error} command.
14300
14301 This also works with @option{-include}.  So yet another way to use
14302 precompiled headers, good for projects not designed with precompiled
14303 header files in mind, is to simply take most of the header files used by
14304 a project, include them from another header file, precompile that header
14305 file, and @option{-include} the precompiled header.  If the header files
14306 have guards against multiple inclusion, they will be skipped because
14307 they've already been included (in the precompiled header).
14308
14309 If you need to precompile the same header file for different
14310 languages, targets, or compiler options, you can instead make a
14311 @emph{directory} named like @file{all.h.gch}, and put each precompiled
14312 header in the directory, perhaps using @option{-o}.  It doesn't matter
14313 what you call the files in the directory, every precompiled header in
14314 the directory will be considered.  The first precompiled header
14315 encountered in the directory that is valid for this compilation will
14316 be used; they're searched in no particular order.
14317
14318 There are many other possibilities, limited only by your imagination,
14319 good sense, and the constraints of your build system.
14320
14321 A precompiled header file can be used only when these conditions apply:
14322
14323 @itemize
14324 @item
14325 Only one precompiled header can be used in a particular compilation.
14326
14327 @item
14328 A precompiled header can't be used once the first C token is seen.  You
14329 can have preprocessor directives before a precompiled header; you can
14330 even include a precompiled header from inside another header, so long as
14331 there are no C tokens before the @code{#include}.
14332
14333 @item
14334 The precompiled header file must be produced for the same language as
14335 the current compilation.  You can't use a C precompiled header for a C++
14336 compilation.
14337
14338 @item
14339 The precompiled header file must have been produced by the same compiler
14340 binary as the current compilation is using.
14341
14342 @item
14343 Any macros defined before the precompiled header is included must
14344 either be defined in the same way as when the precompiled header was
14345 generated, or must not affect the precompiled header, which usually
14346 means that they don't appear in the precompiled header at all.
14347
14348 The @option{-D} option is one way to define a macro before a
14349 precompiled header is included; using a @code{#define} can also do it.
14350 There are also some options that define macros implicitly, like
14351 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
14352 defined this way.
14353
14354 @item If debugging information is output when using the precompiled
14355 header, using @option{-g} or similar, the same kind of debugging information
14356 must have been output when building the precompiled header.  However,
14357 a precompiled header built using @option{-g} can be used in a compilation
14358 when no debugging information is being output.
14359
14360 @item The same @option{-m} options must generally be used when building
14361 and using the precompiled header.  @xref{Submodel Options},
14362 for any cases where this rule is relaxed.
14363
14364 @item Each of the following options must be the same when building and using
14365 the precompiled header:
14366
14367 @gccoptlist{-fexceptions -funit-at-a-time}
14368
14369 @item
14370 Some other command-line options starting with @option{-f},
14371 @option{-p}, or @option{-O} must be defined in the same way as when
14372 the precompiled header was generated.  At present, it's not clear
14373 which options are safe to change and which are not; the safest choice
14374 is to use exactly the same options when generating and using the
14375 precompiled header.  The following are known to be safe:
14376
14377 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
14378 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
14379 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
14380 -pedantic-errors}
14381
14382 @end itemize
14383
14384 For all of these except the last, the compiler will automatically
14385 ignore the precompiled header if the conditions aren't met.  If you
14386 find an option combination that doesn't work and doesn't cause the
14387 precompiled header to be ignored, please consider filing a bug report,
14388 see @ref{Bugs}.
14389
14390 If you do use differing options when generating and using the
14391 precompiled header, the actual behavior will be a mixture of the
14392 behavior for the options.  For instance, if you use @option{-g} to
14393 generate the precompiled header but not when using it, you may or may
14394 not get debugging information for routines in the precompiled header.
14395
14396 @node Running Protoize
14397 @section Running Protoize
14398
14399 The program @code{protoize} is an optional part of GCC@.  You can use
14400 it to add prototypes to a program, thus converting the program to ISO
14401 C in one respect.  The companion program @code{unprotoize} does the
14402 reverse: it removes argument types from any prototypes that are found.
14403
14404 When you run these programs, you must specify a set of source files as
14405 command line arguments.  The conversion programs start out by compiling
14406 these files to see what functions they define.  The information gathered
14407 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
14408
14409 After scanning comes actual conversion.  The specified files are all
14410 eligible to be converted; any files they include (whether sources or
14411 just headers) are eligible as well.
14412
14413 But not all the eligible files are converted.  By default,
14414 @code{protoize} and @code{unprotoize} convert only source and header
14415 files in the current directory.  You can specify additional directories
14416 whose files should be converted with the @option{-d @var{directory}}
14417 option.  You can also specify particular files to exclude with the
14418 @option{-x @var{file}} option.  A file is converted if it is eligible, its
14419 directory name matches one of the specified directory names, and its
14420 name within the directory has not been excluded.
14421
14422 Basic conversion with @code{protoize} consists of rewriting most
14423 function definitions and function declarations to specify the types of
14424 the arguments.  The only ones not rewritten are those for varargs
14425 functions.
14426
14427 @code{protoize} optionally inserts prototype declarations at the
14428 beginning of the source file, to make them available for any calls that
14429 precede the function's definition.  Or it can insert prototype
14430 declarations with block scope in the blocks where undeclared functions
14431 are called.
14432
14433 Basic conversion with @code{unprotoize} consists of rewriting most
14434 function declarations to remove any argument types, and rewriting
14435 function definitions to the old-style pre-ISO form.
14436
14437 Both conversion programs print a warning for any function declaration or
14438 definition that they can't convert.  You can suppress these warnings
14439 with @option{-q}.
14440
14441 The output from @code{protoize} or @code{unprotoize} replaces the
14442 original source file.  The original file is renamed to a name ending
14443 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
14444 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
14445 for DOS) file already exists, then the source file is simply discarded.
14446
14447 @code{protoize} and @code{unprotoize} both depend on GCC itself to
14448 scan the program and collect information about the functions it uses.
14449 So neither of these programs will work until GCC is installed.
14450
14451 Here is a table of the options you can use with @code{protoize} and
14452 @code{unprotoize}.  Each option works with both programs unless
14453 otherwise stated.
14454
14455 @table @code
14456 @item -B @var{directory}
14457 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
14458 usual directory (normally @file{/usr/local/lib}).  This file contains
14459 prototype information about standard system functions.  This option
14460 applies only to @code{protoize}.
14461
14462 @item -c @var{compilation-options}
14463 Use @var{compilation-options} as the options when running @command{gcc} to
14464 produce the @samp{.X} files.  The special option @option{-aux-info} is
14465 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
14466
14467 Note that the compilation options must be given as a single argument to
14468 @code{protoize} or @code{unprotoize}.  If you want to specify several
14469 @command{gcc} options, you must quote the entire set of compilation options
14470 to make them a single word in the shell.
14471
14472 There are certain @command{gcc} arguments that you cannot use, because they
14473 would produce the wrong kind of output.  These include @option{-g},
14474 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
14475 the @var{compilation-options}, they are ignored.
14476
14477 @item -C
14478 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
14479 systems) instead of @samp{.c}.  This is convenient if you are converting
14480 a C program to C++.  This option applies only to @code{protoize}.
14481
14482 @item -g
14483 Add explicit global declarations.  This means inserting explicit
14484 declarations at the beginning of each source file for each function
14485 that is called in the file and was not declared.  These declarations
14486 precede the first function definition that contains a call to an
14487 undeclared function.  This option applies only to @code{protoize}.
14488
14489 @item -i @var{string}
14490 Indent old-style parameter declarations with the string @var{string}.
14491 This option applies only to @code{protoize}.
14492
14493 @code{unprotoize} converts prototyped function definitions to old-style
14494 function definitions, where the arguments are declared between the
14495 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
14496 uses five spaces as the indentation.  If you want to indent with just
14497 one space instead, use @option{-i " "}.
14498
14499 @item -k
14500 Keep the @samp{.X} files.  Normally, they are deleted after conversion
14501 is finished.
14502
14503 @item -l
14504 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
14505 a prototype declaration for each function in each block which calls the
14506 function without any declaration.  This option applies only to
14507 @code{protoize}.
14508
14509 @item -n
14510 Make no real changes.  This mode just prints information about the conversions
14511 that would have been done without @option{-n}.
14512
14513 @item -N
14514 Make no @samp{.save} files.  The original files are simply deleted.
14515 Use this option with caution.
14516
14517 @item -p @var{program}
14518 Use the program @var{program} as the compiler.  Normally, the name
14519 @file{gcc} is used.
14520
14521 @item -q
14522 Work quietly.  Most warnings are suppressed.
14523
14524 @item -v
14525 Print the version number, just like @option{-v} for @command{gcc}.
14526 @end table
14527
14528 If you need special compiler options to compile one of your program's
14529 source files, then you should generate that file's @samp{.X} file
14530 specially, by running @command{gcc} on that source file with the
14531 appropriate options and the option @option{-aux-info}.  Then run
14532 @code{protoize} on the entire set of files.  @code{protoize} will use
14533 the existing @samp{.X} file because it is newer than the source file.
14534 For example:
14535
14536 @smallexample
14537 gcc -Dfoo=bar file1.c -aux-info file1.X
14538 protoize *.c
14539 @end smallexample
14540
14541 @noindent
14542 You need to include the special files along with the rest in the
14543 @code{protoize} command, even though their @samp{.X} files already
14544 exist, because otherwise they won't get converted.
14545
14546 @xref{Protoize Caveats}, for more information on how to use
14547 @code{protoize} successfully.