OSDN Git Service

PR c/3190
[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 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
61
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
67
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
74
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
79
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
86
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
90
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
97
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
104
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
111
112 @c man end
113
114 @xref{Option Index}, for an index to GCC's options.
115
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char @gol
170 -fwritable-strings}
171
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs  -fexternal-templates @gol
178 -falt-external-templates @gol
179 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
180 -fno-implicit-templates @gol
181 -fno-implicit-inline-templates @gol
182 -fno-implement-inlines  -fms-extensions @gol
183 -fno-nonansi-builtins  -fno-operator-names @gol
184 -fno-optional-diags  -fpermissive @gol
185 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
186 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
187 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
193
194 @item Objective-C Language Options
195 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
205
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -Wextra  -Wall  -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
218 -Werror  -Werror-implicit-function-declaration @gol
219 -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security  -Wformat-y2k @gol
222 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
223 -Wimport  -Wno-import  -Winit-self  -Winline @gol
224 -Wno-invalid-offsetof  -Winvalid-pch @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces @gol
227 -Wmissing-format-attribute  -Wmissing-noreturn @gol
228 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
229 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
230 -Wreturn-type  -Wsequence-point  -Wshadow @gol
231 -Wsign-compare  -Wstrict-aliasing @gol
232 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
233 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
234 -Wunknown-pragmas  -Wunreachable-code @gol
235 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
236 -Wunused-value  -Wunused-variable  -Wwrite-strings}
237
238 @item C-only Warning Options
239 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
240 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
241 -Wstrict-prototypes  -Wtraditional @gol
242 -Wdeclaration-after-statement}
243
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
247 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
248 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
250 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
251 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
252 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
253 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
254 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
255 -ftest-coverage  -ftime-report @gol
256 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
257 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
258 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
259 -print-multi-directory  -print-multi-lib @gol
260 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
261 -save-temps  -time}
262
263 @item Optimization Options
264 @xref{Optimize Options,,Options that Control Optimization}.
265 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
266 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
267 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
268 -fbranch-target-load-optimize2 -fcaller-saves  -fcprop-registers @gol
269 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
270 -fdelayed-branch  -fdelete-null-pointer-checks @gol
271 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
272 -fforce-addr  -fforce-mem  -ffunction-sections @gol
273 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -floop-optimize @gol
274 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
275 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
276 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
277 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
278 -fno-default-inline  -fno-defer-pop @gol
279 -fno-function-cse  -fno-guess-branch-probability @gol
280 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
281 -funsafe-math-optimizations  -ffinite-math-only @gol
282 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
283 -fomit-frame-pointer  -foptimize-register-move @gol
284 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
285 -freduce-all-givs  -fregmove  -frename-registers @gol
286 -freorder-blocks  -freorder-functions @gol
287 -frerun-cse-after-loop  -frerun-loop-opt @gol
288 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
289 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
290 -fsched-spec-load-dangerous  @gol
291 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
292 -fsched2-use-superblocks @gol
293 -fsched2-use-traces  -fsignaling-nans @gol
294 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
295 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
296 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
297 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
298 --param @var{name}=@var{value}
299 -O  -O0  -O1  -O2  -O3  -Os}
300
301 @item Preprocessor Options
302 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
303 @gccoptlist{-A@var{question}=@var{answer} @gol
304 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
305 -C  -dD  -dI  -dM  -dN @gol
306 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
307 -idirafter @var{dir} @gol
308 -include @var{file}  -imacros @var{file} @gol
309 -iprefix @var{file}  -iwithprefix @var{dir} @gol
310 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
311 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
312 -P  -fworking-directory  -remap @gol
313 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
314 -Xpreprocessor @var{option}}
315
316 @item Assembler Option
317 @xref{Assembler Options,,Passing Options to the Assembler}.
318 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
319
320 @item Linker Options
321 @xref{Link Options,,Options for Linking}.
322 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
323 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
324 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
325 -Wl,@var{option}  -Xlinker @var{option} @gol
326 -u @var{symbol}}
327
328 @item Directory Options
329 @xref{Directory Options,,Options for Directory Search}.
330 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
331
332 @item Target Options
333 @c I wrote this xref this way to avoid overfull hbox. -- rms
334 @xref{Target Options}.
335 @gccoptlist{-V @var{version}  -b @var{machine}}
336
337 @item Machine Dependent Options
338 @xref{Submodel Options,,Hardware Models and Configurations}.
339
340 @emph{M680x0 Options}
341 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
342 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
343 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
344 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
345 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
346
347 @emph{M68hc1x Options}
348 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
349 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
350 -msoft-reg-count=@var{count}}
351
352 @emph{VAX Options}
353 @gccoptlist{-mg  -mgnu  -munix}
354
355 @emph{SPARC Options}
356 @gccoptlist{-mcpu=@var{cpu-type} @gol
357 -mtune=@var{cpu-type} @gol
358 -mcmodel=@var{code-model} @gol
359 -m32  -m64 @gol
360 -mapp-regs  -mbroken-saverestore  -mcypress @gol
361 -mfaster-structs  -mflat @gol
362 -mfpu  -mhard-float  -mhard-quad-float @gol
363 -mimpure-text  -mlittle-endian  -mlive-g0  -mno-app-regs @gol
364 -mno-faster-structs  -mno-flat  -mno-fpu @gol
365 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
366 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
367 -msupersparc  -munaligned-doubles  -mv8}
368
369 @emph{ARM Options}
370 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
371 -mapcs-26  -mapcs-32 @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -malignment-traps  -mno-alignment-traps @gol
378 -msoft-float  -mhard-float  -mfpe @gol
379 -mthumb-interwork  -mno-thumb-interwork @gol
380 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
381 -mstructure-size-boundary=@var{n} @gol
382 -mabort-on-noreturn @gol
383 -mlong-calls  -mno-long-calls @gol
384 -msingle-pic-base  -mno-single-pic-base @gol
385 -mpic-register=@var{reg} @gol
386 -mnop-fun-dllimport @gol
387 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
388 -mpoke-function-name @gol
389 -mthumb  -marm @gol
390 -mtpcs-frame  -mtpcs-leaf-frame @gol
391 -mcaller-super-interworking  -mcallee-super-interworking}
392
393 @emph{MN10200 Options}
394 @gccoptlist{-mrelax}
395
396 @emph{MN10300 Options}
397 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
398 -mam33  -mno-am33 @gol
399 -mam33-2  -mno-am33-2 @gol
400 -mno-crt0  -mrelax}
401
402 @emph{M32R/D Options}
403 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
404 -msdata=@var{sdata-type}  -G @var{num}}
405
406 @emph{M88K Options}
407 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
408 -mcheck-zero-division  -mhandle-large-shift @gol
409 -midentify-revision  -mno-check-zero-division @gol
410 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
411 -mno-optimize-arg-area  -mno-serialize-volatile @gol
412 -mno-underscores  -mocs-debug-info @gol
413 -mocs-frame-position  -moptimize-arg-area @gol
414 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
415 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
416 -mversion-03.00  -mwarn-passed-structs}
417
418 @emph{RS/6000 and PowerPC Options}
419 @gccoptlist{-mcpu=@var{cpu-type} @gol
420 -mtune=@var{cpu-type} @gol
421 -mpower  -mno-power  -mpower2  -mno-power2 @gol
422 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
423 -maltivec  -mno-altivec @gol
424 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
425 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
426 -mnew-mnemonics  -mold-mnemonics @gol
427 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
428 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
429 -malign-power  -malign-natural @gol
430 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
431 -mstring  -mno-string  -mupdate  -mno-update @gol
432 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
433 -mstrict-align  -mno-strict-align  -mrelocatable @gol
434 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
435 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
436 -mdynamic-no-pic @gol
437 -mprioritize-restricted-insns=@var{priority} @gol
438 -msched-costly-dep=@var{dependence_type} @gol
439 -minsert-sched-nops=@var{scheme} @gol
440 -mcall-sysv  -mcall-netbsd @gol
441 -maix-struct-return  -msvr4-struct-return @gol
442 -mabi=altivec  -mabi=no-altivec @gol
443 -mabi=spe  -mabi=no-spe @gol
444 -misel=yes  -misel=no @gol
445 -mspe=yes  -mspe=no @gol
446 -mfloat-gprs=yes  -mfloat-gprs=no @gol
447 -mprototype  -mno-prototype @gol
448 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
449 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
450
451 @emph{Darwin Options}
452 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
453 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
454 -client_name  -compatibility_version  -current_version @gol
455 -dependency-file  -dylib_file  -dylinker_install_name @gol
456 -dynamic  -dynamiclib  -exported_symbols_list @gol
457 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
458 -force_flat_namespace  -headerpad_max_install_names @gol
459 -image_base  -init  -install_name  -keep_private_externs @gol
460 -multi_module  -multiply_defined  -multiply_defined_unused @gol
461 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
462 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
463 -private_bundle  -read_only_relocs  -sectalign @gol
464 -sectobjectsymbols  -whyload  -seg1addr @gol
465 -sectcreate  -sectobjectsymbols  -sectorder @gol
466 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
467 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
468 -single_module  -static  -sub_library  -sub_umbrella @gol
469 -twolevel_namespace  -umbrella  -undefined @gol
470 -unexported_symbols_list  -weak_reference_mismatches @gol
471 -whatsloaded}
472
473 @emph{RT Options}
474 @gccoptlist{-mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
475 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
476 -mminimum-fp-blocks  -mnohc-struct-return}
477
478 @emph{MIPS Options}
479 @gccoptlist{-mabicalls  -march=@var{cpu-type}  -mtune=@var{cpu=type} @gol
480 -mcpu=@var{cpu-type}  -membedded-data  -muninit-const-in-rodata @gol
481 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
482 -mgas  -mgp32  -mgp64  -mhard-float  -mint64  -mips1 @gol
483 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
484 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
485 -mmips-as  -mmips-tfile  -mno-abicalls  -mxgot @gol
486 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
487 -mno-embedded-pic  -mno-long-calls @gol
488 -mno-memcpy  -mno-mips-tfile  -mno-rnames @gol
489 -mrnames  -msoft-float @gol
490 -m4650  -msingle-float  -mmad @gol
491 -EL  -EB  -G @var{num}  -nocpp @gol
492 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
493 -mfix7000  -mfix-sb1  -mno-fix-sb1 @gol
494 -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
495 -mbranch-likely -mno-branch-likely}
496
497 @emph{i386 and x86-64 Options}
498 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
499 -mfpmath=@var{unit} @gol
500 -masm=@var{dialect}  -mno-fancy-math-387 @gol
501 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
502 -mno-wide-multiply  -mrtd  -malign-double @gol
503 -mpreferred-stack-boundary=@var{num} @gol
504 -mmmx  -msse  -msse2 -mpni -m3dnow @gol
505 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
506 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
507 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
508 -mno-red-zone -mno-tls-direct-seg-refs @gol
509 -mcmodel=@var{code-model} @gol
510 -m32  -m64}
511
512 @emph{HPPA Options}
513 @gccoptlist{-march=@var{architecture-type} @gol
514 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
515 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
516 -mjump-in-delay -mlinker-opt -mlong-calls @gol
517 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
518 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
519 -mno-jump-in-delay  -mno-long-load-store @gol
520 -mno-portable-runtime  -mno-soft-float @gol
521 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
522 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
523 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
524 -nolibdld  -static  -threads}
525
526 @emph{Intel 960 Options}
527 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
528 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
529 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
530 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
531 -mno-complex-addr  -mno-leaf-procedures @gol
532 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
533 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
534 -mtail-call}
535
536 @emph{DEC Alpha Options}
537 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
538 -mieee  -mieee-with-inexact  -mieee-conformant @gol
539 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
540 -mtrap-precision=@var{mode}  -mbuild-constants @gol
541 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
542 -mbwx  -mmax  -mfix  -mcix @gol
543 -mfloat-vax  -mfloat-ieee @gol
544 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
545 -msmall-text  -mlarge-text @gol
546 -mmemory-latency=@var{time}}
547
548 @emph{DEC Alpha/VMS Options}
549 @gccoptlist{-mvms-return-codes}
550
551 @emph{H8/300 Options}
552 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
553
554 @emph{SH Options}
555 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
556 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
557 -m5-64media  -m5-64media-nofpu @gol
558 -m5-32media  -m5-32media-nofpu @gol
559 -m5-compact  -m5-compact-nofpu @gol
560 -mb  -ml  -mdalign  -mrelax @gol
561 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
562 -mieee  -misize  -mpadstruct  -mspace @gol
563 -mprefergot  -musermode}
564
565 @emph{System V Options}
566 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
567
568 @emph{ARC Options}
569 @gccoptlist{-EB  -EL @gol
570 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
571 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
572
573 @emph{TMS320C3x/C4x Options}
574 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
575 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
576 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
577 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
578
579 @emph{V850 Options}
580 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
581 -mprolog-function  -mno-prolog-function  -mspace @gol
582 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
583 -mapp-regs  -mno-app-regs @gol
584 -mdisable-callt  -mno-disable-callt @gol
585 -mv850e1 @gol
586 -mv850e @gol
587 -mv850  -mbig-switch}
588
589 @emph{NS32K Options}
590 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
591 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
592 -mregparam  -mnoregparam  -msb  -mnosb @gol
593 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
594
595 @emph{AVR Options}
596 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
597 -mcall-prologues  -mno-tablejump  -mtiny-stack}
598
599 @emph{MCore Options}
600 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
601 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
602 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
603 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
604 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
605
606 @emph{MMIX Options}
607 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
608 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
609 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
610 -mno-base-addresses  -msingle-exit  -mno-single-exit}
611
612 @emph{IA-64 Options}
613 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
614 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
615 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
616 -minline-float-divide-max-throughput @gol
617 -minline-int-divide-min-latency @gol
618 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
619 -mfixed-range=@var{register-range}}
620
621 @emph{D30V Options}
622 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
623 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
624
625 @emph{S/390 and zSeries Options}
626 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
627 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
628 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
629 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch  -mfused-madd  -mno-fused-madd}
630
631 @emph{CRIS Options}
632 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
633 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
634 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
635 -mstack-align  -mdata-align  -mconst-align @gol
636 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
637 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
638
639 @emph{PDP-11 Options}
640 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
641 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
642 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
643 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
644 -mbranch-expensive  -mbranch-cheap @gol
645 -msplit  -mno-split  -munix-asm  -mdec-asm}
646
647 @emph{Xstormy16 Options}
648 @gccoptlist{-msim}
649
650 @emph{Xtensa Options}
651 @gccoptlist{-mconst16 -mno-const16 @gol
652 -mfused-madd  -mno-fused-madd @gol
653 -mtext-section-literals  -mno-text-section-literals @gol
654 -mtarget-align  -mno-target-align @gol
655 -mlongcalls  -mno-longcalls}
656
657 @emph{FRV Options}
658 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
659 -mhard-float  -msoft-float @gol
660 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
661 -mdouble  -mno-double @gol
662 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
663 -mlibrary-pic  -macc-4 -macc-8 @gol
664 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
665 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
666 -mvliw-branch  -mno-vliw-branch @gol
667 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
668 -mno-nested-cond-exec  -mtomcat-stats @gol
669 -mcpu=@var{cpu}}
670
671 @item Code Generation Options
672 @xref{Code Gen Options,,Options for Code Generation Conventions}.
673 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
674 -ffixed-@var{reg}  -fexceptions @gol
675 -fnon-call-exceptions  -funwind-tables @gol
676 -fasynchronous-unwind-tables @gol
677 -finhibit-size-directive  -finstrument-functions @gol
678 -fno-common  -fno-ident  -fno-gnu-linker @gol
679 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
680 -freg-struct-return  -fshared-data  -fshort-enums @gol
681 -fshort-double  -fshort-wchar @gol
682 -fverbose-asm  -fpack-struct  -fstack-check @gol
683 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
684 -fargument-alias  -fargument-noalias @gol
685 -fargument-noalias-global  -fleading-underscore @gol
686 -ftls-model=@var{model} @gol
687 -ftrapv  -fwrapv  -fbounds-check}
688 @end table
689
690 @menu
691 * Overall Options::     Controlling the kind of output:
692                         an executable, object files, assembler files,
693                         or preprocessed source.
694 * C Dialect Options::   Controlling the variant of C language compiled.
695 * C++ Dialect Options:: Variations on C++.
696 * Objective-C Dialect Options:: Variations on Objective-C.
697 * Language Independent Options:: Controlling how diagnostics should be
698                         formatted.
699 * Warning Options::     How picky should the compiler be?
700 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
701 * Optimize Options::    How much optimization?
702 * Preprocessor Options:: Controlling header files and macro definitions.
703                          Also, getting dependency information for Make.
704 * Assembler Options::   Passing options to the assembler.
705 * Link Options::        Specifying libraries and so on.
706 * Directory Options::   Where to find header files and libraries.
707                         Where to find the compiler executable files.
708 * Spec Files::          How to pass switches to sub-processes.
709 * Target Options::      Running a cross-compiler, or an old version of GCC.
710 @end menu
711
712 @node Overall Options
713 @section Options Controlling the Kind of Output
714
715 Compilation can involve up to four stages: preprocessing, compilation
716 proper, assembly and linking, always in that order.  GCC is capable of
717 preprocessing and compiling several files either into several
718 assembler input files, or into one assembler input file; then each
719 assembler input file produces an object file, and linking combines all
720 the object files (those newly compiled, and those specified as input)
721 into an executable file.
722
723 @cindex file name suffix
724 For any given input file, the file name suffix determines what kind of
725 compilation is done:
726
727 @table @gcctabopt
728 @item @var{file}.c
729 C source code which must be preprocessed.
730
731 @item @var{file}.i
732 C source code which should not be preprocessed.
733
734 @item @var{file}.ii
735 C++ source code which should not be preprocessed.
736
737 @item @var{file}.m
738 Objective-C source code.  Note that you must link with the library
739 @file{libobjc.a} to make an Objective-C program work.
740
741 @item @var{file}.mi
742 Objective-C source code which should not be preprocessed.
743
744 @item @var{file}.h
745 C or C++ header file to be turned into a precompiled header.
746
747 @item @var{file}.cc
748 @itemx @var{file}.cp
749 @itemx @var{file}.cxx
750 @itemx @var{file}.cpp
751 @itemx @var{file}.CPP
752 @itemx @var{file}.c++
753 @itemx @var{file}.C
754 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
755 the last two letters must both be literally @samp{x}.  Likewise,
756 @samp{.C} refers to a literal capital C@.
757
758 @item @var{file}.hh
759 @itemx @var{file}.H
760 C++ header file to be turned into a precompiled header.
761
762 @item @var{file}.f
763 @itemx @var{file}.for
764 @itemx @var{file}.FOR
765 Fortran source code which should not be preprocessed.
766
767 @item @var{file}.F
768 @itemx @var{file}.fpp
769 @itemx @var{file}.FPP
770 Fortran source code which must be preprocessed (with the traditional
771 preprocessor).
772
773 @item @var{file}.r
774 Fortran source code which must be preprocessed with a RATFOR
775 preprocessor (not included with GCC)@.
776
777 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
778 Using and Porting GNU Fortran}, for more details of the handling of
779 Fortran input files.
780
781 @c FIXME: Descriptions of Java file types.
782 @c @var{file}.java
783 @c @var{file}.class
784 @c @var{file}.zip
785 @c @var{file}.jar
786
787 @item @var{file}.ads
788 Ada source code file which contains a library unit declaration (a
789 declaration of a package, subprogram, or generic, or a generic
790 instantiation), or a library unit renaming declaration (a package,
791 generic, or subprogram renaming declaration).  Such files are also
792 called @dfn{specs}.
793
794 @itemx @var{file}.adb
795 Ada source code file containing a library unit body (a subprogram or
796 package body).  Such files are also called @dfn{bodies}.
797
798 @c GCC also knows about some suffixes for languages not yet included:
799 @c Pascal:
800 @c @var{file}.p
801 @c @var{file}.pas
802
803 @item @var{file}.s
804 Assembler code.
805
806 @item @var{file}.S
807 Assembler code which must be preprocessed.
808
809 @item @var{other}
810 An object file to be fed straight into linking.
811 Any file name with no recognized suffix is treated this way.
812 @end table
813
814 @opindex x
815 You can specify the input language explicitly with the @option{-x} option:
816
817 @table @gcctabopt
818 @item -x @var{language}
819 Specify explicitly the @var{language} for the following input files
820 (rather than letting the compiler choose a default based on the file
821 name suffix).  This option applies to all following input files until
822 the next @option{-x} option.  Possible values for @var{language} are:
823 @example
824 c  c-header  cpp-output
825 c++  c++-header  c++-cpp-output
826 objective-c  objective-c-header  objc-cpp-output
827 assembler  assembler-with-cpp
828 ada
829 f77  f77-cpp-input  ratfor
830 java
831 treelang
832 @end example
833
834 @item -x none
835 Turn off any specification of a language, so that subsequent files are
836 handled according to their file name suffixes (as they are if @option{-x}
837 has not been used at all).
838
839 @item -pass-exit-codes
840 @opindex pass-exit-codes
841 Normally the @command{gcc} program will exit with the code of 1 if any
842 phase of the compiler returns a non-success return code.  If you specify
843 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
844 numerically highest error produced by any phase that returned an error
845 indication.
846 @end table
847
848 If you only want some of the stages of compilation, you can use
849 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
850 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
851 @command{gcc} is to stop.  Note that some combinations (for example,
852 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
853
854 @table @gcctabopt
855 @item -c
856 @opindex c
857 Compile or assemble the source files, but do not link.  The linking
858 stage simply is not done.  The ultimate output is in the form of an
859 object file for each source file.
860
861 By default, the object file name for a source file is made by replacing
862 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
863
864 Unrecognized input files, not requiring compilation or assembly, are
865 ignored.
866
867 @item -S
868 @opindex S
869 Stop after the stage of compilation proper; do not assemble.  The output
870 is in the form of an assembler code file for each non-assembler input
871 file specified.
872
873 By default, the assembler file name for a source file is made by
874 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
875
876 Input files that don't require compilation are ignored.
877
878 @item -E
879 @opindex E
880 Stop after the preprocessing stage; do not run the compiler proper.  The
881 output is in the form of preprocessed source code, which is sent to the
882 standard output.
883
884 Input files which don't require preprocessing are ignored.
885
886 @cindex output file option
887 @item -o @var{file}
888 @opindex o
889 Place output in file @var{file}.  This applies regardless to whatever
890 sort of output is being produced, whether it be an executable file,
891 an object file, an assembler file or preprocessed C code.
892
893 If you specify @option{-o} when compiling more than one input file, or
894 you are producing an executable file as output, all the source files
895 on the command line will be compiled at once.
896
897 If @option{-o} is not specified, the default is to put an executable file
898 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
899 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
900 all preprocessed C source on standard output.
901
902 @item -v
903 @opindex v
904 Print (on standard error output) the commands executed to run the stages
905 of compilation.  Also print the version number of the compiler driver
906 program and of the preprocessor and the compiler proper.
907
908 @item -###
909 @opindex ###
910 Like @option{-v} except the commands are not executed and all command
911 arguments are quoted.  This is useful for shell scripts to capture the
912 driver-generated command lines.
913
914 @item -pipe
915 @opindex pipe
916 Use pipes rather than temporary files for communication between the
917 various stages of compilation.  This fails to work on some systems where
918 the assembler is unable to read from a pipe; but the GNU assembler has
919 no trouble.
920
921 @item --help
922 @opindex help
923 Print (on the standard output) a description of the command line options
924 understood by @command{gcc}.  If the @option{-v} option is also specified
925 then @option{--help} will also be passed on to the various processes
926 invoked by @command{gcc}, so that they can display the command line options
927 they accept.  If the @option{-Wextra} option is also specified then command
928 line options which have no documentation associated with them will also
929 be displayed.
930
931 @item --target-help
932 @opindex target-help
933 Print (on the standard output) a description of target specific command
934 line options for each tool.
935
936 @item --version
937 @opindex version
938 Display the version number and copyrights of the invoked GCC.
939 @end table
940
941 @node Invoking G++
942 @section Compiling C++ Programs
943
944 @cindex suffixes for C++ source
945 @cindex C++ source file suffixes
946 C++ source files conventionally use one of the suffixes @samp{.C},
947 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
948 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
949 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
950 files with these names and compiles them as C++ programs even if you
951 call the compiler the same way as for compiling C programs (usually
952 with the name @command{gcc}).
953
954 @findex g++
955 @findex c++
956 However, C++ programs often require class libraries as well as a
957 compiler that understands the C++ language---and under some
958 circumstances, you might want to compile programs or header files from
959 standard input, or otherwise without a suffix that flags them as C++
960 programs.  You might also like to precompile a C header file with a
961 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
962 program that calls GCC with the default language set to C++, and
963 automatically specifies linking against the C++ library.  On many
964 systems, @command{g++} is also installed with the name @command{c++}.
965
966 @cindex invoking @command{g++}
967 When you compile C++ programs, you may specify many of the same
968 command-line options that you use for compiling programs in any
969 language; or command-line options meaningful for C and related
970 languages; or options that are meaningful only for C++ programs.
971 @xref{C Dialect Options,,Options Controlling C Dialect}, for
972 explanations of options for languages related to C@.
973 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
974 explanations of options that are meaningful only for C++ programs.
975
976 @node C Dialect Options
977 @section Options Controlling C Dialect
978 @cindex dialect options
979 @cindex language dialect options
980 @cindex options, dialect
981
982 The following options control the dialect of C (or languages derived
983 from C, such as C++ and Objective-C) that the compiler accepts:
984
985 @table @gcctabopt
986 @cindex ANSI support
987 @cindex ISO support
988 @item -ansi
989 @opindex ansi
990 In C mode, support all ISO C90 programs.  In C++ mode,
991 remove GNU extensions that conflict with ISO C++.
992
993 This turns off certain features of GCC that are incompatible with ISO
994 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
995 such as the @code{asm} and @code{typeof} keywords, and
996 predefined macros such as @code{unix} and @code{vax} that identify the
997 type of system you are using.  It also enables the undesirable and
998 rarely used ISO trigraph feature.  For the C compiler,
999 it disables recognition of C++ style @samp{//} comments as well as
1000 the @code{inline} keyword.
1001
1002 The alternate keywords @code{__asm__}, @code{__extension__},
1003 @code{__inline__} and @code{__typeof__} continue to work despite
1004 @option{-ansi}.  You would not want to use them in an ISO C program, of
1005 course, but it is useful to put them in header files that might be included
1006 in compilations done with @option{-ansi}.  Alternate predefined macros
1007 such as @code{__unix__} and @code{__vax__} are also available, with or
1008 without @option{-ansi}.
1009
1010 The @option{-ansi} option does not cause non-ISO programs to be
1011 rejected gratuitously.  For that, @option{-pedantic} is required in
1012 addition to @option{-ansi}.  @xref{Warning Options}.
1013
1014 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1015 option is used.  Some header files may notice this macro and refrain
1016 from declaring certain functions or defining certain macros that the
1017 ISO standard doesn't call for; this is to avoid interfering with any
1018 programs that might use these names for other things.
1019
1020 Functions which would normally be built in but do not have semantics
1021 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1022 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1023 built-in functions provided by GCC}, for details of the functions
1024 affected.
1025
1026 @item -std=
1027 @opindex std
1028 Determine the language standard.  This option is currently only
1029 supported when compiling C or C++.  A value for this option must be
1030 provided; possible values are
1031
1032 @table @samp
1033 @item c89
1034 @itemx iso9899:1990
1035 ISO C90 (same as @option{-ansi}).
1036
1037 @item iso9899:199409
1038 ISO C90 as modified in amendment 1.
1039
1040 @item c99
1041 @itemx c9x
1042 @itemx iso9899:1999
1043 @itemx iso9899:199x
1044 ISO C99.  Note that this standard is not yet fully supported; see
1045 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1046 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1047
1048 @item gnu89
1049 Default, ISO C90 plus GNU extensions (including some C99 features).
1050
1051 @item gnu99
1052 @item gnu9x
1053 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1054 this will become the default.  The name @samp{gnu9x} is deprecated.
1055
1056 @item c++98
1057 The 1998 ISO C++ standard plus amendments.
1058
1059 @item gnu++98
1060 The same as @option{-std=c++98} plus GNU extensions.  This is the
1061 default for C++ code.
1062 @end table
1063
1064 Even when this option is not specified, you can still use some of the
1065 features of newer standards in so far as they do not conflict with
1066 previous C standards.  For example, you may use @code{__restrict__} even
1067 when @option{-std=c99} is not specified.
1068
1069 The @option{-std} options specifying some version of ISO C have the same
1070 effects as @option{-ansi}, except that features that were not in ISO C90
1071 but are in the specified version (for example, @samp{//} comments and
1072 the @code{inline} keyword in ISO C99) are not disabled.
1073
1074 @xref{Standards,,Language Standards Supported by GCC}, for details of
1075 these standard versions.
1076
1077 @item -aux-info @var{filename}
1078 @opindex aux-info
1079 Output to the given filename prototyped declarations for all functions
1080 declared and/or defined in a translation unit, including those in header
1081 files.  This option is silently ignored in any language other than C@.
1082
1083 Besides declarations, the file indicates, in comments, the origin of
1084 each declaration (source file and line), whether the declaration was
1085 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1086 @samp{O} for old, respectively, in the first character after the line
1087 number and the colon), and whether it came from a declaration or a
1088 definition (@samp{C} or @samp{F}, respectively, in the following
1089 character).  In the case of function definitions, a K&R-style list of
1090 arguments followed by their declarations is also provided, inside
1091 comments, after the declaration.
1092
1093 @item -fno-asm
1094 @opindex fno-asm
1095 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1096 keyword, so that code can use these words as identifiers.  You can use
1097 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1098 instead.  @option{-ansi} implies @option{-fno-asm}.
1099
1100 In C++, this switch only affects the @code{typeof} keyword, since
1101 @code{asm} and @code{inline} are standard keywords.  You may want to
1102 use the @option{-fno-gnu-keywords} flag instead, which has the same
1103 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1104 switch only affects the @code{asm} and @code{typeof} keywords, since
1105 @code{inline} is a standard keyword in ISO C99.
1106
1107 @item -fno-builtin
1108 @itemx -fno-builtin-@var{function}
1109 @opindex fno-builtin
1110 @cindex built-in functions
1111 Don't recognize built-in functions that do not begin with
1112 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1113 functions provided by GCC}, for details of the functions affected,
1114 including those which are not built-in functions when @option{-ansi} or
1115 @option{-std} options for strict ISO C conformance are used because they
1116 do not have an ISO standard meaning.
1117
1118 GCC normally generates special code to handle certain built-in functions
1119 more efficiently; for instance, calls to @code{alloca} may become single
1120 instructions that adjust the stack directly, and calls to @code{memcpy}
1121 may become inline copy loops.  The resulting code is often both smaller
1122 and faster, but since the function calls no longer appear as such, you
1123 cannot set a breakpoint on those calls, nor can you change the behavior
1124 of the functions by linking with a different library.
1125
1126 With the @option{-fno-builtin-@var{function}} option
1127 only the built-in function @var{function} is
1128 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1129 function is named this is not built-in in this version of GCC, this
1130 option is ignored.  There is no corresponding
1131 @option{-fbuiltin-@var{function}} option; if you wish to enable
1132 built-in functions selectively when using @option{-fno-builtin} or
1133 @option{-ffreestanding}, you may define macros such as:
1134
1135 @smallexample
1136 #define abs(n)          __builtin_abs ((n))
1137 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1138 @end smallexample
1139
1140 @item -fhosted
1141 @opindex fhosted
1142 @cindex hosted environment
1143
1144 Assert that compilation takes place in a hosted environment.  This implies
1145 @option{-fbuiltin}.  A hosted environment is one in which the
1146 entire standard library is available, and in which @code{main} has a return
1147 type of @code{int}.  Examples are nearly everything except a kernel.
1148 This is equivalent to @option{-fno-freestanding}.
1149
1150 @item -ffreestanding
1151 @opindex ffreestanding
1152 @cindex hosted environment
1153
1154 Assert that compilation takes place in a freestanding environment.  This
1155 implies @option{-fno-builtin}.  A freestanding environment
1156 is one in which the standard library may not exist, and program startup may
1157 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1158 This is equivalent to @option{-fno-hosted}.
1159
1160 @xref{Standards,,Language Standards Supported by GCC}, for details of
1161 freestanding and hosted environments.
1162
1163 @item -fms-extensions
1164 @opindex fms-extensions
1165 Accept some non-standard constructs used in Microsoft header files.
1166
1167 @item -trigraphs
1168 @opindex trigraphs
1169 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1170 options for strict ISO C conformance) implies @option{-trigraphs}.
1171
1172 @item -no-integrated-cpp
1173 @opindex no-integrated-cpp
1174 Performs a compilation in two passes: preprocessing and compiling.  This
1175 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1176 @option{-B} option. The user supplied compilation step can then add in
1177 an additional preprocessing step after normal preprocessing but before
1178 compiling. The default is to use the integrated cpp (internal cpp)
1179
1180 The semantics of this option will change if "cc1", "cc1plus", and
1181 "cc1obj" are merged.
1182
1183 @cindex traditional C language
1184 @cindex C language, traditional
1185 @item -traditional
1186 @itemx -traditional-cpp
1187 @opindex traditional-cpp
1188 @opindex traditional
1189 Formerly, these options caused GCC to attempt to emulate a pre-standard
1190 C compiler.  They are now only supported with the @option{-E} switch.
1191 The preprocessor continues to support a pre-standard mode.  See the GNU
1192 CPP manual for details.
1193
1194 @item -fcond-mismatch
1195 @opindex fcond-mismatch
1196 Allow conditional expressions with mismatched types in the second and
1197 third arguments.  The value of such an expression is void.  This option
1198 is not supported for C++.
1199
1200 @item -funsigned-char
1201 @opindex funsigned-char
1202 Let the type @code{char} be unsigned, like @code{unsigned char}.
1203
1204 Each kind of machine has a default for what @code{char} should
1205 be.  It is either like @code{unsigned char} by default or like
1206 @code{signed char} by default.
1207
1208 Ideally, a portable program should always use @code{signed char} or
1209 @code{unsigned char} when it depends on the signedness of an object.
1210 But many programs have been written to use plain @code{char} and
1211 expect it to be signed, or expect it to be unsigned, depending on the
1212 machines they were written for.  This option, and its inverse, let you
1213 make such a program work with the opposite default.
1214
1215 The type @code{char} is always a distinct type from each of
1216 @code{signed char} or @code{unsigned char}, even though its behavior
1217 is always just like one of those two.
1218
1219 @item -fsigned-char
1220 @opindex fsigned-char
1221 Let the type @code{char} be signed, like @code{signed char}.
1222
1223 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1224 the negative form of @option{-funsigned-char}.  Likewise, the option
1225 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1226
1227 @item -fsigned-bitfields
1228 @itemx -funsigned-bitfields
1229 @itemx -fno-signed-bitfields
1230 @itemx -fno-unsigned-bitfields
1231 @opindex fsigned-bitfields
1232 @opindex funsigned-bitfields
1233 @opindex fno-signed-bitfields
1234 @opindex fno-unsigned-bitfields
1235 These options control whether a bit-field is signed or unsigned, when the
1236 declaration does not use either @code{signed} or @code{unsigned}.  By
1237 default, such a bit-field is signed, because this is consistent: the
1238 basic integer types such as @code{int} are signed types.
1239
1240 @item -fwritable-strings
1241 @opindex fwritable-strings
1242 Store string constants in the writable data segment and don't uniquize
1243 them.  This is for compatibility with old programs which assume they can
1244 write into string constants.
1245
1246 Writing into string constants is a very bad idea; ``constants'' should
1247 be constant.
1248 @end table
1249
1250 @node C++ Dialect Options
1251 @section Options Controlling C++ Dialect
1252
1253 @cindex compiler options, C++
1254 @cindex C++ options, command line
1255 @cindex options, C++
1256 This section describes the command-line options that are only meaningful
1257 for C++ programs; but you can also use most of the GNU compiler options
1258 regardless of what language your program is in.  For example, you
1259 might compile a file @code{firstClass.C} like this:
1260
1261 @example
1262 g++ -g -frepo -O -c firstClass.C
1263 @end example
1264
1265 @noindent
1266 In this example, only @option{-frepo} is an option meant
1267 only for C++ programs; you can use the other options with any
1268 language supported by GCC@.
1269
1270 Here is a list of options that are @emph{only} for compiling C++ programs:
1271
1272 @table @gcctabopt
1273
1274 @item -fabi-version=@var{n}
1275 @opindex fabi-version
1276 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1277 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1278 version that conforms most closely to the C++ ABI specification.
1279 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1280 fixed.
1281
1282 The default is version 1.
1283
1284 @item -fno-access-control
1285 @opindex fno-access-control
1286 Turn off all access checking.  This switch is mainly useful for working
1287 around bugs in the access control code.
1288
1289 @item -fcheck-new
1290 @opindex fcheck-new
1291 Check that the pointer returned by @code{operator new} is non-null
1292 before attempting to modify the storage allocated.  This check is
1293 normally unnecessary because the C++ standard specifies that
1294 @code{operator new} will only return @code{0} if it is declared
1295 @samp{throw()}, in which case the compiler will always check the
1296 return value even without this option.  In all other cases, when
1297 @code{operator new} has a non-empty exception specification, memory
1298 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1299 @samp{new (nothrow)}.
1300
1301 @item -fconserve-space
1302 @opindex fconserve-space
1303 Put uninitialized or runtime-initialized global variables into the
1304 common segment, as C does.  This saves space in the executable at the
1305 cost of not diagnosing duplicate definitions.  If you compile with this
1306 flag and your program mysteriously crashes after @code{main()} has
1307 completed, you may have an object that is being destroyed twice because
1308 two definitions were merged.
1309
1310 This option is no longer useful on most targets, now that support has
1311 been added for putting variables into BSS without making them common.
1312
1313 @item -fno-const-strings
1314 @opindex fno-const-strings
1315 Give string constants type @code{char *} instead of type @code{const
1316 char *}.  By default, G++ uses type @code{const char *} as required by
1317 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1318 actually modify the value of a string constant, unless you also use
1319 @option{-fwritable-strings}.
1320
1321 This option might be removed in a future release of G++.  For maximum
1322 portability, you should structure your code so that it works with
1323 string constants that have type @code{const char *}.
1324
1325 @item -fno-elide-constructors
1326 @opindex fno-elide-constructors
1327 The C++ standard allows an implementation to omit creating a temporary
1328 which is only used to initialize another object of the same type.
1329 Specifying this option disables that optimization, and forces G++ to
1330 call the copy constructor in all cases.
1331
1332 @item -fno-enforce-eh-specs
1333 @opindex fno-enforce-eh-specs
1334 Don't check for violation of exception specifications at runtime.  This
1335 option violates the C++ standard, but may be useful for reducing code
1336 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1337 will still optimize based on the exception specifications.
1338
1339 @item -fexternal-templates
1340 @opindex fexternal-templates
1341
1342 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1343 template instantiation; template instances are emitted or not according
1344 to the location of the template definition.  @xref{Template
1345 Instantiation}, for more information.
1346
1347 This option is deprecated.
1348
1349 @item -falt-external-templates
1350 @opindex falt-external-templates
1351 Similar to @option{-fexternal-templates}, but template instances are
1352 emitted or not according to the place where they are first instantiated.
1353 @xref{Template Instantiation}, for more information.
1354
1355 This option is deprecated.
1356
1357 @item -ffor-scope
1358 @itemx -fno-for-scope
1359 @opindex ffor-scope
1360 @opindex fno-for-scope
1361 If @option{-ffor-scope} is specified, the scope of variables declared in
1362 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1363 as specified by the C++ standard.
1364 If @option{-fno-for-scope} is specified, the scope of variables declared in
1365 a @i{for-init-statement} extends to the end of the enclosing scope,
1366 as was the case in old versions of G++, and other (traditional)
1367 implementations of C++.
1368
1369 The default if neither flag is given to follow the standard,
1370 but to allow and give a warning for old-style code that would
1371 otherwise be invalid, or have different behavior.
1372
1373 @item -fno-gnu-keywords
1374 @opindex fno-gnu-keywords
1375 Do not recognize @code{typeof} as a keyword, so that code can use this
1376 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1377 @option{-ansi} implies @option{-fno-gnu-keywords}.
1378
1379 @item -fno-implicit-templates
1380 @opindex fno-implicit-templates
1381 Never emit code for non-inline templates which are instantiated
1382 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1383 @xref{Template Instantiation}, for more information.
1384
1385 @item -fno-implicit-inline-templates
1386 @opindex fno-implicit-inline-templates
1387 Don't emit code for implicit instantiations of inline templates, either.
1388 The default is to handle inlines differently so that compiles with and
1389 without optimization will need the same set of explicit instantiations.
1390
1391 @item -fno-implement-inlines
1392 @opindex fno-implement-inlines
1393 To save space, do not emit out-of-line copies of inline functions
1394 controlled by @samp{#pragma implementation}.  This will cause linker
1395 errors if these functions are not inlined everywhere they are called.
1396
1397 @item -fms-extensions
1398 @opindex fms-extensions
1399 Disable pedantic warnings about constructs used in MFC, such as implicit
1400 int and getting a pointer to member function via non-standard syntax.
1401
1402 @item -fno-nonansi-builtins
1403 @opindex fno-nonansi-builtins
1404 Disable built-in declarations of functions that are not mandated by
1405 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1406 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1407
1408 @item -fno-operator-names
1409 @opindex fno-operator-names
1410 Do not treat the operator name keywords @code{and}, @code{bitand},
1411 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1412 synonyms as keywords.
1413
1414 @item -fno-optional-diags
1415 @opindex fno-optional-diags
1416 Disable diagnostics that the standard says a compiler does not need to
1417 issue.  Currently, the only such diagnostic issued by G++ is the one for
1418 a name having multiple meanings within a class.
1419
1420 @item -fpermissive
1421 @opindex fpermissive
1422 Downgrade some diagnostics about nonconformant code from errors to
1423 warnings.  Thus, using @option{-fpermissive} will allow some
1424 nonconforming code to compile.
1425
1426 @item -frepo
1427 @opindex frepo
1428 Enable automatic template instantiation at link time.  This option also
1429 implies @option{-fno-implicit-templates}.  @xref{Template
1430 Instantiation}, for more information.
1431
1432 @item -fno-rtti
1433 @opindex fno-rtti
1434 Disable generation of information about every class with virtual
1435 functions for use by the C++ runtime type identification features
1436 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1437 of the language, you can save some space by using this flag.  Note that
1438 exception handling uses the same information, but it will generate it as
1439 needed.
1440
1441 @item -fstats
1442 @opindex fstats
1443 Emit statistics about front-end processing at the end of the compilation.
1444 This information is generally only useful to the G++ development team.
1445
1446 @item -ftemplate-depth-@var{n}
1447 @opindex ftemplate-depth
1448 Set the maximum instantiation depth for template classes to @var{n}.
1449 A limit on the template instantiation depth is needed to detect
1450 endless recursions during template class instantiation.  ANSI/ISO C++
1451 conforming programs must not rely on a maximum depth greater than 17.
1452
1453 @item -fuse-cxa-atexit
1454 @opindex fuse-cxa-atexit
1455 Register destructors for objects with static storage duration with the
1456 @code{__cxa_atexit} function rather than the @code{atexit} function.
1457 This option is required for fully standards-compliant handling of static
1458 destructors, but will only work if your C library supports
1459 @code{__cxa_atexit}.
1460
1461 @item -fno-weak
1462 @opindex fno-weak
1463 Do not use weak symbol support, even if it is provided by the linker.
1464 By default, G++ will use weak symbols if they are available.  This
1465 option exists only for testing, and should not be used by end-users;
1466 it will result in inferior code and has no benefits.  This option may
1467 be removed in a future release of G++.
1468
1469 @item -nostdinc++
1470 @opindex nostdinc++
1471 Do not search for header files in the standard directories specific to
1472 C++, but do still search the other standard directories.  (This option
1473 is used when building the C++ library.)
1474 @end table
1475
1476 In addition, these optimization, warning, and code generation options
1477 have meanings only for C++ programs:
1478
1479 @table @gcctabopt
1480 @item -fno-default-inline
1481 @opindex fno-default-inline
1482 Do not assume @samp{inline} for functions defined inside a class scope.
1483 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1484 functions will have linkage like inline functions; they just won't be
1485 inlined by default.
1486
1487 @item -Wabi @r{(C++ only)}
1488 @opindex Wabi
1489 Warn when G++ generates code that is probably not compatible with the
1490 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1491 all such cases, there are probably some cases that are not warned about, 
1492 even though G++ is generating incompatible code.  There may also be
1493 cases where warnings are emitted even though the code that is generated
1494 will be compatible.
1495
1496 You should rewrite your code to avoid these warnings if you are
1497 concerned about the fact that code generated by G++ may not be binary
1498 compatible with code generated by other compilers.
1499
1500 The known incompatibilities at this point include:
1501
1502 @itemize @bullet
1503
1504 @item
1505 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1506 pack data into the same byte as a base class.  For example:
1507
1508 @smallexample
1509 struct A @{ virtual void f(); int f1 : 1; @};
1510 struct B : public A @{ int f2 : 1; @};
1511 @end smallexample
1512
1513 @noindent
1514 In this case, G++ will place @code{B::f2} into the same byte
1515 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1516 by explicitly padding @code{A} so that its size is a multiple of the
1517 byte size on your platform; that will cause G++ and other compilers to
1518 layout @code{B} identically.
1519
1520 @item
1521 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1522 tail padding when laying out virtual bases.  For example:
1523
1524 @smallexample
1525 struct A @{ virtual void f(); char c1; @};
1526 struct B @{ B(); char c2; @};
1527 struct C : public A, public virtual B @{@};
1528 @end smallexample
1529
1530 @noindent
1531 In this case, G++ will not place @code{B} into the tail-padding for
1532 @code{A}; other compilers will.  You can avoid this problem by
1533 explicitly padding @code{A} so that its size is a multiple of its
1534 alignment (ignoring virtual base classes); that will cause G++ and other
1535 compilers to layout @code{C} identically.
1536
1537 @item
1538 Incorrect handling of bit-fields with declared widths greater than that
1539 of their underlying types, when the bit-fields appear in a union.  For
1540 example:
1541
1542 @smallexample
1543 union U @{ int i : 4096; @};
1544 @end smallexample
1545
1546 @noindent
1547 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1548 union too small by the number of bits in an @code{int}.
1549
1550 @item
1551 Empty classes can be placed at incorrect offsets.  For example:
1552  
1553 @smallexample
1554 struct A @{@};
1555
1556 struct B @{
1557   A a;
1558   virtual void f ();
1559 @};
1560
1561 struct C : public B, public A @{@};
1562 @end smallexample
1563
1564 @noindent
1565 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1566 it should be placed at offset zero.  G++ mistakenly believes that the
1567 @code{A} data member of @code{B} is already at offset zero.
1568
1569 @item
1570 Names of template functions whose types involve @code{typename} or
1571 template template parameters can be mangled incorrectly.
1572
1573 @smallexample
1574 template <typename Q>
1575 void f(typename Q::X) @{@}
1576
1577 template <template <typename> class Q>
1578 void f(typename Q<int>::X) @{@}
1579 @end smallexample
1580
1581 @noindent
1582 Instantiations of these templates may be mangled incorrectly.
1583
1584 @end itemize
1585
1586 @item -Wctor-dtor-privacy @r{(C++ only)}
1587 @opindex Wctor-dtor-privacy
1588 Warn when a class seems unusable because all the constructors or
1589 destructors in that class are private, and it has neither friends nor
1590 public static member functions.
1591
1592 @item -Wnon-virtual-dtor @r{(C++ only)}
1593 @opindex Wnon-virtual-dtor
1594 Warn when a class appears to be polymorphic, thereby requiring a virtual
1595 destructor, yet it declares a non-virtual one.
1596 This warning is enabled by @option{-Wall}.
1597
1598 @item -Wreorder @r{(C++ only)}
1599 @opindex Wreorder
1600 @cindex reordering, warning
1601 @cindex warning for reordering of member initializers
1602 Warn when the order of member initializers given in the code does not
1603 match the order in which they must be executed.  For instance:
1604
1605 @smallexample
1606 struct A @{
1607   int i;
1608   int j;
1609   A(): j (0), i (1) @{ @}
1610 @};
1611 @end smallexample
1612
1613 The compiler will rearrange the member initializers for @samp{i}
1614 and @samp{j} to match the declaration order of the members, emitting
1615 a warning to that effect.  This warning is enabled by @option{-Wall}.
1616 @end table
1617
1618 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1619
1620 @table @gcctabopt
1621 @item -Weffc++ @r{(C++ only)}
1622 @opindex Weffc++
1623 Warn about violations of the following style guidelines from Scott Meyers'
1624 @cite{Effective C++} book:
1625
1626 @itemize @bullet
1627 @item
1628 Item 11:  Define a copy constructor and an assignment operator for classes
1629 with dynamically allocated memory.
1630
1631 @item
1632 Item 12:  Prefer initialization to assignment in constructors.
1633
1634 @item
1635 Item 14:  Make destructors virtual in base classes.
1636
1637 @item
1638 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1639
1640 @item
1641 Item 23:  Don't try to return a reference when you must return an object.
1642
1643 @end itemize
1644
1645 Also warn about violations of the following style guidelines from 
1646 Scott Meyers' @cite{More Effective C++} book:
1647
1648 @itemize @bullet
1649 @item
1650 Item 6:  Distinguish between prefix and postfix forms of increment and
1651 decrement operators.
1652
1653 @item
1654 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1655
1656 @end itemize
1657
1658 When selecting this option, be aware that the standard library
1659 headers do not obey all of these guidelines; use @samp{grep -v}
1660 to filter out those warnings.
1661
1662 @item -Wno-deprecated @r{(C++ only)}
1663 @opindex Wno-deprecated
1664 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1665
1666 @item -Wno-non-template-friend @r{(C++ only)}
1667 @opindex Wno-non-template-friend
1668 Disable warnings when non-templatized friend functions are declared
1669 within a template.  Since the advent of explicit template specification
1670 support in G++, if the name of the friend is an unqualified-id (i.e.,
1671 @samp{friend foo(int)}), the C++ language specification demands that the
1672 friend declare or define an ordinary, nontemplate function.  (Section
1673 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1674 could be interpreted as a particular specialization of a templatized
1675 function.  Because this non-conforming behavior is no longer the default
1676 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1677 check existing code for potential trouble spots and is on by default.
1678 This new compiler behavior can be turned off with
1679 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1680 but disables the helpful warning.
1681
1682 @item -Wold-style-cast @r{(C++ only)}
1683 @opindex Wold-style-cast
1684 Warn if an old-style (C-style) cast to a non-void type is used within
1685 a C++ program.  The new-style casts (@samp{static_cast},
1686 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1687 unintended effects and much easier to search for.
1688
1689 @item -Woverloaded-virtual @r{(C++ only)}
1690 @opindex Woverloaded-virtual
1691 @cindex overloaded virtual fn, warning
1692 @cindex warning for overloaded virtual fn
1693 Warn when a function declaration hides virtual functions from a
1694 base class.  For example, in:
1695
1696 @smallexample
1697 struct A @{
1698   virtual void f();
1699 @};
1700
1701 struct B: public A @{
1702   void f(int);
1703 @};
1704 @end smallexample
1705
1706 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1707 like:
1708
1709 @smallexample
1710 B* b;
1711 b->f();
1712 @end smallexample
1713
1714 will fail to compile.
1715
1716 @item -Wno-pmf-conversions @r{(C++ only)}
1717 @opindex Wno-pmf-conversions
1718 Disable the diagnostic for converting a bound pointer to member function
1719 to a plain pointer.
1720
1721 @item -Wsign-promo @r{(C++ only)}
1722 @opindex Wsign-promo
1723 Warn when overload resolution chooses a promotion from unsigned or
1724 enumeral type to a signed type, over a conversion to an unsigned type of
1725 the same size.  Previous versions of G++ would try to preserve
1726 unsignedness, but the standard mandates the current behavior.
1727
1728 @item -Wsynth @r{(C++ only)}
1729 @opindex Wsynth
1730 @cindex warning for synthesized methods
1731 @cindex synthesized methods, warning
1732 Warn when G++'s synthesis behavior does not match that of cfront.  For
1733 instance:
1734
1735 @smallexample
1736 struct A @{
1737   operator int ();
1738   A& operator = (int);
1739 @};
1740
1741 main ()
1742 @{
1743   A a,b;
1744   a = b;
1745 @}
1746 @end smallexample
1747
1748 In this example, G++ will synthesize a default @samp{A& operator =
1749 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1750 @end table
1751
1752 @node Objective-C Dialect Options
1753 @section Options Controlling Objective-C Dialect
1754
1755 @cindex compiler options, Objective-C
1756 @cindex Objective-C options, command line
1757 @cindex options, Objective-C
1758 (NOTE: This manual does not describe the Objective-C language itself.  See
1759 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1760
1761 This section describes the command-line options that are only meaningful
1762 for Objective-C programs, but you can also use most of the GNU compiler
1763 options regardless of what language your program is in.  For example,
1764 you might compile a file @code{some_class.m} like this:
1765
1766 @example
1767 gcc -g -fgnu-runtime -O -c some_class.m
1768 @end example
1769
1770 @noindent
1771 In this example, @option{-fgnu-runtime} is an option meant only for
1772 Objective-C programs; you can use the other options with any language
1773 supported by GCC@.
1774
1775 Here is a list of options that are @emph{only} for compiling Objective-C
1776 programs:
1777
1778 @table @gcctabopt
1779 @item -fconstant-string-class=@var{class-name}
1780 @opindex fconstant-string-class
1781 Use @var{class-name} as the name of the class to instantiate for each
1782 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1783 class name is @code{NXConstantString} if the GNU runtime is being used, and
1784 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1785 @option{-fconstant-cfstrings} option, if also present, will override the
1786 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1787 to be laid out as constant CoreFoundation strings.
1788
1789 @item -fgnu-runtime
1790 @opindex fgnu-runtime
1791 Generate object code compatible with the standard GNU Objective-C
1792 runtime.  This is the default for most types of systems.
1793
1794 @item -fnext-runtime
1795 @opindex fnext-runtime
1796 Generate output compatible with the NeXT runtime.  This is the default
1797 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1798 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1799 used.
1800
1801 @item -fno-nil-receivers
1802 @opindex -fno-nil-receivers
1803 Assume that all Objective-C message dispatches (e.g., 
1804 @code{[receiver message:arg]}) in this translation unit ensure that the receiver 
1805 is not @code{nil}.  This allows for more efficient entry points in the runtime to be 
1806 used.  Currently, this option is only available in conjunction with 
1807 the NeXT runtime on Mac OS X 10.3 and later.
1808
1809 @item -fobjc-exceptions
1810 @opindex -fobjc-exceptions
1811 Enable syntactic support for structured exception handling in Objective-C, 
1812 similar to what is offered by C++ and Java.  Currently, this option is only 
1813 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later. 
1814
1815 @smallexample
1816   @@try @{
1817     @dots{}
1818        @@throw expr;
1819     @dots{}
1820   @}
1821   @@catch (AnObjCClass *exc) @{
1822     @dots{}
1823       @@throw expr;
1824     @dots{}
1825       @@throw;
1826     @dots{}
1827   @}
1828   @@catch (AnotherClass *exc) @{
1829     @dots{}
1830   @}
1831   @@catch (id allOthers) @{
1832     @dots{}
1833   @}
1834   @@finally @{
1835     @dots{}
1836       @@throw expr;
1837     @dots{}
1838   @}
1839 @end smallexample
1840
1841 The @code{@@throw} statement may appear anywhere in an Objective-C or
1842 Objective-C++ program; when used inside of a @code{@@catch} block, the 
1843 @code{@@throw} may appear without an argument (as shown above), in which case 
1844 the object caught by the @code{@@catch} will be rethrown.
1845
1846 Note that only (pointers to) Objective-C objects may be thrown and
1847 caught using this scheme.  When an object is thrown, it will be caught
1848 by the nearest @code{@@catch} clause capable of handling objects of that type,
1849 analogously to how @code{catch} blocks work in C++ and Java.  A 
1850 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch 
1851 any and all Objective-C exceptions not caught by previous @code{@@catch}
1852 clauses (if any).
1853
1854 The @code{@@finally} clause, if present, will be executed upon exit from the
1855 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1856 regardless of whether any exceptions are thrown, caught or rethrown
1857 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1858 of the @code{finally} clause in Java.
1859
1860 There are several caveats to using the new exception mechanism:
1861
1862 @itemize @bullet
1863 @item
1864 Although currently designed to be binary compatible with @code{NS_HANDLER}-style 
1865 idioms provided by the @code{NSException} class, the new
1866 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1867 systems, due to additional functionality needed in the (NeXT) Objective-C
1868 runtime.
1869
1870 @item
1871 As mentioned above, the new exceptions do not support handling
1872 types other than Objective-C objects.   Furthermore, when used from 
1873 Objective-C++, the Objective-C exception model does not interoperate with C++
1874 exceptions at this time.  This means you cannot @code{@@throw} an exception
1875 from Objective-C and @code{catch} it in C++, or vice versa 
1876 (i.e., @code{throw @dots{} @@catch}).
1877 @end itemize
1878  
1879 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1880 blocks for thread-safe execution:
1881
1882 @smallexample
1883   @@synchronized (ObjCClass *guard) @{
1884     @dots{}
1885   @}
1886 @end smallexample
1887
1888 Upon entering the @code{@@synchronized} block, a thread of execution shall
1889 first check whether a lock has been placed on the corresponding @code{guard}
1890 object by another thread.  If it has, the current thread shall wait until
1891 the other thread relinquishes its lock.  Once @code{guard} becomes available, 
1892 the current thread will place its own lock on it, execute the code contained in
1893 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1894 making @code{guard} available to other threads).
1895
1896 Unlike Java, Objective-C does not allow for entire methods to be marked
1897 @code{@@synchronized}.  Note that throwing exceptions out of
1898 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1899 to be unlocked properly.
1900
1901 @item -freplace-objc-classes
1902 @opindex -freplace-objc-classes
1903 Emit a special marker instructing @command{ld(1)} not to statically link in
1904 the resulting object file, and allow @command{dyld(1)} to load it in at
1905 run time instead.  This is used in conjunction with the Fix-and-Continue
1906 debugging mode, where the object file in question may be recompiled and 
1907 dynamically reloaded in the course of program execution, without the need
1908 to restart the program itself.  Currently, Fix-and-Continue functionality
1909 is only available in conjunction with the NeXT runtime on Mac OS X 10.3 
1910 and later.
1911
1912 @item -fzero-link
1913 @opindex -fzero-link
1914 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1915 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1916 compile time) with static class references that get initialized at load time,
1917 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1918 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1919 to be retained.  This is useful in Zero-Link debugging mode, since it allows 
1920 for individual class implementations to be modified during program execution.
1921
1922 @item -gen-decls
1923 @opindex gen-decls
1924 Dump interface declarations for all classes seen in the source file to a
1925 file named @file{@var{sourcename}.decl}.
1926
1927 @item -Wno-protocol
1928 @opindex Wno-protocol
1929 If a class is declared to implement a protocol, a warning is issued for
1930 every method in the protocol that is not implemented by the class.  The
1931 default behavior is to issue a warning for every method not explicitly
1932 implemented in the class, even if a method implementation is inherited
1933 from the superclass.  If you use the @code{-Wno-protocol} option, then
1934 methods inherited from the superclass are considered to be implemented,
1935 and no warning is issued for them.
1936
1937 @item -Wselector
1938 @opindex Wselector
1939 Warn if multiple methods of different types for the same selector are
1940 found during compilation.  The check is performed on the list of methods
1941 in the final stage of compilation.  Additionally, a check is performed
1942 for each selector appearing in a @code{@@selector(@dots{})}
1943 expression, and a corresponding method for that selector has been found
1944 during compilation.  Because these checks scan the method table only at
1945 the end of compilation, these warnings are not produced if the final
1946 stage of compilation is not reached, for example because an error is
1947 found during compilation, or because the @code{-fsyntax-only} option is
1948 being used.
1949
1950 @item -Wundeclared-selector
1951 @opindex Wundeclared-selector
1952 Warn if a @code{@@selector(@dots{})} expression referring to an
1953 undeclared selector is found.  A selector is considered undeclared if no
1954 method with that name has been declared before the 
1955 @code{@@selector(@dots{})} expression, either explicitly in an
1956 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1957 an @code{@@implementation} section.  This option always performs its
1958 checks as soon as a @code{@@selector(@dots{})} expression is found,
1959 while @code{-Wselector} only performs its checks in the final stage of
1960 compilation.  This also enforces the coding style convention
1961 that methods and selectors must be declared before being used.
1962
1963 @item -print-objc-runtime-info
1964 @opindex -print-objc-runtime-info
1965 Generate C header describing the largest structure that is passed by
1966 value, if any.
1967
1968 @end table
1969
1970 @node Language Independent Options
1971 @section Options to Control Diagnostic Messages Formatting
1972 @cindex options to control diagnostics formatting
1973 @cindex diagnostic messages
1974 @cindex message formatting
1975
1976 Traditionally, diagnostic messages have been formatted irrespective of
1977 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1978 below can be used to control the diagnostic messages formatting
1979 algorithm, e.g.@: how many characters per line, how often source location
1980 information should be reported.  Right now, only the C++ front end can
1981 honor these options.  However it is expected, in the near future, that
1982 the remaining front ends would be able to digest them correctly.
1983
1984 @table @gcctabopt
1985 @item -fmessage-length=@var{n}
1986 @opindex fmessage-length
1987 Try to format error messages so that they fit on lines of about @var{n}
1988 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1989 the front ends supported by GCC@.  If @var{n} is zero, then no
1990 line-wrapping will be done; each error message will appear on a single
1991 line.
1992
1993 @opindex fdiagnostics-show-location
1994 @item -fdiagnostics-show-location=once
1995 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1996 reporter to emit @emph{once} source location information; that is, in
1997 case the message is too long to fit on a single physical line and has to
1998 be wrapped, the source location won't be emitted (as prefix) again,
1999 over and over, in subsequent continuation lines.  This is the default
2000 behavior.
2001
2002 @item -fdiagnostics-show-location=every-line
2003 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2004 messages reporter to emit the same source location information (as
2005 prefix) for physical lines that result from the process of breaking
2006 a message which is too long to fit on a single line.
2007
2008 @end table
2009
2010 @node Warning Options
2011 @section Options to Request or Suppress Warnings
2012 @cindex options to control warnings
2013 @cindex warning messages
2014 @cindex messages, warning
2015 @cindex suppressing warnings
2016
2017 Warnings are diagnostic messages that report constructions which
2018 are not inherently erroneous but which are risky or suggest there
2019 may have been an error.
2020
2021 You can request many specific warnings with options beginning @samp{-W},
2022 for example @option{-Wimplicit} to request warnings on implicit
2023 declarations.  Each of these specific warning options also has a
2024 negative form beginning @samp{-Wno-} to turn off warnings;
2025 for example, @option{-Wno-implicit}.  This manual lists only one of the
2026 two forms, whichever is not the default.
2027
2028 The following options control the amount and kinds of warnings produced
2029 by GCC; for further, language-specific options also refer to
2030 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2031
2032 @table @gcctabopt
2033 @cindex syntax checking
2034 @item -fsyntax-only
2035 @opindex fsyntax-only
2036 Check the code for syntax errors, but don't do anything beyond that.
2037
2038 @item -pedantic
2039 @opindex pedantic
2040 Issue all the warnings demanded by strict ISO C and ISO C++;
2041 reject all programs that use forbidden extensions, and some other
2042 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2043 version of the ISO C standard specified by any @option{-std} option used.
2044
2045 Valid ISO C and ISO C++ programs should compile properly with or without
2046 this option (though a rare few will require @option{-ansi} or a
2047 @option{-std} option specifying the required version of ISO C)@.  However,
2048 without this option, certain GNU extensions and traditional C and C++
2049 features are supported as well.  With this option, they are rejected.
2050
2051 @option{-pedantic} does not cause warning messages for use of the
2052 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2053 warnings are also disabled in the expression that follows
2054 @code{__extension__}.  However, only system header files should use
2055 these escape routes; application programs should avoid them.
2056 @xref{Alternate Keywords}.
2057
2058 Some users try to use @option{-pedantic} to check programs for strict ISO
2059 C conformance.  They soon find that it does not do quite what they want:
2060 it finds some non-ISO practices, but not all---only those for which
2061 ISO C @emph{requires} a diagnostic, and some others for which
2062 diagnostics have been added.
2063
2064 A feature to report any failure to conform to ISO C might be useful in
2065 some instances, but would require considerable additional work and would
2066 be quite different from @option{-pedantic}.  We don't have plans to
2067 support such a feature in the near future.
2068
2069 Where the standard specified with @option{-std} represents a GNU
2070 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2071 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2072 extended dialect is based.  Warnings from @option{-pedantic} are given
2073 where they are required by the base standard.  (It would not make sense
2074 for such warnings to be given only for features not in the specified GNU
2075 C dialect, since by definition the GNU dialects of C include all
2076 features the compiler supports with the given option, and there would be
2077 nothing to warn about.)
2078
2079 @item -pedantic-errors
2080 @opindex pedantic-errors
2081 Like @option{-pedantic}, except that errors are produced rather than
2082 warnings.
2083
2084 @item -w
2085 @opindex w
2086 Inhibit all warning messages.
2087
2088 @item -Wno-import
2089 @opindex Wno-import
2090 Inhibit warning messages about the use of @samp{#import}.
2091
2092 @item -Wchar-subscripts
2093 @opindex Wchar-subscripts
2094 Warn if an array subscript has type @code{char}.  This is a common cause
2095 of error, as programmers often forget that this type is signed on some
2096 machines.
2097
2098 @item -Wcomment
2099 @opindex Wcomment
2100 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2101 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2102
2103 @item -Wformat
2104 @opindex Wformat
2105 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2106 the arguments supplied have types appropriate to the format string
2107 specified, and that the conversions specified in the format string make
2108 sense.  This includes standard functions, and others specified by format
2109 attributes (@pxref{Function Attributes}), in the @code{printf},
2110 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2111 not in the C standard) families.
2112
2113 The formats are checked against the format features supported by GNU
2114 libc version 2.2.  These include all ISO C90 and C99 features, as well
2115 as features from the Single Unix Specification and some BSD and GNU
2116 extensions.  Other library implementations may not support all these
2117 features; GCC does not support warning about features that go beyond a
2118 particular library's limitations.  However, if @option{-pedantic} is used
2119 with @option{-Wformat}, warnings will be given about format features not
2120 in the selected standard version (but not for @code{strfmon} formats,
2121 since those are not in any version of the C standard).  @xref{C Dialect
2122 Options,,Options Controlling C Dialect}.
2123
2124 Since @option{-Wformat} also checks for null format arguments for
2125 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2126
2127 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2128 aspects of format checking, the options @option{-Wformat-y2k},
2129 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2130 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2131 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2132
2133 @item -Wformat-y2k
2134 @opindex Wformat-y2k
2135 If @option{-Wformat} is specified, also warn about @code{strftime}
2136 formats which may yield only a two-digit year.
2137
2138 @item -Wno-format-extra-args
2139 @opindex Wno-format-extra-args
2140 If @option{-Wformat} is specified, do not warn about excess arguments to a
2141 @code{printf} or @code{scanf} format function.  The C standard specifies
2142 that such arguments are ignored.
2143
2144 Where the unused arguments lie between used arguments that are
2145 specified with @samp{$} operand number specifications, normally
2146 warnings are still given, since the implementation could not know what
2147 type to pass to @code{va_arg} to skip the unused arguments.  However,
2148 in the case of @code{scanf} formats, this option will suppress the
2149 warning if the unused arguments are all pointers, since the Single
2150 Unix Specification says that such unused arguments are allowed.
2151
2152 @item -Wno-format-zero-length
2153 @opindex Wno-format-zero-length
2154 If @option{-Wformat} is specified, do not warn about zero-length formats.
2155 The C standard specifies that zero-length formats are allowed.
2156
2157 @item -Wformat-nonliteral
2158 @opindex Wformat-nonliteral
2159 If @option{-Wformat} is specified, also warn if the format string is not a
2160 string literal and so cannot be checked, unless the format function
2161 takes its format arguments as a @code{va_list}.
2162
2163 @item -Wformat-security
2164 @opindex Wformat-security
2165 If @option{-Wformat} is specified, also warn about uses of format
2166 functions that represent possible security problems.  At present, this
2167 warns about calls to @code{printf} and @code{scanf} functions where the
2168 format string is not a string literal and there are no format arguments,
2169 as in @code{printf (foo);}.  This may be a security hole if the format
2170 string came from untrusted input and contains @samp{%n}.  (This is
2171 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2172 in future warnings may be added to @option{-Wformat-security} that are not
2173 included in @option{-Wformat-nonliteral}.)
2174
2175 @item -Wformat=2
2176 @opindex Wformat=2
2177 Enable @option{-Wformat} plus format checks not included in
2178 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2179 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2180
2181 @item -Wnonnull
2182 @opindex Wnonnull
2183 Warn about passing a null pointer for arguments marked as
2184 requiring a non-null value by the @code{nonnull} function attribute.
2185
2186 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2187 can be disabled with the @option{-Wno-nonnull} option.
2188
2189 @item -Winit-self @r{(C, C++, and Objective-C only)} 
2190 @opindex Winit-self
2191 Warn about uninitialized variables which are initialized with themselves.
2192 Note this option can only be used with the @option{-Wuninitialized} option,
2193 which in turn only works with @option{-O1} and above.
2194
2195 For example, GCC will warn about @code{i} being uninitialized in the
2196 following snippet only when @option{-Winit-self} has been specified:
2197 @smallexample
2198 @group
2199 int f()
2200 @{
2201   int i = i;
2202   return i;
2203 @}
2204 @end group
2205 @end smallexample
2206
2207 @item -Wimplicit-int
2208 @opindex Wimplicit-int
2209 Warn when a declaration does not specify a type.
2210
2211 @item -Wimplicit-function-declaration
2212 @itemx -Werror-implicit-function-declaration
2213 @opindex Wimplicit-function-declaration
2214 @opindex Werror-implicit-function-declaration
2215 Give a warning (or error) whenever a function is used before being
2216 declared.
2217
2218 @item -Wimplicit
2219 @opindex Wimplicit
2220 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2221
2222 @item -Wmain
2223 @opindex Wmain
2224 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2225 function with external linkage, returning int, taking either zero
2226 arguments, two, or three arguments of appropriate types.
2227
2228 @item -Wmissing-braces
2229 @opindex Wmissing-braces
2230 Warn if an aggregate or union initializer is not fully bracketed.  In
2231 the following example, the initializer for @samp{a} is not fully
2232 bracketed, but that for @samp{b} is fully bracketed.
2233
2234 @smallexample
2235 int a[2][2] = @{ 0, 1, 2, 3 @};
2236 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2237 @end smallexample
2238
2239 @item -Wparentheses
2240 @opindex Wparentheses
2241 Warn if parentheses are omitted in certain contexts, such
2242 as when there is an assignment in a context where a truth value
2243 is expected, or when operators are nested whose precedence people
2244 often get confused about.
2245
2246 Also warn about constructions where there may be confusion to which
2247 @code{if} statement an @code{else} branch belongs.  Here is an example of
2248 such a case:
2249
2250 @smallexample
2251 @group
2252 @{
2253   if (a)
2254     if (b)
2255       foo ();
2256   else
2257     bar ();
2258 @}
2259 @end group
2260 @end smallexample
2261
2262 In C, every @code{else} branch belongs to the innermost possible @code{if}
2263 statement, which in this example is @code{if (b)}.  This is often not
2264 what the programmer expected, as illustrated in the above example by
2265 indentation the programmer chose.  When there is the potential for this
2266 confusion, GCC will issue a warning when this flag is specified.
2267 To eliminate the warning, add explicit braces around the innermost
2268 @code{if} statement so there is no way the @code{else} could belong to
2269 the enclosing @code{if}.  The resulting code would look like this:
2270
2271 @smallexample
2272 @group
2273 @{
2274   if (a)
2275     @{
2276       if (b)
2277         foo ();
2278       else
2279         bar ();
2280     @}
2281 @}
2282 @end group
2283 @end smallexample
2284
2285 @item -Wsequence-point
2286 @opindex Wsequence-point
2287 Warn about code that may have undefined semantics because of violations
2288 of sequence point rules in the C standard.
2289
2290 The C standard defines the order in which expressions in a C program are
2291 evaluated in terms of @dfn{sequence points}, which represent a partial
2292 ordering between the execution of parts of the program: those executed
2293 before the sequence point, and those executed after it.  These occur
2294 after the evaluation of a full expression (one which is not part of a
2295 larger expression), after the evaluation of the first operand of a
2296 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2297 function is called (but after the evaluation of its arguments and the
2298 expression denoting the called function), and in certain other places.
2299 Other than as expressed by the sequence point rules, the order of
2300 evaluation of subexpressions of an expression is not specified.  All
2301 these rules describe only a partial order rather than a total order,
2302 since, for example, if two functions are called within one expression
2303 with no sequence point between them, the order in which the functions
2304 are called is not specified.  However, the standards committee have
2305 ruled that function calls do not overlap.
2306
2307 It is not specified when between sequence points modifications to the
2308 values of objects take effect.  Programs whose behavior depends on this
2309 have undefined behavior; the C standard specifies that ``Between the
2310 previous and next sequence point an object shall have its stored value
2311 modified at most once by the evaluation of an expression.  Furthermore,
2312 the prior value shall be read only to determine the value to be
2313 stored.''.  If a program breaks these rules, the results on any
2314 particular implementation are entirely unpredictable.
2315
2316 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2317 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2318 diagnosed by this option, and it may give an occasional false positive
2319 result, but in general it has been found fairly effective at detecting
2320 this sort of problem in programs.
2321
2322 The present implementation of this option only works for C programs.  A
2323 future implementation may also work for C++ programs.
2324
2325 The C standard is worded confusingly, therefore there is some debate
2326 over the precise meaning of the sequence point rules in subtle cases.
2327 Links to discussions of the problem, including proposed formal
2328 definitions, may be found on our readings page, at
2329 @w{@uref{http://gcc.gnu.org/readings.html}}.
2330
2331 @item -Wreturn-type
2332 @opindex Wreturn-type
2333 Warn whenever a function is defined with a return-type that defaults to
2334 @code{int}.  Also warn about any @code{return} statement with no
2335 return-value in a function whose return-type is not @code{void}.
2336
2337 For C++, a function without return type always produces a diagnostic
2338 message, even when @option{-Wno-return-type} is specified.  The only
2339 exceptions are @samp{main} and functions defined in system headers.
2340
2341 @item -Wswitch
2342 @opindex Wswitch
2343 Warn whenever a @code{switch} statement has an index of enumeral type
2344 and lacks a @code{case} for one or more of the named codes of that
2345 enumeration.  (The presence of a @code{default} label prevents this
2346 warning.)  @code{case} labels outside the enumeration range also
2347 provoke warnings when this option is used.
2348
2349 @item -Wswitch-default
2350 @opindex Wswitch-switch
2351 Warn whenever a @code{switch} statement does not have a @code{default}
2352 case.
2353
2354 @item -Wswitch-enum
2355 @opindex Wswitch-enum
2356 Warn whenever a @code{switch} statement has an index of enumeral type
2357 and lacks a @code{case} for one or more of the named codes of that
2358 enumeration.  @code{case} labels outside the enumeration range also
2359 provoke warnings when this option is used.
2360
2361 @item -Wtrigraphs
2362 @opindex Wtrigraphs
2363 Warn if any trigraphs are encountered that might change the meaning of
2364 the program (trigraphs within comments are not warned about).
2365
2366 @item -Wunused-function
2367 @opindex Wunused-function
2368 Warn whenever a static function is declared but not defined or a
2369 non\-inline static function is unused.
2370
2371 @item -Wunused-label
2372 @opindex Wunused-label
2373 Warn whenever a label is declared but not used.
2374
2375 To suppress this warning use the @samp{unused} attribute
2376 (@pxref{Variable Attributes}).
2377
2378 @item -Wunused-parameter
2379 @opindex Wunused-parameter
2380 Warn whenever a function parameter is unused aside from its declaration.
2381
2382 To suppress this warning use the @samp{unused} attribute
2383 (@pxref{Variable Attributes}).
2384
2385 @item -Wunused-variable
2386 @opindex Wunused-variable
2387 Warn whenever a local variable or non-constant static variable is unused
2388 aside from its declaration
2389
2390 To suppress this warning use the @samp{unused} attribute
2391 (@pxref{Variable Attributes}).
2392
2393 @item -Wunused-value
2394 @opindex Wunused-value
2395 Warn whenever a statement computes a result that is explicitly not used.
2396
2397 To suppress this warning cast the expression to @samp{void}.
2398
2399 @item -Wunused
2400 @opindex Wunused
2401 All the above @option{-Wunused} options combined.
2402
2403 In order to get a warning about an unused function parameter, you must
2404 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2405 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2406
2407 @item -Wuninitialized
2408 @opindex Wuninitialized
2409 Warn if an automatic variable is used without first being initialized or
2410 if a variable may be clobbered by a @code{setjmp} call.
2411
2412 These warnings are possible only in optimizing compilation,
2413 because they require data flow information that is computed only
2414 when optimizing.  If you don't specify @option{-O}, you simply won't
2415 get these warnings.
2416
2417 If you want to warn about code which uses the uninitialized value of the
2418 variable in its own initializer, use the @option{-Winit-self} option.
2419
2420 These warnings occur only for variables that are candidates for
2421 register allocation.  Therefore, they do not occur for a variable that
2422 is declared @code{volatile}, or whose address is taken, or whose size
2423 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2424 structures, unions or arrays, even when they are in registers.
2425
2426 Note that there may be no warning about a variable that is used only
2427 to compute a value that itself is never used, because such
2428 computations may be deleted by data flow analysis before the warnings
2429 are printed.
2430
2431 These warnings are made optional because GCC is not smart
2432 enough to see all the reasons why the code might be correct
2433 despite appearing to have an error.  Here is one example of how
2434 this can happen:
2435
2436 @smallexample
2437 @group
2438 @{
2439   int x;
2440   switch (y)
2441     @{
2442     case 1: x = 1;
2443       break;
2444     case 2: x = 4;
2445       break;
2446     case 3: x = 5;
2447     @}
2448   foo (x);
2449 @}
2450 @end group
2451 @end smallexample
2452
2453 @noindent
2454 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2455 always initialized, but GCC doesn't know this.  Here is
2456 another common case:
2457
2458 @smallexample
2459 @{
2460   int save_y;
2461   if (change_y) save_y = y, y = new_y;
2462   @dots{}
2463   if (change_y) y = save_y;
2464 @}
2465 @end smallexample
2466
2467 @noindent
2468 This has no bug because @code{save_y} is used only if it is set.
2469
2470 @cindex @code{longjmp} warnings
2471 This option also warns when a non-volatile automatic variable might be
2472 changed by a call to @code{longjmp}.  These warnings as well are possible
2473 only in optimizing compilation.
2474
2475 The compiler sees only the calls to @code{setjmp}.  It cannot know
2476 where @code{longjmp} will be called; in fact, a signal handler could
2477 call it at any point in the code.  As a result, you may get a warning
2478 even when there is in fact no problem because @code{longjmp} cannot
2479 in fact be called at the place which would cause a problem.
2480
2481 Some spurious warnings can be avoided if you declare all the functions
2482 you use that never return as @code{noreturn}.  @xref{Function
2483 Attributes}.
2484
2485 @item -Wunknown-pragmas
2486 @opindex Wunknown-pragmas
2487 @cindex warning for unknown pragmas
2488 @cindex unknown pragmas, warning
2489 @cindex pragmas, warning of unknown
2490 Warn when a #pragma directive is encountered which is not understood by
2491 GCC@.  If this command line option is used, warnings will even be issued
2492 for unknown pragmas in system header files.  This is not the case if
2493 the warnings were only enabled by the @option{-Wall} command line option.
2494
2495 @item -Wstrict-aliasing
2496 @opindex Wstrict-aliasing
2497 This option is only active when @option{-fstrict-aliasing} is active.
2498 It warns about code which might break the strict aliasing rules that the
2499 compiler is using for optimization. The warning does not catch all
2500 cases, but does attempt to catch the more common pitfalls. It is
2501 included in @option{-Wall}.
2502
2503 @item -Wall
2504 @opindex Wall
2505 All of the above @samp{-W} options combined.  This enables all the
2506 warnings about constructions that some users consider questionable, and
2507 that are easy to avoid (or modify to prevent the warning), even in
2508 conjunction with macros.  This also enables some language-specific
2509 warnings described in @ref{C++ Dialect Options} and
2510 @ref{Objective-C Dialect Options}.
2511 @end table
2512
2513 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2514 Some of them warn about constructions that users generally do not
2515 consider questionable, but which occasionally you might wish to check
2516 for; others warn about constructions that are necessary or hard to avoid
2517 in some cases, and there is no simple way to modify the code to suppress
2518 the warning.
2519
2520 @table @gcctabopt
2521 @item -Wextra
2522 @opindex W
2523 @opindex Wextra
2524 (This option used to be called @option{-W}.  The older name is still
2525 supported, but the newer name is more descriptive.)  Print extra warning
2526 messages for these events:
2527
2528 @itemize @bullet
2529 @item
2530 A function can return either with or without a value.  (Falling
2531 off the end of the function body is considered returning without
2532 a value.)  For example, this function would evoke such a
2533 warning:
2534
2535 @smallexample
2536 @group
2537 foo (a)
2538 @{
2539   if (a > 0)
2540     return a;
2541 @}
2542 @end group
2543 @end smallexample
2544
2545 @item
2546 An expression-statement or the left-hand side of a comma expression
2547 contains no side effects.
2548 To suppress the warning, cast the unused expression to void.
2549 For example, an expression such as @samp{x[i,j]} will cause a warning,
2550 but @samp{x[(void)i,j]} will not.
2551
2552 @item
2553 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2554
2555 @item
2556 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2557 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2558 that of ordinary mathematical notation.
2559
2560 @item
2561 Storage-class specifiers like @code{static} are not the first things in
2562 a declaration.  According to the C Standard, this usage is obsolescent.
2563
2564 @item
2565 The return type of a function has a type qualifier such as @code{const}.
2566 Such a type qualifier has no effect, since the value returned by a
2567 function is not an lvalue.  (But don't warn about the GNU extension of
2568 @code{volatile void} return types.  That extension will be warned about
2569 if @option{-pedantic} is specified.)
2570
2571 @item
2572 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2573 arguments.
2574
2575 @item
2576 A comparison between signed and unsigned values could produce an
2577 incorrect result when the signed value is converted to unsigned.
2578 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2579
2580 @item
2581 An aggregate has an initializer which does not initialize all members.
2582 For example, the following code would cause such a warning, because
2583 @code{x.h} would be implicitly initialized to zero:
2584
2585 @smallexample
2586 struct s @{ int f, g, h; @};
2587 struct s x = @{ 3, 4 @};
2588 @end smallexample
2589
2590 @item
2591 A function parameter is declared without a type specifier in K&R-style
2592 functions:
2593
2594 @smallexample
2595 void foo(bar) @{ @}
2596 @end smallexample
2597
2598 @item
2599 An empty body occurs in an @samp{if} or @samp{else} statement.
2600
2601 @item
2602 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2603 @samp{>}, or @samp{>=}.
2604
2605 @item
2606 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2607
2608 @item
2609 Any of several floating-point events that often indicate errors, such as
2610 overflow, underflow, loss of precision, etc.
2611
2612 @item @r{(C++ only)}
2613 An enumerator and a non-enumerator both appear in a conditional expression.
2614
2615 @item @r{(C++ only)}
2616 A non-static reference or non-static @samp{const} member appears in a
2617 class without constructors.
2618
2619 @item @r{(C++ only)}
2620 Ambiguous virtual bases.
2621
2622 @item @r{(C++ only)}
2623 Subscripting an array which has been declared @samp{register}.
2624
2625 @item @r{(C++ only)}
2626 Taking the address of a variable which has been declared @samp{register}.
2627
2628 @item @r{(C++ only)}
2629 A base class is not initialized in a derived class' copy constructor.
2630 @end itemize
2631
2632 @item -Wno-div-by-zero
2633 @opindex Wno-div-by-zero
2634 @opindex Wdiv-by-zero
2635 Do not warn about compile-time integer division by zero.  Floating point
2636 division by zero is not warned about, as it can be a legitimate way of
2637 obtaining infinities and NaNs.
2638
2639 @item -Wsystem-headers
2640 @opindex Wsystem-headers
2641 @cindex warnings from system headers
2642 @cindex system headers, warnings from
2643 Print warning messages for constructs found in system header files.
2644 Warnings from system headers are normally suppressed, on the assumption
2645 that they usually do not indicate real problems and would only make the
2646 compiler output harder to read.  Using this command line option tells
2647 GCC to emit warnings from system headers as if they occurred in user
2648 code.  However, note that using @option{-Wall} in conjunction with this
2649 option will @emph{not} warn about unknown pragmas in system
2650 headers---for that, @option{-Wunknown-pragmas} must also be used.
2651
2652 @item -Wfloat-equal
2653 @opindex Wfloat-equal
2654 Warn if floating point values are used in equality comparisons.
2655
2656 The idea behind this is that sometimes it is convenient (for the
2657 programmer) to consider floating-point values as approximations to
2658 infinitely precise real numbers.  If you are doing this, then you need
2659 to compute (by analyzing the code, or in some other way) the maximum or
2660 likely maximum error that the computation introduces, and allow for it
2661 when performing comparisons (and when producing output, but that's a
2662 different problem).  In particular, instead of testing for equality, you
2663 would check to see whether the two values have ranges that overlap; and
2664 this is done with the relational operators, so equality comparisons are
2665 probably mistaken.
2666
2667 @item -Wtraditional @r{(C only)}
2668 @opindex Wtraditional
2669 Warn about certain constructs that behave differently in traditional and
2670 ISO C@.  Also warn about ISO C constructs that have no traditional C
2671 equivalent, and/or problematic constructs which should be avoided.
2672
2673 @itemize @bullet
2674 @item
2675 Macro parameters that appear within string literals in the macro body.
2676 In traditional C macro replacement takes place within string literals,
2677 but does not in ISO C@.
2678
2679 @item
2680 In traditional C, some preprocessor directives did not exist.
2681 Traditional preprocessors would only consider a line to be a directive
2682 if the @samp{#} appeared in column 1 on the line.  Therefore
2683 @option{-Wtraditional} warns about directives that traditional C
2684 understands but would ignore because the @samp{#} does not appear as the
2685 first character on the line.  It also suggests you hide directives like
2686 @samp{#pragma} not understood by traditional C by indenting them.  Some
2687 traditional implementations would not recognize @samp{#elif}, so it
2688 suggests avoiding it altogether.
2689
2690 @item
2691 A function-like macro that appears without arguments.
2692
2693 @item
2694 The unary plus operator.
2695
2696 @item
2697 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2698 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2699 constants.)  Note, these suffixes appear in macros defined in the system
2700 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2701 Use of these macros in user code might normally lead to spurious
2702 warnings, however gcc's integrated preprocessor has enough context to
2703 avoid warning in these cases.
2704
2705 @item
2706 A function declared external in one block and then used after the end of
2707 the block.
2708
2709 @item
2710 A @code{switch} statement has an operand of type @code{long}.
2711
2712 @item
2713 A non-@code{static} function declaration follows a @code{static} one.
2714 This construct is not accepted by some traditional C compilers.
2715
2716 @item
2717 The ISO type of an integer constant has a different width or
2718 signedness from its traditional type.  This warning is only issued if
2719 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2720 typically represent bit patterns, are not warned about.
2721
2722 @item
2723 Usage of ISO string concatenation is detected.
2724
2725 @item
2726 Initialization of automatic aggregates.
2727
2728 @item
2729 Identifier conflicts with labels.  Traditional C lacks a separate
2730 namespace for labels.
2731
2732 @item
2733 Initialization of unions.  If the initializer is zero, the warning is
2734 omitted.  This is done under the assumption that the zero initializer in
2735 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2736 initializer warnings and relies on default initialization to zero in the
2737 traditional C case.
2738
2739 @item
2740 Conversions by prototypes between fixed/floating point values and vice
2741 versa.  The absence of these prototypes when compiling with traditional
2742 C would cause serious problems.  This is a subset of the possible
2743 conversion warnings, for the full set use @option{-Wconversion}.
2744
2745 @item
2746 Use of ISO C style function definitions.  This warning intentionally is
2747 @emph{not} issued for prototype declarations or variadic functions
2748 because these ISO C features will appear in your code when using
2749 libiberty's traditional C compatibility macros, @code{PARAMS} and
2750 @code{VPARAMS}.  This warning is also bypassed for nested functions
2751 because that feature is already a gcc extension and thus not relevant to
2752 traditional C compatibility.
2753 @end itemize
2754
2755 @item -Wdeclaration-after-statement @r{(C only)}
2756 @opindex Wdeclaration-after-statement
2757 Warn when a declaration is found after a statement in a block.  This
2758 construct, known from C++, was introduced with ISO C99 and is by default
2759 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2760 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2761
2762 @item -Wundef
2763 @opindex Wundef
2764 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2765
2766 @item -Wendif-labels
2767 @opindex Wendif-labels
2768 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2769
2770 @item -Wshadow
2771 @opindex Wshadow
2772 Warn whenever a local variable shadows another local variable, parameter or
2773 global variable or whenever a built-in function is shadowed.
2774
2775 @item -Wlarger-than-@var{len}
2776 @opindex Wlarger-than
2777 Warn whenever an object of larger than @var{len} bytes is defined.
2778
2779 @item -Wpointer-arith
2780 @opindex Wpointer-arith
2781 Warn about anything that depends on the ``size of'' a function type or
2782 of @code{void}.  GNU C assigns these types a size of 1, for
2783 convenience in calculations with @code{void *} pointers and pointers
2784 to functions.
2785
2786 @item -Wbad-function-cast @r{(C only)}
2787 @opindex Wbad-function-cast
2788 Warn whenever a function call is cast to a non-matching type.
2789 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2790
2791 @item -Wcast-qual
2792 @opindex Wcast-qual
2793 Warn whenever a pointer is cast so as to remove a type qualifier from
2794 the target type.  For example, warn if a @code{const char *} is cast
2795 to an ordinary @code{char *}.
2796
2797 @item -Wcast-align
2798 @opindex Wcast-align
2799 Warn whenever a pointer is cast such that the required alignment of the
2800 target is increased.  For example, warn if a @code{char *} is cast to
2801 an @code{int *} on machines where integers can only be accessed at
2802 two- or four-byte boundaries.
2803
2804 @item -Wwrite-strings
2805 @opindex Wwrite-strings
2806 When compiling C, give string constants the type @code{const
2807 char[@var{length}]} so that
2808 copying the address of one into a non-@code{const} @code{char *}
2809 pointer will get a warning; when compiling C++, warn about the
2810 deprecated conversion from string constants to @code{char *}.
2811 These warnings will help you find at
2812 compile time code that can try to write into a string constant, but
2813 only if you have been very careful about using @code{const} in
2814 declarations and prototypes.  Otherwise, it will just be a nuisance;
2815 this is why we did not make @option{-Wall} request these warnings.
2816
2817 @item -Wconversion
2818 @opindex Wconversion
2819 Warn if a prototype causes a type conversion that is different from what
2820 would happen to the same argument in the absence of a prototype.  This
2821 includes conversions of fixed point to floating and vice versa, and
2822 conversions changing the width or signedness of a fixed point argument
2823 except when the same as the default promotion.
2824
2825 Also, warn if a negative integer constant expression is implicitly
2826 converted to an unsigned type.  For example, warn about the assignment
2827 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2828 casts like @code{(unsigned) -1}.
2829
2830 @item -Wsign-compare
2831 @opindex Wsign-compare
2832 @cindex warning for comparison of signed and unsigned values
2833 @cindex comparison of signed and unsigned values, warning
2834 @cindex signed and unsigned values, comparison warning
2835 Warn when a comparison between signed and unsigned values could produce
2836 an incorrect result when the signed value is converted to unsigned.
2837 This warning is also enabled by @option{-Wextra}; to get the other warnings
2838 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2839
2840 @item -Waggregate-return
2841 @opindex Waggregate-return
2842 Warn if any functions that return structures or unions are defined or
2843 called.  (In languages where you can return an array, this also elicits
2844 a warning.)
2845
2846 @item -Wstrict-prototypes @r{(C only)}
2847 @opindex Wstrict-prototypes
2848 Warn if a function is declared or defined without specifying the
2849 argument types.  (An old-style function definition is permitted without
2850 a warning if preceded by a declaration which specifies the argument
2851 types.)
2852
2853 @item -Wold-style-definition @r{(C only)}
2854 @opindex Wold-style-definition
2855 Warn if an old-style function definition is used.  A warning is given
2856 even if there is a previous prototype.
2857
2858 @item -Wmissing-prototypes @r{(C only)}
2859 @opindex Wmissing-prototypes
2860 Warn if a global function is defined without a previous prototype
2861 declaration.  This warning is issued even if the definition itself
2862 provides a prototype.  The aim is to detect global functions that fail
2863 to be declared in header files.
2864
2865 @item -Wmissing-declarations @r{(C only)}
2866 @opindex Wmissing-declarations
2867 Warn if a global function is defined without a previous declaration.
2868 Do so even if the definition itself provides a prototype.
2869 Use this option to detect global functions that are not declared in
2870 header files.
2871
2872 @item -Wmissing-noreturn
2873 @opindex Wmissing-noreturn
2874 Warn about functions which might be candidates for attribute @code{noreturn}.
2875 Note these are only possible candidates, not absolute ones.  Care should
2876 be taken to manually verify functions actually do not ever return before
2877 adding the @code{noreturn} attribute, otherwise subtle code generation
2878 bugs could be introduced.  You will not get a warning for @code{main} in
2879 hosted C environments.
2880
2881 @item -Wmissing-format-attribute
2882 @opindex Wmissing-format-attribute
2883 @opindex Wformat
2884 If @option{-Wformat} is enabled, also warn about functions which might be
2885 candidates for @code{format} attributes.  Note these are only possible
2886 candidates, not absolute ones.  GCC will guess that @code{format}
2887 attributes might be appropriate for any function that calls a function
2888 like @code{vprintf} or @code{vscanf}, but this might not always be the
2889 case, and some functions for which @code{format} attributes are
2890 appropriate may not be detected.  This option has no effect unless
2891 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2892
2893 @item -Wno-multichar
2894 @opindex Wno-multichar
2895 @opindex Wmultichar
2896 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2897 Usually they indicate a typo in the user's code, as they have
2898 implementation-defined values, and should not be used in portable code.
2899
2900 @item -Wno-deprecated-declarations
2901 @opindex Wno-deprecated-declarations
2902 Do not warn about uses of functions, variables, and types marked as
2903 deprecated by using the @code{deprecated} attribute.
2904 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2905 @pxref{Type Attributes}.)
2906
2907 @item -Wpacked
2908 @opindex Wpacked
2909 Warn if a structure is given the packed attribute, but the packed
2910 attribute has no effect on the layout or size of the structure.
2911 Such structures may be mis-aligned for little benefit.  For
2912 instance, in this code, the variable @code{f.x} in @code{struct bar}
2913 will be misaligned even though @code{struct bar} does not itself
2914 have the packed attribute:
2915
2916 @smallexample
2917 @group
2918 struct foo @{
2919   int x;
2920   char a, b, c, d;
2921 @} __attribute__((packed));
2922 struct bar @{
2923   char z;
2924   struct foo f;
2925 @};
2926 @end group
2927 @end smallexample
2928
2929 @item -Wpadded
2930 @opindex Wpadded
2931 Warn if padding is included in a structure, either to align an element
2932 of the structure or to align the whole structure.  Sometimes when this
2933 happens it is possible to rearrange the fields of the structure to
2934 reduce the padding and so make the structure smaller.
2935
2936 @item -Wredundant-decls
2937 @opindex Wredundant-decls
2938 Warn if anything is declared more than once in the same scope, even in
2939 cases where multiple declaration is valid and changes nothing.
2940
2941 @item -Wnested-externs @r{(C only)}
2942 @opindex Wnested-externs
2943 Warn if an @code{extern} declaration is encountered within a function.
2944
2945 @item -Wunreachable-code
2946 @opindex Wunreachable-code
2947 Warn if the compiler detects that code will never be executed.
2948
2949 This option is intended to warn when the compiler detects that at
2950 least a whole line of source code will never be executed, because
2951 some condition is never satisfied or because it is after a
2952 procedure that never returns.
2953
2954 It is possible for this option to produce a warning even though there
2955 are circumstances under which part of the affected line can be executed,
2956 so care should be taken when removing apparently-unreachable code.
2957
2958 For instance, when a function is inlined, a warning may mean that the
2959 line is unreachable in only one inlined copy of the function.
2960
2961 This option is not made part of @option{-Wall} because in a debugging
2962 version of a program there is often substantial code which checks
2963 correct functioning of the program and is, hopefully, unreachable
2964 because the program does work.  Another common use of unreachable
2965 code is to provide behavior which is selectable at compile-time.
2966
2967 @item -Winline
2968 @opindex Winline
2969 Warn if a function can not be inlined and it was declared as inline.
2970 Even with this option, the compiler will not warn about failures to
2971 inline functions declared in system headers.  
2972
2973 The compiler uses a variety of heuristics to determine whether or not
2974 to inline a function.  For example, the compiler takes into account
2975 the size of the function being inlined and the the amount of inlining
2976 that has already been done in the current function.  Therefore,
2977 seemingly insignificant changes in the source program can cause the
2978 warnings produced by @option{-Winline} to appear or disappear.
2979
2980 @item -Wno-invalid-offsetof @r{(C++ only)}
2981 @opindex Wno-invalid-offsetof
2982 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2983 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2984 to a non-POD type is undefined.  In existing C++ implementations,
2985 however, @samp{offsetof} typically gives meaningful results even when
2986 applied to certain kinds of non-POD types. (Such as a simple
2987 @samp{struct} that fails to be a POD type only by virtue of having a
2988 constructor.)  This flag is for users who are aware that they are
2989 writing nonportable code and who have deliberately chosen to ignore the
2990 warning about it.
2991
2992 The restrictions on @samp{offsetof} may be relaxed in a future version
2993 of the C++ standard.
2994
2995 @item -Winvalid-pch
2996 @opindex Winvalid-pch
2997 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2998 the search path but can't be used.
2999
3000 @item -Wlong-long
3001 @opindex Wlong-long
3002 @opindex Wno-long-long
3003 Warn if @samp{long long} type is used.  This is default.  To inhibit
3004 the warning messages, use @option{-Wno-long-long}.  Flags
3005 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3006 only when @option{-pedantic} flag is used.
3007
3008 @item -Wdisabled-optimization
3009 @opindex Wdisabled-optimization
3010 Warn if a requested optimization pass is disabled.  This warning does
3011 not generally indicate that there is anything wrong with your code; it
3012 merely indicates that GCC's optimizers were unable to handle the code
3013 effectively.  Often, the problem is that your code is too big or too
3014 complex; GCC will refuse to optimize programs when the optimization
3015 itself is likely to take inordinate amounts of time.
3016
3017 @item -Werror
3018 @opindex Werror
3019 Make all warnings into errors.
3020 @end table
3021
3022 @node Debugging Options
3023 @section Options for Debugging Your Program or GCC
3024 @cindex options, debugging
3025 @cindex debugging information options
3026
3027 GCC has various special options that are used for debugging
3028 either your program or GCC:
3029
3030 @table @gcctabopt
3031 @item -g
3032 @opindex g
3033 Produce debugging information in the operating system's native format
3034 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3035 information.
3036
3037 On most systems that use stabs format, @option{-g} enables use of extra
3038 debugging information that only GDB can use; this extra information
3039 makes debugging work better in GDB but will probably make other debuggers
3040 crash or
3041 refuse to read the program.  If you want to control for certain whether
3042 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3043 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
3044 or @option{-gvms} (see below).
3045
3046 Unlike most other C compilers, GCC allows you to use @option{-g} with
3047 @option{-O}.  The shortcuts taken by optimized code may occasionally
3048 produce surprising results: some variables you declared may not exist
3049 at all; flow of control may briefly move where you did not expect it;
3050 some statements may not be executed because they compute constant
3051 results or their values were already at hand; some statements may
3052 execute in different places because they were moved out of loops.
3053
3054 Nevertheless it proves possible to debug optimized output.  This makes
3055 it reasonable to use the optimizer for programs that might have bugs.
3056
3057 The following options are useful when GCC is generated with the
3058 capability for more than one debugging format.
3059
3060 @item -ggdb
3061 @opindex ggdb
3062 Produce debugging information for use by GDB@.  This means to use the
3063 most expressive format available (DWARF 2, stabs, or the native format
3064 if neither of those are supported), including GDB extensions if at all
3065 possible.
3066
3067 @item -gstabs
3068 @opindex gstabs
3069 Produce debugging information in stabs format (if that is supported),
3070 without GDB extensions.  This is the format used by DBX on most BSD
3071 systems.  On MIPS, Alpha and System V Release 4 systems this option
3072 produces stabs debugging output which is not understood by DBX or SDB@.
3073 On System V Release 4 systems this option requires the GNU assembler.
3074
3075 @item -feliminate-unused-debug-symbols
3076 @opindex feliminate-unused-debug-symbols
3077 Produce debugging information in stabs format (if that is supported),
3078 for only symbols that are actually used.
3079
3080 @item -gstabs+
3081 @opindex gstabs+
3082 Produce debugging information in stabs format (if that is supported),
3083 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3084 use of these extensions is likely to make other debuggers crash or
3085 refuse to read the program.
3086
3087 @item -gcoff
3088 @opindex gcoff
3089 Produce debugging information in COFF format (if that is supported).
3090 This is the format used by SDB on most System V systems prior to
3091 System V Release 4.
3092
3093 @item -gxcoff
3094 @opindex gxcoff
3095 Produce debugging information in XCOFF format (if that is supported).
3096 This is the format used by the DBX debugger on IBM RS/6000 systems.
3097
3098 @item -gxcoff+
3099 @opindex gxcoff+
3100 Produce debugging information in XCOFF format (if that is supported),
3101 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3102 use of these extensions is likely to make other debuggers crash or
3103 refuse to read the program, and may cause assemblers other than the GNU
3104 assembler (GAS) to fail with an error.
3105
3106 @item -gdwarf
3107 @opindex gdwarf
3108 Produce debugging information in DWARF version 1 format (if that is
3109 supported).  This is the format used by SDB on most System V Release 4
3110 systems.
3111
3112 This option is deprecated.
3113
3114 @item -gdwarf+
3115 @opindex gdwarf+
3116 Produce debugging information in DWARF version 1 format (if that is
3117 supported), using GNU extensions understood only by the GNU debugger
3118 (GDB)@.  The use of these extensions is likely to make other debuggers
3119 crash or refuse to read the program.
3120
3121 This option is deprecated.
3122
3123 @item -gdwarf-2
3124 @opindex gdwarf-2
3125 Produce debugging information in DWARF version 2 format (if that is
3126 supported).  This is the format used by DBX on IRIX 6.
3127
3128 @item -gvms
3129 @opindex gvms
3130 Produce debugging information in VMS debug format (if that is
3131 supported).  This is the format used by DEBUG on VMS systems.
3132
3133 @item -g@var{level}
3134 @itemx -ggdb@var{level}
3135 @itemx -gstabs@var{level}
3136 @itemx -gcoff@var{level}
3137 @itemx -gxcoff@var{level}
3138 @itemx -gvms@var{level}
3139 Request debugging information and also use @var{level} to specify how
3140 much information.  The default level is 2.
3141
3142 Level 1 produces minimal information, enough for making backtraces in
3143 parts of the program that you don't plan to debug.  This includes
3144 descriptions of functions and external variables, but no information
3145 about local variables and no line numbers.
3146
3147 Level 3 includes extra information, such as all the macro definitions
3148 present in the program.  Some debuggers support macro expansion when
3149 you use @option{-g3}.
3150
3151 Note that in order to avoid confusion between DWARF1 debug level 2,
3152 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
3153 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
3154 option to change the debug level for DWARF1 or DWARF2.
3155
3156 @item -feliminate-dwarf2-dups
3157 @opindex feliminate-dwarf2-dups
3158 Compress DWARF2 debugging information by eliminating duplicated
3159 information about each symbol.  This option only makes sense when
3160 generating DWARF2 debugging information with @option{-gdwarf-2}.
3161
3162 @cindex @command{prof}
3163 @item -p
3164 @opindex p
3165 Generate extra code to write profile information suitable for the
3166 analysis program @command{prof}.  You must use this option when compiling
3167 the source files you want data about, and you must also use it when
3168 linking.
3169
3170 @cindex @command{gprof}
3171 @item -pg
3172 @opindex pg
3173 Generate extra code to write profile information suitable for the
3174 analysis program @command{gprof}.  You must use this option when compiling
3175 the source files you want data about, and you must also use it when
3176 linking.
3177
3178 @item -Q
3179 @opindex Q
3180 Makes the compiler print out each function name as it is compiled, and
3181 print some statistics about each pass when it finishes.
3182
3183 @item -ftime-report
3184 @opindex ftime-report
3185 Makes the compiler print some statistics about the time consumed by each
3186 pass when it finishes.
3187
3188 @item -fmem-report
3189 @opindex fmem-report
3190 Makes the compiler print some statistics about permanent memory
3191 allocation when it finishes.
3192
3193 @item -fprofile-arcs
3194 @opindex fprofile-arcs
3195 Add code so that program flow @dfn{arcs} are instrumented.  During
3196 execution the program records how many times each branch and call is
3197 executed and how many times it is taken or returns.  When the compiled
3198 program exits it saves this data to a file called
3199 @file{@var{auxname}.gcda} for each source file. The data may be used for
3200 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3201 test coverage analysis (@option{-ftest-coverage}). Each object file's
3202 @var{auxname} is generated from the name of the output file, if
3203 explicitly specified and it is not the final executable, otherwise it is
3204 the basename of the source file. In both cases any suffix is removed
3205 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3206 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3207
3208 @itemize
3209
3210 @item
3211 Compile the source files with @option{-fprofile-arcs} plus optimization
3212 and code generation options. For test coverage analysis, use the
3213 additional @option{-ftest-coverage} option. You do not need to profile
3214 every source file in a program.
3215
3216 @item
3217 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3218 (the latter implies the former).
3219
3220 @item
3221 Run the program on a representative workload to generate the arc profile
3222 information. This may be repeated any number of times. You can run
3223 concurrent instances of your program, and provided that the file system
3224 supports locking, the data files will be correctly updated. Also
3225 @code{fork} calls are detected and correctly handled (double counting
3226 will not happen).
3227
3228 @item
3229 For profile-directed optimizations, compile the source files again with
3230 the same optimization and code generation options plus
3231 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3232 Control Optimization}).
3233
3234 @item
3235 For test coverage analysis, use @command{gcov} to produce human readable
3236 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3237 @command{gcov} documentation for further information.
3238
3239 @end itemize
3240
3241 With @option{-fprofile-arcs}, for each function of your program GCC
3242 creates a program flow graph, then finds a spanning tree for the graph.
3243 Only arcs that are not on the spanning tree have to be instrumented: the
3244 compiler adds code to count the number of times that these arcs are
3245 executed.  When an arc is the only exit or only entrance to a block, the
3246 instrumentation code can be added to the block; otherwise, a new basic
3247 block must be created to hold the instrumentation code.
3248
3249 @need 2000
3250 @item -ftest-coverage
3251 @opindex ftest-coverage
3252 Produce a notes file that the @command{gcov} code-coverage utility
3253 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3254 show program coverage. Each source file's note file is called
3255 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3256 above for a description of @var{auxname} and instructions on how to
3257 generate test coverage data. Coverage data will match the source files
3258 more closely, if you do not optimize.
3259
3260 @item -d@var{letters}
3261 @opindex d
3262 Says to make debugging dumps during compilation at times specified by
3263 @var{letters}.  This is used for debugging the compiler.  The file names
3264 for most of the dumps are made by appending a pass number and a word to
3265 the @var{dumpname}. @var{dumpname} is generated from the name of the
3266 output file, if explicitly specified and it is not an executable,
3267 otherwise it is the basename of the source file. In both cases any
3268 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3269 Here are the possible letters for use in @var{letters}, and their
3270 meanings:
3271
3272 @table @samp
3273 @item A
3274 @opindex dA
3275 Annotate the assembler output with miscellaneous debugging information.
3276 @item b
3277 @opindex db
3278 Dump after computing branch probabilities, to @file{@var{file}.16.bp}.
3279 @item B
3280 @opindex dB
3281 Dump after block reordering, to @file{@var{file}.32.bbro}.
3282 @item c
3283 @opindex dc
3284 Dump after instruction combination, to the file @file{@var{file}.22.combine}.
3285 @item C
3286 @opindex dC
3287 Dump after the first if conversion, to the file @file{@var{file}.17.ce1}.
3288 Also dump after the second if conversion, to the file @file{@var{file}.23.ce2}.
3289 @item d
3290 @opindex dd
3291 Dump after branch target load optimization, to to @file{@var{file}.34.btl}.
3292 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3293 @item D
3294 @opindex dD
3295 Dump all macro definitions, at the end of preprocessing, in addition to
3296 normal output.
3297 @item e
3298 @opindex de
3299 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
3300 @file{@var{file}.010.ussa}.
3301 @item E
3302 @opindex dE
3303 Dump after the second if conversion, to @file{@var{file}.33.ce3}.
3304 @item f
3305 @opindex df
3306 Dump after control and data flow analysis, to @file{@var{file}.15.cfg}.
3307 Also dump after life analysis, to @file{@var{file}.21.life}.
3308 @item F
3309 @opindex dF
3310 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.11.addressof}.
3311 @item g
3312 @opindex dg
3313 Dump after global register allocation, to @file{@var{file}.27.greg}.
3314 @item G
3315 @opindex dG
3316 Dump after GCSE, to @file{@var{file}.12.gcse}.
3317 Also dump after jump bypassing and control flow optimizations, to
3318 @file{@var{file}.14.bypass}.
3319 @item h
3320 @opindex dh
3321 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3322 @item i
3323 @opindex di
3324 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3325 @item j
3326 @opindex dj
3327 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3328 @item k
3329 @opindex dk
3330 Dump after conversion from registers to stack, to @file{@var{file}.36.stack}.
3331 @item l
3332 @opindex dl
3333 Dump after local register allocation, to @file{@var{file}.26.lreg}.
3334 @item L
3335 @opindex dL
3336 Dump after loop optimization passes, to @file{@var{file}.13.loop} and
3337 @file{@var{file}.19.loop2}.
3338 @item M
3339 @opindex dM
3340 Dump after performing the machine dependent reorganization pass, to
3341 @file{@var{file}.37.mach}.
3342 @item n
3343 @opindex dn
3344 Dump after register renumbering, to @file{@var{file}.31.rnreg}.
3345 @item N
3346 @opindex dN
3347 Dump after the register move pass, to @file{@var{file}.24.regmove}.
3348 @item o
3349 @opindex do
3350 Dump after post-reload optimizations, to @file{@var{file}.28.postreload}.
3351 @item r
3352 @opindex dr
3353 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3354 @item R
3355 @opindex dR
3356 Dump after the second scheduling pass, to @file{@var{file}.35.sched2}.
3357 @item s
3358 @opindex ds
3359 Dump after CSE (including the jump optimization that sometimes follows
3360 CSE), to @file{@var{file}.019.cse}.
3361 @item S
3362 @opindex dS
3363 Dump after the first scheduling pass, to @file{@var{file}.25.sched}.
3364 @item t
3365 @opindex dt
3366 Dump after the second CSE pass (including the jump optimization that
3367 sometimes follows CSE), to @file{@var{file}.20.cse2}.
3368 @item T
3369 @opindex dT
3370 Dump after running tracer, to @file{@var{file}.18.tracer}.
3371 @item u
3372 @opindex du
3373 Dump after null pointer elimination pass to @file{@var{file}.018.null}.
3374 @item U
3375 @opindex dU
3376 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3377 @item w
3378 @opindex dw
3379 Dump after the second flow pass, to @file{@var{file}.29.flow2}.
3380 @item W
3381 @opindex dW
3382 Dump after SSA conditional constant propagation, to
3383 @file{@var{file}.06.ssaccp}.
3384 @item X
3385 @opindex dX
3386 Dump after SSA dead code elimination, to @file{@var{file}.07.ssadce}.
3387 @item z
3388 @opindex dz
3389 Dump after the peephole pass, to @file{@var{file}.30.peephole2}.
3390 @item a
3391 @opindex da
3392 Produce all the dumps listed above.
3393 @item H
3394 @opindex dH
3395 Produce a core dump whenever an error occurs.
3396 @item m
3397 @opindex dm
3398 Print statistics on memory usage, at the end of the run, to
3399 standard error.
3400 @item p
3401 @opindex dp
3402 Annotate the assembler output with a comment indicating which
3403 pattern and alternative was used.  The length of each instruction is
3404 also printed.
3405 @item P
3406 @opindex dP
3407 Dump the RTL in the assembler output as a comment before each instruction.
3408 Also turns on @option{-dp} annotation.
3409 @item v
3410 @opindex dv
3411 For each of the other indicated dump files (except for
3412 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3413 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3414 @item x
3415 @opindex dx
3416 Just generate RTL for a function instead of compiling it.  Usually used
3417 with @samp{r}.
3418 @item y
3419 @opindex dy
3420 Dump debugging information during parsing, to standard error.
3421 @end table
3422
3423 @item -fdump-unnumbered
3424 @opindex fdump-unnumbered
3425 When doing debugging dumps (see @option{-d} option above), suppress instruction
3426 numbers and line number note output.  This makes it more feasible to
3427 use diff on debugging dumps for compiler invocations with different
3428 options, in particular with and without @option{-g}.
3429
3430 @item -fdump-translation-unit @r{(C and C++ only)}
3431 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3432 @opindex fdump-translation-unit
3433 Dump a representation of the tree structure for the entire translation
3434 unit to a file.  The file name is made by appending @file{.tu} to the
3435 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3436 controls the details of the dump as described for the
3437 @option{-fdump-tree} options.
3438
3439 @item -fdump-class-hierarchy @r{(C++ only)}
3440 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3441 @opindex fdump-class-hierarchy
3442 Dump a representation of each class's hierarchy and virtual function
3443 table layout to a file.  The file name is made by appending @file{.class}
3444 to the source file name.  If the @samp{-@var{options}} form is used,
3445 @var{options} controls the details of the dump as described for the
3446 @option{-fdump-tree} options.
3447
3448 @item -fdump-tree-@var{switch} @r{(C++ only)}
3449 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3450 @opindex fdump-tree
3451 Control the dumping at various stages of processing the intermediate
3452 language tree to a file.  The file name is generated by appending a switch
3453 specific suffix to the source file name.  If the @samp{-@var{options}}
3454 form is used, @var{options} is a list of @samp{-} separated options that
3455 control the details of the dump. Not all options are applicable to all
3456 dumps, those which are not meaningful will be ignored. The following
3457 options are available
3458
3459 @table @samp
3460 @item address
3461 Print the address of each node.  Usually this is not meaningful as it
3462 changes according to the environment and source file. Its primary use
3463 is for tying up a dump file with a debug environment.
3464 @item slim
3465 Inhibit dumping of members of a scope or body of a function merely
3466 because that scope has been reached. Only dump such items when they
3467 are directly reachable by some other path.
3468 @item all
3469 Turn on all options.
3470 @end table
3471
3472 The following tree dumps are possible:
3473 @table @samp
3474 @item original
3475 Dump before any tree based optimization, to @file{@var{file}.original}.
3476 @item optimized
3477 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3478 @item inlined
3479 Dump after function inlining, to @file{@var{file}.inlined}.
3480 @end table
3481
3482 @item -frandom-seed=@var{string}
3483 @opindex frandom-string
3484 This option provides a seed that GCC uses when it would otherwise use
3485 random numbers.  It is used to generate certain symbol names
3486 that have to be different in every compiled file. It is also used to
3487 place unique stamps in coverage data files and the object files that
3488 produce them. You can use the @option{-frandom-seed} option to produce
3489 reproducibly identical object files.
3490
3491 The @var{string} should be different for every file you compile.
3492
3493 @item -fsched-verbose=@var{n}
3494 @opindex fsched-verbose
3495 On targets that use instruction scheduling, this option controls the
3496 amount of debugging output the scheduler prints.  This information is
3497 written to standard error, unless @option{-dS} or @option{-dR} is
3498 specified, in which case it is output to the usual dump
3499 listing file, @file{.sched} or @file{.sched2} respectively.  However
3500 for @var{n} greater than nine, the output is always printed to standard
3501 error.
3502
3503 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3504 same information as @option{-dRS}.  For @var{n} greater than one, it
3505 also output basic block probabilities, detailed ready list information
3506 and unit/insn info.  For @var{n} greater than two, it includes RTL
3507 at abort point, control-flow and regions info.  And for @var{n} over
3508 four, @option{-fsched-verbose} also includes dependence info.
3509
3510 @item -save-temps
3511 @opindex save-temps
3512 Store the usual ``temporary'' intermediate files permanently; place them
3513 in the current directory and name them based on the source file.  Thus,
3514 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3515 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3516 preprocessed @file{foo.i} output file even though the compiler now
3517 normally uses an integrated preprocessor.
3518
3519 @item -time
3520 @opindex time
3521 Report the CPU time taken by each subprocess in the compilation
3522 sequence.  For C source files, this is the compiler proper and assembler
3523 (plus the linker if linking is done).  The output looks like this:
3524
3525 @smallexample
3526 # cc1 0.12 0.01
3527 # as 0.00 0.01
3528 @end smallexample
3529
3530 The first number on each line is the ``user time,'' that is time spent
3531 executing the program itself.  The second number is ``system time,''
3532 time spent executing operating system routines on behalf of the program.
3533 Both numbers are in seconds.
3534
3535 @item -print-file-name=@var{library}
3536 @opindex print-file-name
3537 Print the full absolute name of the library file @var{library} that
3538 would be used when linking---and don't do anything else.  With this
3539 option, GCC does not compile or link anything; it just prints the
3540 file name.
3541
3542 @item -print-multi-directory
3543 @opindex print-multi-directory
3544 Print the directory name corresponding to the multilib selected by any
3545 other switches present in the command line.  This directory is supposed
3546 to exist in @env{GCC_EXEC_PREFIX}.
3547
3548 @item -print-multi-lib
3549 @opindex print-multi-lib
3550 Print the mapping from multilib directory names to compiler switches
3551 that enable them.  The directory name is separated from the switches by
3552 @samp{;}, and each switch starts with an @samp{@@} instead of the
3553 @samp{-}, without spaces between multiple switches.  This is supposed to
3554 ease shell-processing.
3555
3556 @item -print-prog-name=@var{program}
3557 @opindex print-prog-name
3558 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3559
3560 @item -print-libgcc-file-name
3561 @opindex print-libgcc-file-name
3562 Same as @option{-print-file-name=libgcc.a}.
3563
3564 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3565 but you do want to link with @file{libgcc.a}.  You can do
3566
3567 @example
3568 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3569 @end example
3570
3571 @item -print-search-dirs
3572 @opindex print-search-dirs
3573 Print the name of the configured installation directory and a list of
3574 program and library directories gcc will search---and don't do anything else.
3575
3576 This is useful when gcc prints the error message
3577 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3578 To resolve this you either need to put @file{cpp0} and the other compiler
3579 components where gcc expects to find them, or you can set the environment
3580 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3581 Don't forget the trailing '/'.
3582 @xref{Environment Variables}.
3583
3584 @item -dumpmachine
3585 @opindex dumpmachine
3586 Print the compiler's target machine (for example,
3587 @samp{i686-pc-linux-gnu})---and don't do anything else.
3588
3589 @item -dumpversion
3590 @opindex dumpversion
3591 Print the compiler version (for example, @samp{3.0})---and don't do
3592 anything else.
3593
3594 @item -dumpspecs
3595 @opindex dumpspecs
3596 Print the compiler's built-in specs---and don't do anything else.  (This
3597 is used when GCC itself is being built.)  @xref{Spec Files}.
3598
3599 @item -feliminate-unused-debug-types
3600 @opindex feliminate-unused-debug-types
3601 Normally, when producing DWARF2 output, GCC will emit debugging
3602 information for all types declared in a compilation
3603 unit, regardless of whether or not they are actually used
3604 in that compilation unit.  Sometimes this is useful, such as
3605 if, in the debugger, you want to cast a value to a type that is
3606 not actually used in your program (but is declared).  More often,
3607 however, this results in a significant amount of wasted space.
3608 With this option, GCC will avoid producing debug symbol output
3609 for types that are nowhere used in the source file being compiled.
3610 @end table
3611
3612 @node Optimize Options
3613 @section Options That Control Optimization
3614 @cindex optimize options
3615 @cindex options, optimization
3616
3617 These options control various sorts of optimizations.
3618
3619 Without any optimization option, the compiler's goal is to reduce the
3620 cost of compilation and to make debugging produce the expected
3621 results.  Statements are independent: if you stop the program with a
3622 breakpoint between statements, you can then assign a new value to any
3623 variable or change the program counter to any other statement in the
3624 function and get exactly the results you would expect from the source
3625 code.
3626
3627 Turning on optimization flags makes the compiler attempt to improve
3628 the performance and/or code size at the expense of compilation time
3629 and possibly the ability to debug the program.
3630
3631 The compiler performs optimisation based on the knowledge it has of
3632 the program.  Using the @option{-funit-at-a-time} flag will allow the
3633 compiler to consider information gained from later functions in the
3634 file when compiling a function.  Compiling multiple files at once to a
3635 single output file (and using @option{-funit-at-a-time}) will allow
3636 the compiler to use information gained from all of the files when
3637 compiling each of them.
3638
3639 Not all optimizations are controlled directly by a flag.  Only
3640 optimizations that have a flag are listed.
3641
3642 @table @gcctabopt
3643 @item -O
3644 @itemx -O1
3645 @opindex O
3646 @opindex O1
3647 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3648 more memory for a large function.
3649
3650 With @option{-O}, the compiler tries to reduce code size and execution
3651 time, without performing any optimizations that take a great deal of
3652 compilation time.
3653
3654 @option{-O} turns on the following optimization flags: 
3655 @gccoptlist{-fdefer-pop @gol
3656 -fmerge-constants @gol
3657 -fthread-jumps @gol
3658 -floop-optimize @gol
3659 -fcrossjumping @gol
3660 -fif-conversion @gol
3661 -fif-conversion2 @gol
3662 -fdelayed-branch @gol
3663 -fguess-branch-probability @gol
3664 -fcprop-registers}
3665
3666 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3667 where doing so does not interfere with debugging.
3668
3669 @item -O2
3670 @opindex O2
3671 Optimize even more.  GCC performs nearly all supported optimizations
3672 that do not involve a space-speed tradeoff.  The compiler does not
3673 perform loop unrolling or function inlining when you specify @option{-O2}.
3674 As compared to @option{-O}, this option increases both compilation time
3675 and the performance of the generated code.
3676
3677 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3678 also turns on the following optimization flags:
3679 @gccoptlist{-fforce-mem @gol
3680 -foptimize-sibling-calls @gol
3681 -fstrength-reduce @gol
3682 -fcse-follow-jumps  -fcse-skip-blocks @gol
3683 -frerun-cse-after-loop  -frerun-loop-opt @gol
3684 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3685 -fdelete-null-pointer-checks @gol
3686 -fexpensive-optimizations @gol
3687 -fregmove @gol
3688 -fschedule-insns  -fschedule-insns2 @gol
3689 -fsched-interblock  -fsched-spec @gol
3690 -fcaller-saves @gol
3691 -fpeephole2 @gol
3692 -freorder-blocks  -freorder-functions @gol
3693 -fstrict-aliasing @gol
3694 -funit-at-a-time -fweb @gol
3695 -falign-functions  -falign-jumps @gol
3696 -falign-loops  -falign-labels}
3697
3698 Please note the warning under @option{-fgcse} about
3699 invoking @option{-O2} on programs that use computed gotos.
3700
3701 @item -O3
3702 @opindex O3
3703 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3704 @option{-O2} and also turns on the @option{-finline-functions},
3705 @option{-fweb} and @option{-frename-registers} options.
3706
3707 @item -O0
3708 @opindex O0
3709 Do not optimize.  This is the default.
3710
3711 @item -Os
3712 @opindex Os
3713 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3714 do not typically increase code size.  It also performs further
3715 optimizations designed to reduce code size.
3716
3717 @option{-Os} disables the following optimization flags:
3718 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3719 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3720
3721 If you use multiple @option{-O} options, with or without level numbers,
3722 the last such option is the one that is effective.
3723 @end table
3724
3725 Options of the form @option{-f@var{flag}} specify machine-independent
3726 flags.  Most flags have both positive and negative forms; the negative
3727 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3728 below, only one of the forms is listed---the one you typically will
3729 use.  You can figure out the other form by either removing @samp{no-}
3730 or adding it.
3731
3732 The following options control specific optimizations.  They are either
3733 activated by @option{-O} options or are related to ones that are.  You
3734 can use the following flags in the rare cases when ``fine-tuning'' of
3735 optimizations to be performed is desired.
3736
3737 @table @gcctabopt
3738 @item -fno-default-inline
3739 @opindex fno-default-inline
3740 Do not make member functions inline by default merely because they are
3741 defined inside the class scope (C++ only).  Otherwise, when you specify
3742 @w{@option{-O}}, member functions defined inside class scope are compiled
3743 inline by default; i.e., you don't need to add @samp{inline} in front of
3744 the member function name.
3745
3746 @item -fno-defer-pop
3747 @opindex fno-defer-pop
3748 Always pop the arguments to each function call as soon as that function
3749 returns.  For machines which must pop arguments after a function call,
3750 the compiler normally lets arguments accumulate on the stack for several
3751 function calls and pops them all at once.
3752
3753 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3754
3755 @item -fforce-mem
3756 @opindex fforce-mem
3757 Force memory operands to be copied into registers before doing
3758 arithmetic on them.  This produces better code by making all memory
3759 references potential common subexpressions.  When they are not common
3760 subexpressions, instruction combination should eliminate the separate
3761 register-load.
3762
3763 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3764
3765 @item -fforce-addr
3766 @opindex fforce-addr
3767 Force memory address constants to be copied into registers before
3768 doing arithmetic on them.  This may produce better code just as
3769 @option{-fforce-mem} may.
3770
3771 @item -fomit-frame-pointer
3772 @opindex fomit-frame-pointer
3773 Don't keep the frame pointer in a register for functions that
3774 don't need one.  This avoids the instructions to save, set up and
3775 restore frame pointers; it also makes an extra register available
3776 in many functions.  @strong{It also makes debugging impossible on
3777 some machines.}
3778
3779 On some machines, such as the VAX, this flag has no effect, because
3780 the standard calling sequence automatically handles the frame pointer
3781 and nothing is saved by pretending it doesn't exist.  The
3782 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3783 whether a target machine supports this flag.  @xref{Registers,,Register
3784 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3785
3786 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3787
3788 @item -foptimize-sibling-calls
3789 @opindex foptimize-sibling-calls
3790 Optimize sibling and tail recursive calls.
3791
3792 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3793
3794 @item -fno-inline
3795 @opindex fno-inline
3796 Don't pay attention to the @code{inline} keyword.  Normally this option
3797 is used to keep the compiler from expanding any functions inline.
3798 Note that if you are not optimizing, no functions can be expanded inline.
3799
3800 @item -finline-functions
3801 @opindex finline-functions
3802 Integrate all simple functions into their callers.  The compiler
3803 heuristically decides which functions are simple enough to be worth
3804 integrating in this way.
3805
3806 If all calls to a given function are integrated, and the function is
3807 declared @code{static}, then the function is normally not output as
3808 assembler code in its own right.
3809
3810 Enabled at level @option{-O3}.
3811
3812 @item -finline-limit=@var{n}
3813 @opindex finline-limit
3814 By default, gcc limits the size of functions that can be inlined.  This flag
3815 allows the control of this limit for functions that are explicitly marked as
3816 inline (i.e., marked with the inline keyword or defined within the class
3817 definition in c++).  @var{n} is the size of functions that can be inlined in
3818 number of pseudo instructions (not counting parameter handling).  The default
3819 value of @var{n} is 600.
3820 Increasing this value can result in more inlined code at
3821 the cost of compilation time and memory consumption.  Decreasing usually makes
3822 the compilation faster and less code will be inlined (which presumably
3823 means slower programs).  This option is particularly useful for programs that
3824 use inlining heavily such as those based on recursive templates with C++.
3825
3826 Inlining is actually controlled by a number of parameters, which may be
3827 specified individually by using @option{--param @var{name}=@var{value}}.
3828 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3829 as follows:
3830
3831 @table @gcctabopt
3832  @item max-inline-insns
3833   is set to @var{n}.
3834  @item max-inline-insns-single
3835   is set to @var{n}/2.
3836  @item max-inline-insns-auto
3837   is set to @var{n}/2.
3838  @item min-inline-insns
3839   is set to 130 or @var{n}/4, whichever is smaller.
3840  @item max-inline-insns-rtl
3841   is set to @var{n}.
3842 @end table
3843
3844 Using @option{-finline-limit=600} thus results in the default settings
3845 for these parameters.  See below for a documentation of the individual
3846 parameters controlling inlining.
3847
3848 @emph{Note:} pseudo instruction represents, in this particular context, an
3849 abstract measurement of function's size.  In no way, it represents a count
3850 of assembly instructions and as such its exact meaning might change from one
3851 release to an another.
3852
3853 @item -fkeep-inline-functions
3854 @opindex fkeep-inline-functions
3855 Even if all calls to a given function are integrated, and the function
3856 is declared @code{static}, nevertheless output a separate run-time
3857 callable version of the function.  This switch does not affect
3858 @code{extern inline} functions.
3859
3860 @item -fkeep-static-consts
3861 @opindex fkeep-static-consts
3862 Emit variables declared @code{static const} when optimization isn't turned
3863 on, even if the variables aren't referenced.
3864
3865 GCC enables this option by default.  If you want to force the compiler to
3866 check if the variable was referenced, regardless of whether or not
3867 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3868
3869 @item -fmerge-constants
3870 Attempt to merge identical constants (string constants and floating point
3871 constants) across compilation units.
3872
3873 This option is the default for optimized compilation if the assembler and
3874 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3875 behavior.
3876
3877 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3878
3879 @item -fmerge-all-constants
3880 Attempt to merge identical constants and identical variables.
3881
3882 This option implies @option{-fmerge-constants}.  In addition to
3883 @option{-fmerge-constants} this considers e.g. even constant initialized
3884 arrays or initialized constant variables with integral or floating point
3885 types.  Languages like C or C++ require each non-automatic variable to
3886 have distinct location, so using this option will result in non-conforming
3887 behavior.
3888
3889 @item -fnew-ra
3890 @opindex fnew-ra
3891 Use a graph coloring register allocator.  Currently this option is meant
3892 for testing, so we are interested to hear about miscompilations with
3893 @option{-fnew-ra}.
3894
3895 @item -fno-branch-count-reg
3896 @opindex fno-branch-count-reg
3897 Do not use ``decrement and branch'' instructions on a count register,
3898 but instead generate a sequence of instructions that decrement a
3899 register, compare it against zero, then branch based upon the result.
3900 This option is only meaningful on architectures that support such
3901 instructions, which include x86, PowerPC, IA-64 and S/390.
3902
3903 The default is @option{-fbranch-count-reg}, enabled when
3904 @option{-fstrength-reduce} is enabled.
3905
3906 @item -fno-function-cse
3907 @opindex fno-function-cse
3908 Do not put function addresses in registers; make each instruction that
3909 calls a constant function contain the function's address explicitly.
3910
3911 This option results in less efficient code, but some strange hacks
3912 that alter the assembler output may be confused by the optimizations
3913 performed when this option is not used.
3914
3915 The default is @option{-ffunction-cse}
3916
3917 @item -fno-zero-initialized-in-bss
3918 @opindex fno-zero-initialized-in-bss
3919 If the target supports a BSS section, GCC by default puts variables that
3920 are initialized to zero into BSS@.  This can save space in the resulting
3921 code.
3922
3923 This option turns off this behavior because some programs explicitly
3924 rely on variables going to the data section.  E.g., so that the
3925 resulting executable can find the beginning of that section and/or make
3926 assumptions based on that.
3927
3928 The default is @option{-fzero-initialized-in-bss}.
3929
3930 @item -fstrength-reduce
3931 @opindex fstrength-reduce
3932 Perform the optimizations of loop strength reduction and
3933 elimination of iteration variables.
3934
3935 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3936
3937 @item -fthread-jumps
3938 @opindex fthread-jumps
3939 Perform optimizations where we check to see if a jump branches to a
3940 location where another comparison subsumed by the first is found.  If
3941 so, the first branch is redirected to either the destination of the
3942 second branch or a point immediately following it, depending on whether
3943 the condition is known to be true or false.
3944
3945 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3946
3947 @item -fcse-follow-jumps
3948 @opindex fcse-follow-jumps
3949 In common subexpression elimination, scan through jump instructions
3950 when the target of the jump is not reached by any other path.  For
3951 example, when CSE encounters an @code{if} statement with an
3952 @code{else} clause, CSE will follow the jump when the condition
3953 tested is false.
3954
3955 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3956
3957 @item -fcse-skip-blocks
3958 @opindex fcse-skip-blocks
3959 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3960 follow jumps which conditionally skip over blocks.  When CSE
3961 encounters a simple @code{if} statement with no else clause,
3962 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3963 body of the @code{if}.
3964
3965 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3966
3967 @item -frerun-cse-after-loop
3968 @opindex frerun-cse-after-loop
3969 Re-run common subexpression elimination after loop optimizations has been
3970 performed.
3971
3972 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3973
3974 @item -frerun-loop-opt
3975 @opindex frerun-loop-opt
3976 Run the loop optimizer twice.
3977
3978 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3979
3980 @item -fgcse
3981 @opindex fgcse
3982 Perform a global common subexpression elimination pass.
3983 This pass also performs global constant and copy propagation.
3984
3985 @emph{Note:} When compiling a program using computed gotos, a GCC
3986 extension, you may get better runtime performance if you disable
3987 the global common subexpression elimination pass by adding
3988 @option{-fno-gcse} to the command line.
3989
3990 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3991
3992 @item -fgcse-lm
3993 @opindex fgcse-lm
3994 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3995 attempt to move loads which are only killed by stores into themselves.  This
3996 allows a loop containing a load/store sequence to be changed to a load outside
3997 the loop, and a copy/store within the loop.
3998
3999 Enabled by default when gcse is enabled.
4000
4001 @item -fgcse-sm
4002 @opindex fgcse-sm
4003 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4004 global common subexpression elimination.  This pass will attempt to move
4005 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4006 loops containing a load/store sequence can be changed to a load before
4007 the loop and a store after the loop.
4008
4009 Enabled by default when gcse is enabled.
4010
4011 @item -fgcse-las
4012 @opindex fgcse-las
4013 When @option{-fgcse-las} is enabled, the global common subexpression
4014 elimination pass eliminates redundant loads that come after stores to the
4015 same memory location (both partial and full redundancies).
4016
4017 Enabled by default when gcse is enabled.
4018
4019 @item -floop-optimize
4020 @opindex floop-optimize
4021 Perform loop optimizations: move constant expressions out of loops, simplify
4022 exit test conditions and optionally do strength-reduction and loop unrolling as
4023 well.
4024
4025 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4026
4027 @item -fcrossjumping
4028 @opindex crossjumping
4029 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4030 resulting code may or may not perform better than without cross-jumping.
4031
4032 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4033
4034 @item -fif-conversion
4035 @opindex if-conversion
4036 Attempt to transform conditional jumps into branch-less equivalents.  This
4037 include use of conditional moves, min, max, set flags and abs instructions, and
4038 some tricks doable by standard arithmetics.  The use of conditional execution
4039 on chips where it is available is controlled by @code{if-conversion2}.
4040
4041 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4042
4043 @item -fif-conversion2
4044 @opindex if-conversion2
4045 Use conditional execution (where available) to transform conditional jumps into
4046 branch-less equivalents.
4047
4048 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4049
4050 @item -fdelete-null-pointer-checks
4051 @opindex fdelete-null-pointer-checks
4052 Use global dataflow analysis to identify and eliminate useless checks
4053 for null pointers.  The compiler assumes that dereferencing a null
4054 pointer would have halted the program.  If a pointer is checked after
4055 it has already been dereferenced, it cannot be null.
4056
4057 In some environments, this assumption is not true, and programs can
4058 safely dereference null pointers.  Use
4059 @option{-fno-delete-null-pointer-checks} to disable this optimization
4060 for programs which depend on that behavior.
4061
4062 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4063
4064 @item -fexpensive-optimizations
4065 @opindex fexpensive-optimizations
4066 Perform a number of minor optimizations that are relatively expensive.
4067
4068 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4069
4070 @item -foptimize-register-move
4071 @itemx -fregmove
4072 @opindex foptimize-register-move
4073 @opindex fregmove
4074 Attempt to reassign register numbers in move instructions and as
4075 operands of other simple instructions in order to maximize the amount of
4076 register tying.  This is especially helpful on machines with two-operand
4077 instructions.
4078
4079 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4080 optimization.
4081
4082 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4083
4084 @item -fdelayed-branch
4085 @opindex fdelayed-branch
4086 If supported for the target machine, attempt to reorder instructions
4087 to exploit instruction slots available after delayed branch
4088 instructions.
4089
4090 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4091
4092 @item -fschedule-insns
4093 @opindex fschedule-insns
4094 If supported for the target machine, attempt to reorder instructions to
4095 eliminate execution stalls due to required data being unavailable.  This
4096 helps machines that have slow floating point or memory load instructions
4097 by allowing other instructions to be issued until the result of the load
4098 or floating point instruction is required.
4099
4100 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4101
4102 @item -fschedule-insns2
4103 @opindex fschedule-insns2
4104 Similar to @option{-fschedule-insns}, but requests an additional pass of
4105 instruction scheduling after register allocation has been done.  This is
4106 especially useful on machines with a relatively small number of
4107 registers and where memory load instructions take more than one cycle.
4108
4109 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4110
4111 @item -fno-sched-interblock
4112 @opindex fno-sched-interblock
4113 Don't schedule instructions across basic blocks.  This is normally
4114 enabled by default when scheduling before register allocation, i.e.@:
4115 with @option{-fschedule-insns} or at @option{-O2} or higher.
4116
4117 @item -fno-sched-spec
4118 @opindex fno-sched-spec
4119 Don't allow speculative motion of non-load instructions.  This is normally
4120 enabled by default when scheduling before register allocation, i.e.@:
4121 with @option{-fschedule-insns} or at @option{-O2} or higher.
4122
4123 @item -fsched-spec-load
4124 @opindex fsched-spec-load
4125 Allow speculative motion of some load instructions.  This only makes
4126 sense when scheduling before register allocation, i.e.@: with
4127 @option{-fschedule-insns} or at @option{-O2} or higher.
4128
4129 @item -fsched-spec-load-dangerous
4130 @opindex fsched-spec-load-dangerous
4131 Allow speculative motion of more load instructions.  This only makes
4132 sense when scheduling before register allocation, i.e.@: with
4133 @option{-fschedule-insns} or at @option{-O2} or higher.
4134
4135 @item -fsched-stalled-insns=@var{n}
4136 @opindex fsched-stalled-insns
4137 Define how many insns (if any) can be moved prematurely from the queue
4138 of stalled insns into the ready list, during the second scheduling pass.
4139
4140 @item -fsched-stalled-insns-dep=@var{n}
4141 @opindex fsched-stalled-insns-dep
4142 Define how many insn groups (cycles) will be examined for a dependency 
4143 on a stalled insn that is candidate for premature removal from the queue 
4144 of stalled insns.  Has an effect only during the second scheduling pass, 
4145 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4146
4147 @item -fsched2-use-superblocks
4148 @opindex fsched2-use-superblocks
4149 When scheduling after register allocation, do use superblock scheduling
4150 algorithm.  Superblock scheduling allows motion across basic block boundaries
4151 resulting on faster schedules.  This option is experimental, as not all machine
4152 descriptions used by GCC model the CPU closely enough to avoid unreliable
4153 results from the algorithm. 
4154
4155 This only makes sense when scheduling after register allocation, i.e.@: with
4156 @option{-fschedule-insns2} or at @option{-O2} or higher.
4157
4158 @item -fsched2-use-traces
4159 @opindex fsched2-use-traces
4160 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4161 allocation and additionally perform code duplication in order to increase the
4162 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4163 trace formation.
4164
4165 This mode should produce faster but significantly longer programs.  Also
4166 without @code{-fbranch-probabilities} the traces constructed may not match the
4167 reality and hurt the performance.  This only makes
4168 sense when scheduling after register allocation, i.e.@: with
4169 @option{-fschedule-insns2} or at @option{-O2} or higher.
4170
4171 @item -fcaller-saves
4172 @opindex fcaller-saves
4173 Enable values to be allocated in registers that will be clobbered by
4174 function calls, by emitting extra instructions to save and restore the
4175 registers around such calls.  Such allocation is done only when it
4176 seems to result in better code than would otherwise be produced.
4177
4178 This option is always enabled by default on certain machines, usually
4179 those which have no call-preserved registers to use instead.
4180
4181 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4182
4183 @item -fmove-all-movables
4184 @opindex fmove-all-movables
4185 Forces all invariant computations in loops to be moved
4186 outside the loop.
4187
4188 @item -freduce-all-givs
4189 @opindex freduce-all-givs
4190 Forces all general-induction variables in loops to be
4191 strength-reduced.
4192
4193 @emph{Note:} When compiling programs written in Fortran,
4194 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4195 by default when you use the optimizer.
4196
4197 These options may generate better or worse code; results are highly
4198 dependent on the structure of loops within the source code.
4199
4200 These two options are intended to be removed someday, once
4201 they have helped determine the efficacy of various
4202 approaches to improving loop optimizations.
4203
4204 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
4205 know how use of these options affects
4206 the performance of your production code.
4207 We're very interested in code that runs @emph{slower}
4208 when these options are @emph{enabled}.
4209
4210 @item -fno-peephole
4211 @itemx -fno-peephole2
4212 @opindex fno-peephole
4213 @opindex fno-peephole2
4214 Disable any machine-specific peephole optimizations.  The difference
4215 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4216 are implemented in the compiler; some targets use one, some use the
4217 other, a few use both.
4218
4219 @option{-fpeephole} is enabled by default.
4220 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4221
4222 @item -fno-guess-branch-probability
4223 @opindex fno-guess-branch-probability
4224 Do not guess branch probabilities using a randomized model.
4225
4226 Sometimes gcc will opt to use a randomized model to guess branch
4227 probabilities, when none are available from either profiling feedback
4228 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4229 different runs of the compiler on the same program may produce different
4230 object code.
4231
4232 In a hard real-time system, people don't want different runs of the
4233 compiler to produce code that has different behavior; minimizing
4234 non-determinism is of paramount import.  This switch allows users to
4235 reduce non-determinism, possibly at the expense of inferior
4236 optimization.
4237
4238 The default is @option{-fguess-branch-probability} at levels
4239 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4240
4241 @item -freorder-blocks
4242 @opindex freorder-blocks
4243 Reorder basic blocks in the compiled function in order to reduce number of
4244 taken branches and improve code locality.
4245
4246 Enabled at levels @option{-O2}, @option{-O3}.
4247
4248 @item -freorder-functions
4249 @opindex freorder-functions
4250 Reorder basic blocks in the compiled function in order to reduce number of
4251 taken branches and improve code locality. This is implemented by using special
4252 subsections @code{text.hot} for most frequently executed functions and
4253 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4254 the linker so object file format must support named sections and linker must
4255 place them in a reasonable way.
4256
4257 Also profile feedback must be available in to make this option effective.  See
4258 @option{-fprofile-arcs} for details.
4259
4260 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4261
4262 @item -fstrict-aliasing
4263 @opindex fstrict-aliasing
4264 Allows the compiler to assume the strictest aliasing rules applicable to
4265 the language being compiled.  For C (and C++), this activates
4266 optimizations based on the type of expressions.  In particular, an
4267 object of one type is assumed never to reside at the same address as an
4268 object of a different type, unless the types are almost the same.  For
4269 example, an @code{unsigned int} can alias an @code{int}, but not a
4270 @code{void*} or a @code{double}.  A character type may alias any other
4271 type.
4272
4273 Pay special attention to code like this:
4274 @example
4275 union a_union @{
4276   int i;
4277   double d;
4278 @};
4279
4280 int f() @{
4281   a_union t;
4282   t.d = 3.0;
4283   return t.i;
4284 @}
4285 @end example
4286 The practice of reading from a different union member than the one most
4287 recently written to (called ``type-punning'') is common.  Even with
4288 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4289 is accessed through the union type.  So, the code above will work as
4290 expected.  However, this code might not:
4291 @example
4292 int f() @{
4293   a_union t;
4294   int* ip;
4295   t.d = 3.0;
4296   ip = &t.i;
4297   return *ip;
4298 @}
4299 @end example
4300
4301 Every language that wishes to perform language-specific alias analysis
4302 should define a function that computes, given an @code{tree}
4303 node, an alias set for the node.  Nodes in different alias sets are not
4304 allowed to alias.  For an example, see the C front-end function
4305 @code{c_get_alias_set}.
4306
4307 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4308
4309 @item -falign-functions
4310 @itemx -falign-functions=@var{n}
4311 @opindex falign-functions
4312 Align the start of functions to the next power-of-two greater than
4313 @var{n}, skipping up to @var{n} bytes.  For instance,
4314 @option{-falign-functions=32} aligns functions to the next 32-byte
4315 boundary, but @option{-falign-functions=24} would align to the next
4316 32-byte boundary only if this can be done by skipping 23 bytes or less.
4317
4318 @option{-fno-align-functions} and @option{-falign-functions=1} are
4319 equivalent and mean that functions will not be aligned.
4320
4321 Some assemblers only support this flag when @var{n} is a power of two;
4322 in that case, it is rounded up.
4323
4324 If @var{n} is not specified or is zero, use a machine-dependent default.
4325
4326 Enabled at levels @option{-O2}, @option{-O3}.
4327
4328 @item -falign-labels
4329 @itemx -falign-labels=@var{n}
4330 @opindex falign-labels
4331 Align all branch targets to a power-of-two boundary, skipping up to
4332 @var{n} bytes like @option{-falign-functions}.  This option can easily
4333 make code slower, because it must insert dummy operations for when the
4334 branch target is reached in the usual flow of the code.
4335
4336 @option{-fno-align-labels} and @option{-falign-labels=1} are
4337 equivalent and mean that labels will not be aligned.
4338
4339 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4340 are greater than this value, then their values are used instead.
4341
4342 If @var{n} is not specified or is zero, use a machine-dependent default
4343 which is very likely to be @samp{1}, meaning no alignment.
4344
4345 Enabled at levels @option{-O2}, @option{-O3}.
4346
4347 @item -falign-loops
4348 @itemx -falign-loops=@var{n}
4349 @opindex falign-loops
4350 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4351 like @option{-falign-functions}.  The hope is that the loop will be
4352 executed many times, which will make up for any execution of the dummy
4353 operations.
4354
4355 @option{-fno-align-loops} and @option{-falign-loops=1} are
4356 equivalent and mean that loops will not be aligned.
4357
4358 If @var{n} is not specified or is zero, use a machine-dependent default.
4359
4360 Enabled at levels @option{-O2}, @option{-O3}.
4361
4362 @item -falign-jumps
4363 @itemx -falign-jumps=@var{n}
4364 @opindex falign-jumps
4365 Align branch targets to a power-of-two boundary, for branch targets
4366 where the targets can only be reached by jumping, skipping up to @var{n}
4367 bytes like @option{-falign-functions}.  In this case, no dummy operations
4368 need be executed.
4369
4370 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4371 equivalent and mean that loops will not be aligned.
4372
4373 If @var{n} is not specified or is zero, use a machine-dependent default.
4374
4375 Enabled at levels @option{-O2}, @option{-O3}.
4376
4377 @item -frename-registers
4378 @opindex frename-registers
4379 Attempt to avoid false dependencies in scheduled code by making use
4380 of registers left over after register allocation.  This optimization
4381 will most benefit processors with lots of registers.  It can, however,
4382 make debugging impossible, since variables will no longer stay in
4383 a ``home register''.
4384
4385 @item -fweb
4386 @opindex fweb
4387 Constructs webs as commonly used for register allocation purposes and assign
4388 each web individual pseudo register.  This allows our register allocation pass
4389 to operate on pseudos directly, but also strengthens several other optimization
4390 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4391 however, make debugging impossible, since variables will no longer stay in a
4392 ``home register''.
4393
4394 Enabled at levels @option{-O3}.
4395
4396 @item -fno-cprop-registers
4397 @opindex fno-cprop-registers
4398 After register allocation and post-register allocation instruction splitting,
4399 we perform a copy-propagation pass to try to reduce scheduling dependencies
4400 and occasionally eliminate the copy.
4401
4402 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4403
4404 @end table
4405
4406 The following options control compiler behavior regarding floating
4407 point arithmetic.  These options trade off between speed and
4408 correctness.  All must be specifically enabled.
4409
4410 @table @gcctabopt
4411 @item -ffloat-store
4412 @opindex ffloat-store
4413 Do not store floating point variables in registers, and inhibit other
4414 options that might change whether a floating point value is taken from a
4415 register or memory.
4416
4417 @cindex floating point precision
4418 This option prevents undesirable excess precision on machines such as
4419 the 68000 where the floating registers (of the 68881) keep more
4420 precision than a @code{double} is supposed to have.  Similarly for the
4421 x86 architecture.  For most programs, the excess precision does only
4422 good, but a few programs rely on the precise definition of IEEE floating
4423 point.  Use @option{-ffloat-store} for such programs, after modifying
4424 them to store all pertinent intermediate computations into variables.
4425
4426 @item -ffast-math
4427 @opindex ffast-math
4428 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4429 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4430 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4431
4432 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4433
4434 This option should never be turned on by any @option{-O} option since
4435 it can result in incorrect output for programs which depend on
4436 an exact implementation of IEEE or ISO rules/specifications for
4437 math functions.
4438
4439 @item -fno-math-errno
4440 @opindex fno-math-errno
4441 Do not set ERRNO after calling math functions that are executed
4442 with a single instruction, e.g., sqrt.  A program that relies on
4443 IEEE exceptions for math error handling may want to use this flag
4444 for speed while maintaining IEEE arithmetic compatibility.
4445
4446 This option should never be turned on by any @option{-O} option since
4447 it can result in incorrect output for programs which depend on
4448 an exact implementation of IEEE or ISO rules/specifications for
4449 math functions.
4450
4451 The default is @option{-fmath-errno}.
4452
4453 @item -funsafe-math-optimizations
4454 @opindex funsafe-math-optimizations
4455 Allow optimizations for floating-point arithmetic that (a) assume
4456 that arguments and results are valid and (b) may violate IEEE or
4457 ANSI standards.  When used at link-time, it may include libraries
4458 or startup files that change the default FPU control word or other
4459 similar optimizations.
4460
4461 This option should never be turned on by any @option{-O} option since
4462 it can result in incorrect output for programs which depend on
4463 an exact implementation of IEEE or ISO rules/specifications for
4464 math functions.
4465
4466 The default is @option{-fno-unsafe-math-optimizations}.
4467
4468 @item -ffinite-math-only
4469 @opindex ffinite-math-only
4470 Allow optimizations for floating-point arithmetic that assume
4471 that arguments and results are not NaNs or +-Infs.
4472
4473 This option should never be turned on by any @option{-O} option since
4474 it can result in incorrect output for programs which depend on
4475 an exact implementation of IEEE or ISO rules/specifications.
4476
4477 The default is @option{-fno-finite-math-only}.
4478
4479 @item -fno-trapping-math
4480 @opindex fno-trapping-math
4481 Compile code assuming that floating-point operations cannot generate
4482 user-visible traps.  These traps include division by zero, overflow,
4483 underflow, inexact result and invalid operation.  This option implies
4484 @option{-fno-signaling-nans}.  Setting this option may allow faster
4485 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4486
4487 This option should never be turned on by any @option{-O} option since
4488 it can result in incorrect output for programs which depend on
4489 an exact implementation of IEEE or ISO rules/specifications for
4490 math functions.
4491
4492 The default is @option{-ftrapping-math}.
4493
4494 @item -frounding-math
4495 @opindex frounding-math
4496 Disable transformations and optimizations that assume default floating
4497 point rounding behavior.  This is round-to-zero for all floating point
4498 to integer conversions, and round-to-nearest for all other arithmetic
4499 truncations.  This option should be specified for programs that change
4500 the FP rounding mode dynamically, or that may be executed with a
4501 non-default rounding mode.  This option disables constant folding of
4502 floating point expressions at compile-time (which may be affected by
4503 rounding mode) and arithmetic transformations that are unsafe in the
4504 presence of sign-dependent rounding modes.
4505
4506 The default is @option{-fno-rounding-math}.
4507
4508 This option is experimental and does not currently guarantee to
4509 disable all GCC optimizations that are affected by rounding mode.
4510 Future versions of gcc may provide finer control of this setting
4511 using C99's @code{FENV_ACCESS} pragma.  This command line option
4512 will be used to specify the default state for @code{FENV_ACCESS}.
4513
4514 @item -fsignaling-nans
4515 @opindex fsignaling-nans
4516 Compile code assuming that IEEE signaling NaNs may generate user-visible
4517 traps during floating-point operations.  Setting this option disables
4518 optimizations that may change the number of exceptions visible with
4519 signaling NaNs.  This option implies @option{-ftrapping-math}.
4520
4521 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4522 be defined.
4523
4524 The default is @option{-fno-signaling-nans}.
4525
4526 This option is experimental and does not currently guarantee to
4527 disable all GCC optimizations that affect signaling NaN behavior.
4528
4529 @item -fsingle-precision-constant
4530 @opindex fsingle-precision-constant
4531 Treat floating point constant as single precision constant instead of
4532 implicitly converting it to double precision constant.
4533
4534
4535 @end table
4536
4537 The following options control optimizations that may improve
4538 performance, but are not enabled by any @option{-O} options.  This
4539 section includes experimental options that may produce broken code.
4540
4541 @table @gcctabopt
4542 @item -fbranch-probabilities
4543 @opindex fbranch-probabilities
4544 After running a program compiled with @option{-fprofile-arcs}
4545 (@pxref{Debugging Options,, Options for Debugging Your Program or
4546 @command{gcc}}), you can compile it a second time using
4547 @option{-fbranch-probabilities}, to improve optimizations based on
4548 the number of times each branch was taken.  When the program
4549 compiled with @option{-fprofile-arcs} exits it saves arc execution
4550 counts to a file called @file{@var{sourcename}.gcda} for each source
4551 file  The information in this data file is very dependent on the
4552 structure of the generated code, so you must use the same source code
4553 and the same optimization options for both compilations.
4554
4555 With @option{-fbranch-probabilities}, GCC puts a 
4556 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4557 These can be used to improve optimization.  Currently, they are only
4558 used in one place: in @file{reorg.c}, instead of guessing which path a
4559 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4560 exactly determine which path is taken more often.
4561
4562 @item -fprofile-values
4563 @opindex fprofile-values
4564 If combined with @option{-fprofile-arcs}, it adds code so that some
4565 data about values of expressions in the program is gathered.
4566
4567 With @option{-fbranch-probabilities}, it reads back the data gathered
4568 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4569 notes to instructions for their later usage in optimizations.
4570
4571 @item -fvpt
4572 @opindex fvpt
4573 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4574 a code to gather information about values of expressions.
4575
4576 With @option{-fbranch-probabilities}, it reads back the data gathered
4577 and actually performs the optimizations based on them.
4578 Currently the optimizations include specialization of division operation
4579 using the knowledge about the value of the denominator.
4580
4581 @item -fnew-ra
4582 @opindex fnew-ra
4583 Use a graph coloring register allocator.  Currently this option is meant
4584 for testing, so we are interested to hear about miscompilations with
4585 @option{-fnew-ra}.
4586
4587 @item -ftracer
4588 @opindex ftracer
4589 Perform tail duplication to enlarge superblock size. This transformation
4590 simplifies the control flow of the function allowing other optimizations to do
4591 better job.
4592
4593 @item -funit-at-a-time
4594 @opindex funit-at-a-time
4595 Parse the whole compilation unit before starting to produce code.
4596 This allows some extra optimizations to take place but consumes more
4597 memory.
4598
4599 @item -funroll-loops
4600 @opindex funroll-loops
4601 Unroll loops whose number of iterations can be determined at compile time or
4602 upon entry to the loop.  @option{-funroll-loops} implies
4603 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4604 (i.e. complete removal of loops with small constant number of iterations).
4605 This option makes code larger, and may or may not make it run faster.
4606
4607 @item -funroll-all-loops
4608 @opindex funroll-all-loops
4609 Unroll all loops, even if their number of iterations is uncertain when
4610 the loop is entered.  This usually makes programs run more slowly.
4611 @option{-funroll-all-loops} implies the same options as
4612 @option{-funroll-loops}.
4613
4614 @item -fpeel-loops
4615 @opindex fpeel-loops
4616 Peels the loops for that there is enough information that they do not
4617 roll much (from profile feedback).  It also turns on complete loop peeling
4618 (i.e. complete removal of loops with small constant number of iterations).
4619
4620 @item -funswitch-loops
4621 @opindex funswitch-loops
4622 Move branches with loop invariant conditions out of the loop, with duplicates
4623 of the loop on both branches (modified according to result of the condition).
4624
4625 @item -fold-unroll-loops
4626 @opindex fold-unroll-loops
4627 Unroll loops whose number of iterations can be determined at compile
4628 time or upon entry to the loop, using the old loop unroller whose loop
4629 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4630 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4631 option makes code larger, and may or may not make it run faster.
4632
4633 @item -fold-unroll-all-loops
4634 @opindex fold-unroll-all-loops
4635 Unroll all loops, even if their number of iterations is uncertain when
4636 the loop is entered. This is done using the old loop unroller whose loop
4637 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4638 @option{-fold-unroll-all-loops} implies the same options as
4639 @option{-fold-unroll-loops}.
4640  
4641 @item -funswitch-loops
4642 @opindex funswitch-loops
4643 Move branches with loop invariant conditions out of the loop, with duplicates
4644 of the loop on both branches (modified according to result of the condition).
4645
4646 @item -funswitch-loops
4647 @opindex funswitch-loops
4648 Move branches with loop invariant conditions out of the loop, with duplicates
4649 of the loop on both branches (modified according to result of the condition).
4650
4651 @item -fprefetch-loop-arrays
4652 @opindex fprefetch-loop-arrays
4653 If supported by the target machine, generate instructions to prefetch
4654 memory to improve the performance of loops that access large arrays.
4655
4656 Disabled at level @option{-Os}.
4657
4658 @item -ffunction-sections
4659 @itemx -fdata-sections
4660 @opindex ffunction-sections
4661 @opindex fdata-sections
4662 Place each function or data item into its own section in the output
4663 file if the target supports arbitrary sections.  The name of the
4664 function or the name of the data item determines the section's name
4665 in the output file.
4666
4667 Use these options on systems where the linker can perform optimizations
4668 to improve locality of reference in the instruction space.  Most systems
4669 using the ELF object format and SPARC processors running Solaris 2 have
4670 linkers with such optimizations.  AIX may have these optimizations in
4671 the future.
4672
4673 Only use these options when there are significant benefits from doing
4674 so.  When you specify these options, the assembler and linker will
4675 create larger object and executable files and will also be slower.
4676 You will not be able to use @code{gprof} on all systems if you
4677 specify this option and you may have problems with debugging if
4678 you specify both this option and @option{-g}.
4679
4680 @item -fssa
4681 @opindex fssa
4682 Perform optimizations in static single assignment form.  Each function's
4683 flow graph is translated into SSA form, optimizations are performed, and
4684 the flow graph is translated back from SSA form.  Users should not
4685 specify this option, since it is not yet ready for production use.
4686
4687 @item -fssa-ccp
4688 @opindex fssa-ccp
4689 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4690 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4691
4692 @item -fssa-dce
4693 @opindex fssa-dce
4694 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4695 Like @option{-fssa}, this is an experimental feature.
4696
4697 @item -fbranch-target-load-optimize
4698 @opindex fbranch-target-load-optimize
4699 Perform branch target register load optimization before prologue / epilogue
4700 threading.
4701 The use of target registers can typically be exposed only during reload,
4702 thus hoisting loads out of loops and doing inter-block scheduling needs
4703 a separate optimization pass.
4704
4705 @item -fbranch-target-load-optimize2
4706 @opindex fbranch-target-load-optimize2
4707 Perform branch target register load optimization after prologue / epilogue
4708 threading.
4709
4710
4711
4712
4713 @item --param @var{name}=@var{value}
4714 @opindex param
4715 In some places, GCC uses various constants to control the amount of
4716 optimization that is done.  For example, GCC will not inline functions
4717 that contain more that a certain number of instructions.  You can
4718 control some of these constants on the command-line using the
4719 @option{--param} option.
4720
4721 In each case, the @var{value} is an integer.  The allowable choices for
4722 @var{name} are given in the following table:
4723
4724 @table @gcctabopt
4725 @item max-crossjump-edges
4726 The maximum number of incoming edges to consider for crossjumping.
4727 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4728 the number of edges incoming to each block.  Increasing values mean
4729 more aggressive optimization, making the compile time increase with
4730 probably small improvement in executable size.
4731
4732 @item max-delay-slot-insn-search
4733 The maximum number of instructions to consider when looking for an
4734 instruction to fill a delay slot.  If more than this arbitrary number of
4735 instructions is searched, the time savings from filling the delay slot
4736 will be minimal so stop searching.  Increasing values mean more
4737 aggressive optimization, making the compile time increase with probably
4738 small improvement in executable run time.
4739
4740 @item max-delay-slot-live-search
4741 When trying to fill delay slots, the maximum number of instructions to
4742 consider when searching for a block with valid live register
4743 information.  Increasing this arbitrarily chosen value means more
4744 aggressive optimization, increasing the compile time.  This parameter
4745 should be removed when the delay slot code is rewritten to maintain the
4746 control-flow graph.
4747
4748 @item max-gcse-memory
4749 The approximate maximum amount of memory that will be allocated in
4750 order to perform the global common subexpression elimination
4751 optimization.  If more memory than specified is required, the
4752 optimization will not be done.
4753
4754 @item max-gcse-passes
4755 The maximum number of passes of GCSE to run.
4756
4757 @item max-pending-list-length
4758 The maximum number of pending dependencies scheduling will allow
4759 before flushing the current state and starting over.  Large functions
4760 with few branches or calls can create excessively large lists which
4761 needlessly consume memory and resources.
4762
4763 @item max-inline-insns-single
4764 Several parameters control the tree inliner used in gcc.
4765 This number sets the maximum number of instructions (counted in gcc's
4766 internal representation) in a single function that the tree inliner 
4767 will consider for inlining.  This only affects functions declared
4768 inline and methods implemented in a class declaration (C++).
4769 The default value is 500.
4770
4771 @item max-inline-insns-auto
4772 When you use @option{-finline-functions} (included in @option{-O3}),
4773 a lot of functions that would otherwise not be considered for inlining
4774 by the compiler will be investigated.  To those functions, a different
4775 (more restrictive) limit compared to functions declared inline can
4776 be applied.
4777 The default value is 150.
4778
4779 @item max-inline-insns
4780 The tree inliner does decrease the allowable size for single functions 
4781 to be inlined after we already inlined the number of instructions
4782 given here by repeated inlining.  This number should be a factor of 
4783 two or more larger than the single function limit.
4784 Higher numbers result in better runtime performance, but incur higher
4785 compile-time resource (CPU time, memory) requirements and result in
4786 larger binaries.  Very high values are not advisable, as too large
4787 binaries may adversely affect runtime performance.
4788 The default value is 200.
4789
4790 @item large-function-insns
4791 The limit specifying really large functions.  For functions greater than this
4792 limit inlining is constrained by @option{--param large-function-growth}.
4793 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
4794 algorithms used by the backend.
4795 This parameter is ignored when @option{-funit-at-a-time} is not used.
4796 The default value is 30000.
4797
4798 @item large-function-growth
4799 Specifies maximal growth of large functtion caused by inlining in percents.
4800 This parameter is ignored when @option{-funit-at-a-time} is not used.
4801 The default value is 200.
4802
4803 @item inline-unit-growth
4804 Specifies maximal overall growth of the compilation unit caused by inlining.
4805 This parameter is ignored when @option{-funit-at-a-time} is not used.
4806 The default value is 150.
4807
4808 @item max-inline-insns-rtl
4809 For languages that use the RTL inliner (this happens at a later stage
4810 than tree inlining), you can set the maximum allowable size (counted 
4811 in RTL instructions) for the RTL inliner with this parameter.
4812 The default value is 600.
4813
4814
4815 @item max-unrolled-insns
4816 The maximum number of instructions that a loop should have if that loop
4817 is unrolled, and if the loop is unrolled, it determines how many times
4818 the loop code is unrolled.
4819
4820 @item max-average-unrolled-insns
4821 The maximum number of instructions biased by probabilities of their execution
4822 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4823 it determines how many times the loop code is unrolled.
4824
4825 @item max-unroll-times
4826 The maximum number of unrollings of a single loop.
4827
4828 @item max-peeled-insns
4829 The maximum number of instructions that a loop should have if that loop
4830 is peeled, and if the loop is peeled, it determines how many times
4831 the loop code is peeled.
4832
4833 @item max-peel-times
4834 The maximum number of peelings of a single loop.
4835
4836 @item max-completely-peeled-insns
4837 The maximum number of insns of a completely peeled loop.
4838
4839 @item max-completely-peel-times
4840 The maximum number of iterations of a loop to be suitable for complete peeling.
4841
4842 @item max-unswitch-insns
4843 The maximum number of insns of an unswitched loop.
4844
4845 @item max-unswitch-level
4846 The maximum number of branches unswitched in a single loop.
4847
4848 @item hot-bb-count-fraction
4849 Select fraction of the maximal count of repetitions of basic block in program
4850 given basic block needs to have to be considered hot.
4851
4852 @item hot-bb-frequency-fraction
4853 Select fraction of the maximal frequency of executions of basic block in
4854 function given basic block needs to have to be considered hot
4855
4856 @item tracer-dynamic-coverage
4857 @itemx tracer-dynamic-coverage-feedback
4858
4859 This value is used to limit superblock formation once the given percentage of
4860 executed instructions is covered.  This limits unnecessary code size
4861 expansion.
4862
4863 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4864 feedback is available.  The real profiles (as opposed to statically estimated
4865 ones) are much less balanced allowing the threshold to be larger value.
4866
4867 @item tracer-max-code-growth
4868 Stop tail duplication once code growth has reached given percentage.  This is
4869 rather hokey argument, as most of the duplicates will be eliminated later in
4870 cross jumping, so it may be set to much higher values than is the desired code
4871 growth.
4872
4873 @item tracer-min-branch-ratio
4874
4875 Stop reverse growth when the reverse probability of best edge is less than this
4876 threshold (in percent).
4877
4878 @item tracer-min-branch-ratio
4879 @itemx tracer-min-branch-ratio-feedback
4880
4881 Stop forward growth if the best edge do have probability lower than this
4882 threshold.
4883
4884 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4885 compilation for profile feedback and one for compilation without.  The value
4886 for compilation with profile feedback needs to be more conservative (higher) in
4887 order to make tracer effective.
4888
4889 @item max-cse-path-length
4890
4891 Maximum number of basic blocks on path that cse considers.
4892
4893 @item ggc-min-expand
4894
4895 GCC uses a garbage collector to manage its own memory allocation.  This
4896 parameter specifies the minimum percentage by which the garbage
4897 collector's heap should be allowed to expand between collections.
4898 Tuning this may improve compilation speed; it has no effect on code
4899 generation.
4900
4901 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4902 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4903 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4904 GCC is not able to calculate RAM on a particular platform, the lower
4905 bound of 30% is used.  Setting this parameter and
4906 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4907 every opportunity.  This is extremely slow, but can be useful for
4908 debugging.
4909
4910 @item ggc-min-heapsize
4911
4912 Minimum size of the garbage collector's heap before it begins bothering
4913 to collect garbage.  The first collection occurs after the heap expands
4914 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4915 tuning this may improve compilation speed, and has no effect on code
4916 generation.
4917
4918 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4919 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4920 available, the notion of "RAM" is the smallest of actual RAM,
4921 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4922 RAM on a particular platform, the lower bound is used.  Setting this
4923 parameter very large effectively disables garbage collection.  Setting
4924 this parameter and @option{ggc-min-expand} to zero causes a full
4925 collection to occur at every opportunity.
4926
4927 @item reorder-blocks-duplicate
4928 @itemx reorder-blocks-duplicate-feedback
4929
4930 Used by basic block reordering pass to decide whether to use unconditional
4931 branch or duplicate the code on its destination.  Code is duplicated when its
4932 estimated size is smaller than this value multiplied by the estimated size of
4933 unconditional jump in the hot spots of the program.
4934
4935 The @option{reorder-block-duplicate-feedback} is used only when profile
4936 feedback is available and may be set to higher values than
4937 @option{reorder-block-duplicate} since information about the hot spots is more
4938 accurate.
4939 @end table
4940 @end table
4941
4942 @node Preprocessor Options
4943 @section Options Controlling the Preprocessor
4944 @cindex preprocessor options
4945 @cindex options, preprocessor
4946
4947 These options control the C preprocessor, which is run on each C source
4948 file before actual compilation.
4949
4950 If you use the @option{-E} option, nothing is done except preprocessing.
4951 Some of these options make sense only together with @option{-E} because
4952 they cause the preprocessor output to be unsuitable for actual
4953 compilation.
4954
4955 @table @gcctabopt
4956 @opindex Wp
4957 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4958 and pass @var{option} directly through to the preprocessor.  If
4959 @var{option} contains commas, it is split into multiple options at the
4960 commas.  However, many options are modified, translated or interpreted
4961 by the compiler driver before being passed to the preprocessor, and
4962 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4963 interface is undocumented and subject to change, so whenever possible
4964 you should avoid using @option{-Wp} and let the driver handle the
4965 options instead.
4966
4967 @item -Xpreprocessor @var{option}
4968 @opindex preprocessor
4969 Pass @var{option} as an option to the preprocessor.  You can use this to
4970 supply system-specific preprocessor options which GCC does not know how to
4971 recognize.
4972
4973 If you want to pass an option that takes an argument, you must use
4974 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4975 @end table
4976
4977 @include cppopts.texi
4978
4979 @node Assembler Options
4980 @section Passing Options to the Assembler
4981
4982 @c prevent bad page break with this line
4983 You can pass options to the assembler.
4984
4985 @table @gcctabopt
4986 @item -Wa,@var{option}
4987 @opindex Wa
4988 Pass @var{option} as an option to the assembler.  If @var{option}
4989 contains commas, it is split into multiple options at the commas.
4990
4991 @item -Xassembler @var{option}
4992 @opindex Xassembler
4993 Pass @var{option} as an option to the assembler.  You can use this to
4994 supply system-specific assembler options which GCC does not know how to
4995 recognize.
4996
4997 If you want to pass an option that takes an argument, you must use
4998 @option{-Xassembler} twice, once for the option and once for the argument.
4999
5000 @end table
5001
5002 @node Link Options
5003 @section Options for Linking
5004 @cindex link options
5005 @cindex options, linking
5006
5007 These options come into play when the compiler links object files into
5008 an executable output file.  They are meaningless if the compiler is
5009 not doing a link step.
5010
5011 @table @gcctabopt
5012 @cindex file names
5013 @item @var{object-file-name}
5014 A file name that does not end in a special recognized suffix is
5015 considered to name an object file or library.  (Object files are
5016 distinguished from libraries by the linker according to the file
5017 contents.)  If linking is done, these object files are used as input
5018 to the linker.
5019
5020 @item -c
5021 @itemx -S
5022 @itemx -E
5023 @opindex c
5024 @opindex S
5025 @opindex E
5026 If any of these options is used, then the linker is not run, and
5027 object file names should not be used as arguments.  @xref{Overall
5028 Options}.
5029
5030 @cindex Libraries
5031 @item -l@var{library}
5032 @itemx -l @var{library}
5033 @opindex l
5034 Search the library named @var{library} when linking.  (The second
5035 alternative with the library as a separate argument is only for
5036 POSIX compliance and is not recommended.)
5037
5038 It makes a difference where in the command you write this option; the
5039 linker searches and processes libraries and object files in the order they
5040 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5041 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5042 to functions in @samp{z}, those functions may not be loaded.
5043
5044 The linker searches a standard list of directories for the library,
5045 which is actually a file named @file{lib@var{library}.a}.  The linker
5046 then uses this file as if it had been specified precisely by name.
5047
5048 The directories searched include several standard system directories
5049 plus any that you specify with @option{-L}.
5050
5051 Normally the files found this way are library files---archive files
5052 whose members are object files.  The linker handles an archive file by
5053 scanning through it for members which define symbols that have so far
5054 been referenced but not defined.  But if the file that is found is an
5055 ordinary object file, it is linked in the usual fashion.  The only
5056 difference between using an @option{-l} option and specifying a file name
5057 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5058 and searches several directories.
5059
5060 @item -lobjc
5061 @opindex lobjc
5062 You need this special case of the @option{-l} option in order to
5063 link an Objective-C program.
5064
5065 @item -nostartfiles
5066 @opindex nostartfiles
5067 Do not use the standard system startup files when linking.
5068 The standard system libraries are used normally, unless @option{-nostdlib}
5069 or @option{-nodefaultlibs} is used.
5070
5071 @item -nodefaultlibs
5072 @opindex nodefaultlibs
5073 Do not use the standard system libraries when linking.
5074 Only the libraries you specify will be passed to the linker.
5075 The standard startup files are used normally, unless @option{-nostartfiles}
5076 is used.  The compiler may generate calls to memcmp, memset, and memcpy
5077 for System V (and ISO C) environments or to bcopy and bzero for
5078 BSD environments.  These entries are usually resolved by entries in
5079 libc.  These entry points should be supplied through some other
5080 mechanism when this option is specified.
5081
5082 @item -nostdlib
5083 @opindex nostdlib
5084 Do not use the standard system startup files or libraries when linking.
5085 No startup files and only the libraries you specify will be passed to
5086 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
5087 for System V (and ISO C) environments or to bcopy and bzero for
5088 BSD environments.  These entries are usually resolved by entries in
5089 libc.  These entry points should be supplied through some other
5090 mechanism when this option is specified.
5091
5092 @cindex @option{-lgcc}, use with @option{-nostdlib}
5093 @cindex @option{-nostdlib} and unresolved references
5094 @cindex unresolved references and @option{-nostdlib}
5095 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5096 @cindex @option{-nodefaultlibs} and unresolved references
5097 @cindex unresolved references and @option{-nodefaultlibs}
5098 One of the standard libraries bypassed by @option{-nostdlib} and
5099 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5100 that GCC uses to overcome shortcomings of particular machines, or special
5101 needs for some languages.
5102 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5103 Collection (GCC) Internals},
5104 for more discussion of @file{libgcc.a}.)
5105 In most cases, you need @file{libgcc.a} even when you want to avoid
5106 other standard libraries.  In other words, when you specify @option{-nostdlib}
5107 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5108 This ensures that you have no unresolved references to internal GCC
5109 library subroutines.  (For example, @samp{__main}, used to ensure C++
5110 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5111 GNU Compiler Collection (GCC) Internals}.)
5112
5113 @item -pie
5114 @opindex pie
5115 Produce a position independent executable on targets which support it.
5116 For predictable results, you must also specify the same set of options
5117 that were used to generate code (@option{-fpie}, @option{-fPIE},
5118 or model suboptions) when you specify this option.
5119
5120 @item -s
5121 @opindex s
5122 Remove all symbol table and relocation information from the executable.
5123
5124 @item -static
5125 @opindex static
5126 On systems that support dynamic linking, this prevents linking with the shared
5127 libraries.  On other systems, this option has no effect.
5128
5129 @item -shared
5130 @opindex shared
5131 Produce a shared object which can then be linked with other objects to
5132 form an executable.  Not all systems support this option.  For predictable
5133 results, you must also specify the same set of options that were used to
5134 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5135 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5136 needs to build supplementary stub code for constructors to work.  On
5137 multi-libbed systems, @samp{gcc -shared} must select the correct support
5138 libraries to link against.  Failing to supply the correct flags may lead
5139 to subtle defects.  Supplying them in cases where they are not necessary
5140 is innocuous.}
5141
5142 @item -shared-libgcc
5143 @itemx -static-libgcc
5144 @opindex shared-libgcc
5145 @opindex static-libgcc
5146 On systems that provide @file{libgcc} as a shared library, these options
5147 force the use of either the shared or static version respectively.
5148 If no shared version of @file{libgcc} was built when the compiler was
5149 configured, these options have no effect.
5150
5151 There are several situations in which an application should use the
5152 shared @file{libgcc} instead of the static version.  The most common
5153 of these is when the application wishes to throw and catch exceptions
5154 across different shared libraries.  In that case, each of the libraries
5155 as well as the application itself should use the shared @file{libgcc}.
5156
5157 Therefore, the G++ and GCJ drivers automatically add
5158 @option{-shared-libgcc} whenever you build a shared library or a main
5159 executable, because C++ and Java programs typically use exceptions, so
5160 this is the right thing to do.
5161
5162 If, instead, you use the GCC driver to create shared libraries, you may
5163 find that they will not always be linked with the shared @file{libgcc}.
5164 If GCC finds, at its configuration time, that you have a GNU linker that
5165 does not support option @option{--eh-frame-hdr}, it will link the shared
5166 version of @file{libgcc} into shared libraries by default.  Otherwise,
5167 it will take advantage of the linker and optimize away the linking with
5168 the shared version of @file{libgcc}, linking with the static version of
5169 libgcc by default.  This allows exceptions to propagate through such
5170 shared libraries, without incurring relocation costs at library load
5171 time.
5172
5173 However, if a library or main executable is supposed to throw or catch
5174 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5175 for the languages used in the program, or using the option
5176 @option{-shared-libgcc}, such that it is linked with the shared
5177 @file{libgcc}.
5178
5179 @item -symbolic
5180 @opindex symbolic
5181 Bind references to global symbols when building a shared object.  Warn
5182 about any unresolved references (unless overridden by the link editor
5183 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5184 this option.
5185
5186 @item -Xlinker @var{option}
5187 @opindex Xlinker
5188 Pass @var{option} as an option to the linker.  You can use this to
5189 supply system-specific linker options which GCC does not know how to
5190 recognize.
5191
5192 If you want to pass an option that takes an argument, you must use
5193 @option{-Xlinker} twice, once for the option and once for the argument.
5194 For example, to pass @option{-assert definitions}, you must write
5195 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5196 @option{-Xlinker "-assert definitions"}, because this passes the entire
5197 string as a single argument, which is not what the linker expects.
5198
5199 @item -Wl,@var{option}
5200 @opindex Wl
5201 Pass @var{option} as an option to the linker.  If @var{option} contains
5202 commas, it is split into multiple options at the commas.
5203
5204 @item -u @var{symbol}
5205 @opindex u
5206 Pretend the symbol @var{symbol} is undefined, to force linking of
5207 library modules to define it.  You can use @option{-u} multiple times with
5208 different symbols to force loading of additional library modules.
5209 @end table
5210
5211 @node Directory Options
5212 @section Options for Directory Search
5213 @cindex directory options
5214 @cindex options, directory search
5215 @cindex search path
5216
5217 These options specify directories to search for header files, for
5218 libraries and for parts of the compiler:
5219
5220 @table @gcctabopt
5221 @item -I@var{dir}
5222 @opindex I
5223 Add the directory @var{dir} to the head of the list of directories to be
5224 searched for header files.  This can be used to override a system header
5225 file, substituting your own version, since these directories are
5226 searched before the system header file directories.  However, you should
5227 not use this option to add directories that contain vendor-supplied
5228 system header files (use @option{-isystem} for that).  If you use more than
5229 one @option{-I} option, the directories are scanned in left-to-right
5230 order; the standard system directories come after.
5231
5232 If a standard system include directory, or a directory specified with
5233 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5234 option will be ignored.  The directory will still be searched but as a
5235 system directory at its normal position in the system include chain.
5236 This is to ensure that GCC's procedure to fix buggy system headers and
5237 the ordering for the include_next directive are not inadvertently changed.
5238 If you really need to change the search order for system directories,
5239 use the @option{-nostdinc} and/or @option{-isystem} options.
5240
5241 @item -I-
5242 @opindex I-
5243 Any directories you specify with @option{-I} options before the @option{-I-}
5244 option are searched only for the case of @samp{#include "@var{file}"};
5245 they are not searched for @samp{#include <@var{file}>}.
5246
5247 If additional directories are specified with @option{-I} options after
5248 the @option{-I-}, these directories are searched for all @samp{#include}
5249 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5250 this way.)
5251
5252 In addition, the @option{-I-} option inhibits the use of the current
5253 directory (where the current input file came from) as the first search
5254 directory for @samp{#include "@var{file}"}.  There is no way to
5255 override this effect of @option{-I-}.  With @option{-I.} you can specify
5256 searching the directory which was current when the compiler was
5257 invoked.  That is not exactly the same as what the preprocessor does
5258 by default, but it is often satisfactory.
5259
5260 @option{-I-} does not inhibit the use of the standard system directories
5261 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5262 independent.
5263
5264 @item -L@var{dir}
5265 @opindex L
5266 Add directory @var{dir} to the list of directories to be searched
5267 for @option{-l}.
5268
5269 @item -B@var{prefix}
5270 @opindex B
5271 This option specifies where to find the executables, libraries,
5272 include files, and data files of the compiler itself.
5273
5274 The compiler driver program runs one or more of the subprograms
5275 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5276 @var{prefix} as a prefix for each program it tries to run, both with and
5277 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5278
5279 For each subprogram to be run, the compiler driver first tries the
5280 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5281 was not specified, the driver tries two standard prefixes, which are
5282 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5283 those results in a file name that is found, the unmodified program
5284 name is searched for using the directories specified in your
5285 @env{PATH} environment variable.
5286
5287 The compiler will check to see if the path provided by the @option{-B}
5288 refers to a directory, and if necessary it will add a directory
5289 separator character at the end of the path.
5290
5291 @option{-B} prefixes that effectively specify directory names also apply
5292 to libraries in the linker, because the compiler translates these
5293 options into @option{-L} options for the linker.  They also apply to
5294 includes files in the preprocessor, because the compiler translates these
5295 options into @option{-isystem} options for the preprocessor.  In this case,
5296 the compiler appends @samp{include} to the prefix.
5297
5298 The run-time support file @file{libgcc.a} can also be searched for using
5299 the @option{-B} prefix, if needed.  If it is not found there, the two
5300 standard prefixes above are tried, and that is all.  The file is left
5301 out of the link if it is not found by those means.
5302
5303 Another way to specify a prefix much like the @option{-B} prefix is to use
5304 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5305 Variables}.
5306
5307 As a special kludge, if the path provided by @option{-B} is
5308 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5309 9, then it will be replaced by @file{[dir/]include}.  This is to help
5310 with boot-strapping the compiler.
5311
5312 @item -specs=@var{file}
5313 @opindex specs
5314 Process @var{file} after the compiler reads in the standard @file{specs}
5315 file, in order to override the defaults that the @file{gcc} driver
5316 program uses when determining what switches to pass to @file{cc1},
5317 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5318 @option{-specs=@var{file}} can be specified on the command line, and they
5319 are processed in order, from left to right.
5320 @end table
5321
5322 @c man end
5323
5324 @node Spec Files
5325 @section Specifying subprocesses and the switches to pass to them
5326 @cindex Spec Files
5327
5328 @command{gcc} is a driver program.  It performs its job by invoking a
5329 sequence of other programs to do the work of compiling, assembling and
5330 linking.  GCC interprets its command-line parameters and uses these to
5331 deduce which programs it should invoke, and which command-line options
5332 it ought to place on their command lines.  This behavior is controlled
5333 by @dfn{spec strings}.  In most cases there is one spec string for each
5334 program that GCC can invoke, but a few programs have multiple spec
5335 strings to control their behavior.  The spec strings built into GCC can
5336 be overridden by using the @option{-specs=} command-line switch to specify
5337 a spec file.
5338
5339 @dfn{Spec files} are plaintext files that are used to construct spec
5340 strings.  They consist of a sequence of directives separated by blank
5341 lines.  The type of directive is determined by the first non-whitespace
5342 character on the line and it can be one of the following:
5343
5344 @table @code
5345 @item %@var{command}
5346 Issues a @var{command} to the spec file processor.  The commands that can
5347 appear here are:
5348
5349 @table @code
5350 @item %include <@var{file}>
5351 @cindex %include
5352 Search for @var{file} and insert its text at the current point in the
5353 specs file.
5354
5355 @item %include_noerr <@var{file}>
5356 @cindex %include_noerr
5357 Just like @samp{%include}, but do not generate an error message if the include
5358 file cannot be found.
5359
5360 @item %rename @var{old_name} @var{new_name}
5361 @cindex %rename
5362 Rename the spec string @var{old_name} to @var{new_name}.
5363
5364 @end table
5365
5366 @item *[@var{spec_name}]:
5367 This tells the compiler to create, override or delete the named spec
5368 string.  All lines after this directive up to the next directive or
5369 blank line are considered to be the text for the spec string.  If this
5370 results in an empty string then the spec will be deleted.  (Or, if the
5371 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5372 does not currently exist a new spec will be created.  If the spec does
5373 exist then its contents will be overridden by the text of this
5374 directive, unless the first character of that text is the @samp{+}
5375 character, in which case the text will be appended to the spec.
5376
5377 @item [@var{suffix}]:
5378 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5379 and up to the next directive or blank line are considered to make up the
5380 spec string for the indicated suffix.  When the compiler encounters an
5381 input file with the named suffix, it will processes the spec string in
5382 order to work out how to compile that file.  For example:
5383
5384 @smallexample
5385 .ZZ:
5386 z-compile -input %i
5387 @end smallexample
5388
5389 This says that any input file whose name ends in @samp{.ZZ} should be
5390 passed to the program @samp{z-compile}, which should be invoked with the
5391 command-line switch @option{-input} and with the result of performing the
5392 @samp{%i} substitution.  (See below.)
5393
5394 As an alternative to providing a spec string, the text that follows a
5395 suffix directive can be one of the following:
5396
5397 @table @code
5398 @item @@@var{language}
5399 This says that the suffix is an alias for a known @var{language}.  This is
5400 similar to using the @option{-x} command-line switch to GCC to specify a
5401 language explicitly.  For example:
5402
5403 @smallexample
5404 .ZZ:
5405 @@c++
5406 @end smallexample
5407
5408 Says that .ZZ files are, in fact, C++ source files.
5409
5410 @item #@var{name}
5411 This causes an error messages saying:
5412
5413 @smallexample
5414 @var{name} compiler not installed on this system.
5415 @end smallexample
5416 @end table
5417
5418 GCC already has an extensive list of suffixes built into it.
5419 This directive will add an entry to the end of the list of suffixes, but
5420 since the list is searched from the end backwards, it is effectively
5421 possible to override earlier entries using this technique.
5422
5423 @end table
5424
5425 GCC has the following spec strings built into it.  Spec files can
5426 override these strings or create their own.  Note that individual
5427 targets can also add their own spec strings to this list.
5428
5429 @smallexample
5430 asm          Options to pass to the assembler
5431 asm_final    Options to pass to the assembler post-processor
5432 cpp          Options to pass to the C preprocessor
5433 cc1          Options to pass to the C compiler
5434 cc1plus      Options to pass to the C++ compiler
5435 endfile      Object files to include at the end of the link
5436 link         Options to pass to the linker
5437 lib          Libraries to include on the command line to the linker
5438 libgcc       Decides which GCC support library to pass to the linker
5439 linker       Sets the name of the linker
5440 predefines   Defines to be passed to the C preprocessor
5441 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5442              by default
5443 startfile    Object files to include at the start of the link
5444 @end smallexample
5445
5446 Here is a small example of a spec file:
5447
5448 @smallexample
5449 %rename lib                 old_lib
5450
5451 *lib:
5452 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5453 @end smallexample
5454
5455 This example renames the spec called @samp{lib} to @samp{old_lib} and
5456 then overrides the previous definition of @samp{lib} with a new one.
5457 The new definition adds in some extra command-line options before
5458 including the text of the old definition.
5459
5460 @dfn{Spec strings} are a list of command-line options to be passed to their
5461 corresponding program.  In addition, the spec strings can contain
5462 @samp{%}-prefixed sequences to substitute variable text or to
5463 conditionally insert text into the command line.  Using these constructs
5464 it is possible to generate quite complex command lines.
5465
5466 Here is a table of all defined @samp{%}-sequences for spec
5467 strings.  Note that spaces are not generated automatically around the
5468 results of expanding these sequences.  Therefore you can concatenate them
5469 together or combine them with constant text in a single argument.
5470
5471 @table @code
5472 @item %%
5473 Substitute one @samp{%} into the program name or argument.
5474
5475 @item %i
5476 Substitute the name of the input file being processed.
5477
5478 @item %b
5479 Substitute the basename of the input file being processed.
5480 This is the substring up to (and not including) the last period
5481 and not including the directory.
5482
5483 @item %B
5484 This is the same as @samp{%b}, but include the file suffix (text after
5485 the last period).
5486
5487 @item %d
5488 Marks the argument containing or following the @samp{%d} as a
5489 temporary file name, so that that file will be deleted if GCC exits
5490 successfully.  Unlike @samp{%g}, this contributes no text to the
5491 argument.
5492
5493 @item %g@var{suffix}
5494 Substitute a file name that has suffix @var{suffix} and is chosen
5495 once per compilation, and mark the argument in the same way as
5496 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5497 name is now chosen in a way that is hard to predict even when previously
5498 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5499 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5500 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5501 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5502 was simply substituted with a file name chosen once per compilation,
5503 without regard to any appended suffix (which was therefore treated
5504 just like ordinary text), making such attacks more likely to succeed.
5505
5506 @item %u@var{suffix}
5507 Like @samp{%g}, but generates a new temporary file name even if
5508 @samp{%u@var{suffix}} was already seen.
5509
5510 @item %U@var{suffix}
5511 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5512 new one if there is no such last file name.  In the absence of any
5513 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5514 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5515 would involve the generation of two distinct file names, one
5516 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5517 simply substituted with a file name chosen for the previous @samp{%u},
5518 without regard to any appended suffix.
5519
5520 @item %j@var{suffix}
5521 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5522 writable, and if save-temps is off; otherwise, substitute the name
5523 of a temporary file, just like @samp{%u}.  This temporary file is not
5524 meant for communication between processes, but rather as a junk
5525 disposal mechanism.
5526
5527 @item %|@var{suffix}
5528 @itemx %m@var{suffix}
5529 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5530 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5531 all.  These are the two most common ways to instruct a program that it
5532 should read from standard input or write to standard output.  If you
5533 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5534 construct: see for example @file{f/lang-specs.h}.
5535
5536 @item %.@var{SUFFIX}
5537 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5538 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5539 terminated by the next space or %.
5540
5541 @item %w
5542 Marks the argument containing or following the @samp{%w} as the
5543 designated output file of this compilation.  This puts the argument
5544 into the sequence of arguments that @samp{%o} will substitute later.
5545
5546 @item %o
5547 Substitutes the names of all the output files, with spaces
5548 automatically placed around them.  You should write spaces
5549 around the @samp{%o} as well or the results are undefined.
5550 @samp{%o} is for use in the specs for running the linker.
5551 Input files whose names have no recognized suffix are not compiled
5552 at all, but they are included among the output files, so they will
5553 be linked.
5554
5555 @item %O
5556 Substitutes the suffix for object files.  Note that this is
5557 handled specially when it immediately follows @samp{%g, %u, or %U},
5558 because of the need for those to form complete file names.  The
5559 handling is such that @samp{%O} is treated exactly as if it had already
5560 been substituted, except that @samp{%g, %u, and %U} do not currently
5561 support additional @var{suffix} characters following @samp{%O} as they would
5562 following, for example, @samp{.o}.
5563
5564 @item %p
5565 Substitutes the standard macro predefinitions for the
5566 current target machine.  Use this when running @code{cpp}.
5567
5568 @item %P
5569 Like @samp{%p}, but puts @samp{__} before and after the name of each
5570 predefined macro, except for macros that start with @samp{__} or with
5571 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5572 C@.
5573
5574 @item %I
5575 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5576 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5577 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5578 as necessary.
5579
5580 @item %s
5581 Current argument is the name of a library or startup file of some sort.
5582 Search for that file in a standard list of directories and substitute
5583 the full name found.
5584
5585 @item %e@var{str}
5586 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5587 Use this when inconsistent options are detected.
5588
5589 @item %(@var{name})
5590 Substitute the contents of spec string @var{name} at this point.
5591
5592 @item %[@var{name}]
5593 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5594
5595 @item %x@{@var{option}@}
5596 Accumulate an option for @samp{%X}.
5597
5598 @item %X
5599 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5600 spec string.
5601
5602 @item %Y
5603 Output the accumulated assembler options specified by @option{-Wa}.
5604
5605 @item %Z
5606 Output the accumulated preprocessor options specified by @option{-Wp}.
5607
5608 @item %a
5609 Process the @code{asm} spec.  This is used to compute the
5610 switches to be passed to the assembler.
5611
5612 @item %A
5613 Process the @code{asm_final} spec.  This is a spec string for
5614 passing switches to an assembler post-processor, if such a program is
5615 needed.
5616
5617 @item %l
5618 Process the @code{link} spec.  This is the spec for computing the
5619 command line passed to the linker.  Typically it will make use of the
5620 @samp{%L %G %S %D and %E} sequences.
5621
5622 @item %D
5623 Dump out a @option{-L} option for each directory that GCC believes might
5624 contain startup files.  If the target supports multilibs then the
5625 current multilib directory will be prepended to each of these paths.
5626
5627 @item %M
5628 Output the multilib directory with directory separators replaced with
5629 @samp{_}.  If multilib directories are not set, or the multilib directory is
5630 @file{.} then this option emits nothing.
5631
5632 @item %L
5633 Process the @code{lib} spec.  This is a spec string for deciding which
5634 libraries should be included on the command line to the linker.
5635
5636 @item %G
5637 Process the @code{libgcc} spec.  This is a spec string for deciding
5638 which GCC support library should be included on the command line to the linker.
5639
5640 @item %S
5641 Process the @code{startfile} spec.  This is a spec for deciding which
5642 object files should be the first ones passed to the linker.  Typically
5643 this might be a file named @file{crt0.o}.
5644
5645 @item %E
5646 Process the @code{endfile} spec.  This is a spec string that specifies
5647 the last object files that will be passed to the linker.
5648
5649 @item %C
5650 Process the @code{cpp} spec.  This is used to construct the arguments
5651 to be passed to the C preprocessor.
5652
5653 @item %c
5654 Process the @code{signed_char} spec.  This is intended to be used
5655 to tell cpp whether a char is signed.  It typically has the definition:
5656 @smallexample
5657 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5658 @end smallexample
5659
5660 @item %1
5661 Process the @code{cc1} spec.  This is used to construct the options to be
5662 passed to the actual C compiler (@samp{cc1}).
5663
5664 @item %2
5665 Process the @code{cc1plus} spec.  This is used to construct the options to be
5666 passed to the actual C++ compiler (@samp{cc1plus}).
5667
5668 @item %*
5669 Substitute the variable part of a matched option.  See below.
5670 Note that each comma in the substituted string is replaced by
5671 a single space.
5672
5673 @item %<@code{S}
5674 Remove all occurrences of @code{-S} from the command line.  Note---this
5675 command is position dependent.  @samp{%} commands in the spec string
5676 before this one will see @code{-S}, @samp{%} commands in the spec string
5677 after this one will not.
5678
5679 @item %:@var{function}(@var{args})
5680 Call the named function @var{function}, passing it @var{args}.
5681 @var{args} is first processed as a nested spec string, then split
5682 into an argument vector in the usual fashion.  The function returns
5683 a string which is processed as if it had appeared literally as part
5684 of the current spec.
5685
5686 The following built-in spec functions are provided:
5687
5688 @table @code
5689 @item @code{if-exists}
5690 The @code{if-exists} spec function takes one argument, an absolute
5691 pathname to a file.  If the file exists, @code{if-exists} returns the
5692 pathname.  Here is a small example of its usage:
5693
5694 @smallexample
5695 *startfile:
5696 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5697 @end smallexample
5698
5699 @item @code{if-exists-else}
5700 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5701 spec function, except that it takes two arguments.  The first argument is
5702 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5703 returns the pathname.  If it does not exist, it returns the second argument.
5704 This way, @code{if-exists-else} can be used to select one file or another,
5705 based on the existence of the first.  Here is a small example of its usage:
5706
5707 @smallexample 
5708 *startfile:
5709 crt0%O%s %:if-exists(crti%O%s) \
5710 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5711 @end smallexample
5712 @end table 
5713
5714 @item %@{@code{S}@}
5715 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5716 If that switch was not specified, this substitutes nothing.  Note that
5717 the leading dash is omitted when specifying this option, and it is
5718 automatically inserted if the substitution is performed.  Thus the spec
5719 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5720 and would output the command line option @option{-foo}.
5721
5722 @item %W@{@code{S}@}
5723 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5724 deleted on failure.
5725
5726 @item %@{@code{S}*@}
5727 Substitutes all the switches specified to GCC whose names start
5728 with @code{-S}, but which also take an argument.  This is used for
5729 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5730 GCC considers @option{-o foo} as being
5731 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5732 text, including the space.  Thus two arguments would be generated.
5733
5734 @item %@{@code{S}*&@code{T}*@}
5735 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5736 (the order of @code{S} and @code{T} in the spec is not significant).
5737 There can be any number of ampersand-separated variables; for each the
5738 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5739
5740 @item %@{@code{S}:@code{X}@}
5741 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5742
5743 @item %@{!@code{S}:@code{X}@}
5744 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5745
5746 @item %@{@code{S}*:@code{X}@}
5747 Substitutes @code{X} if one or more switches whose names start with
5748 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5749 once, no matter how many such switches appeared.  However, if @code{%*}
5750 appears somewhere in @code{X}, then @code{X} will be substituted once
5751 for each matching switch, with the @code{%*} replaced by the part of
5752 that switch that matched the @code{*}.
5753
5754 @item %@{.@code{S}:@code{X}@}
5755 Substitutes @code{X}, if processing a file with suffix @code{S}.
5756
5757 @item %@{!.@code{S}:@code{X}@}
5758 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5759
5760 @item %@{@code{S}|@code{P}:@code{X}@}
5761 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5762 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5763 although they have a stronger binding than the @samp{|}.  If @code{%*}
5764 appears in @code{X}, all of the alternatives must be starred, and only
5765 the first matching alternative is substituted.
5766
5767 For example, a spec string like this:
5768
5769 @smallexample
5770 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5771 @end smallexample
5772
5773 will output the following command-line options from the following input
5774 command-line options:
5775
5776 @smallexample
5777 fred.c        -foo -baz
5778 jim.d         -bar -boggle
5779 -d fred.c     -foo -baz -boggle
5780 -d jim.d      -bar -baz -boggle
5781 @end smallexample
5782
5783 @item %@{S:X; T:Y; :D@}
5784
5785 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
5786 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
5787 be as many clauses as you need.  This may be combined with @code{.}, 
5788 @code{!}, @code{|}, and @code{*} as needed.
5789
5790
5791 @end table
5792
5793 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5794 construct may contain other nested @samp{%} constructs or spaces, or
5795 even newlines.  They are processed as usual, as described above.
5796 Trailing white space in @code{X} is ignored.  White space may also
5797 appear anywhere on the left side of the colon in these constructs,
5798 except between @code{.} or @code{*} and the corresponding word.
5799
5800 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5801 handled specifically in these constructs.  If another value of
5802 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5803 @option{-W} switch is found later in the command line, the earlier
5804 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5805 just one letter, which passes all matching options.
5806
5807 The character @samp{|} at the beginning of the predicate text is used to
5808 indicate that a command should be piped to the following command, but
5809 only if @option{-pipe} is specified.
5810
5811 It is built into GCC which switches take arguments and which do not.
5812 (You might think it would be useful to generalize this to allow each
5813 compiler's spec to say which switches take arguments.  But this cannot
5814 be done in a consistent fashion.  GCC cannot even decide which input
5815 files have been specified without knowing which switches take arguments,
5816 and it must know which input files to compile in order to tell which
5817 compilers to run).
5818
5819 GCC also knows implicitly that arguments starting in @option{-l} are to be
5820 treated as compiler output files, and passed to the linker in their
5821 proper position among the other output files.
5822
5823 @c man begin OPTIONS
5824
5825 @node Target Options
5826 @section Specifying Target Machine and Compiler Version
5827 @cindex target options
5828 @cindex cross compiling
5829 @cindex specifying machine version
5830 @cindex specifying compiler version and target machine
5831 @cindex compiler version, specifying
5832 @cindex target machine, specifying
5833
5834 The usual way to run GCC is to run the executable called @file{gcc}, or
5835 @file{<machine>-gcc} when cross-compiling, or
5836 @file{<machine>-gcc-<version>} to run a version other than the one that
5837 was installed last.  Sometimes this is inconvenient, so GCC provides
5838 options that will switch to another cross-compiler or version.
5839
5840 @table @gcctabopt
5841 @item -b @var{machine}
5842 @opindex b
5843 The argument @var{machine} specifies the target machine for compilation.
5844
5845 The value to use for @var{machine} is the same as was specified as the
5846 machine type when configuring GCC as a cross-compiler.  For
5847 example, if a cross-compiler was configured with @samp{configure
5848 i386v}, meaning to compile for an 80386 running System V, then you
5849 would specify @option{-b i386v} to run that cross compiler.
5850
5851 @item -V @var{version}
5852 @opindex V
5853 The argument @var{version} specifies which version of GCC to run.
5854 This is useful when multiple versions are installed.  For example,
5855 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5856 @end table
5857
5858 The @option{-V} and @option{-b} options work by running the
5859 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5860 use them if you can just run that directly.
5861
5862 @node Submodel Options
5863 @section Hardware Models and Configurations
5864 @cindex submodel options
5865 @cindex specifying hardware config
5866 @cindex hardware models and configurations, specifying
5867 @cindex machine dependent options
5868
5869 Earlier we discussed the standard option @option{-b} which chooses among
5870 different installed compilers for completely different target
5871 machines, such as VAX vs.@: 68000 vs.@: 80386.
5872
5873 In addition, each of these target machine types can have its own
5874 special options, starting with @samp{-m}, to choose among various
5875 hardware models or configurations---for example, 68010 vs 68020,
5876 floating coprocessor or none.  A single installed version of the
5877 compiler can compile for any model or configuration, according to the
5878 options specified.
5879
5880 Some configurations of the compiler also support additional special
5881 options, usually for compatibility with other compilers on the same
5882 platform.
5883
5884 These options are defined by the macro @code{TARGET_SWITCHES} in the
5885 machine description.  The default for the options is also defined by
5886 that macro, which enables you to change the defaults.
5887
5888 @menu
5889 * M680x0 Options::
5890 * M68hc1x Options::
5891 * VAX Options::
5892 * SPARC Options::
5893 * ARM Options::
5894 * MN10200 Options::
5895 * MN10300 Options::
5896 * M32R/D Options::
5897 * M88K Options::
5898 * RS/6000 and PowerPC Options::
5899 * Darwin Options::
5900 * RT Options::
5901 * MIPS Options::
5902 * i386 and x86-64 Options::
5903 * HPPA Options::
5904 * Intel 960 Options::
5905 * DEC Alpha Options::
5906 * DEC Alpha/VMS Options::
5907 * H8/300 Options::
5908 * SH Options::
5909 * System V Options::
5910 * TMS320C3x/C4x Options::
5911 * V850 Options::
5912 * ARC Options::
5913 * NS32K Options::
5914 * AVR Options::
5915 * MCore Options::
5916 * IA-64 Options::
5917 * D30V Options::
5918 * S/390 and zSeries Options::
5919 * CRIS Options::
5920 * MMIX Options::
5921 * PDP-11 Options::
5922 * Xstormy16 Options::
5923 * Xtensa Options::
5924 * FRV Options::
5925 @end menu
5926
5927 @node M680x0 Options
5928 @subsection M680x0 Options
5929 @cindex M680x0 options
5930
5931 These are the @samp{-m} options defined for the 68000 series.  The default
5932 values for these options depends on which style of 68000 was selected when
5933 the compiler was configured; the defaults for the most common choices are
5934 given below.
5935
5936 @table @gcctabopt
5937 @item -m68000
5938 @itemx -mc68000
5939 @opindex m68000
5940 @opindex mc68000
5941 Generate output for a 68000.  This is the default
5942 when the compiler is configured for 68000-based systems.
5943
5944 Use this option for microcontrollers with a 68000 or EC000 core,
5945 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5946
5947 @item -m68020
5948 @itemx -mc68020
5949 @opindex m68020
5950 @opindex mc68020
5951 Generate output for a 68020.  This is the default
5952 when the compiler is configured for 68020-based systems.
5953
5954 @item -m68881
5955 @opindex m68881
5956 Generate output containing 68881 instructions for floating point.
5957 This is the default for most 68020 systems unless @option{--nfp} was
5958 specified when the compiler was configured.
5959
5960 @item -m68030
5961 @opindex m68030
5962 Generate output for a 68030.  This is the default when the compiler is
5963 configured for 68030-based systems.
5964
5965 @item -m68040
5966 @opindex m68040
5967 Generate output for a 68040.  This is the default when the compiler is
5968 configured for 68040-based systems.
5969
5970 This option inhibits the use of 68881/68882 instructions that have to be
5971 emulated by software on the 68040.  Use this option if your 68040 does not
5972 have code to emulate those instructions.
5973
5974 @item -m68060
5975 @opindex m68060
5976 Generate output for a 68060.  This is the default when the compiler is
5977 configured for 68060-based systems.
5978
5979 This option inhibits the use of 68020 and 68881/68882 instructions that
5980 have to be emulated by software on the 68060.  Use this option if your 68060
5981 does not have code to emulate those instructions.
5982
5983 @item -mcpu32
5984 @opindex mcpu32
5985 Generate output for a CPU32.  This is the default
5986 when the compiler is configured for CPU32-based systems.
5987
5988 Use this option for microcontrollers with a
5989 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5990 68336, 68340, 68341, 68349 and 68360.
5991
5992 @item -m5200
5993 @opindex m5200
5994 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5995 when the compiler is configured for 520X-based systems.
5996
5997 Use this option for microcontroller with a 5200 core, including
5998 the MCF5202, MCF5203, MCF5204 and MCF5202.
5999
6000
6001 @item -m68020-40
6002 @opindex m68020-40
6003 Generate output for a 68040, without using any of the new instructions.
6004 This results in code which can run relatively efficiently on either a
6005 68020/68881 or a 68030 or a 68040.  The generated code does use the
6006 68881 instructions that are emulated on the 68040.
6007
6008 @item -m68020-60
6009 @opindex m68020-60
6010 Generate output for a 68060, without using any of the new instructions.
6011 This results in code which can run relatively efficiently on either a
6012 68020/68881 or a 68030 or a 68040.  The generated code does use the
6013 68881 instructions that are emulated on the 68060.
6014
6015 @item -msoft-float
6016 @opindex msoft-float
6017 Generate output containing library calls for floating point.
6018 @strong{Warning:} the requisite libraries are not available for all m68k
6019 targets.  Normally the facilities of the machine's usual C compiler are
6020 used, but this can't be done directly in cross-compilation.  You must
6021 make your own arrangements to provide suitable library functions for
6022 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
6023 @samp{m68k-*-coff} do provide software floating point support.
6024
6025 @item -mshort
6026 @opindex mshort
6027 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6028
6029 @item -mnobitfield
6030 @opindex mnobitfield
6031 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
6032 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
6033
6034 @item -mbitfield
6035 @opindex mbitfield
6036 Do use the bit-field instructions.  The @option{-m68020} option implies
6037 @option{-mbitfield}.  This is the default if you use a configuration
6038 designed for a 68020.
6039
6040 @item -mrtd
6041 @opindex mrtd
6042 Use a different function-calling convention, in which functions
6043 that take a fixed number of arguments return with the @code{rtd}
6044 instruction, which pops their arguments while returning.  This
6045 saves one instruction in the caller since there is no need to pop
6046 the arguments there.
6047
6048 This calling convention is incompatible with the one normally
6049 used on Unix, so you cannot use it if you need to call libraries
6050 compiled with the Unix compiler.
6051
6052 Also, you must provide function prototypes for all functions that
6053 take variable numbers of arguments (including @code{printf});
6054 otherwise incorrect code will be generated for calls to those
6055 functions.
6056
6057 In addition, seriously incorrect code will result if you call a
6058 function with too many arguments.  (Normally, extra arguments are
6059 harmlessly ignored.)
6060
6061 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
6062 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
6063
6064 @item -malign-int
6065 @itemx -mno-align-int
6066 @opindex malign-int
6067 @opindex mno-align-int
6068 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
6069 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
6070 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
6071 Aligning variables on 32-bit boundaries produces code that runs somewhat
6072 faster on processors with 32-bit busses at the expense of more memory.
6073
6074 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
6075 align structures containing the above types  differently than
6076 most published application binary interface specifications for the m68k.
6077
6078 @item -mpcrel
6079 @opindex mpcrel
6080 Use the pc-relative addressing mode of the 68000 directly, instead of
6081 using a global offset table.  At present, this option implies @option{-fpic},
6082 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
6083 not presently supported with @option{-mpcrel}, though this could be supported for
6084 68020 and higher processors.
6085
6086 @item -mno-strict-align
6087 @itemx -mstrict-align
6088 @opindex mno-strict-align
6089 @opindex mstrict-align
6090 Do not (do) assume that unaligned memory references will be handled by
6091 the system.
6092
6093 @item -msep-data
6094 Generate code that allows the data segment to be located in a different
6095 area of memory from the text segment.  This allows for execute in place in
6096 an environment without virtual memory management.  This option implies -fPIC.
6097
6098 @item -mno-sep-data
6099 Generate code that assumes that the data segment follows the text segment.
6100 This is the default.
6101
6102 @item -mid-shared-library
6103 Generate code that supports shared libraries via the library ID method.
6104 This allows for execute in place and shared libraries in an environment
6105 without virtual memory management.  This option implies -fPIC.
6106
6107 @item -mno-id-shared-library
6108 Generate code that doesn't assume ID based shared libraries are being used.
6109 This is the default.
6110
6111 @item -mshared-library-id=n
6112 Specified the identification number of the ID based shared library being
6113 compiled.  Specifying a value of 0 will generate more compact code, specifying
6114 other values will force the allocation of that number to the current
6115 library but is no more space or time efficient than omitting this option.
6116
6117 @end table
6118
6119 @node M68hc1x Options
6120 @subsection M68hc1x Options
6121 @cindex M68hc1x options
6122
6123 These are the @samp{-m} options defined for the 68hc11 and 68hc12
6124 microcontrollers.  The default values for these options depends on
6125 which style of microcontroller was selected when the compiler was configured;
6126 the defaults for the most common choices are given below.
6127
6128 @table @gcctabopt
6129 @item -m6811
6130 @itemx -m68hc11
6131 @opindex m6811
6132 @opindex m68hc11
6133 Generate output for a 68HC11.  This is the default
6134 when the compiler is configured for 68HC11-based systems.
6135
6136 @item -m6812
6137 @itemx -m68hc12
6138 @opindex m6812
6139 @opindex m68hc12
6140 Generate output for a 68HC12.  This is the default
6141 when the compiler is configured for 68HC12-based systems.
6142
6143 @item -m68S12
6144 @itemx -m68hcs12
6145 @opindex m68S12
6146 @opindex m68hcs12
6147 Generate output for a 68HCS12.  
6148
6149 @item -mauto-incdec
6150 @opindex mauto-incdec
6151 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
6152 addressing modes.
6153
6154 @item -minmax
6155 @itemx -nominmax
6156 @opindex minmax
6157 @opindex mnominmax
6158 Enable the use of 68HC12 min and max instructions.
6159
6160 @item -mlong-calls
6161 @itemx -mno-long-calls
6162 @opindex mlong-calls
6163 @opindex mno-long-calls
6164 Treat all calls as being far away (near).  If calls are assumed to be
6165 far away, the compiler will use the @code{call} instruction to
6166 call a function and the @code{rtc} instruction for returning.
6167
6168 @item -mshort
6169 @opindex mshort
6170 Consider type @code{int} to be 16 bits wide, like @code{short int}.
6171
6172 @item -msoft-reg-count=@var{count}
6173 @opindex msoft-reg-count
6174 Specify the number of pseudo-soft registers which are used for the
6175 code generation.  The maximum number is 32.  Using more pseudo-soft
6176 register may or may not result in better code depending on the program.
6177 The default is 4 for 68HC11 and 2 for 68HC12.
6178
6179 @end table
6180
6181 @node VAX Options
6182 @subsection VAX Options
6183 @cindex VAX options
6184
6185 These @samp{-m} options are defined for the VAX:
6186
6187 @table @gcctabopt
6188 @item -munix
6189 @opindex munix
6190 Do not output certain jump instructions (@code{aobleq} and so on)
6191 that the Unix assembler for the VAX cannot handle across long
6192 ranges.
6193
6194 @item -mgnu
6195 @opindex mgnu
6196 Do output those jump instructions, on the assumption that you
6197 will assemble with the GNU assembler.
6198
6199 @item -mg
6200 @opindex mg
6201 Output code for g-format floating point numbers instead of d-format.
6202 @end table
6203
6204 @node SPARC Options
6205 @subsection SPARC Options
6206 @cindex SPARC options
6207
6208 These @samp{-m} switches are supported on the SPARC:
6209
6210 @table @gcctabopt
6211 @item -mno-app-regs
6212 @itemx -mapp-regs
6213 @opindex mno-app-regs
6214 @opindex mapp-regs
6215 Specify @option{-mapp-regs} to generate output using the global registers
6216 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
6217 is the default.
6218
6219 To be fully SVR4 ABI compliant at the cost of some performance loss,
6220 specify @option{-mno-app-regs}.  You should compile libraries and system
6221 software with this option.
6222
6223 @item -mfpu
6224 @itemx -mhard-float
6225 @opindex mfpu
6226 @opindex mhard-float
6227 Generate output containing floating point instructions.  This is the
6228 default.
6229
6230 @item -mno-fpu
6231 @itemx -msoft-float
6232 @opindex mno-fpu
6233 @opindex msoft-float
6234 Generate output containing library calls for floating point.
6235 @strong{Warning:} the requisite libraries are not available for all SPARC
6236 targets.  Normally the facilities of the machine's usual C compiler are
6237 used, but this cannot be done directly in cross-compilation.  You must make
6238 your own arrangements to provide suitable library functions for
6239 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
6240 @samp{sparclite-*-*} do provide software floating point support.
6241
6242 @option{-msoft-float} changes the calling convention in the output file;
6243 therefore, it is only useful if you compile @emph{all} of a program with
6244 this option.  In particular, you need to compile @file{libgcc.a}, the
6245 library that comes with GCC, with @option{-msoft-float} in order for
6246 this to work.
6247
6248 @item -mhard-quad-float
6249 @opindex mhard-quad-float
6250 Generate output containing quad-word (long double) floating point
6251 instructions.
6252
6253 @item -msoft-quad-float
6254 @opindex msoft-quad-float
6255 Generate output containing library calls for quad-word (long double)
6256 floating point instructions.  The functions called are those specified
6257 in the SPARC ABI@.  This is the default.
6258
6259 As of this writing, there are no sparc implementations that have hardware
6260 support for the quad-word floating point instructions.  They all invoke
6261 a trap handler for one of these instructions, and then the trap handler
6262 emulates the effect of the instruction.  Because of the trap handler overhead,
6263 this is much slower than calling the ABI library routines.  Thus the
6264 @option{-msoft-quad-float} option is the default.
6265
6266 @item -mno-flat
6267 @itemx -mflat
6268 @opindex mno-flat
6269 @opindex mflat
6270 With @option{-mflat}, the compiler does not generate save/restore instructions
6271 and will use a ``flat'' or single register window calling convention.
6272 This model uses %i7 as the frame pointer and is compatible with the normal
6273 register window model.  Code from either may be intermixed.
6274 The local registers and the input registers (0--5) are still treated as
6275 ``call saved'' registers and will be saved on the stack as necessary.
6276
6277 With @option{-mno-flat} (the default), the compiler emits save/restore
6278 instructions (except for leaf functions) and is the normal mode of operation.
6279
6280 @item -mno-unaligned-doubles
6281 @itemx -munaligned-doubles
6282 @opindex mno-unaligned-doubles
6283 @opindex munaligned-doubles
6284 Assume that doubles have 8 byte alignment.  This is the default.
6285
6286 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
6287 alignment only if they are contained in another type, or if they have an
6288 absolute address.  Otherwise, it assumes they have 4 byte alignment.
6289 Specifying this option avoids some rare compatibility problems with code
6290 generated by other compilers.  It is not the default because it results
6291 in a performance loss, especially for floating point code.
6292
6293 @item -mno-faster-structs
6294 @itemx -mfaster-structs
6295 @opindex mno-faster-structs
6296 @opindex mfaster-structs
6297 With @option{-mfaster-structs}, the compiler assumes that structures
6298 should have 8 byte alignment.  This enables the use of pairs of
6299 @code{ldd} and @code{std} instructions for copies in structure
6300 assignment, in place of twice as many @code{ld} and @code{st} pairs.
6301 However, the use of this changed alignment directly violates the SPARC
6302 ABI@.  Thus, it's intended only for use on targets where the developer
6303 acknowledges that their resulting code will not be directly in line with
6304 the rules of the ABI@.
6305
6306 @item -mimpure-text
6307 @opindex mimpure-text
6308 @option{-mimpure-text}, used in addition to @option{-shared}, tells
6309 the compiler to not pass @option{-z text} to the linker when linking a
6310 shared object.  Using this option, you can link position-dependent
6311 code into a shared object.  
6312
6313 @option{-mimpure-text} suppresses the ``relocations remain against
6314 allocatable but non-writable sections'' linker error message.
6315 However, the necessary relocations will trigger copy-on-write, and the
6316 shared object is not actually shared across processes.  Instead of
6317 using @option{-mimpure-text}, you should compile all source code with
6318 @option{-fpic} or @option{-fPIC}.
6319
6320 This option is only available on SunOS and Solaris.
6321
6322 @item -mv8
6323 @itemx -msparclite
6324 @opindex mv8
6325 @opindex msparclite
6326 These two options select variations on the SPARC architecture.
6327
6328 By default (unless specifically configured for the Fujitsu SPARClite),
6329 GCC generates code for the v7 variant of the SPARC architecture.
6330
6331 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
6332 code is that the compiler emits the integer multiply and integer
6333 divide instructions which exist in SPARC v8 but not in SPARC v7.
6334
6335 @option{-msparclite} will give you SPARClite code.  This adds the integer
6336 multiply, integer divide step and scan (@code{ffs}) instructions which
6337 exist in SPARClite but not in SPARC v7.
6338
6339 These options are deprecated and will be deleted in a future GCC release.
6340 They have been replaced with @option{-mcpu=xxx}.
6341
6342 @item -mcypress
6343 @itemx -msupersparc
6344 @opindex mcypress
6345 @opindex msupersparc
6346 These two options select the processor for which the code is optimized.
6347
6348 With @option{-mcypress} (the default), the compiler optimizes code for the
6349 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
6350 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
6351
6352 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
6353 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
6354 of the full SPARC v8 instruction set.
6355
6356 These options are deprecated and will be deleted in a future GCC release.
6357 They have been replaced with @option{-mcpu=xxx}.
6358
6359 @item -mcpu=@var{cpu_type}
6360 @opindex mcpu
6361 Set the instruction set, register set, and instruction scheduling parameters
6362 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
6363 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
6364 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
6365 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
6366 @samp{ultrasparc3}.
6367
6368 Default instruction scheduling parameters are used for values that select
6369 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
6370 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
6371
6372 Here is a list of each supported architecture and their supported
6373 implementations.
6374
6375 @smallexample
6376     v7:             cypress
6377     v8:             supersparc, hypersparc
6378     sparclite:      f930, f934, sparclite86x
6379     sparclet:       tsc701
6380     v9:             ultrasparc, ultrasparc3
6381 @end smallexample
6382
6383 @item -mtune=@var{cpu_type}
6384 @opindex mtune
6385 Set the instruction scheduling parameters for machine type
6386 @var{cpu_type}, but do not set the instruction set or register set that the
6387 option @option{-mcpu=@var{cpu_type}} would.
6388
6389 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6390 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6391 that select a particular cpu implementation.  Those are @samp{cypress},
6392 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6393 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6394 @samp{ultrasparc3}.
6395
6396 @end table
6397
6398 These @samp{-m} switches are supported in addition to the above
6399 on the SPARCLET processor.
6400
6401 @table @gcctabopt
6402 @item -mlittle-endian
6403 @opindex mlittle-endian
6404 Generate code for a processor running in little-endian mode.
6405
6406 @item -mlive-g0
6407 @opindex mlive-g0
6408 Treat register @code{%g0} as a normal register.
6409 GCC will continue to clobber it as necessary but will not assume
6410 it always reads as 0.
6411
6412 @item -mbroken-saverestore
6413 @opindex mbroken-saverestore
6414 Generate code that does not use non-trivial forms of the @code{save} and
6415 @code{restore} instructions.  Early versions of the SPARCLET processor do
6416 not correctly handle @code{save} and @code{restore} instructions used with
6417 arguments.  They correctly handle them used without arguments.  A @code{save}
6418 instruction used without arguments increments the current window pointer
6419 but does not allocate a new stack frame.  It is assumed that the window
6420 overflow trap handler will properly handle this case as will interrupt
6421 handlers.
6422 @end table
6423
6424 These @samp{-m} switches are supported in addition to the above
6425 on SPARC V9 processors in 64-bit environments.
6426
6427 @table @gcctabopt
6428 @item -mlittle-endian
6429 @opindex mlittle-endian
6430 Generate code for a processor running in little-endian mode. It is only
6431 available for a few configurations and most notably not on Solaris.
6432
6433 @item -m32
6434 @itemx -m64
6435 @opindex m32
6436 @opindex m64
6437 Generate code for a 32-bit or 64-bit environment.
6438 The 32-bit environment sets int, long and pointer to 32 bits.
6439 The 64-bit environment sets int to 32 bits and long and pointer
6440 to 64 bits.
6441
6442 @item -mcmodel=medlow
6443 @opindex mcmodel=medlow
6444 Generate code for the Medium/Low code model: the program must be linked
6445 in the low 32 bits of the address space.  Pointers are 64 bits.
6446 Programs can be statically or dynamically linked.
6447
6448 @item -mcmodel=medmid
6449 @opindex mcmodel=medmid
6450 Generate code for the Medium/Middle code model: the program must be linked
6451 in the low 44 bits of the address space, the text segment must be less than
6452 2G bytes, and data segment must be within 2G of the text segment.
6453 Pointers are 64 bits.
6454
6455 @item -mcmodel=medany
6456 @opindex mcmodel=medany
6457 Generate code for the Medium/Anywhere code model: the program may be linked
6458 anywhere in the address space, the text segment must be less than
6459 2G bytes, and data segment must be within 2G of the text segment.
6460 Pointers are 64 bits.
6461
6462 @item -mcmodel=embmedany
6463 @opindex mcmodel=embmedany
6464 Generate code for the Medium/Anywhere code model for embedded systems:
6465 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6466 (determined at link time).  Register %g4 points to the base of the
6467 data segment.  Pointers are still 64 bits.
6468 Programs are statically linked, PIC is not supported.
6469
6470 @item -mstack-bias
6471 @itemx -mno-stack-bias
6472 @opindex mstack-bias
6473 @opindex mno-stack-bias
6474 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6475 frame pointer if present, are offset by @minus{}2047 which must be added back
6476 when making stack frame references.
6477 Otherwise, assume no such offset is present.
6478 @end table
6479
6480 @node ARM Options
6481 @subsection ARM Options
6482 @cindex ARM options
6483
6484 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6485 architectures:
6486
6487 @table @gcctabopt
6488 @item -mapcs-frame
6489 @opindex mapcs-frame
6490 Generate a stack frame that is compliant with the ARM Procedure Call
6491 Standard for all functions, even if this is not strictly necessary for
6492 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6493 with this option will cause the stack frames not to be generated for
6494 leaf functions.  The default is @option{-mno-apcs-frame}.
6495
6496 @item -mapcs
6497 @opindex mapcs
6498 This is a synonym for @option{-mapcs-frame}.
6499
6500 @item -mapcs-26
6501 @opindex mapcs-26
6502 Generate code for a processor running with a 26-bit program counter,
6503 and conforming to the function calling standards for the APCS 26-bit
6504 option.  This option replaces the @option{-m2} and @option{-m3} options
6505 of previous releases of the compiler.
6506
6507 @item -mapcs-32
6508 @opindex mapcs-32
6509 Generate code for a processor running with a 32-bit program counter,
6510 and conforming to the function calling standards for the APCS 32-bit
6511 option.  This option replaces the @option{-m6} option of previous releases
6512 of the compiler.
6513
6514 @ignore
6515 @c not currently implemented
6516 @item -mapcs-stack-check
6517 @opindex mapcs-stack-check
6518 Generate code to check the amount of stack space available upon entry to
6519 every function (that actually uses some stack space).  If there is
6520 insufficient space available then either the function
6521 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6522 called, depending upon the amount of stack space required.  The run time
6523 system is required to provide these functions.  The default is
6524 @option{-mno-apcs-stack-check}, since this produces smaller code.
6525
6526 @c not currently implemented
6527 @item -mapcs-float
6528 @opindex mapcs-float
6529 Pass floating point arguments using the float point registers.  This is
6530 one of the variants of the APCS@.  This option is recommended if the
6531 target hardware has a floating point unit or if a lot of floating point
6532 arithmetic is going to be performed by the code.  The default is
6533 @option{-mno-apcs-float}, since integer only code is slightly increased in
6534 size if @option{-mapcs-float} is used.
6535
6536 @c not currently implemented
6537 @item -mapcs-reentrant
6538 @opindex mapcs-reentrant
6539 Generate reentrant, position independent code.  The default is
6540 @option{-mno-apcs-reentrant}.
6541 @end ignore
6542
6543 @item -mthumb-interwork
6544 @opindex mthumb-interwork
6545 Generate code which supports calling between the ARM and Thumb
6546 instruction sets.  Without this option the two instruction sets cannot
6547 be reliably used inside one program.  The default is
6548 @option{-mno-thumb-interwork}, since slightly larger code is generated
6549 when @option{-mthumb-interwork} is specified.
6550
6551 @item -mno-sched-prolog
6552 @opindex mno-sched-prolog
6553 Prevent the reordering of instructions in the function prolog, or the
6554 merging of those instruction with the instructions in the function's
6555 body.  This means that all functions will start with a recognizable set
6556 of instructions (or in fact one of a choice from a small set of
6557 different function prologues), and this information can be used to
6558 locate the start if functions inside an executable piece of code.  The
6559 default is @option{-msched-prolog}.
6560
6561 @item -mhard-float
6562 @opindex mhard-float
6563 Generate output containing floating point instructions.  This is the
6564 default.
6565
6566 @item -msoft-float
6567 @opindex msoft-float
6568 Generate output containing library calls for floating point.
6569 @strong{Warning:} the requisite libraries are not available for all ARM
6570 targets.  Normally the facilities of the machine's usual C compiler are
6571 used, but this cannot be done directly in cross-compilation.  You must make
6572 your own arrangements to provide suitable library functions for
6573 cross-compilation.
6574
6575 @option{-msoft-float} changes the calling convention in the output file;
6576 therefore, it is only useful if you compile @emph{all} of a program with
6577 this option.  In particular, you need to compile @file{libgcc.a}, the
6578 library that comes with GCC, with @option{-msoft-float} in order for
6579 this to work.
6580
6581 @item -mlittle-endian
6582 @opindex mlittle-endian
6583 Generate code for a processor running in little-endian mode.  This is
6584 the default for all standard configurations.
6585
6586 @item -mbig-endian
6587 @opindex mbig-endian
6588 Generate code for a processor running in big-endian mode; the default is
6589 to compile code for a little-endian processor.
6590
6591 @item -mwords-little-endian
6592 @opindex mwords-little-endian
6593 This option only applies when generating code for big-endian processors.
6594 Generate code for a little-endian word order but a big-endian byte
6595 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6596 option should only be used if you require compatibility with code for
6597 big-endian ARM processors generated by versions of the compiler prior to
6598 2.8.
6599
6600 @item -malignment-traps
6601 @opindex malignment-traps
6602 Generate code that will not trap if the MMU has alignment traps enabled.
6603 On ARM architectures prior to ARMv4, there were no instructions to
6604 access half-word objects stored in memory.  However, when reading from
6605 memory a feature of the ARM architecture allows a word load to be used,
6606 even if the address is unaligned, and the processor core will rotate the
6607 data as it is being loaded.  This option tells the compiler that such
6608 misaligned accesses will cause a MMU trap and that it should instead
6609 synthesize the access as a series of byte accesses.  The compiler can
6610 still use word accesses to load half-word data if it knows that the
6611 address is aligned to a word boundary.
6612
6613 This option is ignored when compiling for ARM architecture 4 or later,
6614 since these processors have instructions to directly access half-word
6615 objects in memory.
6616
6617 @item -mno-alignment-traps
6618 @opindex mno-alignment-traps
6619 Generate code that assumes that the MMU will not trap unaligned
6620 accesses.  This produces better code when the target instruction set
6621 does not have half-word memory operations (i.e.@: implementations prior to
6622 ARMv4).
6623
6624 Note that you cannot use this option to access unaligned word objects,
6625 since the processor will only fetch one 32-bit aligned object from
6626 memory.
6627
6628 The default setting for most targets is @option{-mno-alignment-traps}, since
6629 this produces better code when there are no half-word memory
6630 instructions available.
6631
6632 @item -mshort-load-bytes
6633 @itemx -mno-short-load-words
6634 @opindex mshort-load-bytes
6635 @opindex mno-short-load-words
6636 These are deprecated aliases for @option{-malignment-traps}.
6637
6638 @item -mno-short-load-bytes
6639 @itemx -mshort-load-words
6640 @opindex mno-short-load-bytes
6641 @opindex mshort-load-words
6642 This are deprecated aliases for @option{-mno-alignment-traps}.
6643
6644 @item -mcpu=@var{name}
6645 @opindex mcpu
6646 This specifies the name of the target ARM processor.  GCC uses this name
6647 to determine what kind of instructions it can emit when generating
6648 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6649 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6650 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6651 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6652 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6653 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6654 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6655 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6656 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6657 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6658 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6659 @samp{ep9312}.
6660
6661 @itemx -mtune=@var{name}
6662 @opindex mtune
6663 This option is very similar to the @option{-mcpu=} option, except that
6664 instead of specifying the actual target processor type, and hence
6665 restricting which instructions can be used, it specifies that GCC should
6666 tune the performance of the code as if the target were of the type
6667 specified in this option, but still choosing the instructions that it
6668 will generate based on the cpu specified by a @option{-mcpu=} option.
6669 For some ARM implementations better performance can be obtained by using
6670 this option.
6671
6672 @item -march=@var{name}
6673 @opindex march
6674 This specifies the name of the target ARM architecture.  GCC uses this
6675 name to determine what kind of instructions it can emit when generating
6676 assembly code.  This option can be used in conjunction with or instead
6677 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6678 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6679 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6j},
6680 @samp{iwmmxt}, @samp{ep9312}.
6681
6682 @item -mfpe=@var{number}
6683 @itemx -mfp=@var{number}
6684 @opindex mfpe
6685 @opindex mfp
6686 This specifies the version of the floating point emulation available on
6687 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6688 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6689
6690 @item -mstructure-size-boundary=@var{n}
6691 @opindex mstructure-size-boundary
6692 The size of all structures and unions will be rounded up to a multiple
6693 of the number of bits set by this option.  Permissible values are 8 and
6694 32.  The default value varies for different toolchains.  For the COFF
6695 targeted toolchain the default value is 8.  Specifying the larger number
6696 can produce faster, more efficient code, but can also increase the size
6697 of the program.  The two values are potentially incompatible.  Code
6698 compiled with one value cannot necessarily expect to work with code or
6699 libraries compiled with the other value, if they exchange information
6700 using structures or unions.
6701
6702 @item -mabort-on-noreturn
6703 @opindex mabort-on-noreturn
6704 Generate a call to the function @code{abort} at the end of a
6705 @code{noreturn} function.  It will be executed if the function tries to
6706 return.
6707
6708 @item -mlong-calls
6709 @itemx -mno-long-calls
6710 @opindex mlong-calls
6711 @opindex mno-long-calls
6712 Tells the compiler to perform function calls by first loading the
6713 address of the function into a register and then performing a subroutine
6714 call on this register.  This switch is needed if the target function
6715 will lie outside of the 64 megabyte addressing range of the offset based
6716 version of subroutine call instruction.
6717
6718 Even if this switch is enabled, not all function calls will be turned
6719 into long calls.  The heuristic is that static functions, functions
6720 which have the @samp{short-call} attribute, functions that are inside
6721 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6722 definitions have already been compiled within the current compilation
6723 unit, will not be turned into long calls.  The exception to this rule is
6724 that weak function definitions, functions with the @samp{long-call}
6725 attribute or the @samp{section} attribute, and functions that are within
6726 the scope of a @samp{#pragma long_calls} directive, will always be
6727 turned into long calls.
6728
6729 This feature is not enabled by default.  Specifying
6730 @option{-mno-long-calls} will restore the default behavior, as will
6731 placing the function calls within the scope of a @samp{#pragma
6732 long_calls_off} directive.  Note these switches have no effect on how
6733 the compiler generates code to handle function calls via function
6734 pointers.
6735
6736 @item -mnop-fun-dllimport
6737 @opindex mnop-fun-dllimport
6738 Disable support for the @code{dllimport} attribute.
6739
6740 @item -msingle-pic-base
6741 @opindex msingle-pic-base
6742 Treat the register used for PIC addressing as read-only, rather than
6743 loading it in the prologue for each function.  The run-time system is
6744 responsible for initializing this register with an appropriate value
6745 before execution begins.
6746
6747 @item -mpic-register=@var{reg}
6748 @opindex mpic-register
6749 Specify the register to be used for PIC addressing.  The default is R10
6750 unless stack-checking is enabled, when R9 is used.
6751
6752 @item -mcirrus-fix-invalid-insns
6753 @opindex mcirrus-fix-invalid-insns
6754 @opindex mno-cirrus-fix-invalid-insns
6755 Insert NOPs into the instruction stream to in order to work around
6756 problems with invalid Maverick instruction combinations.  This option
6757 is only valid if the @option{-mcpu=ep9312} option has been used to
6758 enable generation of instructions for the Cirrus Maverick floating
6759 point co-processor.  This option is not enabled by default, since the
6760 problem is only present in older Maverick implementations.  The default
6761 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6762 switch.
6763
6764 @item -mpoke-function-name
6765 @opindex mpoke-function-name
6766 Write the name of each function into the text section, directly
6767 preceding the function prologue.  The generated code is similar to this:
6768
6769 @smallexample
6770      t0
6771          .ascii "arm_poke_function_name", 0
6772          .align
6773      t1
6774          .word 0xff000000 + (t1 - t0)
6775      arm_poke_function_name
6776          mov     ip, sp
6777          stmfd   sp!, @{fp, ip, lr, pc@}
6778          sub     fp, ip, #4
6779 @end smallexample
6780
6781 When performing a stack backtrace, code can inspect the value of
6782 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6783 location @code{pc - 12} and the top 8 bits are set, then we know that
6784 there is a function name embedded immediately preceding this location
6785 and has length @code{((pc[-3]) & 0xff000000)}.
6786
6787 @item -mthumb
6788 @opindex mthumb
6789 Generate code for the 16-bit Thumb instruction set.  The default is to
6790 use the 32-bit ARM instruction set.
6791
6792 @item -mtpcs-frame
6793 @opindex mtpcs-frame
6794 Generate a stack frame that is compliant with the Thumb Procedure Call
6795 Standard for all non-leaf functions.  (A leaf function is one that does
6796 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6797
6798 @item -mtpcs-leaf-frame
6799 @opindex mtpcs-leaf-frame
6800 Generate a stack frame that is compliant with the Thumb Procedure Call
6801 Standard for all leaf functions.  (A leaf function is one that does
6802 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6803
6804 @item -mcallee-super-interworking
6805 @opindex mcallee-super-interworking
6806 Gives all externally visible functions in the file being compiled an ARM
6807 instruction set header which switches to Thumb mode before executing the
6808 rest of the function.  This allows these functions to be called from
6809 non-interworking code.
6810
6811 @item -mcaller-super-interworking
6812 @opindex mcaller-super-interworking
6813 Allows calls via function pointers (including virtual functions) to
6814 execute correctly regardless of whether the target code has been
6815 compiled for interworking or not.  There is a small overhead in the cost
6816 of executing a function pointer if this option is enabled.
6817
6818 @end table
6819
6820 @node MN10200 Options
6821 @subsection MN10200 Options
6822 @cindex MN10200 options
6823
6824 These @option{-m} options are defined for Matsushita MN10200 architectures:
6825 @table @gcctabopt
6826
6827 @item -mrelax
6828 @opindex mrelax
6829 Indicate to the linker that it should perform a relaxation optimization pass
6830 to shorten branches, calls and absolute memory addresses.  This option only
6831 has an effect when used on the command line for the final link step.
6832
6833 This option makes symbolic debugging impossible.
6834 @end table
6835
6836 @node MN10300 Options
6837 @subsection MN10300 Options
6838 @cindex MN10300 options
6839
6840 These @option{-m} options are defined for Matsushita MN10300 architectures:
6841
6842 @table @gcctabopt
6843 @item -mmult-bug
6844 @opindex mmult-bug
6845 Generate code to avoid bugs in the multiply instructions for the MN10300
6846 processors.  This is the default.
6847
6848 @item -mno-mult-bug
6849 @opindex mno-mult-bug
6850 Do not generate code to avoid bugs in the multiply instructions for the
6851 MN10300 processors.
6852
6853 @item -mam33
6854 @opindex mam33
6855 Generate code which uses features specific to the AM33 processor.
6856
6857 @item -mno-am33
6858 @opindex mno-am33
6859 Do not generate code which uses features specific to the AM33 processor.  This
6860 is the default.
6861
6862 @item -mno-crt0
6863 @opindex mno-crt0
6864 Do not link in the C run-time initialization object file.
6865
6866 @item -mrelax
6867 @opindex mrelax
6868 Indicate to the linker that it should perform a relaxation optimization pass
6869 to shorten branches, calls and absolute memory addresses.  This option only
6870 has an effect when used on the command line for the final link step.
6871
6872 This option makes symbolic debugging impossible.
6873 @end table
6874
6875
6876 @node M32R/D Options
6877 @subsection M32R/D Options
6878 @cindex M32R/D options
6879
6880 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6881
6882 @table @gcctabopt
6883 @item -m32rx
6884 @opindex m32rx
6885 Generate code for the M32R/X@.
6886
6887 @item -m32r
6888 @opindex m32r
6889 Generate code for the M32R@.  This is the default.
6890
6891 @item -mcode-model=small
6892 @opindex mcode-model=small
6893 Assume all objects live in the lower 16MB of memory (so that their addresses
6894 can be loaded with the @code{ld24} instruction), and assume all subroutines
6895 are reachable with the @code{bl} instruction.
6896 This is the default.
6897
6898 The addressability of a particular object can be set with the
6899 @code{model} attribute.
6900
6901 @item -mcode-model=medium
6902 @opindex mcode-model=medium
6903 Assume objects may be anywhere in the 32-bit address space (the compiler
6904 will generate @code{seth/add3} instructions to load their addresses), and
6905 assume all subroutines are reachable with the @code{bl} instruction.
6906
6907 @item -mcode-model=large
6908 @opindex mcode-model=large
6909 Assume objects may be anywhere in the 32-bit address space (the compiler
6910 will generate @code{seth/add3} instructions to load their addresses), and
6911 assume subroutines may not be reachable with the @code{bl} instruction
6912 (the compiler will generate the much slower @code{seth/add3/jl}
6913 instruction sequence).
6914
6915 @item -msdata=none
6916 @opindex msdata=none
6917 Disable use of the small data area.  Variables will be put into
6918 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6919 @code{section} attribute has been specified).
6920 This is the default.
6921
6922 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6923 Objects may be explicitly put in the small data area with the
6924 @code{section} attribute using one of these sections.
6925
6926 @item -msdata=sdata
6927 @opindex msdata=sdata
6928 Put small global and static data in the small data area, but do not
6929 generate special code to reference them.
6930
6931 @item -msdata=use
6932 @opindex msdata=use
6933 Put small global and static data in the small data area, and generate
6934 special instructions to reference them.
6935
6936 @item -G @var{num}
6937 @opindex G
6938 @cindex smaller data references
6939 Put global and static objects less than or equal to @var{num} bytes
6940 into the small data or bss sections instead of the normal data or bss
6941 sections.  The default value of @var{num} is 8.
6942 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6943 for this option to have any effect.
6944
6945 All modules should be compiled with the same @option{-G @var{num}} value.
6946 Compiling with different values of @var{num} may or may not work; if it
6947 doesn't the linker will give an error message---incorrect code will not be
6948 generated.
6949
6950 @end table
6951
6952 @node M88K Options
6953 @subsection M88K Options
6954 @cindex M88k options
6955
6956 These @samp{-m} options are defined for Motorola 88k architectures:
6957
6958 @table @gcctabopt
6959 @item -m88000
6960 @opindex m88000
6961 Generate code that works well on both the m88100 and the
6962 m88110.
6963
6964 @item -m88100
6965 @opindex m88100
6966 Generate code that works best for the m88100, but that also
6967 runs on the m88110.
6968
6969 @item -m88110
6970 @opindex m88110
6971 Generate code that works best for the m88110, and may not run
6972 on the m88100.
6973
6974 @item -mbig-pic
6975 @opindex mbig-pic
6976 Obsolete option to be removed from the next revision.
6977 Use @option{-fPIC}.
6978
6979 @item -midentify-revision
6980 @opindex midentify-revision
6981 @cindex identifying source, compiler (88k)
6982 Include an @code{ident} directive in the assembler output recording the
6983 source file name, compiler name and version, timestamp, and compilation
6984 flags used.
6985
6986 @item -mno-underscores
6987 @opindex mno-underscores
6988 @cindex underscores, avoiding (88k)
6989 In assembler output, emit symbol names without adding an underscore
6990 character at the beginning of each name.  The default is to use an
6991 underscore as prefix on each name.
6992
6993 @item -mocs-debug-info
6994 @itemx -mno-ocs-debug-info
6995 @opindex mocs-debug-info
6996 @opindex mno-ocs-debug-info
6997 @cindex OCS (88k)
6998 @cindex debugging, 88k OCS
6999 Include (or omit) additional debugging information (about registers used
7000 in each stack frame) as specified in the 88open Object Compatibility
7001 Standard, ``OCS''@.  This extra information allows debugging of code that
7002 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
7003 SVr3.2 is to include this information; other 88k configurations omit this
7004 information by default.
7005
7006 @item -mocs-frame-position
7007 @opindex mocs-frame-position
7008 @cindex register positions in frame (88k)
7009 When emitting COFF debugging information for automatic variables and
7010 parameters stored on the stack, use the offset from the canonical frame
7011 address, which is the stack pointer (register 31) on entry to the
7012 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
7013 @option{-mocs-frame-position}; other 88k configurations have the default
7014 @option{-mno-ocs-frame-position}.
7015
7016 @item -mno-ocs-frame-position
7017 @opindex mno-ocs-frame-position
7018 @cindex register positions in frame (88k)
7019 When emitting COFF debugging information for automatic variables and
7020 parameters stored on the stack, use the offset from the frame pointer
7021 register (register 30).  When this option is in effect, the frame
7022 pointer is not eliminated when debugging information is selected by the
7023 -g switch.
7024
7025 @item -moptimize-arg-area
7026 @opindex moptimize-arg-area
7027 @cindex arguments in frame (88k)
7028 Save space by reorganizing the stack frame.  This option generates code
7029 that does not agree with the 88open specifications, but uses less
7030 memory.
7031
7032 @itemx -mno-optimize-arg-area
7033 @opindex mno-optimize-arg-area
7034 Do not reorganize the stack frame to save space.  This is the default.
7035 The generated conforms to the specification, but uses more memory.
7036
7037 @item -mshort-data-@var{num}
7038 @opindex mshort-data
7039 @cindex smaller data references (88k)
7040 @cindex r0-relative references (88k)
7041 Generate smaller data references by making them relative to @code{r0},
7042 which allows loading a value using a single instruction (rather than the
7043 usual two).  You control which data references are affected by
7044 specifying @var{num} with this option.  For example, if you specify
7045 @option{-mshort-data-512}, then the data references affected are those
7046 involving displacements of less than 512 bytes.
7047 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
7048 than 64k.
7049
7050 @item -mserialize-volatile
7051 @opindex mserialize-volatile
7052 @itemx -mno-serialize-volatile
7053 @opindex mno-serialize-volatile
7054 @cindex sequential consistency on 88k
7055 Do, or don't, generate code to guarantee sequential consistency
7056 of volatile memory references.  By default, consistency is
7057 guaranteed.
7058
7059 The order of memory references made by the MC88110 processor does
7060 not always match the order of the instructions requesting those
7061 references.  In particular, a load instruction may execute before
7062 a preceding store instruction.  Such reordering violates
7063 sequential consistency of volatile memory references, when there
7064 are multiple processors.   When consistency must be guaranteed,
7065 GCC generates special instructions, as needed, to force
7066 execution in the proper order.
7067
7068 The MC88100 processor does not reorder memory references and so
7069 always provides sequential consistency.  However, by default, GCC
7070 generates the special instructions to guarantee consistency
7071 even when you use @option{-m88100}, so that the code may be run on an
7072 MC88110 processor.  If you intend to run your code only on the
7073 MC88100 processor, you may use @option{-mno-serialize-volatile}.
7074
7075 The extra code generated to guarantee consistency may affect the
7076 performance of your application.  If you know that you can safely
7077 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
7078
7079 @item -msvr4
7080 @itemx -msvr3
7081 @opindex msvr4
7082 @opindex msvr3
7083 @cindex assembler syntax, 88k
7084 @cindex SVr4
7085 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
7086 related to System V release 4 (SVr4).  This controls the following:
7087
7088 @enumerate
7089 @item
7090 Which variant of the assembler syntax to emit.
7091 @item
7092 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
7093 that is used on System V release 4.
7094 @item
7095 @option{-msvr4} makes GCC issue additional declaration directives used in
7096 SVr4.
7097 @end enumerate
7098
7099 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
7100 @option{-msvr3} is the default for all other m88k configurations.
7101
7102 @item -mversion-03.00
7103 @opindex mversion-03.00
7104 This option is obsolete, and is ignored.
7105 @c ??? which asm syntax better for GAS?  option there too?
7106
7107 @item -mno-check-zero-division
7108 @itemx -mcheck-zero-division
7109 @opindex mno-check-zero-division
7110 @opindex mcheck-zero-division
7111 @cindex zero division on 88k
7112 Do, or don't, generate code to guarantee that integer division by
7113 zero will be detected.  By default, detection is guaranteed.
7114
7115 Some models of the MC88100 processor fail to trap upon integer
7116 division by zero under certain conditions.  By default, when
7117 compiling code that might be run on such a processor, GCC
7118 generates code that explicitly checks for zero-valued divisors
7119 and traps with exception number 503 when one is detected.  Use of
7120 @option{-mno-check-zero-division} suppresses such checking for code
7121 generated to run on an MC88100 processor.
7122
7123 GCC assumes that the MC88110 processor correctly detects all instances
7124 of integer division by zero.  When @option{-m88110} is specified, no
7125 explicit checks for zero-valued divisors are generated, and both
7126 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
7127 ignored.
7128
7129 @item -muse-div-instruction
7130 @opindex muse-div-instruction
7131 @cindex divide instruction, 88k
7132 Use the div instruction for signed integer division on the
7133 MC88100 processor.  By default, the div instruction is not used.
7134
7135 On the MC88100 processor the signed integer division instruction
7136 div) traps to the operating system on a negative operand.  The
7137 operating system transparently completes the operation, but at a
7138 large cost in execution time.  By default, when compiling code
7139 that might be run on an MC88100 processor, GCC emulates signed
7140 integer division using the unsigned integer division instruction
7141 divu), thereby avoiding the large penalty of a trap to the
7142 operating system.  Such emulation has its own, smaller, execution
7143 cost in both time and space.  To the extent that your code's
7144 important signed integer division operations are performed on two
7145 nonnegative operands, it may be desirable to use the div
7146 instruction directly.
7147
7148 On the MC88110 processor the div instruction (also known as the
7149 divs instruction) processes negative operands without trapping to
7150 the operating system.  When @option{-m88110} is specified,
7151 @option{-muse-div-instruction} is ignored, and the div instruction is used
7152 for signed integer division.
7153
7154 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
7155 particular, the behavior of such a division with and without
7156 @option{-muse-div-instruction} may differ.
7157
7158 @item -mtrap-large-shift
7159 @itemx -mhandle-large-shift
7160 @opindex mtrap-large-shift
7161 @opindex mhandle-large-shift
7162 @cindex bit shift overflow (88k)
7163 @cindex large bit shifts (88k)
7164 Include code to detect bit-shifts of more than 31 bits; respectively,
7165 trap such shifts or emit code to handle them properly.  By default GCC
7166 makes no special provision for large bit shifts.
7167
7168 @item -mwarn-passed-structs
7169 @opindex mwarn-passed-structs
7170 @cindex structure passing (88k)
7171 Warn when a function passes a struct as an argument or result.
7172 Structure-passing conventions have changed during the evolution of the C
7173 language, and are often the source of portability problems.  By default,
7174 GCC issues no such warning.
7175 @end table
7176
7177 @c break page here to avoid unsightly interparagraph stretch.
7178 @c -zw, 2001-8-17
7179 @page
7180
7181 @node RS/6000 and PowerPC Options
7182 @subsection IBM RS/6000 and PowerPC Options
7183 @cindex RS/6000 and PowerPC Options
7184 @cindex IBM RS/6000 and PowerPC Options
7185
7186 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
7187 @table @gcctabopt
7188 @item -mpower
7189 @itemx -mno-power
7190 @itemx -mpower2
7191 @itemx -mno-power2
7192 @itemx -mpowerpc
7193 @itemx -mno-powerpc
7194 @itemx -mpowerpc-gpopt
7195 @itemx -mno-powerpc-gpopt
7196 @itemx -mpowerpc-gfxopt
7197 @itemx -mno-powerpc-gfxopt
7198 @itemx -mpowerpc64
7199 @itemx -mno-powerpc64
7200 @opindex mpower
7201 @opindex mno-power
7202 @opindex mpower2
7203 @opindex mno-power2
7204 @opindex mpowerpc
7205 @opindex mno-powerpc
7206 @opindex mpowerpc-gpopt
7207 @opindex mno-powerpc-gpopt
7208 @opindex mpowerpc-gfxopt
7209 @opindex mno-powerpc-gfxopt
7210 @opindex mpowerpc64
7211 @opindex mno-powerpc64
7212 GCC supports two related instruction set architectures for the
7213 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
7214 instructions supported by the @samp{rios} chip set used in the original
7215 RS/6000 systems and the @dfn{PowerPC} instruction set is the
7216 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
7217 the IBM 4xx microprocessors.
7218
7219 Neither architecture is a subset of the other.  However there is a
7220 large common subset of instructions supported by both.  An MQ
7221 register is included in processors supporting the POWER architecture.
7222
7223 You use these options to specify which instructions are available on the
7224 processor you are using.  The default value of these options is
7225 determined when configuring GCC@.  Specifying the
7226 @option{-mcpu=@var{cpu_type}} overrides the specification of these
7227 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
7228 rather than the options listed above.
7229
7230 The @option{-mpower} option allows GCC to generate instructions that
7231 are found only in the POWER architecture and to use the MQ register.
7232 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
7233 to generate instructions that are present in the POWER2 architecture but
7234 not the original POWER architecture.
7235
7236 The @option{-mpowerpc} option allows GCC to generate instructions that
7237 are found only in the 32-bit subset of the PowerPC architecture.
7238 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
7239 GCC to use the optional PowerPC architecture instructions in the
7240 General Purpose group, including floating-point square root.  Specifying
7241 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
7242 use the optional PowerPC architecture instructions in the Graphics
7243 group, including floating-point select.
7244
7245 The @option{-mpowerpc64} option allows GCC to generate the additional
7246 64-bit instructions that are found in the full PowerPC64 architecture
7247 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
7248 @option{-mno-powerpc64}.
7249
7250 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
7251 will use only the instructions in the common subset of both
7252 architectures plus some special AIX common-mode calls, and will not use
7253 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
7254 permits GCC to use any instruction from either architecture and to
7255 allow use of the MQ register; specify this for the Motorola MPC601.
7256
7257 @item -mnew-mnemonics
7258 @itemx -mold-mnemonics
7259 @opindex mnew-mnemonics
7260 @opindex mold-mnemonics
7261 Select which mnemonics to use in the generated assembler code.  With
7262 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
7263 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
7264 assembler mnemonics defined for the POWER architecture.  Instructions
7265 defined in only one architecture have only one mnemonic; GCC uses that
7266 mnemonic irrespective of which of these options is specified.
7267
7268 GCC defaults to the mnemonics appropriate for the architecture in
7269 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
7270 value of these option.  Unless you are building a cross-compiler, you
7271 should normally not specify either @option{-mnew-mnemonics} or
7272 @option{-mold-mnemonics}, but should instead accept the default.
7273
7274 @item -mcpu=@var{cpu_type}
7275 @opindex mcpu
7276 Set architecture type, register usage, choice of mnemonics, and
7277 instruction scheduling parameters for machine type @var{cpu_type}.
7278 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
7279 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
7280 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
7281 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{G4}, 
7282 @samp{750}, @samp{G3},  @samp{power}, @samp{power2}, @samp{powerpc}, 
7283 @samp{403}, @samp{505}, @samp{801}, @samp{821}, @samp{823}, @samp{860},
7284 @samp{970}, @samp{G5} and @samp{common}.
7285
7286 @option{-mcpu=common} selects a completely generic processor.  Code
7287 generated under this option will run on any POWER or PowerPC processor.
7288 GCC will use only the instructions in the common subset of both
7289 architectures, and will not use the MQ register.  GCC assumes a generic
7290 processor model for scheduling purposes.
7291
7292 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
7293 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
7294 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
7295 types, with an appropriate, generic processor model assumed for
7296 scheduling purposes.
7297
7298 The other options specify a specific processor.  Code generated under
7299 those options will run best on that processor, and may not run at all on
7300 others.
7301
7302 The @option{-mcpu} options automatically enable or disable other
7303 @option{-m} options as follows:
7304
7305 @table @samp
7306 @item common
7307 @option{-mno-power}, @option{-mno-powerpc}
7308
7309 @item power
7310 @itemx power2
7311 @itemx rios1
7312 @itemx rios2
7313 @itemx rsc
7314 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
7315
7316 @item powerpc
7317 @itemx rs64a
7318 @itemx 602
7319 @itemx 603
7320 @itemx 603e
7321 @itemx 604
7322 @itemx 620
7323 @itemx 630
7324 @itemx 740
7325 @itemx 7400
7326 @itemx 7450
7327 @itemx G4
7328 @itemx 750
7329 @itemx G3
7330 @itemx 505
7331 @itemx 970
7332 @itemx G5
7333 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7334
7335 @item 601
7336 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
7337
7338 @item 403
7339 @itemx 821
7340 @itemx 860
7341 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
7342 @end table
7343
7344 @item -mtune=@var{cpu_type}
7345 @opindex mtune
7346 Set the instruction scheduling parameters for machine type
7347 @var{cpu_type}, but do not set the architecture type, register usage, or
7348 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
7349 values for @var{cpu_type} are used for @option{-mtune} as for
7350 @option{-mcpu}.  If both are specified, the code generated will use the
7351 architecture, registers, and mnemonics set by @option{-mcpu}, but the
7352 scheduling parameters set by @option{-mtune}.
7353
7354 @item -maltivec
7355 @itemx -mno-altivec
7356 @opindex maltivec
7357 @opindex mno-altivec
7358 These switches enable or disable the use of built-in functions that
7359 allow access to the AltiVec instruction set.  You may also need to set
7360 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
7361 enhancements.
7362
7363 @item -mabi=spe
7364 @opindex mabi=spe
7365 Extend the current ABI with SPE ABI extensions.  This does not change
7366 the default ABI, instead it adds the SPE ABI extensions to the current
7367 ABI@.
7368
7369 @item -mabi=no-spe
7370 @opindex mabi=no-spe
7371 Disable Booke SPE ABI extensions for the current ABI.
7372
7373 @item -misel=@var{yes/no}
7374 @itemx -misel
7375 @opindex misel
7376 This switch enables or disables the generation of ISEL instructions.
7377
7378 @item -mspe=@var{yes/no}
7379 @itemx -mspe
7380 @opindex mspe
7381 This switch enables or disables the generation of SPE simd
7382 instructions.
7383
7384 @item -mfloat-gprs=@var{yes/no}
7385 @itemx -mfloat-gprs
7386 @opindex mfloat-gprs
7387 This switch enables or disables the generation of floating point
7388 operations on the general purpose registers for architectures that
7389 support it.  This option is currently only available on the MPC8540.
7390
7391 @item -mfull-toc
7392 @itemx -mno-fp-in-toc
7393 @itemx -mno-sum-in-toc
7394 @itemx -mminimal-toc
7395 @opindex mfull-toc
7396 @opindex mno-fp-in-toc
7397 @opindex mno-sum-in-toc
7398 @opindex mminimal-toc
7399 Modify generation of the TOC (Table Of Contents), which is created for
7400 every executable file.  The @option{-mfull-toc} option is selected by
7401 default.  In that case, GCC will allocate at least one TOC entry for
7402 each unique non-automatic variable reference in your program.  GCC
7403 will also place floating-point constants in the TOC@.  However, only
7404 16,384 entries are available in the TOC@.
7405
7406 If you receive a linker error message that saying you have overflowed
7407 the available TOC space, you can reduce the amount of TOC space used
7408 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7409 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7410 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7411 generate code to calculate the sum of an address and a constant at
7412 run-time instead of putting that sum into the TOC@.  You may specify one
7413 or both of these options.  Each causes GCC to produce very slightly
7414 slower and larger code at the expense of conserving TOC space.
7415
7416 If you still run out of space in the TOC even when you specify both of
7417 these options, specify @option{-mminimal-toc} instead.  This option causes
7418 GCC to make only one TOC entry for every file.  When you specify this
7419 option, GCC will produce code that is slower and larger but which
7420 uses extremely little TOC space.  You may wish to use this option
7421 only on files that contain less frequently executed code.
7422
7423 @item -maix64
7424 @itemx -maix32
7425 @opindex maix64
7426 @opindex maix32
7427 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7428 @code{long} type, and the infrastructure needed to support them.
7429 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7430 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7431 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7432
7433 @item -mxl-call
7434 @itemx -mno-xl-call
7435 @opindex mxl-call
7436 @opindex mno-xl-call
7437 On AIX, pass floating-point arguments to prototyped functions beyond the
7438 register save area (RSA) on the stack in addition to argument FPRs.  The
7439 AIX calling convention was extended but not initially documented to
7440 handle an obscure K&R C case of calling a function that takes the
7441 address of its arguments with fewer arguments than declared.  AIX XL
7442 compilers access floating point arguments which do not fit in the
7443 RSA from the stack when a subroutine is compiled without
7444 optimization.  Because always storing floating-point arguments on the
7445 stack is inefficient and rarely needed, this option is not enabled by
7446 default and only is necessary when calling subroutines compiled by AIX
7447 XL compilers without optimization.
7448
7449 @item -mpe
7450 @opindex mpe
7451 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7452 application written to use message passing with special startup code to
7453 enable the application to run.  The system must have PE installed in the
7454 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7455 must be overridden with the @option{-specs=} option to specify the
7456 appropriate directory location.  The Parallel Environment does not
7457 support threads, so the @option{-mpe} option and the @option{-pthread}
7458 option are incompatible.
7459
7460 @item -malign-natural
7461 @itemx -malign-power
7462 @opindex malign-natural
7463 @opindex malign-power
7464 On AIX, Darwin, and 64-bit PowerPC Linux, the option
7465 @option{-malign-natural} overrides the ABI-defined alignment of larger
7466 types, such as floating-point doubles, on their natural size-based boundary.
7467 The option @option{-malign-power} instructs GCC to follow the ABI-specified
7468 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
7469
7470 @item -msoft-float
7471 @itemx -mhard-float
7472 @opindex msoft-float
7473 @opindex mhard-float
7474 Generate code that does not use (uses) the floating-point register set.
7475 Software floating point emulation is provided if you use the
7476 @option{-msoft-float} option, and pass the option to GCC when linking.
7477
7478 @item -mmultiple
7479 @itemx -mno-multiple
7480 @opindex mmultiple
7481 @opindex mno-multiple
7482 Generate code that uses (does not use) the load multiple word
7483 instructions and the store multiple word instructions.  These
7484 instructions are generated by default on POWER systems, and not
7485 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7486 endian PowerPC systems, since those instructions do not work when the
7487 processor is in little endian mode.  The exceptions are PPC740 and
7488 PPC750 which permit the instructions usage in little endian mode.
7489
7490 @item -mstring
7491 @itemx -mno-string
7492 @opindex mstring
7493 @opindex mno-string
7494 Generate code that uses (does not use) the load string instructions
7495 and the store string word instructions to save multiple registers and
7496 do small block moves.  These instructions are generated by default on
7497 POWER systems, and not generated on PowerPC systems.  Do not use
7498 @option{-mstring} on little endian PowerPC systems, since those
7499 instructions do not work when the processor is in little endian mode.
7500 The exceptions are PPC740 and PPC750 which permit the instructions
7501 usage in little endian mode.
7502
7503 @item -mupdate
7504 @itemx -mno-update
7505 @opindex mupdate
7506 @opindex mno-update
7507 Generate code that uses (does not use) the load or store instructions
7508 that update the base register to the address of the calculated memory
7509 location.  These instructions are generated by default.  If you use
7510 @option{-mno-update}, there is a small window between the time that the
7511 stack pointer is updated and the address of the previous frame is
7512 stored, which means code that walks the stack frame across interrupts or
7513 signals may get corrupted data.
7514
7515 @item -mfused-madd
7516 @itemx -mno-fused-madd
7517 @opindex mfused-madd
7518 @opindex mno-fused-madd
7519 Generate code that uses (does not use) the floating point multiply and
7520 accumulate instructions.  These instructions are generated by default if
7521 hardware floating is used.
7522
7523 @item -mno-bit-align
7524 @itemx -mbit-align
7525 @opindex mno-bit-align
7526 @opindex mbit-align
7527 On System V.4 and embedded PowerPC systems do not (do) force structures
7528 and unions that contain bit-fields to be aligned to the base type of the
7529 bit-field.
7530
7531 For example, by default a structure containing nothing but 8
7532 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7533 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7534 the structure would be aligned to a 1 byte boundary and be one byte in
7535 size.
7536
7537 @item -mno-strict-align
7538 @itemx -mstrict-align
7539 @opindex mno-strict-align
7540 @opindex mstrict-align
7541 On System V.4 and embedded PowerPC systems do not (do) assume that
7542 unaligned memory references will be handled by the system.
7543
7544 @item -mrelocatable
7545 @itemx -mno-relocatable
7546 @opindex mrelocatable
7547 @opindex mno-relocatable
7548 On embedded PowerPC systems generate code that allows (does not allow)
7549 the program to be relocated to a different address at runtime.  If you
7550 use @option{-mrelocatable} on any module, all objects linked together must
7551 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7552
7553 @item -mrelocatable-lib
7554 @itemx -mno-relocatable-lib
7555 @opindex mrelocatable-lib
7556 @opindex mno-relocatable-lib
7557 On embedded PowerPC systems generate code that allows (does not allow)
7558 the program to be relocated to a different address at runtime.  Modules
7559 compiled with @option{-mrelocatable-lib} can be linked with either modules
7560 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7561 with modules compiled with the @option{-mrelocatable} options.
7562
7563 @item -mno-toc
7564 @itemx -mtoc
7565 @opindex mno-toc
7566 @opindex mtoc
7567 On System V.4 and embedded PowerPC systems do not (do) assume that
7568 register 2 contains a pointer to a global area pointing to the addresses
7569 used in the program.
7570
7571 @item -mlittle
7572 @itemx -mlittle-endian
7573 @opindex mlittle
7574 @opindex mlittle-endian
7575 On System V.4 and embedded PowerPC systems compile code for the
7576 processor in little endian mode.  The @option{-mlittle-endian} option is
7577 the same as @option{-mlittle}.
7578
7579 @item -mbig
7580 @itemx -mbig-endian
7581 @opindex mbig
7582 @opindex mbig-endian
7583 On System V.4 and embedded PowerPC systems compile code for the
7584 processor in big endian mode.  The @option{-mbig-endian} option is
7585 the same as @option{-mbig}.
7586
7587 @item -mdynamic-no-pic
7588 @opindex mdynamic-no-pic
7589 On Darwin and Mac OS X systems, compile code so that it is not
7590 relocatable, but that its external references are relocatable.  The
7591 resulting code is suitable for applications, but not shared
7592 libraries.
7593
7594 @item -mprioritize-restricted-insns=@var{priority}
7595 @opindex mprioritize-restricted-insns
7596 This option controls the priority that is assigned to 
7597 dispatch-slot restricted instructions during the second scheduling 
7598 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign 
7599 @var{no/highest/second-highest} priority to dispatch slot restricted 
7600 instructions.
7601
7602 @item -msched-costly-dep=@var{dependence_type}
7603 @opindex msched-costly-dep
7604 This option controls which dependences are considered costly
7605 by the target during instruction scheduling.  The argument
7606 @var{dependence_type} takes one of the following values:
7607 @var{no}: no dependence is costly, 
7608 @var{all}: all dependences are costly, 
7609 @var{true_store_to_load}: a true dependence from store to load is costly,
7610 @var{store_to_load}: any dependence from store to load is costly,
7611 @var{number}: any dependence which latency >= @var{number} is costly.
7612  
7613 @item -minsert-sched-nops=@var{scheme}
7614 @opindex minsert-sched-nops
7615 This option controls which nop insertion scheme will be used during
7616 the second scheduling pass. The argument @var{scheme} takes one of the
7617 following values:
7618 @var{no}: Don't insert nops.
7619 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
7620 according to the scheduler's grouping.
7621 @var{regroup_exact}: Insert nops to force costly dependent insns into
7622 separate groups.  Insert exactly as many nops as needed to force an insn
7623 to a new group, according to the estimatied processor grouping.
7624 @var{number}: Insert nops to force costly dependent insns into 
7625 separate groups.  Insert @var{number} nops to force an insn to a new group.
7626
7627 @item -mcall-sysv
7628 @opindex mcall-sysv
7629 On System V.4 and embedded PowerPC systems compile code using calling
7630 conventions that adheres to the March 1995 draft of the System V
7631 Application Binary Interface, PowerPC processor supplement.  This is the
7632 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7633
7634 @item -mcall-sysv-eabi
7635 @opindex mcall-sysv-eabi
7636 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7637
7638 @item -mcall-sysv-noeabi
7639 @opindex mcall-sysv-noeabi
7640 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7641
7642 @item -mcall-solaris
7643 @opindex mcall-solaris
7644 On System V.4 and embedded PowerPC systems compile code for the Solaris
7645 operating system.
7646
7647 @item -mcall-linux
7648 @opindex mcall-linux
7649 On System V.4 and embedded PowerPC systems compile code for the
7650 Linux-based GNU system.
7651
7652 @item -mcall-gnu
7653 @opindex mcall-gnu
7654 On System V.4 and embedded PowerPC systems compile code for the
7655 Hurd-based GNU system.
7656
7657 @item -mcall-netbsd
7658 @opindex mcall-netbsd
7659 On System V.4 and embedded PowerPC systems compile code for the
7660 NetBSD operating system.
7661
7662 @item -maix-struct-return
7663 @opindex maix-struct-return
7664 Return all structures in memory (as specified by the AIX ABI)@.
7665
7666 @item -msvr4-struct-return
7667 @opindex msvr4-struct-return
7668 Return structures smaller than 8 bytes in registers (as specified by the
7669 SVR4 ABI)@.
7670
7671 @item -mabi=altivec
7672 @opindex mabi=altivec
7673 Extend the current ABI with AltiVec ABI extensions.  This does not
7674 change the default ABI, instead it adds the AltiVec ABI extensions to
7675 the current ABI@.
7676
7677 @item -mabi=no-altivec
7678 @opindex mabi=no-altivec
7679 Disable AltiVec ABI extensions for the current ABI.
7680
7681 @item -mprototype
7682 @itemx -mno-prototype
7683 @opindex mprototype
7684 @opindex mno-prototype
7685 On System V.4 and embedded PowerPC systems assume that all calls to
7686 variable argument functions are properly prototyped.  Otherwise, the
7687 compiler must insert an instruction before every non prototyped call to
7688 set or clear bit 6 of the condition code register (@var{CR}) to
7689 indicate whether floating point values were passed in the floating point
7690 registers in case the function takes a variable arguments.  With
7691 @option{-mprototype}, only calls to prototyped variable argument functions
7692 will set or clear the bit.
7693
7694 @item -msim
7695 @opindex msim
7696 On embedded PowerPC systems, assume that the startup module is called
7697 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7698 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7699 configurations.
7700
7701 @item -mmvme
7702 @opindex mmvme
7703 On embedded PowerPC systems, assume that the startup module is called
7704 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7705 @file{libc.a}.
7706
7707 @item -mads
7708 @opindex mads
7709 On embedded PowerPC systems, assume that the startup module is called
7710 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7711 @file{libc.a}.
7712
7713 @item -myellowknife
7714 @opindex myellowknife
7715 On embedded PowerPC systems, assume that the startup module is called
7716 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7717 @file{libc.a}.
7718
7719 @item -mvxworks
7720 @opindex mvxworks
7721 On System V.4 and embedded PowerPC systems, specify that you are
7722 compiling for a VxWorks system.
7723
7724 @item -mwindiss
7725 @opindex mwindiss
7726 Specify that you are compiling for the WindISS simulation environment.
7727
7728 @item -memb
7729 @opindex memb
7730 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7731 header to indicate that @samp{eabi} extended relocations are used.
7732
7733 @item -meabi
7734 @itemx -mno-eabi
7735 @opindex meabi
7736 @opindex mno-eabi
7737 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7738 Embedded Applications Binary Interface (eabi) which is a set of
7739 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7740 means that the stack is aligned to an 8 byte boundary, a function
7741 @code{__eabi} is called to from @code{main} to set up the eabi
7742 environment, and the @option{-msdata} option can use both @code{r2} and
7743 @code{r13} to point to two separate small data areas.  Selecting
7744 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7745 do not call an initialization function from @code{main}, and the
7746 @option{-msdata} option will only use @code{r13} to point to a single
7747 small data area.  The @option{-meabi} option is on by default if you
7748 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7749
7750 @item -msdata=eabi
7751 @opindex msdata=eabi
7752 On System V.4 and embedded PowerPC systems, put small initialized
7753 @code{const} global and static data in the @samp{.sdata2} section, which
7754 is pointed to by register @code{r2}.  Put small initialized
7755 non-@code{const} global and static data in the @samp{.sdata} section,
7756 which is pointed to by register @code{r13}.  Put small uninitialized
7757 global and static data in the @samp{.sbss} section, which is adjacent to
7758 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7759 incompatible with the @option{-mrelocatable} option.  The
7760 @option{-msdata=eabi} option also sets the @option{-memb} option.
7761
7762 @item -msdata=sysv
7763 @opindex msdata=sysv
7764 On System V.4 and embedded PowerPC systems, put small global and static
7765 data in the @samp{.sdata} section, which is pointed to by register
7766 @code{r13}.  Put small uninitialized global and static data in the
7767 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7768 The @option{-msdata=sysv} option is incompatible with the
7769 @option{-mrelocatable} option.
7770
7771 @item -msdata=default
7772 @itemx -msdata
7773 @opindex msdata=default
7774 @opindex msdata
7775 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7776 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7777 same as @option{-msdata=sysv}.
7778
7779 @item -msdata-data
7780 @opindex msdata-data
7781 On System V.4 and embedded PowerPC systems, put small global and static
7782 data in the @samp{.sdata} section.  Put small uninitialized global and
7783 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7784 to address small data however.  This is the default behavior unless
7785 other @option{-msdata} options are used.
7786
7787 @item -msdata=none
7788 @itemx -mno-sdata
7789 @opindex msdata=none
7790 @opindex mno-sdata
7791 On embedded PowerPC systems, put all initialized global and static data
7792 in the @samp{.data} section, and all uninitialized data in the
7793 @samp{.bss} section.
7794
7795 @item -G @var{num}
7796 @opindex G
7797 @cindex smaller data references (PowerPC)
7798 @cindex .sdata/.sdata2 references (PowerPC)
7799 On embedded PowerPC systems, put global and static items less than or
7800 equal to @var{num} bytes into the small data or bss sections instead of
7801 the normal data or bss section.  By default, @var{num} is 8.  The
7802 @option{-G @var{num}} switch is also passed to the linker.
7803 All modules should be compiled with the same @option{-G @var{num}} value.
7804
7805 @item -mregnames
7806 @itemx -mno-regnames
7807 @opindex mregnames
7808 @opindex mno-regnames
7809 On System V.4 and embedded PowerPC systems do (do not) emit register
7810 names in the assembly language output using symbolic forms.
7811
7812 @item -mlongcall
7813 @itemx -mno-longcall
7814 @opindex mlongcall
7815 @opindex mno-longcall
7816 Default to making all function calls via pointers, so that functions
7817 which reside further than 64 megabytes (67,108,864 bytes) from the
7818 current location can be called.  This setting can be overridden by the
7819 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7820
7821 Some linkers are capable of detecting out-of-range calls and generating
7822 glue code on the fly.  On these systems, long calls are unnecessary and
7823 generate slower code.  As of this writing, the AIX linker can do this,
7824 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7825 to the GNU linker for 32-bit PowerPC systems as well.
7826
7827 In the future, we may cause GCC to ignore all longcall specifications
7828 when the linker is known to generate glue.
7829
7830 @item -pthread
7831 @opindex pthread
7832 Adds support for multithreading with the @dfn{pthreads} library.
7833 This option sets flags for both the preprocessor and linker.
7834
7835 @end table
7836
7837 @node Darwin Options
7838 @subsection Darwin Options
7839 @cindex Darwin options
7840
7841 These options are defined for all architectures running the Darwin operating
7842 system.  They are useful for compatibility with other Mac OS compilers.
7843
7844 @table @gcctabopt
7845 @item -all_load    
7846 @opindex all_load   
7847 Loads all members of static archive libraries.
7848 See man ld(1) for more information.
7849
7850 @item -arch_errors_fatal
7851 @opindex arch_errors_fatal
7852 Cause the errors having to do with files that have the wrong architecture
7853 to be fatal.
7854
7855 @item -bind_at_load
7856 @opindex bind_at_load
7857 Causes the output file to be marked such that the dynamic linker will
7858 bind all undefined references when the file is loaded or launched.
7859
7860 @item -bundle     
7861 @opindex bundle
7862 Produce a Mach-o bundle format file.
7863 See man ld(1) for more information.
7864
7865 @item -bundle_loader @var{executable}
7866 @opindex bundle_loader
7867 This specifies the @var{executable} that will be loading the build
7868 output file being linked. See man ld(1) for more information.
7869
7870 @item -allowable_client  @var{client_name}
7871 @item -arch_only
7872
7873 @item -client_name       
7874 @item -compatibility_version
7875 @item -current_version    
7876 @item -dependency-file
7877 @item -dylib_file    
7878 @item -dylinker_install_name
7879 @item -dynamic
7880 @item -dynamiclib   
7881 @item -exported_symbols_list  
7882 @item -filelist
7883 @item -flat_namespace   
7884 @item -force_cpusubtype_ALL
7885 @item -force_flat_namespace   
7886 @item -headerpad_max_install_names
7887 @item -image_base  
7888 @item -init
7889 @item -install_name
7890 @item -keep_private_externs
7891 @item -multi_module
7892 @item -multiply_defined      
7893 @item -multiply_defined_unused      
7894 @item -noall_load  
7895 @item -nofixprebinding
7896 @item -nomultidefs
7897 @item -noprebind     
7898 @item -noseglinkedit
7899 @item -pagezero_size    
7900 @item -prebind
7901 @item -prebind_all_twolevel_modules
7902 @item -private_bundle
7903 @item -read_only_relocs
7904 @item -sectalign  
7905 @item -sectobjectsymbols    
7906 @item -whyload
7907 @item -seg1addr 
7908 @item -sectcreate
7909 @item -sectobjectsymbols
7910 @item -sectorder
7911 @item -seg_addr_table
7912 @item -seg_addr_table_filename
7913 @item -seglinkedit
7914 @item -segprot   
7915 @item -segs_read_only_addr
7916 @item -segs_read_write_addr
7917 @item -single_module   
7918 @item -static
7919 @item -sub_library
7920 @item -sub_umbrella 
7921 @item -twolevel_namespace
7922 @item -umbrella
7923 @item -undefined
7924 @item -unexported_symbols_list
7925 @item -weak_reference_mismatches
7926 @item -whatsloaded  
7927
7928 @opindex allowable_client
7929 @opindex arch_only    
7930 @opindex client_name
7931 @opindex compatibility_version
7932 @opindex current_version
7933 @opindex dependency-file
7934 @opindex dylib_file
7935 @opindex dylinker_install_name
7936 @opindex dynamic
7937 @opindex dynamiclib
7938 @opindex exported_symbols_list
7939 @opindex filelist  
7940 @opindex flat_namespace    
7941 @opindex force_cpusubtype_ALL
7942 @opindex force_flat_namespace
7943 @opindex headerpad_max_install_names
7944 @opindex image_base
7945 @opindex init     
7946 @opindex install_name
7947 @opindex keep_private_externs
7948 @opindex multi_module   
7949 @opindex multiply_defined
7950 @opindex multiply_defined_unused   
7951 @opindex noall_load  
7952 @opindex nofixprebinding
7953 @opindex nomultidefs   
7954 @opindex noprebind
7955 @opindex noseglinkedit      
7956 @opindex pagezero_size
7957 @opindex prebind
7958 @opindex prebind_all_twolevel_modules
7959 @opindex private_bundle 
7960 @opindex read_only_relocs
7961 @opindex sectalign   
7962 @opindex sectobjectsymbols    
7963 @opindex whyload  
7964 @opindex seg1addr
7965 @opindex sectcreate       
7966 @opindex sectobjectsymbols 
7967 @opindex sectorder     
7968 @opindex seg_addr_table
7969 @opindex seg_addr_table_filename
7970 @opindex seglinkedit
7971 @opindex segprot
7972 @opindex segs_read_only_addr
7973 @opindex segs_read_write_addr
7974 @opindex single_module
7975 @opindex static
7976 @opindex sub_library
7977 @opindex sub_umbrella
7978 @opindex twolevel_namespace
7979 @opindex umbrella
7980 @opindex undefined
7981 @opindex unexported_symbols_list
7982 @opindex weak_reference_mismatches
7983 @opindex whatsloaded
7984
7985 This options are available for Darwin linker. Darwin linker man page
7986 describes them in detail.
7987 @end table
7988
7989
7990 @node RT Options
7991 @subsection IBM RT Options
7992 @cindex RT options
7993 @cindex IBM RT options
7994
7995 These @samp{-m} options are defined for the IBM RT PC:
7996
7997 @table @gcctabopt
7998 @item -min-line-mul
7999 @opindex min-line-mul
8000 Use an in-line code sequence for integer multiplies.  This is the
8001 default.
8002
8003 @item -mcall-lib-mul
8004 @opindex mcall-lib-mul
8005 Call @code{lmul$$} for integer multiples.
8006
8007 @item -mfull-fp-blocks
8008 @opindex mfull-fp-blocks
8009 Generate full-size floating point data blocks, including the minimum
8010 amount of scratch space recommended by IBM@.  This is the default.
8011
8012 @item -mminimum-fp-blocks
8013 @opindex mminimum-fp-blocks
8014 Do not include extra scratch space in floating point data blocks.  This
8015 results in smaller code, but slower execution, since scratch space must
8016 be allocated dynamically.
8017
8018 @cindex @file{stdarg.h} and RT PC
8019 @item -mfp-arg-in-fpregs
8020 @opindex mfp-arg-in-fpregs
8021 Use a calling sequence incompatible with the IBM calling convention in
8022 which floating point arguments are passed in floating point registers.
8023 Note that @code{stdarg.h} will not work with floating point operands
8024 if this option is specified.
8025
8026 @item -mfp-arg-in-gregs
8027 @opindex mfp-arg-in-gregs
8028 Use the normal calling convention for floating point arguments.  This is
8029 the default.
8030
8031 @item -mhc-struct-return
8032 @opindex mhc-struct-return
8033 Return structures of more than one word in memory, rather than in a
8034 register.  This provides compatibility with the MetaWare HighC (hc)
8035 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
8036 with the Portable C Compiler (pcc).
8037
8038 @item -mnohc-struct-return
8039 @opindex mnohc-struct-return
8040 Return some structures of more than one word in registers, when
8041 convenient.  This is the default.  For compatibility with the
8042 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
8043 option @option{-mhc-struct-return}.
8044 @end table
8045
8046 @node MIPS Options
8047 @subsection MIPS Options
8048 @cindex MIPS options
8049
8050 These @samp{-m} options are defined for the MIPS family of computers:
8051
8052 @table @gcctabopt
8053
8054 @item -march=@var{arch}
8055 @opindex march
8056 Generate code that will run on @var{arch}, which can be the name of a
8057 generic MIPS ISA, or the name of a particular processor.
8058 The ISA names are:
8059 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
8060 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
8061 The processor names are:
8062 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
8063 @samp{m4k},
8064 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
8065 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
8066 @samp{rm9000},
8067 @samp{orion},
8068 @samp{sb1},
8069 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4300},
8070 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
8071 The special value @samp{from-abi} selects the
8072 most compatible architecture for the selected ABI (that is,
8073 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
8074
8075 In processor names, a final @samp{000} can be abbreviated as @samp{k}
8076 (for example, @samp{-march=r2k}).  Prefixes are optional, and
8077 @samp{vr} may be written @samp{r}.
8078
8079 GCC defines two macros based on the value of this option.  The first
8080 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
8081 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
8082 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
8083 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
8084 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
8085
8086 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
8087 above.  In other words, it will have the full prefix and will not
8088 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
8089 the macro names the resolved architecture (either @samp{"mips1"} or
8090 @samp{"mips3"}).  It names the default architecture when no
8091 @option{-march} option is given.
8092
8093 @item -mtune=@var{arch}
8094 @opindex mtune
8095 Optimize for @var{arch}.  Among other things, this option controls
8096 the way instructions are scheduled, and the perceived cost of arithmetic
8097 operations.  The list of @var{arch} values is the same as for
8098 @option{-march}.
8099
8100 When this option is not used, GCC will optimize for the processor
8101 specified by @option{-march}.  By using @option{-march} and
8102 @option{-mtune} together, it is possible to generate code that will
8103 run on a family of processors, but optimize the code for one
8104 particular member of that family.
8105
8106 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
8107 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
8108 @samp{-march} ones described above.
8109
8110 @item -mips1
8111 @opindex mips1
8112 Equivalent to @samp{-march=mips1}.
8113
8114 @item -mips2
8115 @opindex mips2
8116 Equivalent to @samp{-march=mips2}.
8117
8118 @item -mips3
8119 @opindex mips3
8120 Equivalent to @samp{-march=mips3}.
8121
8122 @item -mips4
8123 @opindex mips4
8124 Equivalent to @samp{-march=mips4}.
8125
8126 @item -mips32
8127 @opindex mips32
8128 Equivalent to @samp{-march=mips32}.
8129
8130 @item -mips32r2
8131 @opindex mips32r2
8132 Equivalent to @samp{-march=mips32r2}.
8133
8134 @item -mips64
8135 @opindex mips64
8136 Equivalent to @samp{-march=mips64}.
8137
8138 @item -mfused-madd
8139 @itemx -mno-fused-madd
8140 @opindex mfused-madd
8141 @opindex mno-fused-madd
8142 Generate code that uses (does not use) the floating point multiply and
8143 accumulate instructions, when they are available.  These instructions
8144 are generated by default if they are available, but this may be
8145 undesirable if the extra precision causes problems or on certain chips
8146 in the mode where denormals are rounded to zero where denormals
8147 generated by multiply and accumulate instructions cause exceptions
8148 anyway.
8149
8150 @item -mfp32
8151 @opindex mfp32
8152 Assume that floating point registers are 32 bits wide.
8153
8154 @item -mfp64
8155 @opindex mfp64
8156 Assume that floating point registers are 64 bits wide.
8157
8158 @item -mgp32
8159 @opindex mgp32
8160 Assume that general purpose registers are 32 bits wide.
8161
8162 @item -mgp64
8163 @opindex mgp64
8164 Assume that general purpose registers are 64 bits wide.
8165
8166 @item -mint64
8167 @opindex mint64
8168 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
8169 explanation of the default, and the width of pointers.
8170
8171 @item -mlong64
8172 @opindex mlong64
8173 Force long types to be 64 bits wide.  See @option{-mlong32} for an
8174 explanation of the default, and the width of pointers.
8175
8176 @item -mlong32
8177 @opindex mlong32
8178 Force long, int, and pointer types to be 32 bits wide.
8179
8180 The default size of ints, longs and pointers depends on the ABI@.  All
8181 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
8182 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
8183 are the same size as longs, or the same size as integer registers,
8184 whichever is smaller.
8185
8186 @item -mabi=32
8187 @itemx -mabi=o64
8188 @itemx -mabi=n32
8189 @itemx -mabi=64
8190 @itemx -mabi=eabi
8191 @itemx -mabi=meabi
8192 @opindex mabi=32
8193 @opindex mabi=o64
8194 @opindex mabi=n32
8195 @opindex mabi=64
8196 @opindex mabi=eabi
8197 @opindex mabi=meabi
8198 Generate code for the given ABI@.
8199
8200 Note that there are two embedded ABIs: @option{-mabi=eabi}
8201 selects the one defined by Cygnus while @option{-meabi=meabi}
8202 selects the one defined by MIPS@.  Both these ABIs have
8203 32-bit and 64-bit variants.  Normally, GCC will generate
8204 64-bit code when you select a 64-bit architecture, but you
8205 can use @option{-mgp32} to get 32-bit code instead.
8206
8207 @item -mabi-fake-default
8208 @opindex mabi-fake-default
8209 You don't want to know what this option does.  No, really.  I mean
8210 it.  Move on to the next option.
8211
8212 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
8213 wants the default set of options to get the root of the multilib tree,
8214 and the shared library SONAMEs without any multilib-indicating
8215 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
8216 we want to default to the N32 ABI, while still being binary-compatible
8217 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
8218 binary-compatible means shared libraries should have the same SONAMEs,
8219 and libraries should live in the same location.  Having O32 libraries
8220 in a sub-directory named say @file{o32} is not acceptable.
8221
8222 So we trick GCC into believing that O32 is the default ABI, except
8223 that we override the default with some internal command-line
8224 processing magic.  Problem is, if we stopped at that, and you then
8225 created a multilib-aware package that used the output of @command{gcc
8226 -print-multi-lib} to decide which multilibs to build, and how, and
8227 you'd find yourself in an awkward situation when you found out that
8228 some of the options listed ended up mapping to the same multilib, and
8229 none of your libraries was actually built for the multilib that
8230 @option{-print-multi-lib} claims to be the default.  So we added this
8231 option that disables the default switcher, falling back to GCC's
8232 original notion of the default library.  Confused yet?
8233
8234 For short: don't ever use this option, unless you find it in the list
8235 of additional options to be used when building for multilibs, in the
8236 output of @option{gcc -print-multi-lib}.
8237
8238 @item -mmips-as
8239 @opindex mmips-as
8240 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
8241 add normal debug information.  This is the default for all
8242 platforms except for the OSF/1 reference platform, using the OSF/rose
8243 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
8244 switches are used, the @file{mips-tfile} program will encapsulate the
8245 stabs within MIPS ECOFF@.
8246
8247 @item -mgas
8248 @opindex mgas
8249 Generate code for the GNU assembler.  This is the default on the OSF/1
8250 reference platform, using the OSF/rose object format.  Also, this is
8251 the default if the configure option @option{--with-gnu-as} is used.
8252
8253 @item -msplit-addresses
8254 @itemx -mno-split-addresses
8255 @opindex msplit-addresses
8256 @opindex mno-split-addresses
8257 Generate code to load the high and low parts of address constants separately.
8258 This allows GCC to optimize away redundant loads of the high order
8259 bits of addresses.  This optimization requires GNU as and GNU ld.
8260 This optimization is enabled by default for some embedded targets where
8261 GNU as and GNU ld are standard.
8262
8263 @item -mrnames
8264 @itemx -mno-rnames
8265 @opindex mrnames
8266 @opindex mno-rnames
8267 The @option{-mrnames} switch says to output code using the MIPS software
8268 names for the registers, instead of the hardware names (ie, @var{a0}
8269 instead of @var{$4}).  The only known assembler that supports this option
8270 is the Algorithmics assembler.
8271
8272 @item -mmemcpy
8273 @itemx -mno-memcpy
8274 @opindex mmemcpy
8275 @opindex mno-memcpy
8276 The @option{-mmemcpy} switch makes all block moves call the appropriate
8277 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
8278 generating inline code.
8279
8280 @item -mmips-tfile
8281 @itemx -mno-mips-tfile
8282 @opindex mmips-tfile
8283 @opindex mno-mips-tfile
8284 The @option{-mno-mips-tfile} switch causes the compiler not
8285 postprocess the object file with the @file{mips-tfile} program,
8286 after the MIPS assembler has generated it to add debug support.  If
8287 @file{mips-tfile} is not run, then no local variables will be
8288 available to the debugger.  In addition, @file{stage2} and
8289 @file{stage3} objects will have the temporary file names passed to the
8290 assembler embedded in the object file, which means the objects will
8291 not compare the same.  The @option{-mno-mips-tfile} switch should only
8292 be used when there are bugs in the @file{mips-tfile} program that
8293 prevents compilation.
8294
8295 @item -msoft-float
8296 @opindex msoft-float
8297 Generate output containing library calls for floating point.
8298 @strong{Warning:} the requisite libraries are not part of GCC@.
8299 Normally the facilities of the machine's usual C compiler are used, but
8300 this can't be done directly in cross-compilation.  You must make your
8301 own arrangements to provide suitable library functions for
8302 cross-compilation.
8303
8304 @item -mhard-float
8305 @opindex mhard-float
8306 Generate output containing floating point instructions.  This is the
8307 default if you use the unmodified sources.
8308
8309 @item -mabicalls
8310 @itemx -mno-abicalls
8311 @opindex mabicalls
8312 @opindex mno-abicalls
8313 Emit (or do not emit) the pseudo operations @samp{.abicalls},
8314 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
8315 position independent code.
8316
8317 @item -mxgot
8318 @itemx -mno-xgot
8319 @opindex mxgot
8320 @opindex mno-xgot
8321 Lift (or do not lift) the usual restrictions on the size of the global
8322 offset table.
8323
8324 GCC normally uses a single instruction to load values from the GOT.
8325 While this is relatively efficient, it will only work if the GOT
8326 is smaller than about 64k.  Anything larger will cause the linker
8327 to report an error such as:
8328
8329 @cindex relocation truncated to fit (MIPS)
8330 @smallexample
8331 relocation truncated to fit: R_MIPS_GOT16 foobar
8332 @end smallexample
8333
8334 If this happens, you should recompile your code with @option{-mxgot}.
8335 It should then work with very large GOTs, although it will also be
8336 less efficient, since it will take three instructions to fetch the
8337 value of a global symbol.
8338
8339 Note that some linkers can create multiple GOTs.  If you have such a
8340 linker, you should only need to use @option{-mxgot} when a single object
8341 file accesses more than 64k's worth of GOT entries.  Very few do.
8342
8343 These options have no effect unless GCC is generating position
8344 independent code.
8345
8346 @item -mlong-calls
8347 @itemx -mno-long-calls
8348 @opindex mlong-calls
8349 @opindex mno-long-calls
8350 Do all calls with the @samp{JALR} instruction, which requires
8351 loading up a function's address into a register before the call.
8352 You need to use this switch, if you call outside of the current
8353 512 megabyte segment to functions that are not through pointers.
8354
8355 @item -membedded-pic
8356 @itemx -mno-embedded-pic
8357 @opindex membedded-pic
8358 @opindex mno-embedded-pic
8359 Generate PIC code suitable for some embedded systems.  All calls are
8360 made using PC relative address, and all data is addressed using the $gp
8361 register.  No more than 65536 bytes of global data may be used.  This
8362 requires GNU as and GNU ld which do most of the work.  This currently
8363 only works on targets which use ECOFF; it does not work with ELF@.
8364
8365 @item -membedded-data
8366 @itemx -mno-embedded-data
8367 @opindex membedded-data
8368 @opindex mno-embedded-data
8369 Allocate variables to the read-only data section first if possible, then
8370 next in the small data section if possible, otherwise in data.  This gives
8371 slightly slower code than the default, but reduces the amount of RAM required
8372 when executing, and thus may be preferred for some embedded systems.
8373
8374 @item -muninit-const-in-rodata
8375 @itemx -mno-uninit-const-in-rodata
8376 @opindex muninit-const-in-rodata
8377 @opindex mno-uninit-const-in-rodata
8378 When used together with @option{-membedded-data}, it will always store uninitialized
8379 const variables in the read-only data section.
8380
8381 @item -msingle-float
8382 @itemx -mdouble-float
8383 @opindex msingle-float
8384 @opindex mdouble-float
8385 The @option{-msingle-float} switch tells gcc to assume that the floating
8386 point coprocessor only supports single precision operations, as on the
8387 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
8388 double precision operations.  This is the default.
8389
8390 @item -mmad
8391 @itemx -mno-mad
8392 @opindex mmad
8393 @opindex mno-mad
8394 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
8395 as on the @samp{r4650} chip.
8396
8397 @item -m4650
8398 @opindex m4650
8399 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
8400 @option{-mcpu=r4650}.
8401
8402 @item -mips16
8403 @itemx -mno-mips16
8404 @opindex mips16
8405 @opindex mno-mips16
8406 Enable 16-bit instructions.
8407
8408 @item -EL
8409 @opindex EL
8410 Compile code for the processor in little endian mode.
8411 The requisite libraries are assumed to exist.
8412
8413 @item -EB
8414 @opindex EB
8415 Compile code for the processor in big endian mode.
8416 The requisite libraries are assumed to exist.
8417
8418 @item -G @var{num}
8419 @opindex G
8420 @cindex smaller data references (MIPS)
8421 @cindex gp-relative references (MIPS)
8422 Put global and static items less than or equal to @var{num} bytes into
8423 the small data or bss sections instead of the normal data or bss
8424 section.  This allows the assembler to emit one word memory reference
8425 instructions based on the global pointer (@var{gp} or @var{$28}),
8426 instead of the normal two words used.  By default, @var{num} is 8 when
8427 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8428 @option{-G @var{num}} switch is also passed to the assembler and linker.
8429 All modules should be compiled with the same @option{-G @var{num}}
8430 value.
8431
8432 @item -nocpp
8433 @opindex nocpp
8434 Tell the MIPS assembler to not run its preprocessor over user
8435 assembler files (with a @samp{.s} suffix) when assembling them.
8436
8437 @item -mfix7000
8438 @opindex mfix7000
8439 Pass an option to gas which will cause nops to be inserted if
8440 the read of the destination register of an mfhi or mflo instruction
8441 occurs in the following two instructions.
8442
8443 @item -mfix-sb1
8444 @itemx -mno-fix-sb1
8445 @opindex mfix-sb1
8446 Work around certain SB-1 CPU core errata.
8447 (This flag currently works around the SB-1 revision 2
8448 ``F1'' and ``F2'' floating point errata.)
8449
8450 @item -no-crt0
8451 @opindex no-crt0
8452 Do not include the default crt0.
8453
8454 @item -mflush-func=@var{func}
8455 @itemx -mno-flush-func
8456 @opindex mflush-func
8457 Specifies the function to call to flush the I and D caches, or to not
8458 call any such function.  If called, the function must take the same
8459 arguments as the common @code{_flush_func()}, that is, the address of the
8460 memory range for which the cache is being flushed, the size of the
8461 memory range, and the number 3 (to flush both caches).  The default
8462 depends on the target gcc was configured for, but commonly is either
8463 @samp{_flush_func} or @samp{__cpu_flush}.
8464
8465 @item -mbranch-likely
8466 @itemx -mno-branch-likely
8467 @opindex mbranch-likely
8468 @opindex mno-branch-likely
8469 Enable or disable use of Branch Likely instructions, regardless of the
8470 default for the selected architecture.  By default, Branch Likely
8471 instructions may be generated if they are supported by the selected
8472 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8473 and processors which implement those architectures; for those, Branch
8474 Likely instructions will not be generated by default because the MIPS32
8475 and MIPS64 architectures specifically deprecate their use.
8476 @end table
8477
8478 @node i386 and x86-64 Options
8479 @subsection Intel 386 and AMD x86-64 Options
8480 @cindex i386 Options
8481 @cindex x86-64 Options
8482 @cindex Intel 386 Options
8483 @cindex AMD x86-64 Options
8484
8485 These @samp{-m} options are defined for the i386 and x86-64 family of
8486 computers:
8487
8488 @table @gcctabopt
8489 @item -mtune=@var{cpu-type}
8490 @opindex mtune
8491 Tune to @var{cpu-type} everything applicable about the generated code, except
8492 for the ABI and the set of available instructions.  The choices for
8493 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8494 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8495 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8496 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8497 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8498 and @samp{c3-2}.
8499
8500 While picking a specific @var{cpu-type} will schedule things appropriately
8501 for that particular chip, the compiler will not generate any code that
8502 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8503 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8504 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8505 AMD chips as opposed to the Intel ones.
8506
8507 @item -march=@var{cpu-type}
8508 @opindex march
8509 Generate instructions for the machine type @var{cpu-type}.  The choices
8510 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8511 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8512
8513 @item -mcpu=@var{cpu-type}
8514 @opindex mcpu
8515 A deprecated synonym for @option{-mtune}.
8516
8517 @item -m386
8518 @itemx -m486
8519 @itemx -mpentium
8520 @itemx -mpentiumpro
8521 @opindex m386
8522 @opindex m486
8523 @opindex mpentium
8524 @opindex mpentiumpro
8525 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8526 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8527 These synonyms are deprecated.
8528
8529 @item -mfpmath=@var{unit}
8530 @opindex march
8531 generate floating point arithmetics for selected unit @var{unit}.  the choices
8532 for @var{unit} are:
8533
8534 @table @samp
8535 @item 387
8536 Use the standard 387 floating point coprocessor present majority of chips and
8537 emulated otherwise.  Code compiled with this option will run almost everywhere.
8538 The temporary results are computed in 80bit precision instead of precision
8539 specified by the type resulting in slightly different results compared to most
8540 of other chips. See @option{-ffloat-store} for more detailed description.
8541
8542 This is the default choice for i386 compiler.
8543
8544 @item sse
8545 Use scalar floating point instructions present in the SSE instruction set.
8546 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8547 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8548 instruction set supports only single precision arithmetics, thus the double and
8549 extended precision arithmetics is still done using 387.  Later version, present
8550 only in Pentium4 and the future AMD x86-64 chips supports double precision
8551 arithmetics too.
8552
8553 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8554 @option{-msse2} switches to enable SSE extensions and make this option
8555 effective.  For x86-64 compiler, these extensions are enabled by default.
8556
8557 The resulting code should be considerably faster in majority of cases and avoid
8558 the numerical instability problems of 387 code, but may break some existing
8559 code that expects temporaries to be 80bit.
8560
8561 This is the default choice for x86-64 compiler.
8562
8563 @item pni
8564 Use all SSE extensions enabled by @option{-msse2} as well as the new
8565 SSE extensions in Prescott New Instructions. @option{-mpni} also
8566 enables 2 builtin functions, @code{__builtin_ia32_monitor} and
8567 @code{__builtin_ia32_mwait}, for new instructions @code{monitor} and
8568 @code{mwait}. 
8569
8570 @item sse,387
8571 Attempt to utilize both instruction sets at once.  This effectively double the
8572 amount of available registers and on chips with separate execution units for
8573 387 and SSE the execution resources too.  Use this option with care, as it is
8574 still experimental, because gcc register allocator does not model separate
8575 functional units well resulting in instable performance.
8576 @end table
8577
8578 @item -masm=@var{dialect}
8579 @opindex masm=@var{dialect}
8580 Output asm instructions using selected @var{dialect}. Supported choices are
8581 @samp{intel} or @samp{att} (the default one).
8582
8583 @item -mieee-fp
8584 @itemx -mno-ieee-fp
8585 @opindex mieee-fp
8586 @opindex mno-ieee-fp
8587 Control whether or not the compiler uses IEEE floating point
8588 comparisons.  These handle correctly the case where the result of a
8589 comparison is unordered.
8590
8591 @item -msoft-float
8592 @opindex msoft-float
8593 Generate output containing library calls for floating point.
8594 @strong{Warning:} the requisite libraries are not part of GCC@.
8595 Normally the facilities of the machine's usual C compiler are used, but
8596 this can't be done directly in cross-compilation.  You must make your
8597 own arrangements to provide suitable library functions for
8598 cross-compilation.
8599
8600 On machines where a function returns floating point results in the 80387
8601 register stack, some floating point opcodes may be emitted even if
8602 @option{-msoft-float} is used.
8603
8604 @item -mno-fp-ret-in-387
8605 @opindex mno-fp-ret-in-387
8606 Do not use the FPU registers for return values of functions.
8607
8608 The usual calling convention has functions return values of types
8609 @code{float} and @code{double} in an FPU register, even if there
8610 is no FPU@.  The idea is that the operating system should emulate
8611 an FPU@.
8612
8613 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8614 in ordinary CPU registers instead.
8615
8616 @item -mno-fancy-math-387
8617 @opindex mno-fancy-math-387
8618 Some 387 emulators do not support the @code{sin}, @code{cos} and
8619 @code{sqrt} instructions for the 387.  Specify this option to avoid
8620 generating those instructions.  This option is the default on FreeBSD,
8621 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8622 indicates that the target cpu will always have an FPU and so the
8623 instruction will not need emulation.  As of revision 2.6.1, these
8624 instructions are not generated unless you also use the
8625 @option{-funsafe-math-optimizations} switch.
8626
8627 @item -malign-double
8628 @itemx -mno-align-double
8629 @opindex malign-double
8630 @opindex mno-align-double
8631 Control whether GCC aligns @code{double}, @code{long double}, and
8632 @code{long long} variables on a two word boundary or a one word
8633 boundary.  Aligning @code{double} variables on a two word boundary will
8634 produce code that runs somewhat faster on a @samp{Pentium} at the
8635 expense of more memory.
8636
8637 @strong{Warning:} if you use the @option{-malign-double} switch,
8638 structures containing the above types will be aligned differently than
8639 the published application binary interface specifications for the 386
8640 and will not be binary compatible with structures in code compiled
8641 without that switch.
8642
8643 @item -m96bit-long-double
8644 @item -m128bit-long-double
8645 @opindex m96bit-long-double
8646 @opindex m128bit-long-double
8647 These switches control the size of @code{long double} type. The i386 
8648 application binary interface specifies the size to be 96 bits, 
8649 so @option{-m96bit-long-double} is the default in 32 bit mode.
8650
8651 Modern architectures (Pentium and newer) would prefer @code{long double}
8652 to be aligned to an 8 or 16 byte boundary.  In arrays or structures 
8653 conforming to the ABI, this would not be possible.  So specifying a 
8654 @option{-m128bit-long-double} will align @code{long double}
8655 to a 16 byte boundary by padding the @code{long double} with an additional
8656 32 bit zero. 
8657
8658 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8659 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8660  
8661 Notice that neither of these options enable any extra precision over the x87
8662 standard of 80 bits for a @code{long double}. 
8663
8664 @strong{Warning:} if you override the default value for your target ABI, the
8665 structures and arrays containing @code{long double} will change their size as
8666 well as function calling convention for function taking @code{long double}
8667 will be modified.  Hence they will not be binary compatible with arrays or
8668 structures in code compiled without that switch.
8669
8670
8671 @item -msvr3-shlib
8672 @itemx -mno-svr3-shlib
8673 @opindex msvr3-shlib
8674 @opindex mno-svr3-shlib
8675 Control whether GCC places uninitialized local variables into the
8676 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8677 into @code{bss}.  These options are meaningful only on System V Release 3.
8678
8679 @item -mrtd
8680 @opindex mrtd
8681 Use a different function-calling convention, in which functions that
8682 take a fixed number of arguments return with the @code{ret} @var{num}
8683 instruction, which pops their arguments while returning.  This saves one
8684 instruction in the caller since there is no need to pop the arguments
8685 there.
8686
8687 You can specify that an individual function is called with this calling
8688 sequence with the function attribute @samp{stdcall}.  You can also
8689 override the @option{-mrtd} option by using the function attribute
8690 @samp{cdecl}.  @xref{Function Attributes}.
8691
8692 @strong{Warning:} this calling convention is incompatible with the one
8693 normally used on Unix, so you cannot use it if you need to call
8694 libraries compiled with the Unix compiler.
8695
8696 Also, you must provide function prototypes for all functions that
8697 take variable numbers of arguments (including @code{printf});
8698 otherwise incorrect code will be generated for calls to those
8699 functions.
8700
8701 In addition, seriously incorrect code will result if you call a
8702 function with too many arguments.  (Normally, extra arguments are
8703 harmlessly ignored.)
8704
8705 @item -mregparm=@var{num}
8706 @opindex mregparm
8707 Control how many registers are used to pass integer arguments.  By
8708 default, no registers are used to pass arguments, and at most 3
8709 registers can be used.  You can control this behavior for a specific
8710 function by using the function attribute @samp{regparm}.
8711 @xref{Function Attributes}.
8712
8713 @strong{Warning:} if you use this switch, and
8714 @var{num} is nonzero, then you must build all modules with the same
8715 value, including any libraries.  This includes the system libraries and
8716 startup modules.
8717
8718 @item -mpreferred-stack-boundary=@var{num}
8719 @opindex mpreferred-stack-boundary
8720 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8721 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8722 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8723 size (@option{-Os}), in which case the default is the minimum correct
8724 alignment (4 bytes for x86, and 8 bytes for x86-64).
8725
8726 On Pentium and PentiumPro, @code{double} and @code{long double} values
8727 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8728 suffer significant run time performance penalties.  On Pentium III, the
8729 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8730 penalties if it is not 16 byte aligned.
8731
8732 To ensure proper alignment of this values on the stack, the stack boundary
8733 must be as aligned as that required by any value stored on the stack.
8734 Further, every function must be generated such that it keeps the stack
8735 aligned.  Thus calling a function compiled with a higher preferred
8736 stack boundary from a function compiled with a lower preferred stack
8737 boundary will most likely misalign the stack.  It is recommended that
8738 libraries that use callbacks always use the default setting.
8739
8740 This extra alignment does consume extra stack space, and generally
8741 increases code size.  Code that is sensitive to stack space usage, such
8742 as embedded systems and operating system kernels, may want to reduce the
8743 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8744
8745 @item -mmmx
8746 @itemx -mno-mmx
8747 @item -msse
8748 @itemx -mno-sse
8749 @item -msse2
8750 @itemx -mno-sse2
8751 @item -mpni
8752 @itemx -mno-pni
8753 @item -m3dnow
8754 @itemx -mno-3dnow
8755 @opindex mmmx
8756 @opindex mno-mmx
8757 @opindex msse
8758 @opindex mno-sse
8759 @opindex m3dnow
8760 @opindex mno-3dnow
8761 These switches enable or disable the use of built-in functions that allow
8762 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8763
8764 @xref{X86 Built-in Functions}, for details of the functions enabled
8765 and disabled by these switches.
8766
8767 To have SSE/SSE2 instructions generated automatically from floating-point
8768 code, see @option{-mfpmath=sse}.
8769
8770 @item -mpush-args
8771 @itemx -mno-push-args
8772 @opindex mpush-args
8773 @opindex mno-push-args
8774 Use PUSH operations to store outgoing parameters.  This method is shorter
8775 and usually equally fast as method using SUB/MOV operations and is enabled
8776 by default.  In some cases disabling it may improve performance because of
8777 improved scheduling and reduced dependencies.
8778
8779 @item -maccumulate-outgoing-args
8780 @opindex maccumulate-outgoing-args
8781 If enabled, the maximum amount of space required for outgoing arguments will be
8782 computed in the function prologue.  This is faster on most modern CPUs
8783 because of reduced dependencies, improved scheduling and reduced stack usage
8784 when preferred stack boundary is not equal to 2.  The drawback is a notable
8785 increase in code size.  This switch implies @option{-mno-push-args}.
8786
8787 @item -mthreads
8788 @opindex mthreads
8789 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8790 on thread-safe exception handling must compile and link all code with the
8791 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8792 @option{-D_MT}; when linking, it links in a special thread helper library
8793 @option{-lmingwthrd} which cleans up per thread exception handling data.
8794
8795 @item -mno-align-stringops
8796 @opindex mno-align-stringops
8797 Do not align destination of inlined string operations.  This switch reduces
8798 code size and improves performance in case the destination is already aligned,
8799 but gcc don't know about it.
8800
8801 @item -minline-all-stringops
8802 @opindex minline-all-stringops
8803 By default GCC inlines string operations only when destination is known to be
8804 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8805 size, but may improve performance of code that depends on fast memcpy, strlen
8806 and memset for short lengths.
8807
8808 @item -momit-leaf-frame-pointer
8809 @opindex momit-leaf-frame-pointer
8810 Don't keep the frame pointer in a register for leaf functions.  This
8811 avoids the instructions to save, set up and restore frame pointers and
8812 makes an extra register available in leaf functions.  The option
8813 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8814 which might make debugging harder.
8815
8816 @item -mtls-direct-seg-refs
8817 @itemx -mno-tls-direct-seg-refs
8818 @opindex mtls-direct-seg-refs
8819 Controls whether TLS variables may be accessed with offsets from the
8820 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8821 or whether the thread base pointer must be added.  Whether or not this
8822 is legal depends on the operating system, and whether it maps the
8823 segment to cover the entire TLS area.
8824
8825 For systems that use GNU libc, the default is on.
8826 @end table
8827
8828 These @samp{-m} switches are supported in addition to the above
8829 on AMD x86-64 processors in 64-bit environments.
8830
8831 @table @gcctabopt
8832 @item -m32
8833 @itemx -m64
8834 @opindex m32
8835 @opindex m64
8836 Generate code for a 32-bit or 64-bit environment.
8837 The 32-bit environment sets int, long and pointer to 32 bits and
8838 generates code that runs on any i386 system.
8839 The 64-bit environment sets int to 32 bits and long and pointer
8840 to 64 bits and generates code for AMD's x86-64 architecture.
8841
8842 @item -mno-red-zone
8843 @opindex no-red-zone
8844 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8845 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8846 stack pointer that will not be modified by signal or interrupt handlers
8847 and therefore can be used for temporary data without adjusting the stack
8848 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8849
8850 @item -mcmodel=small
8851 @opindex mcmodel=small
8852 Generate code for the small code model: the program and its symbols must
8853 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8854 Programs can be statically or dynamically linked.  This is the default
8855 code model.
8856
8857 @item -mcmodel=kernel
8858 @opindex mcmodel=kernel
8859 Generate code for the kernel code model.  The kernel runs in the
8860 negative 2 GB of the address space.
8861 This model has to be used for Linux kernel code.
8862
8863 @item -mcmodel=medium
8864 @opindex mcmodel=medium
8865 Generate code for the medium model: The program is linked in the lower 2
8866 GB of the address space but symbols can be located anywhere in the
8867 address space.  Programs can be statically or dynamically linked, but
8868 building of shared libraries are not supported with the medium model.
8869
8870 @item -mcmodel=large
8871 @opindex mcmodel=large
8872 Generate code for the large model: This model makes no assumptions
8873 about addresses and sizes of sections.  Currently GCC does not implement
8874 this model.
8875 @end table
8876
8877 @node HPPA Options
8878 @subsection HPPA Options
8879 @cindex HPPA Options
8880
8881 These @samp{-m} options are defined for the HPPA family of computers:
8882
8883 @table @gcctabopt
8884 @item -march=@var{architecture-type}
8885 @opindex march
8886 Generate code for the specified architecture.  The choices for
8887 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8888 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8889 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8890 architecture option for your machine.  Code compiled for lower numbered
8891 architectures will run on higher numbered architectures, but not the
8892 other way around.
8893
8894 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8895 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8896 support.
8897
8898 @item -mpa-risc-1-0
8899 @itemx -mpa-risc-1-1
8900 @itemx -mpa-risc-2-0
8901 @opindex mpa-risc-1-0
8902 @opindex mpa-risc-1-1
8903 @opindex mpa-risc-2-0
8904 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8905
8906 @item -mbig-switch
8907 @opindex mbig-switch
8908 Generate code suitable for big switch tables.  Use this option only if
8909 the assembler/linker complain about out of range branches within a switch
8910 table.
8911
8912 @item -mjump-in-delay
8913 @opindex mjump-in-delay
8914 Fill delay slots of function calls with unconditional jump instructions
8915 by modifying the return pointer for the function call to be the target
8916 of the conditional jump.
8917
8918 @item -mdisable-fpregs
8919 @opindex mdisable-fpregs
8920 Prevent floating point registers from being used in any manner.  This is
8921 necessary for compiling kernels which perform lazy context switching of
8922 floating point registers.  If you use this option and attempt to perform
8923 floating point operations, the compiler will abort.
8924
8925 @item -mdisable-indexing
8926 @opindex mdisable-indexing
8927 Prevent the compiler from using indexing address modes.  This avoids some
8928 rather obscure problems when compiling MIG generated code under MACH@.
8929
8930 @item -mno-space-regs
8931 @opindex mno-space-regs
8932 Generate code that assumes the target has no space registers.  This allows
8933 GCC to generate faster indirect calls and use unscaled index address modes.
8934
8935 Such code is suitable for level 0 PA systems and kernels.
8936
8937 @item -mfast-indirect-calls
8938 @opindex mfast-indirect-calls
8939 Generate code that assumes calls never cross space boundaries.  This
8940 allows GCC to emit code which performs faster indirect calls.
8941
8942 This option will not work in the presence of shared libraries or nested
8943 functions.
8944
8945 @item -mlong-load-store
8946 @opindex mlong-load-store
8947 Generate 3-instruction load and store sequences as sometimes required by
8948 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8949 the HP compilers.
8950
8951 @item -mportable-runtime
8952 @opindex mportable-runtime
8953 Use the portable calling conventions proposed by HP for ELF systems.
8954
8955 @item -mgas
8956 @opindex mgas
8957 Enable the use of assembler directives only GAS understands.
8958
8959 @item -mschedule=@var{cpu-type}
8960 @opindex mschedule
8961 Schedule code according to the constraints for the machine type
8962 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8963 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8964 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8965 proper scheduling option for your machine.  The default scheduling is
8966 @samp{8000}.
8967
8968 @item -mlinker-opt
8969 @opindex mlinker-opt
8970 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8971 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8972 linkers in which they give bogus error messages when linking some programs.
8973
8974 @item -msoft-float
8975 @opindex msoft-float
8976 Generate output containing library calls for floating point.
8977 @strong{Warning:} the requisite libraries are not available for all HPPA
8978 targets.  Normally the facilities of the machine's usual C compiler are
8979 used, but this cannot be done directly in cross-compilation.  You must make
8980 your own arrangements to provide suitable library functions for
8981 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8982 does provide software floating point support.
8983
8984 @option{-msoft-float} changes the calling convention in the output file;
8985 therefore, it is only useful if you compile @emph{all} of a program with
8986 this option.  In particular, you need to compile @file{libgcc.a}, the
8987 library that comes with GCC, with @option{-msoft-float} in order for
8988 this to work.
8989
8990 @item -msio
8991 @opindex msio
8992 Generate the predefine, @code{_SIO}, for server IO.  The default is
8993 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8994 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8995 options are available under HP-UX and HI-UX.
8996
8997 @item -mgnu-ld
8998 @opindex gnu-ld
8999 Use GNU ld specific options.  This passes @option{-shared} to ld when
9000 building a shared library.  It is the default when GCC is configured,
9001 explicitly or implicitly, with the GNU linker.  This option does not
9002 have any affect on which ld is called, it only changes what parameters
9003 are passed to that ld.  The ld that is called is determined by the
9004 @option{--with-ld} configure option, gcc's program search path, and
9005 finally by the user's @env{PATH}.  The linker used by GCC can be printed
9006 using @samp{which `gcc -print-prog-name=ld`}.
9007
9008 @item -mhp-ld
9009 @opindex hp-ld
9010 Use HP ld specific options.  This passes @option{-b} to ld when building
9011 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9012 links.  It is the default when GCC is configured, explicitly or
9013 implicitly, with the HP linker.  This option does not have any affect on
9014 which ld is called, it only changes what parameters are passed to that
9015 ld.  The ld that is called is determined by the @option{--with-ld}
9016 configure option, gcc's program search path, and finally by the user's
9017 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9018 `gcc -print-prog-name=ld`}.
9019
9020 @item -mlong-calls
9021 @opindex mno-long-calls
9022 Generate code that uses long call sequences.  This ensures that a call
9023 is always able to reach linker generated stubs.  The default is to generate
9024 long calls only when the distance from the call site to the beginning
9025 of the function or translation unit, as the case may be, exceeds a
9026 predefined limit set by the branch type being used.  The limits for
9027 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9028 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9029 240,000 bytes.
9030
9031 Distances are measured from the beginning of functions when using the
9032 @option{-ffunction-sections} option, or when using the @option{-mgas}
9033 and @option{-mno-portable-runtime} options together under HP-UX with
9034 the SOM linker.
9035
9036 It is normally not desirable to use this option as it will degrade
9037 performance.  However, it may be useful in large applications,
9038 particularly when partial linking is used to build the application.
9039
9040 The types of long calls used depends on the capabilities of the
9041 assembler and linker, and the type of code being generated.  The
9042 impact on systems that support long absolute calls, and long pic
9043 symbol-difference or pc-relative calls should be relatively small.
9044 However, an indirect call is used on 32-bit ELF systems in pic code
9045 and it is quite long.
9046
9047 @item -nolibdld
9048 @opindex nolibdld
9049 Suppress the generation of link options to search libdld.sl when the
9050 @option{-static} option is specified on HP-UX 10 and later.
9051
9052 @item -static
9053 @opindex static
9054 The HP-UX implementation of setlocale in libc has a dependency on
9055 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9056 when the @option{-static} option is specified, special link options
9057 are needed to resolve this dependency.
9058
9059 On HP-UX 10 and later, the GCC driver adds the necessary options to
9060 link with libdld.sl when the @option{-static} option is specified.
9061 This causes the resulting binary to be dynamic.  On the 64-bit port,
9062 the linkers generate dynamic binaries by default in any case.  The
9063 @option{-nolibdld} option can be used to prevent the GCC driver from
9064 adding these link options.
9065
9066 @item -threads
9067 @opindex threads
9068 Add support for multithreading with the @dfn{dce thread} library
9069 under HP-UX.  This option sets flags for both the preprocessor and
9070 linker.
9071 @end table
9072
9073 @node Intel 960 Options
9074 @subsection Intel 960 Options
9075
9076 These @samp{-m} options are defined for the Intel 960 implementations:
9077
9078 @table @gcctabopt
9079 @item -m@var{cpu-type}
9080 @opindex mka
9081 @opindex mkb
9082 @opindex mmc
9083 @opindex mca
9084 @opindex mcf
9085 @opindex msa
9086 @opindex msb
9087 Assume the defaults for the machine type @var{cpu-type} for some of
9088 the other options, including instruction scheduling, floating point
9089 support, and addressing modes.  The choices for @var{cpu-type} are
9090 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
9091 @samp{sa}, and @samp{sb}.
9092 The default is
9093 @samp{kb}.
9094
9095 @item -mnumerics
9096 @itemx -msoft-float
9097 @opindex mnumerics
9098 @opindex msoft-float
9099 The @option{-mnumerics} option indicates that the processor does support
9100 floating-point instructions.  The @option{-msoft-float} option indicates
9101 that floating-point support should not be assumed.
9102
9103 @item -mleaf-procedures
9104 @itemx -mno-leaf-procedures
9105 @opindex mleaf-procedures
9106 @opindex mno-leaf-procedures
9107 Do (or do not) attempt to alter leaf procedures to be callable with the
9108 @code{bal} instruction as well as @code{call}.  This will result in more
9109 efficient code for explicit calls when the @code{bal} instruction can be
9110 substituted by the assembler or linker, but less efficient code in other
9111 cases, such as calls via function pointers, or using a linker that doesn't
9112 support this optimization.
9113
9114 @item -mtail-call
9115 @itemx -mno-tail-call
9116 @opindex mtail-call
9117 @opindex mno-tail-call
9118 Do (or do not) make additional attempts (beyond those of the
9119 machine-independent portions of the compiler) to optimize tail-recursive
9120 calls into branches.  You may not want to do this because the detection of
9121 cases where this is not valid is not totally complete.  The default is
9122 @option{-mno-tail-call}.
9123
9124 @item -mcomplex-addr
9125 @itemx -mno-complex-addr
9126 @opindex mcomplex-addr
9127 @opindex mno-complex-addr
9128 Assume (or do not assume) that the use of a complex addressing mode is a
9129 win on this implementation of the i960.  Complex addressing modes may not
9130 be worthwhile on the K-series, but they definitely are on the C-series.
9131 The default is currently @option{-mcomplex-addr} for all processors except
9132 the CB and CC@.
9133
9134 @item -mcode-align
9135 @itemx -mno-code-align
9136 @opindex mcode-align
9137 @opindex mno-code-align
9138 Align code to 8-byte boundaries for faster fetching (or don't bother).
9139 Currently turned on by default for C-series implementations only.
9140
9141 @ignore
9142 @item -mclean-linkage
9143 @itemx -mno-clean-linkage
9144 @opindex mclean-linkage
9145 @opindex mno-clean-linkage
9146 These options are not fully implemented.
9147 @end ignore
9148
9149 @item -mic-compat
9150 @itemx -mic2.0-compat
9151 @itemx -mic3.0-compat
9152 @opindex mic-compat
9153 @opindex mic2.0-compat
9154 @opindex mic3.0-compat
9155 Enable compatibility with iC960 v2.0 or v3.0.
9156
9157 @item -masm-compat
9158 @itemx -mintel-asm
9159 @opindex masm-compat
9160 @opindex mintel-asm
9161 Enable compatibility with the iC960 assembler.
9162
9163 @item -mstrict-align
9164 @itemx -mno-strict-align
9165 @opindex mstrict-align
9166 @opindex mno-strict-align
9167 Do not permit (do permit) unaligned accesses.
9168
9169 @item -mold-align
9170 @opindex mold-align
9171 Enable structure-alignment compatibility with Intel's gcc release version
9172 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
9173
9174 @item -mlong-double-64
9175 @opindex mlong-double-64
9176 Implement type @samp{long double} as 64-bit floating point numbers.
9177 Without the option @samp{long double} is implemented by 80-bit
9178 floating point numbers.  The only reason we have it because there is
9179 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
9180 is only useful for people using soft-float targets.  Otherwise, we
9181 should recommend against use of it.
9182
9183 @end table
9184
9185 @node DEC Alpha Options
9186 @subsection DEC Alpha Options
9187
9188 These @samp{-m} options are defined for the DEC Alpha implementations:
9189
9190 @table @gcctabopt
9191 @item -mno-soft-float
9192 @itemx -msoft-float
9193 @opindex mno-soft-float
9194 @opindex msoft-float
9195 Use (do not use) the hardware floating-point instructions for
9196 floating-point operations.  When @option{-msoft-float} is specified,
9197 functions in @file{libgcc.a} will be used to perform floating-point
9198 operations.  Unless they are replaced by routines that emulate the
9199 floating-point operations, or compiled in such a way as to call such
9200 emulations routines, these routines will issue floating-point
9201 operations.   If you are compiling for an Alpha without floating-point
9202 operations, you must ensure that the library is built so as not to call
9203 them.
9204
9205 Note that Alpha implementations without floating-point operations are
9206 required to have floating-point registers.
9207
9208 @item -mfp-reg
9209 @itemx -mno-fp-regs
9210 @opindex mfp-reg
9211 @opindex mno-fp-regs
9212 Generate code that uses (does not use) the floating-point register set.
9213 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
9214 register set is not used, floating point operands are passed in integer
9215 registers as if they were integers and floating-point results are passed
9216 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
9217 so any function with a floating-point argument or return value called by code
9218 compiled with @option{-mno-fp-regs} must also be compiled with that
9219 option.
9220
9221 A typical use of this option is building a kernel that does not use,
9222 and hence need not save and restore, any floating-point registers.
9223
9224 @item -mieee
9225 @opindex mieee
9226 The Alpha architecture implements floating-point hardware optimized for
9227 maximum performance.  It is mostly compliant with the IEEE floating
9228 point standard.  However, for full compliance, software assistance is
9229 required.  This option generates code fully IEEE compliant code
9230 @emph{except} that the @var{inexact-flag} is not maintained (see below).
9231 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
9232 defined during compilation.  The resulting code is less efficient but is
9233 able to correctly support denormalized numbers and exceptional IEEE
9234 values such as not-a-number and plus/minus infinity.  Other Alpha
9235 compilers call this option @option{-ieee_with_no_inexact}.
9236
9237 @item -mieee-with-inexact
9238 @opindex mieee-with-inexact
9239 This is like @option{-mieee} except the generated code also maintains
9240 the IEEE @var{inexact-flag}.  Turning on this option causes the
9241 generated code to implement fully-compliant IEEE math.  In addition to
9242 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
9243 macro.  On some Alpha implementations the resulting code may execute
9244 significantly slower than the code generated by default.  Since there is
9245 very little code that depends on the @var{inexact-flag}, you should
9246 normally not specify this option.  Other Alpha compilers call this
9247 option @option{-ieee_with_inexact}.
9248
9249 @item -mfp-trap-mode=@var{trap-mode}
9250 @opindex mfp-trap-mode
9251 This option controls what floating-point related traps are enabled.
9252 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
9253 The trap mode can be set to one of four values:
9254
9255 @table @samp
9256 @item n
9257 This is the default (normal) setting.  The only traps that are enabled
9258 are the ones that cannot be disabled in software (e.g., division by zero
9259 trap).
9260
9261 @item u
9262 In addition to the traps enabled by @samp{n}, underflow traps are enabled
9263 as well.
9264
9265 @item su
9266 Like @samp{su}, but the instructions are marked to be safe for software
9267 completion (see Alpha architecture manual for details).
9268
9269 @item sui
9270 Like @samp{su}, but inexact traps are enabled as well.
9271 @end table
9272
9273 @item -mfp-rounding-mode=@var{rounding-mode}
9274 @opindex mfp-rounding-mode
9275 Selects the IEEE rounding mode.  Other Alpha compilers call this option
9276 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
9277 of:
9278
9279 @table @samp
9280 @item n
9281 Normal IEEE rounding mode.  Floating point numbers are rounded towards
9282 the nearest machine number or towards the even machine number in case
9283 of a tie.
9284
9285 @item m
9286 Round towards minus infinity.
9287
9288 @item c
9289 Chopped rounding mode.  Floating point numbers are rounded towards zero.
9290
9291 @item d
9292 Dynamic rounding mode.  A field in the floating point control register
9293 (@var{fpcr}, see Alpha architecture reference manual) controls the
9294 rounding mode in effect.  The C library initializes this register for
9295 rounding towards plus infinity.  Thus, unless your program modifies the
9296 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
9297 @end table
9298
9299 @item -mtrap-precision=@var{trap-precision}
9300 @opindex mtrap-precision
9301 In the Alpha architecture, floating point traps are imprecise.  This
9302 means without software assistance it is impossible to recover from a
9303 floating trap and program execution normally needs to be terminated.
9304 GCC can generate code that can assist operating system trap handlers
9305 in determining the exact location that caused a floating point trap.
9306 Depending on the requirements of an application, different levels of
9307 precisions can be selected:
9308
9309 @table @samp
9310 @item p
9311 Program precision.  This option is the default and means a trap handler
9312 can only identify which program caused a floating point exception.
9313
9314 @item f
9315 Function precision.  The trap handler can determine the function that
9316 caused a floating point exception.
9317
9318 @item i
9319 Instruction precision.  The trap handler can determine the exact
9320 instruction that caused a floating point exception.
9321 @end table
9322
9323 Other Alpha compilers provide the equivalent options called
9324 @option{-scope_safe} and @option{-resumption_safe}.
9325
9326 @item -mieee-conformant
9327 @opindex mieee-conformant
9328 This option marks the generated code as IEEE conformant.  You must not
9329 use this option unless you also specify @option{-mtrap-precision=i} and either
9330 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
9331 is to emit the line @samp{.eflag 48} in the function prologue of the
9332 generated assembly file.  Under DEC Unix, this has the effect that
9333 IEEE-conformant math library routines will be linked in.
9334
9335 @item -mbuild-constants
9336 @opindex mbuild-constants
9337 Normally GCC examines a 32- or 64-bit integer constant to
9338 see if it can construct it from smaller constants in two or three
9339 instructions.  If it cannot, it will output the constant as a literal and
9340 generate code to load it from the data segment at runtime.
9341
9342 Use this option to require GCC to construct @emph{all} integer constants
9343 using code, even if it takes more instructions (the maximum is six).
9344
9345 You would typically use this option to build a shared library dynamic
9346 loader.  Itself a shared library, it must relocate itself in memory
9347 before it can find the variables and constants in its own data segment.
9348
9349 @item -malpha-as
9350 @itemx -mgas
9351 @opindex malpha-as
9352 @opindex mgas
9353 Select whether to generate code to be assembled by the vendor-supplied
9354 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
9355
9356 @item -mbwx
9357 @itemx -mno-bwx
9358 @itemx -mcix
9359 @itemx -mno-cix
9360 @itemx -mfix
9361 @itemx -mno-fix
9362 @itemx -mmax
9363 @itemx -mno-max
9364 @opindex mbwx
9365 @opindex mno-bwx
9366 @opindex mcix
9367 @opindex mno-cix
9368 @opindex mfix
9369 @opindex mno-fix
9370 @opindex mmax
9371 @opindex mno-max
9372 Indicate whether GCC should generate code to use the optional BWX,
9373 CIX, FIX and MAX instruction sets.  The default is to use the instruction
9374 sets supported by the CPU type specified via @option{-mcpu=} option or that
9375 of the CPU on which GCC was built if none was specified.
9376
9377 @item -mfloat-vax
9378 @itemx -mfloat-ieee
9379 @opindex mfloat-vax
9380 @opindex mfloat-ieee
9381 Generate code that uses (does not use) VAX F and G floating point
9382 arithmetic instead of IEEE single and double precision.
9383
9384 @item -mexplicit-relocs
9385 @itemx -mno-explicit-relocs
9386 @opindex mexplicit-relocs
9387 @opindex mno-explicit-relocs
9388 Older Alpha assemblers provided no way to generate symbol relocations
9389 except via assembler macros.  Use of these macros does not allow
9390 optimal instruction scheduling.  GNU binutils as of version 2.12
9391 supports a new syntax that allows the compiler to explicitly mark
9392 which relocations should apply to which instructions.  This option
9393 is mostly useful for debugging, as GCC detects the capabilities of
9394 the assembler when it is built and sets the default accordingly.
9395
9396 @item -msmall-data
9397 @itemx -mlarge-data
9398 @opindex msmall-data
9399 @opindex mlarge-data
9400 When @option{-mexplicit-relocs} is in effect, static data is
9401 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
9402 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
9403 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
9404 16-bit relocations off of the @code{$gp} register.  This limits the
9405 size of the small data area to 64KB, but allows the variables to be
9406 directly accessed via a single instruction.
9407
9408 The default is @option{-mlarge-data}.  With this option the data area
9409 is limited to just below 2GB.  Programs that require more than 2GB of
9410 data must use @code{malloc} or @code{mmap} to allocate the data in the
9411 heap instead of in the program's data segment.
9412
9413 When generating code for shared libraries, @option{-fpic} implies
9414 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
9415
9416 @item -msmall-text
9417 @itemx -mlarge-text
9418 @opindex msmall-text
9419 @opindex mlarge-text
9420 When @option{-msmall-text} is used, the compiler assumes that the
9421 code of the entire program (or shared library) fits in 4MB, and is
9422 thus reachable with a branch instruction.  When @option{-msmall-data}
9423 is used, the compiler can assume that all local symbols share the
9424 same @code{$gp} value, and thus reduce the number of instructions
9425 required for a function call from 4 to 1.
9426
9427 The default is @option{-mlarge-text}.
9428
9429 @item -mcpu=@var{cpu_type}
9430 @opindex mcpu
9431 Set the instruction set and instruction scheduling parameters for
9432 machine type @var{cpu_type}.  You can specify either the @samp{EV}
9433 style name or the corresponding chip number.  GCC supports scheduling
9434 parameters for the EV4, EV5 and EV6 family of processors and will
9435 choose the default values for the instruction set from the processor
9436 you specify.  If you do not specify a processor type, GCC will default
9437 to the processor on which the compiler was built.
9438
9439 Supported values for @var{cpu_type} are
9440
9441 @table @samp
9442 @item ev4
9443 @item ev45
9444 @itemx 21064
9445 Schedules as an EV4 and has no instruction set extensions.
9446
9447 @item ev5
9448 @itemx 21164
9449 Schedules as an EV5 and has no instruction set extensions.
9450
9451 @item ev56
9452 @itemx 21164a
9453 Schedules as an EV5 and supports the BWX extension.
9454
9455 @item pca56
9456 @itemx 21164pc
9457 @itemx 21164PC
9458 Schedules as an EV5 and supports the BWX and MAX extensions.
9459
9460 @item ev6
9461 @itemx 21264
9462 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
9463
9464 @item ev67
9465 @item 21264a
9466 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
9467 @end table
9468
9469 @item -mtune=@var{cpu_type}
9470 @opindex mtune
9471 Set only the instruction scheduling parameters for machine type
9472 @var{cpu_type}.  The instruction set is not changed.
9473
9474 @item -mmemory-latency=@var{time}
9475 @opindex mmemory-latency
9476 Sets the latency the scheduler should assume for typical memory
9477 references as seen by the application.  This number is highly
9478 dependent on the memory access patterns used by the application
9479 and the size of the external cache on the machine.
9480
9481 Valid options for @var{time} are
9482
9483 @table @samp
9484 @item @var{number}
9485 A decimal number representing clock cycles.
9486
9487 @item L1
9488 @itemx L2
9489 @itemx L3
9490 @itemx main
9491 The compiler contains estimates of the number of clock cycles for
9492 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9493 (also called Dcache, Scache, and Bcache), as well as to main memory.
9494 Note that L3 is only valid for EV5.
9495
9496 @end table
9497 @end table
9498
9499 @node DEC Alpha/VMS Options
9500 @subsection DEC Alpha/VMS Options
9501
9502 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9503
9504 @table @gcctabopt
9505 @item -mvms-return-codes
9506 @opindex mvms-return-codes
9507 Return VMS condition codes from main.  The default is to return POSIX
9508 style condition (e.g.@ error) codes.
9509 @end table
9510
9511 @node H8/300 Options
9512 @subsection H8/300 Options
9513
9514 These @samp{-m} options are defined for the H8/300 implementations:
9515
9516 @table @gcctabopt
9517 @item -mrelax
9518 @opindex mrelax
9519 Shorten some address references at link time, when possible; uses the
9520 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9521 ld.info, Using ld}, for a fuller description.
9522
9523 @item -mh
9524 @opindex mh
9525 Generate code for the H8/300H@.
9526
9527 @item -ms
9528 @opindex ms
9529 Generate code for the H8S@.
9530
9531 @item -mn
9532 @opindex mn
9533 Generate code for the H8S and H8/300H in the normal mode.  This switch
9534 must be used either with -mh or -ms.
9535
9536 @item -ms2600
9537 @opindex ms2600
9538 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9539
9540 @item -mint32
9541 @opindex mint32
9542 Make @code{int} data 32 bits by default.
9543
9544 @item -malign-300
9545 @opindex malign-300
9546 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9547 The default for the H8/300H and H8S is to align longs and floats on 4
9548 byte boundaries.
9549 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9550 This option has no effect on the H8/300.
9551 @end table
9552
9553 @node SH Options
9554 @subsection SH Options
9555
9556 These @samp{-m} options are defined for the SH implementations:
9557
9558 @table @gcctabopt
9559 @item -m1
9560 @opindex m1
9561 Generate code for the SH1.
9562
9563 @item -m2
9564 @opindex m2
9565 Generate code for the SH2.
9566
9567 @item -m2e
9568 Generate code for the SH2e.
9569
9570 @item -m3
9571 @opindex m3
9572 Generate code for the SH3.
9573
9574 @item -m3e
9575 @opindex m3e
9576 Generate code for the SH3e.
9577
9578 @item -m4-nofpu
9579 @opindex m4-nofpu
9580 Generate code for the SH4 without a floating-point unit.
9581
9582 @item -m4-single-only
9583 @opindex m4-single-only
9584 Generate code for the SH4 with a floating-point unit that only
9585 supports single-precision arithmetic.
9586
9587 @item -m4-single
9588 @opindex m4-single
9589 Generate code for the SH4 assuming the floating-point unit is in
9590 single-precision mode by default.
9591
9592 @item -m4
9593 @opindex m4
9594 Generate code for the SH4.
9595
9596 @item -mb
9597 @opindex mb
9598 Compile code for the processor in big endian mode.
9599
9600 @item -ml
9601 @opindex ml
9602 Compile code for the processor in little endian mode.
9603
9604 @item -mdalign
9605 @opindex mdalign
9606 Align doubles at 64-bit boundaries.  Note that this changes the calling
9607 conventions, and thus some functions from the standard C library will
9608 not work unless you recompile it first with @option{-mdalign}.
9609
9610 @item -mrelax
9611 @opindex mrelax
9612 Shorten some address references at link time, when possible; uses the
9613 linker option @option{-relax}.
9614
9615 @item -mbigtable
9616 @opindex mbigtable
9617 Use 32-bit offsets in @code{switch} tables.  The default is to use
9618 16-bit offsets.
9619
9620 @item -mfmovd
9621 @opindex mfmovd
9622 Enable the use of the instruction @code{fmovd}.
9623
9624 @item -mhitachi
9625 @opindex mhitachi
9626 Comply with the calling conventions defined by Renesas.
9627
9628 @item -mnomacsave
9629 @opindex mnomacsave
9630 Mark the @code{MAC} register as call-clobbered, even if
9631 @option{-mhitachi} is given.
9632
9633 @item -mieee
9634 @opindex mieee
9635 Increase IEEE-compliance of floating-point code.
9636
9637 @item -misize
9638 @opindex misize
9639 Dump instruction size and location in the assembly code.
9640
9641 @item -mpadstruct
9642 @opindex mpadstruct
9643 This option is deprecated.  It pads structures to multiple of 4 bytes,
9644 which is incompatible with the SH ABI@.
9645
9646 @item -mspace
9647 @opindex mspace
9648 Optimize for space instead of speed.  Implied by @option{-Os}.
9649
9650 @item -mprefergot
9651 @opindex mprefergot
9652 When generating position-independent code, emit function calls using
9653 the Global Offset Table instead of the Procedure Linkage Table.
9654
9655 @item -musermode
9656 @opindex musermode
9657 Generate a library function call to invalidate instruction cache
9658 entries, after fixing up a trampoline.  This library function call
9659 doesn't assume it can write to the whole memory address space.  This
9660 is the default when the target is @code{sh-*-linux*}.
9661 @end table
9662
9663 @node System V Options
9664 @subsection Options for System V
9665
9666 These additional options are available on System V Release 4 for
9667 compatibility with other compilers on those systems:
9668
9669 @table @gcctabopt
9670 @item -G
9671 @opindex G
9672 Create a shared object.
9673 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9674
9675 @item -Qy
9676 @opindex Qy
9677 Identify the versions of each tool used by the compiler, in a
9678 @code{.ident} assembler directive in the output.
9679
9680 @item -Qn
9681 @opindex Qn
9682 Refrain from adding @code{.ident} directives to the output file (this is
9683 the default).
9684
9685 @item -YP,@var{dirs}
9686 @opindex YP
9687 Search the directories @var{dirs}, and no others, for libraries
9688 specified with @option{-l}.
9689
9690 @item -Ym,@var{dir}
9691 @opindex Ym
9692 Look in the directory @var{dir} to find the M4 preprocessor.
9693 The assembler uses this option.
9694 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9695 @c the generic assembler that comes with Solaris takes just -Ym.
9696 @end table
9697
9698 @node TMS320C3x/C4x Options
9699 @subsection TMS320C3x/C4x Options
9700 @cindex TMS320C3x/C4x Options
9701
9702 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9703
9704 @table @gcctabopt
9705
9706 @item -mcpu=@var{cpu_type}
9707 @opindex mcpu
9708 Set the instruction set, register set, and instruction scheduling
9709 parameters for machine type @var{cpu_type}.  Supported values for
9710 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9711 @samp{c44}.  The default is @samp{c40} to generate code for the
9712 TMS320C40.
9713
9714 @item -mbig-memory
9715 @item -mbig
9716 @itemx -msmall-memory
9717 @itemx -msmall
9718 @opindex mbig-memory
9719 @opindex mbig
9720 @opindex msmall-memory
9721 @opindex msmall
9722 Generates code for the big or small memory model.  The small memory
9723 model assumed that all data fits into one 64K word page.  At run-time
9724 the data page (DP) register must be set to point to the 64K page
9725 containing the .bss and .data program sections.  The big memory model is
9726 the default and requires reloading of the DP register for every direct
9727 memory access.
9728
9729 @item -mbk
9730 @itemx -mno-bk
9731 @opindex mbk
9732 @opindex mno-bk
9733 Allow (disallow) allocation of general integer operands into the block
9734 count register BK@.
9735
9736 @item -mdb
9737 @itemx -mno-db
9738 @opindex mdb
9739 @opindex mno-db
9740 Enable (disable) generation of code using decrement and branch,
9741 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9742 on the safe side, this is disabled for the C3x, since the maximum
9743 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9744 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9745 that it can utilize the decrement and branch instruction, but will give
9746 up if there is more than one memory reference in the loop.  Thus a loop
9747 where the loop counter is decremented can generate slightly more
9748 efficient code, in cases where the RPTB instruction cannot be utilized.
9749
9750 @item -mdp-isr-reload
9751 @itemx -mparanoid
9752 @opindex mdp-isr-reload
9753 @opindex mparanoid
9754 Force the DP register to be saved on entry to an interrupt service
9755 routine (ISR), reloaded to point to the data section, and restored on
9756 exit from the ISR@.  This should not be required unless someone has
9757 violated the small memory model by modifying the DP register, say within
9758 an object library.
9759
9760 @item -mmpyi
9761 @itemx -mno-mpyi
9762 @opindex mmpyi
9763 @opindex mno-mpyi
9764 For the C3x use the 24-bit MPYI instruction for integer multiplies
9765 instead of a library call to guarantee 32-bit results.  Note that if one
9766 of the operands is a constant, then the multiplication will be performed
9767 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9768 then squaring operations are performed inline instead of a library call.
9769
9770 @item -mfast-fix
9771 @itemx -mno-fast-fix
9772 @opindex mfast-fix
9773 @opindex mno-fast-fix
9774 The C3x/C4x FIX instruction to convert a floating point value to an
9775 integer value chooses the nearest integer less than or equal to the
9776 floating point value rather than to the nearest integer.  Thus if the
9777 floating point number is negative, the result will be incorrectly
9778 truncated an additional code is necessary to detect and correct this
9779 case.  This option can be used to disable generation of the additional
9780 code required to correct the result.
9781
9782 @item -mrptb
9783 @itemx -mno-rptb
9784 @opindex mrptb
9785 @opindex mno-rptb
9786 Enable (disable) generation of repeat block sequences using the RPTB
9787 instruction for zero overhead looping.  The RPTB construct is only used
9788 for innermost loops that do not call functions or jump across the loop
9789 boundaries.  There is no advantage having nested RPTB loops due to the
9790 overhead required to save and restore the RC, RS, and RE registers.
9791 This is enabled by default with @option{-O2}.
9792
9793 @item -mrpts=@var{count}
9794 @itemx -mno-rpts
9795 @opindex mrpts
9796 @opindex mno-rpts
9797 Enable (disable) the use of the single instruction repeat instruction
9798 RPTS@.  If a repeat block contains a single instruction, and the loop
9799 count can be guaranteed to be less than the value @var{count}, GCC will
9800 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9801 then a RPTS will be emitted even if the loop count cannot be determined
9802 at compile time.  Note that the repeated instruction following RPTS does
9803 not have to be reloaded from memory each iteration, thus freeing up the
9804 CPU buses for operands.  However, since interrupts are blocked by this
9805 instruction, it is disabled by default.
9806
9807 @item -mloop-unsigned
9808 @itemx -mno-loop-unsigned
9809 @opindex mloop-unsigned
9810 @opindex mno-loop-unsigned
9811 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9812 is @math{2^{31} + 1} since these instructions test if the iteration count is
9813 negative to terminate the loop.  If the iteration count is unsigned
9814 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9815 exceeded.  This switch allows an unsigned iteration count.
9816
9817 @item -mti
9818 @opindex mti
9819 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9820 with.  This also enforces compatibility with the API employed by the TI
9821 C3x C compiler.  For example, long doubles are passed as structures
9822 rather than in floating point registers.
9823
9824 @item -mregparm
9825 @itemx -mmemparm
9826 @opindex mregparm
9827 @opindex mmemparm
9828 Generate code that uses registers (stack) for passing arguments to functions.
9829 By default, arguments are passed in registers where possible rather
9830 than by pushing arguments on to the stack.
9831
9832 @item -mparallel-insns
9833 @itemx -mno-parallel-insns
9834 @opindex mparallel-insns
9835 @opindex mno-parallel-insns
9836 Allow the generation of parallel instructions.  This is enabled by
9837 default with @option{-O2}.
9838
9839 @item -mparallel-mpy
9840 @itemx -mno-parallel-mpy
9841 @opindex mparallel-mpy
9842 @opindex mno-parallel-mpy
9843 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9844 provided @option{-mparallel-insns} is also specified.  These instructions have
9845 tight register constraints which can pessimize the code generation
9846 of large functions.
9847
9848 @end table
9849
9850 @node V850 Options
9851 @subsection V850 Options
9852 @cindex V850 Options
9853
9854 These @samp{-m} options are defined for V850 implementations:
9855
9856 @table @gcctabopt
9857 @item -mlong-calls
9858 @itemx -mno-long-calls
9859 @opindex mlong-calls
9860 @opindex mno-long-calls
9861 Treat all calls as being far away (near).  If calls are assumed to be
9862 far away, the compiler will always load the functions address up into a
9863 register, and call indirect through the pointer.
9864
9865 @item -mno-ep
9866 @itemx -mep
9867 @opindex mno-ep
9868 @opindex mep
9869 Do not optimize (do optimize) basic blocks that use the same index
9870 pointer 4 or more times to copy pointer into the @code{ep} register, and
9871 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9872 option is on by default if you optimize.
9873
9874 @item -mno-prolog-function
9875 @itemx -mprolog-function
9876 @opindex mno-prolog-function
9877 @opindex mprolog-function
9878 Do not use (do use) external functions to save and restore registers
9879 at the prologue and epilogue of a function.  The external functions
9880 are slower, but use less code space if more than one function saves
9881 the same number of registers.  The @option{-mprolog-function} option
9882 is on by default if you optimize.
9883
9884 @item -mspace
9885 @opindex mspace
9886 Try to make the code as small as possible.  At present, this just turns
9887 on the @option{-mep} and @option{-mprolog-function} options.
9888
9889 @item -mtda=@var{n}
9890 @opindex mtda
9891 Put static or global variables whose size is @var{n} bytes or less into
9892 the tiny data area that register @code{ep} points to.  The tiny data
9893 area can hold up to 256 bytes in total (128 bytes for byte references).
9894
9895 @item -msda=@var{n}
9896 @opindex msda
9897 Put static or global variables whose size is @var{n} bytes or less into
9898 the small data area that register @code{gp} points to.  The small data
9899 area can hold up to 64 kilobytes.
9900
9901 @item -mzda=@var{n}
9902 @opindex mzda
9903 Put static or global variables whose size is @var{n} bytes or less into
9904 the first 32 kilobytes of memory.
9905
9906 @item -mv850
9907 @opindex mv850
9908 Specify that the target processor is the V850.
9909
9910 @item -mbig-switch
9911 @opindex mbig-switch
9912 Generate code suitable for big switch tables.  Use this option only if
9913 the assembler/linker complain about out of range branches within a switch
9914 table.
9915
9916 @item -mapp-regs
9917 @opindex mapp-regs
9918 This option will cause r2 and r5 to be used in the code generated by
9919 the compiler.  This setting is the default.
9920
9921 @item -mno-app-regs
9922 @opindex mno-app-regs
9923 This option will cause r2 and r5 to be treated as fixed registers.
9924   
9925 @item -mv850e1
9926 @opindex mv850e1
9927 Specify that the target processor is the V850E1.  The preprocessor
9928 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
9929 this option is used.
9930
9931 @item -mv850e
9932 @opindex mv850e
9933 Specify that the target processor is the V850E.  The preprocessor
9934 constant @samp{__v850e__} will be defined if this option is used.
9935
9936 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
9937 are defined then a default target processor will be chosen and the
9938 relevant @samp{__v850*__} preprocessor constant will be defined.
9939
9940 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9941 defined, regardless of which processor variant is the target.
9942
9943 @item -mdisable-callt
9944 @opindex mdisable-callt
9945 This option will suppress generation of the CALLT instruction for the
9946 v850e and v850e1 flavors of the v850 architecture.  The default is
9947 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9948
9949 @end table
9950
9951 @node ARC Options
9952 @subsection ARC Options
9953 @cindex ARC Options
9954
9955 These options are defined for ARC implementations:
9956
9957 @table @gcctabopt
9958 @item -EL
9959 @opindex EL
9960 Compile code for little endian mode.  This is the default.
9961
9962 @item -EB
9963 @opindex EB
9964 Compile code for big endian mode.
9965
9966 @item -mmangle-cpu
9967 @opindex mmangle-cpu
9968 Prepend the name of the cpu to all public symbol names.
9969 In multiple-processor systems, there are many ARC variants with different
9970 instruction and register set characteristics.  This flag prevents code
9971 compiled for one cpu to be linked with code compiled for another.
9972 No facility exists for handling variants that are ``almost identical''.
9973 This is an all or nothing option.
9974
9975 @item -mcpu=@var{cpu}
9976 @opindex mcpu
9977 Compile code for ARC variant @var{cpu}.
9978 Which variants are supported depend on the configuration.
9979 All variants support @option{-mcpu=base}, this is the default.
9980
9981 @item -mtext=@var{text-section}
9982 @itemx -mdata=@var{data-section}
9983 @itemx -mrodata=@var{readonly-data-section}
9984 @opindex mtext
9985 @opindex mdata
9986 @opindex mrodata
9987 Put functions, data, and readonly data in @var{text-section},
9988 @var{data-section}, and @var{readonly-data-section} respectively
9989 by default.  This can be overridden with the @code{section} attribute.
9990 @xref{Variable Attributes}.
9991
9992 @end table
9993
9994 @node NS32K Options
9995 @subsection NS32K Options
9996 @cindex NS32K options
9997
9998 These are the @samp{-m} options defined for the 32000 series.  The default
9999 values for these options depends on which style of 32000 was selected when
10000 the compiler was configured; the defaults for the most common choices are
10001 given below.
10002
10003 @table @gcctabopt
10004 @item -m32032
10005 @itemx -m32032
10006 @opindex m32032
10007 @opindex m32032
10008 Generate output for a 32032.  This is the default
10009 when the compiler is configured for 32032 and 32016 based systems.
10010
10011 @item -m32332
10012 @itemx -m32332
10013 @opindex m32332
10014 @opindex m32332
10015 Generate output for a 32332.  This is the default
10016 when the compiler is configured for 32332-based systems.
10017
10018 @item -m32532
10019 @itemx -m32532
10020 @opindex m32532
10021 @opindex m32532
10022 Generate output for a 32532.  This is the default
10023 when the compiler is configured for 32532-based systems.
10024
10025 @item -m32081
10026 @opindex m32081
10027 Generate output containing 32081 instructions for floating point.
10028 This is the default for all systems.
10029
10030 @item -m32381
10031 @opindex m32381
10032 Generate output containing 32381 instructions for floating point.  This
10033 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10034 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10035
10036 @item -mmulti-add
10037 @opindex mmulti-add
10038 Try and generate multiply-add floating point instructions @code{polyF}
10039 and @code{dotF}.  This option is only available if the @option{-m32381}
10040 option is in effect.  Using these instructions requires changes to
10041 register allocation which generally has a negative impact on
10042 performance.  This option should only be enabled when compiling code
10043 particularly likely to make heavy use of multiply-add instructions.
10044
10045 @item -mnomulti-add
10046 @opindex mnomulti-add
10047 Do not try and generate multiply-add floating point instructions
10048 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10049
10050 @item -msoft-float
10051 @opindex msoft-float
10052 Generate output containing library calls for floating point.
10053 @strong{Warning:} the requisite libraries may not be available.
10054
10055 @item -mieee-compare
10056 @itemx -mno-ieee-compare
10057 @opindex mieee-compare
10058 @opindex mno-ieee-compare
10059 Control whether or not the compiler uses IEEE floating point
10060 comparisons.  These handle correctly the case where the result of a
10061 comparison is unordered.
10062 @strong{Warning:} the requisite kernel support may not be available.
10063
10064 @item -mnobitfield
10065 @opindex mnobitfield
10066 Do not use the bit-field instructions.  On some machines it is faster to
10067 use shifting and masking operations.  This is the default for the pc532.
10068
10069 @item -mbitfield
10070 @opindex mbitfield
10071 Do use the bit-field instructions.  This is the default for all platforms
10072 except the pc532.
10073
10074 @item -mrtd
10075 @opindex mrtd
10076 Use a different function-calling convention, in which functions
10077 that take a fixed number of arguments return pop their
10078 arguments on return with the @code{ret} instruction.
10079
10080 This calling convention is incompatible with the one normally
10081 used on Unix, so you cannot use it if you need to call libraries
10082 compiled with the Unix compiler.
10083
10084 Also, you must provide function prototypes for all functions that
10085 take variable numbers of arguments (including @code{printf});
10086 otherwise incorrect code will be generated for calls to those
10087 functions.
10088
10089 In addition, seriously incorrect code will result if you call a
10090 function with too many arguments.  (Normally, extra arguments are
10091 harmlessly ignored.)
10092
10093 This option takes its name from the 680x0 @code{rtd} instruction.
10094
10095
10096 @item -mregparam
10097 @opindex mregparam
10098 Use a different function-calling convention where the first two arguments
10099 are passed in registers.
10100
10101 This calling convention is incompatible with the one normally
10102 used on Unix, so you cannot use it if you need to call libraries
10103 compiled with the Unix compiler.
10104
10105 @item -mnoregparam
10106 @opindex mnoregparam
10107 Do not pass any arguments in registers.  This is the default for all
10108 targets.
10109
10110 @item -msb
10111 @opindex msb
10112 It is OK to use the sb as an index register which is always loaded with
10113 zero.  This is the default for the pc532-netbsd target.
10114
10115 @item -mnosb
10116 @opindex mnosb
10117 The sb register is not available for use or has not been initialized to
10118 zero by the run time system.  This is the default for all targets except
10119 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10120 @option{-fpic} is set.
10121
10122 @item -mhimem
10123 @opindex mhimem
10124 Many ns32000 series addressing modes use displacements of up to 512MB@.
10125 If an address is above 512MB then displacements from zero can not be used.
10126 This option causes code to be generated which can be loaded above 512MB@.
10127 This may be useful for operating systems or ROM code.
10128
10129 @item -mnohimem
10130 @opindex mnohimem
10131 Assume code will be loaded in the first 512MB of virtual address space.
10132 This is the default for all platforms.
10133
10134
10135 @end table
10136
10137 @node AVR Options
10138 @subsection AVR Options
10139 @cindex AVR Options
10140
10141 These options are defined for AVR implementations:
10142
10143 @table @gcctabopt
10144 @item -mmcu=@var{mcu}
10145 @opindex mmcu
10146 Specify ATMEL AVR instruction set or MCU type.
10147
10148 Instruction set avr1 is for the minimal AVR core, not supported by the C
10149 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10150 attiny11, attiny12, attiny15, attiny28).
10151
10152 Instruction set avr2 (default) is for the classic AVR core with up to
10153 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10154 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10155 at90c8534, at90s8535).
10156
10157 Instruction set avr3 is for the classic AVR core with up to 128K program
10158 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10159
10160 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10161 memory space (MCU types: atmega8, atmega83, atmega85).
10162
10163 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10164 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10165 atmega64, atmega128, at43usb355, at94k).
10166
10167 @item -msize
10168 @opindex msize
10169 Output instruction sizes to the asm file.
10170
10171 @item -minit-stack=@var{N}
10172 @opindex minit-stack
10173 Specify the initial stack address, which may be a symbol or numeric value,
10174 @samp{__stack} is the default.
10175
10176 @item -mno-interrupts
10177 @opindex mno-interrupts
10178 Generated code is not compatible with hardware interrupts.
10179 Code size will be smaller.
10180
10181 @item -mcall-prologues
10182 @opindex mcall-prologues
10183 Functions prologues/epilogues expanded as call to appropriate
10184 subroutines.  Code size will be smaller.
10185
10186 @item -mno-tablejump
10187 @opindex mno-tablejump
10188 Do not generate tablejump insns which sometimes increase code size.
10189
10190 @item -mtiny-stack
10191 @opindex mtiny-stack
10192 Change only the low 8 bits of the stack pointer.
10193 @end table
10194
10195 @node MCore Options
10196 @subsection MCore Options
10197 @cindex MCore options
10198
10199 These are the @samp{-m} options defined for the Motorola M*Core
10200 processors.
10201
10202 @table @gcctabopt
10203
10204 @item -mhardlit
10205 @itemx -mno-hardlit
10206 @opindex mhardlit
10207 @opindex mno-hardlit
10208 Inline constants into the code stream if it can be done in two
10209 instructions or less.
10210
10211 @item -mdiv
10212 @itemx -mno-div
10213 @opindex mdiv
10214 @opindex mno-div
10215 Use the divide instruction.  (Enabled by default).
10216
10217 @item -mrelax-immediate
10218 @itemx -mno-relax-immediate
10219 @opindex mrelax-immediate
10220 @opindex mno-relax-immediate
10221 Allow arbitrary sized immediates in bit operations.
10222
10223 @item -mwide-bitfields
10224 @itemx -mno-wide-bitfields
10225 @opindex mwide-bitfields
10226 @opindex mno-wide-bitfields
10227 Always treat bit-fields as int-sized.
10228
10229 @item -m4byte-functions
10230 @itemx -mno-4byte-functions
10231 @opindex m4byte-functions
10232 @opindex mno-4byte-functions
10233 Force all functions to be aligned to a four byte boundary.
10234
10235 @item -mcallgraph-data
10236 @itemx -mno-callgraph-data
10237 @opindex mcallgraph-data
10238 @opindex mno-callgraph-data
10239 Emit callgraph information.
10240
10241 @item -mslow-bytes
10242 @itemx -mno-slow-bytes
10243 @opindex mslow-bytes
10244 @opindex mno-slow-bytes
10245 Prefer word access when reading byte quantities.
10246
10247 @item -mlittle-endian
10248 @itemx -mbig-endian
10249 @opindex mlittle-endian
10250 @opindex mbig-endian
10251 Generate code for a little endian target.
10252
10253 @item -m210
10254 @itemx -m340
10255 @opindex m210
10256 @opindex m340
10257 Generate code for the 210 processor.
10258 @end table
10259
10260 @node IA-64 Options
10261 @subsection IA-64 Options
10262 @cindex IA-64 Options
10263
10264 These are the @samp{-m} options defined for the Intel IA-64 architecture.
10265
10266 @table @gcctabopt
10267 @item -mbig-endian
10268 @opindex mbig-endian
10269 Generate code for a big endian target.  This is the default for HP-UX@.
10270
10271 @item -mlittle-endian
10272 @opindex mlittle-endian
10273 Generate code for a little endian target.  This is the default for AIX5
10274 and Linux.
10275
10276 @item -mgnu-as
10277 @itemx -mno-gnu-as
10278 @opindex mgnu-as
10279 @opindex mno-gnu-as
10280 Generate (or don't) code for the GNU assembler.  This is the default.
10281 @c Also, this is the default if the configure option @option{--with-gnu-as}
10282 @c is used.
10283
10284 @item -mgnu-ld
10285 @itemx -mno-gnu-ld
10286 @opindex mgnu-ld
10287 @opindex mno-gnu-ld
10288 Generate (or don't) code for the GNU linker.  This is the default.
10289 @c Also, this is the default if the configure option @option{--with-gnu-ld}
10290 @c is used.
10291
10292 @item -mno-pic
10293 @opindex mno-pic
10294 Generate code that does not use a global pointer register.  The result
10295 is not position independent code, and violates the IA-64 ABI@.
10296
10297 @item -mvolatile-asm-stop
10298 @itemx -mno-volatile-asm-stop
10299 @opindex mvolatile-asm-stop
10300 @opindex mno-volatile-asm-stop
10301 Generate (or don't) a stop bit immediately before and after volatile asm
10302 statements.
10303
10304 @item -mb-step
10305 @opindex mb-step
10306 Generate code that works around Itanium B step errata.
10307
10308 @item -mregister-names
10309 @itemx -mno-register-names
10310 @opindex mregister-names
10311 @opindex mno-register-names
10312 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
10313 the stacked registers.  This may make assembler output more readable.
10314
10315 @item -mno-sdata
10316 @itemx -msdata
10317 @opindex mno-sdata
10318 @opindex msdata
10319 Disable (or enable) optimizations that use the small data section.  This may
10320 be useful for working around optimizer bugs.
10321
10322 @item -mconstant-gp
10323 @opindex mconstant-gp
10324 Generate code that uses a single constant global pointer value.  This is
10325 useful when compiling kernel code.
10326
10327 @item -mauto-pic
10328 @opindex mauto-pic
10329 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
10330 This is useful when compiling firmware code.
10331
10332 @item -minline-float-divide-min-latency
10333 @opindex minline-float-divide-min-latency
10334 Generate code for inline divides of floating point values
10335 using the minimum latency algorithm.
10336
10337 @item -minline-float-divide-max-throughput
10338 @opindex minline-float-divide-max-throughput
10339 Generate code for inline divides of floating point values
10340 using the maximum throughput algorithm.
10341
10342 @item -minline-int-divide-min-latency
10343 @opindex minline-int-divide-min-latency
10344 Generate code for inline divides of integer values
10345 using the minimum latency algorithm.
10346
10347 @item -minline-int-divide-max-throughput
10348 @opindex minline-int-divide-max-throughput
10349 Generate code for inline divides of integer values
10350 using the maximum throughput algorithm.
10351
10352 @item -mno-dwarf2-asm
10353 @itemx -mdwarf2-asm
10354 @opindex mno-dwarf2-asm
10355 @opindex mdwarf2-asm
10356 Don't (or do) generate assembler code for the DWARF2 line number debugging
10357 info.  This may be useful when not using the GNU assembler.
10358
10359 @item -mfixed-range=@var{register-range}
10360 @opindex mfixed-range
10361 Generate code treating the given register range as fixed registers.
10362 A fixed register is one that the register allocator can not use.  This is
10363 useful when compiling kernel code.  A register range is specified as
10364 two registers separated by a dash.  Multiple register ranges can be
10365 specified separated by a comma.
10366
10367 @item -mearly-stop-bits
10368 @itemx -mno-early-stop-bits
10369 @opindex mearly-stop-bits
10370 @opindex mno-early-stop-bits
10371 Allow stop bits to be placed earlier than immediately preceding the
10372 instruction that triggered the stop bit.  This can improve instruction
10373 scheduling, but does not always do so.
10374 @end table
10375
10376 @node D30V Options
10377 @subsection D30V Options
10378 @cindex D30V Options
10379
10380 These @samp{-m} options are defined for D30V implementations:
10381
10382 @table @gcctabopt
10383 @item -mextmem
10384 @opindex mextmem
10385 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
10386 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
10387 memory, which starts at location @code{0x80000000}.
10388
10389 @item -mextmemory
10390 @opindex mextmemory
10391 Same as the @option{-mextmem} switch.
10392
10393 @item -monchip
10394 @opindex monchip
10395 Link the @samp{.text} section into onchip text memory, which starts at
10396 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
10397 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
10398 into onchip data memory, which starts at location @code{0x20000000}.
10399
10400 @item -mno-asm-optimize
10401 @itemx -masm-optimize
10402 @opindex mno-asm-optimize
10403 @opindex masm-optimize
10404 Disable (enable) passing @option{-O} to the assembler when optimizing.
10405 The assembler uses the @option{-O} option to automatically parallelize
10406 adjacent short instructions where possible.
10407
10408 @item -mbranch-cost=@var{n}
10409 @opindex mbranch-cost
10410 Increase the internal costs of branches to @var{n}.  Higher costs means
10411 that the compiler will issue more instructions to avoid doing a branch.
10412 The default is 2.
10413
10414 @item -mcond-exec=@var{n}
10415 @opindex mcond-exec
10416 Specify the maximum number of conditionally executed instructions that
10417 replace a branch.  The default is 4.
10418 @end table
10419
10420 @node S/390 and zSeries Options
10421 @subsection S/390 and zSeries Options
10422 @cindex S/390 and zSeries Options
10423
10424 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10425
10426 @table @gcctabopt
10427 @item -mhard-float
10428 @itemx -msoft-float
10429 @opindex mhard-float
10430 @opindex msoft-float
10431 Use (do not use) the hardware floating-point instructions and registers
10432 for floating-point operations.  When @option{-msoft-float} is specified,
10433 functions in @file{libgcc.a} will be used to perform floating-point
10434 operations.  When @option{-mhard-float} is specified, the compiler
10435 generates IEEE floating-point instructions.  This is the default.
10436
10437 @item -mbackchain
10438 @itemx -mno-backchain
10439 @opindex mbackchain
10440 @opindex mno-backchain
10441 Generate (or do not generate) code which maintains an explicit
10442 backchain within the stack frame that points to the caller's frame.
10443 This is currently needed to allow debugging.  The default is to
10444 generate the backchain.
10445
10446 @item -msmall-exec
10447 @itemx -mno-small-exec
10448 @opindex msmall-exec
10449 @opindex mno-small-exec
10450 Generate (or do not generate) code using the @code{bras} instruction
10451 to do subroutine calls.
10452 This only works reliably if the total executable size does not
10453 exceed 64k.  The default is to use the @code{basr} instruction instead,
10454 which does not have this limitation.
10455
10456 @item -m64
10457 @itemx -m31
10458 @opindex m64
10459 @opindex m31
10460 When @option{-m31} is specified, generate code compliant to the
10461 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10462 code compliant to the Linux for zSeries ABI@.  This allows GCC in
10463 particular to generate 64-bit instructions.  For the @samp{s390}
10464 targets, the default is @option{-m31}, while the @samp{s390x}
10465 targets default to @option{-m64}.
10466
10467 @item -mzarch
10468 @itemx -mesa
10469 @opindex mzarch
10470 @opindex mesa
10471 When @option{-mzarch} is specified, generate code using the 
10472 instructions available on z/Architecture. 
10473 When @option{-mesa} is specified, generate code using the 
10474 instructions available on ESA/390. Note that @option{-mesa} is
10475 not possible with @option{-m64}.
10476 When generating code compliant to the Linux for S/390 ABI,
10477 the default is @option{-mesa}.  When generating code compliant
10478 to the Linux for zSeries ABI, the default is @option{-mzarch}.
10479
10480 @item -mmvcle
10481 @itemx -mno-mvcle
10482 @opindex mmvcle
10483 @opindex mno-mvcle
10484 Generate (or do not generate) code using the @code{mvcle} instruction
10485 to perform block moves.  When @option{-mno-mvcle} is specified,
10486 use a @code{mvc} loop instead.  This is the default.
10487
10488 @item -mdebug
10489 @itemx -mno-debug
10490 @opindex mdebug
10491 @opindex mno-debug
10492 Print (or do not print) additional debug information when compiling.
10493 The default is to not print debug information.
10494
10495 @item -march=@var{cpu-type}
10496 @opindex march
10497 Generate code that will run on @var{cpu-type}, which is the name of a system
10498 representing a certain processor type. Possible values for
10499 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10500 When generating code using the instructions available on z/Architecture,
10501 the default is @option{-march=z900}.  Otherwise, the default is
10502 @option{-march=g5}.
10503
10504 @item -mtune=@var{cpu-type}
10505 @opindex mtune
10506 Tune to @var{cpu-type} everything applicable about the generated code,
10507 except for the ABI and the set of available instructions.
10508 The list of @var{cpu-type} values is the same as for @option{-march}.
10509 The default is the value used for @option{-march}.
10510
10511 @item -mfused-madd
10512 @itemx -mno-fused-madd
10513 @opindex mfused-madd
10514 @opindex mno-fused-madd
10515 Generate code that uses (does not use) the floating point multiply and
10516 accumulate instructions.  These instructions are generated by default if
10517 hardware floating point is used.
10518 @end table
10519
10520 @node CRIS Options
10521 @subsection CRIS Options
10522 @cindex CRIS Options
10523
10524 These options are defined specifically for the CRIS ports.
10525
10526 @table @gcctabopt
10527 @item -march=@var{architecture-type}
10528 @itemx -mcpu=@var{architecture-type}
10529 @opindex march
10530 @opindex mcpu
10531 Generate code for the specified architecture.  The choices for
10532 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10533 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10534 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10535 @samp{v10}.
10536
10537 @item -mtune=@var{architecture-type}
10538 @opindex mtune
10539 Tune to @var{architecture-type} everything applicable about the generated
10540 code, except for the ABI and the set of available instructions.  The
10541 choices for @var{architecture-type} are the same as for
10542 @option{-march=@var{architecture-type}}.
10543
10544 @item -mmax-stack-frame=@var{n}
10545 @opindex mmax-stack-frame
10546 Warn when the stack frame of a function exceeds @var{n} bytes.
10547
10548 @item -melinux-stacksize=@var{n}
10549 @opindex melinux-stacksize
10550 Only available with the @samp{cris-axis-aout} target.  Arranges for
10551 indications in the program to the kernel loader that the stack of the
10552 program should be set to @var{n} bytes.
10553
10554 @item -metrax4
10555 @itemx -metrax100
10556 @opindex metrax4
10557 @opindex metrax100
10558 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10559 @option{-march=v3} and @option{-march=v8} respectively.
10560
10561 @item -mpdebug
10562 @opindex mpdebug
10563 Enable CRIS-specific verbose debug-related information in the assembly
10564 code.  This option also has the effect to turn off the @samp{#NO_APP}
10565 formatted-code indicator to the assembler at the beginning of the
10566 assembly file.
10567
10568 @item -mcc-init
10569 @opindex mcc-init
10570 Do not use condition-code results from previous instruction; always emit
10571 compare and test instructions before use of condition codes.
10572
10573 @item -mno-side-effects
10574 @opindex mno-side-effects
10575 Do not emit instructions with side-effects in addressing modes other than
10576 post-increment.
10577
10578 @item -mstack-align
10579 @itemx -mno-stack-align
10580 @itemx -mdata-align
10581 @itemx -mno-data-align
10582 @itemx -mconst-align
10583 @itemx -mno-const-align
10584 @opindex mstack-align
10585 @opindex mno-stack-align
10586 @opindex mdata-align
10587 @opindex mno-data-align
10588 @opindex mconst-align
10589 @opindex mno-const-align
10590 These options (no-options) arranges (eliminate arrangements) for the
10591 stack-frame, individual data and constants to be aligned for the maximum
10592 single data access size for the chosen CPU model.  The default is to
10593 arrange for 32-bit alignment.  ABI details such as structure layout are
10594 not affected by these options.
10595
10596 @item -m32-bit
10597 @itemx -m16-bit
10598 @itemx -m8-bit
10599 @opindex m32-bit
10600 @opindex m16-bit
10601 @opindex m8-bit
10602 Similar to the stack- data- and const-align options above, these options
10603 arrange for stack-frame, writable data and constants to all be 32-bit,
10604 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10605
10606 @item -mno-prologue-epilogue
10607 @itemx -mprologue-epilogue
10608 @opindex mno-prologue-epilogue
10609 @opindex mprologue-epilogue
10610 With @option{-mno-prologue-epilogue}, the normal function prologue and
10611 epilogue that sets up the stack-frame are omitted and no return
10612 instructions or return sequences are generated in the code.  Use this
10613 option only together with visual inspection of the compiled code: no
10614 warnings or errors are generated when call-saved registers must be saved,
10615 or storage for local variable needs to be allocated.
10616
10617 @item -mno-gotplt
10618 @itemx -mgotplt
10619 @opindex mno-gotplt
10620 @opindex mgotplt
10621 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10622 instruction sequences that load addresses for functions from the PLT part
10623 of the GOT rather than (traditional on other architectures) calls to the
10624 PLT.  The default is @option{-mgotplt}.
10625
10626 @item -maout
10627 @opindex maout
10628 Legacy no-op option only recognized with the cris-axis-aout target.
10629
10630 @item -melf
10631 @opindex melf
10632 Legacy no-op option only recognized with the cris-axis-elf and
10633 cris-axis-linux-gnu targets.
10634
10635 @item -melinux
10636 @opindex melinux
10637 Only recognized with the cris-axis-aout target, where it selects a
10638 GNU/linux-like multilib, include files and instruction set for
10639 @option{-march=v8}.
10640
10641 @item -mlinux
10642 @opindex mlinux
10643 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10644
10645 @item -sim
10646 @opindex sim
10647 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10648 to link with input-output functions from a simulator library.  Code,
10649 initialized data and zero-initialized data are allocated consecutively.
10650
10651 @item -sim2
10652 @opindex sim2
10653 Like @option{-sim}, but pass linker options to locate initialized data at
10654 0x40000000 and zero-initialized data at 0x80000000.
10655 @end table
10656
10657 @node MMIX Options
10658 @subsection MMIX Options
10659 @cindex MMIX Options
10660
10661 These options are defined for the MMIX:
10662
10663 @table @gcctabopt
10664 @item -mlibfuncs
10665 @itemx -mno-libfuncs
10666 @opindex mlibfuncs
10667 @opindex mno-libfuncs
10668 Specify that intrinsic library functions are being compiled, passing all
10669 values in registers, no matter the size.
10670
10671 @item -mepsilon
10672 @itemx -mno-epsilon
10673 @opindex mepsilon
10674 @opindex mno-epsilon
10675 Generate floating-point comparison instructions that compare with respect
10676 to the @code{rE} epsilon register.
10677
10678 @item -mabi=mmixware
10679 @itemx -mabi=gnu
10680 @opindex mabi-mmixware
10681 @opindex mabi=gnu
10682 Generate code that passes function parameters and return values that (in
10683 the called function) are seen as registers @code{$0} and up, as opposed to
10684 the GNU ABI which uses global registers @code{$231} and up.
10685
10686 @item -mzero-extend
10687 @itemx -mno-zero-extend
10688 @opindex mzero-extend
10689 @opindex mno-zero-extend
10690 When reading data from memory in sizes shorter than 64 bits, use (do not
10691 use) zero-extending load instructions by default, rather than
10692 sign-extending ones.
10693
10694 @item -mknuthdiv
10695 @itemx -mno-knuthdiv
10696 @opindex mknuthdiv
10697 @opindex mno-knuthdiv
10698 Make the result of a division yielding a remainder have the same sign as
10699 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10700 remainder follows the sign of the dividend.  Both methods are
10701 arithmetically valid, the latter being almost exclusively used.
10702
10703 @item -mtoplevel-symbols
10704 @itemx -mno-toplevel-symbols
10705 @opindex mtoplevel-symbols
10706 @opindex mno-toplevel-symbols
10707 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10708 code can be used with the @code{PREFIX} assembly directive.
10709
10710 @item -melf
10711 @opindex melf
10712 Generate an executable in the ELF format, rather than the default
10713 @samp{mmo} format used by the @command{mmix} simulator.
10714
10715 @item -mbranch-predict
10716 @itemx -mno-branch-predict
10717 @opindex mbranch-predict
10718 @opindex mno-branch-predict
10719 Use (do not use) the probable-branch instructions, when static branch
10720 prediction indicates a probable branch.
10721
10722 @item -mbase-addresses
10723 @itemx -mno-base-addresses
10724 @opindex mbase-addresses
10725 @opindex mno-base-addresses
10726 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10727 base address automatically generates a request (handled by the assembler
10728 and the linker) for a constant to be set up in a global register.  The
10729 register is used for one or more base address requests within the range 0
10730 to 255 from the value held in the register.  The generally leads to short
10731 and fast code, but the number of different data items that can be
10732 addressed is limited.  This means that a program that uses lots of static
10733 data may require @option{-mno-base-addresses}.
10734
10735 @item -msingle-exit
10736 @itemx -mno-single-exit
10737 @opindex msingle-exit
10738 @opindex mno-single-exit
10739 Force (do not force) generated code to have a single exit point in each
10740 function.
10741 @end table
10742
10743 @node PDP-11 Options
10744 @subsection PDP-11 Options
10745 @cindex PDP-11 Options
10746
10747 These options are defined for the PDP-11:
10748
10749 @table @gcctabopt
10750 @item -mfpu
10751 @opindex mfpu
10752 Use hardware FPP floating point.  This is the default.  (FIS floating
10753 point on the PDP-11/40 is not supported.)
10754
10755 @item -msoft-float
10756 @opindex msoft-float
10757 Do not use hardware floating point.
10758
10759 @item -mac0
10760 @opindex mac0
10761 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10762
10763 @item -mno-ac0
10764 @opindex mno-ac0
10765 Return floating-point results in memory.  This is the default.
10766
10767 @item -m40
10768 @opindex m40
10769 Generate code for a PDP-11/40.
10770
10771 @item -m45
10772 @opindex m45
10773 Generate code for a PDP-11/45.  This is the default.
10774
10775 @item -m10
10776 @opindex m10
10777 Generate code for a PDP-11/10.
10778
10779 @item -mbcopy-builtin
10780 @opindex bcopy-builtin
10781 Use inline @code{movstrhi} patterns for copying memory.  This is the
10782 default.
10783
10784 @item -mbcopy
10785 @opindex mbcopy
10786 Do not use inline @code{movstrhi} patterns for copying memory.
10787
10788 @item -mint16
10789 @itemx -mno-int32
10790 @opindex mint16
10791 @opindex mno-int32
10792 Use 16-bit @code{int}.  This is the default.
10793
10794 @item -mint32
10795 @itemx -mno-int16
10796 @opindex mint32
10797 @opindex mno-int16
10798 Use 32-bit @code{int}.
10799
10800 @item -mfloat64
10801 @itemx -mno-float32
10802 @opindex mfloat64
10803 @opindex mno-float32
10804 Use 64-bit @code{float}.  This is the default.
10805
10806 @item -mfloat32
10807 @item -mno-float64
10808 @opindex mfloat32
10809 @opindex mno-float64
10810 Use 32-bit @code{float}.
10811
10812 @item -mabshi
10813 @opindex mabshi
10814 Use @code{abshi2} pattern.  This is the default.
10815
10816 @item -mno-abshi
10817 @opindex mno-abshi
10818 Do not use @code{abshi2} pattern.
10819
10820 @item -mbranch-expensive
10821 @opindex mbranch-expensive
10822 Pretend that branches are expensive.  This is for experimenting with
10823 code generation only.
10824
10825 @item -mbranch-cheap
10826 @opindex mbranch-cheap
10827 Do not pretend that branches are expensive.  This is the default.
10828
10829 @item -msplit
10830 @opindex msplit
10831 Generate code for a system with split I&D.
10832
10833 @item -mno-split
10834 @opindex mno-split
10835 Generate code for a system without split I&D.  This is the default.
10836
10837 @item -munix-asm
10838 @opindex munix-asm
10839 Use Unix assembler syntax.  This is the default when configured for
10840 @samp{pdp11-*-bsd}.
10841
10842 @item -mdec-asm
10843 @opindex mdec-asm
10844 Use DEC assembler syntax.  This is the default when configured for any
10845 PDP-11 target other than @samp{pdp11-*-bsd}.
10846 @end table
10847
10848 @node Xstormy16 Options
10849 @subsection Xstormy16 Options
10850 @cindex Xstormy16 Options
10851
10852 These options are defined for Xstormy16:
10853
10854 @table @gcctabopt
10855 @item -msim
10856 @opindex msim
10857 Choose startup files and linker script suitable for the simulator.
10858 @end table
10859
10860 @node FRV Options
10861 @subsection FRV Options
10862 @cindex FRV Options
10863
10864 @table @gcctabopt
10865 @item -mgpr-32
10866 @opindex mgpr-32
10867
10868 Only use the first 32 general purpose registers.
10869
10870 @item -mgpr-64
10871 @opindex mgpr-64
10872
10873 Use all 64 general purpose registers.
10874
10875 @item -mfpr-32
10876 @opindex mfpr-32
10877
10878 Use only the first 32 floating point registers.
10879
10880 @item -mfpr-64
10881 @opindex mfpr-64
10882
10883 Use all 64 floating point registers
10884
10885 @item -mhard-float
10886 @opindex mhard-float
10887
10888 Use hardware instructions for floating point operations.
10889
10890 @item -msoft-float
10891 @opindex msoft-float
10892
10893 Use library routines for floating point operations.
10894
10895 @item -malloc-cc
10896 @opindex malloc-cc
10897
10898 Dynamically allocate condition code registers.
10899
10900 @item -mfixed-cc
10901 @opindex mfixed-cc
10902
10903 Do not try to dynamically allocate condition code registers, only
10904 use @code{icc0} and @code{fcc0}.
10905
10906 @item -mdword
10907 @opindex mdword
10908
10909 Change ABI to use double word insns.
10910
10911 @item -mno-dword
10912 @opindex mno-dword
10913
10914 Do not use double word instructions.
10915
10916 @item -mdouble
10917 @opindex mdouble
10918
10919 Use floating point double instructions.
10920
10921 @item -mno-double
10922 @opindex mno-double
10923
10924 Do not use floating point double instructions.
10925
10926 @item -mmedia
10927 @opindex mmedia
10928
10929 Use media instructions.
10930
10931 @item -mno-media
10932 @opindex mno-media
10933
10934 Do not use media instructions.
10935
10936 @item -mmuladd
10937 @opindex mmuladd
10938
10939 Use multiply and add/subtract instructions.
10940
10941 @item -mno-muladd
10942 @opindex mno-muladd
10943
10944 Do not use multiply and add/subtract instructions.
10945
10946 @item -mlibrary-pic
10947 @opindex mlibrary-pic
10948
10949 Enable PIC support for building libraries
10950
10951 @item -macc-4
10952 @opindex macc-4
10953
10954 Use only the first four media accumulator registers.
10955
10956 @item -macc-8
10957 @opindex macc-8
10958
10959 Use all eight media accumulator registers.
10960
10961 @item -mpack
10962 @opindex mpack
10963
10964 Pack VLIW instructions.
10965
10966 @item -mno-pack
10967 @opindex mno-pack
10968
10969 Do not pack VLIW instructions.
10970
10971 @item -mno-eflags
10972 @opindex mno-eflags
10973
10974 Do not mark ABI switches in e_flags.
10975
10976 @item -mcond-move
10977 @opindex mcond-move
10978
10979 Enable the use of conditional-move instructions (default).
10980
10981 This switch is mainly for debugging the compiler and will likely be removed
10982 in a future version.
10983
10984 @item -mno-cond-move
10985 @opindex mno-cond-move
10986
10987 Disable the use of conditional-move instructions.
10988
10989 This switch is mainly for debugging the compiler and will likely be removed
10990 in a future version.
10991
10992 @item -mscc
10993 @opindex mscc
10994
10995 Enable the use of conditional set instructions (default).
10996
10997 This switch is mainly for debugging the compiler and will likely be removed
10998 in a future version.
10999
11000 @item -mno-scc
11001 @opindex mno-scc
11002
11003 Disable the use of conditional set instructions.
11004
11005 This switch is mainly for debugging the compiler and will likely be removed
11006 in a future version.
11007
11008 @item -mcond-exec
11009 @opindex mcond-exec
11010
11011 Enable the use of conditional execution (default).
11012
11013 This switch is mainly for debugging the compiler and will likely be removed
11014 in a future version.
11015
11016 @item -mno-cond-exec
11017 @opindex mno-cond-exec
11018
11019 Disable the use of conditional execution.
11020
11021 This switch is mainly for debugging the compiler and will likely be removed
11022 in a future version.
11023
11024 @item -mvliw-branch
11025 @opindex mvliw-branch
11026
11027 Run a pass to pack branches into VLIW instructions (default).
11028
11029 This switch is mainly for debugging the compiler and will likely be removed
11030 in a future version.
11031
11032 @item -mno-vliw-branch
11033 @opindex mno-vliw-branch
11034
11035 Do not run a pass to pack branches into VLIW instructions.
11036
11037 This switch is mainly for debugging the compiler and will likely be removed
11038 in a future version.
11039
11040 @item -mmulti-cond-exec
11041 @opindex mmulti-cond-exec
11042
11043 Enable optimization of @code{&&} and @code{||} in conditional execution
11044 (default).
11045
11046 This switch is mainly for debugging the compiler and will likely be removed
11047 in a future version.
11048
11049 @item -mno-multi-cond-exec
11050 @opindex mno-multi-cond-exec
11051
11052 Disable optimization of @code{&&} and @code{||} in conditional execution.
11053
11054 This switch is mainly for debugging the compiler and will likely be removed
11055 in a future version.
11056
11057 @item -mnested-cond-exec
11058 @opindex mnested-cond-exec
11059
11060 Enable nested conditional execution optimizations (default).
11061
11062 This switch is mainly for debugging the compiler and will likely be removed
11063 in a future version.
11064
11065 @item -mno-nested-cond-exec
11066 @opindex mno-nested-cond-exec
11067
11068 Disable nested conditional execution optimizations.
11069
11070 This switch is mainly for debugging the compiler and will likely be removed
11071 in a future version.
11072
11073 @item -mtomcat-stats
11074 @opindex mtomcat-stats
11075
11076 Cause gas to print out tomcat statistics.
11077
11078 @item -mcpu=@var{cpu}
11079 @opindex mcpu
11080
11081 Select the processor type for which to generate code.  Possible values are
11082 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
11083 @samp{frv}.
11084
11085 @end table
11086
11087 @node Xtensa Options
11088 @subsection Xtensa Options
11089 @cindex Xtensa Options
11090
11091 These options are supported for Xtensa targets:
11092
11093 @table @gcctabopt
11094 @item -mconst16
11095 @itemx -mno-const16
11096 @opindex mconst16
11097 @opindex mno-const16
11098 Enable or disable use of @code{CONST16} instructions for loading
11099 constant values.  The @code{CONST16} instruction is currently not a
11100 standard option from Tensilica.  When enabled, @code{CONST16}
11101 instructions are always used in place of the standard @code{L32R}
11102 instructions.  The use of @code{CONST16} is enabled by default only if
11103 the @code{L32R} instruction is not available.
11104
11105 @item -mfused-madd
11106 @itemx -mno-fused-madd
11107 @opindex mfused-madd
11108 @opindex mno-fused-madd
11109 Enable or disable use of fused multiply/add and multiply/subtract
11110 instructions in the floating-point option.  This has no effect if the
11111 floating-point option is not also enabled.  Disabling fused multiply/add
11112 and multiply/subtract instructions forces the compiler to use separate
11113 instructions for the multiply and add/subtract operations.  This may be
11114 desirable in some cases where strict IEEE 754-compliant results are
11115 required: the fused multiply add/subtract instructions do not round the
11116 intermediate result, thereby producing results with @emph{more} bits of
11117 precision than specified by the IEEE standard.  Disabling fused multiply
11118 add/subtract instructions also ensures that the program output is not
11119 sensitive to the compiler's ability to combine multiply and add/subtract
11120 operations.
11121
11122 @item -mtext-section-literals
11123 @itemx -mno-text-section-literals
11124 @opindex mtext-section-literals
11125 @opindex mno-text-section-literals
11126 Control the treatment of literal pools.  The default is
11127 @option{-mno-text-section-literals}, which places literals in a separate
11128 section in the output file.  This allows the literal pool to be placed
11129 in a data RAM/ROM, and it also allows the linker to combine literal
11130 pools from separate object files to remove redundant literals and
11131 improve code size.  With @option{-mtext-section-literals}, the literals
11132 are interspersed in the text section in order to keep them as close as
11133 possible to their references.  This may be necessary for large assembly
11134 files.
11135
11136 @item -mtarget-align
11137 @itemx -mno-target-align
11138 @opindex mtarget-align
11139 @opindex mno-target-align
11140 When this option is enabled, GCC instructs the assembler to
11141 automatically align instructions to reduce branch penalties at the
11142 expense of some code density.  The assembler attempts to widen density
11143 instructions to align branch targets and the instructions following call
11144 instructions.  If there are not enough preceding safe density
11145 instructions to align a target, no widening will be performed.  The
11146 default is @option{-mtarget-align}.  These options do not affect the
11147 treatment of auto-aligned instructions like @code{LOOP}, which the
11148 assembler will always align, either by widening density instructions or
11149 by inserting no-op instructions.
11150
11151 @item -mlongcalls
11152 @itemx -mno-longcalls
11153 @opindex mlongcalls
11154 @opindex mno-longcalls
11155 When this option is enabled, GCC instructs the assembler to translate
11156 direct calls to indirect calls unless it can determine that the target
11157 of a direct call is in the range allowed by the call instruction.  This
11158 translation typically occurs for calls to functions in other source
11159 files.  Specifically, the assembler translates a direct @code{CALL}
11160 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11161 The default is @option{-mno-longcalls}.  This option should be used in
11162 programs where the call target can potentially be out of range.  This
11163 option is implemented in the assembler, not the compiler, so the
11164 assembly code generated by GCC will still show direct call
11165 instructions---look at the disassembled object code to see the actual
11166 instructions.  Note that the assembler will use an indirect call for
11167 every cross-file call, not just those that really will be out of range.
11168 @end table
11169
11170 @node Code Gen Options
11171 @section Options for Code Generation Conventions
11172 @cindex code generation conventions
11173 @cindex options, code generation
11174 @cindex run-time options
11175
11176 These machine-independent options control the interface conventions
11177 used in code generation.
11178
11179 Most of them have both positive and negative forms; the negative form
11180 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11181 one of the forms is listed---the one which is not the default.  You
11182 can figure out the other form by either removing @samp{no-} or adding
11183 it.
11184
11185 @table @gcctabopt
11186 @item -fbounds-check
11187 @opindex fbounds-check
11188 For front-ends that support it, generate additional code to check that
11189 indices used to access arrays are within the declared range.  This is
11190 currently only supported by the Java and Fortran 77 front-ends, where
11191 this option defaults to true and false respectively.
11192
11193 @item -ftrapv
11194 @opindex ftrapv
11195 This option generates traps for signed overflow on addition, subtraction,
11196 multiplication operations.
11197
11198 @item -fwrapv
11199 @opindex fwrapv
11200 This option instructs the compiler to assume that signed arithmetic
11201 overflow of addition, subtraction and multiplication wraps around
11202 using twos-complement representation.  This flag enables some optimizations
11203 and disables other.  This option is enabled by default for the Java
11204 front-end, as required by the Java language specification.
11205
11206 @item -fexceptions
11207 @opindex fexceptions
11208 Enable exception handling.  Generates extra code needed to propagate
11209 exceptions.  For some targets, this implies GCC will generate frame
11210 unwind information for all functions, which can produce significant data
11211 size overhead, although it does not affect execution.  If you do not
11212 specify this option, GCC will enable it by default for languages like
11213 C++ which normally require exception handling, and disable it for
11214 languages like C that do not normally require it.  However, you may need
11215 to enable this option when compiling C code that needs to interoperate
11216 properly with exception handlers written in C++.  You may also wish to
11217 disable this option if you are compiling older C++ programs that don't
11218 use exception handling.
11219
11220 @item -fnon-call-exceptions
11221 @opindex fnon-call-exceptions
11222 Generate code that allows trapping instructions to throw exceptions.
11223 Note that this requires platform-specific runtime support that does
11224 not exist everywhere.  Moreover, it only allows @emph{trapping}
11225 instructions to throw exceptions, i.e.@: memory references or floating
11226 point instructions.  It does not allow exceptions to be thrown from
11227 arbitrary signal handlers such as @code{SIGALRM}.
11228
11229 @item -funwind-tables
11230 @opindex funwind-tables
11231 Similar to @option{-fexceptions}, except that it will just generate any needed
11232 static data, but will not affect the generated code in any other way.
11233 You will normally not enable this option; instead, a language processor
11234 that needs this handling would enable it on your behalf.
11235
11236 @item -fasynchronous-unwind-tables
11237 @opindex funwind-tables
11238 Generate unwind table in dwarf2 format, if supported by target machine.  The
11239 table is exact at each instruction boundary, so it can be used for stack
11240 unwinding from asynchronous events (such as debugger or garbage collector).
11241
11242 @item -fpcc-struct-return
11243 @opindex fpcc-struct-return
11244 Return ``short'' @code{struct} and @code{union} values in memory like
11245 longer ones, rather than in registers.  This convention is less
11246 efficient, but it has the advantage of allowing intercallability between
11247 GCC-compiled files and files compiled with other compilers, particularly
11248 the Portable C Compiler (pcc).
11249
11250 The precise convention for returning structures in memory depends
11251 on the target configuration macros.
11252
11253 Short structures and unions are those whose size and alignment match
11254 that of some integer type.
11255
11256 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11257 switch is not binary compatible with code compiled with the
11258 @option{-freg-struct-return} switch.
11259 Use it to conform to a non-default application binary interface.
11260
11261 @item -freg-struct-return
11262 @opindex freg-struct-return
11263 Return @code{struct} and @code{union} values in registers when possible.
11264 This is more efficient for small structures than
11265 @option{-fpcc-struct-return}.
11266
11267 If you specify neither @option{-fpcc-struct-return} nor
11268 @option{-freg-struct-return}, GCC defaults to whichever convention is
11269 standard for the target.  If there is no standard convention, GCC
11270 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11271 the principal compiler.  In those cases, we can choose the standard, and
11272 we chose the more efficient register return alternative.
11273
11274 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11275 switch is not binary compatible with code compiled with the
11276 @option{-fpcc-struct-return} switch.
11277 Use it to conform to a non-default application binary interface.
11278
11279 @item -fshort-enums
11280 @opindex fshort-enums
11281 Allocate to an @code{enum} type only as many bytes as it needs for the
11282 declared range of possible values.  Specifically, the @code{enum} type
11283 will be equivalent to the smallest integer type which has enough room.
11284
11285 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11286 code that is not binary compatible with code generated without that switch.
11287 Use it to conform to a non-default application binary interface.
11288
11289 @item -fshort-double
11290 @opindex fshort-double
11291 Use the same size for @code{double} as for @code{float}.
11292
11293 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11294 code that is not binary compatible with code generated without that switch.
11295 Use it to conform to a non-default application binary interface.
11296
11297 @item -fshort-wchar
11298 @opindex fshort-wchar
11299 Override the underlying type for @samp{wchar_t} to be @samp{short
11300 unsigned int} instead of the default for the target.  This option is
11301 useful for building programs to run under WINE@.
11302
11303 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11304 code that is not binary compatible with code generated without that switch.
11305 Use it to conform to a non-default application binary interface.
11306
11307 @item -fshared-data
11308 @opindex fshared-data
11309 Requests that the data and non-@code{const} variables of this
11310 compilation be shared data rather than private data.  The distinction
11311 makes sense only on certain operating systems, where shared data is
11312 shared between processes running the same program, while private data
11313 exists in one copy per process.
11314
11315 @item -fno-common
11316 @opindex fno-common
11317 In C, allocate even uninitialized global variables in the data section of the
11318 object file, rather than generating them as common blocks.  This has the
11319 effect that if the same variable is declared (without @code{extern}) in
11320 two different compilations, you will get an error when you link them.
11321 The only reason this might be useful is if you wish to verify that the
11322 program will work on other systems which always work this way.
11323
11324 @item -fno-ident
11325 @opindex fno-ident
11326 Ignore the @samp{#ident} directive.
11327
11328 @item -fno-gnu-linker
11329 @opindex fno-gnu-linker
11330 Do not output global initializations (such as C++ constructors and
11331 destructors) in the form used by the GNU linker (on systems where the GNU
11332 linker is the standard method of handling them).  Use this option when
11333 you want to use a non-GNU linker, which also requires using the
11334 @command{collect2} program to make sure the system linker includes
11335 constructors and destructors.  (@command{collect2} is included in the GCC
11336 distribution.)  For systems which @emph{must} use @command{collect2}, the
11337 compiler driver @command{gcc} is configured to do this automatically.
11338
11339 @item -finhibit-size-directive
11340 @opindex finhibit-size-directive
11341 Don't output a @code{.size} assembler directive, or anything else that
11342 would cause trouble if the function is split in the middle, and the
11343 two halves are placed at locations far apart in memory.  This option is
11344 used when compiling @file{crtstuff.c}; you should not need to use it
11345 for anything else.
11346
11347 @item -fverbose-asm
11348 @opindex fverbose-asm
11349 Put extra commentary information in the generated assembly code to
11350 make it more readable.  This option is generally only of use to those
11351 who actually need to read the generated assembly code (perhaps while
11352 debugging the compiler itself).
11353
11354 @option{-fno-verbose-asm}, the default, causes the
11355 extra information to be omitted and is useful when comparing two assembler
11356 files.
11357
11358 @item -fpic
11359 @opindex fpic
11360 @cindex global offset table
11361 @cindex PIC
11362 Generate position-independent code (PIC) suitable for use in a shared
11363 library, if supported for the target machine.  Such code accesses all
11364 constant addresses through a global offset table (GOT)@.  The dynamic
11365 loader resolves the GOT entries when the program starts (the dynamic
11366 loader is not part of GCC; it is part of the operating system).  If
11367 the GOT size for the linked executable exceeds a machine-specific
11368 maximum size, you get an error message from the linker indicating that
11369 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11370 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
11371 on the m68k and RS/6000.  The 386 has no such limit.)
11372
11373 Position-independent code requires special support, and therefore works
11374 only on certain machines.  For the 386, GCC supports PIC for System V
11375 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11376 position-independent.
11377
11378 @item -fPIC
11379 @opindex fPIC
11380 If supported for the target machine, emit position-independent code,
11381 suitable for dynamic linking and avoiding any limit on the size of the
11382 global offset table.  This option makes a difference on the m68k, m88k,
11383 and the SPARC.
11384
11385 Position-independent code requires special support, and therefore works
11386 only on certain machines.
11387
11388 @item -fpie
11389 @itemx -fPIE
11390 @opindex fpie
11391 @opindex fPIE
11392 These options are similar to @option{-fpic} and @option{-fPIC}, but
11393 generated position independent code can be only linked into executables.
11394 Usually these options are used when @option{-pie} GCC option will be
11395 used during linking.
11396
11397 @item -ffixed-@var{reg}
11398 @opindex ffixed
11399 Treat the register named @var{reg} as a fixed register; generated code
11400 should never refer to it (except perhaps as a stack pointer, frame
11401 pointer or in some other fixed role).
11402
11403 @var{reg} must be the name of a register.  The register names accepted
11404 are machine-specific and are defined in the @code{REGISTER_NAMES}
11405 macro in the machine description macro file.
11406
11407 This flag does not have a negative form, because it specifies a
11408 three-way choice.
11409
11410 @item -fcall-used-@var{reg}
11411 @opindex fcall-used
11412 Treat the register named @var{reg} as an allocable register that is
11413 clobbered by function calls.  It may be allocated for temporaries or
11414 variables that do not live across a call.  Functions compiled this way
11415 will not save and restore the register @var{reg}.
11416
11417 It is an error to used this flag with the frame pointer or stack pointer.
11418 Use of this flag for other registers that have fixed pervasive roles in
11419 the machine's execution model will produce disastrous results.
11420
11421 This flag does not have a negative form, because it specifies a
11422 three-way choice.
11423
11424 @item -fcall-saved-@var{reg}
11425 @opindex fcall-saved
11426 Treat the register named @var{reg} as an allocable register saved by
11427 functions.  It may be allocated even for temporaries or variables that
11428 live across a call.  Functions compiled this way will save and restore
11429 the register @var{reg} if they use it.
11430
11431 It is an error to used this flag with the frame pointer or stack pointer.
11432 Use of this flag for other registers that have fixed pervasive roles in
11433 the machine's execution model will produce disastrous results.
11434
11435 A different sort of disaster will result from the use of this flag for
11436 a register in which function values may be returned.
11437
11438 This flag does not have a negative form, because it specifies a
11439 three-way choice.
11440
11441 @item -fpack-struct
11442 @opindex fpack-struct
11443 Pack all structure members together without holes.
11444
11445 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11446 code that is not binary compatible with code generated without that switch.
11447 Additionally, it makes the code suboptimal.
11448 Use it to conform to a non-default application binary interface.
11449
11450 @item -finstrument-functions
11451 @opindex finstrument-functions
11452 Generate instrumentation calls for entry and exit to functions.  Just
11453 after function entry and just before function exit, the following
11454 profiling functions will be called with the address of the current
11455 function and its call site.  (On some platforms,
11456 @code{__builtin_return_address} does not work beyond the current
11457 function, so the call site information may not be available to the
11458 profiling functions otherwise.)
11459
11460 @example
11461 void __cyg_profile_func_enter (void *this_fn,
11462                                void *call_site);
11463 void __cyg_profile_func_exit  (void *this_fn,
11464                                void *call_site);
11465 @end example
11466
11467 The first argument is the address of the start of the current function,
11468 which may be looked up exactly in the symbol table.
11469
11470 This instrumentation is also done for functions expanded inline in other
11471 functions.  The profiling calls will indicate where, conceptually, the
11472 inline function is entered and exited.  This means that addressable
11473 versions of such functions must be available.  If all your uses of a
11474 function are expanded inline, this may mean an additional expansion of
11475 code size.  If you use @samp{extern inline} in your C code, an
11476 addressable version of such functions must be provided.  (This is
11477 normally the case anyways, but if you get lucky and the optimizer always
11478 expands the functions inline, you might have gotten away without
11479 providing static copies.)
11480
11481 A function may be given the attribute @code{no_instrument_function}, in
11482 which case this instrumentation will not be done.  This can be used, for
11483 example, for the profiling functions listed above, high-priority
11484 interrupt routines, and any functions from which the profiling functions
11485 cannot safely be called (perhaps signal handlers, if the profiling
11486 routines generate output or allocate memory).
11487
11488 @item -fstack-check
11489 @opindex fstack-check
11490 Generate code to verify that you do not go beyond the boundary of the
11491 stack.  You should specify this flag if you are running in an
11492 environment with multiple threads, but only rarely need to specify it in
11493 a single-threaded environment since stack overflow is automatically
11494 detected on nearly all systems if there is only one stack.
11495
11496 Note that this switch does not actually cause checking to be done; the
11497 operating system must do that.  The switch causes generation of code
11498 to ensure that the operating system sees the stack being extended.
11499
11500 @item -fstack-limit-register=@var{reg}
11501 @itemx -fstack-limit-symbol=@var{sym}
11502 @itemx -fno-stack-limit
11503 @opindex fstack-limit-register
11504 @opindex fstack-limit-symbol
11505 @opindex fno-stack-limit
11506 Generate code to ensure that the stack does not grow beyond a certain value,
11507 either the value of a register or the address of a symbol.  If the stack
11508 would grow beyond the value, a signal is raised.  For most targets,
11509 the signal is raised before the stack overruns the boundary, so
11510 it is possible to catch the signal without taking special precautions.
11511
11512 For instance, if the stack starts at absolute address @samp{0x80000000}
11513 and grows downwards, you can use the flags
11514 @option{-fstack-limit-symbol=__stack_limit} and
11515 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11516 of 128KB@.  Note that this may only work with the GNU linker.
11517
11518 @cindex aliasing of parameters
11519 @cindex parameters, aliased
11520 @item -fargument-alias
11521 @itemx -fargument-noalias
11522 @itemx -fargument-noalias-global
11523 @opindex fargument-alias
11524 @opindex fargument-noalias
11525 @opindex fargument-noalias-global
11526 Specify the possible relationships among parameters and between
11527 parameters and global data.
11528
11529 @option{-fargument-alias} specifies that arguments (parameters) may
11530 alias each other and may alias global storage.@*
11531 @option{-fargument-noalias} specifies that arguments do not alias
11532 each other, but may alias global storage.@*
11533 @option{-fargument-noalias-global} specifies that arguments do not
11534 alias each other and do not alias global storage.
11535
11536 Each language will automatically use whatever option is required by
11537 the language standard.  You should not need to use these options yourself.
11538
11539 @item -fleading-underscore
11540 @opindex fleading-underscore
11541 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11542 change the way C symbols are represented in the object file.  One use
11543 is to help link with legacy assembly code.
11544
11545 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11546 generate code that is not binary compatible with code generated without that
11547 switch.  Use it to conform to a non-default application binary interface.
11548 Not all targets provide complete support for this switch.
11549
11550 @item -ftls-model=@var{model}
11551 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11552 The @var{model} argument should be one of @code{global-dynamic},
11553 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11554
11555 The default without @option{-fpic} is @code{initial-exec}; with
11556 @option{-fpic} the default is @code{global-dynamic}.
11557 @end table
11558
11559 @c man end
11560
11561 @node Environment Variables
11562 @section Environment Variables Affecting GCC
11563 @cindex environment variables
11564
11565 @c man begin ENVIRONMENT
11566 This section describes several environment variables that affect how GCC
11567 operates.  Some of them work by specifying directories or prefixes to use
11568 when searching for various kinds of files.  Some are used to specify other
11569 aspects of the compilation environment.
11570
11571 Note that you can also specify places to search using options such as
11572 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11573 take precedence over places specified using environment variables, which
11574 in turn take precedence over those specified by the configuration of GCC@.
11575 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11576 GNU Compiler Collection (GCC) Internals}.
11577
11578 @table @env
11579 @item LANG
11580 @itemx LC_CTYPE
11581 @c @itemx LC_COLLATE
11582 @itemx LC_MESSAGES
11583 @c @itemx LC_MONETARY
11584 @c @itemx LC_NUMERIC
11585 @c @itemx LC_TIME
11586 @itemx LC_ALL
11587 @findex LANG
11588 @findex LC_CTYPE
11589 @c @findex LC_COLLATE
11590 @findex LC_MESSAGES
11591 @c @findex LC_MONETARY
11592 @c @findex LC_NUMERIC
11593 @c @findex LC_TIME
11594 @findex LC_ALL
11595 @cindex locale
11596 These environment variables control the way that GCC uses
11597 localization information that allow GCC to work with different
11598 national conventions.  GCC inspects the locale categories
11599 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11600 so.  These locale categories can be set to any value supported by your
11601 installation.  A typical value is @samp{en_UK} for English in the United
11602 Kingdom.
11603
11604 The @env{LC_CTYPE} environment variable specifies character
11605 classification.  GCC uses it to determine the character boundaries in
11606 a string; this is needed for some multibyte encodings that contain quote
11607 and escape characters that would otherwise be interpreted as a string
11608 end or escape.
11609
11610 The @env{LC_MESSAGES} environment variable specifies the language to
11611 use in diagnostic messages.
11612
11613 If the @env{LC_ALL} environment variable is set, it overrides the value
11614 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11615 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11616 environment variable.  If none of these variables are set, GCC
11617 defaults to traditional C English behavior.
11618
11619 @item TMPDIR
11620 @findex TMPDIR
11621 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11622 files.  GCC uses temporary files to hold the output of one stage of
11623 compilation which is to be used as input to the next stage: for example,
11624 the output of the preprocessor, which is the input to the compiler
11625 proper.
11626
11627 @item GCC_EXEC_PREFIX
11628 @findex GCC_EXEC_PREFIX
11629 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11630 names of the subprograms executed by the compiler.  No slash is added
11631 when this prefix is combined with the name of a subprogram, but you can
11632 specify a prefix that ends with a slash if you wish.
11633
11634 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11635 an appropriate prefix to use based on the pathname it was invoked with.
11636
11637 If GCC cannot find the subprogram using the specified prefix, it
11638 tries looking in the usual places for the subprogram.
11639
11640 The default value of @env{GCC_EXEC_PREFIX} is
11641 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11642 of @code{prefix} when you ran the @file{configure} script.
11643
11644 Other prefixes specified with @option{-B} take precedence over this prefix.
11645
11646 This prefix is also used for finding files such as @file{crt0.o} that are
11647 used for linking.
11648
11649 In addition, the prefix is used in an unusual way in finding the
11650 directories to search for header files.  For each of the standard
11651 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11652 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11653 replacing that beginning with the specified prefix to produce an
11654 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11655 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11656 These alternate directories are searched first; the standard directories
11657 come next.
11658
11659 @item COMPILER_PATH
11660 @findex COMPILER_PATH
11661 The value of @env{COMPILER_PATH} is a colon-separated list of
11662 directories, much like @env{PATH}.  GCC tries the directories thus
11663 specified when searching for subprograms, if it can't find the
11664 subprograms using @env{GCC_EXEC_PREFIX}.
11665
11666 @item LIBRARY_PATH
11667 @findex LIBRARY_PATH
11668 The value of @env{LIBRARY_PATH} is a colon-separated list of
11669 directories, much like @env{PATH}.  When configured as a native compiler,
11670 GCC tries the directories thus specified when searching for special
11671 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11672 using GCC also uses these directories when searching for ordinary
11673 libraries for the @option{-l} option (but directories specified with
11674 @option{-L} come first).
11675
11676 @item LANG
11677 @findex LANG
11678 @cindex locale definition
11679 This variable is used to pass locale information to the compiler.  One way in
11680 which this information is used is to determine the character set to be used
11681 when character literals, string literals and comments are parsed in C and C++.
11682 When the compiler is configured to allow multibyte characters,
11683 the following values for @env{LANG} are recognized:
11684
11685 @table @samp
11686 @item C-JIS
11687 Recognize JIS characters.
11688 @item C-SJIS
11689 Recognize SJIS characters.
11690 @item C-EUCJP
11691 Recognize EUCJP characters.
11692 @end table
11693
11694 If @env{LANG} is not defined, or if it has some other value, then the
11695 compiler will use mblen and mbtowc as defined by the default locale to
11696 recognize and translate multibyte characters.
11697 @end table
11698
11699 @noindent
11700 Some additional environments variables affect the behavior of the
11701 preprocessor.
11702
11703 @include cppenv.texi
11704
11705 @c man end
11706
11707 @node Precompiled Headers
11708 @section Using Precompiled Headers
11709 @cindex precompiled headers
11710 @cindex speed of compilation
11711
11712 Often large projects have many header files that are included in every
11713 source file.  The time the compiler takes to process these header files
11714 over and over again can account for nearly all of the time required to
11715 build the project.  To make builds faster, GCC allows users to
11716 `precompile' a header file; then, if builds can use the precompiled
11717 header file they will be much faster.
11718
11719 To create a precompiled header file, simply compile it as you would any
11720 other file, if necessary using the @option{-x} option to make the driver
11721 treat it as a C or C++ header file.  You will probably want to use a
11722 tool like @command{make} to keep the precompiled header up-to-date when
11723 the headers it contains change.
11724
11725 A precompiled header file will be searched for when @code{#include} is
11726 seen in the compilation.  As it searches for the included file
11727 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11728 compiler looks for a precompiled header in each directory just before it
11729 looks for the include file in that directory.  The name searched for is
11730 the name specified in the @code{#include} with @samp{.gch} appended.  If
11731 the precompiled header file can't be used, it is ignored.
11732
11733 For instance, if you have @code{#include "all.h"}, and you have
11734 @file{all.h.gch} in the same directory as @file{all.h}, then the
11735 precompiled header file will be used if possible, and the original
11736 header will be used otherwise.
11737
11738 Alternatively, you might decide to put the precompiled header file in a
11739 directory and use @option{-I} to ensure that directory is searched
11740 before (or instead of) the directory containing the original header.
11741 Then, if you want to check that the precompiled header file is always
11742 used, you can put a file of the same name as the original header in this
11743 directory containing an @code{#error} command.
11744
11745 This also works with @option{-include}.  So yet another way to use
11746 precompiled headers, good for projects not designed with precompiled
11747 header files in mind, is to simply take most of the header files used by
11748 a project, include them from another header file, precompile that header
11749 file, and @option{-include} the precompiled header.  If the header files
11750 have guards against multiple inclusion, they will be skipped because
11751 they've already been included (in the precompiled header).
11752
11753 If you need to precompile the same header file for different
11754 languages, targets, or compiler options, you can instead make a
11755 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11756 header in the directory.  (It doesn't matter what you call the files
11757 in the directory, every precompiled header in the directory will be
11758 considered.)  The first precompiled header encountered in the
11759 directory that is valid for this compilation will be used; they're
11760 searched in no particular order.
11761
11762 There are many other possibilities, limited only by your imagination,
11763 good sense, and the constraints of your build system.
11764
11765 A precompiled header file can be used only when these conditions apply:
11766
11767 @itemize
11768 @item
11769 Only one precompiled header can be used in a particular compilation.
11770 @item
11771 A precompiled header can't be used once the first C token is seen.  You
11772 can have preprocessor directives before a precompiled header; you can
11773 even include a precompiled header from inside another header, so long as
11774 there are no C tokens before the @code{#include}.
11775 @item
11776 The precompiled header file must be produced for the same language as
11777 the current compilation.  You can't use a C precompiled header for a C++
11778 compilation.
11779 @item
11780 The precompiled header file must be produced by the same compiler
11781 version and configuration as the current compilation is using.
11782 The easiest way to guarantee this is to use the same compiler binary
11783 for creating and using precompiled headers.
11784 @item
11785 Any macros defined before the precompiled header (including with
11786 @option{-D}) must either be defined in the same way as when the
11787 precompiled header was generated, or must not affect the precompiled
11788 header, which usually means that the they don't appear in the
11789 precompiled header at all.
11790 @item
11791 Certain command-line options must be defined in the same way as when the
11792 precompiled header was generated.  At present, it's not clear which
11793 options are safe to change and which are not; the safest choice is to
11794 use exactly the same options when generating and using the precompiled
11795 header.
11796 @end itemize
11797
11798 For all of these but the last, the compiler will automatically ignore
11799 the precompiled header if the conditions aren't met.  For the last item,
11800 some option changes will cause the precompiled header to be rejected,
11801 but not all incompatible option combinations have yet been found.  If
11802 you find a new incompatible combination, please consider filing a bug
11803 report, see @ref{Bugs}.
11804
11805 @node Running Protoize
11806 @section Running Protoize
11807
11808 The program @code{protoize} is an optional part of GCC@.  You can use
11809 it to add prototypes to a program, thus converting the program to ISO
11810 C in one respect.  The companion program @code{unprotoize} does the
11811 reverse: it removes argument types from any prototypes that are found.
11812
11813 When you run these programs, you must specify a set of source files as
11814 command line arguments.  The conversion programs start out by compiling
11815 these files to see what functions they define.  The information gathered
11816 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11817
11818 After scanning comes actual conversion.  The specified files are all
11819 eligible to be converted; any files they include (whether sources or
11820 just headers) are eligible as well.
11821
11822 But not all the eligible files are converted.  By default,
11823 @code{protoize} and @code{unprotoize} convert only source and header
11824 files in the current directory.  You can specify additional directories
11825 whose files should be converted with the @option{-d @var{directory}}
11826 option.  You can also specify particular files to exclude with the
11827 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11828 directory name matches one of the specified directory names, and its
11829 name within the directory has not been excluded.
11830
11831 Basic conversion with @code{protoize} consists of rewriting most
11832 function definitions and function declarations to specify the types of
11833 the arguments.  The only ones not rewritten are those for varargs
11834 functions.
11835
11836 @code{protoize} optionally inserts prototype declarations at the
11837 beginning of the source file, to make them available for any calls that
11838 precede the function's definition.  Or it can insert prototype
11839 declarations with block scope in the blocks where undeclared functions
11840 are called.
11841
11842 Basic conversion with @code{unprotoize} consists of rewriting most
11843 function declarations to remove any argument types, and rewriting
11844 function definitions to the old-style pre-ISO form.
11845
11846 Both conversion programs print a warning for any function declaration or
11847 definition that they can't convert.  You can suppress these warnings
11848 with @option{-q}.
11849
11850 The output from @code{protoize} or @code{unprotoize} replaces the
11851 original source file.  The original file is renamed to a name ending
11852 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11853 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11854 for DOS) file already exists, then the source file is simply discarded.
11855
11856 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11857 scan the program and collect information about the functions it uses.
11858 So neither of these programs will work until GCC is installed.
11859
11860 Here is a table of the options you can use with @code{protoize} and
11861 @code{unprotoize}.  Each option works with both programs unless
11862 otherwise stated.
11863
11864 @table @code
11865 @item -B @var{directory}
11866 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11867 usual directory (normally @file{/usr/local/lib}).  This file contains
11868 prototype information about standard system functions.  This option
11869 applies only to @code{protoize}.
11870
11871 @item -c @var{compilation-options}
11872 Use @var{compilation-options} as the options when running @command{gcc} to
11873 produce the @samp{.X} files.  The special option @option{-aux-info} is
11874 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11875
11876 Note that the compilation options must be given as a single argument to
11877 @code{protoize} or @code{unprotoize}.  If you want to specify several
11878 @command{gcc} options, you must quote the entire set of compilation options
11879 to make them a single word in the shell.
11880
11881 There are certain @command{gcc} arguments that you cannot use, because they
11882 would produce the wrong kind of output.  These include @option{-g},
11883 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11884 the @var{compilation-options}, they are ignored.
11885
11886 @item -C
11887 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11888 systems) instead of @samp{.c}.  This is convenient if you are converting
11889 a C program to C++.  This option applies only to @code{protoize}.
11890
11891 @item -g
11892 Add explicit global declarations.  This means inserting explicit
11893 declarations at the beginning of each source file for each function
11894 that is called in the file and was not declared.  These declarations
11895 precede the first function definition that contains a call to an
11896 undeclared function.  This option applies only to @code{protoize}.
11897
11898 @item -i @var{string}
11899 Indent old-style parameter declarations with the string @var{string}.
11900 This option applies only to @code{protoize}.
11901
11902 @code{unprotoize} converts prototyped function definitions to old-style
11903 function definitions, where the arguments are declared between the
11904 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11905 uses five spaces as the indentation.  If you want to indent with just
11906 one space instead, use @option{-i " "}.
11907
11908 @item -k
11909 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11910 is finished.
11911
11912 @item -l
11913 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11914 a prototype declaration for each function in each block which calls the
11915 function without any declaration.  This option applies only to
11916 @code{protoize}.
11917
11918 @item -n
11919 Make no real changes.  This mode just prints information about the conversions
11920 that would have been done without @option{-n}.
11921
11922 @item -N
11923 Make no @samp{.save} files.  The original files are simply deleted.
11924 Use this option with caution.
11925
11926 @item -p @var{program}
11927 Use the program @var{program} as the compiler.  Normally, the name
11928 @file{gcc} is used.
11929
11930 @item -q
11931 Work quietly.  Most warnings are suppressed.
11932
11933 @item -v
11934 Print the version number, just like @option{-v} for @command{gcc}.
11935 @end table
11936
11937 If you need special compiler options to compile one of your program's
11938 source files, then you should generate that file's @samp{.X} file
11939 specially, by running @command{gcc} on that source file with the
11940 appropriate options and the option @option{-aux-info}.  Then run
11941 @code{protoize} on the entire set of files.  @code{protoize} will use
11942 the existing @samp{.X} file because it is newer than the source file.
11943 For example:
11944
11945 @example
11946 gcc -Dfoo=bar file1.c -aux-info file1.X
11947 protoize *.c
11948 @end example
11949
11950 @noindent
11951 You need to include the special files along with the rest in the
11952 @code{protoize} command, even though their @samp{.X} files already
11953 exist, because otherwise they won't get converted.
11954
11955 @xref{Protoize Caveats}, for more information on how to use
11956 @code{protoize} successfully.