OSDN Git Service

2003-04-07 Aldy Hernandez <aldyh@redhat.com>
[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
70 When you invoke GCC, it normally does preprocessing, compilation,
71 assembly and linking.  The ``overall options'' allow you to stop this
72 process at an intermediate stage.  For example, the @option{-c} option
73 says not to run the linker.  Then the output consists of object files
74 output by the assembler.
75
76 Other options are passed on to one stage of processing.  Some options
77 control the preprocessor and others the compiler itself.  Yet other
78 options control the assembler and linker; most of these are not
79 documented here, since you rarely need to use any of them.
80
81 @cindex C compilation options
82 Most of the command line options that you can use with GCC are useful
83 for C programs; when an option is only useful with another language
84 (usually C++), the explanation says so explicitly.  If the description
85 for a particular option does not mention a source language, you can use
86 that option with all supported languages.
87
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
91
92 @cindex grouping options
93 @cindex options, grouping
94 The @command{gcc} program accepts options and file names as operands.  Many
95 options have multi-letter names; therefore multiple single-letter options
96 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
97 -r}}.
98
99 @cindex order of options
100 @cindex options, order
101 You can mix options and other arguments.  For the most part, the order
102 you use doesn't matter.  Order does matter when you use several options
103 of the same kind; for example, if you specify @option{-L} more than once,
104 the directories are searched in the order specified.
105
106 Many options have long names starting with @samp{-f} or with
107 @samp{-W}---for example, @option{-fforce-mem},
108 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
109 these have both positive and negative forms; the negative form of
110 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
111 only one of these two forms, whichever one is not the default.
112
113 @c man end
114
115 @xref{Option Index}, for an index to GCC's options.
116
117 @menu
118 * Option Summary::      Brief list of all options, without explanations.
119 * Overall Options::     Controlling the kind of output:
120                         an executable, object files, assembler files,
121                         or preprocessed source.
122 * Invoking G++::        Compiling C++ programs.
123 * C Dialect Options::   Controlling the variant of C language compiled.
124 * C++ Dialect Options:: Variations on C++.
125 * Objective-C Dialect Options:: Variations on Objective-C.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
147
148 @c man begin OPTIONS
149
150 @node Option Summary
151 @section Option Summary
152
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
155
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
161
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char @gol
171 -fwritable-strings}
172
173 @item C++ Language Options
174 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
175 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
176 -fconserve-space  -fno-const-strings  -fdollars-in-identifiers @gol
177 -fno-elide-constructors @gol
178 -fno-enforce-eh-specs  -fexternal-templates @gol
179 -falt-external-templates @gol
180 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
181 -fno-implicit-templates @gol
182 -fno-implicit-inline-templates @gol
183 -fno-implement-inlines  -fms-extensions @gol
184 -fno-nonansi-builtins  -fno-operator-names @gol
185 -fno-optional-diags  -fpermissive @gol
186 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
187 -fuse-cxa-atexit  -fvtable-gc  -fno-weak  -nostdinc++ @gol
188 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
189 -Wnon-virtual-dtor  -Wreorder @gol
190 -Weffc++  -Wno-deprecated @gol
191 -Wno-non-template-friend  -Wold-style-cast @gol
192 -Woverloaded-virtual  -Wno-pmf-conversions @gol
193 -Wsign-promo  -Wsynth}
194
195 @item Objective-C Language Options
196 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
197 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime  -gen-decls @gol
199 -Wno-protocol  -Wselector -Wundeclared-selector}
200
201 @item Language Independent Options
202 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
203 @gccoptlist{-fmessage-length=@var{n}  @gol
204 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
205
206 @item Warning Options
207 @xref{Warning Options,,Options to Request or Suppress Warnings}.
208 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
209 -w  -Wextra  -Wall  -Waggregate-return @gol
210 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
211 -Wconversion  -Wno-deprecated-declarations @gol
212 -Wdisabled-optimization  -Wno-div-by-zero  -Werror @gol
213 -Wfloat-equal  -Wformat  -Wformat=2 @gol
214 -Wformat-nonliteral  -Wformat-security @gol
215 -Wimplicit  -Wimplicit-int  @gol
216 -Wimplicit-function-declaration @gol
217 -Werror-implicit-function-declaration @gol
218 -Wimport  -Winline  -Winvalid-pch  -Wno-endif-labels @gol
219 -Wlarger-than-@var{len}  -Wlong-long @gol
220 -Wmain  -Wmissing-braces @gol
221 -Wmissing-format-attribute  -Wmissing-noreturn @gol
222 -Wno-multichar  -Wno-format-extra-args  -Wno-format-y2k @gol
223 -Wno-import  -Wnonnull  -Wpacked  -Wpadded @gol
224 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
225 -Wreturn-type  -Wsequence-point  -Wshadow @gol
226 -Wsign-compare  -Wstrict-aliasing @gol
227 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
228 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
229 -Wunknown-pragmas  -Wunreachable-code @gol
230 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
231 -Wunused-value  -Wunused-variable  -Wwrite-strings}
232
233 @item C-only Warning Options
234 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
235 -Wmissing-prototypes  -Wnested-externs @gol
236 -Wstrict-prototypes  -Wtraditional}
237
238 @item Debugging Options
239 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
240 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
241 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
242 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
243 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
244 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
245 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
246 -feliminate-dwarf2-dups  -fmem-report @gol
247 -fprofile-arcs  -fsched-verbose=@var{n} @gol
248 -ftest-coverage  -ftime-report @gol
249 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
250 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
251 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
252 -print-multi-directory  -print-multi-lib @gol
253 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
254 -feliminate-unused-debug-types @gol
255 -save-temps  -time}
256
257 @item Optimization Options
258 @xref{Optimize Options,,Options that Control Optimization}.
259 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
260 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
261 -fbranch-probabilities  -fcaller-saves  -fcprop-registers @gol
262 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
263 -fdelayed-branch  -fdelete-null-pointer-checks @gol
264 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
265 -fforce-addr  -fforce-mem  -ffunction-sections @gol
266 -fgcse  -fgcse-lm  -fgcse-sm  -floop-optimize  -fcrossjumping @gol
267 -fif-conversion  -fif-conversion2 @gol
268 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
269 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
270 -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
271 -fno-default-inline  -fno-defer-pop @gol
272 -fno-function-cse  -fno-guess-branch-probability @gol
273 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
274 -funsafe-math-optimizations  -ffinite-math-only @gol
275 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
276 -fomit-frame-pointer  -foptimize-register-move @gol
277 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
278 -freduce-all-givs  -fregmove  -frename-registers @gol
279 -freorder-blocks  -freorder-functions @gol
280 -frerun-cse-after-loop  -frerun-loop-opt @gol
281 -fschedule-insns  -fschedule-insns2 @gol
282 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
283 -fsched-spec-load-dangerous  -fsched2-use-superblocks @gol
284 -fsched2-use-traces  -fsignaling-nans @gol
285 -fsingle-precision-constant  -fssa  -fssa-ccp  -fssa-dce @gol
286 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
287 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
288 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
289 --param @var{name}=@var{value}
290 -O  -O0  -O1  -O2  -O3  -Os}
291
292 @item Preprocessor Options
293 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
294 @gccoptlist{-$  -A@var{question}=@var{answer} @gol
295 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
296 -C  -dD  -dI  -dM  -dN @gol
297 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
298 -idirafter @var{dir} @gol
299 -include @var{file}  -imacros @var{file} @gol
300 -iprefix @var{file}  -iwithprefix @var{dir} @gol
301 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
302 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
303 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
304 -Xpreprocessor @var{option}}
305
306 @item Assembler Option
307 @xref{Assembler Options,,Passing Options to the Assembler}.
308 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
309
310 @item Linker Options
311 @xref{Link Options,,Options for Linking}.
312 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
313 -nostartfiles  -nodefaultlibs  -nostdlib @gol
314 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
315 -Wl,@var{option}  -Xlinker @var{option} @gol
316 -u @var{symbol}}
317
318 @item Directory Options
319 @xref{Directory Options,,Options for Directory Search}.
320 @gccoptlist{-B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
321
322 @item Target Options
323 @c I wrote this xref this way to avoid overfull hbox. -- rms
324 @xref{Target Options}.
325 @gccoptlist{-V @var{version}  -b @var{machine}}
326
327 @item Machine Dependent Options
328 @xref{Submodel Options,,Hardware Models and Configurations}.
329
330 @emph{M680x0 Options}
331 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
332 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
333 -mfpa  -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
334 -malign-int  -mstrict-align}
335
336 @emph{M68hc1x Options}
337 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
338 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
339 -msoft-reg-count=@var{count}}
340
341 @emph{VAX Options}
342 @gccoptlist{-mg  -mgnu  -munix}
343
344 @emph{SPARC Options}
345 @gccoptlist{-mcpu=@var{cpu-type} @gol
346 -mtune=@var{cpu-type} @gol
347 -mcmodel=@var{code-model} @gol
348 -m32  -m64 @gol
349 -mapp-regs  -mbroken-saverestore  -mcypress @gol
350 -mfaster-structs  -mflat @gol
351 -mfpu  -mhard-float  -mhard-quad-float @gol
352 -mimpure-text  -mlive-g0  -mno-app-regs @gol
353 -mno-faster-structs  -mno-flat  -mno-fpu @gol
354 -mno-impure-text  -mno-stack-bias  -mno-unaligned-doubles @gol
355 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
356 -msupersparc  -munaligned-doubles  -mv8}
357
358 @emph{ARM Options}
359 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
360 -mapcs-26  -mapcs-32 @gol
361 -mapcs-stack-check  -mno-apcs-stack-check @gol
362 -mapcs-float  -mno-apcs-float @gol
363 -mapcs-reentrant  -mno-apcs-reentrant @gol
364 -msched-prolog  -mno-sched-prolog @gol
365 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
366 -malignment-traps  -mno-alignment-traps @gol
367 -msoft-float  -mhard-float  -mfpe @gol
368 -mthumb-interwork  -mno-thumb-interwork @gol
369 -mcpu=@var{name}  -march=@var{name}  -mfpe=@var{name}  @gol
370 -mstructure-size-boundary=@var{n} @gol
371 -mabort-on-noreturn @gol
372 -mlong-calls  -mno-long-calls @gol
373 -msingle-pic-base  -mno-single-pic-base @gol
374 -mpic-register=@var{reg} @gol
375 -mnop-fun-dllimport @gol
376 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
377 -mpoke-function-name @gol
378 -mthumb  -marm @gol
379 -mtpcs-frame  -mtpcs-leaf-frame @gol
380 -mcaller-super-interworking  -mcallee-super-interworking}
381
382 @emph{MN10200 Options}
383 @gccoptlist{-mrelax}
384
385 @emph{MN10300 Options}
386 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
387 -mam33  -mno-am33 @gol
388 -mno-crt0  -mrelax}
389
390 @emph{M32R/D Options}
391 @gccoptlist{-m32rx  -m32r  -mcode-model=@var{model-type} @gol
392 -msdata=@var{sdata-type}  -G @var{num}}
393
394 @emph{M88K Options}
395 @gccoptlist{-m88000  -m88100  -m88110  -mbig-pic @gol
396 -mcheck-zero-division  -mhandle-large-shift @gol
397 -midentify-revision  -mno-check-zero-division @gol
398 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
399 -mno-optimize-arg-area  -mno-serialize-volatile @gol
400 -mno-underscores  -mocs-debug-info @gol
401 -mocs-frame-position  -moptimize-arg-area @gol
402 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
403 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
404 -mversion-03.00  -mwarn-passed-structs}
405
406 @emph{RS/6000 and PowerPC Options}
407 @gccoptlist{-mcpu=@var{cpu-type} @gol
408 -mtune=@var{cpu-type} @gol
409 -mpower  -mno-power  -mpower2  -mno-power2 @gol
410 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
411 -maltivec  -mno-altivec @gol
412 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
413 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
414 -mnew-mnemonics  -mold-mnemonics @gol
415 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
416 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
417 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
418 -mstring  -mno-string  -mupdate  -mno-update @gol
419 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
420 -mstrict-align  -mno-strict-align  -mrelocatable @gol
421 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
422 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
423 -mdynamic-no-pic @gol
424 -mcall-aix -mcall-sysv -mcall-netbsd @gol
425 -maix-struct-return -msvr4-struct-return @gol
426 -mabi=altivec -mabi=no-altivec @gol
427 -mabi=spe -mabi=no-spe @gol
428 -misel=yes -misel=no @gol
429 -mspe=yes -mspe=no @gol
430 -mfloat-gprs=yes -mfloat-gprs=no @gol
431 -mprototype  -mno-prototype @gol
432 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
433 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
434
435 @emph{Darwin Options}
436 @gccoptlist{
437 -all_load -allowable_client -arch -arch_errors_fatal @gol
438 -arch_only -bind_at_load -bundle -bundle_loader @gol
439 -client_name -compatibility_version -current_version @gol
440 -dependency-file -dylib_file -dylinker_install_name @gol
441 -dynamic -dynamiclib -exported_symbols_list @gol
442 -filelist -flat_namespace -force_cpusubtype_ALL @gol
443 -force_flat_namespace -headerpad_max_install_names @gol
444 -image_base -init -install_name -keep_private_externs @gol
445 -multi_module -multiply_defined -multiply_defined_unused @gol
446 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
447 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
448 -private_bundle -read_only_relocs -sectalign @gol
449 -sectobjectsymbols -whyload -seg1addr @gol
450 -sectcreate -sectobjectsymbols -sectorder @gol
451 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
452 -segprot -segs_read_only_addr -segs_read_write_addr @gol
453 -single_module -static -sub_library -sub_umbrella @gol
454 -twolevel_namespace -umbrella -undefined @gol
455 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
456
457 @emph{RT Options}
458 @gccoptlist{
459 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
460 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
461 -mminimum-fp-blocks  -mnohc-struct-return}
462
463 @emph{MIPS Options}
464 @gccoptlist{
465 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
466 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
467 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
468 -mgas  -mgp32  -mgp64 @gol
469 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
470 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
471 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
472 -mmips-as  -mmips-tfile  -mno-abicalls @gol
473 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
474 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
475 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
476 -mrnames  -msoft-float @gol
477 -m4650  -msingle-float  -mmad @gol
478 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
479 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
480 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
481 -mbranch-likely -mno-branch-likely}
482
483 @emph{i386 and x86-64 Options}
484 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
485 -mfpmath=@var{unit} @gol
486 -masm=@var{dialect}  -mno-fancy-math-387 @gol
487 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
488 -mno-wide-multiply  -mrtd  -malign-double @gol
489 -mpreferred-stack-boundary=@var{num} @gol
490 -mmmx  -msse  -msse2  -m3dnow @gol
491 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
492 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
493 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
494 -mno-red-zone @gol
495 -mcmodel=@var{code-model} @gol
496 -m32  -m64}
497
498 @emph{HPPA Options}
499 @gccoptlist{-march=@var{architecture-type} @gol
500 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
501 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
502 -mjump-in-delay -mlinker-opt -mlong-calls @gol
503 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
504 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
505 -mno-jump-in-delay  -mno-long-load-store @gol
506 -mno-portable-runtime  -mno-soft-float @gol
507 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
508 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
509 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio}
510
511 @emph{Intel 960 Options}
512 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
513 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
514 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
515 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
516 -mno-complex-addr  -mno-leaf-procedures @gol
517 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
518 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
519 -mtail-call}
520
521 @emph{DEC Alpha Options}
522 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
523 -mieee  -mieee-with-inexact  -mieee-conformant @gol
524 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
525 -mtrap-precision=@var{mode}  -mbuild-constants @gol
526 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
527 -mbwx  -mmax  -mfix  -mcix @gol
528 -mfloat-vax  -mfloat-ieee @gol
529 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
530 -msmall-text  -mlarge-text @gol
531 -mmemory-latency=@var{time}}
532
533 @emph{DEC Alpha/VMS Options}
534 @gccoptlist{-mvms-return-codes}
535
536 @emph{H8/300 Options}
537 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
538
539 @emph{SH Options}
540 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
541 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
542 -m5-64media  -m5-64media-nofpu @gol
543 -m5-32media  -m5-32media-nofpu @gol
544 -m5-compact  -m5-compact-nofpu @gol
545 -mb  -ml  -mdalign  -mrelax @gol
546 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
547 -mieee  -misize  -mpadstruct  -mspace @gol
548 -mprefergot  -musermode}
549
550 @emph{System V Options}
551 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
552
553 @emph{ARC Options}
554 @gccoptlist{-EB  -EL @gol
555 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
556 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
557
558 @emph{TMS320C3x/C4x Options}
559 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
560 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
561 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
562 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
563
564 @emph{V850 Options}
565 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
566 -mprolog-function  -mno-prolog-function  -mspace @gol
567 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
568 -mapp-regs  -mno-app-regs @gol
569 -mdisable-callt  -mno-disable-callt @gol
570 -mv850e @gol
571 -mv850  -mbig-switch}
572
573 @emph{NS32K Options}
574 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
575 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
576 -mregparam  -mnoregparam  -msb  -mnosb @gol
577 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
578
579 @emph{AVR Options}
580 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
581 -mcall-prologues  -mno-tablejump  -mtiny-stack}
582
583 @emph{MCore Options}
584 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
585 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
586 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
587 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
588 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
589
590 @emph{MMIX Options}
591 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
592 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
593 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
594 -mno-base-addresses  -msingle-exit  -mno-single-exit}
595
596 @emph{IA-64 Options}
597 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
598 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
599 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
600 -minline-float-divide-max-throughput @gol
601 -minline-int-divide-min-latency @gol
602 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
603 -mfixed-range=@var{register-range}}
604
605 @emph{D30V Options}
606 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
607 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
608
609 @emph{S/390 and zSeries Options}
610 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
611 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
612 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
613 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
614
615 @emph{CRIS Options}
616 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
617 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
618 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
619 -mstack-align  -mdata-align  -mconst-align @gol
620 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
621 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
622
623 @emph{PDP-11 Options}
624 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
625 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
626 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
627 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
628 -mbranch-expensive  -mbranch-cheap @gol
629 -msplit  -mno-split  -munix-asm  -mdec-asm}
630
631 @emph{Xstormy16 Options}
632 @gccoptlist{-msim}
633
634 @emph{Xtensa Options}
635 @gccoptlist{-mbig-endian  -mlittle-endian @gol
636 -mdensity  -mno-density @gol
637 -mmac16  -mno-mac16 @gol
638 -mmul16  -mno-mul16 @gol
639 -mmul32  -mno-mul32 @gol
640 -mnsa  -mno-nsa @gol
641 -mminmax  -mno-minmax @gol
642 -msext  -mno-sext @gol
643 -mbooleans  -mno-booleans @gol
644 -mhard-float  -msoft-float @gol
645 -mfused-madd  -mno-fused-madd @gol
646 -mserialize-volatile  -mno-serialize-volatile @gol
647 -mtext-section-literals  -mno-text-section-literals @gol
648 -mtarget-align  -mno-target-align @gol
649 -mlongcalls  -mno-longcalls}
650
651 @emph{FRV Options}
652 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
653 -mhard-float  -msoft-float @gol
654 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
655 -mdouble  -mno-double @gol
656 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
657 -mlibrary-pic  -macc-4 -macc-8 @gol
658 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
659 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
660 -mvliw-branch  -mno-vliw-branch @gol
661 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
662 -mno-nested-cond-exec  -mtomcat-stats @gol
663 -mcpu=@var{cpu}}
664
665 @item Code Generation Options
666 @xref{Code Gen Options,,Options for Code Generation Conventions}.
667 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
668 -ffixed-@var{reg}  -fexceptions @gol
669 -fnon-call-exceptions  -funwind-tables @gol
670 -fasynchronous-unwind-tables  -fforced-unwind-exceptions @gol
671 -finhibit-size-directive  -finstrument-functions @gol
672 -fno-common  -fno-ident  -fno-gnu-linker @gol
673 -fpcc-struct-return  -fpic  -fPIC @gol
674 -freg-struct-return  -fshared-data  -fshort-enums @gol
675 -fshort-double  -fshort-wchar @gol
676 -fverbose-asm  -fpack-struct  -fstack-check @gol
677 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
678 -fargument-alias  -fargument-noalias @gol
679 -fargument-noalias-global  -fleading-underscore @gol
680 -ftls-model=@var{model} @gol
681 -ftrapv  -fbounds-check}
682 @end table
683
684 @menu
685 * Overall Options::     Controlling the kind of output:
686                         an executable, object files, assembler files,
687                         or preprocessed source.
688 * C Dialect Options::   Controlling the variant of C language compiled.
689 * C++ Dialect Options:: Variations on C++.
690 * Objective-C Dialect Options:: Variations on Objective-C.
691 * Language Independent Options:: Controlling how diagnostics should be
692                         formatted.
693 * Warning Options::     How picky should the compiler be?
694 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
695 * Optimize Options::    How much optimization?
696 * Preprocessor Options:: Controlling header files and macro definitions.
697                          Also, getting dependency information for Make.
698 * Assembler Options::   Passing options to the assembler.
699 * Link Options::        Specifying libraries and so on.
700 * Directory Options::   Where to find header files and libraries.
701                         Where to find the compiler executable files.
702 * Spec Files::          How to pass switches to sub-processes.
703 * Target Options::      Running a cross-compiler, or an old version of GCC.
704 @end menu
705
706 @node Overall Options
707 @section Options Controlling the Kind of Output
708
709 Compilation can involve up to four stages: preprocessing, compilation
710 proper, assembly and linking, always in that order.  The first three
711 stages apply to an individual source file, and end by producing an
712 object file; linking combines all the object files (those newly
713 compiled, and those specified as input) into an executable file.
714
715 @cindex file name suffix
716 For any given input file, the file name suffix determines what kind of
717 compilation is done:
718
719 @table @gcctabopt
720 @item @var{file}.c
721 C source code which must be preprocessed.
722
723 @item @var{file}.i
724 C source code which should not be preprocessed.
725
726 @item @var{file}.ii
727 C++ source code which should not be preprocessed.
728
729 @item @var{file}.m
730 Objective-C source code.  Note that you must link with the library
731 @file{libobjc.a} to make an Objective-C program work.
732
733 @item @var{file}.mi
734 Objective-C source code which should not be preprocessed.
735
736 @item @var{file}.h
737 C or C++ header file to be turned into a precompiled header.
738
739 @item @var{file}.cc
740 @itemx @var{file}.cp
741 @itemx @var{file}.cxx
742 @itemx @var{file}.cpp
743 @itemx @var{file}.CPP
744 @itemx @var{file}.c++
745 @itemx @var{file}.C
746 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
747 the last two letters must both be literally @samp{x}.  Likewise,
748 @samp{.C} refers to a literal capital C@.
749
750 @item @var{file}.hh
751 @itemx @var{file}.H
752 C++ header file to be turned into a precompiled header.
753
754 @item @var{file}.f
755 @itemx @var{file}.for
756 @itemx @var{file}.FOR
757 Fortran source code which should not be preprocessed.
758
759 @item @var{file}.F
760 @itemx @var{file}.fpp
761 @itemx @var{file}.FPP
762 Fortran source code which must be preprocessed (with the traditional
763 preprocessor).
764
765 @item @var{file}.r
766 Fortran source code which must be preprocessed with a RATFOR
767 preprocessor (not included with GCC)@.
768
769 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
770 Using and Porting GNU Fortran}, for more details of the handling of
771 Fortran input files.
772
773 @c FIXME: Descriptions of Java file types.
774 @c @var{file}.java
775 @c @var{file}.class
776 @c @var{file}.zip
777 @c @var{file}.jar
778
779 @item @var{file}.ads
780 Ada source code file which contains a library unit declaration (a
781 declaration of a package, subprogram, or generic, or a generic
782 instantiation), or a library unit renaming declaration (a package,
783 generic, or subprogram renaming declaration).  Such files are also
784 called @dfn{specs}.
785
786 @itemx @var{file}.adb
787 Ada source code file containing a library unit body (a subprogram or
788 package body).  Such files are also called @dfn{bodies}.
789
790 @c GCC also knows about some suffixes for languages not yet included:
791 @c Pascal:
792 @c @var{file}.p
793 @c @var{file}.pas
794
795 @item @var{file}.s
796 Assembler code.
797
798 @item @var{file}.S
799 Assembler code which must be preprocessed.
800
801 @item @var{other}
802 An object file to be fed straight into linking.
803 Any file name with no recognized suffix is treated this way.
804 @end table
805
806 @opindex x
807 You can specify the input language explicitly with the @option{-x} option:
808
809 @table @gcctabopt
810 @item -x @var{language}
811 Specify explicitly the @var{language} for the following input files
812 (rather than letting the compiler choose a default based on the file
813 name suffix).  This option applies to all following input files until
814 the next @option{-x} option.  Possible values for @var{language} are:
815 @example
816 c  c-header  cpp-output
817 c++  c++-header  c++-cpp-output
818 objective-c  objc-cpp-output
819 assembler  assembler-with-cpp
820 ada
821 f77  f77-cpp-input  ratfor
822 java
823 treelang
824 @end example
825
826 @item -x none
827 Turn off any specification of a language, so that subsequent files are
828 handled according to their file name suffixes (as they are if @option{-x}
829 has not been used at all).
830
831 @item -pass-exit-codes
832 @opindex pass-exit-codes
833 Normally the @command{gcc} program will exit with the code of 1 if any
834 phase of the compiler returns a non-success return code.  If you specify
835 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
836 numerically highest error produced by any phase that returned an error
837 indication.
838 @end table
839
840 If you only want some of the stages of compilation, you can use
841 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
842 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
843 @command{gcc} is to stop.  Note that some combinations (for example,
844 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
845
846 @table @gcctabopt
847 @item -c
848 @opindex c
849 Compile or assemble the source files, but do not link.  The linking
850 stage simply is not done.  The ultimate output is in the form of an
851 object file for each source file.
852
853 By default, the object file name for a source file is made by replacing
854 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
855
856 Unrecognized input files, not requiring compilation or assembly, are
857 ignored.
858
859 @item -S
860 @opindex S
861 Stop after the stage of compilation proper; do not assemble.  The output
862 is in the form of an assembler code file for each non-assembler input
863 file specified.
864
865 By default, the assembler file name for a source file is made by
866 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
867
868 Input files that don't require compilation are ignored.
869
870 @item -E
871 @opindex E
872 Stop after the preprocessing stage; do not run the compiler proper.  The
873 output is in the form of preprocessed source code, which is sent to the
874 standard output.
875
876 Input files which don't require preprocessing are ignored.
877
878 @cindex output file option
879 @item -o @var{file}
880 @opindex o
881 Place output in file @var{file}.  This applies regardless to whatever
882 sort of output is being produced, whether it be an executable file,
883 an object file, an assembler file or preprocessed C code.
884
885 Since only one output file can be specified, it does not make sense to
886 use @option{-o} when compiling more than one input file, unless you are
887 producing an executable file as output.
888
889 If @option{-o} is not specified, the default is to put an executable file
890 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
891 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
892 all preprocessed C source on standard output.
893
894 @item -v
895 @opindex v
896 Print (on standard error output) the commands executed to run the stages
897 of compilation.  Also print the version number of the compiler driver
898 program and of the preprocessor and the compiler proper.
899
900 @item -###
901 @opindex ###
902 Like @option{-v} except the commands are not executed and all command
903 arguments are quoted.  This is useful for shell scripts to capture the
904 driver-generated command lines.
905
906 @item -pipe
907 @opindex pipe
908 Use pipes rather than temporary files for communication between the
909 various stages of compilation.  This fails to work on some systems where
910 the assembler is unable to read from a pipe; but the GNU assembler has
911 no trouble.
912
913 @item --help
914 @opindex help
915 Print (on the standard output) a description of the command line options
916 understood by @command{gcc}.  If the @option{-v} option is also specified
917 then @option{--help} will also be passed on to the various processes
918 invoked by @command{gcc}, so that they can display the command line options
919 they accept.  If the @option{-Wextra} option is also specified then command
920 line options which have no documentation associated with them will also
921 be displayed.
922
923 @item --target-help
924 @opindex target-help
925 Print (on the standard output) a description of target specific command
926 line options for each tool.
927
928 @item --version
929 @opindex version
930 Display the version number and copyrights of the invoked GCC.
931 @end table
932
933 @node Invoking G++
934 @section Compiling C++ Programs
935
936 @cindex suffixes for C++ source
937 @cindex C++ source file suffixes
938 C++ source files conventionally use one of the suffixes @samp{.C},
939 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
940 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
941 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
942 files with these names and compiles them as C++ programs even if you
943 call the compiler the same way as for compiling C programs (usually
944 with the name @command{gcc}).
945
946 @findex g++
947 @findex c++
948 However, C++ programs often require class libraries as well as a
949 compiler that understands the C++ language---and under some
950 circumstances, you might want to compile programs or header files from
951 standard input, or otherwise without a suffix that flags them as C++
952 programs.  You might also like to precompile a C header file with a
953 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
954 program that calls GCC with the default language set to C++, and
955 automatically specifies linking against the C++ library.  On many
956 systems, @command{g++} is also installed with the name @command{c++}.
957
958 @cindex invoking @command{g++}
959 When you compile C++ programs, you may specify many of the same
960 command-line options that you use for compiling programs in any
961 language; or command-line options meaningful for C and related
962 languages; or options that are meaningful only for C++ programs.
963 @xref{C Dialect Options,,Options Controlling C Dialect}, for
964 explanations of options for languages related to C@.
965 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
966 explanations of options that are meaningful only for C++ programs.
967
968 @node C Dialect Options
969 @section Options Controlling C Dialect
970 @cindex dialect options
971 @cindex language dialect options
972 @cindex options, dialect
973
974 The following options control the dialect of C (or languages derived
975 from C, such as C++ and Objective-C) that the compiler accepts:
976
977 @table @gcctabopt
978 @cindex ANSI support
979 @cindex ISO support
980 @item -ansi
981 @opindex ansi
982 In C mode, support all ISO C90 programs.  In C++ mode,
983 remove GNU extensions that conflict with ISO C++.
984
985 This turns off certain features of GCC that are incompatible with ISO
986 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
987 such as the @code{asm} and @code{typeof} keywords, and
988 predefined macros such as @code{unix} and @code{vax} that identify the
989 type of system you are using.  It also enables the undesirable and
990 rarely used ISO trigraph feature.  For the C compiler,
991 it disables recognition of C++ style @samp{//} comments as well as
992 the @code{inline} keyword.
993
994 The alternate keywords @code{__asm__}, @code{__extension__},
995 @code{__inline__} and @code{__typeof__} continue to work despite
996 @option{-ansi}.  You would not want to use them in an ISO C program, of
997 course, but it is useful to put them in header files that might be included
998 in compilations done with @option{-ansi}.  Alternate predefined macros
999 such as @code{__unix__} and @code{__vax__} are also available, with or
1000 without @option{-ansi}.
1001
1002 The @option{-ansi} option does not cause non-ISO programs to be
1003 rejected gratuitously.  For that, @option{-pedantic} is required in
1004 addition to @option{-ansi}.  @xref{Warning Options}.
1005
1006 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1007 option is used.  Some header files may notice this macro and refrain
1008 from declaring certain functions or defining certain macros that the
1009 ISO standard doesn't call for; this is to avoid interfering with any
1010 programs that might use these names for other things.
1011
1012 Functions which would normally be built in but do not have semantics
1013 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1014 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1015 built-in functions provided by GCC}, for details of the functions
1016 affected.
1017
1018 @item -std=
1019 @opindex std
1020 Determine the language standard.  This option is currently only
1021 supported when compiling C or C++.  A value for this option must be
1022 provided; possible values are
1023
1024 @table @samp
1025 @item c89
1026 @itemx iso9899:1990
1027 ISO C90 (same as @option{-ansi}).
1028
1029 @item iso9899:199409
1030 ISO C90 as modified in amendment 1.
1031
1032 @item c99
1033 @itemx c9x
1034 @itemx iso9899:1999
1035 @itemx iso9899:199x
1036 ISO C99.  Note that this standard is not yet fully supported; see
1037 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1038 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1039
1040 @item gnu89
1041 Default, ISO C90 plus GNU extensions (including some C99 features).
1042
1043 @item gnu99
1044 @item gnu9x
1045 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1046 this will become the default.  The name @samp{gnu9x} is deprecated.
1047
1048 @item c++98
1049 The 1998 ISO C++ standard plus amendments.
1050
1051 @item gnu++98
1052 The same as @option{-std=c++98} plus GNU extensions.  This is the
1053 default for C++ code.
1054 @end table
1055
1056 Even when this option is not specified, you can still use some of the
1057 features of newer standards in so far as they do not conflict with
1058 previous C standards.  For example, you may use @code{__restrict__} even
1059 when @option{-std=c99} is not specified.
1060
1061 The @option{-std} options specifying some version of ISO C have the same
1062 effects as @option{-ansi}, except that features that were not in ISO C90
1063 but are in the specified version (for example, @samp{//} comments and
1064 the @code{inline} keyword in ISO C99) are not disabled.
1065
1066 @xref{Standards,,Language Standards Supported by GCC}, for details of
1067 these standard versions.
1068
1069 @item -aux-info @var{filename}
1070 @opindex aux-info
1071 Output to the given filename prototyped declarations for all functions
1072 declared and/or defined in a translation unit, including those in header
1073 files.  This option is silently ignored in any language other than C@.
1074
1075 Besides declarations, the file indicates, in comments, the origin of
1076 each declaration (source file and line), whether the declaration was
1077 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1078 @samp{O} for old, respectively, in the first character after the line
1079 number and the colon), and whether it came from a declaration or a
1080 definition (@samp{C} or @samp{F}, respectively, in the following
1081 character).  In the case of function definitions, a K&R-style list of
1082 arguments followed by their declarations is also provided, inside
1083 comments, after the declaration.
1084
1085 @item -fno-asm
1086 @opindex fno-asm
1087 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1088 keyword, so that code can use these words as identifiers.  You can use
1089 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1090 instead.  @option{-ansi} implies @option{-fno-asm}.
1091
1092 In C++, this switch only affects the @code{typeof} keyword, since
1093 @code{asm} and @code{inline} are standard keywords.  You may want to
1094 use the @option{-fno-gnu-keywords} flag instead, which has the same
1095 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1096 switch only affects the @code{asm} and @code{typeof} keywords, since
1097 @code{inline} is a standard keyword in ISO C99.
1098
1099 @item -fno-builtin
1100 @itemx -fno-builtin-@var{function}
1101 @opindex fno-builtin
1102 @cindex built-in functions
1103 Don't recognize built-in functions that do not begin with
1104 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1105 functions provided by GCC}, for details of the functions affected,
1106 including those which are not built-in functions when @option{-ansi} or
1107 @option{-std} options for strict ISO C conformance are used because they
1108 do not have an ISO standard meaning.
1109
1110 GCC normally generates special code to handle certain built-in functions
1111 more efficiently; for instance, calls to @code{alloca} may become single
1112 instructions that adjust the stack directly, and calls to @code{memcpy}
1113 may become inline copy loops.  The resulting code is often both smaller
1114 and faster, but since the function calls no longer appear as such, you
1115 cannot set a breakpoint on those calls, nor can you change the behavior
1116 of the functions by linking with a different library.
1117
1118 With the @option{-fno-builtin-@var{function}} option
1119 only the built-in function @var{function} is
1120 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1121 function is named this is not built-in in this version of GCC, this
1122 option is ignored.  There is no corresponding
1123 @option{-fbuiltin-@var{function}} option; if you wish to enable
1124 built-in functions selectively when using @option{-fno-builtin} or
1125 @option{-ffreestanding}, you may define macros such as:
1126
1127 @smallexample
1128 #define abs(n)          __builtin_abs ((n))
1129 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1130 @end smallexample
1131
1132 @item -fhosted
1133 @opindex fhosted
1134 @cindex hosted environment
1135
1136 Assert that compilation takes place in a hosted environment.  This implies
1137 @option{-fbuiltin}.  A hosted environment is one in which the
1138 entire standard library is available, and in which @code{main} has a return
1139 type of @code{int}.  Examples are nearly everything except a kernel.
1140 This is equivalent to @option{-fno-freestanding}.
1141
1142 @item -ffreestanding
1143 @opindex ffreestanding
1144 @cindex hosted environment
1145
1146 Assert that compilation takes place in a freestanding environment.  This
1147 implies @option{-fno-builtin}.  A freestanding environment
1148 is one in which the standard library may not exist, and program startup may
1149 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1150 This is equivalent to @option{-fno-hosted}.
1151
1152 @xref{Standards,,Language Standards Supported by GCC}, for details of
1153 freestanding and hosted environments.
1154
1155 @item -fms-extensions
1156 @opindex fms-extensions
1157 Accept some non-standard constructs used in Microsoft header files.
1158
1159 @item -trigraphs
1160 @opindex trigraphs
1161 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1162 options for strict ISO C conformance) implies @option{-trigraphs}.
1163
1164 @item -no-integrated-cpp
1165 @opindex no-integrated-cpp
1166 Performs a compilation in two passes: preprocessing and compiling.  This
1167 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1168 @option{-B} option. The user supplied compilation step can then add in
1169 an additional preprocessing step after normal preprocessing but before
1170 compiling. The default is to use the integrated cpp (internal cpp)
1171
1172 The semantics of this option will change if "cc1", "cc1plus", and
1173 "cc1obj" are merged.
1174
1175 @cindex traditional C language
1176 @cindex C language, traditional
1177 @item -traditional
1178 @itemx -traditional-cpp
1179 @opindex traditional-cpp
1180 @opindex traditional
1181 Formerly, these options caused GCC to attempt to emulate a pre-standard
1182 C compiler.  They are now only supported with the @option{-E} switch.
1183 The preprocessor continues to support a pre-standard mode.  See the GNU
1184 CPP manual for details.
1185
1186 @item -fcond-mismatch
1187 @opindex fcond-mismatch
1188 Allow conditional expressions with mismatched types in the second and
1189 third arguments.  The value of such an expression is void.  This option
1190 is not supported for C++.
1191
1192 @item -funsigned-char
1193 @opindex funsigned-char
1194 Let the type @code{char} be unsigned, like @code{unsigned char}.
1195
1196 Each kind of machine has a default for what @code{char} should
1197 be.  It is either like @code{unsigned char} by default or like
1198 @code{signed char} by default.
1199
1200 Ideally, a portable program should always use @code{signed char} or
1201 @code{unsigned char} when it depends on the signedness of an object.
1202 But many programs have been written to use plain @code{char} and
1203 expect it to be signed, or expect it to be unsigned, depending on the
1204 machines they were written for.  This option, and its inverse, let you
1205 make such a program work with the opposite default.
1206
1207 The type @code{char} is always a distinct type from each of
1208 @code{signed char} or @code{unsigned char}, even though its behavior
1209 is always just like one of those two.
1210
1211 @item -fsigned-char
1212 @opindex fsigned-char
1213 Let the type @code{char} be signed, like @code{signed char}.
1214
1215 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1216 the negative form of @option{-funsigned-char}.  Likewise, the option
1217 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1218
1219 @item -fsigned-bitfields
1220 @itemx -funsigned-bitfields
1221 @itemx -fno-signed-bitfields
1222 @itemx -fno-unsigned-bitfields
1223 @opindex fsigned-bitfields
1224 @opindex funsigned-bitfields
1225 @opindex fno-signed-bitfields
1226 @opindex fno-unsigned-bitfields
1227 These options control whether a bit-field is signed or unsigned, when the
1228 declaration does not use either @code{signed} or @code{unsigned}.  By
1229 default, such a bit-field is signed, because this is consistent: the
1230 basic integer types such as @code{int} are signed types.
1231
1232 @item -fwritable-strings
1233 @opindex fwritable-strings
1234 Store string constants in the writable data segment and don't uniquize
1235 them.  This is for compatibility with old programs which assume they can
1236 write into string constants.
1237
1238 Writing into string constants is a very bad idea; ``constants'' should
1239 be constant.
1240 @end table
1241
1242 @node C++ Dialect Options
1243 @section Options Controlling C++ Dialect
1244
1245 @cindex compiler options, C++
1246 @cindex C++ options, command line
1247 @cindex options, C++
1248 This section describes the command-line options that are only meaningful
1249 for C++ programs; but you can also use most of the GNU compiler options
1250 regardless of what language your program is in.  For example, you
1251 might compile a file @code{firstClass.C} like this:
1252
1253 @example
1254 g++ -g -frepo -O -c firstClass.C
1255 @end example
1256
1257 @noindent
1258 In this example, only @option{-frepo} is an option meant
1259 only for C++ programs; you can use the other options with any
1260 language supported by GCC@.
1261
1262 Here is a list of options that are @emph{only} for compiling C++ programs:
1263
1264 @table @gcctabopt
1265
1266 @item -fabi-version=@var{n}
1267 @opindex fabi-version
1268 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1269 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1270 version that conforms most closely to the C++ ABI specification.
1271 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1272 fixed.
1273
1274 The default is version 1.
1275
1276 @item -fno-access-control
1277 @opindex fno-access-control
1278 Turn off all access checking.  This switch is mainly useful for working
1279 around bugs in the access control code.
1280
1281 @item -fcheck-new
1282 @opindex fcheck-new
1283 Check that the pointer returned by @code{operator new} is non-null
1284 before attempting to modify the storage allocated.  The current Working
1285 Paper requires that @code{operator new} never return a null pointer, so
1286 this check is normally unnecessary.
1287
1288 An alternative to using this option is to specify that your
1289 @code{operator new} does not throw any exceptions; if you declare it
1290 @samp{throw()}, G++ will check the return value.  See also @samp{new
1291 (nothrow)}.
1292
1293 @item -fconserve-space
1294 @opindex fconserve-space
1295 Put uninitialized or runtime-initialized global variables into the
1296 common segment, as C does.  This saves space in the executable at the
1297 cost of not diagnosing duplicate definitions.  If you compile with this
1298 flag and your program mysteriously crashes after @code{main()} has
1299 completed, you may have an object that is being destroyed twice because
1300 two definitions were merged.
1301
1302 This option is no longer useful on most targets, now that support has
1303 been added for putting variables into BSS without making them common.
1304
1305 @item -fno-const-strings
1306 @opindex fno-const-strings
1307 Give string constants type @code{char *} instead of type @code{const
1308 char *}.  By default, G++ uses type @code{const char *} as required by
1309 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1310 actually modify the value of a string constant, unless you also use
1311 @option{-fwritable-strings}.
1312
1313 This option might be removed in a future release of G++.  For maximum
1314 portability, you should structure your code so that it works with
1315 string constants that have type @code{const char *}.
1316
1317 @item -fdollars-in-identifiers
1318 @opindex fdollars-in-identifiers
1319 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1320 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1321 @samp{$} by default on most target systems, but there are a few exceptions.)
1322 Traditional C allowed the character @samp{$} to form part of
1323 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
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 messages about nonconformant code from errors to warnings.  By
1423 default, G++ effectively sets @option{-pedantic-errors} without
1424 @option{-pedantic}; this option reverses that.  This behavior and this
1425 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1426
1427 @item -frepo
1428 @opindex frepo
1429 Enable automatic template instantiation at link time.  This option also
1430 implies @option{-fno-implicit-templates}.  @xref{Template
1431 Instantiation}, for more information.
1432
1433 @item -fno-rtti
1434 @opindex fno-rtti
1435 Disable generation of information about every class with virtual
1436 functions for use by the C++ runtime type identification features
1437 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1438 of the language, you can save some space by using this flag.  Note that
1439 exception handling uses the same information, but it will generate it as
1440 needed.
1441
1442 @item -fstats
1443 @opindex fstats
1444 Emit statistics about front-end processing at the end of the compilation.
1445 This information is generally only useful to the G++ development team.
1446
1447 @item -ftemplate-depth-@var{n}
1448 @opindex ftemplate-depth
1449 Set the maximum instantiation depth for template classes to @var{n}.
1450 A limit on the template instantiation depth is needed to detect
1451 endless recursions during template class instantiation.  ANSI/ISO C++
1452 conforming programs must not rely on a maximum depth greater than 17.
1453
1454 @item -fuse-cxa-atexit
1455 @opindex fuse-cxa-atexit
1456 Register destructors for objects with static storage duration with the
1457 @code{__cxa_atexit} function rather than the @code{atexit} function.
1458 This option is required for fully standards-compliant handling of static
1459 destructors, but will only work if your C library supports
1460 @code{__cxa_atexit}.
1461
1462 @item -fvtable-gc
1463 @opindex fvtable-gc
1464 Emit special relocations for vtables and virtual function references
1465 so that the linker can identify unused virtual functions and zero out
1466 vtable slots that refer to them.  This is most useful with
1467 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1468 also discard the functions themselves.
1469
1470 This optimization requires GNU as and GNU ld.  Not all systems support
1471 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1472
1473 @item -fno-weak
1474 @opindex fno-weak
1475 Do not use weak symbol support, even if it is provided by the linker.
1476 By default, G++ will use weak symbols if they are available.  This
1477 option exists only for testing, and should not be used by end-users;
1478 it will result in inferior code and has no benefits.  This option may
1479 be removed in a future release of G++.
1480
1481 @item -nostdinc++
1482 @opindex nostdinc++
1483 Do not search for header files in the standard directories specific to
1484 C++, but do still search the other standard directories.  (This option
1485 is used when building the C++ library.)
1486 @end table
1487
1488 In addition, these optimization, warning, and code generation options
1489 have meanings only for C++ programs:
1490
1491 @table @gcctabopt
1492 @item -fno-default-inline
1493 @opindex fno-default-inline
1494 Do not assume @samp{inline} for functions defined inside a class scope.
1495 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1496 functions will have linkage like inline functions; they just won't be
1497 inlined by default.
1498
1499 @item -Wabi @r{(C++ only)}
1500 @opindex Wabi
1501 Warn when G++ generates code that is probably not compatible with the
1502 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1503 all such cases, there are probably some cases that are not warned about, 
1504 even though G++ is generating incompatible code.  There may also be
1505 cases where warnings are emitted even though the code that is generated
1506 will be compatible.
1507
1508 You should rewrite your code to avoid these warnings if you are
1509 concerned about the fact that code generated by G++ may not be binary
1510 compatible with code generated by other compilers.
1511
1512 The known incompatibilities at this point include:
1513
1514 @itemize @bullet
1515
1516 @item
1517 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1518 pack data into the same byte as a base class.  For example:
1519
1520 @smallexample
1521 struct A @{ virtual void f(); int f1 : 1; @};
1522 struct B : public A @{ int f2 : 1; @};
1523 @end smallexample
1524
1525 @noindent
1526 In this case, G++ will place @code{B::f2} into the same byte
1527 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1528 by explicitly padding @code{A} so that its size is a multiple of the
1529 byte size on your platform; that will cause G++ and other compilers to
1530 layout @code{B} identically.
1531
1532 @item
1533 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1534 tail padding when laying out virtual bases.  For example:
1535
1536 @smallexample
1537 struct A @{ virtual void f(); char c1; @};
1538 struct B @{ B(); char c2; @};
1539 struct C : public A, public virtual B @{@};
1540 @end smallexample
1541
1542 @noindent
1543 In this case, G++ will not place @code{B} into the tail-padding for
1544 @code{A}; other compilers will.  You can avoid this problem by
1545 explicitly padding @code{A} so that its size is a multiple of its
1546 alignment (ignoring virtual base classes); that will cause G++ and other
1547 compilers to layout @code{C} identically.
1548
1549 @item
1550 Incorrect handling of bit-fields with declared widths greater than that
1551 of their underlying types, when the bit-fields appear in a union.  For
1552 example:
1553
1554 @smallexample
1555 union U @{ int i : 4096; @};
1556 @end smallexample
1557
1558 @noindent
1559 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1560 union too small by the number of bits in an @code{int}.
1561
1562 @item
1563 Empty classes can be placed at incorrect offsets.  For example:
1564  
1565 @smallexample
1566 struct A @{@};
1567
1568 struct B @{
1569   A a;
1570   virtual void f ();
1571 @};
1572
1573 struct C : public B, public A @{@};
1574 @end smallexample
1575
1576 @noindent
1577 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1578 it should be placed at offset zero.  G++ mistakenly believes that the
1579 @code{A} data member of @code{B} is already at offset zero.
1580
1581 @item
1582 Names of template functions whose types involve @code{typename} or
1583 template template parameters can be mangled incorrectly.
1584
1585 @smallexample
1586 template <typename Q>
1587 void f(typename Q::X) @{@}
1588
1589 template <template <typename> class Q>
1590 void f(typename Q<int>::X) @{@}
1591 @end smallexample
1592
1593 @noindent
1594 Instantiations of these templates may be mangled incorrectly.
1595
1596 @end itemize
1597
1598 @item -Wctor-dtor-privacy @r{(C++ only)}
1599 @opindex Wctor-dtor-privacy
1600 Warn when a class seems unusable, because all the constructors or
1601 destructors in a class are private and the class has no friends or
1602 public static member functions.  This warning is enabled by default.
1603
1604 @item -Wnon-virtual-dtor @r{(C++ only)}
1605 @opindex Wnon-virtual-dtor
1606 Warn when a class declares a non-virtual destructor that should probably
1607 be virtual, because it looks like the class will be used polymorphically.
1608 This warning is enabled by @option{-Wall}.
1609
1610 @item -Wreorder @r{(C++ only)}
1611 @opindex Wreorder
1612 @cindex reordering, warning
1613 @cindex warning for reordering of member initializers
1614 Warn when the order of member initializers given in the code does not
1615 match the order in which they must be executed.  For instance:
1616
1617 @smallexample
1618 struct A @{
1619   int i;
1620   int j;
1621   A(): j (0), i (1) @{ @}
1622 @};
1623 @end smallexample
1624
1625 Here the compiler will warn that the member initializers for @samp{i}
1626 and @samp{j} will be rearranged to match the declaration order of the
1627 members.  This warning is enabled by @option{-Wall}.
1628 @end table
1629
1630 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1631
1632 @table @gcctabopt
1633 @item -Weffc++ @r{(C++ only)}
1634 @opindex Weffc++
1635 Warn about violations of the following style guidelines from Scott Meyers'
1636 @cite{Effective C++} book:
1637
1638 @itemize @bullet
1639 @item
1640 Item 11:  Define a copy constructor and an assignment operator for classes
1641 with dynamically allocated memory.
1642
1643 @item
1644 Item 12:  Prefer initialization to assignment in constructors.
1645
1646 @item
1647 Item 14:  Make destructors virtual in base classes.
1648
1649 @item
1650 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1651
1652 @item
1653 Item 23:  Don't try to return a reference when you must return an object.
1654
1655 @end itemize
1656
1657 and about violations of the following style guidelines from Scott Meyers'
1658 @cite{More Effective C++} book:
1659
1660 @itemize @bullet
1661 @item
1662 Item 6:  Distinguish between prefix and postfix forms of increment and
1663 decrement operators.
1664
1665 @item
1666 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1667
1668 @end itemize
1669
1670 If you use this option, you should be aware that the standard library
1671 headers do not obey all of these guidelines; you can use @samp{grep -v}
1672 to filter out those warnings.
1673
1674 @item -Wno-deprecated @r{(C++ only)}
1675 @opindex Wno-deprecated
1676 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1677
1678 @item -Wno-non-template-friend @r{(C++ only)}
1679 @opindex Wno-non-template-friend
1680 Disable warnings when non-templatized friend functions are declared
1681 within a template.  With the advent of explicit template specification
1682 support in G++, if the name of the friend is an unqualified-id (i.e.,
1683 @samp{friend foo(int)}), the C++ language specification demands that the
1684 friend declare or define an ordinary, nontemplate function.  (Section
1685 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1686 could be interpreted as a particular specialization of a templatized
1687 function.  Because this non-conforming behavior is no longer the default
1688 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1689 check existing code for potential trouble spots, and is on by default.
1690 This new compiler behavior can be turned off with
1691 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1692 but disables the helpful warning.
1693
1694 @item -Wold-style-cast @r{(C++ only)}
1695 @opindex Wold-style-cast
1696 Warn if an old-style (C-style) cast to a non-void type is used within
1697 a C++ program.  The new-style casts (@samp{static_cast},
1698 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1699 unintended effects, and much easier to grep for.
1700
1701 @item -Woverloaded-virtual @r{(C++ only)}
1702 @opindex Woverloaded-virtual
1703 @cindex overloaded virtual fn, warning
1704 @cindex warning for overloaded virtual fn
1705 Warn when a function declaration hides virtual functions from a
1706 base class.  For example, in:
1707
1708 @smallexample
1709 struct A @{
1710   virtual void f();
1711 @};
1712
1713 struct B: public A @{
1714   void f(int);
1715 @};
1716 @end smallexample
1717
1718 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1719 like this:
1720
1721 @smallexample
1722 B* b;
1723 b->f();
1724 @end smallexample
1725
1726 will fail to compile.
1727
1728 @item -Wno-pmf-conversions @r{(C++ only)}
1729 @opindex Wno-pmf-conversions
1730 Disable the diagnostic for converting a bound pointer to member function
1731 to a plain pointer.
1732
1733 @item -Wsign-promo @r{(C++ only)}
1734 @opindex Wsign-promo
1735 Warn when overload resolution chooses a promotion from unsigned or
1736 enumeral type to a signed type over a conversion to an unsigned type of
1737 the same size.  Previous versions of G++ would try to preserve
1738 unsignedness, but the standard mandates the current behavior.
1739
1740 @item -Wsynth @r{(C++ only)}
1741 @opindex Wsynth
1742 @cindex warning for synthesized methods
1743 @cindex synthesized methods, warning
1744 Warn when G++'s synthesis behavior does not match that of cfront.  For
1745 instance:
1746
1747 @smallexample
1748 struct A @{
1749   operator int ();
1750   A& operator = (int);
1751 @};
1752
1753 main ()
1754 @{
1755   A a,b;
1756   a = b;
1757 @}
1758 @end smallexample
1759
1760 In this example, G++ will synthesize a default @samp{A& operator =
1761 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1762 @end table
1763
1764 @node Objective-C Dialect Options
1765 @section Options Controlling Objective-C Dialect
1766
1767 @cindex compiler options, Objective-C
1768 @cindex Objective-C options, command line
1769 @cindex options, Objective-C
1770 This section describes the command-line options that are only meaningful
1771 for Objective-C programs; but you can also use most of the GNU compiler
1772 options regardless of what language your program is in.  For example,
1773 you might compile a file @code{some_class.m} like this:
1774
1775 @example
1776 gcc -g -fgnu-runtime -O -c some_class.m
1777 @end example
1778
1779 @noindent
1780 In this example, only @option{-fgnu-runtime} is an option meant only for
1781 Objective-C programs; you can use the other options with any language
1782 supported by GCC@.
1783
1784 Here is a list of options that are @emph{only} for compiling Objective-C
1785 programs:
1786
1787 @table @gcctabopt
1788 @item -fconstant-string-class=@var{class-name}
1789 @opindex fconstant-string-class
1790 Use @var{class-name} as the name of the class to instantiate for each
1791 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1792 class name is @code{NXConstantString}.
1793
1794 @item -fgnu-runtime
1795 @opindex fgnu-runtime
1796 Generate object code compatible with the standard GNU Objective-C
1797 runtime.  This is the default for most types of systems.
1798
1799 @item -fnext-runtime
1800 @opindex fnext-runtime
1801 Generate output compatible with the NeXT runtime.  This is the default
1802 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1803 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1804 used.
1805
1806 @item -gen-decls
1807 @opindex gen-decls
1808 Dump interface declarations for all classes seen in the source file to a
1809 file named @file{@var{sourcename}.decl}.
1810
1811 @item -Wno-protocol
1812 @opindex Wno-protocol
1813 If a class is declared to implement a protocol, a warning is issued for
1814 every method in the protocol that is not implemented by the class.  The
1815 default behavior is to issue a warning for every method not explicitly
1816 implemented in the class, even if a method implementation is inherited
1817 from the superclass.  If you use the @code{-Wno-protocol} option, then
1818 methods inherited from the superclass are considered to be implemented,
1819 and no warning is issued for them.
1820
1821 @item -Wselector
1822 @opindex Wselector
1823 Warn if multiple methods of different types for the same selector are
1824 found during compilation.  The check is performed on the list of methods
1825 in the final stage of compilation.  Additionally, a check is performed
1826 that for each selector appearing in a @code{@@selector(@dots{})}
1827 expression, a corresponding method with that selector has been found
1828 during compilation.  Because these checks scan the method table only at
1829 the end of compilation, these warnings are not produced if the final
1830 stage of compilation is not reached, for example because an error is
1831 found during compilation, or because the @code{-fsyntax-only} option is
1832 being used.
1833
1834 @item -Wundeclared-selector
1835 @opindex Wundeclared-selector
1836 Warn if a @code{@@selector(@dots{})} expression referring to an
1837 undeclared selector is found.  A selector is considered undeclared if no
1838 method with that name has been declared (explicitly, in an
1839 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1840 an @code{@@implementation} section) before the
1841 @code{@@selector(@dots{})} expression.  This option always performs its
1842 checks as soon as a @code{@@selector(@dots{})} expression is found
1843 (while @code{-Wselector} only performs its checks in the final stage of
1844 compilation), and so additionally enforces the coding style convention
1845 that methods and selectors must be declared before being used.
1846
1847 @c not documented because only avail via -Wp
1848 @c @item -print-objc-runtime-info
1849
1850 @end table
1851
1852 @node Language Independent Options
1853 @section Options to Control Diagnostic Messages Formatting
1854 @cindex options to control diagnostics formatting
1855 @cindex diagnostic messages
1856 @cindex message formatting
1857
1858 Traditionally, diagnostic messages have been formatted irrespective of
1859 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1860 below can be used to control the diagnostic messages formatting
1861 algorithm, e.g.@: how many characters per line, how often source location
1862 information should be reported.  Right now, only the C++ front end can
1863 honor these options.  However it is expected, in the near future, that
1864 the remaining front ends would be able to digest them correctly.
1865
1866 @table @gcctabopt
1867 @item -fmessage-length=@var{n}
1868 @opindex fmessage-length
1869 Try to format error messages so that they fit on lines of about @var{n}
1870 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1871 the front ends supported by GCC@.  If @var{n} is zero, then no
1872 line-wrapping will be done; each error message will appear on a single
1873 line.
1874
1875 @opindex fdiagnostics-show-location
1876 @item -fdiagnostics-show-location=once
1877 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1878 reporter to emit @emph{once} source location information; that is, in
1879 case the message is too long to fit on a single physical line and has to
1880 be wrapped, the source location won't be emitted (as prefix) again,
1881 over and over, in subsequent continuation lines.  This is the default
1882 behavior.
1883
1884 @item -fdiagnostics-show-location=every-line
1885 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1886 messages reporter to emit the same source location information (as
1887 prefix) for physical lines that result from the process of breaking
1888 a message which is too long to fit on a single line.
1889
1890 @end table
1891
1892 @node Warning Options
1893 @section Options to Request or Suppress Warnings
1894 @cindex options to control warnings
1895 @cindex warning messages
1896 @cindex messages, warning
1897 @cindex suppressing warnings
1898
1899 Warnings are diagnostic messages that report constructions which
1900 are not inherently erroneous but which are risky or suggest there
1901 may have been an error.
1902
1903 You can request many specific warnings with options beginning @samp{-W},
1904 for example @option{-Wimplicit} to request warnings on implicit
1905 declarations.  Each of these specific warning options also has a
1906 negative form beginning @samp{-Wno-} to turn off warnings;
1907 for example, @option{-Wno-implicit}.  This manual lists only one of the
1908 two forms, whichever is not the default.
1909
1910 The following options control the amount and kinds of warnings produced
1911 by GCC; for further, language-specific options also refer to
1912 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1913
1914 @table @gcctabopt
1915 @cindex syntax checking
1916 @item -fsyntax-only
1917 @opindex fsyntax-only
1918 Check the code for syntax errors, but don't do anything beyond that.
1919
1920 @item -pedantic
1921 @opindex pedantic
1922 Issue all the warnings demanded by strict ISO C and ISO C++;
1923 reject all programs that use forbidden extensions, and some other
1924 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1925 version of the ISO C standard specified by any @option{-std} option used.
1926
1927 Valid ISO C and ISO C++ programs should compile properly with or without
1928 this option (though a rare few will require @option{-ansi} or a
1929 @option{-std} option specifying the required version of ISO C)@.  However,
1930 without this option, certain GNU extensions and traditional C and C++
1931 features are supported as well.  With this option, they are rejected.
1932
1933 @option{-pedantic} does not cause warning messages for use of the
1934 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1935 warnings are also disabled in the expression that follows
1936 @code{__extension__}.  However, only system header files should use
1937 these escape routes; application programs should avoid them.
1938 @xref{Alternate Keywords}.
1939
1940 Some users try to use @option{-pedantic} to check programs for strict ISO
1941 C conformance.  They soon find that it does not do quite what they want:
1942 it finds some non-ISO practices, but not all---only those for which
1943 ISO C @emph{requires} a diagnostic, and some others for which
1944 diagnostics have been added.
1945
1946 A feature to report any failure to conform to ISO C might be useful in
1947 some instances, but would require considerable additional work and would
1948 be quite different from @option{-pedantic}.  We don't have plans to
1949 support such a feature in the near future.
1950
1951 Where the standard specified with @option{-std} represents a GNU
1952 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1953 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1954 extended dialect is based.  Warnings from @option{-pedantic} are given
1955 where they are required by the base standard.  (It would not make sense
1956 for such warnings to be given only for features not in the specified GNU
1957 C dialect, since by definition the GNU dialects of C include all
1958 features the compiler supports with the given option, and there would be
1959 nothing to warn about.)
1960
1961 @item -pedantic-errors
1962 @opindex pedantic-errors
1963 Like @option{-pedantic}, except that errors are produced rather than
1964 warnings.
1965
1966 @item -w
1967 @opindex w
1968 Inhibit all warning messages.
1969
1970 @item -Wno-import
1971 @opindex Wno-import
1972 Inhibit warning messages about the use of @samp{#import}.
1973
1974 @item -Wchar-subscripts
1975 @opindex Wchar-subscripts
1976 Warn if an array subscript has type @code{char}.  This is a common cause
1977 of error, as programmers often forget that this type is signed on some
1978 machines.
1979
1980 @item -Wcomment
1981 @opindex Wcomment
1982 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1983 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1984
1985 @item -Wformat
1986 @opindex Wformat
1987 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1988 the arguments supplied have types appropriate to the format string
1989 specified, and that the conversions specified in the format string make
1990 sense.  This includes standard functions, and others specified by format
1991 attributes (@pxref{Function Attributes}), in the @code{printf},
1992 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1993 not in the C standard) families.
1994
1995 The formats are checked against the format features supported by GNU
1996 libc version 2.2.  These include all ISO C90 and C99 features, as well
1997 as features from the Single Unix Specification and some BSD and GNU
1998 extensions.  Other library implementations may not support all these
1999 features; GCC does not support warning about features that go beyond a
2000 particular library's limitations.  However, if @option{-pedantic} is used
2001 with @option{-Wformat}, warnings will be given about format features not
2002 in the selected standard version (but not for @code{strfmon} formats,
2003 since those are not in any version of the C standard).  @xref{C Dialect
2004 Options,,Options Controlling C Dialect}.
2005
2006 Since @option{-Wformat} also checks for null format arguments for
2007 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2008
2009 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2010 aspects of format checking, the options @option{-Wno-format-y2k},
2011 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2012 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2013 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2014
2015 @item -Wno-format-y2k
2016 @opindex Wno-format-y2k
2017 If @option{-Wformat} is specified, do not warn about @code{strftime}
2018 formats which may yield only a two-digit year.
2019
2020 @item -Wno-format-extra-args
2021 @opindex Wno-format-extra-args
2022 If @option{-Wformat} is specified, do not warn about excess arguments to a
2023 @code{printf} or @code{scanf} format function.  The C standard specifies
2024 that such arguments are ignored.
2025
2026 Where the unused arguments lie between used arguments that are
2027 specified with @samp{$} operand number specifications, normally
2028 warnings are still given, since the implementation could not know what
2029 type to pass to @code{va_arg} to skip the unused arguments.  However,
2030 in the case of @code{scanf} formats, this option will suppress the
2031 warning if the unused arguments are all pointers, since the Single
2032 Unix Specification says that such unused arguments are allowed.
2033
2034 @item -Wno-format-zero-length
2035 @opindex Wno-format-zero-length
2036 If @option{-Wformat} is specified, do not warn about zero-length formats.
2037 The C standard specifies that zero-length formats are allowed.
2038
2039 @item -Wformat-nonliteral
2040 @opindex Wformat-nonliteral
2041 If @option{-Wformat} is specified, also warn if the format string is not a
2042 string literal and so cannot be checked, unless the format function
2043 takes its format arguments as a @code{va_list}.
2044
2045 @item -Wformat-security
2046 @opindex Wformat-security
2047 If @option{-Wformat} is specified, also warn about uses of format
2048 functions that represent possible security problems.  At present, this
2049 warns about calls to @code{printf} and @code{scanf} functions where the
2050 format string is not a string literal and there are no format arguments,
2051 as in @code{printf (foo);}.  This may be a security hole if the format
2052 string came from untrusted input and contains @samp{%n}.  (This is
2053 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2054 in future warnings may be added to @option{-Wformat-security} that are not
2055 included in @option{-Wformat-nonliteral}.)
2056
2057 @item -Wformat=2
2058 @opindex Wformat=2
2059 Enable @option{-Wformat} plus format checks not included in
2060 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2061 -Wformat-nonliteral -Wformat-security}.
2062
2063 @item -Wnonnull
2064 @opindex Wnonnull
2065 Enable warning about passing a null pointer for arguments marked as
2066 requiring a non-null value by the @code{nonnull} function attribute.
2067
2068 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2069 can be disabled with the @option{-Wno-nonnull} option.
2070
2071 @item -Wimplicit-int
2072 @opindex Wimplicit-int
2073 Warn when a declaration does not specify a type.
2074
2075 @item -Wimplicit-function-declaration
2076 @itemx -Werror-implicit-function-declaration
2077 @opindex Wimplicit-function-declaration
2078 @opindex Werror-implicit-function-declaration
2079 Give a warning (or error) whenever a function is used before being
2080 declared.
2081
2082 @item -Wimplicit
2083 @opindex Wimplicit
2084 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2085
2086 @item -Wmain
2087 @opindex Wmain
2088 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2089 function with external linkage, returning int, taking either zero
2090 arguments, two, or three arguments of appropriate types.
2091
2092 @item -Wmissing-braces
2093 @opindex Wmissing-braces
2094 Warn if an aggregate or union initializer is not fully bracketed.  In
2095 the following example, the initializer for @samp{a} is not fully
2096 bracketed, but that for @samp{b} is fully bracketed.
2097
2098 @smallexample
2099 int a[2][2] = @{ 0, 1, 2, 3 @};
2100 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2101 @end smallexample
2102
2103 @item -Wparentheses
2104 @opindex Wparentheses
2105 Warn if parentheses are omitted in certain contexts, such
2106 as when there is an assignment in a context where a truth value
2107 is expected, or when operators are nested whose precedence people
2108 often get confused about.
2109
2110 Also warn about constructions where there may be confusion to which
2111 @code{if} statement an @code{else} branch belongs.  Here is an example of
2112 such a case:
2113
2114 @smallexample
2115 @group
2116 @{
2117   if (a)
2118     if (b)
2119       foo ();
2120   else
2121     bar ();
2122 @}
2123 @end group
2124 @end smallexample
2125
2126 In C, every @code{else} branch belongs to the innermost possible @code{if}
2127 statement, which in this example is @code{if (b)}.  This is often not
2128 what the programmer expected, as illustrated in the above example by
2129 indentation the programmer chose.  When there is the potential for this
2130 confusion, GCC will issue a warning when this flag is specified.
2131 To eliminate the warning, add explicit braces around the innermost
2132 @code{if} statement so there is no way the @code{else} could belong to
2133 the enclosing @code{if}.  The resulting code would look like this:
2134
2135 @smallexample
2136 @group
2137 @{
2138   if (a)
2139     @{
2140       if (b)
2141         foo ();
2142       else
2143         bar ();
2144     @}
2145 @}
2146 @end group
2147 @end smallexample
2148
2149 @item -Wsequence-point
2150 @opindex Wsequence-point
2151 Warn about code that may have undefined semantics because of violations
2152 of sequence point rules in the C standard.
2153
2154 The C standard defines the order in which expressions in a C program are
2155 evaluated in terms of @dfn{sequence points}, which represent a partial
2156 ordering between the execution of parts of the program: those executed
2157 before the sequence point, and those executed after it.  These occur
2158 after the evaluation of a full expression (one which is not part of a
2159 larger expression), after the evaluation of the first operand of a
2160 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2161 function is called (but after the evaluation of its arguments and the
2162 expression denoting the called function), and in certain other places.
2163 Other than as expressed by the sequence point rules, the order of
2164 evaluation of subexpressions of an expression is not specified.  All
2165 these rules describe only a partial order rather than a total order,
2166 since, for example, if two functions are called within one expression
2167 with no sequence point between them, the order in which the functions
2168 are called is not specified.  However, the standards committee have
2169 ruled that function calls do not overlap.
2170
2171 It is not specified when between sequence points modifications to the
2172 values of objects take effect.  Programs whose behavior depends on this
2173 have undefined behavior; the C standard specifies that ``Between the
2174 previous and next sequence point an object shall have its stored value
2175 modified at most once by the evaluation of an expression.  Furthermore,
2176 the prior value shall be read only to determine the value to be
2177 stored.''.  If a program breaks these rules, the results on any
2178 particular implementation are entirely unpredictable.
2179
2180 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2181 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2182 diagnosed by this option, and it may give an occasional false positive
2183 result, but in general it has been found fairly effective at detecting
2184 this sort of problem in programs.
2185
2186 The present implementation of this option only works for C programs.  A
2187 future implementation may also work for C++ programs.
2188
2189 The C standard is worded confusingly, therefore there is some debate
2190 over the precise meaning of the sequence point rules in subtle cases.
2191 Links to discussions of the problem, including proposed formal
2192 definitions, may be found on our readings page, at
2193 @w{@uref{http://gcc.gnu.org/readings.html}}.
2194
2195 @item -Wreturn-type
2196 @opindex Wreturn-type
2197 Warn whenever a function is defined with a return-type that defaults to
2198 @code{int}.  Also warn about any @code{return} statement with no
2199 return-value in a function whose return-type is not @code{void}.
2200
2201 For C++, a function without return type always produces a diagnostic
2202 message, even when @option{-Wno-return-type} is specified.  The only
2203 exceptions are @samp{main} and functions defined in system headers.
2204
2205 @item -Wswitch
2206 @opindex Wswitch
2207 Warn whenever a @code{switch} statement has an index of enumeral type
2208 and lacks a @code{case} for one or more of the named codes of that
2209 enumeration.  (The presence of a @code{default} label prevents this
2210 warning.)  @code{case} labels outside the enumeration range also
2211 provoke warnings when this option is used.
2212
2213 @item -Wswitch-default
2214 @opindex Wswitch-switch
2215 Warn whenever a @code{switch} statement does not have a @code{default}
2216 case.
2217
2218 @item -Wswitch-enum
2219 @opindex Wswitch-enum
2220 Warn whenever a @code{switch} statement has an index of enumeral type
2221 and lacks a @code{case} for one or more of the named codes of that
2222 enumeration.  @code{case} labels outside the enumeration range also
2223 provoke warnings when this option is used.
2224
2225 @item -Wtrigraphs
2226 @opindex Wtrigraphs
2227 Warn if any trigraphs are encountered that might change the meaning of
2228 the program (trigraphs within comments are not warned about).
2229
2230 @item -Wunused-function
2231 @opindex Wunused-function
2232 Warn whenever a static function is declared but not defined or a
2233 non\-inline static function is unused.
2234
2235 @item -Wunused-label
2236 @opindex Wunused-label
2237 Warn whenever a label is declared but not used.
2238
2239 To suppress this warning use the @samp{unused} attribute
2240 (@pxref{Variable Attributes}).
2241
2242 @item -Wunused-parameter
2243 @opindex Wunused-parameter
2244 Warn whenever a function parameter is unused aside from its declaration.
2245
2246 To suppress this warning use the @samp{unused} attribute
2247 (@pxref{Variable Attributes}).
2248
2249 @item -Wunused-variable
2250 @opindex Wunused-variable
2251 Warn whenever a local variable or non-constant static variable is unused
2252 aside from its declaration
2253
2254 To suppress this warning use the @samp{unused} attribute
2255 (@pxref{Variable Attributes}).
2256
2257 @item -Wunused-value
2258 @opindex Wunused-value
2259 Warn whenever a statement computes a result that is explicitly not used.
2260
2261 To suppress this warning cast the expression to @samp{void}.
2262
2263 @item -Wunused
2264 @opindex Wunused
2265 All the above @option{-Wunused} options combined.
2266
2267 In order to get a warning about an unused function parameter, you must
2268 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2269 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2270
2271 @item -Wuninitialized
2272 @opindex Wuninitialized
2273 Warn if an automatic variable is used without first being initialized or
2274 if a variable may be clobbered by a @code{setjmp} call.
2275
2276 These warnings are possible only in optimizing compilation,
2277 because they require data flow information that is computed only
2278 when optimizing.  If you don't specify @option{-O}, you simply won't
2279 get these warnings.
2280
2281 These warnings occur only for variables that are candidates for
2282 register allocation.  Therefore, they do not occur for a variable that
2283 is declared @code{volatile}, or whose address is taken, or whose size
2284 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2285 structures, unions or arrays, even when they are in registers.
2286
2287 Note that there may be no warning about a variable that is used only
2288 to compute a value that itself is never used, because such
2289 computations may be deleted by data flow analysis before the warnings
2290 are printed.
2291
2292 These warnings are made optional because GCC is not smart
2293 enough to see all the reasons why the code might be correct
2294 despite appearing to have an error.  Here is one example of how
2295 this can happen:
2296
2297 @smallexample
2298 @group
2299 @{
2300   int x;
2301   switch (y)
2302     @{
2303     case 1: x = 1;
2304       break;
2305     case 2: x = 4;
2306       break;
2307     case 3: x = 5;
2308     @}
2309   foo (x);
2310 @}
2311 @end group
2312 @end smallexample
2313
2314 @noindent
2315 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2316 always initialized, but GCC doesn't know this.  Here is
2317 another common case:
2318
2319 @smallexample
2320 @{
2321   int save_y;
2322   if (change_y) save_y = y, y = new_y;
2323   @dots{}
2324   if (change_y) y = save_y;
2325 @}
2326 @end smallexample
2327
2328 @noindent
2329 This has no bug because @code{save_y} is used only if it is set.
2330
2331 @cindex @code{longjmp} warnings
2332 This option also warns when a non-volatile automatic variable might be
2333 changed by a call to @code{longjmp}.  These warnings as well are possible
2334 only in optimizing compilation.
2335
2336 The compiler sees only the calls to @code{setjmp}.  It cannot know
2337 where @code{longjmp} will be called; in fact, a signal handler could
2338 call it at any point in the code.  As a result, you may get a warning
2339 even when there is in fact no problem because @code{longjmp} cannot
2340 in fact be called at the place which would cause a problem.
2341
2342 Some spurious warnings can be avoided if you declare all the functions
2343 you use that never return as @code{noreturn}.  @xref{Function
2344 Attributes}.
2345
2346 @item -Wunknown-pragmas
2347 @opindex Wunknown-pragmas
2348 @cindex warning for unknown pragmas
2349 @cindex unknown pragmas, warning
2350 @cindex pragmas, warning of unknown
2351 Warn when a #pragma directive is encountered which is not understood by
2352 GCC@.  If this command line option is used, warnings will even be issued
2353 for unknown pragmas in system header files.  This is not the case if
2354 the warnings were only enabled by the @option{-Wall} command line option.
2355
2356 @item -Wstrict-aliasing
2357 @opindex Wstrict-aliasing
2358 This option is only active when @option{-fstrict-aliasing} is active.
2359 It warns about code which might break the strict aliasing rules that the
2360 compiler is using for optimization. The warning does not catch all
2361 cases, but does attempt to catch the more common pitfalls. It is
2362 included in @option{-Wall}.
2363
2364 @item -Wall
2365 @opindex Wall
2366 All of the above @samp{-W} options combined.  This enables all the
2367 warnings about constructions that some users consider questionable, and
2368 that are easy to avoid (or modify to prevent the warning), even in
2369 conjunction with macros.  This also enables some language-specific
2370 warnings described in @ref{C++ Dialect Options} and
2371 @ref{Objective-C Dialect Options}.
2372 @end table
2373
2374 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2375 Some of them warn about constructions that users generally do not
2376 consider questionable, but which occasionally you might wish to check
2377 for; others warn about constructions that are necessary or hard to avoid
2378 in some cases, and there is no simple way to modify the code to suppress
2379 the warning.
2380
2381 @table @gcctabopt
2382 @item -Wextra
2383 @opindex W
2384 @opindex Wextra
2385 (This option used to be called @option{-W}.  The older name is still
2386 supported, but the newer name is more descriptive.)  Print extra warning
2387 messages for these events:
2388
2389 @itemize @bullet
2390 @item
2391 A function can return either with or without a value.  (Falling
2392 off the end of the function body is considered returning without
2393 a value.)  For example, this function would evoke such a
2394 warning:
2395
2396 @smallexample
2397 @group
2398 foo (a)
2399 @{
2400   if (a > 0)
2401     return a;
2402 @}
2403 @end group
2404 @end smallexample
2405
2406 @item
2407 An expression-statement or the left-hand side of a comma expression
2408 contains no side effects.
2409 To suppress the warning, cast the unused expression to void.
2410 For example, an expression such as @samp{x[i,j]} will cause a warning,
2411 but @samp{x[(void)i,j]} will not.
2412
2413 @item
2414 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2415
2416 @item
2417 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2418 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2419 that of ordinary mathematical notation.
2420
2421 @item
2422 Storage-class specifiers like @code{static} are not the first things in
2423 a declaration.  According to the C Standard, this usage is obsolescent.
2424
2425 @item
2426 The return type of a function has a type qualifier such as @code{const}.
2427 Such a type qualifier has no effect, since the value returned by a
2428 function is not an lvalue.  (But don't warn about the GNU extension of
2429 @code{volatile void} return types.  That extension will be warned about
2430 if @option{-pedantic} is specified.)
2431
2432 @item
2433 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2434 arguments.
2435
2436 @item
2437 A comparison between signed and unsigned values could produce an
2438 incorrect result when the signed value is converted to unsigned.
2439 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2440
2441 @item
2442 An aggregate has an initializer which does not initialize all members.
2443 For example, the following code would cause such a warning, because
2444 @code{x.h} would be implicitly initialized to zero:
2445
2446 @smallexample
2447 struct s @{ int f, g, h; @};
2448 struct s x = @{ 3, 4 @};
2449 @end smallexample
2450
2451 @item
2452 A function parameter is declared without a type specifier in K&R-style
2453 functions:
2454
2455 @smallexample
2456 void foo(bar) @{ @}
2457 @end smallexample
2458
2459 @item
2460 An empty body occurs in an @samp{if} or @samp{else} statement.
2461
2462 @item
2463 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2464 @samp{>}, or @samp{>=}.
2465
2466 @item
2467 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2468
2469 @item
2470 Any of several floating-point events that often indicate errors, such as
2471 overflow, underflow, loss of precision, etc.
2472
2473 @item @r{(C++ only)}
2474 An enumerator and a non-enumerator both appear in a conditional expression.
2475
2476 @item @r{(C++ only)}
2477 A non-static reference or non-static @samp{const} member appears in a
2478 class without constructors.
2479
2480 @item @r{(C++ only)}
2481 Ambiguous virtual bases.
2482
2483 @item @r{(C++ only)}
2484 Subscripting an array which has been declared @samp{register}.
2485
2486 @item @r{(C++ only)}
2487 Taking the address of a variable which has been declared @samp{register}.
2488
2489 @item @r{(C++ only)}
2490 A base class is not initialized in a derived class' copy constrcutor.
2491 @end itemize
2492
2493 @item -Wno-div-by-zero
2494 @opindex Wno-div-by-zero
2495 @opindex Wdiv-by-zero
2496 Do not warn about compile-time integer division by zero.  Floating point
2497 division by zero is not warned about, as it can be a legitimate way of
2498 obtaining infinities and NaNs.
2499
2500 @item -Wsystem-headers
2501 @opindex Wsystem-headers
2502 @cindex warnings from system headers
2503 @cindex system headers, warnings from
2504 Print warning messages for constructs found in system header files.
2505 Warnings from system headers are normally suppressed, on the assumption
2506 that they usually do not indicate real problems and would only make the
2507 compiler output harder to read.  Using this command line option tells
2508 GCC to emit warnings from system headers as if they occurred in user
2509 code.  However, note that using @option{-Wall} in conjunction with this
2510 option will @emph{not} warn about unknown pragmas in system
2511 headers---for that, @option{-Wunknown-pragmas} must also be used.
2512
2513 @item -Wfloat-equal
2514 @opindex Wfloat-equal
2515 Warn if floating point values are used in equality comparisons.
2516
2517 The idea behind this is that sometimes it is convenient (for the
2518 programmer) to consider floating-point values as approximations to
2519 infinitely precise real numbers.  If you are doing this, then you need
2520 to compute (by analyzing the code, or in some other way) the maximum or
2521 likely maximum error that the computation introduces, and allow for it
2522 when performing comparisons (and when producing output, but that's a
2523 different problem).  In particular, instead of testing for equality, you
2524 would check to see whether the two values have ranges that overlap; and
2525 this is done with the relational operators, so equality comparisons are
2526 probably mistaken.
2527
2528 @item -Wtraditional @r{(C only)}
2529 @opindex Wtraditional
2530 Warn about certain constructs that behave differently in traditional and
2531 ISO C@.  Also warn about ISO C constructs that have no traditional C
2532 equivalent, and/or problematic constructs which should be avoided.
2533
2534 @itemize @bullet
2535 @item
2536 Macro parameters that appear within string literals in the macro body.
2537 In traditional C macro replacement takes place within string literals,
2538 but does not in ISO C@.
2539
2540 @item
2541 In traditional C, some preprocessor directives did not exist.
2542 Traditional preprocessors would only consider a line to be a directive
2543 if the @samp{#} appeared in column 1 on the line.  Therefore
2544 @option{-Wtraditional} warns about directives that traditional C
2545 understands but would ignore because the @samp{#} does not appear as the
2546 first character on the line.  It also suggests you hide directives like
2547 @samp{#pragma} not understood by traditional C by indenting them.  Some
2548 traditional implementations would not recognize @samp{#elif}, so it
2549 suggests avoiding it altogether.
2550
2551 @item
2552 A function-like macro that appears without arguments.
2553
2554 @item
2555 The unary plus operator.
2556
2557 @item
2558 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2559 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2560 constants.)  Note, these suffixes appear in macros defined in the system
2561 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2562 Use of these macros in user code might normally lead to spurious
2563 warnings, however gcc's integrated preprocessor has enough context to
2564 avoid warning in these cases.
2565
2566 @item
2567 A function declared external in one block and then used after the end of
2568 the block.
2569
2570 @item
2571 A @code{switch} statement has an operand of type @code{long}.
2572
2573 @item
2574 A non-@code{static} function declaration follows a @code{static} one.
2575 This construct is not accepted by some traditional C compilers.
2576
2577 @item
2578 The ISO type of an integer constant has a different width or
2579 signedness from its traditional type.  This warning is only issued if
2580 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2581 typically represent bit patterns, are not warned about.
2582
2583 @item
2584 Usage of ISO string concatenation is detected.
2585
2586 @item
2587 Initialization of automatic aggregates.
2588
2589 @item
2590 Identifier conflicts with labels.  Traditional C lacks a separate
2591 namespace for labels.
2592
2593 @item
2594 Initialization of unions.  If the initializer is zero, the warning is
2595 omitted.  This is done under the assumption that the zero initializer in
2596 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2597 initializer warnings and relies on default initialization to zero in the
2598 traditional C case.
2599
2600 @item
2601 Conversions by prototypes between fixed/floating point values and vice
2602 versa.  The absence of these prototypes when compiling with traditional
2603 C would cause serious problems.  This is a subset of the possible
2604 conversion warnings, for the full set use @option{-Wconversion}.
2605
2606 @item
2607 Use of ISO C style function definitions.  This warning intentionally is
2608 @emph{not} issued for prototype declarations or variadic functions
2609 because these ISO C features will appear in your code when using
2610 libiberty's traditional C compatibility macros, @code{PARAMS} and
2611 @code{VPARAMS}.  This warning is also bypassed for nested functions
2612 because that feature is already a gcc extension and thus not relevant to
2613 traditional C compatibility.
2614 @end itemize
2615
2616 @item -Wundef
2617 @opindex Wundef
2618 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2619
2620 @item -Wendif-labels
2621 @opindex Wendif-labels
2622 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2623
2624 @item -Wshadow
2625 @opindex Wshadow
2626 Warn whenever a local variable shadows another local variable, parameter or
2627 global variable or whenever a built-in function is shadowed.
2628
2629 @item -Wlarger-than-@var{len}
2630 @opindex Wlarger-than
2631 Warn whenever an object of larger than @var{len} bytes is defined.
2632
2633 @item -Wpointer-arith
2634 @opindex Wpointer-arith
2635 Warn about anything that depends on the ``size of'' a function type or
2636 of @code{void}.  GNU C assigns these types a size of 1, for
2637 convenience in calculations with @code{void *} pointers and pointers
2638 to functions.
2639
2640 @item -Wbad-function-cast @r{(C only)}
2641 @opindex Wbad-function-cast
2642 Warn whenever a function call is cast to a non-matching type.
2643 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2644
2645 @item -Wcast-qual
2646 @opindex Wcast-qual
2647 Warn whenever a pointer is cast so as to remove a type qualifier from
2648 the target type.  For example, warn if a @code{const char *} is cast
2649 to an ordinary @code{char *}.
2650
2651 @item -Wcast-align
2652 @opindex Wcast-align
2653 Warn whenever a pointer is cast such that the required alignment of the
2654 target is increased.  For example, warn if a @code{char *} is cast to
2655 an @code{int *} on machines where integers can only be accessed at
2656 two- or four-byte boundaries.
2657
2658 @item -Wwrite-strings
2659 @opindex Wwrite-strings
2660 When compiling C, give string constants the type @code{const
2661 char[@var{length}]} so that
2662 copying the address of one into a non-@code{const} @code{char *}
2663 pointer will get a warning; when compiling C++, warn about the
2664 deprecated conversion from string constants to @code{char *}.
2665 These warnings will help you find at
2666 compile time code that can try to write into a string constant, but
2667 only if you have been very careful about using @code{const} in
2668 declarations and prototypes.  Otherwise, it will just be a nuisance;
2669 this is why we did not make @option{-Wall} request these warnings.
2670
2671 @item -Wconversion
2672 @opindex Wconversion
2673 Warn if a prototype causes a type conversion that is different from what
2674 would happen to the same argument in the absence of a prototype.  This
2675 includes conversions of fixed point to floating and vice versa, and
2676 conversions changing the width or signedness of a fixed point argument
2677 except when the same as the default promotion.
2678
2679 Also, warn if a negative integer constant expression is implicitly
2680 converted to an unsigned type.  For example, warn about the assignment
2681 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2682 casts like @code{(unsigned) -1}.
2683
2684 @item -Wsign-compare
2685 @opindex Wsign-compare
2686 @cindex warning for comparison of signed and unsigned values
2687 @cindex comparison of signed and unsigned values, warning
2688 @cindex signed and unsigned values, comparison warning
2689 Warn when a comparison between signed and unsigned values could produce
2690 an incorrect result when the signed value is converted to unsigned.
2691 This warning is also enabled by @option{-Wextra}; to get the other warnings
2692 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2693
2694 @item -Waggregate-return
2695 @opindex Waggregate-return
2696 Warn if any functions that return structures or unions are defined or
2697 called.  (In languages where you can return an array, this also elicits
2698 a warning.)
2699
2700 @item -Wstrict-prototypes @r{(C only)}
2701 @opindex Wstrict-prototypes
2702 Warn if a function is declared or defined without specifying the
2703 argument types.  (An old-style function definition is permitted without
2704 a warning if preceded by a declaration which specifies the argument
2705 types.)
2706
2707 @item -Wmissing-prototypes @r{(C only)}
2708 @opindex Wmissing-prototypes
2709 Warn if a global function is defined without a previous prototype
2710 declaration.  This warning is issued even if the definition itself
2711 provides a prototype.  The aim is to detect global functions that fail
2712 to be declared in header files.
2713
2714 @item -Wmissing-declarations
2715 @opindex Wmissing-declarations
2716 Warn if a global function is defined without a previous declaration.
2717 Do so even if the definition itself provides a prototype.
2718 Use this option to detect global functions that are not declared in
2719 header files.
2720
2721 @item -Wmissing-noreturn
2722 @opindex Wmissing-noreturn
2723 Warn about functions which might be candidates for attribute @code{noreturn}.
2724 Note these are only possible candidates, not absolute ones.  Care should
2725 be taken to manually verify functions actually do not ever return before
2726 adding the @code{noreturn} attribute, otherwise subtle code generation
2727 bugs could be introduced.  You will not get a warning for @code{main} in
2728 hosted C environments.
2729
2730 @item -Wmissing-format-attribute
2731 @opindex Wmissing-format-attribute
2732 @opindex Wformat
2733 If @option{-Wformat} is enabled, also warn about functions which might be
2734 candidates for @code{format} attributes.  Note these are only possible
2735 candidates, not absolute ones.  GCC will guess that @code{format}
2736 attributes might be appropriate for any function that calls a function
2737 like @code{vprintf} or @code{vscanf}, but this might not always be the
2738 case, and some functions for which @code{format} attributes are
2739 appropriate may not be detected.  This option has no effect unless
2740 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2741
2742 @item -Wno-multichar
2743 @opindex Wno-multichar
2744 @opindex Wmultichar
2745 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2746 Usually they indicate a typo in the user's code, as they have
2747 implementation-defined values, and should not be used in portable code.
2748
2749 @item -Wno-deprecated-declarations
2750 @opindex Wno-deprecated-declarations
2751 Do not warn about uses of functions, variables, and types marked as
2752 deprecated by using the @code{deprecated} attribute.
2753 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2754 @pxref{Type Attributes}.)
2755
2756 @item -Wpacked
2757 @opindex Wpacked
2758 Warn if a structure is given the packed attribute, but the packed
2759 attribute has no effect on the layout or size of the structure.
2760 Such structures may be mis-aligned for little benefit.  For
2761 instance, in this code, the variable @code{f.x} in @code{struct bar}
2762 will be misaligned even though @code{struct bar} does not itself
2763 have the packed attribute:
2764
2765 @smallexample
2766 @group
2767 struct foo @{
2768   int x;
2769   char a, b, c, d;
2770 @} __attribute__((packed));
2771 struct bar @{
2772   char z;
2773   struct foo f;
2774 @};
2775 @end group
2776 @end smallexample
2777
2778 @item -Wpadded
2779 @opindex Wpadded
2780 Warn if padding is included in a structure, either to align an element
2781 of the structure or to align the whole structure.  Sometimes when this
2782 happens it is possible to rearrange the fields of the structure to
2783 reduce the padding and so make the structure smaller.
2784
2785 @item -Wredundant-decls
2786 @opindex Wredundant-decls
2787 Warn if anything is declared more than once in the same scope, even in
2788 cases where multiple declaration is valid and changes nothing.
2789
2790 @item -Wnested-externs @r{(C only)}
2791 @opindex Wnested-externs
2792 Warn if an @code{extern} declaration is encountered within a function.
2793
2794 @item -Wunreachable-code
2795 @opindex Wunreachable-code
2796 Warn if the compiler detects that code will never be executed.
2797
2798 This option is intended to warn when the compiler detects that at
2799 least a whole line of source code will never be executed, because
2800 some condition is never satisfied or because it is after a
2801 procedure that never returns.
2802
2803 It is possible for this option to produce a warning even though there
2804 are circumstances under which part of the affected line can be executed,
2805 so care should be taken when removing apparently-unreachable code.
2806
2807 For instance, when a function is inlined, a warning may mean that the
2808 line is unreachable in only one inlined copy of the function.
2809
2810 This option is not made part of @option{-Wall} because in a debugging
2811 version of a program there is often substantial code which checks
2812 correct functioning of the program and is, hopefully, unreachable
2813 because the program does work.  Another common use of unreachable
2814 code is to provide behavior which is selectable at compile-time.
2815
2816 @item -Winline
2817 @opindex Winline
2818 Warn if a function can not be inlined and it was declared as inline.
2819
2820 @item -Winvalid-pch
2821 @opindex Winvalid-pch
2822 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2823 the search path but can't be used.
2824
2825 @item -Wlong-long
2826 @opindex Wlong-long
2827 @opindex Wno-long-long
2828 Warn if @samp{long long} type is used.  This is default.  To inhibit
2829 the warning messages, use @option{-Wno-long-long}.  Flags
2830 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2831 only when @option{-pedantic} flag is used.
2832
2833 @item -Wdisabled-optimization
2834 @opindex Wdisabled-optimization
2835 Warn if a requested optimization pass is disabled.  This warning does
2836 not generally indicate that there is anything wrong with your code; it
2837 merely indicates that GCC's optimizers were unable to handle the code
2838 effectively.  Often, the problem is that your code is too big or too
2839 complex; GCC will refuse to optimize programs when the optimization
2840 itself is likely to take inordinate amounts of time.
2841
2842 @item -Werror
2843 @opindex Werror
2844 Make all warnings into errors.
2845 @end table
2846
2847 @node Debugging Options
2848 @section Options for Debugging Your Program or GCC
2849 @cindex options, debugging
2850 @cindex debugging information options
2851
2852 GCC has various special options that are used for debugging
2853 either your program or GCC:
2854
2855 @table @gcctabopt
2856 @item -g
2857 @opindex g
2858 Produce debugging information in the operating system's native format
2859 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2860 information.
2861
2862 On most systems that use stabs format, @option{-g} enables use of extra
2863 debugging information that only GDB can use; this extra information
2864 makes debugging work better in GDB but will probably make other debuggers
2865 crash or
2866 refuse to read the program.  If you want to control for certain whether
2867 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2868 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2869 or @option{-gvms} (see below).
2870
2871 Unlike most other C compilers, GCC allows you to use @option{-g} with
2872 @option{-O}.  The shortcuts taken by optimized code may occasionally
2873 produce surprising results: some variables you declared may not exist
2874 at all; flow of control may briefly move where you did not expect it;
2875 some statements may not be executed because they compute constant
2876 results or their values were already at hand; some statements may
2877 execute in different places because they were moved out of loops.
2878
2879 Nevertheless it proves possible to debug optimized output.  This makes
2880 it reasonable to use the optimizer for programs that might have bugs.
2881
2882 The following options are useful when GCC is generated with the
2883 capability for more than one debugging format.
2884
2885 @item -ggdb
2886 @opindex ggdb
2887 Produce debugging information for use by GDB@.  This means to use the
2888 most expressive format available (DWARF 2, stabs, or the native format
2889 if neither of those are supported), including GDB extensions if at all
2890 possible.
2891
2892 @item -gstabs
2893 @opindex gstabs
2894 Produce debugging information in stabs format (if that is supported),
2895 without GDB extensions.  This is the format used by DBX on most BSD
2896 systems.  On MIPS, Alpha and System V Release 4 systems this option
2897 produces stabs debugging output which is not understood by DBX or SDB@.
2898 On System V Release 4 systems this option requires the GNU assembler.
2899
2900 @item -gstabs+
2901 @opindex gstabs+
2902 Produce debugging information in stabs format (if that is supported),
2903 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2904 use of these extensions is likely to make other debuggers crash or
2905 refuse to read the program.
2906
2907 @item -gcoff
2908 @opindex gcoff
2909 Produce debugging information in COFF format (if that is supported).
2910 This is the format used by SDB on most System V systems prior to
2911 System V Release 4.
2912
2913 @item -gxcoff
2914 @opindex gxcoff
2915 Produce debugging information in XCOFF format (if that is supported).
2916 This is the format used by the DBX debugger on IBM RS/6000 systems.
2917
2918 @item -gxcoff+
2919 @opindex gxcoff+
2920 Produce debugging information in XCOFF format (if that is supported),
2921 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2922 use of these extensions is likely to make other debuggers crash or
2923 refuse to read the program, and may cause assemblers other than the GNU
2924 assembler (GAS) to fail with an error.
2925
2926 @item -gdwarf
2927 @opindex gdwarf
2928 Produce debugging information in DWARF version 1 format (if that is
2929 supported).  This is the format used by SDB on most System V Release 4
2930 systems.
2931
2932 This option is deprecated.
2933
2934 @item -gdwarf+
2935 @opindex gdwarf+
2936 Produce debugging information in DWARF version 1 format (if that is
2937 supported), using GNU extensions understood only by the GNU debugger
2938 (GDB)@.  The use of these extensions is likely to make other debuggers
2939 crash or refuse to read the program.
2940
2941 This option is deprecated.
2942
2943 @item -gdwarf-2
2944 @opindex gdwarf-2
2945 Produce debugging information in DWARF version 2 format (if that is
2946 supported).  This is the format used by DBX on IRIX 6.
2947
2948 @item -gvms
2949 @opindex gvms
2950 Produce debugging information in VMS debug format (if that is
2951 supported).  This is the format used by DEBUG on VMS systems.
2952
2953 @item -g@var{level}
2954 @itemx -ggdb@var{level}
2955 @itemx -gstabs@var{level}
2956 @itemx -gcoff@var{level}
2957 @itemx -gxcoff@var{level}
2958 @itemx -gvms@var{level}
2959 Request debugging information and also use @var{level} to specify how
2960 much information.  The default level is 2.
2961
2962 Level 1 produces minimal information, enough for making backtraces in
2963 parts of the program that you don't plan to debug.  This includes
2964 descriptions of functions and external variables, but no information
2965 about local variables and no line numbers.
2966
2967 Level 3 includes extra information, such as all the macro definitions
2968 present in the program.  Some debuggers support macro expansion when
2969 you use @option{-g3}.
2970
2971 Note that in order to avoid confusion between DWARF1 debug level 2,
2972 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2973 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2974 option to change the debug level for DWARF1 or DWARF2.
2975
2976 @item -feliminate-dwarf2-dups
2977 @opindex feliminate-dwarf2-dups
2978 Compress DWARF2 debugging information by eliminating duplicated
2979 information about each symbol.  This option only makes sense when
2980 generating DWARF2 debugging information with @option{-gdwarf-2}.
2981
2982 @cindex @command{prof}
2983 @item -p
2984 @opindex p
2985 Generate extra code to write profile information suitable for the
2986 analysis program @command{prof}.  You must use this option when compiling
2987 the source files you want data about, and you must also use it when
2988 linking.
2989
2990 @cindex @command{gprof}
2991 @item -pg
2992 @opindex pg
2993 Generate extra code to write profile information suitable for the
2994 analysis program @command{gprof}.  You must use this option when compiling
2995 the source files you want data about, and you must also use it when
2996 linking.
2997
2998 @item -Q
2999 @opindex Q
3000 Makes the compiler print out each function name as it is compiled, and
3001 print some statistics about each pass when it finishes.
3002
3003 @item -ftime-report
3004 @opindex ftime-report
3005 Makes the compiler print some statistics about the time consumed by each
3006 pass when it finishes.
3007
3008 @item -fmem-report
3009 @opindex fmem-report
3010 Makes the compiler print some statistics about permanent memory
3011 allocation when it finishes.
3012
3013 @item -fprofile-arcs
3014 @opindex fprofile-arcs
3015 Add code so that program flow @dfn{arcs} are instrumented.  During
3016 execution the program records how many times each branch and call is
3017 executed and how many times it is taken or returns.  When the compiled
3018 program exits it saves this data to a file called
3019 @file{@var{auxname}.da} for each source file. The data may be used for
3020 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3021 test coverage analysis (@option{-ftest-coverage}). Each object file's
3022 @var{auxname} is generated from the name of the output file, if
3023 explicitly specified and it is not the final executable, otherwise it is
3024 the basename of the source file. In both cases any suffix is removed
3025 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3026 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3027
3028 @itemize
3029
3030 @item
3031 Compile the source files with @option{-fprofile-arcs} plus optimization
3032 and code generation options. For test coverage analysis, use the
3033 additional @option{-ftest-coverage} option. You do not need to profile
3034 every source file in a program.
3035
3036 @item
3037 Link your object files as normal.
3038
3039 @item
3040 Run the program on a representative workload to generate the arc profile
3041 information. This may be repeated any number of times.
3042
3043 @item
3044 For profile-directed optimizations, compile the source files again with
3045 the same optimization and code generation options plus
3046 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3047 Control Optimization}).
3048
3049 @item
3050 For test coverage analysis, use @command{gcov} to produce human readable
3051 information from the @file{.bbg} and @file{.da} files. Refer to the
3052 @command{gcov} documentation for further information.
3053
3054 @end itemize
3055
3056 With @option{-fprofile-arcs}, for each function of your program GCC
3057 creates a program flow graph, then finds a spanning tree for the graph.
3058 Only arcs that are not on the spanning tree have to be instrumented: the
3059 compiler adds code to count the number of times that these arcs are
3060 executed.  When an arc is the only exit or only entrance to a block, the
3061 instrumentation code can be added to the block; otherwise, a new basic
3062 block must be created to hold the instrumentation code.
3063
3064 @need 2000
3065 @item -ftest-coverage
3066 @opindex ftest-coverage
3067 Produce a graph file that the @command{gcov} code-coverage utility
3068 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3069 show program coverage. Each source file's data file is called
3070 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3071 above for a description of @var{auxname} and instructions on how to
3072 generate test coverage data. Coverage data will match the source files
3073 more closely, if you do not optimize.
3074
3075 @item -d@var{letters}
3076 @opindex d
3077 Says to make debugging dumps during compilation at times specified by
3078 @var{letters}.  This is used for debugging the compiler.  The file names
3079 for most of the dumps are made by appending a pass number and a word to
3080 the @var{dumpname}. @var{dumpname} is generated from the name of the
3081 output file, if explicitly specified and it is not an executable,
3082 otherwise it is the basename of the source file. In both cases any
3083 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3084 Here are the possible letters for use in @var{letters}, and their
3085 meanings:
3086
3087 @table @samp
3088 @item A
3089 @opindex dA
3090 Annotate the assembler output with miscellaneous debugging information.
3091 @item b
3092 @opindex db
3093 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3094 @item B
3095 @opindex dB
3096 Dump after block reordering, to @file{@var{file}.32.bbro}.
3097 @item c
3098 @opindex dc
3099 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3100 @item C
3101 @opindex dC
3102 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3103 @item d
3104 @opindex dd
3105 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3106 @item D
3107 @opindex dD
3108 Dump all macro definitions, at the end of preprocessing, in addition to
3109 normal output.
3110 @item e
3111 @opindex de
3112 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3113 @file{@var{file}.07.ussa}.
3114 @item E
3115 @opindex dE
3116 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3117 @item f
3118 @opindex df
3119 Dump after life analysis, to @file{@var{file}.18.life}.
3120 @item F
3121 @opindex dF
3122 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3123 @item g
3124 @opindex dg
3125 Dump after global register allocation, to @file{@var{file}.24.greg}.
3126 @item h
3127 @opindex dh
3128 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3129 @item k
3130 @opindex dk
3131 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3132 @item o
3133 @opindex do
3134 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3135 @item G
3136 @opindex dG
3137 Dump after GCSE, to @file{@var{file}.11.gcse}.
3138 @item i
3139 @opindex di
3140 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3141 @item j
3142 @opindex dj
3143 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3144 @item k
3145 @opindex dk
3146 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3147 @item l
3148 @opindex dl
3149 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3150 @item L
3151 @opindex dL
3152 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3153 @file{@var{file}.18.loop2}.
3154 @item M
3155 @opindex dM
3156 Dump after performing the machine dependent reorganization pass, to
3157 @file{@var{file}.33.mach}.
3158 @item n
3159 @opindex dn
3160 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3161 @item N
3162 @opindex dN
3163 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3164 @item r
3165 @opindex dr
3166 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3167 @item R
3168 @opindex dR
3169 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3170 @item s
3171 @opindex ds
3172 Dump after CSE (including the jump optimization that sometimes follows
3173 CSE), to @file{@var{file}.09.cse}.
3174 @item S
3175 @opindex dS
3176 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3177 @item t
3178 @opindex dt
3179 Dump after the second CSE pass (including the jump optimization that
3180 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3181 @item u
3182 @opindex du
3183 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3184 @item w
3185 @opindex dw
3186 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3187 @item X
3188 @opindex dX
3189 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3190 @item z
3191 @opindex dz
3192 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3193 @item a
3194 @opindex da
3195 Produce all the dumps listed above.
3196 @item H
3197 @opindex dH
3198 Produce a core dump whenever an error occurs.
3199 @item m
3200 @opindex dm
3201 Print statistics on memory usage, at the end of the run, to
3202 standard error.
3203 @item p
3204 @opindex dp
3205 Annotate the assembler output with a comment indicating which
3206 pattern and alternative was used.  The length of each instruction is
3207 also printed.
3208 @item P
3209 @opindex dP
3210 Dump the RTL in the assembler output as a comment before each instruction.
3211 Also turns on @option{-dp} annotation.
3212 @item v
3213 @opindex dv
3214 For each of the other indicated dump files (except for
3215 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3216 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3217 @item x
3218 @opindex dx
3219 Just generate RTL for a function instead of compiling it.  Usually used
3220 with @samp{r}.
3221 @item y
3222 @opindex dy
3223 Dump debugging information during parsing, to standard error.
3224 @end table
3225
3226 @item -fdump-unnumbered
3227 @opindex fdump-unnumbered
3228 When doing debugging dumps (see @option{-d} option above), suppress instruction
3229 numbers and line number note output.  This makes it more feasible to
3230 use diff on debugging dumps for compiler invocations with different
3231 options, in particular with and without @option{-g}.
3232
3233 @item -fdump-translation-unit @r{(C and C++ only)}
3234 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3235 @opindex fdump-translation-unit
3236 Dump a representation of the tree structure for the entire translation
3237 unit to a file.  The file name is made by appending @file{.tu} to the
3238 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3239 controls the details of the dump as described for the
3240 @option{-fdump-tree} options.
3241
3242 @item -fdump-class-hierarchy @r{(C++ only)}
3243 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3244 @opindex fdump-class-hierarchy
3245 Dump a representation of each class's hierarchy and virtual function
3246 table layout to a file.  The file name is made by appending @file{.class}
3247 to the source file name.  If the @samp{-@var{options}} form is used,
3248 @var{options} controls the details of the dump as described for the
3249 @option{-fdump-tree} options.
3250
3251 @item -fdump-tree-@var{switch} @r{(C++ only)}
3252 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3253 @opindex fdump-tree
3254 Control the dumping at various stages of processing the intermediate
3255 language tree to a file.  The file name is generated by appending a switch
3256 specific suffix to the source file name.  If the @samp{-@var{options}}
3257 form is used, @var{options} is a list of @samp{-} separated options that
3258 control the details of the dump. Not all options are applicable to all
3259 dumps, those which are not meaningful will be ignored. The following
3260 options are available
3261
3262 @table @samp
3263 @item address
3264 Print the address of each node.  Usually this is not meaningful as it
3265 changes according to the environment and source file. Its primary use
3266 is for tying up a dump file with a debug environment.
3267 @item slim
3268 Inhibit dumping of members of a scope or body of a function merely
3269 because that scope has been reached. Only dump such items when they
3270 are directly reachable by some other path.
3271 @item all
3272 Turn on all options.
3273 @end table
3274
3275 The following tree dumps are possible:
3276 @table @samp
3277 @item original
3278 Dump before any tree based optimization, to @file{@var{file}.original}.
3279 @item optimized
3280 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3281 @item inlined
3282 Dump after function inlining, to @file{@var{file}.inlined}.
3283 @end table
3284
3285 @item -fsched-verbose=@var{n}
3286 @opindex fsched-verbose
3287 On targets that use instruction scheduling, this option controls the
3288 amount of debugging output the scheduler prints.  This information is
3289 written to standard error, unless @option{-dS} or @option{-dR} is
3290 specified, in which case it is output to the usual dump
3291 listing file, @file{.sched} or @file{.sched2} respectively.  However
3292 for @var{n} greater than nine, the output is always printed to standard
3293 error.
3294
3295 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3296 same information as @option{-dRS}.  For @var{n} greater than one, it
3297 also output basic block probabilities, detailed ready list information
3298 and unit/insn info.  For @var{n} greater than two, it includes RTL
3299 at abort point, control-flow and regions info.  And for @var{n} over
3300 four, @option{-fsched-verbose} also includes dependence info.
3301
3302 @item -save-temps
3303 @opindex save-temps
3304 Store the usual ``temporary'' intermediate files permanently; place them
3305 in the current directory and name them based on the source file.  Thus,
3306 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3307 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3308 preprocessed @file{foo.i} output file even though the compiler now
3309 normally uses an integrated preprocessor.
3310
3311 @item -time
3312 @opindex time
3313 Report the CPU time taken by each subprocess in the compilation
3314 sequence.  For C source files, this is the compiler proper and assembler
3315 (plus the linker if linking is done).  The output looks like this:
3316
3317 @smallexample
3318 # cc1 0.12 0.01
3319 # as 0.00 0.01
3320 @end smallexample
3321
3322 The first number on each line is the ``user time,'' that is time spent
3323 executing the program itself.  The second number is ``system time,''
3324 time spent executing operating system routines on behalf of the program.
3325 Both numbers are in seconds.
3326
3327 @item -print-file-name=@var{library}
3328 @opindex print-file-name
3329 Print the full absolute name of the library file @var{library} that
3330 would be used when linking---and don't do anything else.  With this
3331 option, GCC does not compile or link anything; it just prints the
3332 file name.
3333
3334 @item -print-multi-directory
3335 @opindex print-multi-directory
3336 Print the directory name corresponding to the multilib selected by any
3337 other switches present in the command line.  This directory is supposed
3338 to exist in @env{GCC_EXEC_PREFIX}.
3339
3340 @item -print-multi-lib
3341 @opindex print-multi-lib
3342 Print the mapping from multilib directory names to compiler switches
3343 that enable them.  The directory name is separated from the switches by
3344 @samp{;}, and each switch starts with an @samp{@@} instead of the
3345 @samp{-}, without spaces between multiple switches.  This is supposed to
3346 ease shell-processing.
3347
3348 @item -print-prog-name=@var{program}
3349 @opindex print-prog-name
3350 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3351
3352 @item -print-libgcc-file-name
3353 @opindex print-libgcc-file-name
3354 Same as @option{-print-file-name=libgcc.a}.
3355
3356 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3357 but you do want to link with @file{libgcc.a}.  You can do
3358
3359 @example
3360 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3361 @end example
3362
3363 @item -print-search-dirs
3364 @opindex print-search-dirs
3365 Print the name of the configured installation directory and a list of
3366 program and library directories gcc will search---and don't do anything else.
3367
3368 This is useful when gcc prints the error message
3369 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3370 To resolve this you either need to put @file{cpp0} and the other compiler
3371 components where gcc expects to find them, or you can set the environment
3372 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3373 Don't forget the trailing '/'.
3374 @xref{Environment Variables}.
3375
3376 @item -dumpmachine
3377 @opindex dumpmachine
3378 Print the compiler's target machine (for example,
3379 @samp{i686-pc-linux-gnu})---and don't do anything else.
3380
3381 @item -dumpversion
3382 @opindex dumpversion
3383 Print the compiler version (for example, @samp{3.0})---and don't do
3384 anything else.
3385
3386 @item -dumpspecs
3387 @opindex dumpspecs
3388 Print the compiler's built-in specs---and don't do anything else.  (This
3389 is used when GCC itself is being built.)  @xref{Spec Files}.
3390
3391 @item -feliminate-unused-debug-types
3392 @opindex feliminate-unused-debug-types
3393 Normally, when producing DWARF2 output, GCC will emit debugging
3394 information for all types declared in a compilation
3395 unit, regardless of whether or not they are actually used
3396 in that compilation unit.  Sometimes this is useful, such as
3397 if, in the debugger, you want to cast a value to a type that is
3398 not actually used in your program (but is declared).  More often,
3399 however, this results in a significant amount of wasted space.
3400 With this option, GCC will avoid producing debug symbol output
3401 for types that are nowhere used in the source file being compiled.
3402 @end table
3403
3404 @node Optimize Options
3405 @section Options That Control Optimization
3406 @cindex optimize options
3407 @cindex options, optimization
3408
3409 These options control various sorts of optimizations.
3410
3411 Without any optimization option, the compiler's goal is to reduce the
3412 cost of compilation and to make debugging produce the expected
3413 results.  Statements are independent: if you stop the program with a
3414 breakpoint between statements, you can then assign a new value to any
3415 variable or change the program counter to any other statement in the
3416 function and get exactly the results you would expect from the source
3417 code.
3418
3419 Turning on optimization flags makes the compiler attempt to improve
3420 the performance and/or code size at the expense of compilation time
3421 and possibly the ability to debug the program.
3422
3423 Not all optimizations are controlled directly by a flag.  Only
3424 optimizations that have a flag are listed.
3425
3426 @table @gcctabopt
3427 @item -O
3428 @itemx -O1
3429 @opindex O
3430 @opindex O1
3431 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3432 more memory for a large function.
3433
3434 With @option{-O}, the compiler tries to reduce code size and execution
3435 time, without performing any optimizations that take a great deal of
3436 compilation time.
3437
3438 @option{-O} turns on the following optimization flags: 
3439 @gccoptlist{-fdefer-pop @gol
3440 -fmerge-constants @gol
3441 -fthread-jumps @gol
3442 -floop-optimize @gol
3443 -fcrossjumping @gol
3444 -fif-conversion @gol
3445 -fif-conversion2 @gol
3446 -fdelayed-branch @gol
3447 -fguess-branch-probability @gol
3448 -fcprop-registers}
3449
3450 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3451 where doing so does not interfere with debugging.
3452
3453 @item -O2
3454 @opindex O2
3455 Optimize even more.  GCC performs nearly all supported optimizations
3456 that do not involve a space-speed tradeoff.  The compiler does not
3457 perform loop unrolling or function inlining when you specify @option{-O2}.
3458 As compared to @option{-O}, this option increases both compilation time
3459 and the performance of the generated code.
3460
3461 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3462 also turns on the following optimization flags:
3463 @gccoptlist{-fforce-mem @gol
3464 -foptimize-sibling-calls @gol
3465 -fstrength-reduce @gol
3466 -fcse-follow-jumps  -fcse-skip-blocks @gol
3467 -frerun-cse-after-loop  -frerun-loop-opt @gol
3468 -fgcse   -fgcse-lm   -fgcse-sm @gol
3469 -fdelete-null-pointer-checks @gol
3470 -fexpensive-optimizations @gol
3471 -fregmove @gol
3472 -fschedule-insns  -fschedule-insns2 @gol
3473 -fsched-interblock  -fsched-spec @gol
3474 -fcaller-saves @gol
3475 -fpeephole2 @gol
3476 -freorder-blocks  -freorder-functions @gol
3477 -fstrict-aliasing @gol
3478 -falign-functions  -falign-jumps @gol
3479 -falign-loops  -falign-labels}
3480
3481 Please note the warning under @option{-fgcse} about
3482 invoking @option{-O2} on programs that use computed gotos.
3483
3484 @item -O3
3485 @opindex O3
3486 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3487 @option{-O2} and also turns on the @option{-finline-functions},
3488 @option{-funit-at-a-time} and @option{-frename-registers} options.
3489
3490 @item -O0
3491 @opindex O0
3492 Do not optimize.  This is the default.
3493
3494 @item -Os
3495 @opindex Os
3496 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3497 do not typically increase code size.  It also performs further
3498 optimizations designed to reduce code size.
3499
3500 @option{-Os} disables the following optimization flags:
3501 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3502 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3503
3504 If you use multiple @option{-O} options, with or without level numbers,
3505 the last such option is the one that is effective.
3506 @end table
3507
3508 Options of the form @option{-f@var{flag}} specify machine-independent
3509 flags.  Most flags have both positive and negative forms; the negative
3510 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3511 below, only one of the forms is listed---the one you typically will
3512 use.  You can figure out the other form by either removing @samp{no-}
3513 or adding it.
3514
3515 The following options control specific optimizations.  They are either
3516 activated by @option{-O} options or are related to ones that are.  You
3517 can use the following flags in the rare cases when ``fine-tuning'' of
3518 optimizations to be performed is desired.
3519
3520 @table @gcctabopt
3521 @item -fno-default-inline
3522 @opindex fno-default-inline
3523 Do not make member functions inline by default merely because they are
3524 defined inside the class scope (C++ only).  Otherwise, when you specify
3525 @w{@option{-O}}, member functions defined inside class scope are compiled
3526 inline by default; i.e., you don't need to add @samp{inline} in front of
3527 the member function name.
3528
3529 @item -fno-defer-pop
3530 @opindex fno-defer-pop
3531 Always pop the arguments to each function call as soon as that function
3532 returns.  For machines which must pop arguments after a function call,
3533 the compiler normally lets arguments accumulate on the stack for several
3534 function calls and pops them all at once.
3535
3536 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3537
3538 @item -fforce-mem
3539 @opindex fforce-mem
3540 Force memory operands to be copied into registers before doing
3541 arithmetic on them.  This produces better code by making all memory
3542 references potential common subexpressions.  When they are not common
3543 subexpressions, instruction combination should eliminate the separate
3544 register-load.
3545
3546 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3547
3548 @item -fforce-addr
3549 @opindex fforce-addr
3550 Force memory address constants to be copied into registers before
3551 doing arithmetic on them.  This may produce better code just as
3552 @option{-fforce-mem} may.
3553
3554 @item -fomit-frame-pointer
3555 @opindex fomit-frame-pointer
3556 Don't keep the frame pointer in a register for functions that
3557 don't need one.  This avoids the instructions to save, set up and
3558 restore frame pointers; it also makes an extra register available
3559 in many functions.  @strong{It also makes debugging impossible on
3560 some machines.}
3561
3562 On some machines, such as the VAX, this flag has no effect, because
3563 the standard calling sequence automatically handles the frame pointer
3564 and nothing is saved by pretending it doesn't exist.  The
3565 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3566 whether a target machine supports this flag.  @xref{Registers,,Register
3567 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3568
3569 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3570
3571 @item -foptimize-sibling-calls
3572 @opindex foptimize-sibling-calls
3573 Optimize sibling and tail recursive calls.
3574
3575 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3576
3577 @item -fno-inline
3578 @opindex fno-inline
3579 Don't pay attention to the @code{inline} keyword.  Normally this option
3580 is used to keep the compiler from expanding any functions inline.
3581 Note that if you are not optimizing, no functions can be expanded inline.
3582
3583 @item -finline-functions
3584 @opindex finline-functions
3585 Integrate all simple functions into their callers.  The compiler
3586 heuristically decides which functions are simple enough to be worth
3587 integrating in this way.
3588
3589 If all calls to a given function are integrated, and the function is
3590 declared @code{static}, then the function is normally not output as
3591 assembler code in its own right.
3592
3593 Enabled at level @option{-O3}.
3594
3595 @item -finline-limit=@var{n}
3596 @opindex finline-limit
3597 By default, gcc limits the size of functions that can be inlined.  This flag
3598 allows the control of this limit for functions that are explicitly marked as
3599 inline (i.e., marked with the inline keyword or defined within the class
3600 definition in c++).  @var{n} is the size of functions that can be inlined in
3601 number of pseudo instructions (not counting parameter handling).  The default
3602 value of @var{n} is 600.
3603 Increasing this value can result in more inlined code at
3604 the cost of compilation time and memory consumption.  Decreasing usually makes
3605 the compilation faster and less code will be inlined (which presumably
3606 means slower programs).  This option is particularly useful for programs that
3607 use inlining heavily such as those based on recursive templates with C++.
3608
3609 Inlining is actually controlled by a number of parameters, which may be
3610 specified individually by using @option{--param @var{name}=@var{value}}.
3611 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3612 as follows:
3613
3614 @table @gcctabopt
3615  @item max-inline-insns
3616   is set to @var{n}.
3617  @item max-inline-insns-single
3618   is set to @var{n}/2.
3619  @item max-inline-insns-single-auto
3620   is set to @var{n}/2.
3621  @item min-inline-insns
3622   is set to 130 or @var{n}/4, whichever is smaller.
3623  @item max-inline-insns-rtl
3624   is set to @var{n}.
3625 @end table
3626
3627 Using @option{-finline-limit=600} thus results in the default settings
3628 for these parameters.  See below for a documentation of the individual
3629 parameters controlling inlining.
3630
3631 @emph{Note:} pseudo instruction represents, in this particular context, an
3632 abstract measurement of function's size.  In no way, it represents a count
3633 of assembly instructions and as such its exact meaning might change from one
3634 release to an another.
3635
3636 @item -fkeep-inline-functions
3637 @opindex fkeep-inline-functions
3638 Even if all calls to a given function are integrated, and the function
3639 is declared @code{static}, nevertheless output a separate run-time
3640 callable version of the function.  This switch does not affect
3641 @code{extern inline} functions.
3642
3643 @item -fkeep-static-consts
3644 @opindex fkeep-static-consts
3645 Emit variables declared @code{static const} when optimization isn't turned
3646 on, even if the variables aren't referenced.
3647
3648 GCC enables this option by default.  If you want to force the compiler to
3649 check if the variable was referenced, regardless of whether or not
3650 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3651
3652 @item -fmerge-constants
3653 Attempt to merge identical constants (string constants and floating point
3654 constants) across compilation units.
3655
3656 This option is the default for optimized compilation if the assembler and
3657 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3658 behavior.
3659
3660 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3661
3662 @item -fmerge-all-constants
3663 Attempt to merge identical constants and identical variables.
3664
3665 This option implies @option{-fmerge-constants}.  In addition to
3666 @option{-fmerge-constants} this considers e.g. even constant initialized
3667 arrays or initialized constant variables with integral or floating point
3668 types.  Languages like C or C++ require each non-automatic variable to
3669 have distinct location, so using this option will result in non-conforming
3670 behavior.
3671
3672 @item -fnew-ra
3673 @opindex fnew-ra
3674 Use a graph coloring register allocator.  Currently this option is meant
3675 for testing, so we are interested to hear about miscompilations with
3676 @option{-fnew-ra}.
3677
3678 @item -fno-branch-count-reg
3679 @opindex fno-branch-count-reg
3680 Do not use ``decrement and branch'' instructions on a count register,
3681 but instead generate a sequence of instructions that decrement a
3682 register, compare it against zero, then branch based upon the result.
3683 This option is only meaningful on architectures that support such
3684 instructions, which include x86, PowerPC, IA-64 and S/390.
3685
3686 The default is @option{-fbranch-count-reg}, enabled when
3687 @option{-fstrength-reduce} is enabled.
3688
3689 @item -fno-function-cse
3690 @opindex fno-function-cse
3691 Do not put function addresses in registers; make each instruction that
3692 calls a constant function contain the function's address explicitly.
3693
3694 This option results in less efficient code, but some strange hacks
3695 that alter the assembler output may be confused by the optimizations
3696 performed when this option is not used.
3697
3698 The default is @option{-ffunction-cse}
3699
3700 @item -fno-zero-initialized-in-bss
3701 @opindex fno-zero-initialized-in-bss
3702 If the target supports a BSS section, GCC by default puts variables that
3703 are initialized to zero into BSS@.  This can save space in the resulting
3704 code.
3705
3706 This option turns off this behavior because some programs explicitly
3707 rely on variables going to the data section.  E.g., so that the
3708 resulting executable can find the beginning of that section and/or make
3709 assumptions based on that.
3710
3711 The default is @option{-fzero-initialized-in-bss}.
3712
3713 @item -fstrength-reduce
3714 @opindex fstrength-reduce
3715 Perform the optimizations of loop strength reduction and
3716 elimination of iteration variables.
3717
3718 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3719
3720 @item -fthread-jumps
3721 @opindex fthread-jumps
3722 Perform optimizations where we check to see if a jump branches to a
3723 location where another comparison subsumed by the first is found.  If
3724 so, the first branch is redirected to either the destination of the
3725 second branch or a point immediately following it, depending on whether
3726 the condition is known to be true or false.
3727
3728 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3729
3730 @item -fcse-follow-jumps
3731 @opindex fcse-follow-jumps
3732 In common subexpression elimination, scan through jump instructions
3733 when the target of the jump is not reached by any other path.  For
3734 example, when CSE encounters an @code{if} statement with an
3735 @code{else} clause, CSE will follow the jump when the condition
3736 tested is false.
3737
3738 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3739
3740 @item -fcse-skip-blocks
3741 @opindex fcse-skip-blocks
3742 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3743 follow jumps which conditionally skip over blocks.  When CSE
3744 encounters a simple @code{if} statement with no else clause,
3745 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3746 body of the @code{if}.
3747
3748 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3749
3750 @item -frerun-cse-after-loop
3751 @opindex frerun-cse-after-loop
3752 Re-run common subexpression elimination after loop optimizations has been
3753 performed.
3754
3755 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3756
3757 @item -frerun-loop-opt
3758 @opindex frerun-loop-opt
3759 Run the loop optimizer twice.
3760
3761 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3762
3763 @item -fgcse
3764 @opindex fgcse
3765 Perform a global common subexpression elimination pass.
3766 This pass also performs global constant and copy propagation.
3767
3768 @emph{Note:} When compiling a program using computed gotos, a GCC
3769 extension, you may get better runtime performance if you disable
3770 the global common subexpression elimination pass by adding
3771 @option{-fno-gcse} to the command line.
3772
3773 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3774
3775 @item -fgcse-lm
3776 @opindex fgcse-lm
3777 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3778 attempt to move loads which are only killed by stores into themselves.  This
3779 allows a loop containing a load/store sequence to be changed to a load outside
3780 the loop, and a copy/store within the loop.
3781
3782 Enabled by default when gcse is enabled.
3783
3784 @item -fgcse-sm
3785 @opindex fgcse-sm
3786 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3787 subexpression elimination.  This pass will attempt to move stores out of loops.
3788 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3789 can be changed to a load before the loop and a store after the loop.
3790
3791 Enabled by default when gcse is enabled.
3792
3793 @item -floop-optimize
3794 @opindex floop-optimize
3795 Perform loop optimizations: move constant expressions out of loops, simplify
3796 exit test conditions and optionally do strength-reduction and loop unrolling as
3797 well.
3798
3799 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3800
3801 @item -fcrossjumping
3802 @opindex crossjumping
3803 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3804 resulting code may or may not perform better than without cross-jumping.
3805
3806 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3807
3808 @item -fif-conversion
3809 @opindex if-conversion
3810 Attempt to transform conditional jumps into branch-less equivalents.  This
3811 include use of conditional moves, min, max, set flags and abs instructions, and
3812 some tricks doable by standard arithmetics.  The use of conditional execution
3813 on chips where it is available is controlled by @code{if-conversion2}.
3814
3815 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3816
3817 @item -fif-conversion2
3818 @opindex if-conversion2
3819 Use conditional execution (where available) to transform conditional jumps into
3820 branch-less equivalents.
3821
3822 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3823
3824 @item -fdelete-null-pointer-checks
3825 @opindex fdelete-null-pointer-checks
3826 Use global dataflow analysis to identify and eliminate useless checks
3827 for null pointers.  The compiler assumes that dereferencing a null
3828 pointer would have halted the program.  If a pointer is checked after
3829 it has already been dereferenced, it cannot be null.
3830
3831 In some environments, this assumption is not true, and programs can
3832 safely dereference null pointers.  Use
3833 @option{-fno-delete-null-pointer-checks} to disable this optimization
3834 for programs which depend on that behavior.
3835
3836 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3837
3838 @item -fexpensive-optimizations
3839 @opindex fexpensive-optimizations
3840 Perform a number of minor optimizations that are relatively expensive.
3841
3842 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3843
3844 @item -foptimize-register-move
3845 @itemx -fregmove
3846 @opindex foptimize-register-move
3847 @opindex fregmove
3848 Attempt to reassign register numbers in move instructions and as
3849 operands of other simple instructions in order to maximize the amount of
3850 register tying.  This is especially helpful on machines with two-operand
3851 instructions.
3852
3853 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3854 optimization.
3855
3856 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3857
3858 @item -fdelayed-branch
3859 @opindex fdelayed-branch
3860 If supported for the target machine, attempt to reorder instructions
3861 to exploit instruction slots available after delayed branch
3862 instructions.
3863
3864 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3865
3866 @item -fschedule-insns
3867 @opindex fschedule-insns
3868 If supported for the target machine, attempt to reorder instructions to
3869 eliminate execution stalls due to required data being unavailable.  This
3870 helps machines that have slow floating point or memory load instructions
3871 by allowing other instructions to be issued until the result of the load
3872 or floating point instruction is required.
3873
3874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3875
3876 @item -fschedule-insns2
3877 @opindex fschedule-insns2
3878 Similar to @option{-fschedule-insns}, but requests an additional pass of
3879 instruction scheduling after register allocation has been done.  This is
3880 especially useful on machines with a relatively small number of
3881 registers and where memory load instructions take more than one cycle.
3882
3883 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3884
3885 @item -fno-sched-interblock
3886 @opindex fno-sched-interblock
3887 Don't schedule instructions across basic blocks.  This is normally
3888 enabled by default when scheduling before register allocation, i.e.@:
3889 with @option{-fschedule-insns} or at @option{-O2} or higher.
3890
3891 @item -fno-sched-spec
3892 @opindex fno-sched-spec
3893 Don't allow speculative motion of non-load instructions.  This is normally
3894 enabled by default when scheduling before register allocation, i.e.@:
3895 with @option{-fschedule-insns} or at @option{-O2} or higher.
3896
3897 @item -fsched-spec-load
3898 @opindex fsched-spec-load
3899 Allow speculative motion of some load instructions.  This only makes
3900 sense when scheduling before register allocation, i.e.@: with
3901 @option{-fschedule-insns} or at @option{-O2} or higher.
3902
3903 @item -fsched-spec-load-dangerous
3904 @opindex fsched-spec-load-dangerous
3905 Allow speculative motion of more load instructions.  This only makes
3906 sense when scheduling before register allocation, i.e.@: with
3907 @option{-fschedule-insns} or at @option{-O2} or higher.
3908
3909 @item -fsched2-use-superblocks
3910 @opindex fsched2-use-superblocks
3911 When schedulilng after register allocation, do use superblock scheduling
3912 algorithm.  Superblock scheduling allows motion acress basic block boundaries
3913 resulting on faster schedules.  This option is experimental, as not all machine
3914 descriptions used by GCC model the CPU closely enought to avoid unreliable
3915 results from the algorithm. 
3916
3917 This only makes sense when scheduling after register allocation, i.e.@: with
3918 @option{-fschedule-insns2} or at @option{-O2} or higher.
3919
3920 @item -fsched2-use-traces
3921 @opindex fsched2-use-traces
3922 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3923 allocation and additionally perform code duplication in order to increase the
3924 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3925 trace formation.
3926
3927 This mode should produce faster but singificantly longer programs.  Also
3928 without @code{-fbranch-probabilities} the traces constructed may not match the
3929 reality and hurt the performance.  This only makes
3930 sense when scheduling after register allocation, i.e.@: with
3931 @option{-fschedule-insns2} or at @option{-O2} or higher.
3932
3933 @item -fcaller-saves
3934 @opindex fcaller-saves
3935 Enable values to be allocated in registers that will be clobbered by
3936 function calls, by emitting extra instructions to save and restore the
3937 registers around such calls.  Such allocation is done only when it
3938 seems to result in better code than would otherwise be produced.
3939
3940 This option is always enabled by default on certain machines, usually
3941 those which have no call-preserved registers to use instead.
3942
3943 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3944
3945 @item -fmove-all-movables
3946 @opindex fmove-all-movables
3947 Forces all invariant computations in loops to be moved
3948 outside the loop.
3949
3950 @item -freduce-all-givs
3951 @opindex freduce-all-givs
3952 Forces all general-induction variables in loops to be
3953 strength-reduced.
3954
3955 @emph{Note:} When compiling programs written in Fortran,
3956 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3957 by default when you use the optimizer.
3958
3959 These options may generate better or worse code; results are highly
3960 dependent on the structure of loops within the source code.
3961
3962 These two options are intended to be removed someday, once
3963 they have helped determine the efficacy of various
3964 approaches to improving loop optimizations.
3965
3966 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3967 know how use of these options affects
3968 the performance of your production code.
3969 We're very interested in code that runs @emph{slower}
3970 when these options are @emph{enabled}.
3971
3972 @item -fno-peephole
3973 @itemx -fno-peephole2
3974 @opindex fno-peephole
3975 @opindex fno-peephole2
3976 Disable any machine-specific peephole optimizations.  The difference
3977 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3978 are implemented in the compiler; some targets use one, some use the
3979 other, a few use both.
3980
3981 @option{-fpeephole} is enabled by default.
3982 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3983
3984 @item -fno-guess-branch-probability
3985 @opindex fno-guess-branch-probability
3986 Do not guess branch probabilities using a randomized model.
3987
3988 Sometimes gcc will opt to use a randomized model to guess branch
3989 probabilities, when none are available from either profiling feedback
3990 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3991 different runs of the compiler on the same program may produce different
3992 object code.
3993
3994 In a hard real-time system, people don't want different runs of the
3995 compiler to produce code that has different behavior; minimizing
3996 non-determinism is of paramount import.  This switch allows users to
3997 reduce non-determinism, possibly at the expense of inferior
3998 optimization.
3999
4000 The default is @option{-fguess-branch-probability} at levels
4001 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4002
4003 @item -freorder-blocks
4004 @opindex freorder-blocks
4005 Reorder basic blocks in the compiled function in order to reduce number of
4006 taken branches and improve code locality.
4007
4008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4009
4010 @item -freorder-functions
4011 @opindex freorder-functions
4012 Reorder basic blocks in the compiled function in order to reduce number of
4013 taken branches and improve code locality. This is implemented by using special
4014 subsections @code{text.hot} for most frequently executed functions and
4015 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4016 the linker so object file format must support named sections and linker must
4017 place them in a reasonable way.
4018
4019 Also profile feedback must be available in to make this option effective.  See
4020 @option{-fprofile-arcs} for details.
4021
4022 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4023
4024 @item -fstrict-aliasing
4025 @opindex fstrict-aliasing
4026 Allows the compiler to assume the strictest aliasing rules applicable to
4027 the language being compiled.  For C (and C++), this activates
4028 optimizations based on the type of expressions.  In particular, an
4029 object of one type is assumed never to reside at the same address as an
4030 object of a different type, unless the types are almost the same.  For
4031 example, an @code{unsigned int} can alias an @code{int}, but not a
4032 @code{void*} or a @code{double}.  A character type may alias any other
4033 type.
4034
4035 Pay special attention to code like this:
4036 @example
4037 union a_union @{
4038   int i;
4039   double d;
4040 @};
4041
4042 int f() @{
4043   a_union t;
4044   t.d = 3.0;
4045   return t.i;
4046 @}
4047 @end example
4048 The practice of reading from a different union member than the one most
4049 recently written to (called ``type-punning'') is common.  Even with
4050 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4051 is accessed through the union type.  So, the code above will work as
4052 expected.  However, this code might not:
4053 @example
4054 int f() @{
4055   a_union t;
4056   int* ip;
4057   t.d = 3.0;
4058   ip = &t.i;
4059   return *ip;
4060 @}
4061 @end example
4062
4063 Every language that wishes to perform language-specific alias analysis
4064 should define a function that computes, given an @code{tree}
4065 node, an alias set for the node.  Nodes in different alias sets are not
4066 allowed to alias.  For an example, see the C front-end function
4067 @code{c_get_alias_set}.
4068
4069 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4070
4071 @item -falign-functions
4072 @itemx -falign-functions=@var{n}
4073 @opindex falign-functions
4074 Align the start of functions to the next power-of-two greater than
4075 @var{n}, skipping up to @var{n} bytes.  For instance,
4076 @option{-falign-functions=32} aligns functions to the next 32-byte
4077 boundary, but @option{-falign-functions=24} would align to the next
4078 32-byte boundary only if this can be done by skipping 23 bytes or less.
4079
4080 @option{-fno-align-functions} and @option{-falign-functions=1} are
4081 equivalent and mean that functions will not be aligned.
4082
4083 Some assemblers only support this flag when @var{n} is a power of two;
4084 in that case, it is rounded up.
4085
4086 If @var{n} is not specified, use a machine-dependent default.
4087
4088 Enabled at levels @option{-O2}, @option{-O3}.
4089
4090 @item -falign-labels
4091 @itemx -falign-labels=@var{n}
4092 @opindex falign-labels
4093 Align all branch targets to a power-of-two boundary, skipping up to
4094 @var{n} bytes like @option{-falign-functions}.  This option can easily
4095 make code slower, because it must insert dummy operations for when the
4096 branch target is reached in the usual flow of the code.
4097
4098 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4099 are greater than this value, then their values are used instead.
4100
4101 If @var{n} is not specified, use a machine-dependent default which is
4102 very likely to be @samp{1}, meaning no alignment.
4103
4104 Enabled at levels @option{-O2}, @option{-O3}.
4105
4106 @item -falign-loops
4107 @itemx -falign-loops=@var{n}
4108 @opindex falign-loops
4109 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4110 like @option{-falign-functions}.  The hope is that the loop will be
4111 executed many times, which will make up for any execution of the dummy
4112 operations.
4113
4114 If @var{n} is not specified, use a machine-dependent default.
4115
4116 Enabled at levels @option{-O2}, @option{-O3}.
4117
4118 @item -falign-jumps
4119 @itemx -falign-jumps=@var{n}
4120 @opindex falign-jumps
4121 Align branch targets to a power-of-two boundary, for branch targets
4122 where the targets can only be reached by jumping, skipping up to @var{n}
4123 bytes like @option{-falign-functions}.  In this case, no dummy operations
4124 need be executed.
4125
4126 If @var{n} is not specified, use a machine-dependent default.
4127
4128 Enabled at levels @option{-O2}, @option{-O3}.
4129
4130 @item -frename-registers
4131 @opindex frename-registers
4132 Attempt to avoid false dependencies in scheduled code by making use
4133 of registers left over after register allocation.  This optimization
4134 will most benefit processors with lots of registers.  It can, however,
4135 make debugging impossible, since variables will no longer stay in
4136 a ``home register''.
4137
4138 Enabled at levels @option{-O3}.
4139
4140 @item -fno-cprop-registers
4141 @opindex fno-cprop-registers
4142 After register allocation and post-register allocation instruction splitting,
4143 we perform a copy-propagation pass to try to reduce scheduling dependencies
4144 and occasionally eliminate the copy.
4145
4146 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4147
4148 @end table
4149
4150 The following options control compiler behavior regarding floating
4151 point arithmetic.  These options trade off between speed and
4152 correctness.  All must be specifically enabled.
4153
4154 @table @gcctabopt
4155 @item -ffloat-store
4156 @opindex ffloat-store
4157 Do not store floating point variables in registers, and inhibit other
4158 options that might change whether a floating point value is taken from a
4159 register or memory.
4160
4161 @cindex floating point precision
4162 This option prevents undesirable excess precision on machines such as
4163 the 68000 where the floating registers (of the 68881) keep more
4164 precision than a @code{double} is supposed to have.  Similarly for the
4165 x86 architecture.  For most programs, the excess precision does only
4166 good, but a few programs rely on the precise definition of IEEE floating
4167 point.  Use @option{-ffloat-store} for such programs, after modifying
4168 them to store all pertinent intermediate computations into variables.
4169
4170 @item -ffast-math
4171 @opindex ffast-math
4172 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4173 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4174 @option{-fno-signaling-nans}.
4175
4176 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4177
4178 This option should never be turned on by any @option{-O} option since
4179 it can result in incorrect output for programs which depend on
4180 an exact implementation of IEEE or ISO rules/specifications for
4181 math functions.
4182
4183 @item -fno-math-errno
4184 @opindex fno-math-errno
4185 Do not set ERRNO after calling math functions that are executed
4186 with a single instruction, e.g., sqrt.  A program that relies on
4187 IEEE exceptions for math error handling may want to use this flag
4188 for speed while maintaining IEEE arithmetic compatibility.
4189
4190 This option should never be turned on by any @option{-O} option since
4191 it can result in incorrect output for programs which depend on
4192 an exact implementation of IEEE or ISO rules/specifications for
4193 math functions.
4194
4195 The default is @option{-fmath-errno}.
4196
4197 @item -funsafe-math-optimizations
4198 @opindex funsafe-math-optimizations
4199 Allow optimizations for floating-point arithmetic that (a) assume
4200 that arguments and results are valid and (b) may violate IEEE or
4201 ANSI standards.  When used at link-time, it may include libraries
4202 or startup files that change the default FPU control word or other
4203 similar optimizations.
4204
4205 This option should never be turned on by any @option{-O} option since
4206 it can result in incorrect output for programs which depend on
4207 an exact implementation of IEEE or ISO rules/specifications for
4208 math functions.
4209
4210 The default is @option{-fno-unsafe-math-optimizations}.
4211
4212 @item -ffinite-math-only
4213 @opindex ffinite-math-only
4214 Allow optimizations for floating-point arithmetic that assume
4215 that arguments and results are not NaNs or +-Infs.
4216
4217 This option should never be turned on by any @option{-O} option since
4218 it can result in incorrect output for programs which depend on
4219 an exact implementation of IEEE or ISO rules/specifications.
4220
4221 The default is @option{-fno-finite-math-only}.
4222
4223 @item -fno-trapping-math
4224 @opindex fno-trapping-math
4225 Compile code assuming that floating-point operations cannot generate
4226 user-visible traps.  These traps include division by zero, overflow,
4227 underflow, inexact result and invalid operation.  This option implies
4228 @option{-fno-signaling-nans}.  Setting this option may allow faster
4229 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4230
4231 This option should never be turned on by any @option{-O} option since
4232 it can result in incorrect output for programs which depend on
4233 an exact implementation of IEEE or ISO rules/specifications for
4234 math functions.
4235
4236 The default is @option{-ftrapping-math}.
4237
4238 @item -fsignaling-nans
4239 @opindex fsignaling-nans
4240 Compile code assuming that IEEE signaling NaNs may generate user-visible
4241 traps during floating-point operations.  Setting this option disables
4242 optimizations that may change the number of exceptions visible with
4243 signaling NaNs.  This option implies @option{-ftrapping-math}.
4244
4245 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4246 be defined.
4247
4248 The default is @option{-fno-signaling-nans}.
4249
4250 This option is experimental and does not currently guarantee to
4251 disable all GCC optimizations that affect signaling NaN behavior.
4252
4253 @item -fsingle-precision-constant
4254 @opindex fsingle-precision-constant
4255 Treat floating point constant as single precision constant instead of
4256 implicitly converting it to double precision constant.
4257
4258
4259 @end table
4260
4261 The following options control optimizations that may improve
4262 performance, but are not enabled by any @option{-O} options.  This
4263 section includes experimental options that may produce broken code.
4264
4265 @table @gcctabopt
4266 @item -fbranch-probabilities
4267 @opindex fbranch-probabilities
4268 After running a program compiled with @option{-fprofile-arcs}
4269 (@pxref{Debugging Options,, Options for Debugging Your Program or
4270 @command{gcc}}), you can compile it a second time using
4271 @option{-fbranch-probabilities}, to improve optimizations based on
4272 the number of times each branch was taken.  When the program
4273 compiled with @option{-fprofile-arcs} exits it saves arc execution
4274 counts to a file called @file{@var{sourcename}.da} for each source
4275 file  The information in this data file is very dependent on the
4276 structure of the generated code, so you must use the same source code
4277 and the same optimization options for both compilations.
4278
4279 With @option{-fbranch-probabilities}, GCC puts a 
4280 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4281 These can be used to improve optimization.  Currently, they are only
4282 used in one place: in @file{reorg.c}, instead of guessing which path a
4283 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4284 exactly determine which path is taken more often.
4285
4286 @item -fnew-ra
4287 @opindex fnew-ra
4288 Use a graph coloring register allocator.  Currently this option is meant
4289 for testing, so we are interested to hear about miscompilations with
4290 @option{-fnew-ra}.
4291
4292 @item -ftracer
4293 @opindex ftracer
4294 Perform tail duplication to enlarge superblock size. This transformation
4295 simplifies the control flow of the function allowing other optimizations to do
4296 better job.
4297
4298 @item -funit-at-a-time
4299 @opindex funit-at-a-time
4300 Parse the whole compilation unit before starting to produce code.  This allows some
4301 extra optimizations to take place but consumes more memory.
4302
4303 @item -funroll-loops
4304 @opindex funroll-loops
4305 Unroll loops whose number of iterations can be determined at compile time or
4306 upon entry to the loop.  @option{-funroll-loops} implies
4307 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4308 (i.e. complete removal of loops with small constant number of iterations).
4309 This option makes code larger, and may or may not make it run faster.
4310
4311 @item -funroll-all-loops
4312 @opindex funroll-all-loops
4313 Unroll all loops, even if their number of iterations is uncertain when
4314 the loop is entered.  This usually makes programs run more slowly.
4315 @option{-funroll-all-loops} implies the same options as
4316 @option{-funroll-loops}.
4317
4318 @item -fpeel-loops
4319 @opindex fpeel-loops
4320 Peels the loops for that there is enough information that they do not
4321 roll much (from profile feedback).  It also turns on complete loop peeling
4322 (i.e. complete removal of loops with small constant number of iterations).
4323
4324 @item -funswitch-loops
4325 @opindex funswitch-loops
4326 Move branches with loop invariant conditions out of the loop, with duplicates
4327 of the loop on both branches (modified according to result of the condition).
4328
4329 @item -fold-unroll-loops
4330 @opindex fold-unroll-loops
4331 Unroll loops whose number of iterations can be determined at compile
4332 time or upon entry to the loop, using the old loop unroller whose loop
4333 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4334 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4335 option makes code larger, and may or may not make it run faster.
4336
4337 @item -fold-unroll-all-loops
4338 @opindex fold-unroll-all-loops
4339 Unroll all loops, even if their number of iterations is uncertain when
4340 the loop is entered. This is done using the old loop unroller whose loop
4341 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4342 @option{-fold-unroll-all-loops} implies the same options as
4343 @option{-fold-unroll-loops}.
4344  
4345 @item -funswitch-loops
4346 @opindex funswitch-loops
4347 Move branches with loop invariant conditions out of the loop, with duplicates
4348 of the loop on both branches (modified according to result of the condition).
4349
4350 @item -funswitch-loops
4351 @opindex funswitch-loops
4352 Move branches with loop invariant conditions out of the loop, with duplicates
4353 of the loop on both branches (modified according to result of the condition).
4354
4355 @item -fprefetch-loop-arrays
4356 @opindex fprefetch-loop-arrays
4357 If supported by the target machine, generate instructions to prefetch
4358 memory to improve the performance of loops that access large arrays.
4359
4360 Disabled at level @option{-Os}.
4361
4362 @item -ffunction-sections
4363 @itemx -fdata-sections
4364 @opindex ffunction-sections
4365 @opindex fdata-sections
4366 Place each function or data item into its own section in the output
4367 file if the target supports arbitrary sections.  The name of the
4368 function or the name of the data item determines the section's name
4369 in the output file.
4370
4371 Use these options on systems where the linker can perform optimizations
4372 to improve locality of reference in the instruction space.  HPPA
4373 processors running HP-UX and SPARC processors running Solaris 2 have
4374 linkers with such optimizations.  Other systems using the ELF object format
4375 as well as AIX may have these optimizations in the future.
4376
4377 Only use these options when there are significant benefits from doing
4378 so.  When you specify these options, the assembler and linker will
4379 create larger object and executable files and will also be slower.
4380 You will not be able to use @code{gprof} on all systems if you
4381 specify this option and you may have problems with debugging if
4382 you specify both this option and @option{-g}.
4383
4384 @item -fssa
4385 @opindex fssa
4386 Perform optimizations in static single assignment form.  Each function's
4387 flow graph is translated into SSA form, optimizations are performed, and
4388 the flow graph is translated back from SSA form.  Users should not
4389 specify this option, since it is not yet ready for production use.
4390
4391 @item -fssa-ccp
4392 @opindex fssa-ccp
4393 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4394 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4395
4396 @item -fssa-dce
4397 @opindex fssa-dce
4398 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4399 Like @option{-fssa}, this is an experimental feature.
4400
4401
4402
4403
4404 @item --param @var{name}=@var{value}
4405 @opindex param
4406 In some places, GCC uses various constants to control the amount of
4407 optimization that is done.  For example, GCC will not inline functions
4408 that contain more that a certain number of instructions.  You can
4409 control some of these constants on the command-line using the
4410 @option{--param} option.
4411
4412 In each case, the @var{value} is an integer.  The allowable choices for
4413 @var{name} are given in the following table:
4414
4415 @table @gcctabopt
4416 @item max-crossjump-edges
4417 The maximum number of incoming edges to consider for crossjumping.
4418 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4419 the number of edges incoming to each block.  Increasing values mean
4420 more aggressive optimization, making the compile time increase with
4421 probably small improvement in executable size.
4422
4423 @item max-delay-slot-insn-search
4424 The maximum number of instructions to consider when looking for an
4425 instruction to fill a delay slot.  If more than this arbitrary number of
4426 instructions is searched, the time savings from filling the delay slot
4427 will be minimal so stop searching.  Increasing values mean more
4428 aggressive optimization, making the compile time increase with probably
4429 small improvement in executable run time.
4430
4431 @item max-delay-slot-live-search
4432 When trying to fill delay slots, the maximum number of instructions to
4433 consider when searching for a block with valid live register
4434 information.  Increasing this arbitrarily chosen value means more
4435 aggressive optimization, increasing the compile time.  This parameter
4436 should be removed when the delay slot code is rewritten to maintain the
4437 control-flow graph.
4438
4439 @item max-gcse-memory
4440 The approximate maximum amount of memory that will be allocated in
4441 order to perform the global common subexpression elimination
4442 optimization.  If more memory than specified is required, the
4443 optimization will not be done.
4444
4445 @item max-gcse-passes
4446 The maximum number of passes of GCSE to run.
4447
4448 @item max-pending-list-length
4449 The maximum number of pending dependencies scheduling will allow
4450 before flushing the current state and starting over.  Large functions
4451 with few branches or calls can create excessively large lists which
4452 needlessly consume memory and resources.
4453
4454 @item max-inline-insns-single
4455 Several parameters control the tree inliner used in gcc.
4456 This number sets the maximum number of instructions (counted in gcc's
4457 internal representation) in a single function that the tree inliner 
4458 will consider for inlining.  This only affects functions declared
4459 inline and methods implemented in a class declaration (C++).
4460 The default value is 300.
4461
4462 @item max-inline-insns-auto
4463 When you use @option{-finline-functions} (included in @option{-O3}),
4464 a lot of functions that would otherwise not be considered for inlining
4465 by the compiler will be investigated.  To those functions, a different
4466 (more restrictive) limit compared to functions declared inline can
4467 be applied.
4468 The default value is 300.
4469
4470 @item max-inline-insns
4471 The tree inliner does decrease the allowable size for single functions 
4472 to be inlined after we already inlined the number of instructions
4473 given here by repeated inlining.  This number should be a factor of 
4474 two or more larger than the single function limit.
4475 Higher numbers result in better runtime performance, but incur higher
4476 compile-time resource (CPU time, memory) requirements and result in
4477 larger binaries.  Very high values are not advisable, as too large
4478 binaries may adversely affect runtime performance.
4479 The default value is 600.
4480
4481 @item max-inline-slope
4482 After exceeding the maximum number of inlined instructions by repeated
4483 inlining, a linear function is used to decrease the allowable size
4484 for single functions.  The slope of that function is the negative
4485 reciprocal of the number specified here.
4486 The default value is 32.
4487
4488 @item min-inline-insns
4489 The repeated inlining is throttled more and more by the linear function
4490 after exceeding the limit.  To avoid too much throttling, a minimum for
4491 this function is specified here to allow repeated inlining for very small
4492 functions even when a lot of repeated inlining already has been done.
4493 The default value is 130.
4494
4495 @item max-inline-insns-rtl
4496 For languages that use the RTL inliner (this happens at a later stage
4497 than tree inlining), you can set the maximum allowable size (counted 
4498 in RTL instructions) for the RTL inliner with this parameter.
4499 The default value is 600.
4500
4501
4502 @item max-unrolled-insns
4503 The maximum number of instructions that a loop should have if that loop
4504 is unrolled, and if the loop is unrolled, it determines how many times
4505 the loop code is unrolled.
4506
4507 @item max-average-unrolled-insns
4508 The maximum number of instructions biased by probabilities of their execution
4509 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4510 it determines how many times the loop code is unrolled.
4511
4512 @item max-unroll-times
4513 The maximum number of unrollings of a single loop.
4514
4515 @item max-peeled-insns
4516 The maximum number of instructions that a loop should have if that loop
4517 is peeled, and if the loop is peeled, it determines how many times
4518 the loop code is peeled.
4519
4520 @item max-peel-times
4521 The maximum number of peelings of a single loop.
4522
4523 @item max-completely-peeled-insns
4524 The maximum number of insns of a completely peeled loop.
4525
4526 @item max-completely-peel-times
4527 The maximum number of iterations of a loop to be suitable for complete peeling.
4528
4529 @item max-unswitch-insns
4530 The maximum number of insns of an unswitched loop.
4531
4532 @item max-unswitch-level
4533 The maximum number of branches unswitched in a single loop.
4534
4535 @item hot-bb-count-fraction
4536 Select fraction of the maximal count of repetitions of basic block in program
4537 given basic block needs to have to be considered hot.
4538
4539 @item hot-bb-frequency-fraction
4540 Select fraction of the maximal frequency of executions of basic block in
4541 function given basic block needs to have to be considered hot
4542
4543 @item tracer-dynamic-coverage
4544 @itemx tracer-dynamic-coverage-feedback
4545
4546 This value is used to limit superblock formation once the given percentage of
4547 executed instructions is covered.  This limits unnecessary code size
4548 expansion.
4549
4550 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4551 feedback is available.  The real profiles (as opposed to statically estimated
4552 ones) are much less balanced allowing the threshold to be larger value.
4553
4554 @item tracer-max-code-growth
4555 Stop tail duplication once code growth has reached given percentage.  This is
4556 rather hokey argument, as most of the duplicates will be eliminated later in
4557 cross jumping, so it may be set to much higher values than is the desired code
4558 growth.
4559
4560 @item tracer-min-branch-ratio
4561
4562 Stop reverse growth when the reverse probability of best edge is less than this
4563 threshold (in percent).
4564
4565 @item tracer-min-branch-ratio
4566 @itemx tracer-min-branch-ratio-feedback
4567
4568 Stop forward growth if the best edge do have probability lower than this
4569 threshold.
4570
4571 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4572 compilation for profile feedback and one for compilation without.  The value
4573 for compilation with profile feedback needs to be more conservative (higher) in
4574 order to make tracer effective.
4575
4576 @item ggc-min-expand
4577
4578 GCC uses a garbage collector to manage its own memory allocation.  This
4579 parameter specifies the minimum percentage by which the garbage
4580 collector's heap should be allowed to expand between collections.
4581 Tuning this may improve compilation speed; it has no effect on code
4582 generation.
4583
4584 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4585 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4586 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4587 GCC is not able to calculate RAM on a particular platform, the lower
4588 bound of 30% is used.  Setting this parameter and
4589 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4590 every opportunity.  This is extremely slow, but can be useful for
4591 debugging.
4592
4593 @item ggc-min-heapsize
4594
4595 Minimum size of the garbage collector's heap before it begins bothering
4596 to collect garbage.  The first collection occurs after the heap expands
4597 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4598 tuning this may improve compilation speed, and has no effect on code
4599 generation.
4600
4601 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4602 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4603 available, the notion of "RAM" is the smallest of actual RAM,
4604 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4605 RAM on a particular platform, the lower bound is used.  Setting this
4606 parameter very large effectively disables garbage collection.  Setting
4607 this parameter and @option{ggc-min-expand} to zero causes a full
4608 collection to occur at every opportunity.
4609
4610 @end table
4611 @end table
4612
4613 @node Preprocessor Options
4614 @section Options Controlling the Preprocessor
4615 @cindex preprocessor options
4616 @cindex options, preprocessor
4617
4618 These options control the C preprocessor, which is run on each C source
4619 file before actual compilation.
4620
4621 If you use the @option{-E} option, nothing is done except preprocessing.
4622 Some of these options make sense only together with @option{-E} because
4623 they cause the preprocessor output to be unsuitable for actual
4624 compilation.
4625
4626 @table @gcctabopt
4627 @opindex Wp
4628 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4629 and pass @var{option} directly through to the preprocessor.  If
4630 @var{option} contains commas, it is split into multiple options at the
4631 commas.  However, many options are modified, translated or interpreted
4632 by the compiler driver before being passed to the preprocessor, and
4633 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4634 interface is undocumented and subject to change, so whenever possible
4635 you should avoid using @option{-Wp} and let the driver handle the
4636 options instead.
4637
4638 @item -Xpreprocessor @var{option}
4639 @opindex preprocessor
4640 Pass @var{option} as an option to the preprocessor.  You can use this to
4641 supply system-specific preprocessor options which GCC does not know how to
4642 recognize.
4643
4644 If you want to pass an option that takes an argument, you must use
4645 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4646 @end table
4647
4648 @include cppopts.texi
4649
4650 @node Assembler Options
4651 @section Passing Options to the Assembler
4652
4653 @c prevent bad page break with this line
4654 You can pass options to the assembler.
4655
4656 @table @gcctabopt
4657 @item -Wa,@var{option}
4658 @opindex Wa
4659 Pass @var{option} as an option to the assembler.  If @var{option}
4660 contains commas, it is split into multiple options at the commas.
4661
4662 @item -Xassembler @var{option}
4663 @opindex Xassembler
4664 Pass @var{option} as an option to the assembler.  You can use this to
4665 supply system-specific assembler options which GCC does not know how to
4666 recognize.
4667
4668 If you want to pass an option that takes an argument, you must use
4669 @option{-Xassembler} twice, once for the option and once for the argument.
4670
4671 @end table
4672
4673 @node Link Options
4674 @section Options for Linking
4675 @cindex link options
4676 @cindex options, linking
4677
4678 These options come into play when the compiler links object files into
4679 an executable output file.  They are meaningless if the compiler is
4680 not doing a link step.
4681
4682 @table @gcctabopt
4683 @cindex file names
4684 @item @var{object-file-name}
4685 A file name that does not end in a special recognized suffix is
4686 considered to name an object file or library.  (Object files are
4687 distinguished from libraries by the linker according to the file
4688 contents.)  If linking is done, these object files are used as input
4689 to the linker.
4690
4691 @item -c
4692 @itemx -S
4693 @itemx -E
4694 @opindex c
4695 @opindex S
4696 @opindex E
4697 If any of these options is used, then the linker is not run, and
4698 object file names should not be used as arguments.  @xref{Overall
4699 Options}.
4700
4701 @cindex Libraries
4702 @item -l@var{library}
4703 @itemx -l @var{library}
4704 @opindex l
4705 Search the library named @var{library} when linking.  (The second
4706 alternative with the library as a separate argument is only for
4707 POSIX compliance and is not recommended.)
4708
4709 It makes a difference where in the command you write this option; the
4710 linker searches and processes libraries and object files in the order they
4711 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4712 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4713 to functions in @samp{z}, those functions may not be loaded.
4714
4715 The linker searches a standard list of directories for the library,
4716 which is actually a file named @file{lib@var{library}.a}.  The linker
4717 then uses this file as if it had been specified precisely by name.
4718
4719 The directories searched include several standard system directories
4720 plus any that you specify with @option{-L}.
4721
4722 Normally the files found this way are library files---archive files
4723 whose members are object files.  The linker handles an archive file by
4724 scanning through it for members which define symbols that have so far
4725 been referenced but not defined.  But if the file that is found is an
4726 ordinary object file, it is linked in the usual fashion.  The only
4727 difference between using an @option{-l} option and specifying a file name
4728 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4729 and searches several directories.
4730
4731 @item -lobjc
4732 @opindex lobjc
4733 You need this special case of the @option{-l} option in order to
4734 link an Objective-C program.
4735
4736 @item -nostartfiles
4737 @opindex nostartfiles
4738 Do not use the standard system startup files when linking.
4739 The standard system libraries are used normally, unless @option{-nostdlib}
4740 or @option{-nodefaultlibs} is used.
4741
4742 @item -nodefaultlibs
4743 @opindex nodefaultlibs
4744 Do not use the standard system libraries when linking.
4745 Only the libraries you specify will be passed to the linker.
4746 The standard startup files are used normally, unless @option{-nostartfiles}
4747 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4748 for System V (and ISO C) environments or to bcopy and bzero for
4749 BSD environments.  These entries are usually resolved by entries in
4750 libc.  These entry points should be supplied through some other
4751 mechanism when this option is specified.
4752
4753 @item -nostdlib
4754 @opindex nostdlib
4755 Do not use the standard system startup files or libraries when linking.
4756 No startup files and only the libraries you specify will be passed to
4757 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4758 for System V (and ISO C) environments or to bcopy and bzero for
4759 BSD environments.  These entries are usually resolved by entries in
4760 libc.  These entry points should be supplied through some other
4761 mechanism when this option is specified.
4762
4763 @cindex @option{-lgcc}, use with @option{-nostdlib}
4764 @cindex @option{-nostdlib} and unresolved references
4765 @cindex unresolved references and @option{-nostdlib}
4766 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4767 @cindex @option{-nodefaultlibs} and unresolved references
4768 @cindex unresolved references and @option{-nodefaultlibs}
4769 One of the standard libraries bypassed by @option{-nostdlib} and
4770 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4771 that GCC uses to overcome shortcomings of particular machines, or special
4772 needs for some languages.
4773 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4774 Collection (GCC) Internals},
4775 for more discussion of @file{libgcc.a}.)
4776 In most cases, you need @file{libgcc.a} even when you want to avoid
4777 other standard libraries.  In other words, when you specify @option{-nostdlib}
4778 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4779 This ensures that you have no unresolved references to internal GCC
4780 library subroutines.  (For example, @samp{__main}, used to ensure C++
4781 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4782 GNU Compiler Collection (GCC) Internals}.)
4783
4784 @item -s
4785 @opindex s
4786 Remove all symbol table and relocation information from the executable.
4787
4788 @item -static
4789 @opindex static
4790 On systems that support dynamic linking, this prevents linking with the shared
4791 libraries.  On other systems, this option has no effect.
4792
4793 @item -shared
4794 @opindex shared
4795 Produce a shared object which can then be linked with other objects to
4796 form an executable.  Not all systems support this option.  For predictable
4797 results, you must also specify the same set of options that were used to
4798 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4799 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4800 needs to build supplementary stub code for constructors to work.  On
4801 multi-libbed systems, @samp{gcc -shared} must select the correct support
4802 libraries to link against.  Failing to supply the correct flags may lead
4803 to subtle defects.  Supplying them in cases where they are not necessary
4804 is innocuous.}
4805
4806 @item -shared-libgcc
4807 @itemx -static-libgcc
4808 @opindex shared-libgcc
4809 @opindex static-libgcc
4810 On systems that provide @file{libgcc} as a shared library, these options
4811 force the use of either the shared or static version respectively.
4812 If no shared version of @file{libgcc} was built when the compiler was
4813 configured, these options have no effect.
4814
4815 There are several situations in which an application should use the
4816 shared @file{libgcc} instead of the static version.  The most common
4817 of these is when the application wishes to throw and catch exceptions
4818 across different shared libraries.  In that case, each of the libraries
4819 as well as the application itself should use the shared @file{libgcc}.
4820
4821 Therefore, the G++ and GCJ drivers automatically add
4822 @option{-shared-libgcc} whenever you build a shared library or a main
4823 executable, because C++ and Java programs typically use exceptions, so
4824 this is the right thing to do.
4825
4826 If, instead, you use the GCC driver to create shared libraries, you may
4827 find that they will not always be linked with the shared @file{libgcc}.
4828 If GCC finds, at its configuration time, that you have a GNU linker that
4829 does not support option @option{--eh-frame-hdr}, it will link the shared
4830 version of @file{libgcc} into shared libraries by default.  Otherwise,
4831 it will take advantage of the linker and optimize away the linking with
4832 the shared version of @file{libgcc}, linking with the static version of
4833 libgcc by default.  This allows exceptions to propagate through such
4834 shared libraries, without incurring relocation costs at library load
4835 time.
4836
4837 However, if a library or main executable is supposed to throw or catch
4838 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4839 for the languages used in the program, or using the option
4840 @option{-shared-libgcc}, such that it is linked with the shared
4841 @file{libgcc}.
4842
4843 @item -symbolic
4844 @opindex symbolic
4845 Bind references to global symbols when building a shared object.  Warn
4846 about any unresolved references (unless overridden by the link editor
4847 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4848 this option.
4849
4850 @item -Xlinker @var{option}
4851 @opindex Xlinker
4852 Pass @var{option} as an option to the linker.  You can use this to
4853 supply system-specific linker options which GCC does not know how to
4854 recognize.
4855
4856 If you want to pass an option that takes an argument, you must use
4857 @option{-Xlinker} twice, once for the option and once for the argument.
4858 For example, to pass @option{-assert definitions}, you must write
4859 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4860 @option{-Xlinker "-assert definitions"}, because this passes the entire
4861 string as a single argument, which is not what the linker expects.
4862
4863 @item -Wl,@var{option}
4864 @opindex Wl
4865 Pass @var{option} as an option to the linker.  If @var{option} contains
4866 commas, it is split into multiple options at the commas.
4867
4868 @item -u @var{symbol}
4869 @opindex u
4870 Pretend the symbol @var{symbol} is undefined, to force linking of
4871 library modules to define it.  You can use @option{-u} multiple times with
4872 different symbols to force loading of additional library modules.
4873 @end table
4874
4875 @node Directory Options
4876 @section Options for Directory Search
4877 @cindex directory options
4878 @cindex options, directory search
4879 @cindex search path
4880
4881 These options specify directories to search for header files, for
4882 libraries and for parts of the compiler:
4883
4884 @table @gcctabopt
4885 @item -I@var{dir}
4886 @opindex I
4887 Add the directory @var{dir} to the head of the list of directories to be
4888 searched for header files.  This can be used to override a system header
4889 file, substituting your own version, since these directories are
4890 searched before the system header file directories.  However, you should
4891 not use this option to add directories that contain vendor-supplied
4892 system header files (use @option{-isystem} for that).  If you use more than
4893 one @option{-I} option, the directories are scanned in left-to-right
4894 order; the standard system directories come after.
4895
4896 If a standard system include directory, or a directory specified with
4897 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4898 option will be ignored.  The directory will still be searched but as a
4899 system directory at its normal position in the system include chain.
4900 This is to ensure that GCC's procedure to fix buggy system headers and
4901 the ordering for the include_next directive are not inadvertently changed.
4902 If you really need to change the search order for system directories,
4903 use the @option{-nostdinc} and/or @option{-isystem} options.
4904
4905 @item -I-
4906 @opindex I-
4907 Any directories you specify with @option{-I} options before the @option{-I-}
4908 option are searched only for the case of @samp{#include "@var{file}"};
4909 they are not searched for @samp{#include <@var{file}>}.
4910
4911 If additional directories are specified with @option{-I} options after
4912 the @option{-I-}, these directories are searched for all @samp{#include}
4913 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4914 this way.)
4915
4916 In addition, the @option{-I-} option inhibits the use of the current
4917 directory (where the current input file came from) as the first search
4918 directory for @samp{#include "@var{file}"}.  There is no way to
4919 override this effect of @option{-I-}.  With @option{-I.} you can specify
4920 searching the directory which was current when the compiler was
4921 invoked.  That is not exactly the same as what the preprocessor does
4922 by default, but it is often satisfactory.
4923
4924 @option{-I-} does not inhibit the use of the standard system directories
4925 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4926 independent.
4927
4928 @item -L@var{dir}
4929 @opindex L
4930 Add directory @var{dir} to the list of directories to be searched
4931 for @option{-l}.
4932
4933 @item -B@var{prefix}
4934 @opindex B
4935 This option specifies where to find the executables, libraries,
4936 include files, and data files of the compiler itself.
4937
4938 The compiler driver program runs one or more of the subprograms
4939 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4940 @var{prefix} as a prefix for each program it tries to run, both with and
4941 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4942
4943 For each subprogram to be run, the compiler driver first tries the
4944 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4945 was not specified, the driver tries two standard prefixes, which are
4946 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4947 those results in a file name that is found, the unmodified program
4948 name is searched for using the directories specified in your
4949 @env{PATH} environment variable.
4950
4951 The compiler will check to see if the path provided by the @option{-B}
4952 refers to a directory, and if necessary it will add a directory
4953 separator character at the end of the path.
4954
4955 @option{-B} prefixes that effectively specify directory names also apply
4956 to libraries in the linker, because the compiler translates these
4957 options into @option{-L} options for the linker.  They also apply to
4958 includes files in the preprocessor, because the compiler translates these
4959 options into @option{-isystem} options for the preprocessor.  In this case,
4960 the compiler appends @samp{include} to the prefix.
4961
4962 The run-time support file @file{libgcc.a} can also be searched for using
4963 the @option{-B} prefix, if needed.  If it is not found there, the two
4964 standard prefixes above are tried, and that is all.  The file is left
4965 out of the link if it is not found by those means.
4966
4967 Another way to specify a prefix much like the @option{-B} prefix is to use
4968 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4969 Variables}.
4970
4971 As a special kludge, if the path provided by @option{-B} is
4972 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4973 9, then it will be replaced by @file{[dir/]include}.  This is to help
4974 with boot-strapping the compiler.
4975
4976 @item -specs=@var{file}
4977 @opindex specs
4978 Process @var{file} after the compiler reads in the standard @file{specs}
4979 file, in order to override the defaults that the @file{gcc} driver
4980 program uses when determining what switches to pass to @file{cc1},
4981 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4982 @option{-specs=@var{file}} can be specified on the command line, and they
4983 are processed in order, from left to right.
4984 @end table
4985
4986 @c man end
4987
4988 @node Spec Files
4989 @section Specifying subprocesses and the switches to pass to them
4990 @cindex Spec Files
4991 @command{gcc} is a driver program.  It performs its job by invoking a
4992 sequence of other programs to do the work of compiling, assembling and
4993 linking.  GCC interprets its command-line parameters and uses these to
4994 deduce which programs it should invoke, and which command-line options
4995 it ought to place on their command lines.  This behavior is controlled
4996 by @dfn{spec strings}.  In most cases there is one spec string for each
4997 program that GCC can invoke, but a few programs have multiple spec
4998 strings to control their behavior.  The spec strings built into GCC can
4999 be overridden by using the @option{-specs=} command-line switch to specify
5000 a spec file.
5001
5002 @dfn{Spec files} are plaintext files that are used to construct spec
5003 strings.  They consist of a sequence of directives separated by blank
5004 lines.  The type of directive is determined by the first non-whitespace
5005 character on the line and it can be one of the following:
5006
5007 @table @code
5008 @item %@var{command}
5009 Issues a @var{command} to the spec file processor.  The commands that can
5010 appear here are:
5011
5012 @table @code
5013 @item %include <@var{file}>
5014 @cindex %include
5015 Search for @var{file} and insert its text at the current point in the
5016 specs file.
5017
5018 @item %include_noerr <@var{file}>
5019 @cindex %include_noerr
5020 Just like @samp{%include}, but do not generate an error message if the include
5021 file cannot be found.
5022
5023 @item %rename @var{old_name} @var{new_name}
5024 @cindex %rename
5025 Rename the spec string @var{old_name} to @var{new_name}.
5026
5027 @end table
5028
5029 @item *[@var{spec_name}]:
5030 This tells the compiler to create, override or delete the named spec
5031 string.  All lines after this directive up to the next directive or
5032 blank line are considered to be the text for the spec string.  If this
5033 results in an empty string then the spec will be deleted.  (Or, if the
5034 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5035 does not currently exist a new spec will be created.  If the spec does
5036 exist then its contents will be overridden by the text of this
5037 directive, unless the first character of that text is the @samp{+}
5038 character, in which case the text will be appended to the spec.
5039
5040 @item [@var{suffix}]:
5041 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5042 and up to the next directive or blank line are considered to make up the
5043 spec string for the indicated suffix.  When the compiler encounters an
5044 input file with the named suffix, it will processes the spec string in
5045 order to work out how to compile that file.  For example:
5046
5047 @smallexample
5048 .ZZ:
5049 z-compile -input %i
5050 @end smallexample
5051
5052 This says that any input file whose name ends in @samp{.ZZ} should be
5053 passed to the program @samp{z-compile}, which should be invoked with the
5054 command-line switch @option{-input} and with the result of performing the
5055 @samp{%i} substitution.  (See below.)
5056
5057 As an alternative to providing a spec string, the text that follows a
5058 suffix directive can be one of the following:
5059
5060 @table @code
5061 @item @@@var{language}
5062 This says that the suffix is an alias for a known @var{language}.  This is
5063 similar to using the @option{-x} command-line switch to GCC to specify a
5064 language explicitly.  For example:
5065
5066 @smallexample
5067 .ZZ:
5068 @@c++
5069 @end smallexample
5070
5071 Says that .ZZ files are, in fact, C++ source files.
5072
5073 @item #@var{name}
5074 This causes an error messages saying:
5075
5076 @smallexample
5077 @var{name} compiler not installed on this system.
5078 @end smallexample
5079 @end table
5080
5081 GCC already has an extensive list of suffixes built into it.
5082 This directive will add an entry to the end of the list of suffixes, but
5083 since the list is searched from the end backwards, it is effectively
5084 possible to override earlier entries using this technique.
5085
5086 @end table
5087
5088 GCC has the following spec strings built into it.  Spec files can
5089 override these strings or create their own.  Note that individual
5090 targets can also add their own spec strings to this list.
5091
5092 @smallexample
5093 asm          Options to pass to the assembler
5094 asm_final    Options to pass to the assembler post-processor
5095 cpp          Options to pass to the C preprocessor
5096 cc1          Options to pass to the C compiler
5097 cc1plus      Options to pass to the C++ compiler
5098 endfile      Object files to include at the end of the link
5099 link         Options to pass to the linker
5100 lib          Libraries to include on the command line to the linker
5101 libgcc       Decides which GCC support library to pass to the linker
5102 linker       Sets the name of the linker
5103 predefines   Defines to be passed to the C preprocessor
5104 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5105              by default
5106 startfile    Object files to include at the start of the link
5107 @end smallexample
5108
5109 Here is a small example of a spec file:
5110
5111 @smallexample
5112 %rename lib                 old_lib
5113
5114 *lib:
5115 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5116 @end smallexample
5117
5118 This example renames the spec called @samp{lib} to @samp{old_lib} and
5119 then overrides the previous definition of @samp{lib} with a new one.
5120 The new definition adds in some extra command-line options before
5121 including the text of the old definition.
5122
5123 @dfn{Spec strings} are a list of command-line options to be passed to their
5124 corresponding program.  In addition, the spec strings can contain
5125 @samp{%}-prefixed sequences to substitute variable text or to
5126 conditionally insert text into the command line.  Using these constructs
5127 it is possible to generate quite complex command lines.
5128
5129 Here is a table of all defined @samp{%}-sequences for spec
5130 strings.  Note that spaces are not generated automatically around the
5131 results of expanding these sequences.  Therefore you can concatenate them
5132 together or combine them with constant text in a single argument.
5133
5134 @table @code
5135 @item %%
5136 Substitute one @samp{%} into the program name or argument.
5137
5138 @item %i
5139 Substitute the name of the input file being processed.
5140
5141 @item %b
5142 Substitute the basename of the input file being processed.
5143 This is the substring up to (and not including) the last period
5144 and not including the directory.
5145
5146 @item %B
5147 This is the same as @samp{%b}, but include the file suffix (text after
5148 the last period).
5149
5150 @item %d
5151 Marks the argument containing or following the @samp{%d} as a
5152 temporary file name, so that that file will be deleted if GCC exits
5153 successfully.  Unlike @samp{%g}, this contributes no text to the
5154 argument.
5155
5156 @item %g@var{suffix}
5157 Substitute a file name that has suffix @var{suffix} and is chosen
5158 once per compilation, and mark the argument in the same way as
5159 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5160 name is now chosen in a way that is hard to predict even when previously
5161 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5162 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5163 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5164 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5165 was simply substituted with a file name chosen once per compilation,
5166 without regard to any appended suffix (which was therefore treated
5167 just like ordinary text), making such attacks more likely to succeed.
5168
5169 @item %u@var{suffix}
5170 Like @samp{%g}, but generates a new temporary file name even if
5171 @samp{%u@var{suffix}} was already seen.
5172
5173 @item %U@var{suffix}
5174 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5175 new one if there is no such last file name.  In the absence of any
5176 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5177 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5178 would involve the generation of two distinct file names, one
5179 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5180 simply substituted with a file name chosen for the previous @samp{%u},
5181 without regard to any appended suffix.
5182
5183 @item %j@var{suffix}
5184 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5185 writable, and if save-temps is off; otherwise, substitute the name
5186 of a temporary file, just like @samp{%u}.  This temporary file is not
5187 meant for communication between processes, but rather as a junk
5188 disposal mechanism.
5189
5190 @item %|@var{suffix}
5191 @itemx %m@var{suffix}
5192 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5193 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5194 all.  These are the two most common ways to instruct a program that it
5195 should read from standard input or write to standard output.  If you
5196 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5197 construct: see for example @file{f/lang-specs.h}.
5198
5199 @item %.@var{SUFFIX}
5200 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5201 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5202 terminated by the next space or %.
5203
5204 @item %w
5205 Marks the argument containing or following the @samp{%w} as the
5206 designated output file of this compilation.  This puts the argument
5207 into the sequence of arguments that @samp{%o} will substitute later.
5208
5209 @item %o
5210 Substitutes the names of all the output files, with spaces
5211 automatically placed around them.  You should write spaces
5212 around the @samp{%o} as well or the results are undefined.
5213 @samp{%o} is for use in the specs for running the linker.
5214 Input files whose names have no recognized suffix are not compiled
5215 at all, but they are included among the output files, so they will
5216 be linked.
5217
5218 @item %O
5219 Substitutes the suffix for object files.  Note that this is
5220 handled specially when it immediately follows @samp{%g, %u, or %U},
5221 because of the need for those to form complete file names.  The
5222 handling is such that @samp{%O} is treated exactly as if it had already
5223 been substituted, except that @samp{%g, %u, and %U} do not currently
5224 support additional @var{suffix} characters following @samp{%O} as they would
5225 following, for example, @samp{.o}.
5226
5227 @item %p
5228 Substitutes the standard macro predefinitions for the
5229 current target machine.  Use this when running @code{cpp}.
5230
5231 @item %P
5232 Like @samp{%p}, but puts @samp{__} before and after the name of each
5233 predefined macro, except for macros that start with @samp{__} or with
5234 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5235 C@.
5236
5237 @item %I
5238 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5239 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5240 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5241 as necessary.
5242
5243 @item %s
5244 Current argument is the name of a library or startup file of some sort.
5245 Search for that file in a standard list of directories and substitute
5246 the full name found.
5247
5248 @item %e@var{str}
5249 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5250 Use this when inconsistent options are detected.
5251
5252 @item %(@var{name})
5253 Substitute the contents of spec string @var{name} at this point.
5254
5255 @item %[@var{name}]
5256 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5257
5258 @item %x@{@var{option}@}
5259 Accumulate an option for @samp{%X}.
5260
5261 @item %X
5262 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5263 spec string.
5264
5265 @item %Y
5266 Output the accumulated assembler options specified by @option{-Wa}.
5267
5268 @item %Z
5269 Output the accumulated preprocessor options specified by @option{-Wp}.
5270
5271 @item %a
5272 Process the @code{asm} spec.  This is used to compute the
5273 switches to be passed to the assembler.
5274
5275 @item %A
5276 Process the @code{asm_final} spec.  This is a spec string for
5277 passing switches to an assembler post-processor, if such a program is
5278 needed.
5279
5280 @item %l
5281 Process the @code{link} spec.  This is the spec for computing the
5282 command line passed to the linker.  Typically it will make use of the
5283 @samp{%L %G %S %D and %E} sequences.
5284
5285 @item %D
5286 Dump out a @option{-L} option for each directory that GCC believes might
5287 contain startup files.  If the target supports multilibs then the
5288 current multilib directory will be prepended to each of these paths.
5289
5290 @item %M
5291 Output the multilib directory with directory separators replaced with
5292 @samp{_}.  If multilib directories are not set, or the multilib directory is
5293 @file{.} then this option emits nothing.
5294
5295 @item %L
5296 Process the @code{lib} spec.  This is a spec string for deciding which
5297 libraries should be included on the command line to the linker.
5298
5299 @item %G
5300 Process the @code{libgcc} spec.  This is a spec string for deciding
5301 which GCC support library should be included on the command line to the linker.
5302
5303 @item %S
5304 Process the @code{startfile} spec.  This is a spec for deciding which
5305 object files should be the first ones passed to the linker.  Typically
5306 this might be a file named @file{crt0.o}.
5307
5308 @item %E
5309 Process the @code{endfile} spec.  This is a spec string that specifies
5310 the last object files that will be passed to the linker.
5311
5312 @item %C
5313 Process the @code{cpp} spec.  This is used to construct the arguments
5314 to be passed to the C preprocessor.
5315
5316 @item %c
5317 Process the @code{signed_char} spec.  This is intended to be used
5318 to tell cpp whether a char is signed.  It typically has the definition:
5319 @smallexample
5320 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5321 @end smallexample
5322
5323 @item %1
5324 Process the @code{cc1} spec.  This is used to construct the options to be
5325 passed to the actual C compiler (@samp{cc1}).
5326
5327 @item %2
5328 Process the @code{cc1plus} spec.  This is used to construct the options to be
5329 passed to the actual C++ compiler (@samp{cc1plus}).
5330
5331 @item %*
5332 Substitute the variable part of a matched option.  See below.
5333 Note that each comma in the substituted string is replaced by
5334 a single space.
5335
5336 @item %<@code{S}
5337 Remove all occurrences of @code{-S} from the command line.  Note---this
5338 command is position dependent.  @samp{%} commands in the spec string
5339 before this one will see @code{-S}, @samp{%} commands in the spec string
5340 after this one will not.
5341
5342 @item %:@var{function}(@var{args})
5343 Call the named function @var{function}, passing it @var{args}.
5344 @var{args} is first processed as a nested spec string, then split
5345 into an argument vector in the usual fashion.  The function returns
5346 a string which is processed as if it had appeared literally as part
5347 of the current spec.
5348
5349 The following built-in spec functions are provided:
5350
5351 @table @code
5352 @item @code{if-exists}
5353 The @code{if-exists} spec function takes one argument, an absolute
5354 pathname to a file.  If the file exists, @code{if-exists} returns the
5355 pathname.  Here is a small example of its usage:
5356
5357 @smallexample
5358 *startfile:
5359 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5360 @end smallexample
5361
5362 @item @code{if-exists-else}
5363 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5364 spec function, except that it takes two arguments.  The first argument is
5365 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5366 returns the pathname.  If it does not exist, it returns the second argument.
5367 This way, @code{if-exists-else} can be used to select one file or another,
5368 based on the existence of the first.  Here is a small example of its usage:
5369
5370 @smallexample 
5371 *startfile:
5372 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5373 @end smallexample
5374 @end table 
5375
5376 @item %@{@code{S}@}
5377 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5378 If that switch was not specified, this substitutes nothing.  Note that
5379 the leading dash is omitted when specifying this option, and it is
5380 automatically inserted if the substitution is performed.  Thus the spec
5381 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5382 and would output the command line option @option{-foo}.
5383
5384 @item %W@{@code{S}@}
5385 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5386 deleted on failure.
5387
5388 @item %@{@code{S}*@}
5389 Substitutes all the switches specified to GCC whose names start
5390 with @code{-S}, but which also take an argument.  This is used for
5391 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5392 GCC considers @option{-o foo} as being
5393 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5394 text, including the space.  Thus two arguments would be generated.
5395
5396 @item %@{@code{S}*&@code{T}*@}
5397 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5398 (the order of @code{S} and @code{T} in the spec is not significant).
5399 There can be any number of ampersand-separated variables; for each the
5400 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5401
5402 @item %@{@code{S}:@code{X}@}
5403 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5404
5405 @item %@{!@code{S}:@code{X}@}
5406 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5407
5408 @item %@{@code{S}*:@code{X}@}
5409 Substitutes @code{X} if one or more switches whose names start with
5410 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5411 once, no matter how many such switches appeared.  However, if @code{%*}
5412 appears somewhere in @code{X}, then @code{X} will be substituted once
5413 for each matching switch, with the @code{%*} replaced by the part of
5414 that switch that matched the @code{*}.
5415
5416 @item %@{.@code{S}:@code{X}@}
5417 Substitutes @code{X}, if processing a file with suffix @code{S}.
5418
5419 @item %@{!.@code{S}:@code{X}@}
5420 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5421
5422 @item %@{@code{S}|@code{P}:@code{X}@}
5423 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5424 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5425 although they have a stronger binding than the @samp{|}.  If @code{%*}
5426 appears in @code{X}, all of the alternatives must be starred, and only
5427 the first matching alternative is substituted.
5428
5429 For example, a spec string like this:
5430
5431 @smallexample
5432 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5433 @end smallexample
5434
5435 will output the following command-line options from the following input
5436 command-line options:
5437
5438 @smallexample
5439 fred.c        -foo -baz
5440 jim.d         -bar -boggle
5441 -d fred.c     -foo -baz -boggle
5442 -d jim.d      -bar -baz -boggle
5443 @end smallexample
5444
5445 @item %@{S:X; T:Y; :D@}
5446
5447 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5448 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5449 be as many clauses as you need.  This may be combined with @code{.}, 
5450 @code{!}, @code{|}, and @code{*} as needed.
5451
5452
5453 @end table
5454
5455 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5456 construct may contain other nested @samp{%} constructs or spaces, or
5457 even newlines.  They are processed as usual, as described above.
5458 Trailing white space in @code{X} is ignored.  White space may also
5459 appear anywhere on the left side of the colon in these constructs,
5460 except between @code{.} or @code{*} and the corresponding word.
5461
5462 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5463 handled specifically in these constructs.  If another value of
5464 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5465 @option{-W} switch is found later in the command line, the earlier
5466 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5467 just one letter, which passes all matching options.
5468
5469 The character @samp{|} at the beginning of the predicate text is used to
5470 indicate that a command should be piped to the following command, but
5471 only if @option{-pipe} is specified.
5472
5473 It is built into GCC which switches take arguments and which do not.
5474 (You might think it would be useful to generalize this to allow each
5475 compiler's spec to say which switches take arguments.  But this cannot
5476 be done in a consistent fashion.  GCC cannot even decide which input
5477 files have been specified without knowing which switches take arguments,
5478 and it must know which input files to compile in order to tell which
5479 compilers to run).
5480
5481 GCC also knows implicitly that arguments starting in @option{-l} are to be
5482 treated as compiler output files, and passed to the linker in their
5483 proper position among the other output files.
5484
5485 @c man begin OPTIONS
5486
5487 @node Target Options
5488 @section Specifying Target Machine and Compiler Version
5489 @cindex target options
5490 @cindex cross compiling
5491 @cindex specifying machine version
5492 @cindex specifying compiler version and target machine
5493 @cindex compiler version, specifying
5494 @cindex target machine, specifying
5495
5496 The usual way to run GCC is to run the executable called @file{gcc}, or
5497 @file{<machine>-gcc} when cross-compiling, or
5498 @file{<machine>-gcc-<version>} to run a version other than the one that
5499 was installed last.  Sometimes this is inconvenient, so GCC provides
5500 options that will switch to another cross-compiler or version.
5501
5502 @table @gcctabopt
5503 @item -b @var{machine}
5504 @opindex b
5505 The argument @var{machine} specifies the target machine for compilation.
5506
5507 The value to use for @var{machine} is the same as was specified as the
5508 machine type when configuring GCC as a cross-compiler.  For
5509 example, if a cross-compiler was configured with @samp{configure
5510 i386v}, meaning to compile for an 80386 running System V, then you
5511 would specify @option{-b i386v} to run that cross compiler.
5512
5513 @item -V @var{version}
5514 @opindex V
5515 The argument @var{version} specifies which version of GCC to run.
5516 This is useful when multiple versions are installed.  For example,
5517 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5518 @end table
5519
5520 The @option{-V} and @option{-b} options work by running the
5521 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5522 use them if you can just run that directly.
5523
5524 @node Submodel Options
5525 @section Hardware Models and Configurations
5526 @cindex submodel options
5527 @cindex specifying hardware config
5528 @cindex hardware models and configurations, specifying
5529 @cindex machine dependent options
5530
5531 Earlier we discussed the standard option @option{-b} which chooses among
5532 different installed compilers for completely different target
5533 machines, such as VAX vs.@: 68000 vs.@: 80386.
5534
5535 In addition, each of these target machine types can have its own
5536 special options, starting with @samp{-m}, to choose among various
5537 hardware models or configurations---for example, 68010 vs 68020,
5538 floating coprocessor or none.  A single installed version of the
5539 compiler can compile for any model or configuration, according to the
5540 options specified.
5541
5542 Some configurations of the compiler also support additional special
5543 options, usually for compatibility with other compilers on the same
5544 platform.
5545
5546 These options are defined by the macro @code{TARGET_SWITCHES} in the
5547 machine description.  The default for the options is also defined by
5548 that macro, which enables you to change the defaults.
5549
5550 @menu
5551 * M680x0 Options::
5552 * M68hc1x Options::
5553 * VAX Options::
5554 * SPARC Options::
5555 * ARM Options::
5556 * MN10200 Options::
5557 * MN10300 Options::
5558 * M32R/D Options::
5559 * M88K Options::
5560 * RS/6000 and PowerPC Options::
5561 * Darwin Options::
5562 * RT Options::
5563 * MIPS Options::
5564 * i386 and x86-64 Options::
5565 * HPPA Options::
5566 * Intel 960 Options::
5567 * DEC Alpha Options::
5568 * DEC Alpha/VMS Options::
5569 * H8/300 Options::
5570 * SH Options::
5571 * System V Options::
5572 * TMS320C3x/C4x Options::
5573 * V850 Options::
5574 * ARC Options::
5575 * NS32K Options::
5576 * AVR Options::
5577 * MCore Options::
5578 * IA-64 Options::
5579 * D30V Options::
5580 * S/390 and zSeries Options::
5581 * CRIS Options::
5582 * MMIX Options::
5583 * PDP-11 Options::
5584 * Xstormy16 Options::
5585 * Xtensa Options::
5586 * FRV Options::
5587 @end menu
5588
5589 @node M680x0 Options
5590 @subsection M680x0 Options
5591 @cindex M680x0 options
5592
5593 These are the @samp{-m} options defined for the 68000 series.  The default
5594 values for these options depends on which style of 68000 was selected when
5595 the compiler was configured; the defaults for the most common choices are
5596 given below.
5597
5598 @table @gcctabopt
5599 @item -m68000
5600 @itemx -mc68000
5601 @opindex m68000
5602 @opindex mc68000
5603 Generate output for a 68000.  This is the default
5604 when the compiler is configured for 68000-based systems.
5605
5606 Use this option for microcontrollers with a 68000 or EC000 core,
5607 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5608
5609 @item -m68020
5610 @itemx -mc68020
5611 @opindex m68020
5612 @opindex mc68020
5613 Generate output for a 68020.  This is the default
5614 when the compiler is configured for 68020-based systems.
5615
5616 @item -m68881
5617 @opindex m68881
5618 Generate output containing 68881 instructions for floating point.
5619 This is the default for most 68020 systems unless @option{--nfp} was
5620 specified when the compiler was configured.
5621
5622 @item -m68030
5623 @opindex m68030
5624 Generate output for a 68030.  This is the default when the compiler is
5625 configured for 68030-based systems.
5626
5627 @item -m68040
5628 @opindex m68040
5629 Generate output for a 68040.  This is the default when the compiler is
5630 configured for 68040-based systems.
5631
5632 This option inhibits the use of 68881/68882 instructions that have to be
5633 emulated by software on the 68040.  Use this option if your 68040 does not
5634 have code to emulate those instructions.
5635
5636 @item -m68060
5637 @opindex m68060
5638 Generate output for a 68060.  This is the default when the compiler is
5639 configured for 68060-based systems.
5640
5641 This option inhibits the use of 68020 and 68881/68882 instructions that
5642 have to be emulated by software on the 68060.  Use this option if your 68060
5643 does not have code to emulate those instructions.
5644
5645 @item -mcpu32
5646 @opindex mcpu32
5647 Generate output for a CPU32.  This is the default
5648 when the compiler is configured for CPU32-based systems.
5649
5650 Use this option for microcontrollers with a
5651 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5652 68336, 68340, 68341, 68349 and 68360.
5653
5654 @item -m5200
5655 @opindex m5200
5656 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5657 when the compiler is configured for 520X-based systems.
5658
5659 Use this option for microcontroller with a 5200 core, including
5660 the MCF5202, MCF5203, MCF5204 and MCF5202.
5661
5662
5663 @item -m68020-40
5664 @opindex m68020-40
5665 Generate output for a 68040, without using any of the new instructions.
5666 This results in code which can run relatively efficiently on either a
5667 68020/68881 or a 68030 or a 68040.  The generated code does use the
5668 68881 instructions that are emulated on the 68040.
5669
5670 @item -m68020-60
5671 @opindex m68020-60
5672 Generate output for a 68060, without using any of the new instructions.
5673 This results in code which can run relatively efficiently on either a
5674 68020/68881 or a 68030 or a 68040.  The generated code does use the
5675 68881 instructions that are emulated on the 68060.
5676
5677 @item -mfpa
5678 @opindex mfpa
5679 Generate output containing Sun FPA instructions for floating point.
5680
5681 @item -msoft-float
5682 @opindex msoft-float
5683 Generate output containing library calls for floating point.
5684 @strong{Warning:} the requisite libraries are not available for all m68k
5685 targets.  Normally the facilities of the machine's usual C compiler are
5686 used, but this can't be done directly in cross-compilation.  You must
5687 make your own arrangements to provide suitable library functions for
5688 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5689 @samp{m68k-*-coff} do provide software floating point support.
5690
5691 @item -mshort
5692 @opindex mshort
5693 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5694
5695 @item -mnobitfield
5696 @opindex mnobitfield
5697 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5698 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5699
5700 @item -mbitfield
5701 @opindex mbitfield
5702 Do use the bit-field instructions.  The @option{-m68020} option implies
5703 @option{-mbitfield}.  This is the default if you use a configuration
5704 designed for a 68020.
5705
5706 @item -mrtd
5707 @opindex mrtd
5708 Use a different function-calling convention, in which functions
5709 that take a fixed number of arguments return with the @code{rtd}
5710 instruction, which pops their arguments while returning.  This
5711 saves one instruction in the caller since there is no need to pop
5712 the arguments there.
5713
5714 This calling convention is incompatible with the one normally
5715 used on Unix, so you cannot use it if you need to call libraries
5716 compiled with the Unix compiler.
5717
5718 Also, you must provide function prototypes for all functions that
5719 take variable numbers of arguments (including @code{printf});
5720 otherwise incorrect code will be generated for calls to those
5721 functions.
5722
5723 In addition, seriously incorrect code will result if you call a
5724 function with too many arguments.  (Normally, extra arguments are
5725 harmlessly ignored.)
5726
5727 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5728 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5729
5730 @item -malign-int
5731 @itemx -mno-align-int
5732 @opindex malign-int
5733 @opindex mno-align-int
5734 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5735 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5736 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5737 Aligning variables on 32-bit boundaries produces code that runs somewhat
5738 faster on processors with 32-bit busses at the expense of more memory.
5739
5740 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5741 align structures containing the above types  differently than
5742 most published application binary interface specifications for the m68k.
5743
5744 @item -mpcrel
5745 @opindex mpcrel
5746 Use the pc-relative addressing mode of the 68000 directly, instead of
5747 using a global offset table.  At present, this option implies @option{-fpic},
5748 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5749 not presently supported with @option{-mpcrel}, though this could be supported for
5750 68020 and higher processors.
5751
5752 @item -mno-strict-align
5753 @itemx -mstrict-align
5754 @opindex mno-strict-align
5755 @opindex mstrict-align
5756 Do not (do) assume that unaligned memory references will be handled by
5757 the system.
5758
5759 @end table
5760
5761 @node M68hc1x Options
5762 @subsection M68hc1x Options
5763 @cindex M68hc1x options
5764
5765 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5766 microcontrollers.  The default values for these options depends on
5767 which style of microcontroller was selected when the compiler was configured;
5768 the defaults for the most common choices are given below.
5769
5770 @table @gcctabopt
5771 @item -m6811
5772 @itemx -m68hc11
5773 @opindex m6811
5774 @opindex m68hc11
5775 Generate output for a 68HC11.  This is the default
5776 when the compiler is configured for 68HC11-based systems.
5777
5778 @item -m6812
5779 @itemx -m68hc12
5780 @opindex m6812
5781 @opindex m68hc12
5782 Generate output for a 68HC12.  This is the default
5783 when the compiler is configured for 68HC12-based systems.
5784
5785 @item -m68S12
5786 @itemx -m68hcs12
5787 @opindex m68S12
5788 @opindex m68hcs12
5789 Generate output for a 68HCS12.  
5790
5791 @item -mauto-incdec
5792 @opindex mauto-incdec
5793 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5794 addressing modes.
5795
5796 @item -minmax
5797 @itemx -nominmax
5798 @opindex minmax
5799 @opindex mnominmax
5800 Enable the use of 68HC12 min and max instructions.
5801
5802 @item -mlong-calls
5803 @itemx -mno-long-calls
5804 @opindex mlong-calls
5805 @opindex mno-long-calls
5806 Treat all calls as being far away (near).  If calls are assumed to be
5807 far away, the compiler will use the @code{call} instruction to
5808 call a function and the @code{rtc} instruction for returning.
5809
5810 @item -mshort
5811 @opindex mshort
5812 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5813
5814 @item -msoft-reg-count=@var{count}
5815 @opindex msoft-reg-count
5816 Specify the number of pseudo-soft registers which are used for the
5817 code generation.  The maximum number is 32.  Using more pseudo-soft
5818 register may or may not result in better code depending on the program.
5819 The default is 4 for 68HC11 and 2 for 68HC12.
5820
5821 @end table
5822
5823 @node VAX Options
5824 @subsection VAX Options
5825 @cindex VAX options
5826
5827 These @samp{-m} options are defined for the VAX:
5828
5829 @table @gcctabopt
5830 @item -munix
5831 @opindex munix
5832 Do not output certain jump instructions (@code{aobleq} and so on)
5833 that the Unix assembler for the VAX cannot handle across long
5834 ranges.
5835
5836 @item -mgnu
5837 @opindex mgnu
5838 Do output those jump instructions, on the assumption that you
5839 will assemble with the GNU assembler.
5840
5841 @item -mg
5842 @opindex mg
5843 Output code for g-format floating point numbers instead of d-format.
5844 @end table
5845
5846 @node SPARC Options
5847 @subsection SPARC Options
5848 @cindex SPARC options
5849
5850 These @samp{-m} switches are supported on the SPARC:
5851
5852 @table @gcctabopt
5853 @item -mno-app-regs
5854 @itemx -mapp-regs
5855 @opindex mno-app-regs
5856 @opindex mapp-regs
5857 Specify @option{-mapp-regs} to generate output using the global registers
5858 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5859 is the default.
5860
5861 To be fully SVR4 ABI compliant at the cost of some performance loss,
5862 specify @option{-mno-app-regs}.  You should compile libraries and system
5863 software with this option.
5864
5865 @item -mfpu
5866 @itemx -mhard-float
5867 @opindex mfpu
5868 @opindex mhard-float
5869 Generate output containing floating point instructions.  This is the
5870 default.
5871
5872 @item -mno-fpu
5873 @itemx -msoft-float
5874 @opindex mno-fpu
5875 @opindex msoft-float
5876 Generate output containing library calls for floating point.
5877 @strong{Warning:} the requisite libraries are not available for all SPARC
5878 targets.  Normally the facilities of the machine's usual C compiler are
5879 used, but this cannot be done directly in cross-compilation.  You must make
5880 your own arrangements to provide suitable library functions for
5881 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5882 @samp{sparclite-*-*} do provide software floating point support.
5883
5884 @option{-msoft-float} changes the calling convention in the output file;
5885 therefore, it is only useful if you compile @emph{all} of a program with
5886 this option.  In particular, you need to compile @file{libgcc.a}, the
5887 library that comes with GCC, with @option{-msoft-float} in order for
5888 this to work.
5889
5890 @item -mhard-quad-float
5891 @opindex mhard-quad-float
5892 Generate output containing quad-word (long double) floating point
5893 instructions.
5894
5895 @item -msoft-quad-float
5896 @opindex msoft-quad-float
5897 Generate output containing library calls for quad-word (long double)
5898 floating point instructions.  The functions called are those specified
5899 in the SPARC ABI@.  This is the default.
5900
5901 As of this writing, there are no sparc implementations that have hardware
5902 support for the quad-word floating point instructions.  They all invoke
5903 a trap handler for one of these instructions, and then the trap handler
5904 emulates the effect of the instruction.  Because of the trap handler overhead,
5905 this is much slower than calling the ABI library routines.  Thus the
5906 @option{-msoft-quad-float} option is the default.
5907
5908 @item -mno-flat
5909 @itemx -mflat
5910 @opindex mno-flat
5911 @opindex mflat
5912 With @option{-mflat}, the compiler does not generate save/restore instructions
5913 and will use a ``flat'' or single register window calling convention.
5914 This model uses %i7 as the frame pointer and is compatible with the normal
5915 register window model.  Code from either may be intermixed.
5916 The local registers and the input registers (0--5) are still treated as
5917 ``call saved'' registers and will be saved on the stack as necessary.
5918
5919 With @option{-mno-flat} (the default), the compiler emits save/restore
5920 instructions (except for leaf functions) and is the normal mode of operation.
5921
5922 @item -mno-unaligned-doubles
5923 @itemx -munaligned-doubles
5924 @opindex mno-unaligned-doubles
5925 @opindex munaligned-doubles
5926 Assume that doubles have 8 byte alignment.  This is the default.
5927
5928 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5929 alignment only if they are contained in another type, or if they have an
5930 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5931 Specifying this option avoids some rare compatibility problems with code
5932 generated by other compilers.  It is not the default because it results
5933 in a performance loss, especially for floating point code.
5934
5935 @item -mno-faster-structs
5936 @itemx -mfaster-structs
5937 @opindex mno-faster-structs
5938 @opindex mfaster-structs
5939 With @option{-mfaster-structs}, the compiler assumes that structures
5940 should have 8 byte alignment.  This enables the use of pairs of
5941 @code{ldd} and @code{std} instructions for copies in structure
5942 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5943 However, the use of this changed alignment directly violates the SPARC
5944 ABI@.  Thus, it's intended only for use on targets where the developer
5945 acknowledges that their resulting code will not be directly in line with
5946 the rules of the ABI@.
5947
5948 @item -mv8
5949 @itemx -msparclite
5950 @opindex mv8
5951 @opindex msparclite
5952 These two options select variations on the SPARC architecture.
5953
5954 By default (unless specifically configured for the Fujitsu SPARClite),
5955 GCC generates code for the v7 variant of the SPARC architecture.
5956
5957 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5958 code is that the compiler emits the integer multiply and integer
5959 divide instructions which exist in SPARC v8 but not in SPARC v7.
5960
5961 @option{-msparclite} will give you SPARClite code.  This adds the integer
5962 multiply, integer divide step and scan (@code{ffs}) instructions which
5963 exist in SPARClite but not in SPARC v7.
5964
5965 These options are deprecated and will be deleted in a future GCC release.
5966 They have been replaced with @option{-mcpu=xxx}.
5967
5968 @item -mcypress
5969 @itemx -msupersparc
5970 @opindex mcypress
5971 @opindex msupersparc
5972 These two options select the processor for which the code is optimized.
5973
5974 With @option{-mcypress} (the default), the compiler optimizes code for the
5975 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5976 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5977
5978 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5979 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5980 of the full SPARC v8 instruction set.
5981
5982 These options are deprecated and will be deleted in a future GCC release.
5983 They have been replaced with @option{-mcpu=xxx}.
5984
5985 @item -mcpu=@var{cpu_type}
5986 @opindex mcpu
5987 Set the instruction set, register set, and instruction scheduling parameters
5988 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5989 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5990 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5991 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5992 @samp{ultrasparc3}.
5993
5994 Default instruction scheduling parameters are used for values that select
5995 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5996 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5997
5998 Here is a list of each supported architecture and their supported
5999 implementations.
6000
6001 @smallexample
6002     v7:             cypress
6003     v8:             supersparc, hypersparc
6004     sparclite:      f930, f934, sparclite86x
6005     sparclet:       tsc701
6006     v9:             ultrasparc, ultrasparc3
6007 @end smallexample
6008
6009 @item -mtune=@var{cpu_type}
6010 @opindex mtune
6011 Set the instruction scheduling parameters for machine type
6012 @var{cpu_type}, but do not set the instruction set or register set that the
6013 option @option{-mcpu=@var{cpu_type}} would.
6014
6015 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6016 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6017 that select a particular cpu implementation.  Those are @samp{cypress},
6018 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6019 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6020 @samp{ultrasparc3}.
6021
6022 @end table
6023
6024 These @samp{-m} switches are supported in addition to the above
6025 on the SPARCLET processor.
6026
6027 @table @gcctabopt
6028 @item -mlittle-endian
6029 @opindex mlittle-endian
6030 Generate code for a processor running in little-endian mode.
6031
6032 @item -mlive-g0
6033 @opindex mlive-g0
6034 Treat register @code{%g0} as a normal register.
6035 GCC will continue to clobber it as necessary but will not assume
6036 it always reads as 0.
6037
6038 @item -mbroken-saverestore
6039 @opindex mbroken-saverestore
6040 Generate code that does not use non-trivial forms of the @code{save} and
6041 @code{restore} instructions.  Early versions of the SPARCLET processor do
6042 not correctly handle @code{save} and @code{restore} instructions used with
6043 arguments.  They correctly handle them used without arguments.  A @code{save}
6044 instruction used without arguments increments the current window pointer
6045 but does not allocate a new stack frame.  It is assumed that the window
6046 overflow trap handler will properly handle this case as will interrupt
6047 handlers.
6048 @end table
6049
6050 These @samp{-m} switches are supported in addition to the above
6051 on SPARC V9 processors in 64-bit environments.
6052
6053 @table @gcctabopt
6054 @item -mlittle-endian
6055 @opindex mlittle-endian
6056 Generate code for a processor running in little-endian mode.
6057
6058 @item -m32
6059 @itemx -m64
6060 @opindex m32
6061 @opindex m64
6062 Generate code for a 32-bit or 64-bit environment.
6063 The 32-bit environment sets int, long and pointer to 32 bits.
6064 The 64-bit environment sets int to 32 bits and long and pointer
6065 to 64 bits.
6066
6067 @item -mcmodel=medlow
6068 @opindex mcmodel=medlow
6069 Generate code for the Medium/Low code model: the program must be linked
6070 in the low 32 bits of the address space.  Pointers are 64 bits.
6071 Programs can be statically or dynamically linked.
6072
6073 @item -mcmodel=medmid
6074 @opindex mcmodel=medmid
6075 Generate code for the Medium/Middle code model: the program must be linked
6076 in the low 44 bits of the address space, the text segment must be less than
6077 2G bytes, and data segment must be within 2G of the text segment.
6078 Pointers are 64 bits.
6079
6080 @item -mcmodel=medany
6081 @opindex mcmodel=medany
6082 Generate code for the Medium/Anywhere code model: the program may be linked
6083 anywhere in the address space, the text segment must be less than
6084 2G bytes, and data segment must be within 2G of the text segment.
6085 Pointers are 64 bits.
6086
6087 @item -mcmodel=embmedany
6088 @opindex mcmodel=embmedany
6089 Generate code for the Medium/Anywhere code model for embedded systems:
6090 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6091 (determined at link time).  Register %g4 points to the base of the
6092 data segment.  Pointers are still 64 bits.
6093 Programs are statically linked, PIC is not supported.
6094
6095 @item -mstack-bias
6096 @itemx -mno-stack-bias
6097 @opindex mstack-bias
6098 @opindex mno-stack-bias
6099 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6100 frame pointer if present, are offset by @minus{}2047 which must be added back
6101 when making stack frame references.
6102 Otherwise, assume no such offset is present.
6103 @end table
6104
6105 @node ARM Options
6106 @subsection ARM Options
6107 @cindex ARM options
6108
6109 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6110 architectures:
6111
6112 @table @gcctabopt
6113 @item -mapcs-frame
6114 @opindex mapcs-frame
6115 Generate a stack frame that is compliant with the ARM Procedure Call
6116 Standard for all functions, even if this is not strictly necessary for
6117 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6118 with this option will cause the stack frames not to be generated for
6119 leaf functions.  The default is @option{-mno-apcs-frame}.
6120
6121 @item -mapcs
6122 @opindex mapcs
6123 This is a synonym for @option{-mapcs-frame}.
6124
6125 @item -mapcs-26
6126 @opindex mapcs-26
6127 Generate code for a processor running with a 26-bit program counter,
6128 and conforming to the function calling standards for the APCS 26-bit
6129 option.  This option replaces the @option{-m2} and @option{-m3} options
6130 of previous releases of the compiler.
6131
6132 @item -mapcs-32
6133 @opindex mapcs-32
6134 Generate code for a processor running with a 32-bit program counter,
6135 and conforming to the function calling standards for the APCS 32-bit
6136 option.  This option replaces the @option{-m6} option of previous releases
6137 of the compiler.
6138
6139 @ignore
6140 @c not currently implemented
6141 @item -mapcs-stack-check
6142 @opindex mapcs-stack-check
6143 Generate code to check the amount of stack space available upon entry to
6144 every function (that actually uses some stack space).  If there is
6145 insufficient space available then either the function
6146 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6147 called, depending upon the amount of stack space required.  The run time
6148 system is required to provide these functions.  The default is
6149 @option{-mno-apcs-stack-check}, since this produces smaller code.
6150
6151 @c not currently implemented
6152 @item -mapcs-float
6153 @opindex mapcs-float
6154 Pass floating point arguments using the float point registers.  This is
6155 one of the variants of the APCS@.  This option is recommended if the
6156 target hardware has a floating point unit or if a lot of floating point
6157 arithmetic is going to be performed by the code.  The default is
6158 @option{-mno-apcs-float}, since integer only code is slightly increased in
6159 size if @option{-mapcs-float} is used.
6160
6161 @c not currently implemented
6162 @item -mapcs-reentrant
6163 @opindex mapcs-reentrant
6164 Generate reentrant, position independent code.  The default is
6165 @option{-mno-apcs-reentrant}.
6166 @end ignore
6167
6168 @item -mthumb-interwork
6169 @opindex mthumb-interwork
6170 Generate code which supports calling between the ARM and Thumb
6171 instruction sets.  Without this option the two instruction sets cannot
6172 be reliably used inside one program.  The default is
6173 @option{-mno-thumb-interwork}, since slightly larger code is generated
6174 when @option{-mthumb-interwork} is specified.
6175
6176 @item -mno-sched-prolog
6177 @opindex mno-sched-prolog
6178 Prevent the reordering of instructions in the function prolog, or the
6179 merging of those instruction with the instructions in the function's
6180 body.  This means that all functions will start with a recognizable set
6181 of instructions (or in fact one of a choice from a small set of
6182 different function prologues), and this information can be used to
6183 locate the start if functions inside an executable piece of code.  The
6184 default is @option{-msched-prolog}.
6185
6186 @item -mhard-float
6187 @opindex mhard-float
6188 Generate output containing floating point instructions.  This is the
6189 default.
6190
6191 @item -msoft-float
6192 @opindex msoft-float
6193 Generate output containing library calls for floating point.
6194 @strong{Warning:} the requisite libraries are not available for all ARM
6195 targets.  Normally the facilities of the machine's usual C compiler are
6196 used, but this cannot be done directly in cross-compilation.  You must make
6197 your own arrangements to provide suitable library functions for
6198 cross-compilation.
6199
6200 @option{-msoft-float} changes the calling convention in the output file;
6201 therefore, it is only useful if you compile @emph{all} of a program with
6202 this option.  In particular, you need to compile @file{libgcc.a}, the
6203 library that comes with GCC, with @option{-msoft-float} in order for
6204 this to work.
6205
6206 @item -mlittle-endian
6207 @opindex mlittle-endian
6208 Generate code for a processor running in little-endian mode.  This is
6209 the default for all standard configurations.
6210
6211 @item -mbig-endian
6212 @opindex mbig-endian
6213 Generate code for a processor running in big-endian mode; the default is
6214 to compile code for a little-endian processor.
6215
6216 @item -mwords-little-endian
6217 @opindex mwords-little-endian
6218 This option only applies when generating code for big-endian processors.
6219 Generate code for a little-endian word order but a big-endian byte
6220 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6221 option should only be used if you require compatibility with code for
6222 big-endian ARM processors generated by versions of the compiler prior to
6223 2.8.
6224
6225 @item -malignment-traps
6226 @opindex malignment-traps
6227 Generate code that will not trap if the MMU has alignment traps enabled.
6228 On ARM architectures prior to ARMv4, there were no instructions to
6229 access half-word objects stored in memory.  However, when reading from
6230 memory a feature of the ARM architecture allows a word load to be used,
6231 even if the address is unaligned, and the processor core will rotate the
6232 data as it is being loaded.  This option tells the compiler that such
6233 misaligned accesses will cause a MMU trap and that it should instead
6234 synthesize the access as a series of byte accesses.  The compiler can
6235 still use word accesses to load half-word data if it knows that the
6236 address is aligned to a word boundary.
6237
6238 This option is ignored when compiling for ARM architecture 4 or later,
6239 since these processors have instructions to directly access half-word
6240 objects in memory.
6241
6242 @item -mno-alignment-traps
6243 @opindex mno-alignment-traps
6244 Generate code that assumes that the MMU will not trap unaligned
6245 accesses.  This produces better code when the target instruction set
6246 does not have half-word memory operations (i.e.@: implementations prior to
6247 ARMv4).
6248
6249 Note that you cannot use this option to access unaligned word objects,
6250 since the processor will only fetch one 32-bit aligned object from
6251 memory.
6252
6253 The default setting for most targets is @option{-mno-alignment-traps}, since
6254 this produces better code when there are no half-word memory
6255 instructions available.
6256
6257 @item -mshort-load-bytes
6258 @itemx -mno-short-load-words
6259 @opindex mshort-load-bytes
6260 @opindex mno-short-load-words
6261 These are deprecated aliases for @option{-malignment-traps}.
6262
6263 @item -mno-short-load-bytes
6264 @itemx -mshort-load-words
6265 @opindex mno-short-load-bytes
6266 @opindex mshort-load-words
6267 This are deprecated aliases for @option{-mno-alignment-traps}.
6268
6269 @item -mcpu=@var{name}
6270 @opindex mcpu
6271 This specifies the name of the target ARM processor.  GCC uses this name
6272 to determine what kind of instructions it can emit when generating
6273 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6274 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6275 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6276 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6277 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6278 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6279 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6280 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6281 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6282 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6283
6284 @itemx -mtune=@var{name}
6285 @opindex mtune
6286 This option is very similar to the @option{-mcpu=} option, except that
6287 instead of specifying the actual target processor type, and hence
6288 restricting which instructions can be used, it specifies that GCC should
6289 tune the performance of the code as if the target were of the type
6290 specified in this option, but still choosing the instructions that it
6291 will generate based on the cpu specified by a @option{-mcpu=} option.
6292 For some ARM implementations better performance can be obtained by using
6293 this option.
6294
6295 @item -march=@var{name}
6296 @opindex march
6297 This specifies the name of the target ARM architecture.  GCC uses this
6298 name to determine what kind of instructions it can emit when generating
6299 assembly code.  This option can be used in conjunction with or instead
6300 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6301 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6302 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6303
6304 @item -mfpe=@var{number}
6305 @itemx -mfp=@var{number}
6306 @opindex mfpe
6307 @opindex mfp
6308 This specifies the version of the floating point emulation available on
6309 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6310 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6311
6312 @item -mstructure-size-boundary=@var{n}
6313 @opindex mstructure-size-boundary
6314 The size of all structures and unions will be rounded up to a multiple
6315 of the number of bits set by this option.  Permissible values are 8 and
6316 32.  The default value varies for different toolchains.  For the COFF
6317 targeted toolchain the default value is 8.  Specifying the larger number
6318 can produce faster, more efficient code, but can also increase the size
6319 of the program.  The two values are potentially incompatible.  Code
6320 compiled with one value cannot necessarily expect to work with code or
6321 libraries compiled with the other value, if they exchange information
6322 using structures or unions.
6323
6324 @item -mabort-on-noreturn
6325 @opindex mabort-on-noreturn
6326 Generate a call to the function @code{abort} at the end of a
6327 @code{noreturn} function.  It will be executed if the function tries to
6328 return.
6329
6330 @item -mlong-calls
6331 @itemx -mno-long-calls
6332 @opindex mlong-calls
6333 @opindex mno-long-calls
6334 Tells the compiler to perform function calls by first loading the
6335 address of the function into a register and then performing a subroutine
6336 call on this register.  This switch is needed if the target function
6337 will lie outside of the 64 megabyte addressing range of the offset based
6338 version of subroutine call instruction.
6339
6340 Even if this switch is enabled, not all function calls will be turned
6341 into long calls.  The heuristic is that static functions, functions
6342 which have the @samp{short-call} attribute, functions that are inside
6343 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6344 definitions have already been compiled within the current compilation
6345 unit, will not be turned into long calls.  The exception to this rule is
6346 that weak function definitions, functions with the @samp{long-call}
6347 attribute or the @samp{section} attribute, and functions that are within
6348 the scope of a @samp{#pragma long_calls} directive, will always be
6349 turned into long calls.
6350
6351 This feature is not enabled by default.  Specifying
6352 @option{-mno-long-calls} will restore the default behavior, as will
6353 placing the function calls within the scope of a @samp{#pragma
6354 long_calls_off} directive.  Note these switches have no effect on how
6355 the compiler generates code to handle function calls via function
6356 pointers.
6357
6358 @item -mnop-fun-dllimport
6359 @opindex mnop-fun-dllimport
6360 Disable support for the @code{dllimport} attribute.
6361
6362 @item -msingle-pic-base
6363 @opindex msingle-pic-base
6364 Treat the register used for PIC addressing as read-only, rather than
6365 loading it in the prologue for each function.  The run-time system is
6366 responsible for initializing this register with an appropriate value
6367 before execution begins.
6368
6369 @item -mpic-register=@var{reg}
6370 @opindex mpic-register
6371 Specify the register to be used for PIC addressing.  The default is R10
6372 unless stack-checking is enabled, when R9 is used.
6373
6374 @item -mcirrus-fix-invalid-insns
6375 @opindex -mcirrus-fix-invalid-insns
6376 @opindex -mno-cirrus-fix-invalid-insns
6377 Insert NOPs into the instruction stream to in order to work around
6378 problems with invalid Maverick instruction combinations.  This option
6379 is only valid if the @option{-mcpu=ep9312} option has been used to
6380 enable generation of instructions for the Cirrus Maverick floating
6381 point co-processor.  This option is not enabled by default, since the
6382 problem is only present in older Maverick implemenations.  The default
6383 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6384 switch.
6385
6386 @item -mpoke-function-name
6387 @opindex mpoke-function-name
6388 Write the name of each function into the text section, directly
6389 preceding the function prologue.  The generated code is similar to this:
6390
6391 @smallexample
6392      t0
6393          .ascii "arm_poke_function_name", 0
6394          .align
6395      t1
6396          .word 0xff000000 + (t1 - t0)
6397      arm_poke_function_name
6398          mov     ip, sp
6399          stmfd   sp!, @{fp, ip, lr, pc@}
6400          sub     fp, ip, #4
6401 @end smallexample
6402
6403 When performing a stack backtrace, code can inspect the value of
6404 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6405 location @code{pc - 12} and the top 8 bits are set, then we know that
6406 there is a function name embedded immediately preceding this location
6407 and has length @code{((pc[-3]) & 0xff000000)}.
6408
6409 @item -mthumb
6410 @opindex mthumb
6411 Generate code for the 16-bit Thumb instruction set.  The default is to
6412 use the 32-bit ARM instruction set.
6413
6414 @item -mtpcs-frame
6415 @opindex mtpcs-frame
6416 Generate a stack frame that is compliant with the Thumb Procedure Call
6417 Standard for all non-leaf functions.  (A leaf function is one that does
6418 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6419
6420 @item -mtpcs-leaf-frame
6421 @opindex mtpcs-leaf-frame
6422 Generate a stack frame that is compliant with the Thumb Procedure Call
6423 Standard for all leaf functions.  (A leaf function is one that does
6424 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6425
6426 @item -mcallee-super-interworking
6427 @opindex mcallee-super-interworking
6428 Gives all externally visible functions in the file being compiled an ARM
6429 instruction set header which switches to Thumb mode before executing the
6430 rest of the function.  This allows these functions to be called from
6431 non-interworking code.
6432
6433 @item -mcaller-super-interworking
6434 @opindex mcaller-super-interworking
6435 Allows calls via function pointers (including virtual functions) to
6436 execute correctly regardless of whether the target code has been
6437 compiled for interworking or not.  There is a small overhead in the cost
6438 of executing a function pointer if this option is enabled.
6439
6440 @end table
6441
6442 @node MN10200 Options
6443 @subsection MN10200 Options
6444 @cindex MN10200 options
6445 These @option{-m} options are defined for Matsushita MN10200 architectures:
6446 @table @gcctabopt
6447
6448 @item -mrelax
6449 @opindex mrelax
6450 Indicate to the linker that it should perform a relaxation optimization pass
6451 to shorten branches, calls and absolute memory addresses.  This option only
6452 has an effect when used on the command line for the final link step.
6453
6454 This option makes symbolic debugging impossible.
6455 @end table
6456
6457 @node MN10300 Options
6458 @subsection MN10300 Options
6459 @cindex MN10300 options
6460 These @option{-m} options are defined for Matsushita MN10300 architectures:
6461
6462 @table @gcctabopt
6463 @item -mmult-bug
6464 @opindex mmult-bug
6465 Generate code to avoid bugs in the multiply instructions for the MN10300
6466 processors.  This is the default.
6467
6468 @item -mno-mult-bug
6469 @opindex mno-mult-bug
6470 Do not generate code to avoid bugs in the multiply instructions for the
6471 MN10300 processors.
6472
6473 @item -mam33
6474 @opindex mam33
6475 Generate code which uses features specific to the AM33 processor.
6476
6477 @item -mno-am33
6478 @opindex mno-am33
6479 Do not generate code which uses features specific to the AM33 processor.  This
6480 is the default.
6481
6482 @item -mno-crt0
6483 @opindex mno-crt0
6484 Do not link in the C run-time initialization object file.
6485
6486 @item -mrelax
6487 @opindex mrelax
6488 Indicate to the linker that it should perform a relaxation optimization pass
6489 to shorten branches, calls and absolute memory addresses.  This option only
6490 has an effect when used on the command line for the final link step.
6491
6492 This option makes symbolic debugging impossible.
6493 @end table
6494
6495
6496 @node M32R/D Options
6497 @subsection M32R/D Options
6498 @cindex M32R/D options
6499
6500 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6501
6502 @table @gcctabopt
6503 @item -m32rx
6504 @opindex m32rx
6505 Generate code for the M32R/X@.
6506
6507 @item -m32r
6508 @opindex m32r
6509 Generate code for the M32R@.  This is the default.
6510
6511 @item -mcode-model=small
6512 @opindex mcode-model=small
6513 Assume all objects live in the lower 16MB of memory (so that their addresses
6514 can be loaded with the @code{ld24} instruction), and assume all subroutines
6515 are reachable with the @code{bl} instruction.
6516 This is the default.
6517
6518 The addressability of a particular object can be set with the
6519 @code{model} attribute.
6520
6521 @item -mcode-model=medium
6522 @opindex mcode-model=medium
6523 Assume objects may be anywhere in the 32-bit address space (the compiler
6524 will generate @code{seth/add3} instructions to load their addresses), and
6525 assume all subroutines are reachable with the @code{bl} instruction.
6526
6527 @item -mcode-model=large
6528 @opindex mcode-model=large
6529 Assume objects may be anywhere in the 32-bit address space (the compiler
6530 will generate @code{seth/add3} instructions to load their addresses), and
6531 assume subroutines may not be reachable with the @code{bl} instruction
6532 (the compiler will generate the much slower @code{seth/add3/jl}
6533 instruction sequence).
6534
6535 @item -msdata=none
6536 @opindex msdata=none
6537 Disable use of the small data area.  Variables will be put into
6538 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6539 @code{section} attribute has been specified).
6540 This is the default.
6541
6542 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6543 Objects may be explicitly put in the small data area with the
6544 @code{section} attribute using one of these sections.
6545
6546 @item -msdata=sdata
6547 @opindex msdata=sdata
6548 Put small global and static data in the small data area, but do not
6549 generate special code to reference them.
6550
6551 @item -msdata=use
6552 @opindex msdata=use
6553 Put small global and static data in the small data area, and generate
6554 special instructions to reference them.
6555
6556 @item -G @var{num}
6557 @opindex G
6558 @cindex smaller data references
6559 Put global and static objects less than or equal to @var{num} bytes
6560 into the small data or bss sections instead of the normal data or bss
6561 sections.  The default value of @var{num} is 8.
6562 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6563 for this option to have any effect.
6564
6565 All modules should be compiled with the same @option{-G @var{num}} value.
6566 Compiling with different values of @var{num} may or may not work; if it
6567 doesn't the linker will give an error message---incorrect code will not be
6568 generated.
6569
6570 @end table
6571
6572 @node M88K Options
6573 @subsection M88K Options
6574 @cindex M88k options
6575
6576 These @samp{-m} options are defined for Motorola 88k architectures:
6577
6578 @table @gcctabopt
6579 @item -m88000
6580 @opindex m88000
6581 Generate code that works well on both the m88100 and the
6582 m88110.
6583
6584 @item -m88100
6585 @opindex m88100
6586 Generate code that works best for the m88100, but that also
6587 runs on the m88110.
6588
6589 @item -m88110
6590 @opindex m88110
6591 Generate code that works best for the m88110, and may not run
6592 on the m88100.
6593
6594 @item -mbig-pic
6595 @opindex mbig-pic
6596 Obsolete option to be removed from the next revision.
6597 Use @option{-fPIC}.
6598
6599 @item -midentify-revision
6600 @opindex midentify-revision
6601 @cindex identifying source, compiler (88k)
6602 Include an @code{ident} directive in the assembler output recording the
6603 source file name, compiler name and version, timestamp, and compilation
6604 flags used.
6605
6606 @item -mno-underscores
6607 @opindex mno-underscores
6608 @cindex underscores, avoiding (88k)
6609 In assembler output, emit symbol names without adding an underscore
6610 character at the beginning of each name.  The default is to use an
6611 underscore as prefix on each name.
6612
6613 @item -mocs-debug-info
6614 @itemx -mno-ocs-debug-info
6615 @opindex mocs-debug-info
6616 @opindex mno-ocs-debug-info
6617 @cindex OCS (88k)
6618 @cindex debugging, 88k OCS
6619 Include (or omit) additional debugging information (about registers used
6620 in each stack frame) as specified in the 88open Object Compatibility
6621 Standard, ``OCS''@.  This extra information allows debugging of code that
6622 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6623 SVr3.2 is to include this information; other 88k configurations omit this
6624 information by default.
6625
6626 @item -mocs-frame-position
6627 @opindex mocs-frame-position
6628 @cindex register positions in frame (88k)
6629 When emitting COFF debugging information for automatic variables and
6630 parameters stored on the stack, use the offset from the canonical frame
6631 address, which is the stack pointer (register 31) on entry to the
6632 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6633 @option{-mocs-frame-position}; other 88k configurations have the default
6634 @option{-mno-ocs-frame-position}.
6635
6636 @item -mno-ocs-frame-position
6637 @opindex mno-ocs-frame-position
6638 @cindex register positions in frame (88k)
6639 When emitting COFF debugging information for automatic variables and
6640 parameters stored on the stack, use the offset from the frame pointer
6641 register (register 30).  When this option is in effect, the frame
6642 pointer is not eliminated when debugging information is selected by the
6643 -g switch.
6644
6645 @item -moptimize-arg-area
6646 @opindex moptimize-arg-area
6647 @cindex arguments in frame (88k)
6648 Save space by reorganizing the stack frame.  This option generates code
6649 that does not agree with the 88open specifications, but uses less
6650 memory.
6651
6652 @itemx -mno-optimize-arg-area
6653 @opindex mno-optimize-arg-area
6654 Do not reorganize the stack frame to save space.  This is the default.
6655 The generated conforms to the specification, but uses more memory.
6656
6657 @item -mshort-data-@var{num}
6658 @opindex mshort-data
6659 @cindex smaller data references (88k)
6660 @cindex r0-relative references (88k)
6661 Generate smaller data references by making them relative to @code{r0},
6662 which allows loading a value using a single instruction (rather than the
6663 usual two).  You control which data references are affected by
6664 specifying @var{num} with this option.  For example, if you specify
6665 @option{-mshort-data-512}, then the data references affected are those
6666 involving displacements of less than 512 bytes.
6667 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6668 than 64k.
6669
6670 @item -mserialize-volatile
6671 @opindex mserialize-volatile
6672 @itemx -mno-serialize-volatile
6673 @opindex mno-serialize-volatile
6674 @cindex sequential consistency on 88k
6675 Do, or don't, generate code to guarantee sequential consistency
6676 of volatile memory references.  By default, consistency is
6677 guaranteed.
6678
6679 The order of memory references made by the MC88110 processor does
6680 not always match the order of the instructions requesting those
6681 references.  In particular, a load instruction may execute before
6682 a preceding store instruction.  Such reordering violates
6683 sequential consistency of volatile memory references, when there
6684 are multiple processors.   When consistency must be guaranteed,
6685 GCC generates special instructions, as needed, to force
6686 execution in the proper order.
6687
6688 The MC88100 processor does not reorder memory references and so
6689 always provides sequential consistency.  However, by default, GCC
6690 generates the special instructions to guarantee consistency
6691 even when you use @option{-m88100}, so that the code may be run on an
6692 MC88110 processor.  If you intend to run your code only on the
6693 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6694
6695 The extra code generated to guarantee consistency may affect the
6696 performance of your application.  If you know that you can safely
6697 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6698
6699 @item -msvr4
6700 @itemx -msvr3
6701 @opindex msvr4
6702 @opindex msvr3
6703 @cindex assembler syntax, 88k
6704 @cindex SVr4
6705 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6706 related to System V release 4 (SVr4).  This controls the following:
6707
6708 @enumerate
6709 @item
6710 Which variant of the assembler syntax to emit.
6711 @item
6712 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6713 that is used on System V release 4.
6714 @item
6715 @option{-msvr4} makes GCC issue additional declaration directives used in
6716 SVr4.
6717 @end enumerate
6718
6719 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6720 @option{-msvr3} is the default for all other m88k configurations.
6721
6722 @item -mversion-03.00
6723 @opindex mversion-03.00
6724 This option is obsolete, and is ignored.
6725 @c ??? which asm syntax better for GAS?  option there too?
6726
6727 @item -mno-check-zero-division
6728 @itemx -mcheck-zero-division
6729 @opindex mno-check-zero-division
6730 @opindex mcheck-zero-division
6731 @cindex zero division on 88k
6732 Do, or don't, generate code to guarantee that integer division by
6733 zero will be detected.  By default, detection is guaranteed.
6734
6735 Some models of the MC88100 processor fail to trap upon integer
6736 division by zero under certain conditions.  By default, when
6737 compiling code that might be run on such a processor, GCC
6738 generates code that explicitly checks for zero-valued divisors
6739 and traps with exception number 503 when one is detected.  Use of
6740 @option{-mno-check-zero-division} suppresses such checking for code
6741 generated to run on an MC88100 processor.
6742
6743 GCC assumes that the MC88110 processor correctly detects all instances
6744 of integer division by zero.  When @option{-m88110} is specified, no
6745 explicit checks for zero-valued divisors are generated, and both
6746 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6747 ignored.
6748
6749 @item -muse-div-instruction
6750 @opindex muse-div-instruction
6751 @cindex divide instruction, 88k
6752 Use the div instruction for signed integer division on the
6753 MC88100 processor.  By default, the div instruction is not used.
6754
6755 On the MC88100 processor the signed integer division instruction
6756 div) traps to the operating system on a negative operand.  The
6757 operating system transparently completes the operation, but at a
6758 large cost in execution time.  By default, when compiling code
6759 that might be run on an MC88100 processor, GCC emulates signed
6760 integer division using the unsigned integer division instruction
6761 divu), thereby avoiding the large penalty of a trap to the
6762 operating system.  Such emulation has its own, smaller, execution
6763 cost in both time and space.  To the extent that your code's
6764 important signed integer division operations are performed on two
6765 nonnegative operands, it may be desirable to use the div
6766 instruction directly.
6767
6768 On the MC88110 processor the div instruction (also known as the
6769 divs instruction) processes negative operands without trapping to
6770 the operating system.  When @option{-m88110} is specified,
6771 @option{-muse-div-instruction} is ignored, and the div instruction is used
6772 for signed integer division.
6773
6774 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6775 particular, the behavior of such a division with and without
6776 @option{-muse-div-instruction} may differ.
6777
6778 @item -mtrap-large-shift
6779 @itemx -mhandle-large-shift
6780 @opindex mtrap-large-shift
6781 @opindex mhandle-large-shift
6782 @cindex bit shift overflow (88k)
6783 @cindex large bit shifts (88k)
6784 Include code to detect bit-shifts of more than 31 bits; respectively,
6785 trap such shifts or emit code to handle them properly.  By default GCC
6786 makes no special provision for large bit shifts.
6787
6788 @item -mwarn-passed-structs
6789 @opindex mwarn-passed-structs
6790 @cindex structure passing (88k)
6791 Warn when a function passes a struct as an argument or result.
6792 Structure-passing conventions have changed during the evolution of the C
6793 language, and are often the source of portability problems.  By default,
6794 GCC issues no such warning.
6795 @end table
6796
6797 @c break page here to avoid unsightly interparagraph stretch.
6798 @c -zw, 2001-8-17
6799 @page
6800
6801 @node RS/6000 and PowerPC Options
6802 @subsection IBM RS/6000 and PowerPC Options
6803 @cindex RS/6000 and PowerPC Options
6804 @cindex IBM RS/6000 and PowerPC Options
6805
6806 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6807 @table @gcctabopt
6808 @item -mpower
6809 @itemx -mno-power
6810 @itemx -mpower2
6811 @itemx -mno-power2
6812 @itemx -mpowerpc
6813 @itemx -mno-powerpc
6814 @itemx -mpowerpc-gpopt
6815 @itemx -mno-powerpc-gpopt
6816 @itemx -mpowerpc-gfxopt
6817 @itemx -mno-powerpc-gfxopt
6818 @itemx -mpowerpc64
6819 @itemx -mno-powerpc64
6820 @opindex mpower
6821 @opindex mno-power
6822 @opindex mpower2
6823 @opindex mno-power2
6824 @opindex mpowerpc
6825 @opindex mno-powerpc
6826 @opindex mpowerpc-gpopt
6827 @opindex mno-powerpc-gpopt
6828 @opindex mpowerpc-gfxopt
6829 @opindex mno-powerpc-gfxopt
6830 @opindex mpowerpc64
6831 @opindex mno-powerpc64
6832 GCC supports two related instruction set architectures for the
6833 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6834 instructions supported by the @samp{rios} chip set used in the original
6835 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6836 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6837 the IBM 4xx microprocessors.
6838
6839 Neither architecture is a subset of the other.  However there is a
6840 large common subset of instructions supported by both.  An MQ
6841 register is included in processors supporting the POWER architecture.
6842
6843 You use these options to specify which instructions are available on the
6844 processor you are using.  The default value of these options is
6845 determined when configuring GCC@.  Specifying the
6846 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6847 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6848 rather than the options listed above.
6849
6850 The @option{-mpower} option allows GCC to generate instructions that
6851 are found only in the POWER architecture and to use the MQ register.
6852 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6853 to generate instructions that are present in the POWER2 architecture but
6854 not the original POWER architecture.
6855
6856 The @option{-mpowerpc} option allows GCC to generate instructions that
6857 are found only in the 32-bit subset of the PowerPC architecture.
6858 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6859 GCC to use the optional PowerPC architecture instructions in the
6860 General Purpose group, including floating-point square root.  Specifying
6861 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6862 use the optional PowerPC architecture instructions in the Graphics
6863 group, including floating-point select.
6864
6865 The @option{-mpowerpc64} option allows GCC to generate the additional
6866 64-bit instructions that are found in the full PowerPC64 architecture
6867 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6868 @option{-mno-powerpc64}.
6869
6870 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6871 will use only the instructions in the common subset of both
6872 architectures plus some special AIX common-mode calls, and will not use
6873 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6874 permits GCC to use any instruction from either architecture and to
6875 allow use of the MQ register; specify this for the Motorola MPC601.
6876
6877 @item -mnew-mnemonics
6878 @itemx -mold-mnemonics
6879 @opindex mnew-mnemonics
6880 @opindex mold-mnemonics
6881 Select which mnemonics to use in the generated assembler code.  With
6882 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6883 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6884 assembler mnemonics defined for the POWER architecture.  Instructions
6885 defined in only one architecture have only one mnemonic; GCC uses that
6886 mnemonic irrespective of which of these options is specified.
6887
6888 GCC defaults to the mnemonics appropriate for the architecture in
6889 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6890 value of these option.  Unless you are building a cross-compiler, you
6891 should normally not specify either @option{-mnew-mnemonics} or
6892 @option{-mold-mnemonics}, but should instead accept the default.
6893
6894 @item -mcpu=@var{cpu_type}
6895 @opindex mcpu
6896 Set architecture type, register usage, choice of mnemonics, and
6897 instruction scheduling parameters for machine type @var{cpu_type}.
6898 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6899 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6900 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6901 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6902 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6903 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6904
6905 @option{-mcpu=common} selects a completely generic processor.  Code
6906 generated under this option will run on any POWER or PowerPC processor.
6907 GCC will use only the instructions in the common subset of both
6908 architectures, and will not use the MQ register.  GCC assumes a generic
6909 processor model for scheduling purposes.
6910
6911 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6912 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6913 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6914 types, with an appropriate, generic processor model assumed for
6915 scheduling purposes.
6916
6917 The other options specify a specific processor.  Code generated under
6918 those options will run best on that processor, and may not run at all on
6919 others.
6920
6921 The @option{-mcpu} options automatically enable or disable other
6922 @option{-m} options as follows:
6923
6924 @table @samp
6925 @item common
6926 @option{-mno-power}, @option{-mno-powerpc}
6927
6928 @item power
6929 @itemx power2
6930 @itemx rios1
6931 @itemx rios2
6932 @itemx rsc
6933 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6934
6935 @item powerpc
6936 @itemx rs64a
6937 @itemx 602
6938 @itemx 603
6939 @itemx 603e
6940 @itemx 604
6941 @itemx 620
6942 @itemx 630
6943 @itemx 740
6944 @itemx 7400
6945 @itemx 7450
6946 @itemx 750
6947 @itemx 505
6948 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6949
6950 @item 601
6951 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6952
6953 @item 403
6954 @itemx 821
6955 @itemx 860
6956 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6957 @end table
6958
6959 @item -mtune=@var{cpu_type}
6960 @opindex mtune
6961 Set the instruction scheduling parameters for machine type
6962 @var{cpu_type}, but do not set the architecture type, register usage, or
6963 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6964 values for @var{cpu_type} are used for @option{-mtune} as for
6965 @option{-mcpu}.  If both are specified, the code generated will use the
6966 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6967 scheduling parameters set by @option{-mtune}.
6968
6969 @item -maltivec
6970 @itemx -mno-altivec
6971 @opindex maltivec
6972 @opindex mno-altivec
6973 These switches enable or disable the use of built-in functions that
6974 allow access to the AltiVec instruction set.  You may also need to set
6975 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6976 enhancements.
6977
6978 @item -mabi=spe
6979 @opindex mabi=spe
6980 Extend the current ABI with SPE ABI extensions.  This does not change
6981 the default ABI, instead it adds the SPE ABI extensions to the current
6982 ABI@.
6983
6984 @item -mabi=no-spe
6985 @opindex mabi=no-spe
6986 Disable Booke SPE ABI extensions for the current ABI.
6987
6988 @item -misel=@var{yes/no}
6989 @itemx -misel
6990 @opindex misel
6991 This switch enables or disables the generation of ISEL instructions.
6992
6993 @item -mspe=@var{yes/no}
6994 @itemx -mspe
6995 @opindex mspe
6996 This switch enables or disables the generation of SPE simd
6997 instructions.
6998
6999 @item -mfloat-gprs=@var{yes/no}
7000 @itemx -mfloat-gprs
7001 @opindex mfloat-gprs
7002 This switch enables or disables the generation of floating point
7003 operations on the general purpose registers for architectures that
7004 support it.  This option is currently only available on the MPC8540.
7005
7006 @item -mfull-toc
7007 @itemx -mno-fp-in-toc
7008 @itemx -mno-sum-in-toc
7009 @itemx -mminimal-toc
7010 @opindex mfull-toc
7011 @opindex mno-fp-in-toc
7012 @opindex mno-sum-in-toc
7013 @opindex mminimal-toc
7014 Modify generation of the TOC (Table Of Contents), which is created for
7015 every executable file.  The @option{-mfull-toc} option is selected by
7016 default.  In that case, GCC will allocate at least one TOC entry for
7017 each unique non-automatic variable reference in your program.  GCC
7018 will also place floating-point constants in the TOC@.  However, only
7019 16,384 entries are available in the TOC@.
7020
7021 If you receive a linker error message that saying you have overflowed
7022 the available TOC space, you can reduce the amount of TOC space used
7023 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7024 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7025 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7026 generate code to calculate the sum of an address and a constant at
7027 run-time instead of putting that sum into the TOC@.  You may specify one
7028 or both of these options.  Each causes GCC to produce very slightly
7029 slower and larger code at the expense of conserving TOC space.
7030
7031 If you still run out of space in the TOC even when you specify both of
7032 these options, specify @option{-mminimal-toc} instead.  This option causes
7033 GCC to make only one TOC entry for every file.  When you specify this
7034 option, GCC will produce code that is slower and larger but which
7035 uses extremely little TOC space.  You may wish to use this option
7036 only on files that contain less frequently executed code.
7037
7038 @item -maix64
7039 @itemx -maix32
7040 @opindex maix64
7041 @opindex maix32
7042 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7043 @code{long} type, and the infrastructure needed to support them.
7044 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7045 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7046 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7047
7048 @item -mxl-call
7049 @itemx -mno-xl-call
7050 @opindex mxl-call
7051 @opindex mno-xl-call
7052 On AIX, pass floating-point arguments to prototyped functions beyond the
7053 register save area (RSA) on the stack in addition to argument FPRs.  The
7054 AIX calling convention was extended but not initially documented to
7055 handle an obscure K&R C case of calling a function that takes the
7056 address of its arguments with fewer arguments than declared.  AIX XL
7057 compilers access floating point arguments which do not fit in the
7058 RSA from the stack when a subroutine is compiled without
7059 optimization.  Because always storing floating-point arguments on the
7060 stack is inefficient and rarely needed, this option is not enabled by
7061 default and only is necessary when calling subroutines compiled by AIX
7062 XL compilers without optimization.
7063
7064 @item -mpe
7065 @opindex mpe
7066 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7067 application written to use message passing with special startup code to
7068 enable the application to run.  The system must have PE installed in the
7069 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7070 must be overridden with the @option{-specs=} option to specify the
7071 appropriate directory location.  The Parallel Environment does not
7072 support threads, so the @option{-mpe} option and the @option{-pthread}
7073 option are incompatible.
7074
7075 @item -msoft-float
7076 @itemx -mhard-float
7077 @opindex msoft-float
7078 @opindex mhard-float
7079 Generate code that does not use (uses) the floating-point register set.
7080 Software floating point emulation is provided if you use the
7081 @option{-msoft-float} option, and pass the option to GCC when linking.
7082
7083 @item -mmultiple
7084 @itemx -mno-multiple
7085 @opindex mmultiple
7086 @opindex mno-multiple
7087 Generate code that uses (does not use) the load multiple word
7088 instructions and the store multiple word instructions.  These
7089 instructions are generated by default on POWER systems, and not
7090 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7091 endian PowerPC systems, since those instructions do not work when the
7092 processor is in little endian mode.  The exceptions are PPC740 and
7093 PPC750 which permit the instructions usage in little endian mode.
7094
7095 @item -mstring
7096 @itemx -mno-string
7097 @opindex mstring
7098 @opindex mno-string
7099 Generate code that uses (does not use) the load string instructions
7100 and the store string word instructions to save multiple registers and
7101 do small block moves.  These instructions are generated by default on
7102 POWER systems, and not generated on PowerPC systems.  Do not use
7103 @option{-mstring} on little endian PowerPC systems, since those
7104 instructions do not work when the processor is in little endian mode.
7105 The exceptions are PPC740 and PPC750 which permit the instructions
7106 usage in little endian mode.
7107
7108 @item -mupdate
7109 @itemx -mno-update
7110 @opindex mupdate
7111 @opindex mno-update
7112 Generate code that uses (does not use) the load or store instructions
7113 that update the base register to the address of the calculated memory
7114 location.  These instructions are generated by default.  If you use
7115 @option{-mno-update}, there is a small window between the time that the
7116 stack pointer is updated and the address of the previous frame is
7117 stored, which means code that walks the stack frame across interrupts or
7118 signals may get corrupted data.
7119
7120 @item -mfused-madd
7121 @itemx -mno-fused-madd
7122 @opindex mfused-madd
7123 @opindex mno-fused-madd
7124 Generate code that uses (does not use) the floating point multiply and
7125 accumulate instructions.  These instructions are generated by default if
7126 hardware floating is used.
7127
7128 @item -mno-bit-align
7129 @itemx -mbit-align
7130 @opindex mno-bit-align
7131 @opindex mbit-align
7132 On System V.4 and embedded PowerPC systems do not (do) force structures
7133 and unions that contain bit-fields to be aligned to the base type of the
7134 bit-field.
7135
7136 For example, by default a structure containing nothing but 8
7137 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7138 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7139 the structure would be aligned to a 1 byte boundary and be one byte in
7140 size.
7141
7142 @item -mno-strict-align
7143 @itemx -mstrict-align
7144 @opindex mno-strict-align
7145 @opindex mstrict-align
7146 On System V.4 and embedded PowerPC systems do not (do) assume that
7147 unaligned memory references will be handled by the system.
7148
7149 @item -mrelocatable
7150 @itemx -mno-relocatable
7151 @opindex mrelocatable
7152 @opindex mno-relocatable
7153 On embedded PowerPC systems generate code that allows (does not allow)
7154 the program to be relocated to a different address at runtime.  If you
7155 use @option{-mrelocatable} on any module, all objects linked together must
7156 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7157
7158 @item -mrelocatable-lib
7159 @itemx -mno-relocatable-lib
7160 @opindex mrelocatable-lib
7161 @opindex mno-relocatable-lib
7162 On embedded PowerPC systems generate code that allows (does not allow)
7163 the program to be relocated to a different address at runtime.  Modules
7164 compiled with @option{-mrelocatable-lib} can be linked with either modules
7165 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7166 with modules compiled with the @option{-mrelocatable} options.
7167
7168 @item -mno-toc
7169 @itemx -mtoc
7170 @opindex mno-toc
7171 @opindex mtoc
7172 On System V.4 and embedded PowerPC systems do not (do) assume that
7173 register 2 contains a pointer to a global area pointing to the addresses
7174 used in the program.
7175
7176 @item -mlittle
7177 @itemx -mlittle-endian
7178 @opindex mlittle
7179 @opindex mlittle-endian
7180 On System V.4 and embedded PowerPC systems compile code for the
7181 processor in little endian mode.  The @option{-mlittle-endian} option is
7182 the same as @option{-mlittle}.
7183
7184 @item -mbig
7185 @itemx -mbig-endian
7186 @opindex mbig
7187 @opindex mbig-endian
7188 On System V.4 and embedded PowerPC systems compile code for the
7189 processor in big endian mode.  The @option{-mbig-endian} option is
7190 the same as @option{-mbig}.
7191
7192 @item -mdynamic-no-pic
7193 @opindex mdynamic-no-pic
7194 On Darwin and Mac OS X systems, compile code so that it is not
7195 relocatable, but that its external references are relocatable.  The
7196 resulting code is suitable for applications, but not shared
7197 libraries.
7198
7199 @item -mcall-sysv
7200 @opindex mcall-sysv
7201 On System V.4 and embedded PowerPC systems compile code using calling
7202 conventions that adheres to the March 1995 draft of the System V
7203 Application Binary Interface, PowerPC processor supplement.  This is the
7204 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7205
7206 @item -mcall-sysv-eabi
7207 @opindex mcall-sysv-eabi
7208 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7209
7210 @item -mcall-sysv-noeabi
7211 @opindex mcall-sysv-noeabi
7212 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7213
7214 @item -mcall-aix
7215 @opindex mcall-aix
7216 On System V.4 and embedded PowerPC systems compile code using calling
7217 conventions that are similar to those used on AIX@.  This is the
7218 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7219
7220 @item -mcall-solaris
7221 @opindex mcall-solaris
7222 On System V.4 and embedded PowerPC systems compile code for the Solaris
7223 operating system.
7224
7225 @item -mcall-linux
7226 @opindex mcall-linux
7227 On System V.4 and embedded PowerPC systems compile code for the
7228 Linux-based GNU system.
7229
7230 @item -mcall-gnu
7231 @opindex mcall-gnu
7232 On System V.4 and embedded PowerPC systems compile code for the
7233 Hurd-based GNU system.
7234
7235 @item -mcall-netbsd
7236 @opindex mcall-netbsd
7237 On System V.4 and embedded PowerPC systems compile code for the
7238 NetBSD operating system.
7239
7240 @item -maix-struct-return
7241 @opindex maix-struct-return
7242 Return all structures in memory (as specified by the AIX ABI)@.
7243
7244 @item -msvr4-struct-return
7245 @opindex msvr4-struct-return
7246 Return structures smaller than 8 bytes in registers (as specified by the
7247 SVR4 ABI)@.
7248
7249 @item -mabi=altivec
7250 @opindex mabi=altivec
7251 Extend the current ABI with AltiVec ABI extensions.  This does not
7252 change the default ABI, instead it adds the AltiVec ABI extensions to
7253 the current ABI@.
7254
7255 @item -mabi=no-altivec
7256 @opindex mabi=no-altivec
7257 Disable AltiVec ABI extensions for the current ABI.
7258
7259 @item -mprototype
7260 @itemx -mno-prototype
7261 @opindex mprototype
7262 @opindex mno-prototype
7263 On System V.4 and embedded PowerPC systems assume that all calls to
7264 variable argument functions are properly prototyped.  Otherwise, the
7265 compiler must insert an instruction before every non prototyped call to
7266 set or clear bit 6 of the condition code register (@var{CR}) to
7267 indicate whether floating point values were passed in the floating point
7268 registers in case the function takes a variable arguments.  With
7269 @option{-mprototype}, only calls to prototyped variable argument functions
7270 will set or clear the bit.
7271
7272 @item -msim
7273 @opindex msim
7274 On embedded PowerPC systems, assume that the startup module is called
7275 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7276 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7277 configurations.
7278
7279 @item -mmvme
7280 @opindex mmvme
7281 On embedded PowerPC systems, assume that the startup module is called
7282 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7283 @file{libc.a}.
7284
7285 @item -mads
7286 @opindex mads
7287 On embedded PowerPC systems, assume that the startup module is called
7288 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7289 @file{libc.a}.
7290
7291 @item -myellowknife
7292 @opindex myellowknife
7293 On embedded PowerPC systems, assume that the startup module is called
7294 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7295 @file{libc.a}.
7296
7297 @item -mvxworks
7298 @opindex mvxworks
7299 On System V.4 and embedded PowerPC systems, specify that you are
7300 compiling for a VxWorks system.
7301
7302 @item -mwindiss
7303 @opindex mwindiss
7304 Specify that you are compiling for the WindISS simulation environment.
7305
7306 @item -memb
7307 @opindex memb
7308 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7309 header to indicate that @samp{eabi} extended relocations are used.
7310
7311 @item -meabi
7312 @itemx -mno-eabi
7313 @opindex meabi
7314 @opindex mno-eabi
7315 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7316 Embedded Applications Binary Interface (eabi) which is a set of
7317 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7318 means that the stack is aligned to an 8 byte boundary, a function
7319 @code{__eabi} is called to from @code{main} to set up the eabi
7320 environment, and the @option{-msdata} option can use both @code{r2} and
7321 @code{r13} to point to two separate small data areas.  Selecting
7322 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7323 do not call an initialization function from @code{main}, and the
7324 @option{-msdata} option will only use @code{r13} to point to a single
7325 small data area.  The @option{-meabi} option is on by default if you
7326 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7327
7328 @item -msdata=eabi
7329 @opindex msdata=eabi
7330 On System V.4 and embedded PowerPC systems, put small initialized
7331 @code{const} global and static data in the @samp{.sdata2} section, which
7332 is pointed to by register @code{r2}.  Put small initialized
7333 non-@code{const} global and static data in the @samp{.sdata} section,
7334 which is pointed to by register @code{r13}.  Put small uninitialized
7335 global and static data in the @samp{.sbss} section, which is adjacent to
7336 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7337 incompatible with the @option{-mrelocatable} option.  The
7338 @option{-msdata=eabi} option also sets the @option{-memb} option.
7339
7340 @item -msdata=sysv
7341 @opindex msdata=sysv
7342 On System V.4 and embedded PowerPC systems, put small global and static
7343 data in the @samp{.sdata} section, which is pointed to by register
7344 @code{r13}.  Put small uninitialized global and static data in the
7345 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7346 The @option{-msdata=sysv} option is incompatible with the
7347 @option{-mrelocatable} option.
7348
7349 @item -msdata=default
7350 @itemx -msdata
7351 @opindex msdata=default
7352 @opindex msdata
7353 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7354 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7355 same as @option{-msdata=sysv}.
7356
7357 @item -msdata-data
7358 @opindex msdata-data
7359 On System V.4 and embedded PowerPC systems, put small global and static
7360 data in the @samp{.sdata} section.  Put small uninitialized global and
7361 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7362 to address small data however.  This is the default behavior unless
7363 other @option{-msdata} options are used.
7364
7365 @item -msdata=none
7366 @itemx -mno-sdata
7367 @opindex msdata=none
7368 @opindex mno-sdata
7369 On embedded PowerPC systems, put all initialized global and static data
7370 in the @samp{.data} section, and all uninitialized data in the
7371 @samp{.bss} section.
7372
7373 @item -G @var{num}
7374 @opindex G
7375 @cindex smaller data references (PowerPC)
7376 @cindex .sdata/.sdata2 references (PowerPC)
7377 On embedded PowerPC systems, put global and static items less than or
7378 equal to @var{num} bytes into the small data or bss sections instead of
7379 the normal data or bss section.  By default, @var{num} is 8.  The
7380 @option{-G @var{num}} switch is also passed to the linker.
7381 All modules should be compiled with the same @option{-G @var{num}} value.
7382
7383 @item -mregnames
7384 @itemx -mno-regnames
7385 @opindex mregnames
7386 @opindex mno-regnames
7387 On System V.4 and embedded PowerPC systems do (do not) emit register
7388 names in the assembly language output using symbolic forms.
7389
7390 @item -mlongcall
7391 @itemx -mno-longcall
7392 @opindex mlongcall
7393 @opindex mno-longcall
7394 Default to making all function calls via pointers, so that functions
7395 which reside further than 64 megabytes (67,108,864 bytes) from the
7396 current location can be called.  This setting can be overridden by the
7397 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7398
7399 Some linkers are capable of detecting out-of-range calls and generating
7400 glue code on the fly.  On these systems, long calls are unnecessary and
7401 generate slower code.  As of this writing, the AIX linker can do this,
7402 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7403 to the GNU linker for 32-bit PowerPC systems as well.
7404
7405 In the future, we may cause GCC to ignore all longcall specifications
7406 when the linker is known to generate glue.
7407
7408 @item -pthread
7409 @opindex pthread
7410 Adds support for multithreading with the @dfn{pthreads} library.
7411 This option sets flags for both the preprocessor and linker.
7412
7413 @end table
7414
7415 @node Darwin Options
7416 @subsection Darwin Options
7417 @cindex Darwin options
7418 @table @gcctabopt
7419 @item -all_load    
7420 @opindex all_load   
7421 Loads all members of static archive libraries.
7422 See man ld(1) for more information.
7423
7424 @item -arch_errors_fatal
7425 @opindex arch_errors_fatal
7426 Cause the errors having to do with files that have the wrong architecture
7427 to be fatal.
7428
7429 @item -bind_at_load
7430 @opindex bind_at_load
7431 Causes the output file to be marked such that the dynamic linker will
7432 bind all undefined references when the file is loaded or launched.
7433
7434 @item -bundle     
7435 @opindex bundle
7436 Produce a Mach-o bundle format file.
7437 See man ld(1) for more information.
7438
7439 @item -bundle_loader @var{executable}
7440 @opindex bundle_loader
7441 This specifies the @var{executable} that will be loading the build
7442 output file being linked. See man ld(1) for more information.
7443
7444 @item -allowable_client  @var{client_name}
7445 @item -arch_only
7446
7447 @item -client_name       
7448 @item -compatibility_version
7449 @item -current_version    
7450 @item -dependency-file
7451 @item -dylib_file    
7452 @item -dylinker_install_name
7453 @item -dynamic
7454 @item -dynamiclib   
7455 @item -exported_symbols_list  
7456 @item -filelist
7457 @item -flat_namespace   
7458 @item -force_cpusubtype_ALL
7459 @item -force_flat_namespace   
7460 @item -headerpad_max_install_names
7461 @item -image_base  
7462 @item -init
7463 @item -install_name
7464 @item -keep_private_externs
7465 @item -multi_module
7466 @item -multiply_defined      
7467 @item -multiply_defined_unused      
7468 @item -noall_load  
7469 @item -nomultidefs
7470 @item -noprebind     
7471 @item -noseglinkedit
7472 @item -pagezero_size    
7473 @item -prebind
7474 @item -prebind_all_twolevel_modules
7475 @item -private_bundle
7476 @item -read_only_relocs
7477 @item -sectalign  
7478 @item -sectobjectsymbols    
7479 @item -whyload
7480 @item -seg1addr 
7481 @item -sectcreate
7482 @item -sectobjectsymbols
7483 @item -sectorder
7484 @item -seg_addr_table
7485 @item -seg_addr_table_filename
7486 @item -seglinkedit
7487 @item -segprot   
7488 @item -segs_read_only_addr
7489 @item -segs_read_write_addr
7490 @item -single_module   
7491 @item -static
7492 @item -sub_library
7493 @item -sub_umbrella 
7494 @item -twolevel_namespace
7495 @item -umbrella
7496 @item -undefined
7497 @item -unexported_symbols_list
7498 @item -weak_reference_mismatches
7499 @item -whatsloaded  
7500
7501 @opindex allowable_client
7502 @opindex arch_only    
7503 @opindex client_name
7504 @opindex compatibility_version
7505 @opindex current_version
7506 @opindex dependency-file
7507 @opindex dylib_file
7508 @opindex dylinker_install_name
7509 @opindex dynamic
7510 @opindex dynamiclib
7511 @opindex exported_symbols_list
7512 @opindex filelist  
7513 @opindex flat_namespace    
7514 @opindex force_cpusubtype_ALL
7515 @opindex force_flat_namespace
7516 @opindex headerpad_max_install_names
7517 @opindex image_base
7518 @opindex init     
7519 @opindex install_name
7520 @opindex keep_private_externs
7521 @opindex multi_module   
7522 @opindex multiply_defined
7523 @opindex multiply_defined_unused   
7524 @opindex noall_load  
7525 @opindex nomultidefs   
7526 @opindex noprebind
7527 @opindex noseglinkedit      
7528 @opindex pagezero_size
7529 @opindex prebind
7530 @opindex prebind_all_twolevel_modules
7531 @opindex private_bundle 
7532 @opindex read_only_relocs
7533 @opindex sectalign   
7534 @opindex sectobjectsymbols    
7535 @opindex whyload  
7536 @opindex seg1addr
7537 @opindex sectcreate       
7538 @opindex sectobjectsymbols 
7539 @opindex sectorder     
7540 @opindex seg_addr_table
7541 @opindex seg_addr_table_filename
7542 @opindex seglinkedit
7543 @opindex segprot
7544 @opindex segs_read_only_addr
7545 @opindex segs_read_write_addr
7546 @opindex single_module
7547 @opindex static
7548 @opindex sub_library
7549 @opindex sub_umbrella
7550 @opindex twolevel_namespace
7551 @opindex umbrella
7552 @opindex undefined
7553 @opindex unexported_symbols_list
7554 @opindex weak_reference_mismatches
7555 @opindex whatsloaded
7556
7557 This options are available for Darwin linker. Darwin linker man page
7558 describes them in detail.
7559 @end table
7560
7561
7562 @node RT Options
7563 @subsection IBM RT Options
7564 @cindex RT options
7565 @cindex IBM RT options
7566
7567 These @samp{-m} options are defined for the IBM RT PC:
7568
7569 @table @gcctabopt
7570 @item -min-line-mul
7571 @opindex min-line-mul
7572 Use an in-line code sequence for integer multiplies.  This is the
7573 default.
7574
7575 @item -mcall-lib-mul
7576 @opindex mcall-lib-mul
7577 Call @code{lmul$$} for integer multiples.
7578
7579 @item -mfull-fp-blocks
7580 @opindex mfull-fp-blocks
7581 Generate full-size floating point data blocks, including the minimum
7582 amount of scratch space recommended by IBM@.  This is the default.
7583
7584 @item -mminimum-fp-blocks
7585 @opindex mminimum-fp-blocks
7586 Do not include extra scratch space in floating point data blocks.  This
7587 results in smaller code, but slower execution, since scratch space must
7588 be allocated dynamically.
7589
7590 @cindex @file{stdarg.h} and RT PC
7591 @item -mfp-arg-in-fpregs
7592 @opindex mfp-arg-in-fpregs
7593 Use a calling sequence incompatible with the IBM calling convention in
7594 which floating point arguments are passed in floating point registers.
7595 Note that @code{stdarg.h} will not work with floating point operands
7596 if this option is specified.
7597
7598 @item -mfp-arg-in-gregs
7599 @opindex mfp-arg-in-gregs
7600 Use the normal calling convention for floating point arguments.  This is
7601 the default.
7602
7603 @item -mhc-struct-return
7604 @opindex mhc-struct-return
7605 Return structures of more than one word in memory, rather than in a
7606 register.  This provides compatibility with the MetaWare HighC (hc)
7607 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7608 with the Portable C Compiler (pcc).
7609
7610 @item -mnohc-struct-return
7611 @opindex mnohc-struct-return
7612 Return some structures of more than one word in registers, when
7613 convenient.  This is the default.  For compatibility with the
7614 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7615 option @option{-mhc-struct-return}.
7616 @end table
7617
7618 @node MIPS Options
7619 @subsection MIPS Options
7620 @cindex MIPS options
7621
7622 These @samp{-m} options are defined for the MIPS family of computers:
7623
7624 @table @gcctabopt
7625
7626 @item -march=@var{arch}
7627 @opindex march
7628 Generate code that will run on @var{arch}, which can be the name of a
7629 generic MIPS ISA, or the name of a particular processor.
7630 The ISA names are:
7631 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7632 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7633 The processor names are:
7634 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7635 @samp{m4k},
7636 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7637 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7638 @samp{orion},
7639 @samp{sb1},
7640 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7641 The special value @samp{from-abi} selects the
7642 most compatible architecture for the selected ABI (that is,
7643 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7644
7645 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7646 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7647 @samp{vr} may be written @samp{r}.
7648
7649 GCC defines two macros based on the value of this option.  The first
7650 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7651 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7652 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7653 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7654 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7655
7656 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7657 above.  In other words, it will have the full prefix and will not
7658 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7659 the macro names the resolved architecture (either @samp{"mips1"} or
7660 @samp{"mips3"}).  It names the default architecture when no
7661 @option{-march} option is given.
7662
7663 @item -mtune=@var{arch}
7664 @opindex mtune
7665 Optimize for @var{arch}.  Among other things, this option controls
7666 the way instructions are scheduled, and the perceived cost of arithmetic
7667 operations.  The list of @var{arch} values is the same as for
7668 @option{-march}.
7669
7670 When this option is not used, GCC will optimize for the processor
7671 specified by @option{-march}.  By using @option{-march} and
7672 @option{-mtune} together, it is possible to generate code that will
7673 run on a family of processors, but optimize the code for one
7674 particular member of that family.
7675
7676 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7677 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7678 @samp{-march} ones described above.
7679
7680 @item -mips1
7681 @opindex mips1
7682 Equivalent to @samp{-march=mips1}.
7683
7684 @item -mips2
7685 @opindex mips2
7686 Equivalent to @samp{-march=mips2}.
7687
7688 @item -mips3
7689 @opindex mips3
7690 Equivalent to @samp{-march=mips3}.
7691
7692 @item -mips4
7693 @opindex mips4
7694 Equivalent to @samp{-march=mips4}.
7695
7696 @item -mips32
7697 @opindex mips32
7698 Equivalent to @samp{-march=mips32}.
7699
7700 @item -mips32r2
7701 @opindex mips32r2
7702 Equivalent to @samp{-march=mips32r2}.
7703
7704 @item -mips64
7705 @opindex mips64
7706 Equivalent to @samp{-march=mips64}.
7707
7708 @item -mfused-madd
7709 @itemx -mno-fused-madd
7710 @opindex mfused-madd
7711 @opindex mno-fused-madd
7712 Generate code that uses (does not use) the floating point multiply and
7713 accumulate instructions, when they are available.  These instructions
7714 are generated by default if they are available, but this may be
7715 undesirable if the extra precision causes problems or on certain chips
7716 in the mode where denormals are rounded to zero where denormals
7717 generated by multiply and accumulate instructions cause exceptions
7718 anyway.
7719
7720 @item -mfp32
7721 @opindex mfp32
7722 Assume that floating point registers are 32 bits wide.
7723
7724 @item -mfp64
7725 @opindex mfp64
7726 Assume that floating point registers are 64 bits wide.
7727
7728 @item -mgp32
7729 @opindex mgp32
7730 Assume that general purpose registers are 32 bits wide.
7731
7732 @item -mgp64
7733 @opindex mgp64
7734 Assume that general purpose registers are 64 bits wide.
7735
7736 @item -mint64
7737 @opindex mint64
7738 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7739 explanation of the default, and the width of pointers.
7740
7741 @item -mlong64
7742 @opindex mlong64
7743 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7744 explanation of the default, and the width of pointers.
7745
7746 @item -mlong32
7747 @opindex mlong32
7748 Force long, int, and pointer types to be 32 bits wide.
7749
7750 The default size of ints, longs and pointers depends on the ABI@.  All
7751 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7752 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7753 are the same size as longs, or the same size as integer registers,
7754 whichever is smaller.
7755
7756 @item -mabi=32
7757 @itemx -mabi=o64
7758 @itemx -mabi=n32
7759 @itemx -mabi=64
7760 @itemx -mabi=eabi
7761 @itemx -mabi=meabi
7762 @opindex mabi=32
7763 @opindex mabi=o64
7764 @opindex mabi=n32
7765 @opindex mabi=64
7766 @opindex mabi=eabi
7767 @opindex mabi=meabi
7768 Generate code for the given ABI@.
7769
7770 Note that there are two embedded ABIs: @option{-mabi=eabi}
7771 selects the one defined by Cygnus while @option{-meabi=meabi}
7772 selects the one defined by MIPS@.  Both these ABIs have
7773 32-bit and 64-bit variants.  Normally, GCC will generate
7774 64-bit code when you select a 64-bit architecture, but you
7775 can use @option{-mgp32} to get 32-bit code instead.
7776
7777 @item -mabi-fake-default
7778 @opindex mabi-fake-default
7779 You don't want to know what this option does.  No, really.  I mean
7780 it.  Move on to the next option.
7781
7782 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7783 wants the default set of options to get the root of the multilib tree,
7784 and the shared library SONAMEs without any multilib-indicating
7785 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7786 we want to default to the N32 ABI, while still being binary-compatible
7787 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7788 binary-compatible means shared libraries should have the same SONAMEs,
7789 and libraries should live in the same location.  Having O32 libraries
7790 in a sub-directory named say @file{o32} is not acceptable.
7791
7792 So we trick GCC into believing that O32 is the default ABI, except
7793 that we override the default with some internal command-line
7794 processing magic.  Problem is, if we stopped at that, and you then
7795 created a multilib-aware package that used the output of @command{gcc
7796 -print-multi-lib} to decide which multilibs to build, and how, and
7797 you'd find yourself in an awkward situation when you found out that
7798 some of the options listed ended up mapping to the same multilib, and
7799 none of your libraries was actually built for the multilib that
7800 @option{-print-multi-lib} claims to be the default.  So we added this
7801 option that disables the default switcher, falling back to GCC's
7802 original notion of the default library.  Confused yet?
7803
7804 For short: don't ever use this option, unless you find it in the list
7805 of additional options to be used when building for multilibs, in the
7806 output of @option{gcc -print-multi-lib}.
7807
7808 @item -mmips-as
7809 @opindex mmips-as
7810 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7811 add normal debug information.  This is the default for all
7812 platforms except for the OSF/1 reference platform, using the OSF/rose
7813 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7814 switches are used, the @file{mips-tfile} program will encapsulate the
7815 stabs within MIPS ECOFF@.
7816
7817 @item -mgas
7818 @opindex mgas
7819 Generate code for the GNU assembler.  This is the default on the OSF/1
7820 reference platform, using the OSF/rose object format.  Also, this is
7821 the default if the configure option @option{--with-gnu-as} is used.
7822
7823 @item -msplit-addresses
7824 @itemx -mno-split-addresses
7825 @opindex msplit-addresses
7826 @opindex mno-split-addresses
7827 Generate code to load the high and low parts of address constants separately.
7828 This allows GCC to optimize away redundant loads of the high order
7829 bits of addresses.  This optimization requires GNU as and GNU ld.
7830 This optimization is enabled by default for some embedded targets where
7831 GNU as and GNU ld are standard.
7832
7833 @item -mrnames
7834 @itemx -mno-rnames
7835 @opindex mrnames
7836 @opindex mno-rnames
7837 The @option{-mrnames} switch says to output code using the MIPS software
7838 names for the registers, instead of the hardware names (ie, @var{a0}
7839 instead of @var{$4}).  The only known assembler that supports this option
7840 is the Algorithmics assembler.
7841
7842 @item -mgpopt
7843 @itemx -mno-gpopt
7844 @opindex mgpopt
7845 @opindex mno-gpopt
7846 The @option{-mgpopt} switch says to write all of the data declarations
7847 before the instructions in the text section, this allows the MIPS
7848 assembler to generate one word memory references instead of using two
7849 words for short global or static data items.  This is on by default if
7850 optimization is selected.
7851
7852 @item -mstats
7853 @itemx -mno-stats
7854 @opindex mstats
7855 @opindex mno-stats
7856 For each non-inline function processed, the @option{-mstats} switch
7857 causes the compiler to emit one line to the standard error file to
7858 print statistics about the program (number of registers saved, stack
7859 size, etc.).
7860
7861 @item -mmemcpy
7862 @itemx -mno-memcpy
7863 @opindex mmemcpy
7864 @opindex mno-memcpy
7865 The @option{-mmemcpy} switch makes all block moves call the appropriate
7866 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7867 generating inline code.
7868
7869 @item -mmips-tfile
7870 @itemx -mno-mips-tfile
7871 @opindex mmips-tfile
7872 @opindex mno-mips-tfile
7873 The @option{-mno-mips-tfile} switch causes the compiler not
7874 postprocess the object file with the @file{mips-tfile} program,
7875 after the MIPS assembler has generated it to add debug support.  If
7876 @file{mips-tfile} is not run, then no local variables will be
7877 available to the debugger.  In addition, @file{stage2} and
7878 @file{stage3} objects will have the temporary file names passed to the
7879 assembler embedded in the object file, which means the objects will
7880 not compare the same.  The @option{-mno-mips-tfile} switch should only
7881 be used when there are bugs in the @file{mips-tfile} program that
7882 prevents compilation.
7883
7884 @item -msoft-float
7885 @opindex msoft-float
7886 Generate output containing library calls for floating point.
7887 @strong{Warning:} the requisite libraries are not part of GCC@.
7888 Normally the facilities of the machine's usual C compiler are used, but
7889 this can't be done directly in cross-compilation.  You must make your
7890 own arrangements to provide suitable library functions for
7891 cross-compilation.
7892
7893 @item -mhard-float
7894 @opindex mhard-float
7895 Generate output containing floating point instructions.  This is the
7896 default if you use the unmodified sources.
7897
7898 @item -mabicalls
7899 @itemx -mno-abicalls
7900 @opindex mabicalls
7901 @opindex mno-abicalls
7902 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7903 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7904 position independent code.
7905
7906 @item -mlong-calls
7907 @itemx -mno-long-calls
7908 @opindex mlong-calls
7909 @opindex mno-long-calls
7910 Do all calls with the @samp{JALR} instruction, which requires
7911 loading up a function's address into a register before the call.
7912 You need to use this switch, if you call outside of the current
7913 512 megabyte segment to functions that are not through pointers.
7914
7915 @item -mhalf-pic
7916 @itemx -mno-half-pic
7917 @opindex mhalf-pic
7918 @opindex mno-half-pic
7919 Put pointers to extern references into the data section and load them
7920 up, rather than put the references in the text section.
7921
7922 @item -membedded-pic
7923 @itemx -mno-embedded-pic
7924 @opindex membedded-pic
7925 @opindex mno-embedded-pic
7926 Generate PIC code suitable for some embedded systems.  All calls are
7927 made using PC relative address, and all data is addressed using the $gp
7928 register.  No more than 65536 bytes of global data may be used.  This
7929 requires GNU as and GNU ld which do most of the work.  This currently
7930 only works on targets which use ECOFF; it does not work with ELF@.
7931
7932 @item -membedded-data
7933 @itemx -mno-embedded-data
7934 @opindex membedded-data
7935 @opindex mno-embedded-data
7936 Allocate variables to the read-only data section first if possible, then
7937 next in the small data section if possible, otherwise in data.  This gives
7938 slightly slower code than the default, but reduces the amount of RAM required
7939 when executing, and thus may be preferred for some embedded systems.
7940
7941 @item -muninit-const-in-rodata
7942 @itemx -mno-uninit-const-in-rodata
7943 @opindex muninit-const-in-rodata
7944 @opindex mno-uninit-const-in-rodata
7945 When used together with @option{-membedded-data}, it will always store uninitialized
7946 const variables in the read-only data section.
7947
7948 @item -msingle-float
7949 @itemx -mdouble-float
7950 @opindex msingle-float
7951 @opindex mdouble-float
7952 The @option{-msingle-float} switch tells gcc to assume that the floating
7953 point coprocessor only supports single precision operations, as on the
7954 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7955 double precision operations.  This is the default.
7956
7957 @item -mmad
7958 @itemx -mno-mad
7959 @opindex mmad
7960 @opindex mno-mad
7961 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7962 as on the @samp{r4650} chip.
7963
7964 @item -m4650
7965 @opindex m4650
7966 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7967 @option{-mcpu=r4650}.
7968
7969 @item -mips16
7970 @itemx -mno-mips16
7971 @opindex mips16
7972 @opindex mno-mips16
7973 Enable 16-bit instructions.
7974
7975 @item -mentry
7976 @opindex mentry
7977 Use the entry and exit pseudo ops.  This option can only be used with
7978 @option{-mips16}.
7979
7980 @item -EL
7981 @opindex EL
7982 Compile code for the processor in little endian mode.
7983 The requisite libraries are assumed to exist.
7984
7985 @item -EB
7986 @opindex EB
7987 Compile code for the processor in big endian mode.
7988 The requisite libraries are assumed to exist.
7989
7990 @item -G @var{num}
7991 @opindex G
7992 @cindex smaller data references (MIPS)
7993 @cindex gp-relative references (MIPS)
7994 Put global and static items less than or equal to @var{num} bytes into
7995 the small data or bss sections instead of the normal data or bss
7996 section.  This allows the assembler to emit one word memory reference
7997 instructions based on the global pointer (@var{gp} or @var{$28}),
7998 instead of the normal two words used.  By default, @var{num} is 8 when
7999 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
8000 @option{-G @var{num}} switch is also passed to the assembler and linker.
8001 All modules should be compiled with the same @option{-G @var{num}}
8002 value.
8003
8004 @item -nocpp
8005 @opindex nocpp
8006 Tell the MIPS assembler to not run its preprocessor over user
8007 assembler files (with a @samp{.s} suffix) when assembling them.
8008
8009 @item -mfix7000
8010 @opindex mfix7000
8011 Pass an option to gas which will cause nops to be inserted if
8012 the read of the destination register of an mfhi or mflo instruction
8013 occurs in the following two instructions.
8014
8015 @item -no-crt0
8016 @opindex no-crt0
8017 Do not include the default crt0.
8018
8019 @item -mflush-func=@var{func}
8020 @itemx -mno-flush-func
8021 @opindex mflush-func
8022 Specifies the function to call to flush the I and D caches, or to not
8023 call any such function.  If called, the function must take the same
8024 arguments as the common @code{_flush_func()}, that is, the address of the
8025 memory range for which the cache is being flushed, the size of the
8026 memory range, and the number 3 (to flush both caches).  The default
8027 depends on the target gcc was configured for, but commonly is either
8028 @samp{_flush_func} or @samp{__cpu_flush}.
8029
8030 @item -mbranch-likely
8031 @itemx -mno-branch-likely
8032 @opindex mbranch-likely
8033 @opindex mno-branch-likely
8034 Enable or disable use of Branch Likely instructions, regardless of the
8035 default for the selected architecture.  By default, Branch Likely
8036 instructions may be generated if they are supported by the selected
8037 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8038 and processors which implement those architectures; for those, Branch
8039 Likely instructions will not be generated by default because the MIPS32
8040 and MIPS64 architectures specifically deprecate their use.
8041 @end table
8042
8043 @node i386 and x86-64 Options
8044 @subsection Intel 386 and AMD x86-64 Options
8045 @cindex i386 Options
8046 @cindex x86-64 Options
8047 @cindex Intel 386 Options
8048 @cindex AMD x86-64 Options
8049
8050 These @samp{-m} options are defined for the i386 and x86-64 family of
8051 computers:
8052
8053 @table @gcctabopt
8054 @item -mtune=@var{cpu-type}
8055 @opindex mtune
8056 Tune to @var{cpu-type} everything applicable about the generated code, except
8057 for the ABI and the set of available instructions.  The choices for
8058 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8059 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8060 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8061 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8062 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8063 and @samp{c3-2}.
8064
8065 While picking a specific @var{cpu-type} will schedule things appropriately
8066 for that particular chip, the compiler will not generate any code that
8067 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8068 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8069 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8070 AMD chips as opposed to the Intel ones.
8071
8072 @item -march=@var{cpu-type}
8073 @opindex march
8074 Generate instructions for the machine type @var{cpu-type}.  The choices
8075 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8076 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8077
8078 @item -mcpu=@var{cpu-type}
8079 @opindex mcpu
8080 A deprecated synonym for @option{-mtune}.
8081
8082 @item -m386
8083 @itemx -m486
8084 @itemx -mpentium
8085 @itemx -mpentiumpro
8086 @opindex m386
8087 @opindex m486
8088 @opindex mpentium
8089 @opindex mpentiumpro
8090 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8091 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8092 These synonyms are deprecated.
8093
8094 @item -mfpmath=@var{unit}
8095 @opindex march
8096 generate floating point arithmetics for selected unit @var{unit}.  the choices
8097 for @var{unit} are:
8098
8099 @table @samp
8100 @item 387
8101 Use the standard 387 floating point coprocessor present majority of chips and
8102 emulated otherwise.  Code compiled with this option will run almost everywhere.
8103 The temporary results are computed in 80bit precision instead of precision
8104 specified by the type resulting in slightly different results compared to most
8105 of other chips. See @option{-ffloat-store} for more detailed description.
8106
8107 This is the default choice for i386 compiler.
8108
8109 @item sse
8110 Use scalar floating point instructions present in the SSE instruction set.
8111 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8112 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8113 instruction set supports only single precision arithmetics, thus the double and
8114 extended precision arithmetics is still done using 387.  Later version, present
8115 only in Pentium4 and the future AMD x86-64 chips supports double precision
8116 arithmetics too.
8117
8118 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8119 @option{-msse2} switches to enable SSE extensions and make this option
8120 effective.  For x86-64 compiler, these extensions are enabled by default.
8121
8122 The resulting code should be considerably faster in majority of cases and avoid
8123 the numerical instability problems of 387 code, but may break some existing
8124 code that expects temporaries to be 80bit.
8125
8126 This is the default choice for x86-64 compiler.
8127
8128 @item sse,387
8129 Attempt to utilize both instruction sets at once.  This effectively double the
8130 amount of available registers and on chips with separate execution units for
8131 387 and SSE the execution resources too.  Use this option with care, as it is
8132 still experimental, because gcc register allocator does not model separate
8133 functional units well resulting in instable performance.
8134 @end table
8135
8136 @item -masm=@var{dialect}
8137 @opindex masm=@var{dialect}
8138 Output asm instructions using selected @var{dialect}. Supported choices are
8139 @samp{intel} or @samp{att} (the default one).
8140
8141 @item -mieee-fp
8142 @itemx -mno-ieee-fp
8143 @opindex mieee-fp
8144 @opindex mno-ieee-fp
8145 Control whether or not the compiler uses IEEE floating point
8146 comparisons.  These handle correctly the case where the result of a
8147 comparison is unordered.
8148
8149 @item -msoft-float
8150 @opindex msoft-float
8151 Generate output containing library calls for floating point.
8152 @strong{Warning:} the requisite libraries are not part of GCC@.
8153 Normally the facilities of the machine's usual C compiler are used, but
8154 this can't be done directly in cross-compilation.  You must make your
8155 own arrangements to provide suitable library functions for
8156 cross-compilation.
8157
8158 On machines where a function returns floating point results in the 80387
8159 register stack, some floating point opcodes may be emitted even if
8160 @option{-msoft-float} is used.
8161
8162 @item -mno-fp-ret-in-387
8163 @opindex mno-fp-ret-in-387
8164 Do not use the FPU registers for return values of functions.
8165
8166 The usual calling convention has functions return values of types
8167 @code{float} and @code{double} in an FPU register, even if there
8168 is no FPU@.  The idea is that the operating system should emulate
8169 an FPU@.
8170
8171 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8172 in ordinary CPU registers instead.
8173
8174 @item -mno-fancy-math-387
8175 @opindex mno-fancy-math-387
8176 Some 387 emulators do not support the @code{sin}, @code{cos} and
8177 @code{sqrt} instructions for the 387.  Specify this option to avoid
8178 generating those instructions.  This option is the default on FreeBSD,
8179 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8180 indicates that the target cpu will always have an FPU and so the
8181 instruction will not need emulation.  As of revision 2.6.1, these
8182 instructions are not generated unless you also use the
8183 @option{-funsafe-math-optimizations} switch.
8184
8185 @item -malign-double
8186 @itemx -mno-align-double
8187 @opindex malign-double
8188 @opindex mno-align-double
8189 Control whether GCC aligns @code{double}, @code{long double}, and
8190 @code{long long} variables on a two word boundary or a one word
8191 boundary.  Aligning @code{double} variables on a two word boundary will
8192 produce code that runs somewhat faster on a @samp{Pentium} at the
8193 expense of more memory.
8194
8195 @strong{Warning:} if you use the @option{-malign-double} switch,
8196 structures containing the above types will be aligned differently than
8197 the published application binary interface specifications for the 386
8198 and will not be binary compatible with structures in code compiled
8199 without that switch.
8200
8201 @item -m128bit-long-double
8202 @opindex m128bit-long-double
8203 Control the size of @code{long double} type. i386 application binary interface
8204 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8205 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8206 impossible to reach with 12 byte long doubles in the array accesses.
8207
8208 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8209 structures and arrays containing @code{long double} will change their size as
8210 well as function calling convention for function taking @code{long double}
8211 will be modified.
8212
8213 @item -m96bit-long-double
8214 @opindex m96bit-long-double
8215 Set the size of @code{long double} to 96 bits as required by the i386
8216 application binary interface.  This is the default.
8217
8218 @item -msvr3-shlib
8219 @itemx -mno-svr3-shlib
8220 @opindex msvr3-shlib
8221 @opindex mno-svr3-shlib
8222 Control whether GCC places uninitialized local variables into the
8223 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8224 into @code{bss}.  These options are meaningful only on System V Release 3.
8225
8226 @item -mrtd
8227 @opindex mrtd
8228 Use a different function-calling convention, in which functions that
8229 take a fixed number of arguments return with the @code{ret} @var{num}
8230 instruction, which pops their arguments while returning.  This saves one
8231 instruction in the caller since there is no need to pop the arguments
8232 there.
8233
8234 You can specify that an individual function is called with this calling
8235 sequence with the function attribute @samp{stdcall}.  You can also
8236 override the @option{-mrtd} option by using the function attribute
8237 @samp{cdecl}.  @xref{Function Attributes}.
8238
8239 @strong{Warning:} this calling convention is incompatible with the one
8240 normally used on Unix, so you cannot use it if you need to call
8241 libraries compiled with the Unix compiler.
8242
8243 Also, you must provide function prototypes for all functions that
8244 take variable numbers of arguments (including @code{printf});
8245 otherwise incorrect code will be generated for calls to those
8246 functions.
8247
8248 In addition, seriously incorrect code will result if you call a
8249 function with too many arguments.  (Normally, extra arguments are
8250 harmlessly ignored.)
8251
8252 @item -mregparm=@var{num}
8253 @opindex mregparm
8254 Control how many registers are used to pass integer arguments.  By
8255 default, no registers are used to pass arguments, and at most 3
8256 registers can be used.  You can control this behavior for a specific
8257 function by using the function attribute @samp{regparm}.
8258 @xref{Function Attributes}.
8259
8260 @strong{Warning:} if you use this switch, and
8261 @var{num} is nonzero, then you must build all modules with the same
8262 value, including any libraries.  This includes the system libraries and
8263 startup modules.
8264
8265 @item -mpreferred-stack-boundary=@var{num}
8266 @opindex mpreferred-stack-boundary
8267 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8268 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8269 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8270 size (@option{-Os}), in which case the default is the minimum correct
8271 alignment (4 bytes for x86, and 8 bytes for x86-64).
8272
8273 On Pentium and PentiumPro, @code{double} and @code{long double} values
8274 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8275 suffer significant run time performance penalties.  On Pentium III, the
8276 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8277 penalties if it is not 16 byte aligned.
8278
8279 To ensure proper alignment of this values on the stack, the stack boundary
8280 must be as aligned as that required by any value stored on the stack.
8281 Further, every function must be generated such that it keeps the stack
8282 aligned.  Thus calling a function compiled with a higher preferred
8283 stack boundary from a function compiled with a lower preferred stack
8284 boundary will most likely misalign the stack.  It is recommended that
8285 libraries that use callbacks always use the default setting.
8286
8287 This extra alignment does consume extra stack space, and generally
8288 increases code size.  Code that is sensitive to stack space usage, such
8289 as embedded systems and operating system kernels, may want to reduce the
8290 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8291
8292 @item -mmmx
8293 @itemx -mno-mmx
8294 @item -msse
8295 @itemx -mno-sse
8296 @item -msse2
8297 @itemx -mno-sse2
8298 @item -m3dnow
8299 @itemx -mno-3dnow
8300 @opindex mmmx
8301 @opindex mno-mmx
8302 @opindex msse
8303 @opindex mno-sse
8304 @opindex m3dnow
8305 @opindex mno-3dnow
8306 These switches enable or disable the use of built-in functions that allow
8307 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8308
8309 @xref{X86 Built-in Functions}, for details of the functions enabled
8310 and disabled by these switches.
8311
8312 To have SSE/SSE2 instructions generated automatically from floating-point
8313 code, see @option{-mfpmath=sse}.
8314
8315 @item -mpush-args
8316 @itemx -mno-push-args
8317 @opindex mpush-args
8318 @opindex mno-push-args
8319 Use PUSH operations to store outgoing parameters.  This method is shorter
8320 and usually equally fast as method using SUB/MOV operations and is enabled
8321 by default.  In some cases disabling it may improve performance because of
8322 improved scheduling and reduced dependencies.
8323
8324 @item -maccumulate-outgoing-args
8325 @opindex maccumulate-outgoing-args
8326 If enabled, the maximum amount of space required for outgoing arguments will be
8327 computed in the function prologue.  This is faster on most modern CPUs
8328 because of reduced dependencies, improved scheduling and reduced stack usage
8329 when preferred stack boundary is not equal to 2.  The drawback is a notable
8330 increase in code size.  This switch implies @option{-mno-push-args}.
8331
8332 @item -mthreads
8333 @opindex mthreads
8334 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8335 on thread-safe exception handling must compile and link all code with the
8336 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8337 @option{-D_MT}; when linking, it links in a special thread helper library
8338 @option{-lmingwthrd} which cleans up per thread exception handling data.
8339
8340 @item -mno-align-stringops
8341 @opindex mno-align-stringops
8342 Do not align destination of inlined string operations.  This switch reduces
8343 code size and improves performance in case the destination is already aligned,
8344 but gcc don't know about it.
8345
8346 @item -minline-all-stringops
8347 @opindex minline-all-stringops
8348 By default GCC inlines string operations only when destination is known to be
8349 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8350 size, but may improve performance of code that depends on fast memcpy, strlen
8351 and memset for short lengths.
8352
8353 @item -momit-leaf-frame-pointer
8354 @opindex momit-leaf-frame-pointer
8355 Don't keep the frame pointer in a register for leaf functions.  This
8356 avoids the instructions to save, set up and restore frame pointers and
8357 makes an extra register available in leaf functions.  The option
8358 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8359 which might make debugging harder.
8360 @end table
8361
8362 These @samp{-m} switches are supported in addition to the above
8363 on AMD x86-64 processors in 64-bit environments.
8364
8365 @table @gcctabopt
8366 @item -m32
8367 @itemx -m64
8368 @opindex m32
8369 @opindex m64
8370 Generate code for a 32-bit or 64-bit environment.
8371 The 32-bit environment sets int, long and pointer to 32 bits and
8372 generates code that runs on any i386 system.
8373 The 64-bit environment sets int to 32 bits and long and pointer
8374 to 64 bits and generates code for AMD's x86-64 architecture.
8375
8376 @item -mno-red-zone
8377 @opindex no-red-zone
8378 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8379 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8380 stack pointer that will not be modified by signal or interrupt handlers
8381 and therefore can be used for temporary data without adjusting the stack
8382 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8383
8384 @item -mcmodel=small
8385 @opindex mcmodel=small
8386 Generate code for the small code model: the program and its symbols must
8387 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8388 Programs can be statically or dynamically linked.  This is the default
8389 code model.
8390
8391 @item -mcmodel=kernel
8392 @opindex mcmodel=kernel
8393 Generate code for the kernel code model.  The kernel runs in the
8394 negative 2 GB of the address space.
8395 This model has to be used for Linux kernel code.
8396
8397 @item -mcmodel=medium
8398 @opindex mcmodel=medium
8399 Generate code for the medium model: The program is linked in the lower 2
8400 GB of the address space but symbols can be located anywhere in the
8401 address space.  Programs can be statically or dynamically linked, but
8402 building of shared libraries are not supported with the medium model.
8403
8404 @item -mcmodel=large
8405 @opindex mcmodel=large
8406 Generate code for the large model: This model makes no assumptions
8407 about addresses and sizes of sections.  Currently GCC does not implement
8408 this model.
8409 @end table
8410
8411 @node HPPA Options
8412 @subsection HPPA Options
8413 @cindex HPPA Options
8414
8415 These @samp{-m} options are defined for the HPPA family of computers:
8416
8417 @table @gcctabopt
8418 @item -march=@var{architecture-type}
8419 @opindex march
8420 Generate code for the specified architecture.  The choices for
8421 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8422 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8423 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8424 architecture option for your machine.  Code compiled for lower numbered
8425 architectures will run on higher numbered architectures, but not the
8426 other way around.
8427
8428 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8429 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8430 support.
8431
8432 @item -mpa-risc-1-0
8433 @itemx -mpa-risc-1-1
8434 @itemx -mpa-risc-2-0
8435 @opindex mpa-risc-1-0
8436 @opindex mpa-risc-1-1
8437 @opindex mpa-risc-2-0
8438 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8439
8440 @item -mbig-switch
8441 @opindex mbig-switch
8442 Generate code suitable for big switch tables.  Use this option only if
8443 the assembler/linker complain about out of range branches within a switch
8444 table.
8445
8446 @item -mjump-in-delay
8447 @opindex mjump-in-delay
8448 Fill delay slots of function calls with unconditional jump instructions
8449 by modifying the return pointer for the function call to be the target
8450 of the conditional jump.
8451
8452 @item -mdisable-fpregs
8453 @opindex mdisable-fpregs
8454 Prevent floating point registers from being used in any manner.  This is
8455 necessary for compiling kernels which perform lazy context switching of
8456 floating point registers.  If you use this option and attempt to perform
8457 floating point operations, the compiler will abort.
8458
8459 @item -mdisable-indexing
8460 @opindex mdisable-indexing
8461 Prevent the compiler from using indexing address modes.  This avoids some
8462 rather obscure problems when compiling MIG generated code under MACH@.
8463
8464 @item -mno-space-regs
8465 @opindex mno-space-regs
8466 Generate code that assumes the target has no space registers.  This allows
8467 GCC to generate faster indirect calls and use unscaled index address modes.
8468
8469 Such code is suitable for level 0 PA systems and kernels.
8470
8471 @item -mfast-indirect-calls
8472 @opindex mfast-indirect-calls
8473 Generate code that assumes calls never cross space boundaries.  This
8474 allows GCC to emit code which performs faster indirect calls.
8475
8476 This option will not work in the presence of shared libraries or nested
8477 functions.
8478
8479 @item -mlong-load-store
8480 @opindex mlong-load-store
8481 Generate 3-instruction load and store sequences as sometimes required by
8482 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8483 the HP compilers.
8484
8485 @item -mportable-runtime
8486 @opindex mportable-runtime
8487 Use the portable calling conventions proposed by HP for ELF systems.
8488
8489 @item -mgas
8490 @opindex mgas
8491 Enable the use of assembler directives only GAS understands.
8492
8493 @item -mschedule=@var{cpu-type}
8494 @opindex mschedule
8495 Schedule code according to the constraints for the machine type
8496 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8497 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8498 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8499 proper scheduling option for your machine.  The default scheduling is
8500 @samp{8000}.
8501
8502 @item -mlinker-opt
8503 @opindex mlinker-opt
8504 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8505 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8506 linkers in which they give bogus error messages when linking some programs.
8507
8508 @item -msoft-float
8509 @opindex msoft-float
8510 Generate output containing library calls for floating point.
8511 @strong{Warning:} the requisite libraries are not available for all HPPA
8512 targets.  Normally the facilities of the machine's usual C compiler are
8513 used, but this cannot be done directly in cross-compilation.  You must make
8514 your own arrangements to provide suitable library functions for
8515 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8516 does provide software floating point support.
8517
8518 @option{-msoft-float} changes the calling convention in the output file;
8519 therefore, it is only useful if you compile @emph{all} of a program with
8520 this option.  In particular, you need to compile @file{libgcc.a}, the
8521 library that comes with GCC, with @option{-msoft-float} in order for
8522 this to work.
8523
8524 @item -msio
8525 @opindex msio
8526 Generate the predefine, @code{_SIO}, for server IO.  The default is
8527 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8528 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8529 options are available under HP-UX and HI-UX.
8530
8531 @item -mgnu-ld
8532 @opindex gnu-ld
8533 Use GNU ld specific options.  This passes @option{-shared} to ld when
8534 building a shared library.  It is the default when GCC is configured,
8535 explicitly or implicitly, with the GNU linker.  This option does not
8536 have any affect on which ld is called, it only changes what parameters
8537 are passed to that ld.  The ld that is called is determined by the
8538 @option{--with-ld} configure option, gcc's program search path, and
8539 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8540 using @samp{which `gcc -print-prog-name=ld`}.
8541
8542 @item -mhp-ld
8543 @opindex hp-ld
8544 Use HP ld specific options.  This passes @option{-b} to ld when building
8545 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8546 links.  It is the default when GCC is configured, explicitly or
8547 implicitly, with the HP linker.  This option does not have any affect on
8548 which ld is called, it only changes what parameters are passed to that
8549 ld.  The ld that is called is determined by the @option{--with-ld}
8550 configure option, gcc's program search path, and finally by the user's
8551 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8552 `gcc -print-prog-name=ld`}.
8553
8554 @item -mlong-calls
8555 @opindex mno-long-calls
8556 Generate code that uses long call sequences.  This ensures that a call
8557 is always able to reach linker generated stubs.  The default is to generate
8558 long calls only when the distance from the call site to the beginning
8559 of the function or translation unit, as the case may be, exceeds a
8560 predefined limit set by the branch type being used.  The limits for
8561 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8562 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8563 240,000 bytes.
8564
8565 Distances are measured from the beginning of functions when using the
8566 @option{-ffunction-sections} option, or when using the @option{-mgas}
8567 and @option{-mno-portable-runtime} options together under HP-UX with
8568 the SOM linker.
8569
8570 It is normally not desirable to use this option as it will degrade
8571 performance.  However, it may be useful in large applications,
8572 particularly when partial linking is used to build the application.
8573
8574 The types of long calls used depends on the capabilities of the
8575 assembler and linker, and the type of code being generated.  The
8576 impact on systems that support long absolute calls, and long pic
8577 symbol-difference or pc-relative calls should be relatively small.
8578 However, an indirect call is used on 32-bit ELF systems in pic code
8579 and it is quite long.
8580
8581 @end table
8582
8583 @node Intel 960 Options
8584 @subsection Intel 960 Options
8585
8586 These @samp{-m} options are defined for the Intel 960 implementations:
8587
8588 @table @gcctabopt
8589 @item -m@var{cpu-type}
8590 @opindex mka
8591 @opindex mkb
8592 @opindex mmc
8593 @opindex mca
8594 @opindex mcf
8595 @opindex msa
8596 @opindex msb
8597 Assume the defaults for the machine type @var{cpu-type} for some of
8598 the other options, including instruction scheduling, floating point
8599 support, and addressing modes.  The choices for @var{cpu-type} are
8600 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8601 @samp{sa}, and @samp{sb}.
8602 The default is
8603 @samp{kb}.
8604
8605 @item -mnumerics
8606 @itemx -msoft-float
8607 @opindex mnumerics
8608 @opindex msoft-float
8609 The @option{-mnumerics} option indicates that the processor does support
8610 floating-point instructions.  The @option{-msoft-float} option indicates
8611 that floating-point support should not be assumed.
8612
8613 @item -mleaf-procedures
8614 @itemx -mno-leaf-procedures
8615 @opindex mleaf-procedures
8616 @opindex mno-leaf-procedures
8617 Do (or do not) attempt to alter leaf procedures to be callable with the
8618 @code{bal} instruction as well as @code{call}.  This will result in more
8619 efficient code for explicit calls when the @code{bal} instruction can be
8620 substituted by the assembler or linker, but less efficient code in other
8621 cases, such as calls via function pointers, or using a linker that doesn't
8622 support this optimization.
8623
8624 @item -mtail-call
8625 @itemx -mno-tail-call
8626 @opindex mtail-call
8627 @opindex mno-tail-call
8628 Do (or do not) make additional attempts (beyond those of the
8629 machine-independent portions of the compiler) to optimize tail-recursive
8630 calls into branches.  You may not want to do this because the detection of
8631 cases where this is not valid is not totally complete.  The default is
8632 @option{-mno-tail-call}.
8633
8634 @item -mcomplex-addr
8635 @itemx -mno-complex-addr
8636 @opindex mcomplex-addr
8637 @opindex mno-complex-addr
8638 Assume (or do not assume) that the use of a complex addressing mode is a
8639 win on this implementation of the i960.  Complex addressing modes may not
8640 be worthwhile on the K-series, but they definitely are on the C-series.
8641 The default is currently @option{-mcomplex-addr} for all processors except
8642 the CB and CC@.
8643
8644 @item -mcode-align
8645 @itemx -mno-code-align
8646 @opindex mcode-align
8647 @opindex mno-code-align
8648 Align code to 8-byte boundaries for faster fetching (or don't bother).
8649 Currently turned on by default for C-series implementations only.
8650
8651 @ignore
8652 @item -mclean-linkage
8653 @itemx -mno-clean-linkage
8654 @opindex mclean-linkage
8655 @opindex mno-clean-linkage
8656 These options are not fully implemented.
8657 @end ignore
8658
8659 @item -mic-compat
8660 @itemx -mic2.0-compat
8661 @itemx -mic3.0-compat
8662 @opindex mic-compat
8663 @opindex mic2.0-compat
8664 @opindex mic3.0-compat
8665 Enable compatibility with iC960 v2.0 or v3.0.
8666
8667 @item -masm-compat
8668 @itemx -mintel-asm
8669 @opindex masm-compat
8670 @opindex mintel-asm
8671 Enable compatibility with the iC960 assembler.
8672
8673 @item -mstrict-align
8674 @itemx -mno-strict-align
8675 @opindex mstrict-align
8676 @opindex mno-strict-align
8677 Do not permit (do permit) unaligned accesses.
8678
8679 @item -mold-align
8680 @opindex mold-align
8681 Enable structure-alignment compatibility with Intel's gcc release version
8682 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8683
8684 @item -mlong-double-64
8685 @opindex mlong-double-64
8686 Implement type @samp{long double} as 64-bit floating point numbers.
8687 Without the option @samp{long double} is implemented by 80-bit
8688 floating point numbers.  The only reason we have it because there is
8689 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8690 is only useful for people using soft-float targets.  Otherwise, we
8691 should recommend against use of it.
8692
8693 @end table
8694
8695 @node DEC Alpha Options
8696 @subsection DEC Alpha Options
8697
8698 These @samp{-m} options are defined for the DEC Alpha implementations:
8699
8700 @table @gcctabopt
8701 @item -mno-soft-float
8702 @itemx -msoft-float
8703 @opindex mno-soft-float
8704 @opindex msoft-float
8705 Use (do not use) the hardware floating-point instructions for
8706 floating-point operations.  When @option{-msoft-float} is specified,
8707 functions in @file{libgcc.a} will be used to perform floating-point
8708 operations.  Unless they are replaced by routines that emulate the
8709 floating-point operations, or compiled in such a way as to call such
8710 emulations routines, these routines will issue floating-point
8711 operations.   If you are compiling for an Alpha without floating-point
8712 operations, you must ensure that the library is built so as not to call
8713 them.
8714
8715 Note that Alpha implementations without floating-point operations are
8716 required to have floating-point registers.
8717
8718 @item -mfp-reg
8719 @itemx -mno-fp-regs
8720 @opindex mfp-reg
8721 @opindex mno-fp-regs
8722 Generate code that uses (does not use) the floating-point register set.
8723 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8724 register set is not used, floating point operands are passed in integer
8725 registers as if they were integers and floating-point results are passed
8726 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8727 so any function with a floating-point argument or return value called by code
8728 compiled with @option{-mno-fp-regs} must also be compiled with that
8729 option.
8730
8731 A typical use of this option is building a kernel that does not use,
8732 and hence need not save and restore, any floating-point registers.
8733
8734 @item -mieee
8735 @opindex mieee
8736 The Alpha architecture implements floating-point hardware optimized for
8737 maximum performance.  It is mostly compliant with the IEEE floating
8738 point standard.  However, for full compliance, software assistance is
8739 required.  This option generates code fully IEEE compliant code
8740 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8741 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8742 defined during compilation.  The resulting code is less efficient but is
8743 able to correctly support denormalized numbers and exceptional IEEE
8744 values such as not-a-number and plus/minus infinity.  Other Alpha
8745 compilers call this option @option{-ieee_with_no_inexact}.
8746
8747 @item -mieee-with-inexact
8748 @opindex mieee-with-inexact
8749 This is like @option{-mieee} except the generated code also maintains
8750 the IEEE @var{inexact-flag}.  Turning on this option causes the
8751 generated code to implement fully-compliant IEEE math.  In addition to
8752 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8753 macro.  On some Alpha implementations the resulting code may execute
8754 significantly slower than the code generated by default.  Since there is
8755 very little code that depends on the @var{inexact-flag}, you should
8756 normally not specify this option.  Other Alpha compilers call this
8757 option @option{-ieee_with_inexact}.
8758
8759 @item -mfp-trap-mode=@var{trap-mode}
8760 @opindex mfp-trap-mode
8761 This option controls what floating-point related traps are enabled.
8762 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8763 The trap mode can be set to one of four values:
8764
8765 @table @samp
8766 @item n
8767 This is the default (normal) setting.  The only traps that are enabled
8768 are the ones that cannot be disabled in software (e.g., division by zero
8769 trap).
8770
8771 @item u
8772 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8773 as well.
8774
8775 @item su
8776 Like @samp{su}, but the instructions are marked to be safe for software
8777 completion (see Alpha architecture manual for details).
8778
8779 @item sui
8780 Like @samp{su}, but inexact traps are enabled as well.
8781 @end table
8782
8783 @item -mfp-rounding-mode=@var{rounding-mode}
8784 @opindex mfp-rounding-mode
8785 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8786 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8787 of:
8788
8789 @table @samp
8790 @item n
8791 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8792 the nearest machine number or towards the even machine number in case
8793 of a tie.
8794
8795 @item m
8796 Round towards minus infinity.
8797
8798 @item c
8799 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8800
8801 @item d
8802 Dynamic rounding mode.  A field in the floating point control register
8803 (@var{fpcr}, see Alpha architecture reference manual) controls the
8804 rounding mode in effect.  The C library initializes this register for
8805 rounding towards plus infinity.  Thus, unless your program modifies the
8806 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8807 @end table
8808
8809 @item -mtrap-precision=@var{trap-precision}
8810 @opindex mtrap-precision
8811 In the Alpha architecture, floating point traps are imprecise.  This
8812 means without software assistance it is impossible to recover from a
8813 floating trap and program execution normally needs to be terminated.
8814 GCC can generate code that can assist operating system trap handlers
8815 in determining the exact location that caused a floating point trap.
8816 Depending on the requirements of an application, different levels of
8817 precisions can be selected:
8818
8819 @table @samp
8820 @item p
8821 Program precision.  This option is the default and means a trap handler
8822 can only identify which program caused a floating point exception.
8823
8824 @item f
8825 Function precision.  The trap handler can determine the function that
8826 caused a floating point exception.
8827
8828 @item i
8829 Instruction precision.  The trap handler can determine the exact
8830 instruction that caused a floating point exception.
8831 @end table
8832
8833 Other Alpha compilers provide the equivalent options called
8834 @option{-scope_safe} and @option{-resumption_safe}.
8835
8836 @item -mieee-conformant
8837 @opindex mieee-conformant
8838 This option marks the generated code as IEEE conformant.  You must not
8839 use this option unless you also specify @option{-mtrap-precision=i} and either
8840 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8841 is to emit the line @samp{.eflag 48} in the function prologue of the
8842 generated assembly file.  Under DEC Unix, this has the effect that
8843 IEEE-conformant math library routines will be linked in.
8844
8845 @item -mbuild-constants
8846 @opindex mbuild-constants
8847 Normally GCC examines a 32- or 64-bit integer constant to
8848 see if it can construct it from smaller constants in two or three
8849 instructions.  If it cannot, it will output the constant as a literal and
8850 generate code to load it from the data segment at runtime.
8851
8852 Use this option to require GCC to construct @emph{all} integer constants
8853 using code, even if it takes more instructions (the maximum is six).
8854
8855 You would typically use this option to build a shared library dynamic
8856 loader.  Itself a shared library, it must relocate itself in memory
8857 before it can find the variables and constants in its own data segment.
8858
8859 @item -malpha-as
8860 @itemx -mgas
8861 @opindex malpha-as
8862 @opindex mgas
8863 Select whether to generate code to be assembled by the vendor-supplied
8864 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8865
8866 @item -mbwx
8867 @itemx -mno-bwx
8868 @itemx -mcix
8869 @itemx -mno-cix
8870 @itemx -mfix
8871 @itemx -mno-fix
8872 @itemx -mmax
8873 @itemx -mno-max
8874 @opindex mbwx
8875 @opindex mno-bwx
8876 @opindex mcix
8877 @opindex mno-cix
8878 @opindex mfix
8879 @opindex mno-fix
8880 @opindex mmax
8881 @opindex mno-max
8882 Indicate whether GCC should generate code to use the optional BWX,
8883 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8884 sets supported by the CPU type specified via @option{-mcpu=} option or that
8885 of the CPU on which GCC was built if none was specified.
8886
8887 @item -mfloat-vax
8888 @itemx -mfloat-ieee
8889 @opindex mfloat-vax
8890 @opindex mfloat-ieee
8891 Generate code that uses (does not use) VAX F and G floating point
8892 arithmetic instead of IEEE single and double precision.
8893
8894 @item -mexplicit-relocs
8895 @itemx -mno-explicit-relocs
8896 @opindex mexplicit-relocs
8897 @opindex mno-explicit-relocs
8898 Older Alpha assemblers provided no way to generate symbol relocations
8899 except via assembler macros.  Use of these macros does not allow
8900 optimal instruction scheduling.  GNU binutils as of version 2.12
8901 supports a new syntax that allows the compiler to explicitly mark
8902 which relocations should apply to which instructions.  This option
8903 is mostly useful for debugging, as GCC detects the capabilities of
8904 the assembler when it is built and sets the default accordingly.
8905
8906 @item -msmall-data
8907 @itemx -mlarge-data
8908 @opindex msmall-data
8909 @opindex mlarge-data
8910 When @option{-mexplicit-relocs} is in effect, static data is
8911 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8912 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8913 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8914 16-bit relocations off of the @code{$gp} register.  This limits the
8915 size of the small data area to 64KB, but allows the variables to be
8916 directly accessed via a single instruction.
8917
8918 The default is @option{-mlarge-data}.  With this option the data area
8919 is limited to just below 2GB.  Programs that require more than 2GB of
8920 data must use @code{malloc} or @code{mmap} to allocate the data in the
8921 heap instead of in the program's data segment.
8922
8923 When generating code for shared libraries, @option{-fpic} implies
8924 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8925
8926 @item -msmall-text
8927 @itemx -mlarge-text
8928 @opindex msmall-text
8929 @opindex mlarge-text
8930 When @option{-msmall-text} is used, the compiler assumes that the
8931 code of the entire program (or shared library) fits in 4MB, and is
8932 thus reachable with a branch instruction.  When @option{-msmall-data}
8933 is used, the compiler can assume that all local symbols share the
8934 same @code{$gp} value, and thus reduce the number of instructions
8935 required for a function call from 4 to 1.
8936
8937 The default is @option{-mlarge-text}.
8938
8939 @item -mcpu=@var{cpu_type}
8940 @opindex mcpu
8941 Set the instruction set and instruction scheduling parameters for
8942 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8943 style name or the corresponding chip number.  GCC supports scheduling
8944 parameters for the EV4, EV5 and EV6 family of processors and will
8945 choose the default values for the instruction set from the processor
8946 you specify.  If you do not specify a processor type, GCC will default
8947 to the processor on which the compiler was built.
8948
8949 Supported values for @var{cpu_type} are
8950
8951 @table @samp
8952 @item ev4
8953 @item ev45
8954 @itemx 21064
8955 Schedules as an EV4 and has no instruction set extensions.
8956
8957 @item ev5
8958 @itemx 21164
8959 Schedules as an EV5 and has no instruction set extensions.
8960
8961 @item ev56
8962 @itemx 21164a
8963 Schedules as an EV5 and supports the BWX extension.
8964
8965 @item pca56
8966 @itemx 21164pc
8967 @itemx 21164PC
8968 Schedules as an EV5 and supports the BWX and MAX extensions.
8969
8970 @item ev6
8971 @itemx 21264
8972 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8973
8974 @item ev67
8975 @item 21264a
8976 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8977 @end table
8978
8979 @item -mtune=@var{cpu_type}
8980 @opindex mtune
8981 Set only the instruction scheduling parameters for machine type
8982 @var{cpu_type}.  The instruction set is not changed.
8983
8984 @item -mmemory-latency=@var{time}
8985 @opindex mmemory-latency
8986 Sets the latency the scheduler should assume for typical memory
8987 references as seen by the application.  This number is highly
8988 dependent on the memory access patterns used by the application
8989 and the size of the external cache on the machine.
8990
8991 Valid options for @var{time} are
8992
8993 @table @samp
8994 @item @var{number}
8995 A decimal number representing clock cycles.
8996
8997 @item L1
8998 @itemx L2
8999 @itemx L3
9000 @itemx main
9001 The compiler contains estimates of the number of clock cycles for
9002 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
9003 (also called Dcache, Scache, and Bcache), as well as to main memory.
9004 Note that L3 is only valid for EV5.
9005
9006 @end table
9007 @end table
9008
9009 @node DEC Alpha/VMS Options
9010 @subsection DEC Alpha/VMS Options
9011
9012 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9013
9014 @table @gcctabopt
9015 @item -mvms-return-codes
9016 @opindex mvms-return-codes
9017 Return VMS condition codes from main.  The default is to return POSIX
9018 style condition (e.g.@ error) codes.
9019 @end table
9020
9021 @node H8/300 Options
9022 @subsection H8/300 Options
9023
9024 These @samp{-m} options are defined for the H8/300 implementations:
9025
9026 @table @gcctabopt
9027 @item -mrelax
9028 @opindex mrelax
9029 Shorten some address references at link time, when possible; uses the
9030 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9031 ld.info, Using ld}, for a fuller description.
9032
9033 @item -mh
9034 @opindex mh
9035 Generate code for the H8/300H@.
9036
9037 @item -ms
9038 @opindex ms
9039 Generate code for the H8S@.
9040
9041 @item -mn
9042 @opindex mn
9043 Generate code for the H8S and H8/300H in the normal mode.  This switch
9044 must be used either with -mh or -ms.
9045
9046 @item -ms2600
9047 @opindex ms2600
9048 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9049
9050 @item -mint32
9051 @opindex mint32
9052 Make @code{int} data 32 bits by default.
9053
9054 @item -malign-300
9055 @opindex malign-300
9056 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9057 The default for the H8/300H and H8S is to align longs and floats on 4
9058 byte boundaries.
9059 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9060 This option has no effect on the H8/300.
9061 @end table
9062
9063 @node SH Options
9064 @subsection SH Options
9065
9066 These @samp{-m} options are defined for the SH implementations:
9067
9068 @table @gcctabopt
9069 @item -m1
9070 @opindex m1
9071 Generate code for the SH1.
9072
9073 @item -m2
9074 @opindex m2
9075 Generate code for the SH2.
9076
9077 @item -m2e
9078 Generate code for the SH2e.
9079
9080 @item -m3
9081 @opindex m3
9082 Generate code for the SH3.
9083
9084 @item -m3e
9085 @opindex m3e
9086 Generate code for the SH3e.
9087
9088 @item -m4-nofpu
9089 @opindex m4-nofpu
9090 Generate code for the SH4 without a floating-point unit.
9091
9092 @item -m4-single-only
9093 @opindex m4-single-only
9094 Generate code for the SH4 with a floating-point unit that only
9095 supports single-precision arithmetic.
9096
9097 @item -m4-single
9098 @opindex m4-single
9099 Generate code for the SH4 assuming the floating-point unit is in
9100 single-precision mode by default.
9101
9102 @item -m4
9103 @opindex m4
9104 Generate code for the SH4.
9105
9106 @item -mb
9107 @opindex mb
9108 Compile code for the processor in big endian mode.
9109
9110 @item -ml
9111 @opindex ml
9112 Compile code for the processor in little endian mode.
9113
9114 @item -mdalign
9115 @opindex mdalign
9116 Align doubles at 64-bit boundaries.  Note that this changes the calling
9117 conventions, and thus some functions from the standard C library will
9118 not work unless you recompile it first with @option{-mdalign}.
9119
9120 @item -mrelax
9121 @opindex mrelax
9122 Shorten some address references at link time, when possible; uses the
9123 linker option @option{-relax}.
9124
9125 @item -mbigtable
9126 @opindex mbigtable
9127 Use 32-bit offsets in @code{switch} tables.  The default is to use
9128 16-bit offsets.
9129
9130 @item -mfmovd
9131 @opindex mfmovd
9132 Enable the use of the instruction @code{fmovd}.
9133
9134 @item -mhitachi
9135 @opindex mhitachi
9136 Comply with the calling conventions defined by Hitachi.
9137
9138 @item -mnomacsave
9139 @opindex mnomacsave
9140 Mark the @code{MAC} register as call-clobbered, even if
9141 @option{-mhitachi} is given.
9142
9143 @item -mieee
9144 @opindex mieee
9145 Increase IEEE-compliance of floating-point code.
9146
9147 @item -misize
9148 @opindex misize
9149 Dump instruction size and location in the assembly code.
9150
9151 @item -mpadstruct
9152 @opindex mpadstruct
9153 This option is deprecated.  It pads structures to multiple of 4 bytes,
9154 which is incompatible with the SH ABI@.
9155
9156 @item -mspace
9157 @opindex mspace
9158 Optimize for space instead of speed.  Implied by @option{-Os}.
9159
9160 @item -mprefergot
9161 @opindex mprefergot
9162 When generating position-independent code, emit function calls using
9163 the Global Offset Table instead of the Procedure Linkage Table.
9164
9165 @item -musermode
9166 @opindex musermode
9167 Generate a library function call to invalidate instruction cache
9168 entries, after fixing up a trampoline.  This library function call
9169 doesn't assume it can write to the whole memory address space.  This
9170 is the default when the target is @code{sh-*-linux*}.
9171 @end table
9172
9173 @node System V Options
9174 @subsection Options for System V
9175
9176 These additional options are available on System V Release 4 for
9177 compatibility with other compilers on those systems:
9178
9179 @table @gcctabopt
9180 @item -G
9181 @opindex G
9182 Create a shared object.
9183 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9184
9185 @item -Qy
9186 @opindex Qy
9187 Identify the versions of each tool used by the compiler, in a
9188 @code{.ident} assembler directive in the output.
9189
9190 @item -Qn
9191 @opindex Qn
9192 Refrain from adding @code{.ident} directives to the output file (this is
9193 the default).
9194
9195 @item -YP,@var{dirs}
9196 @opindex YP
9197 Search the directories @var{dirs}, and no others, for libraries
9198 specified with @option{-l}.
9199
9200 @item -Ym,@var{dir}
9201 @opindex Ym
9202 Look in the directory @var{dir} to find the M4 preprocessor.
9203 The assembler uses this option.
9204 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9205 @c the generic assembler that comes with Solaris takes just -Ym.
9206 @end table
9207
9208 @node TMS320C3x/C4x Options
9209 @subsection TMS320C3x/C4x Options
9210 @cindex TMS320C3x/C4x Options
9211
9212 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9213
9214 @table @gcctabopt
9215
9216 @item -mcpu=@var{cpu_type}
9217 @opindex mcpu
9218 Set the instruction set, register set, and instruction scheduling
9219 parameters for machine type @var{cpu_type}.  Supported values for
9220 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9221 @samp{c44}.  The default is @samp{c40} to generate code for the
9222 TMS320C40.
9223
9224 @item -mbig-memory
9225 @item -mbig
9226 @itemx -msmall-memory
9227 @itemx -msmall
9228 @opindex mbig-memory
9229 @opindex mbig
9230 @opindex msmall-memory
9231 @opindex msmall
9232 Generates code for the big or small memory model.  The small memory
9233 model assumed that all data fits into one 64K word page.  At run-time
9234 the data page (DP) register must be set to point to the 64K page
9235 containing the .bss and .data program sections.  The big memory model is
9236 the default and requires reloading of the DP register for every direct
9237 memory access.
9238
9239 @item -mbk
9240 @itemx -mno-bk
9241 @opindex mbk
9242 @opindex mno-bk
9243 Allow (disallow) allocation of general integer operands into the block
9244 count register BK@.
9245
9246 @item -mdb
9247 @itemx -mno-db
9248 @opindex mdb
9249 @opindex mno-db
9250 Enable (disable) generation of code using decrement and branch,
9251 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9252 on the safe side, this is disabled for the C3x, since the maximum
9253 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9254 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9255 that it can utilize the decrement and branch instruction, but will give
9256 up if there is more than one memory reference in the loop.  Thus a loop
9257 where the loop counter is decremented can generate slightly more
9258 efficient code, in cases where the RPTB instruction cannot be utilized.
9259
9260 @item -mdp-isr-reload
9261 @itemx -mparanoid
9262 @opindex mdp-isr-reload
9263 @opindex mparanoid
9264 Force the DP register to be saved on entry to an interrupt service
9265 routine (ISR), reloaded to point to the data section, and restored on
9266 exit from the ISR@.  This should not be required unless someone has
9267 violated the small memory model by modifying the DP register, say within
9268 an object library.
9269
9270 @item -mmpyi
9271 @itemx -mno-mpyi
9272 @opindex mmpyi
9273 @opindex mno-mpyi
9274 For the C3x use the 24-bit MPYI instruction for integer multiplies
9275 instead of a library call to guarantee 32-bit results.  Note that if one
9276 of the operands is a constant, then the multiplication will be performed
9277 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9278 then squaring operations are performed inline instead of a library call.
9279
9280 @item -mfast-fix
9281 @itemx -mno-fast-fix
9282 @opindex mfast-fix
9283 @opindex mno-fast-fix
9284 The C3x/C4x FIX instruction to convert a floating point value to an
9285 integer value chooses the nearest integer less than or equal to the
9286 floating point value rather than to the nearest integer.  Thus if the
9287 floating point number is negative, the result will be incorrectly
9288 truncated an additional code is necessary to detect and correct this
9289 case.  This option can be used to disable generation of the additional
9290 code required to correct the result.
9291
9292 @item -mrptb
9293 @itemx -mno-rptb
9294 @opindex mrptb
9295 @opindex mno-rptb
9296 Enable (disable) generation of repeat block sequences using the RPTB
9297 instruction for zero overhead looping.  The RPTB construct is only used
9298 for innermost loops that do not call functions or jump across the loop
9299 boundaries.  There is no advantage having nested RPTB loops due to the
9300 overhead required to save and restore the RC, RS, and RE registers.
9301 This is enabled by default with @option{-O2}.
9302
9303 @item -mrpts=@var{count}
9304 @itemx -mno-rpts
9305 @opindex mrpts
9306 @opindex mno-rpts
9307 Enable (disable) the use of the single instruction repeat instruction
9308 RPTS@.  If a repeat block contains a single instruction, and the loop
9309 count can be guaranteed to be less than the value @var{count}, GCC will
9310 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9311 then a RPTS will be emitted even if the loop count cannot be determined
9312 at compile time.  Note that the repeated instruction following RPTS does
9313 not have to be reloaded from memory each iteration, thus freeing up the
9314 CPU buses for operands.  However, since interrupts are blocked by this
9315 instruction, it is disabled by default.
9316
9317 @item -mloop-unsigned
9318 @itemx -mno-loop-unsigned
9319 @opindex mloop-unsigned
9320 @opindex mno-loop-unsigned
9321 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9322 is @math{2^{31} + 1} since these instructions test if the iteration count is
9323 negative to terminate the loop.  If the iteration count is unsigned
9324 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9325 exceeded.  This switch allows an unsigned iteration count.
9326
9327 @item -mti
9328 @opindex mti
9329 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9330 with.  This also enforces compatibility with the API employed by the TI
9331 C3x C compiler.  For example, long doubles are passed as structures
9332 rather than in floating point registers.
9333
9334 @item -mregparm
9335 @itemx -mmemparm
9336 @opindex mregparm
9337 @opindex mmemparm
9338 Generate code that uses registers (stack) for passing arguments to functions.
9339 By default, arguments are passed in registers where possible rather
9340 than by pushing arguments on to the stack.
9341
9342 @item -mparallel-insns
9343 @itemx -mno-parallel-insns
9344 @opindex mparallel-insns
9345 @opindex mno-parallel-insns
9346 Allow the generation of parallel instructions.  This is enabled by
9347 default with @option{-O2}.
9348
9349 @item -mparallel-mpy
9350 @itemx -mno-parallel-mpy
9351 @opindex mparallel-mpy
9352 @opindex mno-parallel-mpy
9353 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9354 provided @option{-mparallel-insns} is also specified.  These instructions have
9355 tight register constraints which can pessimize the code generation
9356 of large functions.
9357
9358 @end table
9359
9360 @node V850 Options
9361 @subsection V850 Options
9362 @cindex V850 Options
9363
9364 These @samp{-m} options are defined for V850 implementations:
9365
9366 @table @gcctabopt
9367 @item -mlong-calls
9368 @itemx -mno-long-calls
9369 @opindex mlong-calls
9370 @opindex mno-long-calls
9371 Treat all calls as being far away (near).  If calls are assumed to be
9372 far away, the compiler will always load the functions address up into a
9373 register, and call indirect through the pointer.
9374
9375 @item -mno-ep
9376 @itemx -mep
9377 @opindex mno-ep
9378 @opindex mep
9379 Do not optimize (do optimize) basic blocks that use the same index
9380 pointer 4 or more times to copy pointer into the @code{ep} register, and
9381 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9382 option is on by default if you optimize.
9383
9384 @item -mno-prolog-function
9385 @itemx -mprolog-function
9386 @opindex mno-prolog-function
9387 @opindex mprolog-function
9388 Do not use (do use) external functions to save and restore registers at
9389 the prolog and epilog of a function.  The external functions are slower,
9390 but use less code space if more than one function saves the same number
9391 of registers.  The @option{-mprolog-function} option is on by default if
9392 you optimize.
9393
9394 @item -mspace
9395 @opindex mspace
9396 Try to make the code as small as possible.  At present, this just turns
9397 on the @option{-mep} and @option{-mprolog-function} options.
9398
9399 @item -mtda=@var{n}
9400 @opindex mtda
9401 Put static or global variables whose size is @var{n} bytes or less into
9402 the tiny data area that register @code{ep} points to.  The tiny data
9403 area can hold up to 256 bytes in total (128 bytes for byte references).
9404
9405 @item -msda=@var{n}
9406 @opindex msda
9407 Put static or global variables whose size is @var{n} bytes or less into
9408 the small data area that register @code{gp} points to.  The small data
9409 area can hold up to 64 kilobytes.
9410
9411 @item -mzda=@var{n}
9412 @opindex mzda
9413 Put static or global variables whose size is @var{n} bytes or less into
9414 the first 32 kilobytes of memory.
9415
9416 @item -mv850
9417 @opindex mv850
9418 Specify that the target processor is the V850.
9419
9420 @item -mbig-switch
9421 @opindex mbig-switch
9422 Generate code suitable for big switch tables.  Use this option only if
9423 the assembler/linker complain about out of range branches within a switch
9424 table.
9425
9426 @item -mapp-regs
9427 @opindex -mapp-regs
9428 This option will cause r2 and r5 to be used in the code generated by
9429 the compiler.  This setting is the default.
9430
9431 @item -mno-app-regs
9432 @opindex -mno-app-regs
9433 This option will cause r2 and r5 to be treated as fixed registers.
9434   
9435 @item -mv850e
9436 @opindex -mv850e
9437 Specify that the target processor is the V850E.  The preprocessor
9438 constant @samp{__v850e__} will be defined if this option is used.
9439
9440 If neither @option{-mv850} nor @option{-mv850e} are defined
9441 then a default target processor will be chosen and the relevant
9442 @samp{__v850*__} preprocessor constant will be defined.
9443
9444 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9445 defined, regardless of which processor variant is the target.
9446
9447 @item -mdisable-callt
9448 @opindex -mdisable-callt
9449 This option will suppress generation of the CALLT instruction for the
9450 v850e flavors of the v850 architecture.  The default is
9451 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9452
9453 @end table
9454
9455 @node ARC Options
9456 @subsection ARC Options
9457 @cindex ARC Options
9458
9459 These options are defined for ARC implementations:
9460
9461 @table @gcctabopt
9462 @item -EL
9463 @opindex EL
9464 Compile code for little endian mode.  This is the default.
9465
9466 @item -EB
9467 @opindex EB
9468 Compile code for big endian mode.
9469
9470 @item -mmangle-cpu
9471 @opindex mmangle-cpu
9472 Prepend the name of the cpu to all public symbol names.
9473 In multiple-processor systems, there are many ARC variants with different
9474 instruction and register set characteristics.  This flag prevents code
9475 compiled for one cpu to be linked with code compiled for another.
9476 No facility exists for handling variants that are ``almost identical''.
9477 This is an all or nothing option.
9478
9479 @item -mcpu=@var{cpu}
9480 @opindex mcpu
9481 Compile code for ARC variant @var{cpu}.
9482 Which variants are supported depend on the configuration.
9483 All variants support @option{-mcpu=base}, this is the default.
9484
9485 @item -mtext=@var{text-section}
9486 @itemx -mdata=@var{data-section}
9487 @itemx -mrodata=@var{readonly-data-section}
9488 @opindex mtext
9489 @opindex mdata
9490 @opindex mrodata
9491 Put functions, data, and readonly data in @var{text-section},
9492 @var{data-section}, and @var{readonly-data-section} respectively
9493 by default.  This can be overridden with the @code{section} attribute.
9494 @xref{Variable Attributes}.
9495
9496 @end table
9497
9498 @node NS32K Options
9499 @subsection NS32K Options
9500 @cindex NS32K options
9501
9502 These are the @samp{-m} options defined for the 32000 series.  The default
9503 values for these options depends on which style of 32000 was selected when
9504 the compiler was configured; the defaults for the most common choices are
9505 given below.
9506
9507 @table @gcctabopt
9508 @item -m32032
9509 @itemx -m32032
9510 @opindex m32032
9511 @opindex m32032
9512 Generate output for a 32032.  This is the default
9513 when the compiler is configured for 32032 and 32016 based systems.
9514
9515 @item -m32332
9516 @itemx -m32332
9517 @opindex m32332
9518 @opindex m32332
9519 Generate output for a 32332.  This is the default
9520 when the compiler is configured for 32332-based systems.
9521
9522 @item -m32532
9523 @itemx -m32532
9524 @opindex m32532
9525 @opindex m32532
9526 Generate output for a 32532.  This is the default
9527 when the compiler is configured for 32532-based systems.
9528
9529 @item -m32081
9530 @opindex m32081
9531 Generate output containing 32081 instructions for floating point.
9532 This is the default for all systems.
9533
9534 @item -m32381
9535 @opindex m32381
9536 Generate output containing 32381 instructions for floating point.  This
9537 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9538 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9539
9540 @item -mmulti-add
9541 @opindex mmulti-add
9542 Try and generate multiply-add floating point instructions @code{polyF}
9543 and @code{dotF}.  This option is only available if the @option{-m32381}
9544 option is in effect.  Using these instructions requires changes to
9545 register allocation which generally has a negative impact on
9546 performance.  This option should only be enabled when compiling code
9547 particularly likely to make heavy use of multiply-add instructions.
9548
9549 @item -mnomulti-add
9550 @opindex mnomulti-add
9551 Do not try and generate multiply-add floating point instructions
9552 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9553
9554 @item -msoft-float
9555 @opindex msoft-float
9556 Generate output containing library calls for floating point.
9557 @strong{Warning:} the requisite libraries may not be available.
9558
9559 @item -mieee-compare
9560 @itemx -mno-ieee-compare
9561 @opindex mieee-compare
9562 @opindex mno-ieee-compare
9563 Control whether or not the compiler uses IEEE floating point
9564 comparisons.  These handle correctly the case where the result of a
9565 comparison is unordered.
9566 @strong{Warning:} the requisite kernel support may not be available.
9567
9568 @item -mnobitfield
9569 @opindex mnobitfield
9570 Do not use the bit-field instructions.  On some machines it is faster to
9571 use shifting and masking operations.  This is the default for the pc532.
9572
9573 @item -mbitfield
9574 @opindex mbitfield
9575 Do use the bit-field instructions.  This is the default for all platforms
9576 except the pc532.
9577
9578 @item -mrtd
9579 @opindex mrtd
9580 Use a different function-calling convention, in which functions
9581 that take a fixed number of arguments return pop their
9582 arguments on return with the @code{ret} instruction.
9583
9584 This calling convention is incompatible with the one normally
9585 used on Unix, so you cannot use it if you need to call libraries
9586 compiled with the Unix compiler.
9587
9588 Also, you must provide function prototypes for all functions that
9589 take variable numbers of arguments (including @code{printf});
9590 otherwise incorrect code will be generated for calls to those
9591 functions.
9592
9593 In addition, seriously incorrect code will result if you call a
9594 function with too many arguments.  (Normally, extra arguments are
9595 harmlessly ignored.)
9596
9597 This option takes its name from the 680x0 @code{rtd} instruction.
9598
9599
9600 @item -mregparam
9601 @opindex mregparam
9602 Use a different function-calling convention where the first two arguments
9603 are passed in registers.
9604
9605 This calling convention is incompatible with the one normally
9606 used on Unix, so you cannot use it if you need to call libraries
9607 compiled with the Unix compiler.
9608
9609 @item -mnoregparam
9610 @opindex mnoregparam
9611 Do not pass any arguments in registers.  This is the default for all
9612 targets.
9613
9614 @item -msb
9615 @opindex msb
9616 It is OK to use the sb as an index register which is always loaded with
9617 zero.  This is the default for the pc532-netbsd target.
9618
9619 @item -mnosb
9620 @opindex mnosb
9621 The sb register is not available for use or has not been initialized to
9622 zero by the run time system.  This is the default for all targets except
9623 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9624 @option{-fpic} is set.
9625
9626 @item -mhimem
9627 @opindex mhimem
9628 Many ns32000 series addressing modes use displacements of up to 512MB@.
9629 If an address is above 512MB then displacements from zero can not be used.
9630 This option causes code to be generated which can be loaded above 512MB@.
9631 This may be useful for operating systems or ROM code.
9632
9633 @item -mnohimem
9634 @opindex mnohimem
9635 Assume code will be loaded in the first 512MB of virtual address space.
9636 This is the default for all platforms.
9637
9638
9639 @end table
9640
9641 @node AVR Options
9642 @subsection AVR Options
9643 @cindex AVR Options
9644
9645 These options are defined for AVR implementations:
9646
9647 @table @gcctabopt
9648 @item -mmcu=@var{mcu}
9649 @opindex mmcu
9650 Specify ATMEL AVR instruction set or MCU type.
9651
9652 Instruction set avr1 is for the minimal AVR core, not supported by the C
9653 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9654 attiny11, attiny12, attiny15, attiny28).
9655
9656 Instruction set avr2 (default) is for the classic AVR core with up to
9657 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9658 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9659 at90c8534, at90s8535).
9660
9661 Instruction set avr3 is for the classic AVR core with up to 128K program
9662 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9663
9664 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9665 memory space (MCU types: atmega8, atmega83, atmega85).
9666
9667 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9668 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9669 atmega64, atmega128, at43usb355, at94k).
9670
9671 @item -msize
9672 @opindex msize
9673 Output instruction sizes to the asm file.
9674
9675 @item -minit-stack=@var{N}
9676 @opindex minit-stack
9677 Specify the initial stack address, which may be a symbol or numeric value,
9678 @samp{__stack} is the default.
9679
9680 @item -mno-interrupts
9681 @opindex mno-interrupts
9682 Generated code is not compatible with hardware interrupts.
9683 Code size will be smaller.
9684
9685 @item -mcall-prologues
9686 @opindex mcall-prologues
9687 Functions prologues/epilogues expanded as call to appropriate
9688 subroutines.  Code size will be smaller.
9689
9690 @item -mno-tablejump
9691 @opindex mno-tablejump
9692 Do not generate tablejump insns which sometimes increase code size.
9693
9694 @item -mtiny-stack
9695 @opindex mtiny-stack
9696 Change only the low 8 bits of the stack pointer.
9697 @end table
9698
9699 @node MCore Options
9700 @subsection MCore Options
9701 @cindex MCore options
9702
9703 These are the @samp{-m} options defined for the Motorola M*Core
9704 processors.
9705
9706 @table @gcctabopt
9707
9708 @item -mhardlit
9709 @itemx -mhardlit
9710 @itemx -mno-hardlit
9711 @opindex mhardlit
9712 @opindex mhardlit
9713 @opindex mno-hardlit
9714 Inline constants into the code stream if it can be done in two
9715 instructions or less.
9716
9717 @item -mdiv
9718 @itemx -mdiv
9719 @itemx -mno-div
9720 @opindex mdiv
9721 @opindex mdiv
9722 @opindex mno-div
9723 Use the divide instruction.  (Enabled by default).
9724
9725 @item -mrelax-immediate
9726 @itemx -mrelax-immediate
9727 @itemx -mno-relax-immediate
9728 @opindex mrelax-immediate
9729 @opindex mrelax-immediate
9730 @opindex mno-relax-immediate
9731 Allow arbitrary sized immediates in bit operations.
9732
9733 @item -mwide-bitfields
9734 @itemx -mwide-bitfields
9735 @itemx -mno-wide-bitfields
9736 @opindex mwide-bitfields
9737 @opindex mwide-bitfields
9738 @opindex mno-wide-bitfields
9739 Always treat bit-fields as int-sized.
9740
9741 @item -m4byte-functions
9742 @itemx -m4byte-functions
9743 @itemx -mno-4byte-functions
9744 @opindex m4byte-functions
9745 @opindex m4byte-functions
9746 @opindex mno-4byte-functions
9747 Force all functions to be aligned to a four byte boundary.
9748
9749 @item -mcallgraph-data
9750 @itemx -mcallgraph-data
9751 @itemx -mno-callgraph-data
9752 @opindex mcallgraph-data
9753 @opindex mcallgraph-data
9754 @opindex mno-callgraph-data
9755 Emit callgraph information.
9756
9757 @item -mslow-bytes
9758 @itemx -mslow-bytes
9759 @itemx -mno-slow-bytes
9760 @opindex mslow-bytes
9761 @opindex mslow-bytes
9762 @opindex mno-slow-bytes
9763 Prefer word access when reading byte quantities.
9764
9765 @item -mlittle-endian
9766 @itemx -mlittle-endian
9767 @itemx -mbig-endian
9768 @opindex mlittle-endian
9769 @opindex mlittle-endian
9770 @opindex mbig-endian
9771 Generate code for a little endian target.
9772
9773 @item -m210
9774 @itemx -m210
9775 @itemx -m340
9776 @opindex m210
9777 @opindex m210
9778 @opindex m340
9779 Generate code for the 210 processor.
9780 @end table
9781
9782 @node IA-64 Options
9783 @subsection IA-64 Options
9784 @cindex IA-64 Options
9785
9786 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9787
9788 @table @gcctabopt
9789 @item -mbig-endian
9790 @opindex mbig-endian
9791 Generate code for a big endian target.  This is the default for HP-UX@.
9792
9793 @item -mlittle-endian
9794 @opindex mlittle-endian
9795 Generate code for a little endian target.  This is the default for AIX5
9796 and Linux.
9797
9798 @item -mgnu-as
9799 @itemx -mno-gnu-as
9800 @opindex mgnu-as
9801 @opindex mno-gnu-as
9802 Generate (or don't) code for the GNU assembler.  This is the default.
9803 @c Also, this is the default if the configure option @option{--with-gnu-as}
9804 @c is used.
9805
9806 @item -mgnu-ld
9807 @itemx -mno-gnu-ld
9808 @opindex mgnu-ld
9809 @opindex mno-gnu-ld
9810 Generate (or don't) code for the GNU linker.  This is the default.
9811 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9812 @c is used.
9813
9814 @item -mno-pic
9815 @opindex mno-pic
9816 Generate code that does not use a global pointer register.  The result
9817 is not position independent code, and violates the IA-64 ABI@.
9818
9819 @item -mvolatile-asm-stop
9820 @itemx -mno-volatile-asm-stop
9821 @opindex mvolatile-asm-stop
9822 @opindex mno-volatile-asm-stop
9823 Generate (or don't) a stop bit immediately before and after volatile asm
9824 statements.
9825
9826 @item -mb-step
9827 @opindex mb-step
9828 Generate code that works around Itanium B step errata.
9829
9830 @item -mregister-names
9831 @itemx -mno-register-names
9832 @opindex mregister-names
9833 @opindex mno-register-names
9834 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9835 the stacked registers.  This may make assembler output more readable.
9836
9837 @item -mno-sdata
9838 @itemx -msdata
9839 @opindex mno-sdata
9840 @opindex msdata
9841 Disable (or enable) optimizations that use the small data section.  This may
9842 be useful for working around optimizer bugs.
9843
9844 @item -mconstant-gp
9845 @opindex mconstant-gp
9846 Generate code that uses a single constant global pointer value.  This is
9847 useful when compiling kernel code.
9848
9849 @item -mauto-pic
9850 @opindex mauto-pic
9851 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9852 This is useful when compiling firmware code.
9853
9854 @item -minline-float-divide-min-latency
9855 @opindex minline-float-divide-min-latency
9856 Generate code for inline divides of floating point values
9857 using the minimum latency algorithm.
9858
9859 @item -minline-float-divide-max-throughput
9860 @opindex minline-float-divide-max-throughput
9861 Generate code for inline divides of floating point values
9862 using the maximum throughput algorithm.
9863
9864 @item -minline-int-divide-min-latency
9865 @opindex minline-int-divide-min-latency
9866 Generate code for inline divides of integer values
9867 using the minimum latency algorithm.
9868
9869 @item -minline-int-divide-max-throughput
9870 @opindex minline-int-divide-max-throughput
9871 Generate code for inline divides of integer values
9872 using the maximum throughput algorithm.
9873
9874 @item -mno-dwarf2-asm
9875 @itemx -mdwarf2-asm
9876 @opindex mno-dwarf2-asm
9877 @opindex mdwarf2-asm
9878 Don't (or do) generate assembler code for the DWARF2 line number debugging
9879 info.  This may be useful when not using the GNU assembler.
9880
9881 @item -mfixed-range=@var{register-range}
9882 @opindex mfixed-range
9883 Generate code treating the given register range as fixed registers.
9884 A fixed register is one that the register allocator can not use.  This is
9885 useful when compiling kernel code.  A register range is specified as
9886 two registers separated by a dash.  Multiple register ranges can be
9887 specified separated by a comma.
9888
9889 @item -mearly-stop-bits
9890 @itemx -mno-early-stop-bits
9891 @opindex mearly-stop-bits
9892 @opindex mno-early-stop-bits
9893 Allow stop bits to be placed earlier than immediately preceding the
9894 instruction that triggered the stop bit.  This can improve instruction
9895 scheduling, but does not always do so.
9896 @end table
9897
9898 @node D30V Options
9899 @subsection D30V Options
9900 @cindex D30V Options
9901
9902 These @samp{-m} options are defined for D30V implementations:
9903
9904 @table @gcctabopt
9905 @item -mextmem
9906 @opindex mextmem
9907 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9908 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9909 memory, which starts at location @code{0x80000000}.
9910
9911 @item -mextmemory
9912 @opindex mextmemory
9913 Same as the @option{-mextmem} switch.
9914
9915 @item -monchip
9916 @opindex monchip
9917 Link the @samp{.text} section into onchip text memory, which starts at
9918 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9919 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9920 into onchip data memory, which starts at location @code{0x20000000}.
9921
9922 @item -mno-asm-optimize
9923 @itemx -masm-optimize
9924 @opindex mno-asm-optimize
9925 @opindex masm-optimize
9926 Disable (enable) passing @option{-O} to the assembler when optimizing.
9927 The assembler uses the @option{-O} option to automatically parallelize
9928 adjacent short instructions where possible.
9929
9930 @item -mbranch-cost=@var{n}
9931 @opindex mbranch-cost
9932 Increase the internal costs of branches to @var{n}.  Higher costs means
9933 that the compiler will issue more instructions to avoid doing a branch.
9934 The default is 2.
9935
9936 @item -mcond-exec=@var{n}
9937 @opindex mcond-exec
9938 Specify the maximum number of conditionally executed instructions that
9939 replace a branch.  The default is 4.
9940 @end table
9941
9942 @node S/390 and zSeries Options
9943 @subsection S/390 and zSeries Options
9944 @cindex S/390 and zSeries Options
9945
9946 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9947
9948 @table @gcctabopt
9949 @item -mhard-float
9950 @itemx -msoft-float
9951 @opindex mhard-float
9952 @opindex msoft-float
9953 Use (do not use) the hardware floating-point instructions and registers
9954 for floating-point operations.  When @option{-msoft-float} is specified,
9955 functions in @file{libgcc.a} will be used to perform floating-point
9956 operations.  When @option{-mhard-float} is specified, the compiler
9957 generates IEEE floating-point instructions.  This is the default.
9958
9959 @item -mbackchain
9960 @itemx -mno-backchain
9961 @opindex mbackchain
9962 @opindex mno-backchain
9963 Generate (or do not generate) code which maintains an explicit
9964 backchain within the stack frame that points to the caller's frame.
9965 This is currently needed to allow debugging.  The default is to
9966 generate the backchain.
9967
9968 @item -msmall-exec
9969 @itemx -mno-small-exec
9970 @opindex msmall-exec
9971 @opindex mno-small-exec
9972 Generate (or do not generate) code using the @code{bras} instruction
9973 to do subroutine calls.
9974 This only works reliably if the total executable size does not
9975 exceed 64k.  The default is to use the @code{basr} instruction instead,
9976 which does not have this limitation.
9977
9978 @item -m64
9979 @itemx -m31
9980 @opindex m64
9981 @opindex m31
9982 When @option{-m31} is specified, generate code compliant to the
9983 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9984 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9985 particular to generate 64-bit instructions.  For the @samp{s390}
9986 targets, the default is @option{-m31}, while the @samp{s390x}
9987 targets default to @option{-m64}.
9988
9989 @item -mzarch
9990 @itemx -mesa
9991 @opindex mzarch
9992 @opindex mesa
9993 When @option{-mzarch} is specified, generate code using the 
9994 instructions available on z/Architecture. 
9995 When @option{-mesa} is specified, generate code using the 
9996 instructions available on ESA/390. Note that @option{-mesa} is
9997 not possible with @option{-m64}.
9998 For the @samp{s390} targets, the default is @option{-mesa}, 
9999 while the @samp{s390x} targets default to @option{-mzarch}.
10000
10001 @item -mmvcle
10002 @itemx -mno-mvcle
10003 @opindex mmvcle
10004 @opindex mno-mvcle
10005 Generate (or do not generate) code using the @code{mvcle} instruction
10006 to perform block moves.  When @option{-mno-mvcle} is specified,
10007 use a @code{mvc} loop instead.  This is the default.
10008
10009 @item -mdebug
10010 @itemx -mno-debug
10011 @opindex mdebug
10012 @opindex mno-debug
10013 Print (or do not print) additional debug information when compiling.
10014 The default is to not print debug information.
10015
10016 @item -march=@var{arch}
10017 @opindex march
10018 Generate code that will run on @var{arch}, which is the name of system
10019 representing a certain processor type. Possible values for
10020 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
10021
10022 @item -mtune=@var{arch}
10023 @opindex mtune
10024 Tune to @var{cpu-type} everything applicable about the generated code,
10025  except for the ABI and the set of available instructions. 
10026 The list of @var{arch} values is the same as for @option{-march}.
10027
10028 @end table
10029
10030 @node CRIS Options
10031 @subsection CRIS Options
10032 @cindex CRIS Options
10033
10034 These options are defined specifically for the CRIS ports.
10035
10036 @table @gcctabopt
10037 @item -march=@var{architecture-type}
10038 @itemx -mcpu=@var{architecture-type}
10039 @opindex march
10040 @opindex mcpu
10041 Generate code for the specified architecture.  The choices for
10042 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10043 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10044 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10045 @samp{v10}.
10046
10047 @item -mtune=@var{architecture-type}
10048 @opindex mtune
10049 Tune to @var{architecture-type} everything applicable about the generated
10050 code, except for the ABI and the set of available instructions.  The
10051 choices for @var{architecture-type} are the same as for
10052 @option{-march=@var{architecture-type}}.
10053
10054 @item -mmax-stack-frame=@var{n}
10055 @opindex mmax-stack-frame
10056 Warn when the stack frame of a function exceeds @var{n} bytes.
10057
10058 @item -melinux-stacksize=@var{n}
10059 @opindex melinux-stacksize
10060 Only available with the @samp{cris-axis-aout} target.  Arranges for
10061 indications in the program to the kernel loader that the stack of the
10062 program should be set to @var{n} bytes.
10063
10064 @item -metrax4
10065 @itemx -metrax100
10066 @opindex metrax4
10067 @opindex metrax100
10068 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10069 @option{-march=v3} and @option{-march=v8} respectively.
10070
10071 @item -mpdebug
10072 @opindex mpdebug
10073 Enable CRIS-specific verbose debug-related information in the assembly
10074 code.  This option also has the effect to turn off the @samp{#NO_APP}
10075 formatted-code indicator to the assembler at the beginning of the
10076 assembly file.
10077
10078 @item -mcc-init
10079 @opindex mcc-init
10080 Do not use condition-code results from previous instruction; always emit
10081 compare and test instructions before use of condition codes.
10082
10083 @item -mno-side-effects
10084 @opindex mno-side-effects
10085 Do not emit instructions with side-effects in addressing modes other than
10086 post-increment.
10087
10088 @item -mstack-align
10089 @itemx -mno-stack-align
10090 @itemx -mdata-align
10091 @itemx -mno-data-align
10092 @itemx -mconst-align
10093 @itemx -mno-const-align
10094 @opindex mstack-align
10095 @opindex mno-stack-align
10096 @opindex mdata-align
10097 @opindex mno-data-align
10098 @opindex mconst-align
10099 @opindex mno-const-align
10100 These options (no-options) arranges (eliminate arrangements) for the
10101 stack-frame, individual data and constants to be aligned for the maximum
10102 single data access size for the chosen CPU model.  The default is to
10103 arrange for 32-bit alignment.  ABI details such as structure layout are
10104 not affected by these options.
10105
10106 @item -m32-bit
10107 @itemx -m16-bit
10108 @itemx -m8-bit
10109 @opindex m32-bit
10110 @opindex m16-bit
10111 @opindex m8-bit
10112 Similar to the stack- data- and const-align options above, these options
10113 arrange for stack-frame, writable data and constants to all be 32-bit,
10114 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10115
10116 @item -mno-prologue-epilogue
10117 @itemx -mprologue-epilogue
10118 @opindex mno-prologue-epilogue
10119 @opindex mprologue-epilogue
10120 With @option{-mno-prologue-epilogue}, the normal function prologue and
10121 epilogue that sets up the stack-frame are omitted and no return
10122 instructions or return sequences are generated in the code.  Use this
10123 option only together with visual inspection of the compiled code: no
10124 warnings or errors are generated when call-saved registers must be saved,
10125 or storage for local variable needs to be allocated.
10126
10127 @item -mno-gotplt
10128 @itemx -mgotplt
10129 @opindex mno-gotplt
10130 @opindex mgotplt
10131 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10132 instruction sequences that load addresses for functions from the PLT part
10133 of the GOT rather than (traditional on other architectures) calls to the
10134 PLT.  The default is @option{-mgotplt}.
10135
10136 @item -maout
10137 @opindex maout
10138 Legacy no-op option only recognized with the cris-axis-aout target.
10139
10140 @item -melf
10141 @opindex melf
10142 Legacy no-op option only recognized with the cris-axis-elf and
10143 cris-axis-linux-gnu targets.
10144
10145 @item -melinux
10146 @opindex melinux
10147 Only recognized with the cris-axis-aout target, where it selects a
10148 GNU/linux-like multilib, include files and instruction set for
10149 @option{-march=v8}.
10150
10151 @item -mlinux
10152 @opindex mlinux
10153 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10154
10155 @item -sim
10156 @opindex sim
10157 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10158 to link with input-output functions from a simulator library.  Code,
10159 initialized data and zero-initialized data are allocated consecutively.
10160
10161 @item -sim2
10162 @opindex sim2
10163 Like @option{-sim}, but pass linker options to locate initialized data at
10164 0x40000000 and zero-initialized data at 0x80000000.
10165 @end table
10166
10167 @node MMIX Options
10168 @subsection MMIX Options
10169 @cindex MMIX Options
10170
10171 These options are defined for the MMIX:
10172
10173 @table @gcctabopt
10174 @item -mlibfuncs
10175 @itemx -mno-libfuncs
10176 @opindex mlibfuncs
10177 @opindex mno-libfuncs
10178 Specify that intrinsic library functions are being compiled, passing all
10179 values in registers, no matter the size.
10180
10181 @item -mepsilon
10182 @itemx -mno-epsilon
10183 @opindex mepsilon
10184 @opindex mno-epsilon
10185 Generate floating-point comparison instructions that compare with respect
10186 to the @code{rE} epsilon register.
10187
10188 @item -mabi=mmixware
10189 @itemx -mabi=gnu
10190 @opindex mabi-mmixware
10191 @opindex mabi=gnu
10192 Generate code that passes function parameters and return values that (in
10193 the called function) are seen as registers @code{$0} and up, as opposed to
10194 the GNU ABI which uses global registers @code{$231} and up.
10195
10196 @item -mzero-extend
10197 @itemx -mno-zero-extend
10198 @opindex mzero-extend
10199 @opindex mno-zero-extend
10200 When reading data from memory in sizes shorter than 64 bits, use (do not
10201 use) zero-extending load instructions by default, rather than
10202 sign-extending ones.
10203
10204 @item -mknuthdiv
10205 @itemx -mno-knuthdiv
10206 @opindex mknuthdiv
10207 @opindex mno-knuthdiv
10208 Make the result of a division yielding a remainder have the same sign as
10209 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10210 remainder follows the sign of the dividend.  Both methods are
10211 arithmetically valid, the latter being almost exclusively used.
10212
10213 @item -mtoplevel-symbols
10214 @itemx -mno-toplevel-symbols
10215 @opindex mtoplevel-symbols
10216 @opindex mno-toplevel-symbols
10217 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10218 code can be used with the @code{PREFIX} assembly directive.
10219
10220 @item -melf
10221 @opindex melf
10222 Generate an executable in the ELF format, rather than the default
10223 @samp{mmo} format used by the @command{mmix} simulator.
10224
10225 @item -mbranch-predict
10226 @itemx -mno-branch-predict
10227 @opindex mbranch-predict
10228 @opindex mno-branch-predict
10229 Use (do not use) the probable-branch instructions, when static branch
10230 prediction indicates a probable branch.
10231
10232 @item -mbase-addresses
10233 @itemx -mno-base-addresses
10234 @opindex mbase-addresses
10235 @opindex mno-base-addresses
10236 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10237 base address automatically generates a request (handled by the assembler
10238 and the linker) for a constant to be set up in a global register.  The
10239 register is used for one or more base address requests within the range 0
10240 to 255 from the value held in the register.  The generally leads to short
10241 and fast code, but the number of different data items that can be
10242 addressed is limited.  This means that a program that uses lots of static
10243 data may require @option{-mno-base-addresses}.
10244
10245 @item -msingle-exit
10246 @itemx -mno-single-exit
10247 @opindex msingle-exit
10248 @opindex mno-single-exit
10249 Force (do not force) generated code to have a single exit point in each
10250 function.
10251 @end table
10252
10253 @node PDP-11 Options
10254 @subsection PDP-11 Options
10255 @cindex PDP-11 Options
10256
10257 These options are defined for the PDP-11:
10258
10259 @table @gcctabopt
10260 @item -mfpu
10261 @opindex mfpu
10262 Use hardware FPP floating point.  This is the default.  (FIS floating
10263 point on the PDP-11/40 is not supported.)
10264
10265 @item -msoft-float
10266 @opindex msoft-float
10267 Do not use hardware floating point.
10268
10269 @item -mac0
10270 @opindex mac0
10271 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10272
10273 @item -mno-ac0
10274 @opindex mno-ac0
10275 Return floating-point results in memory.  This is the default.
10276
10277 @item -m40
10278 @opindex m40
10279 Generate code for a PDP-11/40.
10280
10281 @item -m45
10282 @opindex m45
10283 Generate code for a PDP-11/45.  This is the default.
10284
10285 @item -m10
10286 @opindex m10
10287 Generate code for a PDP-11/10.
10288
10289 @item -mbcopy-builtin
10290 @opindex bcopy-builtin
10291 Use inline @code{movstrhi} patterns for copying memory.  This is the
10292 default.
10293
10294 @item -mbcopy
10295 @opindex mbcopy
10296 Do not use inline @code{movstrhi} patterns for copying memory.
10297
10298 @item -mint16
10299 @itemx -mno-int32
10300 @opindex mint16
10301 @opindex mno-int32
10302 Use 16-bit @code{int}.  This is the default.
10303
10304 @item -mint32
10305 @itemx -mno-int16
10306 @opindex mint32
10307 @opindex mno-int16
10308 Use 32-bit @code{int}.
10309
10310 @item -mfloat64
10311 @itemx -mno-float32
10312 @opindex mfloat64
10313 @opindex mno-float32
10314 Use 64-bit @code{float}.  This is the default.
10315
10316 @item -mfloat32
10317 @item -mno-float64
10318 @opindex mfloat32
10319 @opindex mno-float64
10320 Use 32-bit @code{float}.
10321
10322 @item -mabshi
10323 @opindex mabshi
10324 Use @code{abshi2} pattern.  This is the default.
10325
10326 @item -mno-abshi
10327 @opindex mno-abshi
10328 Do not use @code{abshi2} pattern.
10329
10330 @item -mbranch-expensive
10331 @opindex mbranch-expensive
10332 Pretend that branches are expensive.  This is for experimenting with
10333 code generation only.
10334
10335 @item -mbranch-cheap
10336 @opindex mbranch-cheap
10337 Do not pretend that branches are expensive.  This is the default.
10338
10339 @item -msplit
10340 @opindex msplit
10341 Generate code for a system with split I&D.
10342
10343 @item -mno-split
10344 @opindex mno-split
10345 Generate code for a system without split I&D.  This is the default.
10346
10347 @item -munix-asm
10348 @opindex munix-asm
10349 Use Unix assembler syntax.  This is the default when configured for
10350 @samp{pdp11-*-bsd}.
10351
10352 @item -mdec-asm
10353 @opindex mdec-asm
10354 Use DEC assembler syntax.  This is the default when configured for any
10355 PDP-11 target other than @samp{pdp11-*-bsd}.
10356 @end table
10357
10358 @node Xstormy16 Options
10359 @subsection Xstormy16 Options
10360 @cindex Xstormy16 Options
10361
10362 These options are defined for Xstormy16:
10363
10364 @table @gcctabopt
10365 @item -msim
10366 @opindex msim
10367 Choose startup files and linker script suitable for the simulator.
10368 @end table
10369
10370 @node FRV Options
10371 @subsection FRV Options
10372 @cindex FRV Options
10373
10374 @table @gcctabopt
10375 @item -mgpr-32
10376 @opindex mgpr-32
10377
10378 Only use the first 32 general purpose registers.
10379
10380 @item -mgpr-64
10381 @opindex mgpr-64
10382
10383 Use all 64 general purpose registers.
10384
10385 @item -mfpr-32
10386 @opindex mfpr-32
10387
10388 Use only the first 32 floating point registers.
10389
10390 @item -mfpr-64
10391 @opindex mfpr-64
10392
10393 Use all 64 floating point registers
10394
10395 @item -mhard-float
10396 @opindex mhard-float
10397
10398 Use hardware instructions for floating point operations.
10399
10400 @item -msoft-float
10401 @opindex msoft-float
10402
10403 Use library routines for floating point operations.
10404
10405 @item -malloc-cc
10406 @opindex malloc-cc
10407
10408 Dynamically allocate condition code registers.
10409
10410 @item -mfixed-cc
10411 @opindex mfixed-cc
10412
10413 Do not try to dynamically allocate condition code registers, only
10414 use @code{icc0} and @code{fcc0}.
10415
10416 @item -mdword
10417 @opindex mdword
10418
10419 Change ABI to use double word insns.
10420
10421 @item -mno-dword
10422 @opindex mno-dword
10423
10424 Do not use double word instructions.
10425
10426 @item -mdouble
10427 @opindex mdouble
10428
10429 Use floating point double instructions.
10430
10431 @item -mno-double
10432 @opindex mno-double
10433
10434 Do not use floating point double instructions.
10435
10436 @item -mmedia
10437 @opindex mmedia
10438
10439 Use media instructions.
10440
10441 @item -mno-media
10442 @opindex mno-media
10443
10444 Do not use media instructions.
10445
10446 @item -mmuladd
10447 @opindex mmuladd
10448
10449 Use multiply and add/subtract instructions.
10450
10451 @item -mno-muladd
10452 @opindex mno-muladd
10453
10454 Do not use multiply and add/subtract instructions.
10455
10456 @item -mlibrary-pic
10457 @opindex mlibrary-pic
10458
10459 Enable PIC support for building libraries
10460
10461 @item -macc-4
10462 @opindex macc-4
10463
10464 Use only the first four media accumulator registers.
10465
10466 @item -macc-8
10467 @opindex macc-8
10468
10469 Use all eight media accumulator registers.
10470
10471 @item -mpack
10472 @opindex mpack
10473
10474 Pack VLIW instructions.
10475
10476 @item -mno-pack
10477 @opindex mno-pack
10478
10479 Do not pack VLIW instructions.
10480
10481 @item -mno-eflags
10482 @opindex mno-eflags
10483
10484 Do not mark ABI switches in e_flags.
10485
10486 @item -mcond-move
10487 @opindex mcond-move
10488
10489 Enable the use of conditional-move instructions (default).
10490
10491 This switch is mainly for debugging the compiler and will likely be removed
10492 in a future version.
10493
10494 @item -mno-cond-move
10495 @opindex mno-cond-move
10496
10497 Disable the use of conditional-move instructions.
10498
10499 This switch is mainly for debugging the compiler and will likely be removed
10500 in a future version.
10501
10502 @item -mscc
10503 @opindex mscc
10504
10505 Enable the use of conditional set instructions (default).
10506
10507 This switch is mainly for debugging the compiler and will likely be removed
10508 in a future version.
10509
10510 @item -mno-scc
10511 @opindex mno-scc
10512
10513 Disable the use of conditional set instructions.
10514
10515 This switch is mainly for debugging the compiler and will likely be removed
10516 in a future version.
10517
10518 @item -mcond-exec
10519 @opindex mcond-exec
10520
10521 Enable the use of conditional execution (default).
10522
10523 This switch is mainly for debugging the compiler and will likely be removed
10524 in a future version.
10525
10526 @item -mno-cond-exec
10527 @opindex mno-cond-exec
10528
10529 Disable the use of conditional execution.
10530
10531 This switch is mainly for debugging the compiler and will likely be removed
10532 in a future version.
10533
10534 @item -mvliw-branch
10535 @opindex mvliw-branch
10536
10537 Run a pass to pack branches into VLIW instructions (default).
10538
10539 This switch is mainly for debugging the compiler and will likely be removed
10540 in a future version.
10541
10542 @item -mno-vliw-branch
10543 @opindex mno-vliw-branch
10544
10545 Do not run a pass to pack branches into VLIW instructions.
10546
10547 This switch is mainly for debugging the compiler and will likely be removed
10548 in a future version.
10549
10550 @item -mmulti-cond-exec
10551 @opindex mmulti-cond-exec
10552
10553 Enable optimization of @code{&&} and @code{||} in conditional execution
10554 (default).
10555
10556 This switch is mainly for debugging the compiler and will likely be removed
10557 in a future version.
10558
10559 @item -mno-multi-cond-exec
10560 @opindex mno-multi-cond-exec
10561
10562 Disable optimization of @code{&&} and @code{||} in conditional execution.
10563
10564 This switch is mainly for debugging the compiler and will likely be removed
10565 in a future version.
10566
10567 @item -mnested-cond-exec
10568 @opindex mnested-cond-exec
10569
10570 Enable nested conditional execution optimizations (default).
10571
10572 This switch is mainly for debugging the compiler and will likely be removed
10573 in a future version.
10574
10575 @item -mno-nested-cond-exec
10576 @opindex mno-nested-cond-exec
10577
10578 Disable nested conditional execution optimizations.
10579
10580 This switch is mainly for debugging the compiler and will likely be removed
10581 in a future version.
10582
10583 @item -mtomcat-stats
10584 @opindex mtomcat-stats
10585
10586 Cause gas to print out tomcat statistics.
10587
10588 @item -mcpu=@var{cpu}
10589 @opindex mcpu
10590
10591 Select the processor type for which to generate code.  Possible values are
10592 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10593 @samp{frv}.
10594
10595 @end table
10596
10597 @node Xtensa Options
10598 @subsection Xtensa Options
10599 @cindex Xtensa Options
10600
10601 The Xtensa architecture is designed to support many different
10602 configurations.  The compiler's default options can be set to match a
10603 particular Xtensa configuration by copying a configuration file into the
10604 GCC sources when building GCC@.  The options below may be used to
10605 override the default options.
10606
10607 @table @gcctabopt
10608 @item -mbig-endian
10609 @itemx -mlittle-endian
10610 @opindex mbig-endian
10611 @opindex mlittle-endian
10612 Specify big-endian or little-endian byte ordering for the target Xtensa
10613 processor.
10614
10615 @item -mdensity
10616 @itemx -mno-density
10617 @opindex mdensity
10618 @opindex mno-density
10619 Enable or disable use of the optional Xtensa code density instructions.
10620
10621 @item -mmac16
10622 @itemx -mno-mac16
10623 @opindex mmac16
10624 @opindex mno-mac16
10625 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10626 will generate MAC16 instructions from standard C code, with the
10627 limitation that it will use neither the MR register file nor any
10628 instruction that operates on the MR registers.  When this option is
10629 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10630 combination of core instructions and library calls, depending on whether
10631 any other multiplier options are enabled.
10632
10633 @item -mmul16
10634 @itemx -mno-mul16
10635 @opindex mmul16
10636 @opindex mno-mul16
10637 Enable or disable use of the 16-bit integer multiplier option.  When
10638 enabled, the compiler will generate 16-bit multiply instructions for
10639 multiplications of 16 bits or smaller in standard C code.  When this
10640 option is disabled, the compiler will either use 32-bit multiply or
10641 MAC16 instructions if they are available or generate library calls to
10642 perform the multiply operations using shifts and adds.
10643
10644 @item -mmul32
10645 @itemx -mno-mul32
10646 @opindex mmul32
10647 @opindex mno-mul32
10648 Enable or disable use of the 32-bit integer multiplier option.  When
10649 enabled, the compiler will generate 32-bit multiply instructions for
10650 multiplications of 32 bits or smaller in standard C code.  When this
10651 option is disabled, the compiler will generate library calls to perform
10652 the multiply operations using either shifts and adds or 16-bit multiply
10653 instructions if they are available.
10654
10655 @item -mnsa
10656 @itemx -mno-nsa
10657 @opindex mnsa
10658 @opindex mno-nsa
10659 Enable or disable use of the optional normalization shift amount
10660 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10661
10662 @item -mminmax
10663 @itemx -mno-minmax
10664 @opindex mminmax
10665 @opindex mno-minmax
10666 Enable or disable use of the optional minimum and maximum value
10667 instructions.
10668
10669 @item -msext
10670 @itemx -mno-sext
10671 @opindex msext
10672 @opindex mno-sext
10673 Enable or disable use of the optional sign extend (@code{SEXT})
10674 instruction.
10675
10676 @item -mbooleans
10677 @itemx -mno-booleans
10678 @opindex mbooleans
10679 @opindex mno-booleans
10680 Enable or disable support for the boolean register file used by Xtensa
10681 coprocessors.  This is not typically useful by itself but may be
10682 required for other options that make use of the boolean registers (e.g.,
10683 the floating-point option).
10684
10685 @item -mhard-float
10686 @itemx -msoft-float
10687 @opindex mhard-float
10688 @opindex msoft-float
10689 Enable or disable use of the floating-point option.  When enabled, GCC
10690 generates floating-point instructions for 32-bit @code{float}
10691 operations.  When this option is disabled, GCC generates library calls
10692 to emulate 32-bit floating-point operations using integer instructions.
10693 Regardless of this option, 64-bit @code{double} operations are always
10694 emulated with calls to library functions.
10695
10696 @item -mfused-madd
10697 @itemx -mno-fused-madd
10698 @opindex mfused-madd
10699 @opindex mno-fused-madd
10700 Enable or disable use of fused multiply/add and multiply/subtract
10701 instructions in the floating-point option.  This has no effect if the
10702 floating-point option is not also enabled.  Disabling fused multiply/add
10703 and multiply/subtract instructions forces the compiler to use separate
10704 instructions for the multiply and add/subtract operations.  This may be
10705 desirable in some cases where strict IEEE 754-compliant results are
10706 required: the fused multiply add/subtract instructions do not round the
10707 intermediate result, thereby producing results with @emph{more} bits of
10708 precision than specified by the IEEE standard.  Disabling fused multiply
10709 add/subtract instructions also ensures that the program output is not
10710 sensitive to the compiler's ability to combine multiply and add/subtract
10711 operations.
10712
10713 @item -mserialize-volatile
10714 @itemx -mno-serialize-volatile
10715 @opindex mserialize-volatile
10716 @opindex mno-serialize-volatile
10717 When this option is enabled, GCC inserts @code{MEMW} instructions before
10718 @code{volatile} memory references to guarantee sequential consistency.
10719 The default is @option{-mserialize-volatile}.  Use
10720 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10721
10722 @item -mtext-section-literals
10723 @itemx -mno-text-section-literals
10724 @opindex mtext-section-literals
10725 @opindex mno-text-section-literals
10726 Control the treatment of literal pools.  The default is
10727 @option{-mno-text-section-literals}, which places literals in a separate
10728 section in the output file.  This allows the literal pool to be placed
10729 in a data RAM/ROM, and it also allows the linker to combine literal
10730 pools from separate object files to remove redundant literals and
10731 improve code size.  With @option{-mtext-section-literals}, the literals
10732 are interspersed in the text section in order to keep them as close as
10733 possible to their references.  This may be necessary for large assembly
10734 files.
10735
10736 @item -mtarget-align
10737 @itemx -mno-target-align
10738 @opindex mtarget-align
10739 @opindex mno-target-align
10740 When this option is enabled, GCC instructs the assembler to
10741 automatically align instructions to reduce branch penalties at the
10742 expense of some code density.  The assembler attempts to widen density
10743 instructions to align branch targets and the instructions following call
10744 instructions.  If there are not enough preceding safe density
10745 instructions to align a target, no widening will be performed.  The
10746 default is @option{-mtarget-align}.  These options do not affect the
10747 treatment of auto-aligned instructions like @code{LOOP}, which the
10748 assembler will always align, either by widening density instructions or
10749 by inserting no-op instructions.
10750
10751 @item -mlongcalls
10752 @itemx -mno-longcalls
10753 @opindex mlongcalls
10754 @opindex mno-longcalls
10755 When this option is enabled, GCC instructs the assembler to translate
10756 direct calls to indirect calls unless it can determine that the target
10757 of a direct call is in the range allowed by the call instruction.  This
10758 translation typically occurs for calls to functions in other source
10759 files.  Specifically, the assembler translates a direct @code{CALL}
10760 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10761 The default is @option{-mno-longcalls}.  This option should be used in
10762 programs where the call target can potentially be out of range.  This
10763 option is implemented in the assembler, not the compiler, so the
10764 assembly code generated by GCC will still show direct call
10765 instructions---look at the disassembled object code to see the actual
10766 instructions.  Note that the assembler will use an indirect call for
10767 every cross-file call, not just those that really will be out of range.
10768 @end table
10769
10770 @node Code Gen Options
10771 @section Options for Code Generation Conventions
10772 @cindex code generation conventions
10773 @cindex options, code generation
10774 @cindex run-time options
10775
10776 These machine-independent options control the interface conventions
10777 used in code generation.
10778
10779 Most of them have both positive and negative forms; the negative form
10780 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10781 one of the forms is listed---the one which is not the default.  You
10782 can figure out the other form by either removing @samp{no-} or adding
10783 it.
10784
10785 @table @gcctabopt
10786 @item -fbounds-check
10787 @opindex fbounds-check
10788 For front-ends that support it, generate additional code to check that
10789 indices used to access arrays are within the declared range.  This is
10790 currently only supported by the Java and Fortran 77 front-ends, where
10791 this option defaults to true and false respectively.
10792
10793 @item -ftrapv
10794 @opindex ftrapv
10795 This option generates traps for signed overflow on addition, subtraction,
10796 multiplication operations.
10797
10798 @item -fexceptions
10799 @opindex fexceptions
10800 Enable exception handling.  Generates extra code needed to propagate
10801 exceptions.  For some targets, this implies GCC will generate frame
10802 unwind information for all functions, which can produce significant data
10803 size overhead, although it does not affect execution.  If you do not
10804 specify this option, GCC will enable it by default for languages like
10805 C++ which normally require exception handling, and disable it for
10806 languages like C that do not normally require it.  However, you may need
10807 to enable this option when compiling C code that needs to interoperate
10808 properly with exception handlers written in C++.  You may also wish to
10809 disable this option if you are compiling older C++ programs that don't
10810 use exception handling.
10811
10812 @item -fnon-call-exceptions
10813 @opindex fnon-call-exceptions
10814 Generate code that allows trapping instructions to throw exceptions.
10815 Note that this requires platform-specific runtime support that does
10816 not exist everywhere.  Moreover, it only allows @emph{trapping}
10817 instructions to throw exceptions, i.e.@: memory references or floating
10818 point instructions.  It does not allow exceptions to be thrown from
10819 arbitrary signal handlers such as @code{SIGALRM}.
10820
10821 @item -fforced-unwind-exceptions
10822 @opindex fforced-unwind-exceptions
10823 Generate code that checks for non-catchable exceptions derived from
10824 @code{_Unwind_ForcedUnwind}, such as from @code{longjmp_unwind} or
10825 from pthread cancellation.  There is some amount of code-size 
10826 overhead associated with this, so it is not default.
10827
10828 @item -funwind-tables
10829 @opindex funwind-tables
10830 Similar to @option{-fexceptions}, except that it will just generate any needed
10831 static data, but will not affect the generated code in any other way.
10832 You will normally not enable this option; instead, a language processor
10833 that needs this handling would enable it on your behalf.
10834
10835 @item -fasynchronous-unwind-tables
10836 @opindex funwind-tables
10837 Generate unwind table in dwarf2 format, if supported by target machine.  The
10838 table is exact at each instruction boundary, so it can be used for stack
10839 unwinding from asynchronous events (such as debugger or garbage collector).
10840
10841 @item -fpcc-struct-return
10842 @opindex fpcc-struct-return
10843 Return ``short'' @code{struct} and @code{union} values in memory like
10844 longer ones, rather than in registers.  This convention is less
10845 efficient, but it has the advantage of allowing intercallability between
10846 GCC-compiled files and files compiled with other compilers, particularly
10847 the Portable C Compiler (pcc).
10848
10849 The precise convention for returning structures in memory depends
10850 on the target configuration macros.
10851
10852 Short structures and unions are those whose size and alignment match
10853 that of some integer type.
10854
10855 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10856 switch is not binary compatible with code compiled with the
10857 @option{-freg-struct-return} switch.
10858 Use it to conform to a non-default application binary interface.
10859
10860 @item -freg-struct-return
10861 @opindex freg-struct-return
10862 Return @code{struct} and @code{union} values in registers when possible.
10863 This is more efficient for small structures than
10864 @option{-fpcc-struct-return}.
10865
10866 If you specify neither @option{-fpcc-struct-return} nor
10867 @option{-freg-struct-return}, GCC defaults to whichever convention is
10868 standard for the target.  If there is no standard convention, GCC
10869 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10870 the principal compiler.  In those cases, we can choose the standard, and
10871 we chose the more efficient register return alternative.
10872
10873 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10874 switch is not binary compatible with code compiled with the
10875 @option{-fpcc-struct-return} switch.
10876 Use it to conform to a non-default application binary interface.
10877
10878 @item -fshort-enums
10879 @opindex fshort-enums
10880 Allocate to an @code{enum} type only as many bytes as it needs for the
10881 declared range of possible values.  Specifically, the @code{enum} type
10882 will be equivalent to the smallest integer type which has enough room.
10883
10884 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10885 code that is not binary compatible with code generated without that switch.
10886 Use it to conform to a non-default application binary interface.
10887
10888 @item -fshort-double
10889 @opindex fshort-double
10890 Use the same size for @code{double} as for @code{float}.
10891
10892 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
10893 code that is not binary compatible with code generated without that switch.
10894 Use it to conform to a non-default application binary interface.
10895
10896 @item -fshort-wchar
10897 @opindex fshort-wchar
10898 Override the underlying type for @samp{wchar_t} to be @samp{short
10899 unsigned int} instead of the default for the target.  This option is
10900 useful for building programs to run under WINE@.
10901
10902 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10903 code that is not binary compatible with code generated without that switch.
10904 Use it to conform to a non-default application binary interface.
10905
10906 @item -fshared-data
10907 @opindex fshared-data
10908 Requests that the data and non-@code{const} variables of this
10909 compilation be shared data rather than private data.  The distinction
10910 makes sense only on certain operating systems, where shared data is
10911 shared between processes running the same program, while private data
10912 exists in one copy per process.
10913
10914 @item -fno-common
10915 @opindex fno-common
10916 In C, allocate even uninitialized global variables in the data section of the
10917 object file, rather than generating them as common blocks.  This has the
10918 effect that if the same variable is declared (without @code{extern}) in
10919 two different compilations, you will get an error when you link them.
10920 The only reason this might be useful is if you wish to verify that the
10921 program will work on other systems which always work this way.
10922
10923 @item -fno-ident
10924 @opindex fno-ident
10925 Ignore the @samp{#ident} directive.
10926
10927 @item -fno-gnu-linker
10928 @opindex fno-gnu-linker
10929 Do not output global initializations (such as C++ constructors and
10930 destructors) in the form used by the GNU linker (on systems where the GNU
10931 linker is the standard method of handling them).  Use this option when
10932 you want to use a non-GNU linker, which also requires using the
10933 @command{collect2} program to make sure the system linker includes
10934 constructors and destructors.  (@command{collect2} is included in the GCC
10935 distribution.)  For systems which @emph{must} use @command{collect2}, the
10936 compiler driver @command{gcc} is configured to do this automatically.
10937
10938 @item -finhibit-size-directive
10939 @opindex finhibit-size-directive
10940 Don't output a @code{.size} assembler directive, or anything else that
10941 would cause trouble if the function is split in the middle, and the
10942 two halves are placed at locations far apart in memory.  This option is
10943 used when compiling @file{crtstuff.c}; you should not need to use it
10944 for anything else.
10945
10946 @item -fverbose-asm
10947 @opindex fverbose-asm
10948 Put extra commentary information in the generated assembly code to
10949 make it more readable.  This option is generally only of use to those
10950 who actually need to read the generated assembly code (perhaps while
10951 debugging the compiler itself).
10952
10953 @option{-fno-verbose-asm}, the default, causes the
10954 extra information to be omitted and is useful when comparing two assembler
10955 files.
10956
10957 @item -fpic
10958 @opindex fpic
10959 @cindex global offset table
10960 @cindex PIC
10961 Generate position-independent code (PIC) suitable for use in a shared
10962 library, if supported for the target machine.  Such code accesses all
10963 constant addresses through a global offset table (GOT)@.  The dynamic
10964 loader resolves the GOT entries when the program starts (the dynamic
10965 loader is not part of GCC; it is part of the operating system).  If
10966 the GOT size for the linked executable exceeds a machine-specific
10967 maximum size, you get an error message from the linker indicating that
10968 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10969 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10970 on the m68k and RS/6000.  The 386 has no such limit.)
10971
10972 Position-independent code requires special support, and therefore works
10973 only on certain machines.  For the 386, GCC supports PIC for System V
10974 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10975 position-independent.
10976
10977 @item -fPIC
10978 @opindex fPIC
10979 If supported for the target machine, emit position-independent code,
10980 suitable for dynamic linking and avoiding any limit on the size of the
10981 global offset table.  This option makes a difference on the m68k, m88k,
10982 and the SPARC.
10983
10984 Position-independent code requires special support, and therefore works
10985 only on certain machines.
10986
10987 @item -ffixed-@var{reg}
10988 @opindex ffixed
10989 Treat the register named @var{reg} as a fixed register; generated code
10990 should never refer to it (except perhaps as a stack pointer, frame
10991 pointer or in some other fixed role).
10992
10993 @var{reg} must be the name of a register.  The register names accepted
10994 are machine-specific and are defined in the @code{REGISTER_NAMES}
10995 macro in the machine description macro file.
10996
10997 This flag does not have a negative form, because it specifies a
10998 three-way choice.
10999
11000 @item -fcall-used-@var{reg}
11001 @opindex fcall-used
11002 Treat the register named @var{reg} as an allocable register that is
11003 clobbered by function calls.  It may be allocated for temporaries or
11004 variables that do not live across a call.  Functions compiled this way
11005 will not save and restore the register @var{reg}.
11006
11007 It is an error to used this flag with the frame pointer or stack pointer.
11008 Use of this flag for other registers that have fixed pervasive roles in
11009 the machine's execution model will produce disastrous results.
11010
11011 This flag does not have a negative form, because it specifies a
11012 three-way choice.
11013
11014 @item -fcall-saved-@var{reg}
11015 @opindex fcall-saved
11016 Treat the register named @var{reg} as an allocable register saved by
11017 functions.  It may be allocated even for temporaries or variables that
11018 live across a call.  Functions compiled this way will save and restore
11019 the register @var{reg} if they use it.
11020
11021 It is an error to used this flag with the frame pointer or stack pointer.
11022 Use of this flag for other registers that have fixed pervasive roles in
11023 the machine's execution model will produce disastrous results.
11024
11025 A different sort of disaster will result from the use of this flag for
11026 a register in which function values may be returned.
11027
11028 This flag does not have a negative form, because it specifies a
11029 three-way choice.
11030
11031 @item -fpack-struct
11032 @opindex fpack-struct
11033 Pack all structure members together without holes.
11034
11035 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11036 code that is not binary compatible with code generated without that switch.
11037 Additionally, it makes the code suboptimal.
11038 Use it to conform to a non-default application binary interface.
11039
11040 @item -finstrument-functions
11041 @opindex finstrument-functions
11042 Generate instrumentation calls for entry and exit to functions.  Just
11043 after function entry and just before function exit, the following
11044 profiling functions will be called with the address of the current
11045 function and its call site.  (On some platforms,
11046 @code{__builtin_return_address} does not work beyond the current
11047 function, so the call site information may not be available to the
11048 profiling functions otherwise.)
11049
11050 @example
11051 void __cyg_profile_func_enter (void *this_fn,
11052                                void *call_site);
11053 void __cyg_profile_func_exit  (void *this_fn,
11054                                void *call_site);
11055 @end example
11056
11057 The first argument is the address of the start of the current function,
11058 which may be looked up exactly in the symbol table.
11059
11060 This instrumentation is also done for functions expanded inline in other
11061 functions.  The profiling calls will indicate where, conceptually, the
11062 inline function is entered and exited.  This means that addressable
11063 versions of such functions must be available.  If all your uses of a
11064 function are expanded inline, this may mean an additional expansion of
11065 code size.  If you use @samp{extern inline} in your C code, an
11066 addressable version of such functions must be provided.  (This is
11067 normally the case anyways, but if you get lucky and the optimizer always
11068 expands the functions inline, you might have gotten away without
11069 providing static copies.)
11070
11071 A function may be given the attribute @code{no_instrument_function}, in
11072 which case this instrumentation will not be done.  This can be used, for
11073 example, for the profiling functions listed above, high-priority
11074 interrupt routines, and any functions from which the profiling functions
11075 cannot safely be called (perhaps signal handlers, if the profiling
11076 routines generate output or allocate memory).
11077
11078 @item -fstack-check
11079 @opindex fstack-check
11080 Generate code to verify that you do not go beyond the boundary of the
11081 stack.  You should specify this flag if you are running in an
11082 environment with multiple threads, but only rarely need to specify it in
11083 a single-threaded environment since stack overflow is automatically
11084 detected on nearly all systems if there is only one stack.
11085
11086 Note that this switch does not actually cause checking to be done; the
11087 operating system must do that.  The switch causes generation of code
11088 to ensure that the operating system sees the stack being extended.
11089
11090 @item -fstack-limit-register=@var{reg}
11091 @itemx -fstack-limit-symbol=@var{sym}
11092 @itemx -fno-stack-limit
11093 @opindex fstack-limit-register
11094 @opindex fstack-limit-symbol
11095 @opindex fno-stack-limit
11096 Generate code to ensure that the stack does not grow beyond a certain value,
11097 either the value of a register or the address of a symbol.  If the stack
11098 would grow beyond the value, a signal is raised.  For most targets,
11099 the signal is raised before the stack overruns the boundary, so
11100 it is possible to catch the signal without taking special precautions.
11101
11102 For instance, if the stack starts at absolute address @samp{0x80000000}
11103 and grows downwards, you can use the flags
11104 @option{-fstack-limit-symbol=__stack_limit} and
11105 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11106 of 128KB@.  Note that this may only work with the GNU linker.
11107
11108 @cindex aliasing of parameters
11109 @cindex parameters, aliased
11110 @item -fargument-alias
11111 @itemx -fargument-noalias
11112 @itemx -fargument-noalias-global
11113 @opindex fargument-alias
11114 @opindex fargument-noalias
11115 @opindex fargument-noalias-global
11116 Specify the possible relationships among parameters and between
11117 parameters and global data.
11118
11119 @option{-fargument-alias} specifies that arguments (parameters) may
11120 alias each other and may alias global storage.@*
11121 @option{-fargument-noalias} specifies that arguments do not alias
11122 each other, but may alias global storage.@*
11123 @option{-fargument-noalias-global} specifies that arguments do not
11124 alias each other and do not alias global storage.
11125
11126 Each language will automatically use whatever option is required by
11127 the language standard.  You should not need to use these options yourself.
11128
11129 @item -fleading-underscore
11130 @opindex fleading-underscore
11131 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11132 change the way C symbols are represented in the object file.  One use
11133 is to help link with legacy assembly code.
11134
11135 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11136 generate code that is not binary compatible with code generated without that
11137 switch.  Use it to conform to a non-default application binary interface.
11138 Not all targets provide complete support for this switch.
11139
11140 @item -ftls-model=@var{model}
11141 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11142 The @var{model} argument should be one of @code{global-dynamic},
11143 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11144
11145 The default without @option{-fpic} is @code{initial-exec}; with
11146 @option{-fpic} the default is @code{global-dynamic}.
11147 @end table
11148
11149 @c man end
11150
11151 @node Environment Variables
11152 @section Environment Variables Affecting GCC
11153 @cindex environment variables
11154
11155 @c man begin ENVIRONMENT
11156
11157 This section describes several environment variables that affect how GCC
11158 operates.  Some of them work by specifying directories or prefixes to use
11159 when searching for various kinds of files.  Some are used to specify other
11160 aspects of the compilation environment.
11161
11162 Note that you can also specify places to search using options such as
11163 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11164 take precedence over places specified using environment variables, which
11165 in turn take precedence over those specified by the configuration of GCC@.
11166 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11167 GNU Compiler Collection (GCC) Internals}.
11168
11169 @table @env
11170 @item LANG
11171 @itemx LC_CTYPE
11172 @c @itemx LC_COLLATE
11173 @itemx LC_MESSAGES
11174 @c @itemx LC_MONETARY
11175 @c @itemx LC_NUMERIC
11176 @c @itemx LC_TIME
11177 @itemx LC_ALL
11178 @findex LANG
11179 @findex LC_CTYPE
11180 @c @findex LC_COLLATE
11181 @findex LC_MESSAGES
11182 @c @findex LC_MONETARY
11183 @c @findex LC_NUMERIC
11184 @c @findex LC_TIME
11185 @findex LC_ALL
11186 @cindex locale
11187 These environment variables control the way that GCC uses
11188 localization information that allow GCC to work with different
11189 national conventions.  GCC inspects the locale categories
11190 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11191 so.  These locale categories can be set to any value supported by your
11192 installation.  A typical value is @samp{en_UK} for English in the United
11193 Kingdom.
11194
11195 The @env{LC_CTYPE} environment variable specifies character
11196 classification.  GCC uses it to determine the character boundaries in
11197 a string; this is needed for some multibyte encodings that contain quote
11198 and escape characters that would otherwise be interpreted as a string
11199 end or escape.
11200
11201 The @env{LC_MESSAGES} environment variable specifies the language to
11202 use in diagnostic messages.
11203
11204 If the @env{LC_ALL} environment variable is set, it overrides the value
11205 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11206 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11207 environment variable.  If none of these variables are set, GCC
11208 defaults to traditional C English behavior.
11209
11210 @item TMPDIR
11211 @findex TMPDIR
11212 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11213 files.  GCC uses temporary files to hold the output of one stage of
11214 compilation which is to be used as input to the next stage: for example,
11215 the output of the preprocessor, which is the input to the compiler
11216 proper.
11217
11218 @item GCC_EXEC_PREFIX
11219 @findex GCC_EXEC_PREFIX
11220 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11221 names of the subprograms executed by the compiler.  No slash is added
11222 when this prefix is combined with the name of a subprogram, but you can
11223 specify a prefix that ends with a slash if you wish.
11224
11225 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11226 an appropriate prefix to use based on the pathname it was invoked with.
11227
11228 If GCC cannot find the subprogram using the specified prefix, it
11229 tries looking in the usual places for the subprogram.
11230
11231 The default value of @env{GCC_EXEC_PREFIX} is
11232 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11233 of @code{prefix} when you ran the @file{configure} script.
11234
11235 Other prefixes specified with @option{-B} take precedence over this prefix.
11236
11237 This prefix is also used for finding files such as @file{crt0.o} that are
11238 used for linking.
11239
11240 In addition, the prefix is used in an unusual way in finding the
11241 directories to search for header files.  For each of the standard
11242 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11243 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11244 replacing that beginning with the specified prefix to produce an
11245 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11246 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11247 These alternate directories are searched first; the standard directories
11248 come next.
11249
11250 @item COMPILER_PATH
11251 @findex COMPILER_PATH
11252 The value of @env{COMPILER_PATH} is a colon-separated list of
11253 directories, much like @env{PATH}.  GCC tries the directories thus
11254 specified when searching for subprograms, if it can't find the
11255 subprograms using @env{GCC_EXEC_PREFIX}.
11256
11257 @item LIBRARY_PATH
11258 @findex LIBRARY_PATH
11259 The value of @env{LIBRARY_PATH} is a colon-separated list of
11260 directories, much like @env{PATH}.  When configured as a native compiler,
11261 GCC tries the directories thus specified when searching for special
11262 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11263 using GCC also uses these directories when searching for ordinary
11264 libraries for the @option{-l} option (but directories specified with
11265 @option{-L} come first).
11266
11267 @item LANG
11268 @findex LANG
11269 @cindex locale definition
11270 This variable is used to pass locale information to the compiler.  One way in
11271 which this information is used is to determine the character set to be used
11272 when character literals, string literals and comments are parsed in C and C++.
11273 When the compiler is configured to allow multibyte characters,
11274 the following values for @env{LANG} are recognized:
11275
11276 @table @samp
11277 @item C-JIS
11278 Recognize JIS characters.
11279 @item C-SJIS
11280 Recognize SJIS characters.
11281 @item C-EUCJP
11282 Recognize EUCJP characters.
11283 @end table
11284
11285 If @env{LANG} is not defined, or if it has some other value, then the
11286 compiler will use mblen and mbtowc as defined by the default locale to
11287 recognize and translate multibyte characters.
11288 @end table
11289
11290 @noindent
11291 Some additional environments variables affect the behavior of the
11292 preprocessor.
11293
11294 @include cppenv.texi
11295
11296 @c man end
11297
11298 @node Precompiled Headers
11299 @section Using Precompiled Headers
11300 @cindex precompiled headers
11301 @cindex speed of compilation
11302
11303 Often large projects have many header files that are included in every
11304 source file.  The time the compiler takes to process these header files
11305 over and over again can account for nearly all of the time required to
11306 build the project.  To make builds faster, GCC allows users to
11307 `precompile' a header file; then, if builds can use the precompiled
11308 header file they will be much faster.
11309
11310 To create a precompiled header file, simply compile it as you would any
11311 other file, if necessary using the @option{-x} option to make the driver
11312 treat it as a C or C++ header file.  You will probably want to use a
11313 tool like @command{make} to keep the precompiled header up-to-date when
11314 the headers it contains change.
11315
11316 A precompiled header file will be searched for when @code{#include} is
11317 seen in the compilation.  As it searches for the included file
11318 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11319 compiler looks for a precompiled header in each directory just before it
11320 looks for the include file in that directory.  The name searched for is
11321 the name specified in the @code{#include} with @samp{.gch} appended.  If
11322 the precompiled header file can't be used, it is ignored.
11323
11324 For instance, if you have @code{#include "all.h"}, and you have
11325 @file{all.h.gch} in the same directory as @file{all.h}, then the
11326 precompiled header file will be used if possible, and the original
11327 header will be used otherwise.
11328
11329 Alternatively, you might decide to put the precompiled header file in a
11330 directory and use @option{-I} to ensure that directory is searched
11331 before (or instead of) the directory containing the original header.
11332 Then, if you want to check that the precompiled header file is always
11333 used, you can put a file of the same name as the original header in this
11334 directory containing an @code{#error} command.
11335
11336 This also works with @option{-include}.  So yet another way to use
11337 precompiled headers, good for projects not designed with precompiled
11338 header files in mind, is to simply take most of the header files used by
11339 a project, include them from another header file, precompile that header
11340 file, and @option{-include} the precompiled header.  If the header files
11341 have guards against multiple inclusion, they will be skipped because
11342 they've already been included (in the precompiled header).
11343
11344 If you need to precompile the same header file for different
11345 languages, targets, or compiler options, you can instead make a
11346 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11347 header in the directory.  (It doesn't matter what you call the files
11348 in the directory, every precompiled header in the directory will be
11349 considered.)  The first precompiled header encountered in the
11350 directory that is valid for this compilation will be used; they're
11351 searched in no particular order.
11352
11353 There are many other possibilities, limited only by your imagination,
11354 good sense, and the constraints of your build system.
11355
11356 A precompiled header file can be used only when these conditions apply:
11357
11358 @itemize
11359 @item
11360 Only one precompiled header can be used in a particular compilation.
11361 @item
11362 A precompiled header can't be used once the first C token is seen.  You
11363 can have preprocessor directives before a precompiled header; you can
11364 even include a precompiled header from inside another header, so long as
11365 there are no C tokens before the @code{#include}.
11366 @item
11367 The precompiled header file must be produced for the same language as
11368 the current compilation.  You can't use a C precompiled header for a C++
11369 compilation.
11370 @item
11371 The precompiled header file must be produced by the same compiler
11372 version and configuration as the current compilation is using.
11373 The easiest way to guarantee this is to use the same compiler binary
11374 for creating and using precompiled headers.
11375 @item
11376 Any macros defined before the precompiled header (including with
11377 @option{-D}) must either be defined in the same way as when the
11378 precompiled header was generated, or must not affect the precompiled
11379 header, which usually means that the they don't appear in the
11380 precompiled header at all.
11381 @item
11382 Certain command-line options must be defined in the same way as when the
11383 precompiled header was generated.  At present, it's not clear which
11384 options are safe to change and which are not; the safest choice is to
11385 use exactly the same options when generating and using the precompiled
11386 header.
11387 @end itemize
11388
11389 For all of these but the last, the compiler will automatically ignore
11390 the precompiled header if the conditions aren't met.  For the last item,
11391 some option changes will cause the precompiled header to be rejected,
11392 but not all incompatible option combinations have yet been found.  If
11393 you find a new incompatible combination, please consider filing a bug
11394 report, see @ref{Bugs}.
11395
11396 @node Running Protoize
11397 @section Running Protoize
11398
11399 The program @code{protoize} is an optional part of GCC@.  You can use
11400 it to add prototypes to a program, thus converting the program to ISO
11401 C in one respect.  The companion program @code{unprotoize} does the
11402 reverse: it removes argument types from any prototypes that are found.
11403
11404 When you run these programs, you must specify a set of source files as
11405 command line arguments.  The conversion programs start out by compiling
11406 these files to see what functions they define.  The information gathered
11407 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11408
11409 After scanning comes actual conversion.  The specified files are all
11410 eligible to be converted; any files they include (whether sources or
11411 just headers) are eligible as well.
11412
11413 But not all the eligible files are converted.  By default,
11414 @code{protoize} and @code{unprotoize} convert only source and header
11415 files in the current directory.  You can specify additional directories
11416 whose files should be converted with the @option{-d @var{directory}}
11417 option.  You can also specify particular files to exclude with the
11418 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11419 directory name matches one of the specified directory names, and its
11420 name within the directory has not been excluded.
11421
11422 Basic conversion with @code{protoize} consists of rewriting most
11423 function definitions and function declarations to specify the types of
11424 the arguments.  The only ones not rewritten are those for varargs
11425 functions.
11426
11427 @code{protoize} optionally inserts prototype declarations at the
11428 beginning of the source file, to make them available for any calls that
11429 precede the function's definition.  Or it can insert prototype
11430 declarations with block scope in the blocks where undeclared functions
11431 are called.
11432
11433 Basic conversion with @code{unprotoize} consists of rewriting most
11434 function declarations to remove any argument types, and rewriting
11435 function definitions to the old-style pre-ISO form.
11436
11437 Both conversion programs print a warning for any function declaration or
11438 definition that they can't convert.  You can suppress these warnings
11439 with @option{-q}.
11440
11441 The output from @code{protoize} or @code{unprotoize} replaces the
11442 original source file.  The original file is renamed to a name ending
11443 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11444 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11445 for DOS) file already exists, then the source file is simply discarded.
11446
11447 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11448 scan the program and collect information about the functions it uses.
11449 So neither of these programs will work until GCC is installed.
11450
11451 Here is a table of the options you can use with @code{protoize} and
11452 @code{unprotoize}.  Each option works with both programs unless
11453 otherwise stated.
11454
11455 @table @code
11456 @item -B @var{directory}
11457 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11458 usual directory (normally @file{/usr/local/lib}).  This file contains
11459 prototype information about standard system functions.  This option
11460 applies only to @code{protoize}.
11461
11462 @item -c @var{compilation-options}
11463 Use @var{compilation-options} as the options when running @command{gcc} to
11464 produce the @samp{.X} files.  The special option @option{-aux-info} is
11465 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11466
11467 Note that the compilation options must be given as a single argument to
11468 @code{protoize} or @code{unprotoize}.  If you want to specify several
11469 @command{gcc} options, you must quote the entire set of compilation options
11470 to make them a single word in the shell.
11471
11472 There are certain @command{gcc} arguments that you cannot use, because they
11473 would produce the wrong kind of output.  These include @option{-g},
11474 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11475 the @var{compilation-options}, they are ignored.
11476
11477 @item -C
11478 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11479 systems) instead of @samp{.c}.  This is convenient if you are converting
11480 a C program to C++.  This option applies only to @code{protoize}.
11481
11482 @item -g
11483 Add explicit global declarations.  This means inserting explicit
11484 declarations at the beginning of each source file for each function
11485 that is called in the file and was not declared.  These declarations
11486 precede the first function definition that contains a call to an
11487 undeclared function.  This option applies only to @code{protoize}.
11488
11489 @item -i @var{string}
11490 Indent old-style parameter declarations with the string @var{string}.
11491 This option applies only to @code{protoize}.
11492
11493 @code{unprotoize} converts prototyped function definitions to old-style
11494 function definitions, where the arguments are declared between the
11495 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11496 uses five spaces as the indentation.  If you want to indent with just
11497 one space instead, use @option{-i " "}.
11498
11499 @item -k
11500 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11501 is finished.
11502
11503 @item -l
11504 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11505 a prototype declaration for each function in each block which calls the
11506 function without any declaration.  This option applies only to
11507 @code{protoize}.
11508
11509 @item -n
11510 Make no real changes.  This mode just prints information about the conversions
11511 that would have been done without @option{-n}.
11512
11513 @item -N
11514 Make no @samp{.save} files.  The original files are simply deleted.
11515 Use this option with caution.
11516
11517 @item -p @var{program}
11518 Use the program @var{program} as the compiler.  Normally, the name
11519 @file{gcc} is used.
11520
11521 @item -q
11522 Work quietly.  Most warnings are suppressed.
11523
11524 @item -v
11525 Print the version number, just like @option{-v} for @command{gcc}.
11526 @end table
11527
11528 If you need special compiler options to compile one of your program's
11529 source files, then you should generate that file's @samp{.X} file
11530 specially, by running @command{gcc} on that source file with the
11531 appropriate options and the option @option{-aux-info}.  Then run
11532 @code{protoize} on the entire set of files.  @code{protoize} will use
11533 the existing @samp{.X} file because it is newer than the source file.
11534 For example:
11535
11536 @example
11537 gcc -Dfoo=bar file1.c -aux-info file1.X
11538 protoize *.c
11539 @end example
11540
11541 @noindent
11542 You need to include the special files along with the rest in the
11543 @code{protoize} command, even though their @samp{.X} files already
11544 exist, because otherwise they won't get converted.
11545
11546 @xref{Protoize Caveats}, for more information on how to use
11547 @code{protoize} successfully.