OSDN Git Service

* doc/invoke.texi: Eliminate extra white-space caused by
[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 -mprototype  -mno-prototype @gol
431 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
432 -msdata=@var{opt}  -mvxworks -mwindiss -G @var{num} -pthread}
433
434 @emph{Darwin Options}
435 @gccoptlist{
436 -all_load -allowable_client -arch -arch_errors_fatal @gol
437 -arch_only -bind_at_load -bundle -bundle_loader @gol
438 -client_name -compatibility_version -current_version @gol
439 -dependency-file -dylib_file -dylinker_install_name @gol
440 -dynamic -dynamiclib -exported_symbols_list @gol
441 -filelist -flat_namespace -force_cpusubtype_ALL @gol
442 -force_flat_namespace -headerpad_max_install_names @gol
443 -image_base -init -install_name -keep_private_externs @gol
444 -multi_module -multiply_defined -multiply_defined_unused @gol
445 -noall_load -nomultidefs -noprebind -noseglinkedit @gol
446 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
447 -private_bundle -read_only_relocs -sectalign @gol
448 -sectobjectsymbols -whyload -seg1addr @gol
449 -sectcreate -sectobjectsymbols -sectorder @gol
450 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
451 -segprot -segs_read_only_addr -segs_read_write_addr @gol
452 -single_module -static -sub_library -sub_umbrella @gol
453 -twolevel_namespace -umbrella -undefined @gol
454 -unexported_symbols_list -weak_reference_mismatches -whatsloaded}
455
456 @emph{RT Options}
457 @gccoptlist{
458 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
459 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
460 -mminimum-fp-blocks  -mnohc-struct-return}
461
462 @emph{MIPS Options}
463 @gccoptlist{
464 -mabicalls -march=@var{cpu-type} -mtune=@var{cpu=type} @gol
465 -mcpu=@var{cpu-type} -membedded-data  -muninit-const-in-rodata @gol
466 -membedded-pic  -mfp32  -mfp64  -mfused-madd  -mno-fused-madd @gol
467 -mgas  -mgp32  -mgp64 @gol
468 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
469 -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
470 -mlong64  -mlong32  -mlong-calls  -mmemcpy @gol
471 -mmips-as  -mmips-tfile  -mno-abicalls @gol
472 -mno-embedded-data  -mno-uninit-const-in-rodata @gol
473 -mno-embedded-pic  -mno-gpopt  -mno-long-calls @gol
474 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
475 -mrnames  -msoft-float @gol
476 -m4650  -msingle-float  -mmad @gol
477 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
478 -mabi=32  -mabi=n32  -mabi=64  -mabi=eabi  -mabi-fake-default @gol
479 -mfix7000  -mno-crt0 -mflush-func=@var{func} -mno-flush-func @gol
480 -mbranch-likely -mno-branch-likely}
481
482 @emph{i386 and x86-64 Options}
483 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
484 -mfpmath=@var{unit} @gol
485 -masm=@var{dialect}  -mno-fancy-math-387 @gol
486 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
487 -mno-wide-multiply  -mrtd  -malign-double @gol
488 -mpreferred-stack-boundary=@var{num} @gol
489 -mmmx  -msse  -msse2  -m3dnow @gol
490 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
491 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
492 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
493 -mno-red-zone @gol
494 -mcmodel=@var{code-model} @gol
495 -m32  -m64}
496
497 @emph{HPPA Options}
498 @gccoptlist{-march=@var{architecture-type} @gol
499 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
500 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
501 -mjump-in-delay -mlinker-opt -mlong-calls @gol
502 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
503 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
504 -mno-jump-in-delay  -mno-long-load-store @gol
505 -mno-portable-runtime  -mno-soft-float @gol
506 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
507 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
508 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio}
509
510 @emph{Intel 960 Options}
511 @gccoptlist{-m@var{cpu-type}  -masm-compat  -mclean-linkage @gol
512 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
513 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
514 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
515 -mno-complex-addr  -mno-leaf-procedures @gol
516 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
517 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
518 -mtail-call}
519
520 @emph{DEC Alpha Options}
521 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
522 -mieee  -mieee-with-inexact  -mieee-conformant @gol
523 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
524 -mtrap-precision=@var{mode}  -mbuild-constants @gol
525 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
526 -mbwx  -mmax  -mfix  -mcix @gol
527 -mfloat-vax  -mfloat-ieee @gol
528 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
529 -msmall-text  -mlarge-text @gol
530 -mmemory-latency=@var{time}}
531
532 @emph{DEC Alpha/VMS Options}
533 @gccoptlist{-mvms-return-codes}
534
535 @emph{H8/300 Options}
536 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
537
538 @emph{SH Options}
539 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
540 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
541 -m5-64media  -m5-64media-nofpu @gol
542 -m5-32media  -m5-32media-nofpu @gol
543 -m5-compact  -m5-compact-nofpu @gol
544 -mb  -ml  -mdalign  -mrelax @gol
545 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
546 -mieee  -misize  -mpadstruct  -mspace @gol
547 -mprefergot  -musermode}
548
549 @emph{System V Options}
550 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
551
552 @emph{ARC Options}
553 @gccoptlist{-EB  -EL @gol
554 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
555 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
556
557 @emph{TMS320C3x/C4x Options}
558 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
559 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
560 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
561 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
562
563 @emph{V850 Options}
564 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
565 -mprolog-function  -mno-prolog-function  -mspace @gol
566 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
567 -mapp-regs  -mno-app-regs @gol
568 -mdisable-callt  -mno-disable-callt @gol
569 -mv850e @gol
570 -mv850  -mbig-switch}
571
572 @emph{NS32K Options}
573 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
574 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
575 -mregparam  -mnoregparam  -msb  -mnosb @gol
576 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
577
578 @emph{AVR Options}
579 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
580 -mcall-prologues  -mno-tablejump  -mtiny-stack}
581
582 @emph{MCore Options}
583 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
584 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
585 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
586 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
587 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
588
589 @emph{MMIX Options}
590 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
591 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
592 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
593 -mno-base-addresses  -msingle-exit  -mno-single-exit}
594
595 @emph{IA-64 Options}
596 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
597 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
598 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
599 -minline-float-divide-max-throughput @gol
600 -minline-int-divide-min-latency @gol
601 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
602 -mfixed-range=@var{register-range}}
603
604 @emph{D30V Options}
605 @gccoptlist{-mextmem  -mextmemory  -monchip  -mno-asm-optimize @gol
606 -masm-optimize  -mbranch-cost=@var{n}  -mcond-exec=@var{n}}
607
608 @emph{S/390 and zSeries Options}
609 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
610 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
611 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
612 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch}
613
614 @emph{CRIS Options}
615 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
616 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
617 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
618 -mstack-align  -mdata-align  -mconst-align @gol
619 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
620 -melf  -maout  -melinux  -mlinux  -sim  -sim2}
621
622 @emph{PDP-11 Options}
623 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
624 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
625 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
626 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
627 -mbranch-expensive  -mbranch-cheap @gol
628 -msplit  -mno-split  -munix-asm  -mdec-asm}
629
630 @emph{Xstormy16 Options}
631 @gccoptlist{-msim}
632
633 @emph{Xtensa Options}
634 @gccoptlist{-mbig-endian  -mlittle-endian @gol
635 -mdensity  -mno-density @gol
636 -mmac16  -mno-mac16 @gol
637 -mmul16  -mno-mul16 @gol
638 -mmul32  -mno-mul32 @gol
639 -mnsa  -mno-nsa @gol
640 -mminmax  -mno-minmax @gol
641 -msext  -mno-sext @gol
642 -mbooleans  -mno-booleans @gol
643 -mhard-float  -msoft-float @gol
644 -mfused-madd  -mno-fused-madd @gol
645 -mserialize-volatile  -mno-serialize-volatile @gol
646 -mtext-section-literals  -mno-text-section-literals @gol
647 -mtarget-align  -mno-target-align @gol
648 -mlongcalls  -mno-longcalls}
649
650 @emph{FRV Options}
651 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
652 -mhard-float  -msoft-float @gol
653 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
654 -mdouble  -mno-double @gol
655 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
656 -mlibrary-pic  -macc-4 -macc-8 @gol
657 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
658 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
659 -mvliw-branch  -mno-vliw-branch @gol
660 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
661 -mno-nested-cond-exec  -mtomcat-stats @gol
662 -mcpu=@var{cpu}}
663
664 @item Code Generation Options
665 @xref{Code Gen Options,,Options for Code Generation Conventions}.
666 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
667 -ffixed-@var{reg}  -fexceptions @gol
668 -fnon-call-exceptions  -funwind-tables @gol
669 -fasynchronous-unwind-tables  -fforced-unwind-exceptions @gol
670 -finhibit-size-directive  -finstrument-functions @gol
671 -fno-common  -fno-ident  -fno-gnu-linker @gol
672 -fpcc-struct-return  -fpic  -fPIC @gol
673 -freg-struct-return  -fshared-data  -fshort-enums @gol
674 -fshort-double  -fshort-wchar @gol
675 -fverbose-asm  -fpack-struct  -fstack-check @gol
676 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
677 -fargument-alias  -fargument-noalias @gol
678 -fargument-noalias-global  -fleading-underscore @gol
679 -ftls-model=@var{model} @gol
680 -ftrapv  -fbounds-check}
681 @end table
682
683 @menu
684 * Overall Options::     Controlling the kind of output:
685                         an executable, object files, assembler files,
686                         or preprocessed source.
687 * C Dialect Options::   Controlling the variant of C language compiled.
688 * C++ Dialect Options:: Variations on C++.
689 * Objective-C Dialect Options:: Variations on Objective-C.
690 * Language Independent Options:: Controlling how diagnostics should be
691                         formatted.
692 * Warning Options::     How picky should the compiler be?
693 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
694 * Optimize Options::    How much optimization?
695 * Preprocessor Options:: Controlling header files and macro definitions.
696                          Also, getting dependency information for Make.
697 * Assembler Options::   Passing options to the assembler.
698 * Link Options::        Specifying libraries and so on.
699 * Directory Options::   Where to find header files and libraries.
700                         Where to find the compiler executable files.
701 * Spec Files::          How to pass switches to sub-processes.
702 * Target Options::      Running a cross-compiler, or an old version of GCC.
703 @end menu
704
705 @node Overall Options
706 @section Options Controlling the Kind of Output
707
708 Compilation can involve up to four stages: preprocessing, compilation
709 proper, assembly and linking, always in that order.  The first three
710 stages apply to an individual source file, and end by producing an
711 object file; linking combines all the object files (those newly
712 compiled, and those specified as input) into an executable file.
713
714 @cindex file name suffix
715 For any given input file, the file name suffix determines what kind of
716 compilation is done:
717
718 @table @gcctabopt
719 @item @var{file}.c
720 C source code which must be preprocessed.
721
722 @item @var{file}.i
723 C source code which should not be preprocessed.
724
725 @item @var{file}.ii
726 C++ source code which should not be preprocessed.
727
728 @item @var{file}.m
729 Objective-C source code.  Note that you must link with the library
730 @file{libobjc.a} to make an Objective-C program work.
731
732 @item @var{file}.mi
733 Objective-C source code which should not be preprocessed.
734
735 @item @var{file}.h
736 C or C++ header file to be turned into a precompiled header.
737
738 @item @var{file}.cc
739 @itemx @var{file}.cp
740 @itemx @var{file}.cxx
741 @itemx @var{file}.cpp
742 @itemx @var{file}.CPP
743 @itemx @var{file}.c++
744 @itemx @var{file}.C
745 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
746 the last two letters must both be literally @samp{x}.  Likewise,
747 @samp{.C} refers to a literal capital C@.
748
749 @item @var{file}.hh
750 @itemx @var{file}.H
751 C++ header file to be turned into a precompiled header.
752
753 @item @var{file}.f
754 @itemx @var{file}.for
755 @itemx @var{file}.FOR
756 Fortran source code which should not be preprocessed.
757
758 @item @var{file}.F
759 @itemx @var{file}.fpp
760 @itemx @var{file}.FPP
761 Fortran source code which must be preprocessed (with the traditional
762 preprocessor).
763
764 @item @var{file}.r
765 Fortran source code which must be preprocessed with a RATFOR
766 preprocessor (not included with GCC)@.
767
768 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
769 Using and Porting GNU Fortran}, for more details of the handling of
770 Fortran input files.
771
772 @c FIXME: Descriptions of Java file types.
773 @c @var{file}.java
774 @c @var{file}.class
775 @c @var{file}.zip
776 @c @var{file}.jar
777
778 @item @var{file}.ads
779 Ada source code file which contains a library unit declaration (a
780 declaration of a package, subprogram, or generic, or a generic
781 instantiation), or a library unit renaming declaration (a package,
782 generic, or subprogram renaming declaration).  Such files are also
783 called @dfn{specs}.
784
785 @itemx @var{file}.adb
786 Ada source code file containing a library unit body (a subprogram or
787 package body).  Such files are also called @dfn{bodies}.
788
789 @c GCC also knows about some suffixes for languages not yet included:
790 @c Pascal:
791 @c @var{file}.p
792 @c @var{file}.pas
793
794 @item @var{file}.s
795 Assembler code.
796
797 @item @var{file}.S
798 Assembler code which must be preprocessed.
799
800 @item @var{other}
801 An object file to be fed straight into linking.
802 Any file name with no recognized suffix is treated this way.
803 @end table
804
805 @opindex x
806 You can specify the input language explicitly with the @option{-x} option:
807
808 @table @gcctabopt
809 @item -x @var{language}
810 Specify explicitly the @var{language} for the following input files
811 (rather than letting the compiler choose a default based on the file
812 name suffix).  This option applies to all following input files until
813 the next @option{-x} option.  Possible values for @var{language} are:
814 @example
815 c  c-header  cpp-output
816 c++  c++-header  c++-cpp-output
817 objective-c  objc-cpp-output
818 assembler  assembler-with-cpp
819 ada
820 f77  f77-cpp-input  ratfor
821 java
822 treelang
823 @end example
824
825 @item -x none
826 Turn off any specification of a language, so that subsequent files are
827 handled according to their file name suffixes (as they are if @option{-x}
828 has not been used at all).
829
830 @item -pass-exit-codes
831 @opindex pass-exit-codes
832 Normally the @command{gcc} program will exit with the code of 1 if any
833 phase of the compiler returns a non-success return code.  If you specify
834 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
835 numerically highest error produced by any phase that returned an error
836 indication.
837 @end table
838
839 If you only want some of the stages of compilation, you can use
840 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
841 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
842 @command{gcc} is to stop.  Note that some combinations (for example,
843 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
844
845 @table @gcctabopt
846 @item -c
847 @opindex c
848 Compile or assemble the source files, but do not link.  The linking
849 stage simply is not done.  The ultimate output is in the form of an
850 object file for each source file.
851
852 By default, the object file name for a source file is made by replacing
853 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
854
855 Unrecognized input files, not requiring compilation or assembly, are
856 ignored.
857
858 @item -S
859 @opindex S
860 Stop after the stage of compilation proper; do not assemble.  The output
861 is in the form of an assembler code file for each non-assembler input
862 file specified.
863
864 By default, the assembler file name for a source file is made by
865 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
866
867 Input files that don't require compilation are ignored.
868
869 @item -E
870 @opindex E
871 Stop after the preprocessing stage; do not run the compiler proper.  The
872 output is in the form of preprocessed source code, which is sent to the
873 standard output.
874
875 Input files which don't require preprocessing are ignored.
876
877 @cindex output file option
878 @item -o @var{file}
879 @opindex o
880 Place output in file @var{file}.  This applies regardless to whatever
881 sort of output is being produced, whether it be an executable file,
882 an object file, an assembler file or preprocessed C code.
883
884 Since only one output file can be specified, it does not make sense to
885 use @option{-o} when compiling more than one input file, unless you are
886 producing an executable file as output.
887
888 If @option{-o} is not specified, the default is to put an executable file
889 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
890 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
891 all preprocessed C source on standard output.
892
893 @item -v
894 @opindex v
895 Print (on standard error output) the commands executed to run the stages
896 of compilation.  Also print the version number of the compiler driver
897 program and of the preprocessor and the compiler proper.
898
899 @item -###
900 @opindex ###
901 Like @option{-v} except the commands are not executed and all command
902 arguments are quoted.  This is useful for shell scripts to capture the
903 driver-generated command lines.
904
905 @item -pipe
906 @opindex pipe
907 Use pipes rather than temporary files for communication between the
908 various stages of compilation.  This fails to work on some systems where
909 the assembler is unable to read from a pipe; but the GNU assembler has
910 no trouble.
911
912 @item --help
913 @opindex help
914 Print (on the standard output) a description of the command line options
915 understood by @command{gcc}.  If the @option{-v} option is also specified
916 then @option{--help} will also be passed on to the various processes
917 invoked by @command{gcc}, so that they can display the command line options
918 they accept.  If the @option{-Wextra} option is also specified then command
919 line options which have no documentation associated with them will also
920 be displayed.
921
922 @item --target-help
923 @opindex target-help
924 Print (on the standard output) a description of target specific command
925 line options for each tool.
926
927 @item --version
928 @opindex version
929 Display the version number and copyrights of the invoked GCC.
930 @end table
931
932 @node Invoking G++
933 @section Compiling C++ Programs
934
935 @cindex suffixes for C++ source
936 @cindex C++ source file suffixes
937 C++ source files conventionally use one of the suffixes @samp{.C},
938 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
939 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
940 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
941 files with these names and compiles them as C++ programs even if you
942 call the compiler the same way as for compiling C programs (usually
943 with the name @command{gcc}).
944
945 @findex g++
946 @findex c++
947 However, C++ programs often require class libraries as well as a
948 compiler that understands the C++ language---and under some
949 circumstances, you might want to compile programs or header files from
950 standard input, or otherwise without a suffix that flags them as C++
951 programs.  You might also like to precompile a C header file with a
952 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
953 program that calls GCC with the default language set to C++, and
954 automatically specifies linking against the C++ library.  On many
955 systems, @command{g++} is also installed with the name @command{c++}.
956
957 @cindex invoking @command{g++}
958 When you compile C++ programs, you may specify many of the same
959 command-line options that you use for compiling programs in any
960 language; or command-line options meaningful for C and related
961 languages; or options that are meaningful only for C++ programs.
962 @xref{C Dialect Options,,Options Controlling C Dialect}, for
963 explanations of options for languages related to C@.
964 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
965 explanations of options that are meaningful only for C++ programs.
966
967 @node C Dialect Options
968 @section Options Controlling C Dialect
969 @cindex dialect options
970 @cindex language dialect options
971 @cindex options, dialect
972
973 The following options control the dialect of C (or languages derived
974 from C, such as C++ and Objective-C) that the compiler accepts:
975
976 @table @gcctabopt
977 @cindex ANSI support
978 @cindex ISO support
979 @item -ansi
980 @opindex ansi
981 In C mode, support all ISO C90 programs.  In C++ mode,
982 remove GNU extensions that conflict with ISO C++.
983
984 This turns off certain features of GCC that are incompatible with ISO
985 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
986 such as the @code{asm} and @code{typeof} keywords, and
987 predefined macros such as @code{unix} and @code{vax} that identify the
988 type of system you are using.  It also enables the undesirable and
989 rarely used ISO trigraph feature.  For the C compiler,
990 it disables recognition of C++ style @samp{//} comments as well as
991 the @code{inline} keyword.
992
993 The alternate keywords @code{__asm__}, @code{__extension__},
994 @code{__inline__} and @code{__typeof__} continue to work despite
995 @option{-ansi}.  You would not want to use them in an ISO C program, of
996 course, but it is useful to put them in header files that might be included
997 in compilations done with @option{-ansi}.  Alternate predefined macros
998 such as @code{__unix__} and @code{__vax__} are also available, with or
999 without @option{-ansi}.
1000
1001 The @option{-ansi} option does not cause non-ISO programs to be
1002 rejected gratuitously.  For that, @option{-pedantic} is required in
1003 addition to @option{-ansi}.  @xref{Warning Options}.
1004
1005 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1006 option is used.  Some header files may notice this macro and refrain
1007 from declaring certain functions or defining certain macros that the
1008 ISO standard doesn't call for; this is to avoid interfering with any
1009 programs that might use these names for other things.
1010
1011 Functions which would normally be built in but do not have semantics
1012 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1013 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1014 built-in functions provided by GCC}, for details of the functions
1015 affected.
1016
1017 @item -std=
1018 @opindex std
1019 Determine the language standard.  This option is currently only
1020 supported when compiling C or C++.  A value for this option must be
1021 provided; possible values are
1022
1023 @table @samp
1024 @item c89
1025 @itemx iso9899:1990
1026 ISO C90 (same as @option{-ansi}).
1027
1028 @item iso9899:199409
1029 ISO C90 as modified in amendment 1.
1030
1031 @item c99
1032 @itemx c9x
1033 @itemx iso9899:1999
1034 @itemx iso9899:199x
1035 ISO C99.  Note that this standard is not yet fully supported; see
1036 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1037 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1038
1039 @item gnu89
1040 Default, ISO C90 plus GNU extensions (including some C99 features).
1041
1042 @item gnu99
1043 @item gnu9x
1044 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1045 this will become the default.  The name @samp{gnu9x} is deprecated.
1046
1047 @item c++98
1048 The 1998 ISO C++ standard plus amendments.
1049
1050 @item gnu++98
1051 The same as @option{-std=c++98} plus GNU extensions.  This is the
1052 default for C++ code.
1053 @end table
1054
1055 Even when this option is not specified, you can still use some of the
1056 features of newer standards in so far as they do not conflict with
1057 previous C standards.  For example, you may use @code{__restrict__} even
1058 when @option{-std=c99} is not specified.
1059
1060 The @option{-std} options specifying some version of ISO C have the same
1061 effects as @option{-ansi}, except that features that were not in ISO C90
1062 but are in the specified version (for example, @samp{//} comments and
1063 the @code{inline} keyword in ISO C99) are not disabled.
1064
1065 @xref{Standards,,Language Standards Supported by GCC}, for details of
1066 these standard versions.
1067
1068 @item -aux-info @var{filename}
1069 @opindex aux-info
1070 Output to the given filename prototyped declarations for all functions
1071 declared and/or defined in a translation unit, including those in header
1072 files.  This option is silently ignored in any language other than C@.
1073
1074 Besides declarations, the file indicates, in comments, the origin of
1075 each declaration (source file and line), whether the declaration was
1076 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1077 @samp{O} for old, respectively, in the first character after the line
1078 number and the colon), and whether it came from a declaration or a
1079 definition (@samp{C} or @samp{F}, respectively, in the following
1080 character).  In the case of function definitions, a K&R-style list of
1081 arguments followed by their declarations is also provided, inside
1082 comments, after the declaration.
1083
1084 @item -fno-asm
1085 @opindex fno-asm
1086 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1087 keyword, so that code can use these words as identifiers.  You can use
1088 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1089 instead.  @option{-ansi} implies @option{-fno-asm}.
1090
1091 In C++, this switch only affects the @code{typeof} keyword, since
1092 @code{asm} and @code{inline} are standard keywords.  You may want to
1093 use the @option{-fno-gnu-keywords} flag instead, which has the same
1094 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1095 switch only affects the @code{asm} and @code{typeof} keywords, since
1096 @code{inline} is a standard keyword in ISO C99.
1097
1098 @item -fno-builtin
1099 @itemx -fno-builtin-@var{function}
1100 @opindex fno-builtin
1101 @cindex built-in functions
1102 Don't recognize built-in functions that do not begin with
1103 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1104 functions provided by GCC}, for details of the functions affected,
1105 including those which are not built-in functions when @option{-ansi} or
1106 @option{-std} options for strict ISO C conformance are used because they
1107 do not have an ISO standard meaning.
1108
1109 GCC normally generates special code to handle certain built-in functions
1110 more efficiently; for instance, calls to @code{alloca} may become single
1111 instructions that adjust the stack directly, and calls to @code{memcpy}
1112 may become inline copy loops.  The resulting code is often both smaller
1113 and faster, but since the function calls no longer appear as such, you
1114 cannot set a breakpoint on those calls, nor can you change the behavior
1115 of the functions by linking with a different library.
1116
1117 With the @option{-fno-builtin-@var{function}} option
1118 only the built-in function @var{function} is
1119 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1120 function is named this is not built-in in this version of GCC, this
1121 option is ignored.  There is no corresponding
1122 @option{-fbuiltin-@var{function}} option; if you wish to enable
1123 built-in functions selectively when using @option{-fno-builtin} or
1124 @option{-ffreestanding}, you may define macros such as:
1125
1126 @smallexample
1127 #define abs(n)          __builtin_abs ((n))
1128 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1129 @end smallexample
1130
1131 @item -fhosted
1132 @opindex fhosted
1133 @cindex hosted environment
1134
1135 Assert that compilation takes place in a hosted environment.  This implies
1136 @option{-fbuiltin}.  A hosted environment is one in which the
1137 entire standard library is available, and in which @code{main} has a return
1138 type of @code{int}.  Examples are nearly everything except a kernel.
1139 This is equivalent to @option{-fno-freestanding}.
1140
1141 @item -ffreestanding
1142 @opindex ffreestanding
1143 @cindex hosted environment
1144
1145 Assert that compilation takes place in a freestanding environment.  This
1146 implies @option{-fno-builtin}.  A freestanding environment
1147 is one in which the standard library may not exist, and program startup may
1148 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1149 This is equivalent to @option{-fno-hosted}.
1150
1151 @xref{Standards,,Language Standards Supported by GCC}, for details of
1152 freestanding and hosted environments.
1153
1154 @item -fms-extensions
1155 @opindex fms-extensions
1156 Accept some non-standard constructs used in Microsoft header files.
1157
1158 @item -trigraphs
1159 @opindex trigraphs
1160 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1161 options for strict ISO C conformance) implies @option{-trigraphs}.
1162
1163 @item -no-integrated-cpp
1164 @opindex no-integrated-cpp
1165 Performs a compilation in two passes: preprocessing and compiling.  This
1166 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1167 @option{-B} option. The user supplied compilation step can then add in
1168 an additional preprocessing step after normal preprocessing but before
1169 compiling. The default is to use the integrated cpp (internal cpp)
1170
1171 The semantics of this option will change if "cc1", "cc1plus", and
1172 "cc1obj" are merged.
1173
1174 @cindex traditional C language
1175 @cindex C language, traditional
1176 @item -traditional
1177 @itemx -traditional-cpp
1178 @opindex traditional-cpp
1179 @opindex traditional
1180 Formerly, these options caused GCC to attempt to emulate a pre-standard
1181 C compiler.  They are now only supported with the @option{-E} switch.
1182 The preprocessor continues to support a pre-standard mode.  See the GNU
1183 CPP manual for details.
1184
1185 @item -fcond-mismatch
1186 @opindex fcond-mismatch
1187 Allow conditional expressions with mismatched types in the second and
1188 third arguments.  The value of such an expression is void.  This option
1189 is not supported for C++.
1190
1191 @item -funsigned-char
1192 @opindex funsigned-char
1193 Let the type @code{char} be unsigned, like @code{unsigned char}.
1194
1195 Each kind of machine has a default for what @code{char} should
1196 be.  It is either like @code{unsigned char} by default or like
1197 @code{signed char} by default.
1198
1199 Ideally, a portable program should always use @code{signed char} or
1200 @code{unsigned char} when it depends on the signedness of an object.
1201 But many programs have been written to use plain @code{char} and
1202 expect it to be signed, or expect it to be unsigned, depending on the
1203 machines they were written for.  This option, and its inverse, let you
1204 make such a program work with the opposite default.
1205
1206 The type @code{char} is always a distinct type from each of
1207 @code{signed char} or @code{unsigned char}, even though its behavior
1208 is always just like one of those two.
1209
1210 @item -fsigned-char
1211 @opindex fsigned-char
1212 Let the type @code{char} be signed, like @code{signed char}.
1213
1214 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1215 the negative form of @option{-funsigned-char}.  Likewise, the option
1216 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1217
1218 @item -fsigned-bitfields
1219 @itemx -funsigned-bitfields
1220 @itemx -fno-signed-bitfields
1221 @itemx -fno-unsigned-bitfields
1222 @opindex fsigned-bitfields
1223 @opindex funsigned-bitfields
1224 @opindex fno-signed-bitfields
1225 @opindex fno-unsigned-bitfields
1226 These options control whether a bit-field is signed or unsigned, when the
1227 declaration does not use either @code{signed} or @code{unsigned}.  By
1228 default, such a bit-field is signed, because this is consistent: the
1229 basic integer types such as @code{int} are signed types.
1230
1231 @item -fwritable-strings
1232 @opindex fwritable-strings
1233 Store string constants in the writable data segment and don't uniquize
1234 them.  This is for compatibility with old programs which assume they can
1235 write into string constants.
1236
1237 Writing into string constants is a very bad idea; ``constants'' should
1238 be constant.
1239 @end table
1240
1241 @node C++ Dialect Options
1242 @section Options Controlling C++ Dialect
1243
1244 @cindex compiler options, C++
1245 @cindex C++ options, command line
1246 @cindex options, C++
1247 This section describes the command-line options that are only meaningful
1248 for C++ programs; but you can also use most of the GNU compiler options
1249 regardless of what language your program is in.  For example, you
1250 might compile a file @code{firstClass.C} like this:
1251
1252 @example
1253 g++ -g -frepo -O -c firstClass.C
1254 @end example
1255
1256 @noindent
1257 In this example, only @option{-frepo} is an option meant
1258 only for C++ programs; you can use the other options with any
1259 language supported by GCC@.
1260
1261 Here is a list of options that are @emph{only} for compiling C++ programs:
1262
1263 @table @gcctabopt
1264
1265 @item -fabi-version=@var{n}
1266 @opindex fabi-version
1267 Use version @var{n} of the C++ ABI.  Version 1 is the version of the C++
1268 ABI that first appeared in G++ 3.2.  Version 0 will always be the
1269 version that conforms most closely to the C++ ABI specification.
1270 Therefore, the ABI obtained using version 0 will change as ABI bugs are
1271 fixed.
1272
1273 The default is version 1.
1274
1275 @item -fno-access-control
1276 @opindex fno-access-control
1277 Turn off all access checking.  This switch is mainly useful for working
1278 around bugs in the access control code.
1279
1280 @item -fcheck-new
1281 @opindex fcheck-new
1282 Check that the pointer returned by @code{operator new} is non-null
1283 before attempting to modify the storage allocated.  The current Working
1284 Paper requires that @code{operator new} never return a null pointer, so
1285 this check is normally unnecessary.
1286
1287 An alternative to using this option is to specify that your
1288 @code{operator new} does not throw any exceptions; if you declare it
1289 @samp{throw()}, G++ will check the return value.  See also @samp{new
1290 (nothrow)}.
1291
1292 @item -fconserve-space
1293 @opindex fconserve-space
1294 Put uninitialized or runtime-initialized global variables into the
1295 common segment, as C does.  This saves space in the executable at the
1296 cost of not diagnosing duplicate definitions.  If you compile with this
1297 flag and your program mysteriously crashes after @code{main()} has
1298 completed, you may have an object that is being destroyed twice because
1299 two definitions were merged.
1300
1301 This option is no longer useful on most targets, now that support has
1302 been added for putting variables into BSS without making them common.
1303
1304 @item -fno-const-strings
1305 @opindex fno-const-strings
1306 Give string constants type @code{char *} instead of type @code{const
1307 char *}.  By default, G++ uses type @code{const char *} as required by
1308 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1309 actually modify the value of a string constant, unless you also use
1310 @option{-fwritable-strings}.
1311
1312 This option might be removed in a future release of G++.  For maximum
1313 portability, you should structure your code so that it works with
1314 string constants that have type @code{const char *}.
1315
1316 @item -fdollars-in-identifiers
1317 @opindex fdollars-in-identifiers
1318 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1319 @samp{$} with the option @option{-fno-dollars-in-identifiers}.  (GNU C allows
1320 @samp{$} by default on most target systems, but there are a few exceptions.)
1321 Traditional C allowed the character @samp{$} to form part of
1322 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1323
1324 @item -fno-elide-constructors
1325 @opindex fno-elide-constructors
1326 The C++ standard allows an implementation to omit creating a temporary
1327 which is only used to initialize another object of the same type.
1328 Specifying this option disables that optimization, and forces G++ to
1329 call the copy constructor in all cases.
1330
1331 @item -fno-enforce-eh-specs
1332 @opindex fno-enforce-eh-specs
1333 Don't check for violation of exception specifications at runtime.  This
1334 option violates the C++ standard, but may be useful for reducing code
1335 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1336 will still optimize based on the exception specifications.
1337
1338 @item -fexternal-templates
1339 @opindex fexternal-templates
1340
1341 Cause @samp{#pragma interface} and @samp{implementation} to apply to
1342 template instantiation; template instances are emitted or not according
1343 to the location of the template definition.  @xref{Template
1344 Instantiation}, for more information.
1345
1346 This option is deprecated.
1347
1348 @item -falt-external-templates
1349 @opindex falt-external-templates
1350 Similar to @option{-fexternal-templates}, but template instances are
1351 emitted or not according to the place where they are first instantiated.
1352 @xref{Template Instantiation}, for more information.
1353
1354 This option is deprecated.
1355
1356 @item -ffor-scope
1357 @itemx -fno-for-scope
1358 @opindex ffor-scope
1359 @opindex fno-for-scope
1360 If @option{-ffor-scope} is specified, the scope of variables declared in
1361 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1362 as specified by the C++ standard.
1363 If @option{-fno-for-scope} is specified, the scope of variables declared in
1364 a @i{for-init-statement} extends to the end of the enclosing scope,
1365 as was the case in old versions of G++, and other (traditional)
1366 implementations of C++.
1367
1368 The default if neither flag is given to follow the standard,
1369 but to allow and give a warning for old-style code that would
1370 otherwise be invalid, or have different behavior.
1371
1372 @item -fno-gnu-keywords
1373 @opindex fno-gnu-keywords
1374 Do not recognize @code{typeof} as a keyword, so that code can use this
1375 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1376 @option{-ansi} implies @option{-fno-gnu-keywords}.
1377
1378 @item -fno-implicit-templates
1379 @opindex fno-implicit-templates
1380 Never emit code for non-inline templates which are instantiated
1381 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1382 @xref{Template Instantiation}, for more information.
1383
1384 @item -fno-implicit-inline-templates
1385 @opindex fno-implicit-inline-templates
1386 Don't emit code for implicit instantiations of inline templates, either.
1387 The default is to handle inlines differently so that compiles with and
1388 without optimization will need the same set of explicit instantiations.
1389
1390 @item -fno-implement-inlines
1391 @opindex fno-implement-inlines
1392 To save space, do not emit out-of-line copies of inline functions
1393 controlled by @samp{#pragma implementation}.  This will cause linker
1394 errors if these functions are not inlined everywhere they are called.
1395
1396 @item -fms-extensions
1397 @opindex fms-extensions
1398 Disable pedantic warnings about constructs used in MFC, such as implicit
1399 int and getting a pointer to member function via non-standard syntax.
1400
1401 @item -fno-nonansi-builtins
1402 @opindex fno-nonansi-builtins
1403 Disable built-in declarations of functions that are not mandated by
1404 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1405 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1406
1407 @item -fno-operator-names
1408 @opindex fno-operator-names
1409 Do not treat the operator name keywords @code{and}, @code{bitand},
1410 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1411 synonyms as keywords.
1412
1413 @item -fno-optional-diags
1414 @opindex fno-optional-diags
1415 Disable diagnostics that the standard says a compiler does not need to
1416 issue.  Currently, the only such diagnostic issued by G++ is the one for
1417 a name having multiple meanings within a class.
1418
1419 @item -fpermissive
1420 @opindex fpermissive
1421 Downgrade messages about nonconformant code from errors to warnings.  By
1422 default, G++ effectively sets @option{-pedantic-errors} without
1423 @option{-pedantic}; this option reverses that.  This behavior and this
1424 option are superseded by @option{-pedantic}, which works as it does for GNU C@.
1425
1426 @item -frepo
1427 @opindex frepo
1428 Enable automatic template instantiation at link time.  This option also
1429 implies @option{-fno-implicit-templates}.  @xref{Template
1430 Instantiation}, for more information.
1431
1432 @item -fno-rtti
1433 @opindex fno-rtti
1434 Disable generation of information about every class with virtual
1435 functions for use by the C++ runtime type identification features
1436 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1437 of the language, you can save some space by using this flag.  Note that
1438 exception handling uses the same information, but it will generate it as
1439 needed.
1440
1441 @item -fstats
1442 @opindex fstats
1443 Emit statistics about front-end processing at the end of the compilation.
1444 This information is generally only useful to the G++ development team.
1445
1446 @item -ftemplate-depth-@var{n}
1447 @opindex ftemplate-depth
1448 Set the maximum instantiation depth for template classes to @var{n}.
1449 A limit on the template instantiation depth is needed to detect
1450 endless recursions during template class instantiation.  ANSI/ISO C++
1451 conforming programs must not rely on a maximum depth greater than 17.
1452
1453 @item -fuse-cxa-atexit
1454 @opindex fuse-cxa-atexit
1455 Register destructors for objects with static storage duration with the
1456 @code{__cxa_atexit} function rather than the @code{atexit} function.
1457 This option is required for fully standards-compliant handling of static
1458 destructors, but will only work if your C library supports
1459 @code{__cxa_atexit}.
1460
1461 @item -fvtable-gc
1462 @opindex fvtable-gc
1463 Emit special relocations for vtables and virtual function references
1464 so that the linker can identify unused virtual functions and zero out
1465 vtable slots that refer to them.  This is most useful with
1466 @option{-ffunction-sections} and @option{-Wl,--gc-sections}, in order to
1467 also discard the functions themselves.
1468
1469 This optimization requires GNU as and GNU ld.  Not all systems support
1470 this option.  @option{-Wl,--gc-sections} is ignored without @option{-static}.
1471
1472 @item -fno-weak
1473 @opindex fno-weak
1474 Do not use weak symbol support, even if it is provided by the linker.
1475 By default, G++ will use weak symbols if they are available.  This
1476 option exists only for testing, and should not be used by end-users;
1477 it will result in inferior code and has no benefits.  This option may
1478 be removed in a future release of G++.
1479
1480 @item -nostdinc++
1481 @opindex nostdinc++
1482 Do not search for header files in the standard directories specific to
1483 C++, but do still search the other standard directories.  (This option
1484 is used when building the C++ library.)
1485 @end table
1486
1487 In addition, these optimization, warning, and code generation options
1488 have meanings only for C++ programs:
1489
1490 @table @gcctabopt
1491 @item -fno-default-inline
1492 @opindex fno-default-inline
1493 Do not assume @samp{inline} for functions defined inside a class scope.
1494 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1495 functions will have linkage like inline functions; they just won't be
1496 inlined by default.
1497
1498 @item -Wabi @r{(C++ only)}
1499 @opindex Wabi
1500 Warn when G++ generates code that is probably not compatible with the
1501 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1502 all such cases, there are probably some cases that are not warned about, 
1503 even though G++ is generating incompatible code.  There may also be
1504 cases where warnings are emitted even though the code that is generated
1505 will be compatible.
1506
1507 You should rewrite your code to avoid these warnings if you are
1508 concerned about the fact that code generated by G++ may not be binary
1509 compatible with code generated by other compilers.
1510
1511 The known incompatibilities at this point include:
1512
1513 @itemize @bullet
1514
1515 @item
1516 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1517 pack data into the same byte as a base class.  For example:
1518
1519 @smallexample
1520 struct A @{ virtual void f(); int f1 : 1; @};
1521 struct B : public A @{ int f2 : 1; @};
1522 @end smallexample
1523
1524 @noindent
1525 In this case, G++ will place @code{B::f2} into the same byte
1526 as@code{A::f1}; other compilers will not.  You can avoid this problem 
1527 by explicitly padding @code{A} so that its size is a multiple of the
1528 byte size on your platform; that will cause G++ and other compilers to
1529 layout @code{B} identically.
1530
1531 @item
1532 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1533 tail padding when laying out virtual bases.  For example:
1534
1535 @smallexample
1536 struct A @{ virtual void f(); char c1; @};
1537 struct B @{ B(); char c2; @};
1538 struct C : public A, public virtual B @{@};
1539 @end smallexample
1540
1541 @noindent
1542 In this case, G++ will not place @code{B} into the tail-padding for
1543 @code{A}; other compilers will.  You can avoid this problem by
1544 explicitly padding @code{A} so that its size is a multiple of its
1545 alignment (ignoring virtual base classes); that will cause G++ and other
1546 compilers to layout @code{C} identically.
1547
1548 @item
1549 Incorrect handling of bit-fields with declared widths greater than that
1550 of their underlying types, when the bit-fields appear in a union.  For
1551 example:
1552
1553 @smallexample
1554 union U @{ int i : 4096; @};
1555 @end smallexample
1556
1557 @noindent
1558 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1559 union too small by the number of bits in an @code{int}.
1560
1561 @item
1562 Empty classes can be placed at incorrect offsets.  For example:
1563  
1564 @smallexample
1565 struct A @{@};
1566
1567 struct B @{
1568   A a;
1569   virtual void f ();
1570 @};
1571
1572 struct C : public B, public A @{@};
1573 @end smallexample
1574
1575 @noindent
1576 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1577 it should be placed at offset zero.  G++ mistakenly believes that the
1578 @code{A} data member of @code{B} is already at offset zero.
1579
1580 @item
1581 Names of template functions whose types involve @code{typename} or
1582 template template parameters can be mangled incorrectly.
1583
1584 @smallexample
1585 template <typename Q>
1586 void f(typename Q::X) @{@}
1587
1588 template <template <typename> class Q>
1589 void f(typename Q<int>::X) @{@}
1590 @end smallexample
1591
1592 @noindent
1593 Instantiations of these templates may be mangled incorrectly.
1594
1595 @end itemize
1596
1597 @item -Wctor-dtor-privacy @r{(C++ only)}
1598 @opindex Wctor-dtor-privacy
1599 Warn when a class seems unusable, because all the constructors or
1600 destructors in a class are private and the class has no friends or
1601 public static member functions.  This warning is enabled by default.
1602
1603 @item -Wnon-virtual-dtor @r{(C++ only)}
1604 @opindex Wnon-virtual-dtor
1605 Warn when a class declares a non-virtual destructor that should probably
1606 be virtual, because it looks like the class will be used polymorphically.
1607 This warning is enabled by @option{-Wall}.
1608
1609 @item -Wreorder @r{(C++ only)}
1610 @opindex Wreorder
1611 @cindex reordering, warning
1612 @cindex warning for reordering of member initializers
1613 Warn when the order of member initializers given in the code does not
1614 match the order in which they must be executed.  For instance:
1615
1616 @smallexample
1617 struct A @{
1618   int i;
1619   int j;
1620   A(): j (0), i (1) @{ @}
1621 @};
1622 @end smallexample
1623
1624 Here the compiler will warn that the member initializers for @samp{i}
1625 and @samp{j} will be rearranged to match the declaration order of the
1626 members.  This warning is enabled by @option{-Wall}.
1627 @end table
1628
1629 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1630
1631 @table @gcctabopt
1632 @item -Weffc++ @r{(C++ only)}
1633 @opindex Weffc++
1634 Warn about violations of the following style guidelines from Scott Meyers'
1635 @cite{Effective C++} book:
1636
1637 @itemize @bullet
1638 @item
1639 Item 11:  Define a copy constructor and an assignment operator for classes
1640 with dynamically allocated memory.
1641
1642 @item
1643 Item 12:  Prefer initialization to assignment in constructors.
1644
1645 @item
1646 Item 14:  Make destructors virtual in base classes.
1647
1648 @item
1649 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1650
1651 @item
1652 Item 23:  Don't try to return a reference when you must return an object.
1653
1654 @end itemize
1655
1656 and about violations of the following style guidelines from Scott Meyers'
1657 @cite{More Effective C++} book:
1658
1659 @itemize @bullet
1660 @item
1661 Item 6:  Distinguish between prefix and postfix forms of increment and
1662 decrement operators.
1663
1664 @item
1665 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1666
1667 @end itemize
1668
1669 If you use this option, you should be aware that the standard library
1670 headers do not obey all of these guidelines; you can use @samp{grep -v}
1671 to filter out those warnings.
1672
1673 @item -Wno-deprecated @r{(C++ only)}
1674 @opindex Wno-deprecated
1675 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1676
1677 @item -Wno-non-template-friend @r{(C++ only)}
1678 @opindex Wno-non-template-friend
1679 Disable warnings when non-templatized friend functions are declared
1680 within a template.  With the advent of explicit template specification
1681 support in G++, if the name of the friend is an unqualified-id (i.e.,
1682 @samp{friend foo(int)}), the C++ language specification demands that the
1683 friend declare or define an ordinary, nontemplate function.  (Section
1684 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1685 could be interpreted as a particular specialization of a templatized
1686 function.  Because this non-conforming behavior is no longer the default
1687 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1688 check existing code for potential trouble spots, and is on by default.
1689 This new compiler behavior can be turned off with
1690 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1691 but disables the helpful warning.
1692
1693 @item -Wold-style-cast @r{(C++ only)}
1694 @opindex Wold-style-cast
1695 Warn if an old-style (C-style) cast to a non-void type is used within
1696 a C++ program.  The new-style casts (@samp{static_cast},
1697 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1698 unintended effects, and much easier to grep for.
1699
1700 @item -Woverloaded-virtual @r{(C++ only)}
1701 @opindex Woverloaded-virtual
1702 @cindex overloaded virtual fn, warning
1703 @cindex warning for overloaded virtual fn
1704 Warn when a function declaration hides virtual functions from a
1705 base class.  For example, in:
1706
1707 @smallexample
1708 struct A @{
1709   virtual void f();
1710 @};
1711
1712 struct B: public A @{
1713   void f(int);
1714 @};
1715 @end smallexample
1716
1717 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1718 like this:
1719
1720 @smallexample
1721 B* b;
1722 b->f();
1723 @end smallexample
1724
1725 will fail to compile.
1726
1727 @item -Wno-pmf-conversions @r{(C++ only)}
1728 @opindex Wno-pmf-conversions
1729 Disable the diagnostic for converting a bound pointer to member function
1730 to a plain pointer.
1731
1732 @item -Wsign-promo @r{(C++ only)}
1733 @opindex Wsign-promo
1734 Warn when overload resolution chooses a promotion from unsigned or
1735 enumeral type to a signed type over a conversion to an unsigned type of
1736 the same size.  Previous versions of G++ would try to preserve
1737 unsignedness, but the standard mandates the current behavior.
1738
1739 @item -Wsynth @r{(C++ only)}
1740 @opindex Wsynth
1741 @cindex warning for synthesized methods
1742 @cindex synthesized methods, warning
1743 Warn when G++'s synthesis behavior does not match that of cfront.  For
1744 instance:
1745
1746 @smallexample
1747 struct A @{
1748   operator int ();
1749   A& operator = (int);
1750 @};
1751
1752 main ()
1753 @{
1754   A a,b;
1755   a = b;
1756 @}
1757 @end smallexample
1758
1759 In this example, G++ will synthesize a default @samp{A& operator =
1760 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1761 @end table
1762
1763 @node Objective-C Dialect Options
1764 @section Options Controlling Objective-C Dialect
1765
1766 @cindex compiler options, Objective-C
1767 @cindex Objective-C options, command line
1768 @cindex options, Objective-C
1769 This section describes the command-line options that are only meaningful
1770 for Objective-C programs; but you can also use most of the GNU compiler
1771 options regardless of what language your program is in.  For example,
1772 you might compile a file @code{some_class.m} like this:
1773
1774 @example
1775 gcc -g -fgnu-runtime -O -c some_class.m
1776 @end example
1777
1778 @noindent
1779 In this example, only @option{-fgnu-runtime} is an option meant only for
1780 Objective-C programs; you can use the other options with any language
1781 supported by GCC@.
1782
1783 Here is a list of options that are @emph{only} for compiling Objective-C
1784 programs:
1785
1786 @table @gcctabopt
1787 @item -fconstant-string-class=@var{class-name}
1788 @opindex fconstant-string-class
1789 Use @var{class-name} as the name of the class to instantiate for each
1790 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1791 class name is @code{NXConstantString}.
1792
1793 @item -fgnu-runtime
1794 @opindex fgnu-runtime
1795 Generate object code compatible with the standard GNU Objective-C
1796 runtime.  This is the default for most types of systems.
1797
1798 @item -fnext-runtime
1799 @opindex fnext-runtime
1800 Generate output compatible with the NeXT runtime.  This is the default
1801 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1802 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1803 used.
1804
1805 @item -gen-decls
1806 @opindex gen-decls
1807 Dump interface declarations for all classes seen in the source file to a
1808 file named @file{@var{sourcename}.decl}.
1809
1810 @item -Wno-protocol
1811 @opindex Wno-protocol
1812 If a class is declared to implement a protocol, a warning is issued for
1813 every method in the protocol that is not implemented by the class.  The
1814 default behavior is to issue a warning for every method not explicitly
1815 implemented in the class, even if a method implementation is inherited
1816 from the superclass.  If you use the @code{-Wno-protocol} option, then
1817 methods inherited from the superclass are considered to be implemented,
1818 and no warning is issued for them.
1819
1820 @item -Wselector
1821 @opindex Wselector
1822 Warn if multiple methods of different types for the same selector are
1823 found during compilation.  The check is performed on the list of methods
1824 in the final stage of compilation.  Additionally, a check is performed
1825 that for each selector appearing in a @code{@@selector(@dots{})}
1826 expression, a corresponding method with that selector has been found
1827 during compilation.  Because these checks scan the method table only at
1828 the end of compilation, these warnings are not produced if the final
1829 stage of compilation is not reached, for example because an error is
1830 found during compilation, or because the @code{-fsyntax-only} option is
1831 being used.
1832
1833 @item -Wundeclared-selector
1834 @opindex Wundeclared-selector
1835 Warn if a @code{@@selector(@dots{})} expression referring to an
1836 undeclared selector is found.  A selector is considered undeclared if no
1837 method with that name has been declared (explicitly, in an
1838 @code{@@interface} or @code{@@protocol} declaration, or implicitly, in
1839 an @code{@@implementation} section) before the
1840 @code{@@selector(@dots{})} expression.  This option always performs its
1841 checks as soon as a @code{@@selector(@dots{})} expression is found
1842 (while @code{-Wselector} only performs its checks in the final stage of
1843 compilation), and so additionally enforces the coding style convention
1844 that methods and selectors must be declared before being used.
1845
1846 @c not documented because only avail via -Wp
1847 @c @item -print-objc-runtime-info
1848
1849 @end table
1850
1851 @node Language Independent Options
1852 @section Options to Control Diagnostic Messages Formatting
1853 @cindex options to control diagnostics formatting
1854 @cindex diagnostic messages
1855 @cindex message formatting
1856
1857 Traditionally, diagnostic messages have been formatted irrespective of
1858 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1859 below can be used to control the diagnostic messages formatting
1860 algorithm, e.g.@: how many characters per line, how often source location
1861 information should be reported.  Right now, only the C++ front end can
1862 honor these options.  However it is expected, in the near future, that
1863 the remaining front ends would be able to digest them correctly.
1864
1865 @table @gcctabopt
1866 @item -fmessage-length=@var{n}
1867 @opindex fmessage-length
1868 Try to format error messages so that they fit on lines of about @var{n}
1869 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1870 the front ends supported by GCC@.  If @var{n} is zero, then no
1871 line-wrapping will be done; each error message will appear on a single
1872 line.
1873
1874 @opindex fdiagnostics-show-location
1875 @item -fdiagnostics-show-location=once
1876 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1877 reporter to emit @emph{once} source location information; that is, in
1878 case the message is too long to fit on a single physical line and has to
1879 be wrapped, the source location won't be emitted (as prefix) again,
1880 over and over, in subsequent continuation lines.  This is the default
1881 behavior.
1882
1883 @item -fdiagnostics-show-location=every-line
1884 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1885 messages reporter to emit the same source location information (as
1886 prefix) for physical lines that result from the process of breaking
1887 a message which is too long to fit on a single line.
1888
1889 @end table
1890
1891 @node Warning Options
1892 @section Options to Request or Suppress Warnings
1893 @cindex options to control warnings
1894 @cindex warning messages
1895 @cindex messages, warning
1896 @cindex suppressing warnings
1897
1898 Warnings are diagnostic messages that report constructions which
1899 are not inherently erroneous but which are risky or suggest there
1900 may have been an error.
1901
1902 You can request many specific warnings with options beginning @samp{-W},
1903 for example @option{-Wimplicit} to request warnings on implicit
1904 declarations.  Each of these specific warning options also has a
1905 negative form beginning @samp{-Wno-} to turn off warnings;
1906 for example, @option{-Wno-implicit}.  This manual lists only one of the
1907 two forms, whichever is not the default.
1908
1909 The following options control the amount and kinds of warnings produced
1910 by GCC; for further, language-specific options also refer to
1911 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
1912
1913 @table @gcctabopt
1914 @cindex syntax checking
1915 @item -fsyntax-only
1916 @opindex fsyntax-only
1917 Check the code for syntax errors, but don't do anything beyond that.
1918
1919 @item -pedantic
1920 @opindex pedantic
1921 Issue all the warnings demanded by strict ISO C and ISO C++;
1922 reject all programs that use forbidden extensions, and some other
1923 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1924 version of the ISO C standard specified by any @option{-std} option used.
1925
1926 Valid ISO C and ISO C++ programs should compile properly with or without
1927 this option (though a rare few will require @option{-ansi} or a
1928 @option{-std} option specifying the required version of ISO C)@.  However,
1929 without this option, certain GNU extensions and traditional C and C++
1930 features are supported as well.  With this option, they are rejected.
1931
1932 @option{-pedantic} does not cause warning messages for use of the
1933 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1934 warnings are also disabled in the expression that follows
1935 @code{__extension__}.  However, only system header files should use
1936 these escape routes; application programs should avoid them.
1937 @xref{Alternate Keywords}.
1938
1939 Some users try to use @option{-pedantic} to check programs for strict ISO
1940 C conformance.  They soon find that it does not do quite what they want:
1941 it finds some non-ISO practices, but not all---only those for which
1942 ISO C @emph{requires} a diagnostic, and some others for which
1943 diagnostics have been added.
1944
1945 A feature to report any failure to conform to ISO C might be useful in
1946 some instances, but would require considerable additional work and would
1947 be quite different from @option{-pedantic}.  We don't have plans to
1948 support such a feature in the near future.
1949
1950 Where the standard specified with @option{-std} represents a GNU
1951 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
1952 corresponding @dfn{base standard}, the version of ISO C on which the GNU
1953 extended dialect is based.  Warnings from @option{-pedantic} are given
1954 where they are required by the base standard.  (It would not make sense
1955 for such warnings to be given only for features not in the specified GNU
1956 C dialect, since by definition the GNU dialects of C include all
1957 features the compiler supports with the given option, and there would be
1958 nothing to warn about.)
1959
1960 @item -pedantic-errors
1961 @opindex pedantic-errors
1962 Like @option{-pedantic}, except that errors are produced rather than
1963 warnings.
1964
1965 @item -w
1966 @opindex w
1967 Inhibit all warning messages.
1968
1969 @item -Wno-import
1970 @opindex Wno-import
1971 Inhibit warning messages about the use of @samp{#import}.
1972
1973 @item -Wchar-subscripts
1974 @opindex Wchar-subscripts
1975 Warn if an array subscript has type @code{char}.  This is a common cause
1976 of error, as programmers often forget that this type is signed on some
1977 machines.
1978
1979 @item -Wcomment
1980 @opindex Wcomment
1981 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1982 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1983
1984 @item -Wformat
1985 @opindex Wformat
1986 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1987 the arguments supplied have types appropriate to the format string
1988 specified, and that the conversions specified in the format string make
1989 sense.  This includes standard functions, and others specified by format
1990 attributes (@pxref{Function Attributes}), in the @code{printf},
1991 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1992 not in the C standard) families.
1993
1994 The formats are checked against the format features supported by GNU
1995 libc version 2.2.  These include all ISO C90 and C99 features, as well
1996 as features from the Single Unix Specification and some BSD and GNU
1997 extensions.  Other library implementations may not support all these
1998 features; GCC does not support warning about features that go beyond a
1999 particular library's limitations.  However, if @option{-pedantic} is used
2000 with @option{-Wformat}, warnings will be given about format features not
2001 in the selected standard version (but not for @code{strfmon} formats,
2002 since those are not in any version of the C standard).  @xref{C Dialect
2003 Options,,Options Controlling C Dialect}.
2004
2005 Since @option{-Wformat} also checks for null format arguments for
2006 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2007
2008 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2009 aspects of format checking, the options @option{-Wno-format-y2k},
2010 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2011 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2012 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2013
2014 @item -Wno-format-y2k
2015 @opindex Wno-format-y2k
2016 If @option{-Wformat} is specified, do not warn about @code{strftime}
2017 formats which may yield only a two-digit year.
2018
2019 @item -Wno-format-extra-args
2020 @opindex Wno-format-extra-args
2021 If @option{-Wformat} is specified, do not warn about excess arguments to a
2022 @code{printf} or @code{scanf} format function.  The C standard specifies
2023 that such arguments are ignored.
2024
2025 Where the unused arguments lie between used arguments that are
2026 specified with @samp{$} operand number specifications, normally
2027 warnings are still given, since the implementation could not know what
2028 type to pass to @code{va_arg} to skip the unused arguments.  However,
2029 in the case of @code{scanf} formats, this option will suppress the
2030 warning if the unused arguments are all pointers, since the Single
2031 Unix Specification says that such unused arguments are allowed.
2032
2033 @item -Wno-format-zero-length
2034 @opindex Wno-format-zero-length
2035 If @option{-Wformat} is specified, do not warn about zero-length formats.
2036 The C standard specifies that zero-length formats are allowed.
2037
2038 @item -Wformat-nonliteral
2039 @opindex Wformat-nonliteral
2040 If @option{-Wformat} is specified, also warn if the format string is not a
2041 string literal and so cannot be checked, unless the format function
2042 takes its format arguments as a @code{va_list}.
2043
2044 @item -Wformat-security
2045 @opindex Wformat-security
2046 If @option{-Wformat} is specified, also warn about uses of format
2047 functions that represent possible security problems.  At present, this
2048 warns about calls to @code{printf} and @code{scanf} functions where the
2049 format string is not a string literal and there are no format arguments,
2050 as in @code{printf (foo);}.  This may be a security hole if the format
2051 string came from untrusted input and contains @samp{%n}.  (This is
2052 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2053 in future warnings may be added to @option{-Wformat-security} that are not
2054 included in @option{-Wformat-nonliteral}.)
2055
2056 @item -Wformat=2
2057 @opindex Wformat=2
2058 Enable @option{-Wformat} plus format checks not included in
2059 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2060 -Wformat-nonliteral -Wformat-security}.
2061
2062 @item -Wnonnull
2063 @opindex Wnonnull
2064 Enable warning about passing a null pointer for arguments marked as
2065 requiring a non-null value by the @code{nonnull} function attribute.
2066
2067 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2068 can be disabled with the @option{-Wno-nonnull} option.
2069
2070 @item -Wimplicit-int
2071 @opindex Wimplicit-int
2072 Warn when a declaration does not specify a type.
2073
2074 @item -Wimplicit-function-declaration
2075 @itemx -Werror-implicit-function-declaration
2076 @opindex Wimplicit-function-declaration
2077 @opindex Werror-implicit-function-declaration
2078 Give a warning (or error) whenever a function is used before being
2079 declared.
2080
2081 @item -Wimplicit
2082 @opindex Wimplicit
2083 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2084
2085 @item -Wmain
2086 @opindex Wmain
2087 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2088 function with external linkage, returning int, taking either zero
2089 arguments, two, or three arguments of appropriate types.
2090
2091 @item -Wmissing-braces
2092 @opindex Wmissing-braces
2093 Warn if an aggregate or union initializer is not fully bracketed.  In
2094 the following example, the initializer for @samp{a} is not fully
2095 bracketed, but that for @samp{b} is fully bracketed.
2096
2097 @smallexample
2098 int a[2][2] = @{ 0, 1, 2, 3 @};
2099 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2100 @end smallexample
2101
2102 @item -Wparentheses
2103 @opindex Wparentheses
2104 Warn if parentheses are omitted in certain contexts, such
2105 as when there is an assignment in a context where a truth value
2106 is expected, or when operators are nested whose precedence people
2107 often get confused about.
2108
2109 Also warn about constructions where there may be confusion to which
2110 @code{if} statement an @code{else} branch belongs.  Here is an example of
2111 such a case:
2112
2113 @smallexample
2114 @group
2115 @{
2116   if (a)
2117     if (b)
2118       foo ();
2119   else
2120     bar ();
2121 @}
2122 @end group
2123 @end smallexample
2124
2125 In C, every @code{else} branch belongs to the innermost possible @code{if}
2126 statement, which in this example is @code{if (b)}.  This is often not
2127 what the programmer expected, as illustrated in the above example by
2128 indentation the programmer chose.  When there is the potential for this
2129 confusion, GCC will issue a warning when this flag is specified.
2130 To eliminate the warning, add explicit braces around the innermost
2131 @code{if} statement so there is no way the @code{else} could belong to
2132 the enclosing @code{if}.  The resulting code would look like this:
2133
2134 @smallexample
2135 @group
2136 @{
2137   if (a)
2138     @{
2139       if (b)
2140         foo ();
2141       else
2142         bar ();
2143     @}
2144 @}
2145 @end group
2146 @end smallexample
2147
2148 @item -Wsequence-point
2149 @opindex Wsequence-point
2150 Warn about code that may have undefined semantics because of violations
2151 of sequence point rules in the C standard.
2152
2153 The C standard defines the order in which expressions in a C program are
2154 evaluated in terms of @dfn{sequence points}, which represent a partial
2155 ordering between the execution of parts of the program: those executed
2156 before the sequence point, and those executed after it.  These occur
2157 after the evaluation of a full expression (one which is not part of a
2158 larger expression), after the evaluation of the first operand of a
2159 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2160 function is called (but after the evaluation of its arguments and the
2161 expression denoting the called function), and in certain other places.
2162 Other than as expressed by the sequence point rules, the order of
2163 evaluation of subexpressions of an expression is not specified.  All
2164 these rules describe only a partial order rather than a total order,
2165 since, for example, if two functions are called within one expression
2166 with no sequence point between them, the order in which the functions
2167 are called is not specified.  However, the standards committee have
2168 ruled that function calls do not overlap.
2169
2170 It is not specified when between sequence points modifications to the
2171 values of objects take effect.  Programs whose behavior depends on this
2172 have undefined behavior; the C standard specifies that ``Between the
2173 previous and next sequence point an object shall have its stored value
2174 modified at most once by the evaluation of an expression.  Furthermore,
2175 the prior value shall be read only to determine the value to be
2176 stored.''.  If a program breaks these rules, the results on any
2177 particular implementation are entirely unpredictable.
2178
2179 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2180 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2181 diagnosed by this option, and it may give an occasional false positive
2182 result, but in general it has been found fairly effective at detecting
2183 this sort of problem in programs.
2184
2185 The present implementation of this option only works for C programs.  A
2186 future implementation may also work for C++ programs.
2187
2188 The C standard is worded confusingly, therefore there is some debate
2189 over the precise meaning of the sequence point rules in subtle cases.
2190 Links to discussions of the problem, including proposed formal
2191 definitions, may be found on our readings page, at
2192 @w{@uref{http://gcc.gnu.org/readings.html}}.
2193
2194 @item -Wreturn-type
2195 @opindex Wreturn-type
2196 Warn whenever a function is defined with a return-type that defaults to
2197 @code{int}.  Also warn about any @code{return} statement with no
2198 return-value in a function whose return-type is not @code{void}.
2199
2200 For C++, a function without return type always produces a diagnostic
2201 message, even when @option{-Wno-return-type} is specified.  The only
2202 exceptions are @samp{main} and functions defined in system headers.
2203
2204 @item -Wswitch
2205 @opindex Wswitch
2206 Warn whenever a @code{switch} statement has an index of enumeral type
2207 and lacks a @code{case} for one or more of the named codes of that
2208 enumeration.  (The presence of a @code{default} label prevents this
2209 warning.)  @code{case} labels outside the enumeration range also
2210 provoke warnings when this option is used.
2211
2212 @item -Wswitch-default
2213 @opindex Wswitch-switch
2214 Warn whenever a @code{switch} statement does not have a @code{default}
2215 case.
2216
2217 @item -Wswitch-enum
2218 @opindex Wswitch-enum
2219 Warn whenever a @code{switch} statement has an index of enumeral type
2220 and lacks a @code{case} for one or more of the named codes of that
2221 enumeration.  @code{case} labels outside the enumeration range also
2222 provoke warnings when this option is used.
2223
2224 @item -Wtrigraphs
2225 @opindex Wtrigraphs
2226 Warn if any trigraphs are encountered that might change the meaning of
2227 the program (trigraphs within comments are not warned about).
2228
2229 @item -Wunused-function
2230 @opindex Wunused-function
2231 Warn whenever a static function is declared but not defined or a
2232 non\-inline static function is unused.
2233
2234 @item -Wunused-label
2235 @opindex Wunused-label
2236 Warn whenever a label is declared but not used.
2237
2238 To suppress this warning use the @samp{unused} attribute
2239 (@pxref{Variable Attributes}).
2240
2241 @item -Wunused-parameter
2242 @opindex Wunused-parameter
2243 Warn whenever a function parameter is unused aside from its declaration.
2244
2245 To suppress this warning use the @samp{unused} attribute
2246 (@pxref{Variable Attributes}).
2247
2248 @item -Wunused-variable
2249 @opindex Wunused-variable
2250 Warn whenever a local variable or non-constant static variable is unused
2251 aside from its declaration
2252
2253 To suppress this warning use the @samp{unused} attribute
2254 (@pxref{Variable Attributes}).
2255
2256 @item -Wunused-value
2257 @opindex Wunused-value
2258 Warn whenever a statement computes a result that is explicitly not used.
2259
2260 To suppress this warning cast the expression to @samp{void}.
2261
2262 @item -Wunused
2263 @opindex Wunused
2264 All the above @option{-Wunused} options combined.
2265
2266 In order to get a warning about an unused function parameter, you must
2267 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2268 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2269
2270 @item -Wuninitialized
2271 @opindex Wuninitialized
2272 Warn if an automatic variable is used without first being initialized or
2273 if a variable may be clobbered by a @code{setjmp} call.
2274
2275 These warnings are possible only in optimizing compilation,
2276 because they require data flow information that is computed only
2277 when optimizing.  If you don't specify @option{-O}, you simply won't
2278 get these warnings.
2279
2280 These warnings occur only for variables that are candidates for
2281 register allocation.  Therefore, they do not occur for a variable that
2282 is declared @code{volatile}, or whose address is taken, or whose size
2283 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2284 structures, unions or arrays, even when they are in registers.
2285
2286 Note that there may be no warning about a variable that is used only
2287 to compute a value that itself is never used, because such
2288 computations may be deleted by data flow analysis before the warnings
2289 are printed.
2290
2291 These warnings are made optional because GCC is not smart
2292 enough to see all the reasons why the code might be correct
2293 despite appearing to have an error.  Here is one example of how
2294 this can happen:
2295
2296 @smallexample
2297 @group
2298 @{
2299   int x;
2300   switch (y)
2301     @{
2302     case 1: x = 1;
2303       break;
2304     case 2: x = 4;
2305       break;
2306     case 3: x = 5;
2307     @}
2308   foo (x);
2309 @}
2310 @end group
2311 @end smallexample
2312
2313 @noindent
2314 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2315 always initialized, but GCC doesn't know this.  Here is
2316 another common case:
2317
2318 @smallexample
2319 @{
2320   int save_y;
2321   if (change_y) save_y = y, y = new_y;
2322   @dots{}
2323   if (change_y) y = save_y;
2324 @}
2325 @end smallexample
2326
2327 @noindent
2328 This has no bug because @code{save_y} is used only if it is set.
2329
2330 @cindex @code{longjmp} warnings
2331 This option also warns when a non-volatile automatic variable might be
2332 changed by a call to @code{longjmp}.  These warnings as well are possible
2333 only in optimizing compilation.
2334
2335 The compiler sees only the calls to @code{setjmp}.  It cannot know
2336 where @code{longjmp} will be called; in fact, a signal handler could
2337 call it at any point in the code.  As a result, you may get a warning
2338 even when there is in fact no problem because @code{longjmp} cannot
2339 in fact be called at the place which would cause a problem.
2340
2341 Some spurious warnings can be avoided if you declare all the functions
2342 you use that never return as @code{noreturn}.  @xref{Function
2343 Attributes}.
2344
2345 @item -Wunknown-pragmas
2346 @opindex Wunknown-pragmas
2347 @cindex warning for unknown pragmas
2348 @cindex unknown pragmas, warning
2349 @cindex pragmas, warning of unknown
2350 Warn when a #pragma directive is encountered which is not understood by
2351 GCC@.  If this command line option is used, warnings will even be issued
2352 for unknown pragmas in system header files.  This is not the case if
2353 the warnings were only enabled by the @option{-Wall} command line option.
2354
2355 @item -Wstrict-aliasing
2356 @opindex Wstrict-aliasing
2357 This option is only active when @option{-fstrict-aliasing} is active.
2358 It warns about code which might break the strict aliasing rules that the
2359 compiler is using for optimization. The warning does not catch all
2360 cases, but does attempt to catch the more common pitfalls. It is
2361 included in @option{-Wall}.
2362
2363 @item -Wall
2364 @opindex Wall
2365 All of the above @samp{-W} options combined.  This enables all the
2366 warnings about constructions that some users consider questionable, and
2367 that are easy to avoid (or modify to prevent the warning), even in
2368 conjunction with macros.  This also enables some language-specific
2369 warnings described in @ref{C++ Dialect Options} and
2370 @ref{Objective-C Dialect Options}.
2371 @end table
2372
2373 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2374 Some of them warn about constructions that users generally do not
2375 consider questionable, but which occasionally you might wish to check
2376 for; others warn about constructions that are necessary or hard to avoid
2377 in some cases, and there is no simple way to modify the code to suppress
2378 the warning.
2379
2380 @table @gcctabopt
2381 @item -Wextra
2382 @opindex W
2383 @opindex Wextra
2384 (This option used to be called @option{-W}.  The older name is still
2385 supported, but the newer name is more descriptive.)  Print extra warning
2386 messages for these events:
2387
2388 @itemize @bullet
2389 @item
2390 A function can return either with or without a value.  (Falling
2391 off the end of the function body is considered returning without
2392 a value.)  For example, this function would evoke such a
2393 warning:
2394
2395 @smallexample
2396 @group
2397 foo (a)
2398 @{
2399   if (a > 0)
2400     return a;
2401 @}
2402 @end group
2403 @end smallexample
2404
2405 @item
2406 An expression-statement or the left-hand side of a comma expression
2407 contains no side effects.
2408 To suppress the warning, cast the unused expression to void.
2409 For example, an expression such as @samp{x[i,j]} will cause a warning,
2410 but @samp{x[(void)i,j]} will not.
2411
2412 @item
2413 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2414
2415 @item
2416 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2417 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2418 that of ordinary mathematical notation.
2419
2420 @item
2421 Storage-class specifiers like @code{static} are not the first things in
2422 a declaration.  According to the C Standard, this usage is obsolescent.
2423
2424 @item
2425 The return type of a function has a type qualifier such as @code{const}.
2426 Such a type qualifier has no effect, since the value returned by a
2427 function is not an lvalue.  (But don't warn about the GNU extension of
2428 @code{volatile void} return types.  That extension will be warned about
2429 if @option{-pedantic} is specified.)
2430
2431 @item
2432 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2433 arguments.
2434
2435 @item
2436 A comparison between signed and unsigned values could produce an
2437 incorrect result when the signed value is converted to unsigned.
2438 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2439
2440 @item
2441 An aggregate has an initializer which does not initialize all members.
2442 For example, the following code would cause such a warning, because
2443 @code{x.h} would be implicitly initialized to zero:
2444
2445 @smallexample
2446 struct s @{ int f, g, h; @};
2447 struct s x = @{ 3, 4 @};
2448 @end smallexample
2449
2450 @item
2451 A function parameter is declared without a type specifier in K&R-style
2452 functions:
2453
2454 @smallexample
2455 void foo(bar) @{ @}
2456 @end smallexample
2457
2458 @item
2459 An empty body occurs in an @samp{if} or @samp{else} statement.
2460
2461 @item
2462 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2463 @samp{>}, or @samp{>=}.
2464
2465 @item
2466 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2467
2468 @item
2469 Any of several floating-point events that often indicate errors, such as
2470 overflow, underflow, loss of precision, etc.
2471
2472 @item @r{(C++ only)}
2473 An enumerator and a non-enumerator both appear in a conditional expression.
2474
2475 @item @r{(C++ only)}
2476 A non-static reference or non-static @samp{const} member appears in a
2477 class without constructors.
2478
2479 @item @r{(C++ only)}
2480 Ambiguous virtual bases.
2481
2482 @item @r{(C++ only)}
2483 Subscripting an array which has been declared @samp{register}.
2484
2485 @item @r{(C++ only)}
2486 Taking the address of a variable which has been declared @samp{register}.
2487
2488 @item @r{(C++ only)}
2489 A base class is not initialized in a derived class' copy constrcutor.
2490 @end itemize
2491
2492 @item -Wno-div-by-zero
2493 @opindex Wno-div-by-zero
2494 @opindex Wdiv-by-zero
2495 Do not warn about compile-time integer division by zero.  Floating point
2496 division by zero is not warned about, as it can be a legitimate way of
2497 obtaining infinities and NaNs.
2498
2499 @item -Wsystem-headers
2500 @opindex Wsystem-headers
2501 @cindex warnings from system headers
2502 @cindex system headers, warnings from
2503 Print warning messages for constructs found in system header files.
2504 Warnings from system headers are normally suppressed, on the assumption
2505 that they usually do not indicate real problems and would only make the
2506 compiler output harder to read.  Using this command line option tells
2507 GCC to emit warnings from system headers as if they occurred in user
2508 code.  However, note that using @option{-Wall} in conjunction with this
2509 option will @emph{not} warn about unknown pragmas in system
2510 headers---for that, @option{-Wunknown-pragmas} must also be used.
2511
2512 @item -Wfloat-equal
2513 @opindex Wfloat-equal
2514 Warn if floating point values are used in equality comparisons.
2515
2516 The idea behind this is that sometimes it is convenient (for the
2517 programmer) to consider floating-point values as approximations to
2518 infinitely precise real numbers.  If you are doing this, then you need
2519 to compute (by analyzing the code, or in some other way) the maximum or
2520 likely maximum error that the computation introduces, and allow for it
2521 when performing comparisons (and when producing output, but that's a
2522 different problem).  In particular, instead of testing for equality, you
2523 would check to see whether the two values have ranges that overlap; and
2524 this is done with the relational operators, so equality comparisons are
2525 probably mistaken.
2526
2527 @item -Wtraditional @r{(C only)}
2528 @opindex Wtraditional
2529 Warn about certain constructs that behave differently in traditional and
2530 ISO C@.  Also warn about ISO C constructs that have no traditional C
2531 equivalent, and/or problematic constructs which should be avoided.
2532
2533 @itemize @bullet
2534 @item
2535 Macro parameters that appear within string literals in the macro body.
2536 In traditional C macro replacement takes place within string literals,
2537 but does not in ISO C@.
2538
2539 @item
2540 In traditional C, some preprocessor directives did not exist.
2541 Traditional preprocessors would only consider a line to be a directive
2542 if the @samp{#} appeared in column 1 on the line.  Therefore
2543 @option{-Wtraditional} warns about directives that traditional C
2544 understands but would ignore because the @samp{#} does not appear as the
2545 first character on the line.  It also suggests you hide directives like
2546 @samp{#pragma} not understood by traditional C by indenting them.  Some
2547 traditional implementations would not recognize @samp{#elif}, so it
2548 suggests avoiding it altogether.
2549
2550 @item
2551 A function-like macro that appears without arguments.
2552
2553 @item
2554 The unary plus operator.
2555
2556 @item
2557 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2558 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2559 constants.)  Note, these suffixes appear in macros defined in the system
2560 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2561 Use of these macros in user code might normally lead to spurious
2562 warnings, however gcc's integrated preprocessor has enough context to
2563 avoid warning in these cases.
2564
2565 @item
2566 A function declared external in one block and then used after the end of
2567 the block.
2568
2569 @item
2570 A @code{switch} statement has an operand of type @code{long}.
2571
2572 @item
2573 A non-@code{static} function declaration follows a @code{static} one.
2574 This construct is not accepted by some traditional C compilers.
2575
2576 @item
2577 The ISO type of an integer constant has a different width or
2578 signedness from its traditional type.  This warning is only issued if
2579 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2580 typically represent bit patterns, are not warned about.
2581
2582 @item
2583 Usage of ISO string concatenation is detected.
2584
2585 @item
2586 Initialization of automatic aggregates.
2587
2588 @item
2589 Identifier conflicts with labels.  Traditional C lacks a separate
2590 namespace for labels.
2591
2592 @item
2593 Initialization of unions.  If the initializer is zero, the warning is
2594 omitted.  This is done under the assumption that the zero initializer in
2595 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2596 initializer warnings and relies on default initialization to zero in the
2597 traditional C case.
2598
2599 @item
2600 Conversions by prototypes between fixed/floating point values and vice
2601 versa.  The absence of these prototypes when compiling with traditional
2602 C would cause serious problems.  This is a subset of the possible
2603 conversion warnings, for the full set use @option{-Wconversion}.
2604
2605 @item
2606 Use of ISO C style function definitions.  This warning intentionally is
2607 @emph{not} issued for prototype declarations or variadic functions
2608 because these ISO C features will appear in your code when using
2609 libiberty's traditional C compatibility macros, @code{PARAMS} and
2610 @code{VPARAMS}.  This warning is also bypassed for nested functions
2611 because that feature is already a gcc extension and thus not relevant to
2612 traditional C compatibility.
2613 @end itemize
2614
2615 @item -Wundef
2616 @opindex Wundef
2617 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2618
2619 @item -Wendif-labels
2620 @opindex Wendif-labels
2621 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2622
2623 @item -Wshadow
2624 @opindex Wshadow
2625 Warn whenever a local variable shadows another local variable, parameter or
2626 global variable or whenever a built-in function is shadowed.
2627
2628 @item -Wlarger-than-@var{len}
2629 @opindex Wlarger-than
2630 Warn whenever an object of larger than @var{len} bytes is defined.
2631
2632 @item -Wpointer-arith
2633 @opindex Wpointer-arith
2634 Warn about anything that depends on the ``size of'' a function type or
2635 of @code{void}.  GNU C assigns these types a size of 1, for
2636 convenience in calculations with @code{void *} pointers and pointers
2637 to functions.
2638
2639 @item -Wbad-function-cast @r{(C only)}
2640 @opindex Wbad-function-cast
2641 Warn whenever a function call is cast to a non-matching type.
2642 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2643
2644 @item -Wcast-qual
2645 @opindex Wcast-qual
2646 Warn whenever a pointer is cast so as to remove a type qualifier from
2647 the target type.  For example, warn if a @code{const char *} is cast
2648 to an ordinary @code{char *}.
2649
2650 @item -Wcast-align
2651 @opindex Wcast-align
2652 Warn whenever a pointer is cast such that the required alignment of the
2653 target is increased.  For example, warn if a @code{char *} is cast to
2654 an @code{int *} on machines where integers can only be accessed at
2655 two- or four-byte boundaries.
2656
2657 @item -Wwrite-strings
2658 @opindex Wwrite-strings
2659 When compiling C, give string constants the type @code{const
2660 char[@var{length}]} so that
2661 copying the address of one into a non-@code{const} @code{char *}
2662 pointer will get a warning; when compiling C++, warn about the
2663 deprecated conversion from string constants to @code{char *}.
2664 These warnings will help you find at
2665 compile time code that can try to write into a string constant, but
2666 only if you have been very careful about using @code{const} in
2667 declarations and prototypes.  Otherwise, it will just be a nuisance;
2668 this is why we did not make @option{-Wall} request these warnings.
2669
2670 @item -Wconversion
2671 @opindex Wconversion
2672 Warn if a prototype causes a type conversion that is different from what
2673 would happen to the same argument in the absence of a prototype.  This
2674 includes conversions of fixed point to floating and vice versa, and
2675 conversions changing the width or signedness of a fixed point argument
2676 except when the same as the default promotion.
2677
2678 Also, warn if a negative integer constant expression is implicitly
2679 converted to an unsigned type.  For example, warn about the assignment
2680 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2681 casts like @code{(unsigned) -1}.
2682
2683 @item -Wsign-compare
2684 @opindex Wsign-compare
2685 @cindex warning for comparison of signed and unsigned values
2686 @cindex comparison of signed and unsigned values, warning
2687 @cindex signed and unsigned values, comparison warning
2688 Warn when a comparison between signed and unsigned values could produce
2689 an incorrect result when the signed value is converted to unsigned.
2690 This warning is also enabled by @option{-Wextra}; to get the other warnings
2691 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2692
2693 @item -Waggregate-return
2694 @opindex Waggregate-return
2695 Warn if any functions that return structures or unions are defined or
2696 called.  (In languages where you can return an array, this also elicits
2697 a warning.)
2698
2699 @item -Wstrict-prototypes @r{(C only)}
2700 @opindex Wstrict-prototypes
2701 Warn if a function is declared or defined without specifying the
2702 argument types.  (An old-style function definition is permitted without
2703 a warning if preceded by a declaration which specifies the argument
2704 types.)
2705
2706 @item -Wmissing-prototypes @r{(C only)}
2707 @opindex Wmissing-prototypes
2708 Warn if a global function is defined without a previous prototype
2709 declaration.  This warning is issued even if the definition itself
2710 provides a prototype.  The aim is to detect global functions that fail
2711 to be declared in header files.
2712
2713 @item -Wmissing-declarations
2714 @opindex Wmissing-declarations
2715 Warn if a global function is defined without a previous declaration.
2716 Do so even if the definition itself provides a prototype.
2717 Use this option to detect global functions that are not declared in
2718 header files.
2719
2720 @item -Wmissing-noreturn
2721 @opindex Wmissing-noreturn
2722 Warn about functions which might be candidates for attribute @code{noreturn}.
2723 Note these are only possible candidates, not absolute ones.  Care should
2724 be taken to manually verify functions actually do not ever return before
2725 adding the @code{noreturn} attribute, otherwise subtle code generation
2726 bugs could be introduced.  You will not get a warning for @code{main} in
2727 hosted C environments.
2728
2729 @item -Wmissing-format-attribute
2730 @opindex Wmissing-format-attribute
2731 @opindex Wformat
2732 If @option{-Wformat} is enabled, also warn about functions which might be
2733 candidates for @code{format} attributes.  Note these are only possible
2734 candidates, not absolute ones.  GCC will guess that @code{format}
2735 attributes might be appropriate for any function that calls a function
2736 like @code{vprintf} or @code{vscanf}, but this might not always be the
2737 case, and some functions for which @code{format} attributes are
2738 appropriate may not be detected.  This option has no effect unless
2739 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2740
2741 @item -Wno-multichar
2742 @opindex Wno-multichar
2743 @opindex Wmultichar
2744 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2745 Usually they indicate a typo in the user's code, as they have
2746 implementation-defined values, and should not be used in portable code.
2747
2748 @item -Wno-deprecated-declarations
2749 @opindex Wno-deprecated-declarations
2750 Do not warn about uses of functions, variables, and types marked as
2751 deprecated by using the @code{deprecated} attribute.
2752 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2753 @pxref{Type Attributes}.)
2754
2755 @item -Wpacked
2756 @opindex Wpacked
2757 Warn if a structure is given the packed attribute, but the packed
2758 attribute has no effect on the layout or size of the structure.
2759 Such structures may be mis-aligned for little benefit.  For
2760 instance, in this code, the variable @code{f.x} in @code{struct bar}
2761 will be misaligned even though @code{struct bar} does not itself
2762 have the packed attribute:
2763
2764 @smallexample
2765 @group
2766 struct foo @{
2767   int x;
2768   char a, b, c, d;
2769 @} __attribute__((packed));
2770 struct bar @{
2771   char z;
2772   struct foo f;
2773 @};
2774 @end group
2775 @end smallexample
2776
2777 @item -Wpadded
2778 @opindex Wpadded
2779 Warn if padding is included in a structure, either to align an element
2780 of the structure or to align the whole structure.  Sometimes when this
2781 happens it is possible to rearrange the fields of the structure to
2782 reduce the padding and so make the structure smaller.
2783
2784 @item -Wredundant-decls
2785 @opindex Wredundant-decls
2786 Warn if anything is declared more than once in the same scope, even in
2787 cases where multiple declaration is valid and changes nothing.
2788
2789 @item -Wnested-externs @r{(C only)}
2790 @opindex Wnested-externs
2791 Warn if an @code{extern} declaration is encountered within a function.
2792
2793 @item -Wunreachable-code
2794 @opindex Wunreachable-code
2795 Warn if the compiler detects that code will never be executed.
2796
2797 This option is intended to warn when the compiler detects that at
2798 least a whole line of source code will never be executed, because
2799 some condition is never satisfied or because it is after a
2800 procedure that never returns.
2801
2802 It is possible for this option to produce a warning even though there
2803 are circumstances under which part of the affected line can be executed,
2804 so care should be taken when removing apparently-unreachable code.
2805
2806 For instance, when a function is inlined, a warning may mean that the
2807 line is unreachable in only one inlined copy of the function.
2808
2809 This option is not made part of @option{-Wall} because in a debugging
2810 version of a program there is often substantial code which checks
2811 correct functioning of the program and is, hopefully, unreachable
2812 because the program does work.  Another common use of unreachable
2813 code is to provide behavior which is selectable at compile-time.
2814
2815 @item -Winline
2816 @opindex Winline
2817 Warn if a function can not be inlined and it was declared as inline.
2818
2819 @item -Winvalid-pch
2820 @opindex Winvalid-pch
2821 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
2822 the search path but can't be used.
2823
2824 @item -Wlong-long
2825 @opindex Wlong-long
2826 @opindex Wno-long-long
2827 Warn if @samp{long long} type is used.  This is default.  To inhibit
2828 the warning messages, use @option{-Wno-long-long}.  Flags
2829 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
2830 only when @option{-pedantic} flag is used.
2831
2832 @item -Wdisabled-optimization
2833 @opindex Wdisabled-optimization
2834 Warn if a requested optimization pass is disabled.  This warning does
2835 not generally indicate that there is anything wrong with your code; it
2836 merely indicates that GCC's optimizers were unable to handle the code
2837 effectively.  Often, the problem is that your code is too big or too
2838 complex; GCC will refuse to optimize programs when the optimization
2839 itself is likely to take inordinate amounts of time.
2840
2841 @item -Werror
2842 @opindex Werror
2843 Make all warnings into errors.
2844 @end table
2845
2846 @node Debugging Options
2847 @section Options for Debugging Your Program or GCC
2848 @cindex options, debugging
2849 @cindex debugging information options
2850
2851 GCC has various special options that are used for debugging
2852 either your program or GCC:
2853
2854 @table @gcctabopt
2855 @item -g
2856 @opindex g
2857 Produce debugging information in the operating system's native format
2858 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
2859 information.
2860
2861 On most systems that use stabs format, @option{-g} enables use of extra
2862 debugging information that only GDB can use; this extra information
2863 makes debugging work better in GDB but will probably make other debuggers
2864 crash or
2865 refuse to read the program.  If you want to control for certain whether
2866 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
2867 @option{-gxcoff+}, @option{-gxcoff}, @option{-gdwarf-1+}, @option{-gdwarf-1},
2868 or @option{-gvms} (see below).
2869
2870 Unlike most other C compilers, GCC allows you to use @option{-g} with
2871 @option{-O}.  The shortcuts taken by optimized code may occasionally
2872 produce surprising results: some variables you declared may not exist
2873 at all; flow of control may briefly move where you did not expect it;
2874 some statements may not be executed because they compute constant
2875 results or their values were already at hand; some statements may
2876 execute in different places because they were moved out of loops.
2877
2878 Nevertheless it proves possible to debug optimized output.  This makes
2879 it reasonable to use the optimizer for programs that might have bugs.
2880
2881 The following options are useful when GCC is generated with the
2882 capability for more than one debugging format.
2883
2884 @item -ggdb
2885 @opindex ggdb
2886 Produce debugging information for use by GDB@.  This means to use the
2887 most expressive format available (DWARF 2, stabs, or the native format
2888 if neither of those are supported), including GDB extensions if at all
2889 possible.
2890
2891 @item -gstabs
2892 @opindex gstabs
2893 Produce debugging information in stabs format (if that is supported),
2894 without GDB extensions.  This is the format used by DBX on most BSD
2895 systems.  On MIPS, Alpha and System V Release 4 systems this option
2896 produces stabs debugging output which is not understood by DBX or SDB@.
2897 On System V Release 4 systems this option requires the GNU assembler.
2898
2899 @item -gstabs+
2900 @opindex gstabs+
2901 Produce debugging information in stabs format (if that is supported),
2902 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2903 use of these extensions is likely to make other debuggers crash or
2904 refuse to read the program.
2905
2906 @item -gcoff
2907 @opindex gcoff
2908 Produce debugging information in COFF format (if that is supported).
2909 This is the format used by SDB on most System V systems prior to
2910 System V Release 4.
2911
2912 @item -gxcoff
2913 @opindex gxcoff
2914 Produce debugging information in XCOFF format (if that is supported).
2915 This is the format used by the DBX debugger on IBM RS/6000 systems.
2916
2917 @item -gxcoff+
2918 @opindex gxcoff+
2919 Produce debugging information in XCOFF format (if that is supported),
2920 using GNU extensions understood only by the GNU debugger (GDB)@.  The
2921 use of these extensions is likely to make other debuggers crash or
2922 refuse to read the program, and may cause assemblers other than the GNU
2923 assembler (GAS) to fail with an error.
2924
2925 @item -gdwarf
2926 @opindex gdwarf
2927 Produce debugging information in DWARF version 1 format (if that is
2928 supported).  This is the format used by SDB on most System V Release 4
2929 systems.
2930
2931 This option is deprecated.
2932
2933 @item -gdwarf+
2934 @opindex gdwarf+
2935 Produce debugging information in DWARF version 1 format (if that is
2936 supported), using GNU extensions understood only by the GNU debugger
2937 (GDB)@.  The use of these extensions is likely to make other debuggers
2938 crash or refuse to read the program.
2939
2940 This option is deprecated.
2941
2942 @item -gdwarf-2
2943 @opindex gdwarf-2
2944 Produce debugging information in DWARF version 2 format (if that is
2945 supported).  This is the format used by DBX on IRIX 6.
2946
2947 @item -gvms
2948 @opindex gvms
2949 Produce debugging information in VMS debug format (if that is
2950 supported).  This is the format used by DEBUG on VMS systems.
2951
2952 @item -g@var{level}
2953 @itemx -ggdb@var{level}
2954 @itemx -gstabs@var{level}
2955 @itemx -gcoff@var{level}
2956 @itemx -gxcoff@var{level}
2957 @itemx -gvms@var{level}
2958 Request debugging information and also use @var{level} to specify how
2959 much information.  The default level is 2.
2960
2961 Level 1 produces minimal information, enough for making backtraces in
2962 parts of the program that you don't plan to debug.  This includes
2963 descriptions of functions and external variables, but no information
2964 about local variables and no line numbers.
2965
2966 Level 3 includes extra information, such as all the macro definitions
2967 present in the program.  Some debuggers support macro expansion when
2968 you use @option{-g3}.
2969
2970 Note that in order to avoid confusion between DWARF1 debug level 2,
2971 and DWARF2, neither @option{-gdwarf} nor @option{-gdwarf-2} accept
2972 a concatenated debug level.  Instead use an additional @option{-g@var{level}}
2973 option to change the debug level for DWARF1 or DWARF2.
2974
2975 @item -feliminate-dwarf2-dups
2976 @opindex feliminate-dwarf2-dups
2977 Compress DWARF2 debugging information by eliminating duplicated
2978 information about each symbol.  This option only makes sense when
2979 generating DWARF2 debugging information with @option{-gdwarf-2}.
2980
2981 @cindex @command{prof}
2982 @item -p
2983 @opindex p
2984 Generate extra code to write profile information suitable for the
2985 analysis program @command{prof}.  You must use this option when compiling
2986 the source files you want data about, and you must also use it when
2987 linking.
2988
2989 @cindex @command{gprof}
2990 @item -pg
2991 @opindex pg
2992 Generate extra code to write profile information suitable for the
2993 analysis program @command{gprof}.  You must use this option when compiling
2994 the source files you want data about, and you must also use it when
2995 linking.
2996
2997 @item -Q
2998 @opindex Q
2999 Makes the compiler print out each function name as it is compiled, and
3000 print some statistics about each pass when it finishes.
3001
3002 @item -ftime-report
3003 @opindex ftime-report
3004 Makes the compiler print some statistics about the time consumed by each
3005 pass when it finishes.
3006
3007 @item -fmem-report
3008 @opindex fmem-report
3009 Makes the compiler print some statistics about permanent memory
3010 allocation when it finishes.
3011
3012 @item -fprofile-arcs
3013 @opindex fprofile-arcs
3014 Add code so that program flow @dfn{arcs} are instrumented.  During
3015 execution the program records how many times each branch and call is
3016 executed and how many times it is taken or returns.  When the compiled
3017 program exits it saves this data to a file called
3018 @file{@var{auxname}.da} for each source file. The data may be used for
3019 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3020 test coverage analysis (@option{-ftest-coverage}). Each object file's
3021 @var{auxname} is generated from the name of the output file, if
3022 explicitly specified and it is not the final executable, otherwise it is
3023 the basename of the source file. In both cases any suffix is removed
3024 (e.g.  @file{foo.da} for input file @file{dir/foo.c}, or
3025 @file{dir/foo.da} for output file specified as @option{-o dir/foo.o}).
3026
3027 @itemize
3028
3029 @item
3030 Compile the source files with @option{-fprofile-arcs} plus optimization
3031 and code generation options. For test coverage analysis, use the
3032 additional @option{-ftest-coverage} option. You do not need to profile
3033 every source file in a program.
3034
3035 @item
3036 Link your object files as normal.
3037
3038 @item
3039 Run the program on a representative workload to generate the arc profile
3040 information. This may be repeated any number of times.
3041
3042 @item
3043 For profile-directed optimizations, compile the source files again with
3044 the same optimization and code generation options plus
3045 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3046 Control Optimization}).
3047
3048 @item
3049 For test coverage analysis, use @command{gcov} to produce human readable
3050 information from the @file{.bbg} and @file{.da} files. Refer to the
3051 @command{gcov} documentation for further information.
3052
3053 @end itemize
3054
3055 With @option{-fprofile-arcs}, for each function of your program GCC
3056 creates a program flow graph, then finds a spanning tree for the graph.
3057 Only arcs that are not on the spanning tree have to be instrumented: the
3058 compiler adds code to count the number of times that these arcs are
3059 executed.  When an arc is the only exit or only entrance to a block, the
3060 instrumentation code can be added to the block; otherwise, a new basic
3061 block must be created to hold the instrumentation code.
3062
3063 @need 2000
3064 @item -ftest-coverage
3065 @opindex ftest-coverage
3066 Produce a graph file that the @command{gcov} code-coverage utility
3067 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3068 show program coverage. Each source file's data file is called
3069 @file{@var{auxname}.bbg}. Refer to the @option{-fprofile-arcs} option
3070 above for a description of @var{auxname} and instructions on how to
3071 generate test coverage data. Coverage data will match the source files
3072 more closely, if you do not optimize.
3073
3074 @item -d@var{letters}
3075 @opindex d
3076 Says to make debugging dumps during compilation at times specified by
3077 @var{letters}.  This is used for debugging the compiler.  The file names
3078 for most of the dumps are made by appending a pass number and a word to
3079 the @var{dumpname}. @var{dumpname} is generated from the name of the
3080 output file, if explicitly specified and it is not an executable,
3081 otherwise it is the basename of the source file. In both cases any
3082 suffix is removed (e.g.  @file{foo.00.rtl} or @file{foo.01.sibling}).
3083 Here are the possible letters for use in @var{letters}, and their
3084 meanings:
3085
3086 @table @samp
3087 @item A
3088 @opindex dA
3089 Annotate the assembler output with miscellaneous debugging information.
3090 @item b
3091 @opindex db
3092 Dump after computing branch probabilities, to @file{@var{file}.14.bp}.
3093 @item B
3094 @opindex dB
3095 Dump after block reordering, to @file{@var{file}.32.bbro}.
3096 @item c
3097 @opindex dc
3098 Dump after instruction combination, to the file @file{@var{file}.19.combine}.
3099 @item C
3100 @opindex dC
3101 Dump after the first if conversion, to the file @file{@var{file}.15.ce1}.
3102 @item d
3103 @opindex dd
3104 Dump after delayed branch scheduling, to @file{@var{file}.34.dbr}.
3105 @item D
3106 @opindex dD
3107 Dump all macro definitions, at the end of preprocessing, in addition to
3108 normal output.
3109 @item e
3110 @opindex de
3111 Dump after SSA optimizations, to @file{@var{file}.04.ssa} and
3112 @file{@var{file}.07.ussa}.
3113 @item E
3114 @opindex dE
3115 Dump after the second if conversion, to @file{@var{file}.29.ce3}.
3116 @item f
3117 @opindex df
3118 Dump after life analysis, to @file{@var{file}.18.life}.
3119 @item F
3120 @opindex dF
3121 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.10.addressof}.
3122 @item g
3123 @opindex dg
3124 Dump after global register allocation, to @file{@var{file}.24.greg}.
3125 @item h
3126 @opindex dh
3127 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3128 @item k
3129 @opindex dk
3130 Dump after reg-to-stack conversion, to @file{@var{file}.31.stack}.
3131 @item o
3132 @opindex do
3133 Dump after post-reload optimizations, to @file{@var{file}.25.postreload}.
3134 @item G
3135 @opindex dG
3136 Dump after GCSE, to @file{@var{file}.11.gcse}.
3137 @item i
3138 @opindex di
3139 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3140 @item j
3141 @opindex dj
3142 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3143 @item k
3144 @opindex dk
3145 Dump after conversion from registers to stack, to @file{@var{file}.31.stack}.
3146 @item l
3147 @opindex dl
3148 Dump after local register allocation, to @file{@var{file}.23.lreg}.
3149 @item L
3150 @opindex dL
3151 Dump after loop optimization passes, to @file{@var{file}.12.loop} and
3152 @file{@var{file}.18.loop2}.
3153 @item M
3154 @opindex dM
3155 Dump after performing the machine dependent reorganization pass, to
3156 @file{@var{file}.33.mach}.
3157 @item n
3158 @opindex dn
3159 Dump after register renumbering, to @file{@var{file}.28.rnreg}.
3160 @item N
3161 @opindex dN
3162 Dump after the register move pass, to @file{@var{file}.21.regmove}.
3163 @item r
3164 @opindex dr
3165 Dump after RTL generation, to @file{@var{file}.00.rtl}.
3166 @item R
3167 @opindex dR
3168 Dump after the second scheduling pass, to @file{@var{file}.30.sched2}.
3169 @item s
3170 @opindex ds
3171 Dump after CSE (including the jump optimization that sometimes follows
3172 CSE), to @file{@var{file}.09.cse}.
3173 @item S
3174 @opindex dS
3175 Dump after the first scheduling pass, to @file{@var{file}.22.sched}.
3176 @item t
3177 @opindex dt
3178 Dump after the second CSE pass (including the jump optimization that
3179 sometimes follows CSE), to @file{@var{file}.17.cse2}.
3180 @item u
3181 @opindex du
3182 Dump after null pointer elimination pass to @file{@var{file}.08.null}.
3183 @item w
3184 @opindex dw
3185 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3186 @item X
3187 @opindex dX
3188 Dump after SSA dead code elimination, to @file{@var{file}.06.ssadce}.
3189 @item z
3190 @opindex dz
3191 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3192 @item a
3193 @opindex da
3194 Produce all the dumps listed above.
3195 @item H
3196 @opindex dH
3197 Produce a core dump whenever an error occurs.
3198 @item m
3199 @opindex dm
3200 Print statistics on memory usage, at the end of the run, to
3201 standard error.
3202 @item p
3203 @opindex dp
3204 Annotate the assembler output with a comment indicating which
3205 pattern and alternative was used.  The length of each instruction is
3206 also printed.
3207 @item P
3208 @opindex dP
3209 Dump the RTL in the assembler output as a comment before each instruction.
3210 Also turns on @option{-dp} annotation.
3211 @item v
3212 @opindex dv
3213 For each of the other indicated dump files (except for
3214 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
3215 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3216 @item x
3217 @opindex dx
3218 Just generate RTL for a function instead of compiling it.  Usually used
3219 with @samp{r}.
3220 @item y
3221 @opindex dy
3222 Dump debugging information during parsing, to standard error.
3223 @end table
3224
3225 @item -fdump-unnumbered
3226 @opindex fdump-unnumbered
3227 When doing debugging dumps (see @option{-d} option above), suppress instruction
3228 numbers and line number note output.  This makes it more feasible to
3229 use diff on debugging dumps for compiler invocations with different
3230 options, in particular with and without @option{-g}.
3231
3232 @item -fdump-translation-unit @r{(C and C++ only)}
3233 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3234 @opindex fdump-translation-unit
3235 Dump a representation of the tree structure for the entire translation
3236 unit to a file.  The file name is made by appending @file{.tu} to the
3237 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3238 controls the details of the dump as described for the
3239 @option{-fdump-tree} options.
3240
3241 @item -fdump-class-hierarchy @r{(C++ only)}
3242 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3243 @opindex fdump-class-hierarchy
3244 Dump a representation of each class's hierarchy and virtual function
3245 table layout to a file.  The file name is made by appending @file{.class}
3246 to the source file name.  If the @samp{-@var{options}} form is used,
3247 @var{options} controls the details of the dump as described for the
3248 @option{-fdump-tree} options.
3249
3250 @item -fdump-tree-@var{switch} @r{(C++ only)}
3251 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C++ only)}
3252 @opindex fdump-tree
3253 Control the dumping at various stages of processing the intermediate
3254 language tree to a file.  The file name is generated by appending a switch
3255 specific suffix to the source file name.  If the @samp{-@var{options}}
3256 form is used, @var{options} is a list of @samp{-} separated options that
3257 control the details of the dump. Not all options are applicable to all
3258 dumps, those which are not meaningful will be ignored. The following
3259 options are available
3260
3261 @table @samp
3262 @item address
3263 Print the address of each node.  Usually this is not meaningful as it
3264 changes according to the environment and source file. Its primary use
3265 is for tying up a dump file with a debug environment.
3266 @item slim
3267 Inhibit dumping of members of a scope or body of a function merely
3268 because that scope has been reached. Only dump such items when they
3269 are directly reachable by some other path.
3270 @item all
3271 Turn on all options.
3272 @end table
3273
3274 The following tree dumps are possible:
3275 @table @samp
3276 @item original
3277 Dump before any tree based optimization, to @file{@var{file}.original}.
3278 @item optimized
3279 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3280 @item inlined
3281 Dump after function inlining, to @file{@var{file}.inlined}.
3282 @end table
3283
3284 @item -fsched-verbose=@var{n}
3285 @opindex fsched-verbose
3286 On targets that use instruction scheduling, this option controls the
3287 amount of debugging output the scheduler prints.  This information is
3288 written to standard error, unless @option{-dS} or @option{-dR} is
3289 specified, in which case it is output to the usual dump
3290 listing file, @file{.sched} or @file{.sched2} respectively.  However
3291 for @var{n} greater than nine, the output is always printed to standard
3292 error.
3293
3294 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3295 same information as @option{-dRS}.  For @var{n} greater than one, it
3296 also output basic block probabilities, detailed ready list information
3297 and unit/insn info.  For @var{n} greater than two, it includes RTL
3298 at abort point, control-flow and regions info.  And for @var{n} over
3299 four, @option{-fsched-verbose} also includes dependence info.
3300
3301 @item -save-temps
3302 @opindex save-temps
3303 Store the usual ``temporary'' intermediate files permanently; place them
3304 in the current directory and name them based on the source file.  Thus,
3305 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3306 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3307 preprocessed @file{foo.i} output file even though the compiler now
3308 normally uses an integrated preprocessor.
3309
3310 @item -time
3311 @opindex time
3312 Report the CPU time taken by each subprocess in the compilation
3313 sequence.  For C source files, this is the compiler proper and assembler
3314 (plus the linker if linking is done).  The output looks like this:
3315
3316 @smallexample
3317 # cc1 0.12 0.01
3318 # as 0.00 0.01
3319 @end smallexample
3320
3321 The first number on each line is the ``user time,'' that is time spent
3322 executing the program itself.  The second number is ``system time,''
3323 time spent executing operating system routines on behalf of the program.
3324 Both numbers are in seconds.
3325
3326 @item -print-file-name=@var{library}
3327 @opindex print-file-name
3328 Print the full absolute name of the library file @var{library} that
3329 would be used when linking---and don't do anything else.  With this
3330 option, GCC does not compile or link anything; it just prints the
3331 file name.
3332
3333 @item -print-multi-directory
3334 @opindex print-multi-directory
3335 Print the directory name corresponding to the multilib selected by any
3336 other switches present in the command line.  This directory is supposed
3337 to exist in @env{GCC_EXEC_PREFIX}.
3338
3339 @item -print-multi-lib
3340 @opindex print-multi-lib
3341 Print the mapping from multilib directory names to compiler switches
3342 that enable them.  The directory name is separated from the switches by
3343 @samp{;}, and each switch starts with an @samp{@@} instead of the
3344 @samp{-}, without spaces between multiple switches.  This is supposed to
3345 ease shell-processing.
3346
3347 @item -print-prog-name=@var{program}
3348 @opindex print-prog-name
3349 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3350
3351 @item -print-libgcc-file-name
3352 @opindex print-libgcc-file-name
3353 Same as @option{-print-file-name=libgcc.a}.
3354
3355 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3356 but you do want to link with @file{libgcc.a}.  You can do
3357
3358 @example
3359 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3360 @end example
3361
3362 @item -print-search-dirs
3363 @opindex print-search-dirs
3364 Print the name of the configured installation directory and a list of
3365 program and library directories gcc will search---and don't do anything else.
3366
3367 This is useful when gcc prints the error message
3368 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3369 To resolve this you either need to put @file{cpp0} and the other compiler
3370 components where gcc expects to find them, or you can set the environment
3371 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3372 Don't forget the trailing '/'.
3373 @xref{Environment Variables}.
3374
3375 @item -dumpmachine
3376 @opindex dumpmachine
3377 Print the compiler's target machine (for example,
3378 @samp{i686-pc-linux-gnu})---and don't do anything else.
3379
3380 @item -dumpversion
3381 @opindex dumpversion
3382 Print the compiler version (for example, @samp{3.0})---and don't do
3383 anything else.
3384
3385 @item -dumpspecs
3386 @opindex dumpspecs
3387 Print the compiler's built-in specs---and don't do anything else.  (This
3388 is used when GCC itself is being built.)  @xref{Spec Files}.
3389
3390 @item -feliminate-unused-debug-types
3391 @opindex feliminate-unused-debug-types
3392 Normally, when producing DWARF2 output, GCC will emit debugging
3393 information for all types declared in a compilation
3394 unit, regardless of whether or not they are actually used
3395 in that compilation unit.  Sometimes this is useful, such as
3396 if, in the debugger, you want to cast a value to a type that is
3397 not actually used in your program (but is declared).  More often,
3398 however, this results in a significant amount of wasted space.
3399 With this option, GCC will avoid producing debug symbol output
3400 for types that are nowhere used in the source file being compiled.
3401 @end table
3402
3403 @node Optimize Options
3404 @section Options That Control Optimization
3405 @cindex optimize options
3406 @cindex options, optimization
3407
3408 These options control various sorts of optimizations.
3409
3410 Without any optimization option, the compiler's goal is to reduce the
3411 cost of compilation and to make debugging produce the expected
3412 results.  Statements are independent: if you stop the program with a
3413 breakpoint between statements, you can then assign a new value to any
3414 variable or change the program counter to any other statement in the
3415 function and get exactly the results you would expect from the source
3416 code.
3417
3418 Turning on optimization flags makes the compiler attempt to improve
3419 the performance and/or code size at the expense of compilation time
3420 and possibly the ability to debug the program.
3421
3422 Not all optimizations are controlled directly by a flag.  Only
3423 optimizations that have a flag are listed.
3424
3425 @table @gcctabopt
3426 @item -O
3427 @itemx -O1
3428 @opindex O
3429 @opindex O1
3430 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3431 more memory for a large function.
3432
3433 With @option{-O}, the compiler tries to reduce code size and execution
3434 time, without performing any optimizations that take a great deal of
3435 compilation time.
3436
3437 @option{-O} turns on the following optimization flags: 
3438 @gccoptlist{-fdefer-pop @gol
3439 -fmerge-constants @gol
3440 -fthread-jumps @gol
3441 -floop-optimize @gol
3442 -fcrossjumping @gol
3443 -fif-conversion @gol
3444 -fif-conversion2 @gol
3445 -fdelayed-branch @gol
3446 -fguess-branch-probability @gol
3447 -fcprop-registers}
3448
3449 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3450 where doing so does not interfere with debugging.
3451
3452 @item -O2
3453 @opindex O2
3454 Optimize even more.  GCC performs nearly all supported optimizations
3455 that do not involve a space-speed tradeoff.  The compiler does not
3456 perform loop unrolling or function inlining when you specify @option{-O2}.
3457 As compared to @option{-O}, this option increases both compilation time
3458 and the performance of the generated code.
3459
3460 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3461 also turns on the following optimization flags:
3462 @gccoptlist{-fforce-mem @gol
3463 -foptimize-sibling-calls @gol
3464 -fstrength-reduce @gol
3465 -fcse-follow-jumps  -fcse-skip-blocks @gol
3466 -frerun-cse-after-loop  -frerun-loop-opt @gol
3467 -fgcse   -fgcse-lm   -fgcse-sm @gol
3468 -fdelete-null-pointer-checks @gol
3469 -fexpensive-optimizations @gol
3470 -fregmove @gol
3471 -fschedule-insns  -fschedule-insns2 @gol
3472 -fsched-interblock  -fsched-spec @gol
3473 -fcaller-saves @gol
3474 -fpeephole2 @gol
3475 -freorder-blocks  -freorder-functions @gol
3476 -fstrict-aliasing @gol
3477 -falign-functions  -falign-jumps @gol
3478 -falign-loops  -falign-labels}
3479
3480 Please note the warning under @option{-fgcse} about
3481 invoking @option{-O2} on programs that use computed gotos.
3482
3483 @item -O3
3484 @opindex O3
3485 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3486 @option{-O2} and also turns on the @option{-finline-functions},
3487 @option{-funit-at-a-time} and @option{-frename-registers} options.
3488
3489 @item -O0
3490 @opindex O0
3491 Do not optimize.  This is the default.
3492
3493 @item -Os
3494 @opindex Os
3495 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3496 do not typically increase code size.  It also performs further
3497 optimizations designed to reduce code size.
3498
3499 @option{-Os} disables the following optimization flags:
3500 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3501 -falign-labels  -freorder-blocks  -fprefetch-loop-arrays}
3502
3503 If you use multiple @option{-O} options, with or without level numbers,
3504 the last such option is the one that is effective.
3505 @end table
3506
3507 Options of the form @option{-f@var{flag}} specify machine-independent
3508 flags.  Most flags have both positive and negative forms; the negative
3509 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3510 below, only one of the forms is listed---the one you typically will
3511 use.  You can figure out the other form by either removing @samp{no-}
3512 or adding it.
3513
3514 The following options control specific optimizations.  They are either
3515 activated by @option{-O} options or are related to ones that are.  You
3516 can use the following flags in the rare cases when ``fine-tuning'' of
3517 optimizations to be performed is desired.
3518
3519 @table @gcctabopt
3520 @item -fno-default-inline
3521 @opindex fno-default-inline
3522 Do not make member functions inline by default merely because they are
3523 defined inside the class scope (C++ only).  Otherwise, when you specify
3524 @w{@option{-O}}, member functions defined inside class scope are compiled
3525 inline by default; i.e., you don't need to add @samp{inline} in front of
3526 the member function name.
3527
3528 @item -fno-defer-pop
3529 @opindex fno-defer-pop
3530 Always pop the arguments to each function call as soon as that function
3531 returns.  For machines which must pop arguments after a function call,
3532 the compiler normally lets arguments accumulate on the stack for several
3533 function calls and pops them all at once.
3534
3535 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3536
3537 @item -fforce-mem
3538 @opindex fforce-mem
3539 Force memory operands to be copied into registers before doing
3540 arithmetic on them.  This produces better code by making all memory
3541 references potential common subexpressions.  When they are not common
3542 subexpressions, instruction combination should eliminate the separate
3543 register-load.
3544
3545 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3546
3547 @item -fforce-addr
3548 @opindex fforce-addr
3549 Force memory address constants to be copied into registers before
3550 doing arithmetic on them.  This may produce better code just as
3551 @option{-fforce-mem} may.
3552
3553 @item -fomit-frame-pointer
3554 @opindex fomit-frame-pointer
3555 Don't keep the frame pointer in a register for functions that
3556 don't need one.  This avoids the instructions to save, set up and
3557 restore frame pointers; it also makes an extra register available
3558 in many functions.  @strong{It also makes debugging impossible on
3559 some machines.}
3560
3561 On some machines, such as the VAX, this flag has no effect, because
3562 the standard calling sequence automatically handles the frame pointer
3563 and nothing is saved by pretending it doesn't exist.  The
3564 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3565 whether a target machine supports this flag.  @xref{Registers,,Register
3566 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3567
3568 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3569
3570 @item -foptimize-sibling-calls
3571 @opindex foptimize-sibling-calls
3572 Optimize sibling and tail recursive calls.
3573
3574 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3575
3576 @item -fno-inline
3577 @opindex fno-inline
3578 Don't pay attention to the @code{inline} keyword.  Normally this option
3579 is used to keep the compiler from expanding any functions inline.
3580 Note that if you are not optimizing, no functions can be expanded inline.
3581
3582 @item -finline-functions
3583 @opindex finline-functions
3584 Integrate all simple functions into their callers.  The compiler
3585 heuristically decides which functions are simple enough to be worth
3586 integrating in this way.
3587
3588 If all calls to a given function are integrated, and the function is
3589 declared @code{static}, then the function is normally not output as
3590 assembler code in its own right.
3591
3592 Enabled at level @option{-O3}.
3593
3594 @item -finline-limit=@var{n}
3595 @opindex finline-limit
3596 By default, gcc limits the size of functions that can be inlined.  This flag
3597 allows the control of this limit for functions that are explicitly marked as
3598 inline (i.e., marked with the inline keyword or defined within the class
3599 definition in c++).  @var{n} is the size of functions that can be inlined in
3600 number of pseudo instructions (not counting parameter handling).  The default
3601 value of @var{n} is 600.
3602 Increasing this value can result in more inlined code at
3603 the cost of compilation time and memory consumption.  Decreasing usually makes
3604 the compilation faster and less code will be inlined (which presumably
3605 means slower programs).  This option is particularly useful for programs that
3606 use inlining heavily such as those based on recursive templates with C++.
3607
3608 Inlining is actually controlled by a number of parameters, which may be
3609 specified individually by using @option{--param @var{name}=@var{value}}.
3610 The @option{-finline-limit=@var{n}} option sets some of these parameters 
3611 as follows:
3612
3613 @table @gcctabopt
3614  @item max-inline-insns
3615   is set to @var{n}.
3616  @item max-inline-insns-single
3617   is set to @var{n}/2.
3618  @item max-inline-insns-single-auto
3619   is set to @var{n}/2.
3620  @item min-inline-insns
3621   is set to 130 or @var{n}/4, whichever is smaller.
3622  @item max-inline-insns-rtl
3623   is set to @var{n}.
3624 @end table
3625
3626 Using @option{-finline-limit=600} thus results in the default settings
3627 for these parameters.  See below for a documentation of the individual
3628 parameters controlling inlining.
3629
3630 @emph{Note:} pseudo instruction represents, in this particular context, an
3631 abstract measurement of function's size.  In no way, it represents a count
3632 of assembly instructions and as such its exact meaning might change from one
3633 release to an another.
3634
3635 @item -fkeep-inline-functions
3636 @opindex fkeep-inline-functions
3637 Even if all calls to a given function are integrated, and the function
3638 is declared @code{static}, nevertheless output a separate run-time
3639 callable version of the function.  This switch does not affect
3640 @code{extern inline} functions.
3641
3642 @item -fkeep-static-consts
3643 @opindex fkeep-static-consts
3644 Emit variables declared @code{static const} when optimization isn't turned
3645 on, even if the variables aren't referenced.
3646
3647 GCC enables this option by default.  If you want to force the compiler to
3648 check if the variable was referenced, regardless of whether or not
3649 optimization is turned on, use the @option{-fno-keep-static-consts} option.
3650
3651 @item -fmerge-constants
3652 Attempt to merge identical constants (string constants and floating point
3653 constants) across compilation units.
3654
3655 This option is the default for optimized compilation if the assembler and
3656 linker support it.  Use @option{-fno-merge-constants} to inhibit this
3657 behavior.
3658
3659 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3660
3661 @item -fmerge-all-constants
3662 Attempt to merge identical constants and identical variables.
3663
3664 This option implies @option{-fmerge-constants}.  In addition to
3665 @option{-fmerge-constants} this considers e.g. even constant initialized
3666 arrays or initialized constant variables with integral or floating point
3667 types.  Languages like C or C++ require each non-automatic variable to
3668 have distinct location, so using this option will result in non-conforming
3669 behavior.
3670
3671 @item -fnew-ra
3672 @opindex fnew-ra
3673 Use a graph coloring register allocator.  Currently this option is meant
3674 for testing, so we are interested to hear about miscompilations with
3675 @option{-fnew-ra}.
3676
3677 @item -fno-branch-count-reg
3678 @opindex fno-branch-count-reg
3679 Do not use ``decrement and branch'' instructions on a count register,
3680 but instead generate a sequence of instructions that decrement a
3681 register, compare it against zero, then branch based upon the result.
3682 This option is only meaningful on architectures that support such
3683 instructions, which include x86, PowerPC, IA-64 and S/390.
3684
3685 The default is @option{-fbranch-count-reg}, enabled when
3686 @option{-fstrength-reduce} is enabled.
3687
3688 @item -fno-function-cse
3689 @opindex fno-function-cse
3690 Do not put function addresses in registers; make each instruction that
3691 calls a constant function contain the function's address explicitly.
3692
3693 This option results in less efficient code, but some strange hacks
3694 that alter the assembler output may be confused by the optimizations
3695 performed when this option is not used.
3696
3697 The default is @option{-ffunction-cse}
3698
3699 @item -fno-zero-initialized-in-bss
3700 @opindex fno-zero-initialized-in-bss
3701 If the target supports a BSS section, GCC by default puts variables that
3702 are initialized to zero into BSS@.  This can save space in the resulting
3703 code.
3704
3705 This option turns off this behavior because some programs explicitly
3706 rely on variables going to the data section.  E.g., so that the
3707 resulting executable can find the beginning of that section and/or make
3708 assumptions based on that.
3709
3710 The default is @option{-fzero-initialized-in-bss}.
3711
3712 @item -fstrength-reduce
3713 @opindex fstrength-reduce
3714 Perform the optimizations of loop strength reduction and
3715 elimination of iteration variables.
3716
3717 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3718
3719 @item -fthread-jumps
3720 @opindex fthread-jumps
3721 Perform optimizations where we check to see if a jump branches to a
3722 location where another comparison subsumed by the first is found.  If
3723 so, the first branch is redirected to either the destination of the
3724 second branch or a point immediately following it, depending on whether
3725 the condition is known to be true or false.
3726
3727 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3728
3729 @item -fcse-follow-jumps
3730 @opindex fcse-follow-jumps
3731 In common subexpression elimination, scan through jump instructions
3732 when the target of the jump is not reached by any other path.  For
3733 example, when CSE encounters an @code{if} statement with an
3734 @code{else} clause, CSE will follow the jump when the condition
3735 tested is false.
3736
3737 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3738
3739 @item -fcse-skip-blocks
3740 @opindex fcse-skip-blocks
3741 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
3742 follow jumps which conditionally skip over blocks.  When CSE
3743 encounters a simple @code{if} statement with no else clause,
3744 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
3745 body of the @code{if}.
3746
3747 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3748
3749 @item -frerun-cse-after-loop
3750 @opindex frerun-cse-after-loop
3751 Re-run common subexpression elimination after loop optimizations has been
3752 performed.
3753
3754 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3755
3756 @item -frerun-loop-opt
3757 @opindex frerun-loop-opt
3758 Run the loop optimizer twice.
3759
3760 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3761
3762 @item -fgcse
3763 @opindex fgcse
3764 Perform a global common subexpression elimination pass.
3765 This pass also performs global constant and copy propagation.
3766
3767 @emph{Note:} When compiling a program using computed gotos, a GCC
3768 extension, you may get better runtime performance if you disable
3769 the global common subexpression elimination pass by adding
3770 @option{-fno-gcse} to the command line.
3771
3772 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3773
3774 @item -fgcse-lm
3775 @opindex fgcse-lm
3776 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
3777 attempt to move loads which are only killed by stores into themselves.  This
3778 allows a loop containing a load/store sequence to be changed to a load outside
3779 the loop, and a copy/store within the loop.
3780
3781 Enabled by default when gcse is enabled.
3782
3783 @item -fgcse-sm
3784 @opindex fgcse-sm
3785 When @option{-fgcse-sm} is enabled, A store motion pass is run after global common
3786 subexpression elimination.  This pass will attempt to move stores out of loops.
3787 When used in conjunction with @option{-fgcse-lm}, loops containing a load/store sequence
3788 can be changed to a load before the loop and a store after the loop.
3789
3790 Enabled by default when gcse is enabled.
3791
3792 @item -floop-optimize
3793 @opindex floop-optimize
3794 Perform loop optimizations: move constant expressions out of loops, simplify
3795 exit test conditions and optionally do strength-reduction and loop unrolling as
3796 well.
3797
3798 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3799
3800 @item -fcrossjumping
3801 @opindex crossjumping
3802 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
3803 resulting code may or may not perform better than without cross-jumping.
3804
3805 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3806
3807 @item -fif-conversion
3808 @opindex if-conversion
3809 Attempt to transform conditional jumps into branch-less equivalents.  This
3810 include use of conditional moves, min, max, set flags and abs instructions, and
3811 some tricks doable by standard arithmetics.  The use of conditional execution
3812 on chips where it is available is controlled by @code{if-conversion2}.
3813
3814 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3815
3816 @item -fif-conversion2
3817 @opindex if-conversion2
3818 Use conditional execution (where available) to transform conditional jumps into
3819 branch-less equivalents.
3820
3821 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3822
3823 @item -fdelete-null-pointer-checks
3824 @opindex fdelete-null-pointer-checks
3825 Use global dataflow analysis to identify and eliminate useless checks
3826 for null pointers.  The compiler assumes that dereferencing a null
3827 pointer would have halted the program.  If a pointer is checked after
3828 it has already been dereferenced, it cannot be null.
3829
3830 In some environments, this assumption is not true, and programs can
3831 safely dereference null pointers.  Use
3832 @option{-fno-delete-null-pointer-checks} to disable this optimization
3833 for programs which depend on that behavior.
3834
3835 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3836
3837 @item -fexpensive-optimizations
3838 @opindex fexpensive-optimizations
3839 Perform a number of minor optimizations that are relatively expensive.
3840
3841 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3842
3843 @item -foptimize-register-move
3844 @itemx -fregmove
3845 @opindex foptimize-register-move
3846 @opindex fregmove
3847 Attempt to reassign register numbers in move instructions and as
3848 operands of other simple instructions in order to maximize the amount of
3849 register tying.  This is especially helpful on machines with two-operand
3850 instructions.
3851
3852 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3853 optimization.
3854
3855 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3856
3857 @item -fdelayed-branch
3858 @opindex fdelayed-branch
3859 If supported for the target machine, attempt to reorder instructions
3860 to exploit instruction slots available after delayed branch
3861 instructions.
3862
3863 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3864
3865 @item -fschedule-insns
3866 @opindex fschedule-insns
3867 If supported for the target machine, attempt to reorder instructions to
3868 eliminate execution stalls due to required data being unavailable.  This
3869 helps machines that have slow floating point or memory load instructions
3870 by allowing other instructions to be issued until the result of the load
3871 or floating point instruction is required.
3872
3873 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3874
3875 @item -fschedule-insns2
3876 @opindex fschedule-insns2
3877 Similar to @option{-fschedule-insns}, but requests an additional pass of
3878 instruction scheduling after register allocation has been done.  This is
3879 especially useful on machines with a relatively small number of
3880 registers and where memory load instructions take more than one cycle.
3881
3882 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3883
3884 @item -fno-sched-interblock
3885 @opindex fno-sched-interblock
3886 Don't schedule instructions across basic blocks.  This is normally
3887 enabled by default when scheduling before register allocation, i.e.@:
3888 with @option{-fschedule-insns} or at @option{-O2} or higher.
3889
3890 @item -fno-sched-spec
3891 @opindex fno-sched-spec
3892 Don't allow speculative motion of non-load instructions.  This is normally
3893 enabled by default when scheduling before register allocation, i.e.@:
3894 with @option{-fschedule-insns} or at @option{-O2} or higher.
3895
3896 @item -fsched-spec-load
3897 @opindex fsched-spec-load
3898 Allow speculative motion of some load instructions.  This only makes
3899 sense when scheduling before register allocation, i.e.@: with
3900 @option{-fschedule-insns} or at @option{-O2} or higher.
3901
3902 @item -fsched-spec-load-dangerous
3903 @opindex fsched-spec-load-dangerous
3904 Allow speculative motion of more load instructions.  This only makes
3905 sense when scheduling before register allocation, i.e.@: with
3906 @option{-fschedule-insns} or at @option{-O2} or higher.
3907
3908 @item -fsched2-use-superblocks
3909 @opindex fsched2-use-superblocks
3910 When schedulilng after register allocation, do use superblock scheduling
3911 algorithm.  Superblock scheduling allows motion acress basic block boundaries
3912 resulting on faster schedules.  This option is experimental, as not all machine
3913 descriptions used by GCC model the CPU closely enought to avoid unreliable
3914 results from the algorithm. 
3915
3916 This only makes sense when scheduling after register allocation, i.e.@: with
3917 @option{-fschedule-insns2} or at @option{-O2} or higher.
3918
3919 @item -fsched2-use-traces
3920 @opindex fsched2-use-traces
3921 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
3922 allocation and additionally perform code duplication in order to increase the
3923 size of superblocks using tracer pass.  See @option{-ftracer} for details on
3924 trace formation.
3925
3926 This mode should produce faster but singificantly longer programs.  Also
3927 without @code{-fbranch-probabilities} the traces constructed may not match the
3928 reality and hurt the performance.  This only makes
3929 sense when scheduling after register allocation, i.e.@: with
3930 @option{-fschedule-insns2} or at @option{-O2} or higher.
3931
3932 @item -fcaller-saves
3933 @opindex fcaller-saves
3934 Enable values to be allocated in registers that will be clobbered by
3935 function calls, by emitting extra instructions to save and restore the
3936 registers around such calls.  Such allocation is done only when it
3937 seems to result in better code than would otherwise be produced.
3938
3939 This option is always enabled by default on certain machines, usually
3940 those which have no call-preserved registers to use instead.
3941
3942 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3943
3944 @item -fmove-all-movables
3945 @opindex fmove-all-movables
3946 Forces all invariant computations in loops to be moved
3947 outside the loop.
3948
3949 @item -freduce-all-givs
3950 @opindex freduce-all-givs
3951 Forces all general-induction variables in loops to be
3952 strength-reduced.
3953
3954 @emph{Note:} When compiling programs written in Fortran,
3955 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
3956 by default when you use the optimizer.
3957
3958 These options may generate better or worse code; results are highly
3959 dependent on the structure of loops within the source code.
3960
3961 These two options are intended to be removed someday, once
3962 they have helped determine the efficacy of various
3963 approaches to improving loop optimizations.
3964
3965 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3966 know how use of these options affects
3967 the performance of your production code.
3968 We're very interested in code that runs @emph{slower}
3969 when these options are @emph{enabled}.
3970
3971 @item -fno-peephole
3972 @itemx -fno-peephole2
3973 @opindex fno-peephole
3974 @opindex fno-peephole2
3975 Disable any machine-specific peephole optimizations.  The difference
3976 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
3977 are implemented in the compiler; some targets use one, some use the
3978 other, a few use both.
3979
3980 @option{-fpeephole} is enabled by default.
3981 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3982
3983 @item -fno-guess-branch-probability
3984 @opindex fno-guess-branch-probability
3985 Do not guess branch probabilities using a randomized model.
3986
3987 Sometimes gcc will opt to use a randomized model to guess branch
3988 probabilities, when none are available from either profiling feedback
3989 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
3990 different runs of the compiler on the same program may produce different
3991 object code.
3992
3993 In a hard real-time system, people don't want different runs of the
3994 compiler to produce code that has different behavior; minimizing
3995 non-determinism is of paramount import.  This switch allows users to
3996 reduce non-determinism, possibly at the expense of inferior
3997 optimization.
3998
3999 The default is @option{-fguess-branch-probability} at levels
4000 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4001
4002 @item -freorder-blocks
4003 @opindex freorder-blocks
4004 Reorder basic blocks in the compiled function in order to reduce number of
4005 taken branches and improve code locality.
4006
4007 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4008
4009 @item -freorder-functions
4010 @opindex freorder-functions
4011 Reorder basic blocks in the compiled function in order to reduce number of
4012 taken branches and improve code locality. This is implemented by using special
4013 subsections @code{text.hot} for most frequently executed functions and
4014 @code{text.unlikely} for unlikely executed functions.  Reordering is done by
4015 the linker so object file format must support named sections and linker must
4016 place them in a reasonable way.
4017
4018 Also profile feedback must be available in to make this option effective.  See
4019 @option{-fprofile-arcs} for details.
4020
4021 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4022
4023 @item -fstrict-aliasing
4024 @opindex fstrict-aliasing
4025 Allows the compiler to assume the strictest aliasing rules applicable to
4026 the language being compiled.  For C (and C++), this activates
4027 optimizations based on the type of expressions.  In particular, an
4028 object of one type is assumed never to reside at the same address as an
4029 object of a different type, unless the types are almost the same.  For
4030 example, an @code{unsigned int} can alias an @code{int}, but not a
4031 @code{void*} or a @code{double}.  A character type may alias any other
4032 type.
4033
4034 Pay special attention to code like this:
4035 @example
4036 union a_union @{
4037   int i;
4038   double d;
4039 @};
4040
4041 int f() @{
4042   a_union t;
4043   t.d = 3.0;
4044   return t.i;
4045 @}
4046 @end example
4047 The practice of reading from a different union member than the one most
4048 recently written to (called ``type-punning'') is common.  Even with
4049 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4050 is accessed through the union type.  So, the code above will work as
4051 expected.  However, this code might not:
4052 @example
4053 int f() @{
4054   a_union t;
4055   int* ip;
4056   t.d = 3.0;
4057   ip = &t.i;
4058   return *ip;
4059 @}
4060 @end example
4061
4062 Every language that wishes to perform language-specific alias analysis
4063 should define a function that computes, given an @code{tree}
4064 node, an alias set for the node.  Nodes in different alias sets are not
4065 allowed to alias.  For an example, see the C front-end function
4066 @code{c_get_alias_set}.
4067
4068 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4069
4070 @item -falign-functions
4071 @itemx -falign-functions=@var{n}
4072 @opindex falign-functions
4073 Align the start of functions to the next power-of-two greater than
4074 @var{n}, skipping up to @var{n} bytes.  For instance,
4075 @option{-falign-functions=32} aligns functions to the next 32-byte
4076 boundary, but @option{-falign-functions=24} would align to the next
4077 32-byte boundary only if this can be done by skipping 23 bytes or less.
4078
4079 @option{-fno-align-functions} and @option{-falign-functions=1} are
4080 equivalent and mean that functions will not be aligned.
4081
4082 Some assemblers only support this flag when @var{n} is a power of two;
4083 in that case, it is rounded up.
4084
4085 If @var{n} is not specified, use a machine-dependent default.
4086
4087 Enabled at levels @option{-O2}, @option{-O3}.
4088
4089 @item -falign-labels
4090 @itemx -falign-labels=@var{n}
4091 @opindex falign-labels
4092 Align all branch targets to a power-of-two boundary, skipping up to
4093 @var{n} bytes like @option{-falign-functions}.  This option can easily
4094 make code slower, because it must insert dummy operations for when the
4095 branch target is reached in the usual flow of the code.
4096
4097 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4098 are greater than this value, then their values are used instead.
4099
4100 If @var{n} is not specified, use a machine-dependent default which is
4101 very likely to be @samp{1}, meaning no alignment.
4102
4103 Enabled at levels @option{-O2}, @option{-O3}.
4104
4105 @item -falign-loops
4106 @itemx -falign-loops=@var{n}
4107 @opindex falign-loops
4108 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4109 like @option{-falign-functions}.  The hope is that the loop will be
4110 executed many times, which will make up for any execution of the dummy
4111 operations.
4112
4113 If @var{n} is not specified, use a machine-dependent default.
4114
4115 Enabled at levels @option{-O2}, @option{-O3}.
4116
4117 @item -falign-jumps
4118 @itemx -falign-jumps=@var{n}
4119 @opindex falign-jumps
4120 Align branch targets to a power-of-two boundary, for branch targets
4121 where the targets can only be reached by jumping, skipping up to @var{n}
4122 bytes like @option{-falign-functions}.  In this case, no dummy operations
4123 need be executed.
4124
4125 If @var{n} is not specified, use a machine-dependent default.
4126
4127 Enabled at levels @option{-O2}, @option{-O3}.
4128
4129 @item -frename-registers
4130 @opindex frename-registers
4131 Attempt to avoid false dependencies in scheduled code by making use
4132 of registers left over after register allocation.  This optimization
4133 will most benefit processors with lots of registers.  It can, however,
4134 make debugging impossible, since variables will no longer stay in
4135 a ``home register''.
4136
4137 Enabled at levels @option{-O3}.
4138
4139 @item -fno-cprop-registers
4140 @opindex fno-cprop-registers
4141 After register allocation and post-register allocation instruction splitting,
4142 we perform a copy-propagation pass to try to reduce scheduling dependencies
4143 and occasionally eliminate the copy.
4144
4145 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4146
4147 @end table
4148
4149 The following options control compiler behavior regarding floating
4150 point arithmetic.  These options trade off between speed and
4151 correctness.  All must be specifically enabled.
4152
4153 @table @gcctabopt
4154 @item -ffloat-store
4155 @opindex ffloat-store
4156 Do not store floating point variables in registers, and inhibit other
4157 options that might change whether a floating point value is taken from a
4158 register or memory.
4159
4160 @cindex floating point precision
4161 This option prevents undesirable excess precision on machines such as
4162 the 68000 where the floating registers (of the 68881) keep more
4163 precision than a @code{double} is supposed to have.  Similarly for the
4164 x86 architecture.  For most programs, the excess precision does only
4165 good, but a few programs rely on the precise definition of IEEE floating
4166 point.  Use @option{-ffloat-store} for such programs, after modifying
4167 them to store all pertinent intermediate computations into variables.
4168
4169 @item -ffast-math
4170 @opindex ffast-math
4171 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4172 @option{-fno-trapping-math}, @option{-ffinite-math-only} and @*
4173 @option{-fno-signaling-nans}.
4174
4175 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4176
4177 This option should never be turned on by any @option{-O} option since
4178 it can result in incorrect output for programs which depend on
4179 an exact implementation of IEEE or ISO rules/specifications for
4180 math functions.
4181
4182 @item -fno-math-errno
4183 @opindex fno-math-errno
4184 Do not set ERRNO after calling math functions that are executed
4185 with a single instruction, e.g., sqrt.  A program that relies on
4186 IEEE exceptions for math error handling may want to use this flag
4187 for speed while maintaining IEEE arithmetic compatibility.
4188
4189 This option should never be turned on by any @option{-O} option since
4190 it can result in incorrect output for programs which depend on
4191 an exact implementation of IEEE or ISO rules/specifications for
4192 math functions.
4193
4194 The default is @option{-fmath-errno}.
4195
4196 @item -funsafe-math-optimizations
4197 @opindex funsafe-math-optimizations
4198 Allow optimizations for floating-point arithmetic that (a) assume
4199 that arguments and results are valid and (b) may violate IEEE or
4200 ANSI standards.  When used at link-time, it may include libraries
4201 or startup files that change the default FPU control word or other
4202 similar optimizations.
4203
4204 This option should never be turned on by any @option{-O} option since
4205 it can result in incorrect output for programs which depend on
4206 an exact implementation of IEEE or ISO rules/specifications for
4207 math functions.
4208
4209 The default is @option{-fno-unsafe-math-optimizations}.
4210
4211 @item -ffinite-math-only
4212 @opindex ffinite-math-only
4213 Allow optimizations for floating-point arithmetic that assume
4214 that arguments and results are not NaNs or +-Infs.
4215
4216 This option should never be turned on by any @option{-O} option since
4217 it can result in incorrect output for programs which depend on
4218 an exact implementation of IEEE or ISO rules/specifications.
4219
4220 The default is @option{-fno-finite-math-only}.
4221
4222 @item -fno-trapping-math
4223 @opindex fno-trapping-math
4224 Compile code assuming that floating-point operations cannot generate
4225 user-visible traps.  These traps include division by zero, overflow,
4226 underflow, inexact result and invalid operation.  This option implies
4227 @option{-fno-signaling-nans}.  Setting this option may allow faster
4228 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4229
4230 This option should never be turned on by any @option{-O} option since
4231 it can result in incorrect output for programs which depend on
4232 an exact implementation of IEEE or ISO rules/specifications for
4233 math functions.
4234
4235 The default is @option{-ftrapping-math}.
4236
4237 @item -fsignaling-nans
4238 @opindex fsignaling-nans
4239 Compile code assuming that IEEE signaling NaNs may generate user-visible
4240 traps during floating-point operations.  Setting this option disables
4241 optimizations that may change the number of exceptions visible with
4242 signaling NaNs.  This option implies @option{-ftrapping-math}.
4243
4244 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4245 be defined.
4246
4247 The default is @option{-fno-signaling-nans}.
4248
4249 This option is experimental and does not currently guarantee to
4250 disable all GCC optimizations that affect signaling NaN behavior.
4251
4252 @item -fsingle-precision-constant
4253 @opindex fsingle-precision-constant
4254 Treat floating point constant as single precision constant instead of
4255 implicitly converting it to double precision constant.
4256
4257
4258 @end table
4259
4260 The following options control optimizations that may improve
4261 performance, but are not enabled by any @option{-O} options.  This
4262 section includes experimental options that may produce broken code.
4263
4264 @table @gcctabopt
4265 @item -fbranch-probabilities
4266 @opindex fbranch-probabilities
4267 After running a program compiled with @option{-fprofile-arcs}
4268 (@pxref{Debugging Options,, Options for Debugging Your Program or
4269 @command{gcc}}), you can compile it a second time using
4270 @option{-fbranch-probabilities}, to improve optimizations based on
4271 the number of times each branch was taken.  When the program
4272 compiled with @option{-fprofile-arcs} exits it saves arc execution
4273 counts to a file called @file{@var{sourcename}.da} for each source
4274 file  The information in this data file is very dependent on the
4275 structure of the generated code, so you must use the same source code
4276 and the same optimization options for both compilations.
4277
4278 With @option{-fbranch-probabilities}, GCC puts a 
4279 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4280 These can be used to improve optimization.  Currently, they are only
4281 used in one place: in @file{reorg.c}, instead of guessing which path a
4282 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4283 exactly determine which path is taken more often.
4284
4285 @item -fnew-ra
4286 @opindex fnew-ra
4287 Use a graph coloring register allocator.  Currently this option is meant
4288 for testing, so we are interested to hear about miscompilations with
4289 @option{-fnew-ra}.
4290
4291 @item -ftracer
4292 @opindex ftracer
4293 Perform tail duplication to enlarge superblock size. This transformation
4294 simplifies the control flow of the function allowing other optimizations to do
4295 better job.
4296
4297 @item -funit-at-a-time
4298 @opindex funit-at-a-time
4299 Parse the whole compilation unit before starting to produce code.  This allows some
4300 extra optimizations to take place but consumes more memory.
4301
4302 @item -funroll-loops
4303 @opindex funroll-loops
4304 Unroll loops whose number of iterations can be determined at compile time or
4305 upon entry to the loop.  @option{-funroll-loops} implies
4306 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4307 (i.e. complete removal of loops with small constant number of iterations).
4308 This option makes code larger, and may or may not make it run faster.
4309
4310 @item -funroll-all-loops
4311 @opindex funroll-all-loops
4312 Unroll all loops, even if their number of iterations is uncertain when
4313 the loop is entered.  This usually makes programs run more slowly.
4314 @option{-funroll-all-loops} implies the same options as
4315 @option{-funroll-loops}.
4316
4317 @item -fpeel-loops
4318 @opindex fpeel-loops
4319 Peels the loops for that there is enough information that they do not
4320 roll much (from profile feedback).  It also turns on complete loop peeling
4321 (i.e. complete removal of loops with small constant number of iterations).
4322
4323 @item -funswitch-loops
4324 @opindex funswitch-loops
4325 Move branches with loop invariant conditions out of the loop, with duplicates
4326 of the loop on both branches (modified according to result of the condition).
4327
4328 @item -fold-unroll-loops
4329 @opindex fold-unroll-loops
4330 Unroll loops whose number of iterations can be determined at compile
4331 time or upon entry to the loop, using the old loop unroller whose loop
4332 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4333 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4334 option makes code larger, and may or may not make it run faster.
4335
4336 @item -fold-unroll-all-loops
4337 @opindex fold-unroll-all-loops
4338 Unroll all loops, even if their number of iterations is uncertain when
4339 the loop is entered. This is done using the old loop unroller whose loop
4340 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4341 @option{-fold-unroll-all-loops} implies the same options as
4342 @option{-fold-unroll-loops}.
4343  
4344 @item -funswitch-loops
4345 @opindex funswitch-loops
4346 Move branches with loop invariant conditions out of the loop, with duplicates
4347 of the loop on both branches (modified according to result of the condition).
4348
4349 @item -funswitch-loops
4350 @opindex funswitch-loops
4351 Move branches with loop invariant conditions out of the loop, with duplicates
4352 of the loop on both branches (modified according to result of the condition).
4353
4354 @item -fprefetch-loop-arrays
4355 @opindex fprefetch-loop-arrays
4356 If supported by the target machine, generate instructions to prefetch
4357 memory to improve the performance of loops that access large arrays.
4358
4359 Disabled at level @option{-Os}.
4360
4361 @item -ffunction-sections
4362 @itemx -fdata-sections
4363 @opindex ffunction-sections
4364 @opindex fdata-sections
4365 Place each function or data item into its own section in the output
4366 file if the target supports arbitrary sections.  The name of the
4367 function or the name of the data item determines the section's name
4368 in the output file.
4369
4370 Use these options on systems where the linker can perform optimizations
4371 to improve locality of reference in the instruction space.  HPPA
4372 processors running HP-UX and SPARC processors running Solaris 2 have
4373 linkers with such optimizations.  Other systems using the ELF object format
4374 as well as AIX may have these optimizations in the future.
4375
4376 Only use these options when there are significant benefits from doing
4377 so.  When you specify these options, the assembler and linker will
4378 create larger object and executable files and will also be slower.
4379 You will not be able to use @code{gprof} on all systems if you
4380 specify this option and you may have problems with debugging if
4381 you specify both this option and @option{-g}.
4382
4383 @item -fssa
4384 @opindex fssa
4385 Perform optimizations in static single assignment form.  Each function's
4386 flow graph is translated into SSA form, optimizations are performed, and
4387 the flow graph is translated back from SSA form.  Users should not
4388 specify this option, since it is not yet ready for production use.
4389
4390 @item -fssa-ccp
4391 @opindex fssa-ccp
4392 Perform Sparse Conditional Constant Propagation in SSA form.  Requires
4393 @option{-fssa}.  Like @option{-fssa}, this is an experimental feature.
4394
4395 @item -fssa-dce
4396 @opindex fssa-dce
4397 Perform aggressive dead-code elimination in SSA form.  Requires @option{-fssa}.
4398 Like @option{-fssa}, this is an experimental feature.
4399
4400
4401
4402
4403 @item --param @var{name}=@var{value}
4404 @opindex param
4405 In some places, GCC uses various constants to control the amount of
4406 optimization that is done.  For example, GCC will not inline functions
4407 that contain more that a certain number of instructions.  You can
4408 control some of these constants on the command-line using the
4409 @option{--param} option.
4410
4411 In each case, the @var{value} is an integer.  The allowable choices for
4412 @var{name} are given in the following table:
4413
4414 @table @gcctabopt
4415 @item max-crossjump-edges
4416 The maximum number of incoming edges to consider for crossjumping.
4417 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
4418 the number of edges incoming to each block.  Increasing values mean
4419 more aggressive optimization, making the compile time increase with
4420 probably small improvement in executable size.
4421
4422 @item max-delay-slot-insn-search
4423 The maximum number of instructions to consider when looking for an
4424 instruction to fill a delay slot.  If more than this arbitrary number of
4425 instructions is searched, the time savings from filling the delay slot
4426 will be minimal so stop searching.  Increasing values mean more
4427 aggressive optimization, making the compile time increase with probably
4428 small improvement in executable run time.
4429
4430 @item max-delay-slot-live-search
4431 When trying to fill delay slots, the maximum number of instructions to
4432 consider when searching for a block with valid live register
4433 information.  Increasing this arbitrarily chosen value means more
4434 aggressive optimization, increasing the compile time.  This parameter
4435 should be removed when the delay slot code is rewritten to maintain the
4436 control-flow graph.
4437
4438 @item max-gcse-memory
4439 The approximate maximum amount of memory that will be allocated in
4440 order to perform the global common subexpression elimination
4441 optimization.  If more memory than specified is required, the
4442 optimization will not be done.
4443
4444 @item max-gcse-passes
4445 The maximum number of passes of GCSE to run.
4446
4447 @item max-pending-list-length
4448 The maximum number of pending dependencies scheduling will allow
4449 before flushing the current state and starting over.  Large functions
4450 with few branches or calls can create excessively large lists which
4451 needlessly consume memory and resources.
4452
4453 @item max-inline-insns-single
4454 Several parameters control the tree inliner used in gcc.
4455 This number sets the maximum number of instructions (counted in gcc's
4456 internal representation) in a single function that the tree inliner 
4457 will consider for inlining.  This only affects functions declared
4458 inline and methods implemented in a class declaration (C++).
4459 The default value is 300.
4460
4461 @item max-inline-insns-auto
4462 When you use @option{-finline-functions} (included in @option{-O3}),
4463 a lot of functions that would otherwise not be considered for inlining
4464 by the compiler will be investigated.  To those functions, a different
4465 (more restrictive) limit compared to functions declared inline can
4466 be applied.
4467 The default value is 300.
4468
4469 @item max-inline-insns
4470 The tree inliner does decrease the allowable size for single functions 
4471 to be inlined after we already inlined the number of instructions
4472 given here by repeated inlining.  This number should be a factor of 
4473 two or more larger than the single function limit.
4474 Higher numbers result in better runtime performance, but incur higher
4475 compile-time resource (CPU time, memory) requirements and result in
4476 larger binaries.  Very high values are not advisable, as too large
4477 binaries may adversely affect runtime performance.
4478 The default value is 600.
4479
4480 @item max-inline-slope
4481 After exceeding the maximum number of inlined instructions by repeated
4482 inlining, a linear function is used to decrease the allowable size
4483 for single functions.  The slope of that function is the negative
4484 reciprocal of the number specified here.
4485 The default value is 32.
4486
4487 @item min-inline-insns
4488 The repeated inlining is throttled more and more by the linear function
4489 after exceeding the limit.  To avoid too much throttling, a minimum for
4490 this function is specified here to allow repeated inlining for very small
4491 functions even when a lot of repeated inlining already has been done.
4492 The default value is 130.
4493
4494 @item max-inline-insns-rtl
4495 For languages that use the RTL inliner (this happens at a later stage
4496 than tree inlining), you can set the maximum allowable size (counted 
4497 in RTL instructions) for the RTL inliner with this parameter.
4498 The default value is 600.
4499
4500
4501 @item max-unrolled-insns
4502 The maximum number of instructions that a loop should have if that loop
4503 is unrolled, and if the loop is unrolled, it determines how many times
4504 the loop code is unrolled.
4505
4506 @item max-average-unrolled-insns
4507 The maximum number of instructions biased by probabilities of their execution
4508 that a loop should have if that loop is unrolled, and if the loop is unrolled,
4509 it determines how many times the loop code is unrolled.
4510
4511 @item max-unroll-times
4512 The maximum number of unrollings of a single loop.
4513
4514 @item max-peeled-insns
4515 The maximum number of instructions that a loop should have if that loop
4516 is peeled, and if the loop is peeled, it determines how many times
4517 the loop code is peeled.
4518
4519 @item max-peel-times
4520 The maximum number of peelings of a single loop.
4521
4522 @item max-completely-peeled-insns
4523 The maximum number of insns of a completely peeled loop.
4524
4525 @item max-completely-peel-times
4526 The maximum number of iterations of a loop to be suitable for complete peeling.
4527
4528 @item max-unswitch-insns
4529 The maximum number of insns of an unswitched loop.
4530
4531 @item max-unswitch-level
4532 The maximum number of branches unswitched in a single loop.
4533
4534 @item hot-bb-count-fraction
4535 Select fraction of the maximal count of repetitions of basic block in program
4536 given basic block needs to have to be considered hot.
4537
4538 @item hot-bb-frequency-fraction
4539 Select fraction of the maximal frequency of executions of basic block in
4540 function given basic block needs to have to be considered hot
4541
4542 @item tracer-dynamic-coverage
4543 @itemx tracer-dynamic-coverage-feedback
4544
4545 This value is used to limit superblock formation once the given percentage of
4546 executed instructions is covered.  This limits unnecessary code size
4547 expansion.
4548
4549 The @option{tracer-dynamic-coverage-feedback} is used only when profile
4550 feedback is available.  The real profiles (as opposed to statically estimated
4551 ones) are much less balanced allowing the threshold to be larger value.
4552
4553 @item tracer-max-code-growth
4554 Stop tail duplication once code growth has reached given percentage.  This is
4555 rather hokey argument, as most of the duplicates will be eliminated later in
4556 cross jumping, so it may be set to much higher values than is the desired code
4557 growth.
4558
4559 @item tracer-min-branch-ratio
4560
4561 Stop reverse growth when the reverse probability of best edge is less than this
4562 threshold (in percent).
4563
4564 @item tracer-min-branch-ratio
4565 @itemx tracer-min-branch-ratio-feedback
4566
4567 Stop forward growth if the best edge do have probability lower than this
4568 threshold.
4569
4570 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
4571 compilation for profile feedback and one for compilation without.  The value
4572 for compilation with profile feedback needs to be more conservative (higher) in
4573 order to make tracer effective.
4574
4575 @item ggc-min-expand
4576
4577 GCC uses a garbage collector to manage its own memory allocation.  This
4578 parameter specifies the minimum percentage by which the garbage
4579 collector's heap should be allowed to expand between collections.
4580 Tuning this may improve compilation speed; it has no effect on code
4581 generation.
4582
4583 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
4584 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
4585 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
4586 GCC is not able to calculate RAM on a particular platform, the lower
4587 bound of 30% is used.  Setting this parameter and
4588 @option{ggc-min-heapsize} to zero causes a full collection to occur at
4589 every opportunity.  This is extremely slow, but can be useful for
4590 debugging.
4591
4592 @item ggc-min-heapsize
4593
4594 Minimum size of the garbage collector's heap before it begins bothering
4595 to collect garbage.  The first collection occurs after the heap expands
4596 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
4597 tuning this may improve compilation speed, and has no effect on code
4598 generation.
4599
4600 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
4601 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
4602 available, the notion of "RAM" is the smallest of actual RAM,
4603 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
4604 RAM on a particular platform, the lower bound is used.  Setting this
4605 parameter very large effectively disables garbage collection.  Setting
4606 this parameter and @option{ggc-min-expand} to zero causes a full
4607 collection to occur at every opportunity.
4608
4609 @end table
4610 @end table
4611
4612 @node Preprocessor Options
4613 @section Options Controlling the Preprocessor
4614 @cindex preprocessor options
4615 @cindex options, preprocessor
4616
4617 These options control the C preprocessor, which is run on each C source
4618 file before actual compilation.
4619
4620 If you use the @option{-E} option, nothing is done except preprocessing.
4621 Some of these options make sense only together with @option{-E} because
4622 they cause the preprocessor output to be unsuitable for actual
4623 compilation.
4624
4625 @table @gcctabopt
4626 @opindex Wp
4627 You can use @option{-Wp,@var{option}} to bypass the compiler driver
4628 and pass @var{option} directly through to the preprocessor.  If
4629 @var{option} contains commas, it is split into multiple options at the
4630 commas.  However, many options are modified, translated or interpreted
4631 by the compiler driver before being passed to the preprocessor, and
4632 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
4633 interface is undocumented and subject to change, so whenever possible
4634 you should avoid using @option{-Wp} and let the driver handle the
4635 options instead.
4636
4637 @item -Xpreprocessor @var{option}
4638 @opindex preprocessor
4639 Pass @var{option} as an option to the preprocessor.  You can use this to
4640 supply system-specific preprocessor options which GCC does not know how to
4641 recognize.
4642
4643 If you want to pass an option that takes an argument, you must use
4644 @option{-Xpreprocessor} twice, once for the option and once for the argument.
4645 @end table
4646
4647 @include cppopts.texi
4648
4649 @node Assembler Options
4650 @section Passing Options to the Assembler
4651
4652 @c prevent bad page break with this line
4653 You can pass options to the assembler.
4654
4655 @table @gcctabopt
4656 @item -Wa,@var{option}
4657 @opindex Wa
4658 Pass @var{option} as an option to the assembler.  If @var{option}
4659 contains commas, it is split into multiple options at the commas.
4660
4661 @item -Xassembler @var{option}
4662 @opindex Xassembler
4663 Pass @var{option} as an option to the assembler.  You can use this to
4664 supply system-specific assembler options which GCC does not know how to
4665 recognize.
4666
4667 If you want to pass an option that takes an argument, you must use
4668 @option{-Xassembler} twice, once for the option and once for the argument.
4669
4670 @end table
4671
4672 @node Link Options
4673 @section Options for Linking
4674 @cindex link options
4675 @cindex options, linking
4676
4677 These options come into play when the compiler links object files into
4678 an executable output file.  They are meaningless if the compiler is
4679 not doing a link step.
4680
4681 @table @gcctabopt
4682 @cindex file names
4683 @item @var{object-file-name}
4684 A file name that does not end in a special recognized suffix is
4685 considered to name an object file or library.  (Object files are
4686 distinguished from libraries by the linker according to the file
4687 contents.)  If linking is done, these object files are used as input
4688 to the linker.
4689
4690 @item -c
4691 @itemx -S
4692 @itemx -E
4693 @opindex c
4694 @opindex S
4695 @opindex E
4696 If any of these options is used, then the linker is not run, and
4697 object file names should not be used as arguments.  @xref{Overall
4698 Options}.
4699
4700 @cindex Libraries
4701 @item -l@var{library}
4702 @itemx -l @var{library}
4703 @opindex l
4704 Search the library named @var{library} when linking.  (The second
4705 alternative with the library as a separate argument is only for
4706 POSIX compliance and is not recommended.)
4707
4708 It makes a difference where in the command you write this option; the
4709 linker searches and processes libraries and object files in the order they
4710 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
4711 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
4712 to functions in @samp{z}, those functions may not be loaded.
4713
4714 The linker searches a standard list of directories for the library,
4715 which is actually a file named @file{lib@var{library}.a}.  The linker
4716 then uses this file as if it had been specified precisely by name.
4717
4718 The directories searched include several standard system directories
4719 plus any that you specify with @option{-L}.
4720
4721 Normally the files found this way are library files---archive files
4722 whose members are object files.  The linker handles an archive file by
4723 scanning through it for members which define symbols that have so far
4724 been referenced but not defined.  But if the file that is found is an
4725 ordinary object file, it is linked in the usual fashion.  The only
4726 difference between using an @option{-l} option and specifying a file name
4727 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
4728 and searches several directories.
4729
4730 @item -lobjc
4731 @opindex lobjc
4732 You need this special case of the @option{-l} option in order to
4733 link an Objective-C program.
4734
4735 @item -nostartfiles
4736 @opindex nostartfiles
4737 Do not use the standard system startup files when linking.
4738 The standard system libraries are used normally, unless @option{-nostdlib}
4739 or @option{-nodefaultlibs} is used.
4740
4741 @item -nodefaultlibs
4742 @opindex nodefaultlibs
4743 Do not use the standard system libraries when linking.
4744 Only the libraries you specify will be passed to the linker.
4745 The standard startup files are used normally, unless @option{-nostartfiles}
4746 is used.  The compiler may generate calls to memcmp, memset, and memcpy
4747 for System V (and ISO C) environments or to bcopy and bzero for
4748 BSD environments.  These entries are usually resolved by entries in
4749 libc.  These entry points should be supplied through some other
4750 mechanism when this option is specified.
4751
4752 @item -nostdlib
4753 @opindex nostdlib
4754 Do not use the standard system startup files or libraries when linking.
4755 No startup files and only the libraries you specify will be passed to
4756 the linker.  The compiler may generate calls to memcmp, memset, and memcpy
4757 for System V (and ISO C) environments or to bcopy and bzero for
4758 BSD environments.  These entries are usually resolved by entries in
4759 libc.  These entry points should be supplied through some other
4760 mechanism when this option is specified.
4761
4762 @cindex @option{-lgcc}, use with @option{-nostdlib}
4763 @cindex @option{-nostdlib} and unresolved references
4764 @cindex unresolved references and @option{-nostdlib}
4765 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
4766 @cindex @option{-nodefaultlibs} and unresolved references
4767 @cindex unresolved references and @option{-nodefaultlibs}
4768 One of the standard libraries bypassed by @option{-nostdlib} and
4769 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
4770 that GCC uses to overcome shortcomings of particular machines, or special
4771 needs for some languages.
4772 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
4773 Collection (GCC) Internals},
4774 for more discussion of @file{libgcc.a}.)
4775 In most cases, you need @file{libgcc.a} even when you want to avoid
4776 other standard libraries.  In other words, when you specify @option{-nostdlib}
4777 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
4778 This ensures that you have no unresolved references to internal GCC
4779 library subroutines.  (For example, @samp{__main}, used to ensure C++
4780 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
4781 GNU Compiler Collection (GCC) Internals}.)
4782
4783 @item -s
4784 @opindex s
4785 Remove all symbol table and relocation information from the executable.
4786
4787 @item -static
4788 @opindex static
4789 On systems that support dynamic linking, this prevents linking with the shared
4790 libraries.  On other systems, this option has no effect.
4791
4792 @item -shared
4793 @opindex shared
4794 Produce a shared object which can then be linked with other objects to
4795 form an executable.  Not all systems support this option.  For predictable
4796 results, you must also specify the same set of options that were used to
4797 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
4798 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
4799 needs to build supplementary stub code for constructors to work.  On
4800 multi-libbed systems, @samp{gcc -shared} must select the correct support
4801 libraries to link against.  Failing to supply the correct flags may lead
4802 to subtle defects.  Supplying them in cases where they are not necessary
4803 is innocuous.}
4804
4805 @item -shared-libgcc
4806 @itemx -static-libgcc
4807 @opindex shared-libgcc
4808 @opindex static-libgcc
4809 On systems that provide @file{libgcc} as a shared library, these options
4810 force the use of either the shared or static version respectively.
4811 If no shared version of @file{libgcc} was built when the compiler was
4812 configured, these options have no effect.
4813
4814 There are several situations in which an application should use the
4815 shared @file{libgcc} instead of the static version.  The most common
4816 of these is when the application wishes to throw and catch exceptions
4817 across different shared libraries.  In that case, each of the libraries
4818 as well as the application itself should use the shared @file{libgcc}.
4819
4820 Therefore, the G++ and GCJ drivers automatically add
4821 @option{-shared-libgcc} whenever you build a shared library or a main
4822 executable, because C++ and Java programs typically use exceptions, so
4823 this is the right thing to do.
4824
4825 If, instead, you use the GCC driver to create shared libraries, you may
4826 find that they will not always be linked with the shared @file{libgcc}.
4827 If GCC finds, at its configuration time, that you have a GNU linker that
4828 does not support option @option{--eh-frame-hdr}, it will link the shared
4829 version of @file{libgcc} into shared libraries by default.  Otherwise,
4830 it will take advantage of the linker and optimize away the linking with
4831 the shared version of @file{libgcc}, linking with the static version of
4832 libgcc by default.  This allows exceptions to propagate through such
4833 shared libraries, without incurring relocation costs at library load
4834 time.
4835
4836 However, if a library or main executable is supposed to throw or catch
4837 exceptions, you must link it using the G++ or GCJ driver, as appropriate
4838 for the languages used in the program, or using the option
4839 @option{-shared-libgcc}, such that it is linked with the shared
4840 @file{libgcc}.
4841
4842 @item -symbolic
4843 @opindex symbolic
4844 Bind references to global symbols when building a shared object.  Warn
4845 about any unresolved references (unless overridden by the link editor
4846 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
4847 this option.
4848
4849 @item -Xlinker @var{option}
4850 @opindex Xlinker
4851 Pass @var{option} as an option to the linker.  You can use this to
4852 supply system-specific linker options which GCC does not know how to
4853 recognize.
4854
4855 If you want to pass an option that takes an argument, you must use
4856 @option{-Xlinker} twice, once for the option and once for the argument.
4857 For example, to pass @option{-assert definitions}, you must write
4858 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
4859 @option{-Xlinker "-assert definitions"}, because this passes the entire
4860 string as a single argument, which is not what the linker expects.
4861
4862 @item -Wl,@var{option}
4863 @opindex Wl
4864 Pass @var{option} as an option to the linker.  If @var{option} contains
4865 commas, it is split into multiple options at the commas.
4866
4867 @item -u @var{symbol}
4868 @opindex u
4869 Pretend the symbol @var{symbol} is undefined, to force linking of
4870 library modules to define it.  You can use @option{-u} multiple times with
4871 different symbols to force loading of additional library modules.
4872 @end table
4873
4874 @node Directory Options
4875 @section Options for Directory Search
4876 @cindex directory options
4877 @cindex options, directory search
4878 @cindex search path
4879
4880 These options specify directories to search for header files, for
4881 libraries and for parts of the compiler:
4882
4883 @table @gcctabopt
4884 @item -I@var{dir}
4885 @opindex I
4886 Add the directory @var{dir} to the head of the list of directories to be
4887 searched for header files.  This can be used to override a system header
4888 file, substituting your own version, since these directories are
4889 searched before the system header file directories.  However, you should
4890 not use this option to add directories that contain vendor-supplied
4891 system header files (use @option{-isystem} for that).  If you use more than
4892 one @option{-I} option, the directories are scanned in left-to-right
4893 order; the standard system directories come after.
4894
4895 If a standard system include directory, or a directory specified with
4896 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
4897 option will be ignored.  The directory will still be searched but as a
4898 system directory at its normal position in the system include chain.
4899 This is to ensure that GCC's procedure to fix buggy system headers and
4900 the ordering for the include_next directive are not inadvertently changed.
4901 If you really need to change the search order for system directories,
4902 use the @option{-nostdinc} and/or @option{-isystem} options.
4903
4904 @item -I-
4905 @opindex I-
4906 Any directories you specify with @option{-I} options before the @option{-I-}
4907 option are searched only for the case of @samp{#include "@var{file}"};
4908 they are not searched for @samp{#include <@var{file}>}.
4909
4910 If additional directories are specified with @option{-I} options after
4911 the @option{-I-}, these directories are searched for all @samp{#include}
4912 directives.  (Ordinarily @emph{all} @option{-I} directories are used
4913 this way.)
4914
4915 In addition, the @option{-I-} option inhibits the use of the current
4916 directory (where the current input file came from) as the first search
4917 directory for @samp{#include "@var{file}"}.  There is no way to
4918 override this effect of @option{-I-}.  With @option{-I.} you can specify
4919 searching the directory which was current when the compiler was
4920 invoked.  That is not exactly the same as what the preprocessor does
4921 by default, but it is often satisfactory.
4922
4923 @option{-I-} does not inhibit the use of the standard system directories
4924 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
4925 independent.
4926
4927 @item -L@var{dir}
4928 @opindex L
4929 Add directory @var{dir} to the list of directories to be searched
4930 for @option{-l}.
4931
4932 @item -B@var{prefix}
4933 @opindex B
4934 This option specifies where to find the executables, libraries,
4935 include files, and data files of the compiler itself.
4936
4937 The compiler driver program runs one or more of the subprograms
4938 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
4939 @var{prefix} as a prefix for each program it tries to run, both with and
4940 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
4941
4942 For each subprogram to be run, the compiler driver first tries the
4943 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
4944 was not specified, the driver tries two standard prefixes, which are
4945 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
4946 those results in a file name that is found, the unmodified program
4947 name is searched for using the directories specified in your
4948 @env{PATH} environment variable.
4949
4950 The compiler will check to see if the path provided by the @option{-B}
4951 refers to a directory, and if necessary it will add a directory
4952 separator character at the end of the path.
4953
4954 @option{-B} prefixes that effectively specify directory names also apply
4955 to libraries in the linker, because the compiler translates these
4956 options into @option{-L} options for the linker.  They also apply to
4957 includes files in the preprocessor, because the compiler translates these
4958 options into @option{-isystem} options for the preprocessor.  In this case,
4959 the compiler appends @samp{include} to the prefix.
4960
4961 The run-time support file @file{libgcc.a} can also be searched for using
4962 the @option{-B} prefix, if needed.  If it is not found there, the two
4963 standard prefixes above are tried, and that is all.  The file is left
4964 out of the link if it is not found by those means.
4965
4966 Another way to specify a prefix much like the @option{-B} prefix is to use
4967 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
4968 Variables}.
4969
4970 As a special kludge, if the path provided by @option{-B} is
4971 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
4972 9, then it will be replaced by @file{[dir/]include}.  This is to help
4973 with boot-strapping the compiler.
4974
4975 @item -specs=@var{file}
4976 @opindex specs
4977 Process @var{file} after the compiler reads in the standard @file{specs}
4978 file, in order to override the defaults that the @file{gcc} driver
4979 program uses when determining what switches to pass to @file{cc1},
4980 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
4981 @option{-specs=@var{file}} can be specified on the command line, and they
4982 are processed in order, from left to right.
4983 @end table
4984
4985 @c man end
4986
4987 @node Spec Files
4988 @section Specifying subprocesses and the switches to pass to them
4989 @cindex Spec Files
4990 @command{gcc} is a driver program.  It performs its job by invoking a
4991 sequence of other programs to do the work of compiling, assembling and
4992 linking.  GCC interprets its command-line parameters and uses these to
4993 deduce which programs it should invoke, and which command-line options
4994 it ought to place on their command lines.  This behavior is controlled
4995 by @dfn{spec strings}.  In most cases there is one spec string for each
4996 program that GCC can invoke, but a few programs have multiple spec
4997 strings to control their behavior.  The spec strings built into GCC can
4998 be overridden by using the @option{-specs=} command-line switch to specify
4999 a spec file.
5000
5001 @dfn{Spec files} are plaintext files that are used to construct spec
5002 strings.  They consist of a sequence of directives separated by blank
5003 lines.  The type of directive is determined by the first non-whitespace
5004 character on the line and it can be one of the following:
5005
5006 @table @code
5007 @item %@var{command}
5008 Issues a @var{command} to the spec file processor.  The commands that can
5009 appear here are:
5010
5011 @table @code
5012 @item %include <@var{file}>
5013 @cindex %include
5014 Search for @var{file} and insert its text at the current point in the
5015 specs file.
5016
5017 @item %include_noerr <@var{file}>
5018 @cindex %include_noerr
5019 Just like @samp{%include}, but do not generate an error message if the include
5020 file cannot be found.
5021
5022 @item %rename @var{old_name} @var{new_name}
5023 @cindex %rename
5024 Rename the spec string @var{old_name} to @var{new_name}.
5025
5026 @end table
5027
5028 @item *[@var{spec_name}]:
5029 This tells the compiler to create, override or delete the named spec
5030 string.  All lines after this directive up to the next directive or
5031 blank line are considered to be the text for the spec string.  If this
5032 results in an empty string then the spec will be deleted.  (Or, if the
5033 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5034 does not currently exist a new spec will be created.  If the spec does
5035 exist then its contents will be overridden by the text of this
5036 directive, unless the first character of that text is the @samp{+}
5037 character, in which case the text will be appended to the spec.
5038
5039 @item [@var{suffix}]:
5040 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5041 and up to the next directive or blank line are considered to make up the
5042 spec string for the indicated suffix.  When the compiler encounters an
5043 input file with the named suffix, it will processes the spec string in
5044 order to work out how to compile that file.  For example:
5045
5046 @smallexample
5047 .ZZ:
5048 z-compile -input %i
5049 @end smallexample
5050
5051 This says that any input file whose name ends in @samp{.ZZ} should be
5052 passed to the program @samp{z-compile}, which should be invoked with the
5053 command-line switch @option{-input} and with the result of performing the
5054 @samp{%i} substitution.  (See below.)
5055
5056 As an alternative to providing a spec string, the text that follows a
5057 suffix directive can be one of the following:
5058
5059 @table @code
5060 @item @@@var{language}
5061 This says that the suffix is an alias for a known @var{language}.  This is
5062 similar to using the @option{-x} command-line switch to GCC to specify a
5063 language explicitly.  For example:
5064
5065 @smallexample
5066 .ZZ:
5067 @@c++
5068 @end smallexample
5069
5070 Says that .ZZ files are, in fact, C++ source files.
5071
5072 @item #@var{name}
5073 This causes an error messages saying:
5074
5075 @smallexample
5076 @var{name} compiler not installed on this system.
5077 @end smallexample
5078 @end table
5079
5080 GCC already has an extensive list of suffixes built into it.
5081 This directive will add an entry to the end of the list of suffixes, but
5082 since the list is searched from the end backwards, it is effectively
5083 possible to override earlier entries using this technique.
5084
5085 @end table
5086
5087 GCC has the following spec strings built into it.  Spec files can
5088 override these strings or create their own.  Note that individual
5089 targets can also add their own spec strings to this list.
5090
5091 @smallexample
5092 asm          Options to pass to the assembler
5093 asm_final    Options to pass to the assembler post-processor
5094 cpp          Options to pass to the C preprocessor
5095 cc1          Options to pass to the C compiler
5096 cc1plus      Options to pass to the C++ compiler
5097 endfile      Object files to include at the end of the link
5098 link         Options to pass to the linker
5099 lib          Libraries to include on the command line to the linker
5100 libgcc       Decides which GCC support library to pass to the linker
5101 linker       Sets the name of the linker
5102 predefines   Defines to be passed to the C preprocessor
5103 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5104              by default
5105 startfile    Object files to include at the start of the link
5106 @end smallexample
5107
5108 Here is a small example of a spec file:
5109
5110 @smallexample
5111 %rename lib                 old_lib
5112
5113 *lib:
5114 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5115 @end smallexample
5116
5117 This example renames the spec called @samp{lib} to @samp{old_lib} and
5118 then overrides the previous definition of @samp{lib} with a new one.
5119 The new definition adds in some extra command-line options before
5120 including the text of the old definition.
5121
5122 @dfn{Spec strings} are a list of command-line options to be passed to their
5123 corresponding program.  In addition, the spec strings can contain
5124 @samp{%}-prefixed sequences to substitute variable text or to
5125 conditionally insert text into the command line.  Using these constructs
5126 it is possible to generate quite complex command lines.
5127
5128 Here is a table of all defined @samp{%}-sequences for spec
5129 strings.  Note that spaces are not generated automatically around the
5130 results of expanding these sequences.  Therefore you can concatenate them
5131 together or combine them with constant text in a single argument.
5132
5133 @table @code
5134 @item %%
5135 Substitute one @samp{%} into the program name or argument.
5136
5137 @item %i
5138 Substitute the name of the input file being processed.
5139
5140 @item %b
5141 Substitute the basename of the input file being processed.
5142 This is the substring up to (and not including) the last period
5143 and not including the directory.
5144
5145 @item %B
5146 This is the same as @samp{%b}, but include the file suffix (text after
5147 the last period).
5148
5149 @item %d
5150 Marks the argument containing or following the @samp{%d} as a
5151 temporary file name, so that that file will be deleted if GCC exits
5152 successfully.  Unlike @samp{%g}, this contributes no text to the
5153 argument.
5154
5155 @item %g@var{suffix}
5156 Substitute a file name that has suffix @var{suffix} and is chosen
5157 once per compilation, and mark the argument in the same way as
5158 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5159 name is now chosen in a way that is hard to predict even when previously
5160 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5161 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5162 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5163 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5164 was simply substituted with a file name chosen once per compilation,
5165 without regard to any appended suffix (which was therefore treated
5166 just like ordinary text), making such attacks more likely to succeed.
5167
5168 @item %u@var{suffix}
5169 Like @samp{%g}, but generates a new temporary file name even if
5170 @samp{%u@var{suffix}} was already seen.
5171
5172 @item %U@var{suffix}
5173 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5174 new one if there is no such last file name.  In the absence of any
5175 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5176 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5177 would involve the generation of two distinct file names, one
5178 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5179 simply substituted with a file name chosen for the previous @samp{%u},
5180 without regard to any appended suffix.
5181
5182 @item %j@var{suffix}
5183 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5184 writable, and if save-temps is off; otherwise, substitute the name
5185 of a temporary file, just like @samp{%u}.  This temporary file is not
5186 meant for communication between processes, but rather as a junk
5187 disposal mechanism.
5188
5189 @item %|@var{suffix}
5190 @itemx %m@var{suffix}
5191 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5192 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5193 all.  These are the two most common ways to instruct a program that it
5194 should read from standard input or write to standard output.  If you
5195 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5196 construct: see for example @file{f/lang-specs.h}.
5197
5198 @item %.@var{SUFFIX}
5199 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5200 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5201 terminated by the next space or %.
5202
5203 @item %w
5204 Marks the argument containing or following the @samp{%w} as the
5205 designated output file of this compilation.  This puts the argument
5206 into the sequence of arguments that @samp{%o} will substitute later.
5207
5208 @item %o
5209 Substitutes the names of all the output files, with spaces
5210 automatically placed around them.  You should write spaces
5211 around the @samp{%o} as well or the results are undefined.
5212 @samp{%o} is for use in the specs for running the linker.
5213 Input files whose names have no recognized suffix are not compiled
5214 at all, but they are included among the output files, so they will
5215 be linked.
5216
5217 @item %O
5218 Substitutes the suffix for object files.  Note that this is
5219 handled specially when it immediately follows @samp{%g, %u, or %U},
5220 because of the need for those to form complete file names.  The
5221 handling is such that @samp{%O} is treated exactly as if it had already
5222 been substituted, except that @samp{%g, %u, and %U} do not currently
5223 support additional @var{suffix} characters following @samp{%O} as they would
5224 following, for example, @samp{.o}.
5225
5226 @item %p
5227 Substitutes the standard macro predefinitions for the
5228 current target machine.  Use this when running @code{cpp}.
5229
5230 @item %P
5231 Like @samp{%p}, but puts @samp{__} before and after the name of each
5232 predefined macro, except for macros that start with @samp{__} or with
5233 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5234 C@.
5235
5236 @item %I
5237 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5238 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5239 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5240 as necessary.
5241
5242 @item %s
5243 Current argument is the name of a library or startup file of some sort.
5244 Search for that file in a standard list of directories and substitute
5245 the full name found.
5246
5247 @item %e@var{str}
5248 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5249 Use this when inconsistent options are detected.
5250
5251 @item %(@var{name})
5252 Substitute the contents of spec string @var{name} at this point.
5253
5254 @item %[@var{name}]
5255 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5256
5257 @item %x@{@var{option}@}
5258 Accumulate an option for @samp{%X}.
5259
5260 @item %X
5261 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5262 spec string.
5263
5264 @item %Y
5265 Output the accumulated assembler options specified by @option{-Wa}.
5266
5267 @item %Z
5268 Output the accumulated preprocessor options specified by @option{-Wp}.
5269
5270 @item %a
5271 Process the @code{asm} spec.  This is used to compute the
5272 switches to be passed to the assembler.
5273
5274 @item %A
5275 Process the @code{asm_final} spec.  This is a spec string for
5276 passing switches to an assembler post-processor, if such a program is
5277 needed.
5278
5279 @item %l
5280 Process the @code{link} spec.  This is the spec for computing the
5281 command line passed to the linker.  Typically it will make use of the
5282 @samp{%L %G %S %D and %E} sequences.
5283
5284 @item %D
5285 Dump out a @option{-L} option for each directory that GCC believes might
5286 contain startup files.  If the target supports multilibs then the
5287 current multilib directory will be prepended to each of these paths.
5288
5289 @item %M
5290 Output the multilib directory with directory separators replaced with
5291 @samp{_}.  If multilib directories are not set, or the multilib directory is
5292 @file{.} then this option emits nothing.
5293
5294 @item %L
5295 Process the @code{lib} spec.  This is a spec string for deciding which
5296 libraries should be included on the command line to the linker.
5297
5298 @item %G
5299 Process the @code{libgcc} spec.  This is a spec string for deciding
5300 which GCC support library should be included on the command line to the linker.
5301
5302 @item %S
5303 Process the @code{startfile} spec.  This is a spec for deciding which
5304 object files should be the first ones passed to the linker.  Typically
5305 this might be a file named @file{crt0.o}.
5306
5307 @item %E
5308 Process the @code{endfile} spec.  This is a spec string that specifies
5309 the last object files that will be passed to the linker.
5310
5311 @item %C
5312 Process the @code{cpp} spec.  This is used to construct the arguments
5313 to be passed to the C preprocessor.
5314
5315 @item %c
5316 Process the @code{signed_char} spec.  This is intended to be used
5317 to tell cpp whether a char is signed.  It typically has the definition:
5318 @smallexample
5319 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
5320 @end smallexample
5321
5322 @item %1
5323 Process the @code{cc1} spec.  This is used to construct the options to be
5324 passed to the actual C compiler (@samp{cc1}).
5325
5326 @item %2
5327 Process the @code{cc1plus} spec.  This is used to construct the options to be
5328 passed to the actual C++ compiler (@samp{cc1plus}).
5329
5330 @item %*
5331 Substitute the variable part of a matched option.  See below.
5332 Note that each comma in the substituted string is replaced by
5333 a single space.
5334
5335 @item %<@code{S}
5336 Remove all occurrences of @code{-S} from the command line.  Note---this
5337 command is position dependent.  @samp{%} commands in the spec string
5338 before this one will see @code{-S}, @samp{%} commands in the spec string
5339 after this one will not.
5340
5341 @item %:@var{function}(@var{args})
5342 Call the named function @var{function}, passing it @var{args}.
5343 @var{args} is first processed as a nested spec string, then split
5344 into an argument vector in the usual fashion.  The function returns
5345 a string which is processed as if it had appeared literally as part
5346 of the current spec.
5347
5348 The following built-in spec functions are provided:
5349
5350 @table @code
5351 @item @code{if-exists}
5352 The @code{if-exists} spec function takes one argument, an absolute
5353 pathname to a file.  If the file exists, @code{if-exists} returns the
5354 pathname.  Here is a small example of its usage:
5355
5356 @smallexample
5357 *startfile:
5358 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
5359 @end smallexample
5360
5361 @item @code{if-exists-else}
5362 The @code{if-exists-else} spec function is similar to the @code{if-exists}
5363 spec function, except that it takes two arguments.  The first argument is
5364 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
5365 returns the pathname.  If it does not exist, it returns the second argument.
5366 This way, @code{if-exists-else} can be used to select one file or another,
5367 based on the existence of the first.  Here is a small example of its usage:
5368
5369 @smallexample 
5370 *startfile:
5371 crt0%O%s %:if-exists(crti%O%s) %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
5372 @end smallexample
5373 @end table 
5374
5375 @item %@{@code{S}@}
5376 Substitutes the @code{-S} switch, if that switch was given to GCC@.
5377 If that switch was not specified, this substitutes nothing.  Note that
5378 the leading dash is omitted when specifying this option, and it is
5379 automatically inserted if the substitution is performed.  Thus the spec
5380 string @samp{%@{foo@}} would match the command-line option @option{-foo}
5381 and would output the command line option @option{-foo}.
5382
5383 @item %W@{@code{S}@}
5384 Like %@{@code{S}@} but mark last argument supplied within as a file to be
5385 deleted on failure.
5386
5387 @item %@{@code{S}*@}
5388 Substitutes all the switches specified to GCC whose names start
5389 with @code{-S}, but which also take an argument.  This is used for
5390 switches like @option{-o}, @option{-D}, @option{-I}, etc.
5391 GCC considers @option{-o foo} as being
5392 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
5393 text, including the space.  Thus two arguments would be generated.
5394
5395 @item %@{@code{S}*&@code{T}*@}
5396 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
5397 (the order of @code{S} and @code{T} in the spec is not significant).
5398 There can be any number of ampersand-separated variables; for each the
5399 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
5400
5401 @item %@{@code{S}:@code{X}@}
5402 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
5403
5404 @item %@{!@code{S}:@code{X}@}
5405 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
5406
5407 @item %@{@code{S}*:@code{X}@}
5408 Substitutes @code{X} if one or more switches whose names start with
5409 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
5410 once, no matter how many such switches appeared.  However, if @code{%*}
5411 appears somewhere in @code{X}, then @code{X} will be substituted once
5412 for each matching switch, with the @code{%*} replaced by the part of
5413 that switch that matched the @code{*}.
5414
5415 @item %@{.@code{S}:@code{X}@}
5416 Substitutes @code{X}, if processing a file with suffix @code{S}.
5417
5418 @item %@{!.@code{S}:@code{X}@}
5419 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
5420
5421 @item %@{@code{S}|@code{P}:@code{X}@}
5422 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
5423 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
5424 although they have a stronger binding than the @samp{|}.  If @code{%*}
5425 appears in @code{X}, all of the alternatives must be starred, and only
5426 the first matching alternative is substituted.
5427
5428 For example, a spec string like this:
5429
5430 @smallexample
5431 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
5432 @end smallexample
5433
5434 will output the following command-line options from the following input
5435 command-line options:
5436
5437 @smallexample
5438 fred.c        -foo -baz
5439 jim.d         -bar -boggle
5440 -d fred.c     -foo -baz -boggle
5441 -d jim.d      -bar -baz -boggle
5442 @end smallexample
5443
5444 @item %@{S:X; T:Y; :D@}
5445
5446 If @code{S} was given to GCC, substitues @code{X}; else if @code{T} was
5447 given to GCC, substitues @code{Y}; else substitutes @code{D}.  There can
5448 be as many clauses as you need.  This may be combined with @code{.}, 
5449 @code{!}, @code{|}, and @code{*} as needed.
5450
5451
5452 @end table
5453
5454 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
5455 construct may contain other nested @samp{%} constructs or spaces, or
5456 even newlines.  They are processed as usual, as described above.
5457 Trailing white space in @code{X} is ignored.  White space may also
5458 appear anywhere on the left side of the colon in these constructs,
5459 except between @code{.} or @code{*} and the corresponding word.
5460
5461 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
5462 handled specifically in these constructs.  If another value of
5463 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
5464 @option{-W} switch is found later in the command line, the earlier
5465 switch value is ignored, except with @{@code{S}*@} where @code{S} is
5466 just one letter, which passes all matching options.
5467
5468 The character @samp{|} at the beginning of the predicate text is used to
5469 indicate that a command should be piped to the following command, but
5470 only if @option{-pipe} is specified.
5471
5472 It is built into GCC which switches take arguments and which do not.
5473 (You might think it would be useful to generalize this to allow each
5474 compiler's spec to say which switches take arguments.  But this cannot
5475 be done in a consistent fashion.  GCC cannot even decide which input
5476 files have been specified without knowing which switches take arguments,
5477 and it must know which input files to compile in order to tell which
5478 compilers to run).
5479
5480 GCC also knows implicitly that arguments starting in @option{-l} are to be
5481 treated as compiler output files, and passed to the linker in their
5482 proper position among the other output files.
5483
5484 @c man begin OPTIONS
5485
5486 @node Target Options
5487 @section Specifying Target Machine and Compiler Version
5488 @cindex target options
5489 @cindex cross compiling
5490 @cindex specifying machine version
5491 @cindex specifying compiler version and target machine
5492 @cindex compiler version, specifying
5493 @cindex target machine, specifying
5494
5495 The usual way to run GCC is to run the executable called @file{gcc}, or
5496 @file{<machine>-gcc} when cross-compiling, or
5497 @file{<machine>-gcc-<version>} to run a version other than the one that
5498 was installed last.  Sometimes this is inconvenient, so GCC provides
5499 options that will switch to another cross-compiler or version.
5500
5501 @table @gcctabopt
5502 @item -b @var{machine}
5503 @opindex b
5504 The argument @var{machine} specifies the target machine for compilation.
5505
5506 The value to use for @var{machine} is the same as was specified as the
5507 machine type when configuring GCC as a cross-compiler.  For
5508 example, if a cross-compiler was configured with @samp{configure
5509 i386v}, meaning to compile for an 80386 running System V, then you
5510 would specify @option{-b i386v} to run that cross compiler.
5511
5512 @item -V @var{version}
5513 @opindex V
5514 The argument @var{version} specifies which version of GCC to run.
5515 This is useful when multiple versions are installed.  For example,
5516 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
5517 @end table
5518
5519 The @option{-V} and @option{-b} options work by running the
5520 @file{<machine>-gcc-<version>} executable, so there's no real reason to
5521 use them if you can just run that directly.
5522
5523 @node Submodel Options
5524 @section Hardware Models and Configurations
5525 @cindex submodel options
5526 @cindex specifying hardware config
5527 @cindex hardware models and configurations, specifying
5528 @cindex machine dependent options
5529
5530 Earlier we discussed the standard option @option{-b} which chooses among
5531 different installed compilers for completely different target
5532 machines, such as VAX vs.@: 68000 vs.@: 80386.
5533
5534 In addition, each of these target machine types can have its own
5535 special options, starting with @samp{-m}, to choose among various
5536 hardware models or configurations---for example, 68010 vs 68020,
5537 floating coprocessor or none.  A single installed version of the
5538 compiler can compile for any model or configuration, according to the
5539 options specified.
5540
5541 Some configurations of the compiler also support additional special
5542 options, usually for compatibility with other compilers on the same
5543 platform.
5544
5545 These options are defined by the macro @code{TARGET_SWITCHES} in the
5546 machine description.  The default for the options is also defined by
5547 that macro, which enables you to change the defaults.
5548
5549 @menu
5550 * M680x0 Options::
5551 * M68hc1x Options::
5552 * VAX Options::
5553 * SPARC Options::
5554 * ARM Options::
5555 * MN10200 Options::
5556 * MN10300 Options::
5557 * M32R/D Options::
5558 * M88K Options::
5559 * RS/6000 and PowerPC Options::
5560 * Darwin Options::
5561 * RT Options::
5562 * MIPS Options::
5563 * i386 and x86-64 Options::
5564 * HPPA Options::
5565 * Intel 960 Options::
5566 * DEC Alpha Options::
5567 * DEC Alpha/VMS Options::
5568 * H8/300 Options::
5569 * SH Options::
5570 * System V Options::
5571 * TMS320C3x/C4x Options::
5572 * V850 Options::
5573 * ARC Options::
5574 * NS32K Options::
5575 * AVR Options::
5576 * MCore Options::
5577 * IA-64 Options::
5578 * D30V Options::
5579 * S/390 and zSeries Options::
5580 * CRIS Options::
5581 * MMIX Options::
5582 * PDP-11 Options::
5583 * Xstormy16 Options::
5584 * Xtensa Options::
5585 * FRV Options::
5586 @end menu
5587
5588 @node M680x0 Options
5589 @subsection M680x0 Options
5590 @cindex M680x0 options
5591
5592 These are the @samp{-m} options defined for the 68000 series.  The default
5593 values for these options depends on which style of 68000 was selected when
5594 the compiler was configured; the defaults for the most common choices are
5595 given below.
5596
5597 @table @gcctabopt
5598 @item -m68000
5599 @itemx -mc68000
5600 @opindex m68000
5601 @opindex mc68000
5602 Generate output for a 68000.  This is the default
5603 when the compiler is configured for 68000-based systems.
5604
5605 Use this option for microcontrollers with a 68000 or EC000 core,
5606 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
5607
5608 @item -m68020
5609 @itemx -mc68020
5610 @opindex m68020
5611 @opindex mc68020
5612 Generate output for a 68020.  This is the default
5613 when the compiler is configured for 68020-based systems.
5614
5615 @item -m68881
5616 @opindex m68881
5617 Generate output containing 68881 instructions for floating point.
5618 This is the default for most 68020 systems unless @option{--nfp} was
5619 specified when the compiler was configured.
5620
5621 @item -m68030
5622 @opindex m68030
5623 Generate output for a 68030.  This is the default when the compiler is
5624 configured for 68030-based systems.
5625
5626 @item -m68040
5627 @opindex m68040
5628 Generate output for a 68040.  This is the default when the compiler is
5629 configured for 68040-based systems.
5630
5631 This option inhibits the use of 68881/68882 instructions that have to be
5632 emulated by software on the 68040.  Use this option if your 68040 does not
5633 have code to emulate those instructions.
5634
5635 @item -m68060
5636 @opindex m68060
5637 Generate output for a 68060.  This is the default when the compiler is
5638 configured for 68060-based systems.
5639
5640 This option inhibits the use of 68020 and 68881/68882 instructions that
5641 have to be emulated by software on the 68060.  Use this option if your 68060
5642 does not have code to emulate those instructions.
5643
5644 @item -mcpu32
5645 @opindex mcpu32
5646 Generate output for a CPU32.  This is the default
5647 when the compiler is configured for CPU32-based systems.
5648
5649 Use this option for microcontrollers with a
5650 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
5651 68336, 68340, 68341, 68349 and 68360.
5652
5653 @item -m5200
5654 @opindex m5200
5655 Generate output for a 520X ``coldfire'' family cpu.  This is the default
5656 when the compiler is configured for 520X-based systems.
5657
5658 Use this option for microcontroller with a 5200 core, including
5659 the MCF5202, MCF5203, MCF5204 and MCF5202.
5660
5661
5662 @item -m68020-40
5663 @opindex m68020-40
5664 Generate output for a 68040, without using any of the new instructions.
5665 This results in code which can run relatively efficiently on either a
5666 68020/68881 or a 68030 or a 68040.  The generated code does use the
5667 68881 instructions that are emulated on the 68040.
5668
5669 @item -m68020-60
5670 @opindex m68020-60
5671 Generate output for a 68060, without using any of the new instructions.
5672 This results in code which can run relatively efficiently on either a
5673 68020/68881 or a 68030 or a 68040.  The generated code does use the
5674 68881 instructions that are emulated on the 68060.
5675
5676 @item -mfpa
5677 @opindex mfpa
5678 Generate output containing Sun FPA instructions for floating point.
5679
5680 @item -msoft-float
5681 @opindex msoft-float
5682 Generate output containing library calls for floating point.
5683 @strong{Warning:} the requisite libraries are not available for all m68k
5684 targets.  Normally the facilities of the machine's usual C compiler are
5685 used, but this can't be done directly in cross-compilation.  You must
5686 make your own arrangements to provide suitable library functions for
5687 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
5688 @samp{m68k-*-coff} do provide software floating point support.
5689
5690 @item -mshort
5691 @opindex mshort
5692 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5693
5694 @item -mnobitfield
5695 @opindex mnobitfield
5696 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
5697 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
5698
5699 @item -mbitfield
5700 @opindex mbitfield
5701 Do use the bit-field instructions.  The @option{-m68020} option implies
5702 @option{-mbitfield}.  This is the default if you use a configuration
5703 designed for a 68020.
5704
5705 @item -mrtd
5706 @opindex mrtd
5707 Use a different function-calling convention, in which functions
5708 that take a fixed number of arguments return with the @code{rtd}
5709 instruction, which pops their arguments while returning.  This
5710 saves one instruction in the caller since there is no need to pop
5711 the arguments there.
5712
5713 This calling convention is incompatible with the one normally
5714 used on Unix, so you cannot use it if you need to call libraries
5715 compiled with the Unix compiler.
5716
5717 Also, you must provide function prototypes for all functions that
5718 take variable numbers of arguments (including @code{printf});
5719 otherwise incorrect code will be generated for calls to those
5720 functions.
5721
5722 In addition, seriously incorrect code will result if you call a
5723 function with too many arguments.  (Normally, extra arguments are
5724 harmlessly ignored.)
5725
5726 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
5727 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
5728
5729 @item -malign-int
5730 @itemx -mno-align-int
5731 @opindex malign-int
5732 @opindex mno-align-int
5733 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
5734 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
5735 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
5736 Aligning variables on 32-bit boundaries produces code that runs somewhat
5737 faster on processors with 32-bit busses at the expense of more memory.
5738
5739 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
5740 align structures containing the above types  differently than
5741 most published application binary interface specifications for the m68k.
5742
5743 @item -mpcrel
5744 @opindex mpcrel
5745 Use the pc-relative addressing mode of the 68000 directly, instead of
5746 using a global offset table.  At present, this option implies @option{-fpic},
5747 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
5748 not presently supported with @option{-mpcrel}, though this could be supported for
5749 68020 and higher processors.
5750
5751 @item -mno-strict-align
5752 @itemx -mstrict-align
5753 @opindex mno-strict-align
5754 @opindex mstrict-align
5755 Do not (do) assume that unaligned memory references will be handled by
5756 the system.
5757
5758 @end table
5759
5760 @node M68hc1x Options
5761 @subsection M68hc1x Options
5762 @cindex M68hc1x options
5763
5764 These are the @samp{-m} options defined for the 68hc11 and 68hc12
5765 microcontrollers.  The default values for these options depends on
5766 which style of microcontroller was selected when the compiler was configured;
5767 the defaults for the most common choices are given below.
5768
5769 @table @gcctabopt
5770 @item -m6811
5771 @itemx -m68hc11
5772 @opindex m6811
5773 @opindex m68hc11
5774 Generate output for a 68HC11.  This is the default
5775 when the compiler is configured for 68HC11-based systems.
5776
5777 @item -m6812
5778 @itemx -m68hc12
5779 @opindex m6812
5780 @opindex m68hc12
5781 Generate output for a 68HC12.  This is the default
5782 when the compiler is configured for 68HC12-based systems.
5783
5784 @item -m68S12
5785 @itemx -m68hcs12
5786 @opindex m68S12
5787 @opindex m68hcs12
5788 Generate output for a 68HCS12.  
5789
5790 @item -mauto-incdec
5791 @opindex mauto-incdec
5792 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
5793 addressing modes.
5794
5795 @item -minmax
5796 @itemx -nominmax
5797 @opindex minmax
5798 @opindex mnominmax
5799 Enable the use of 68HC12 min and max instructions.
5800
5801 @item -mlong-calls
5802 @itemx -mno-long-calls
5803 @opindex mlong-calls
5804 @opindex mno-long-calls
5805 Treat all calls as being far away (near).  If calls are assumed to be
5806 far away, the compiler will use the @code{call} instruction to
5807 call a function and the @code{rtc} instruction for returning.
5808
5809 @item -mshort
5810 @opindex mshort
5811 Consider type @code{int} to be 16 bits wide, like @code{short int}.
5812
5813 @item -msoft-reg-count=@var{count}
5814 @opindex msoft-reg-count
5815 Specify the number of pseudo-soft registers which are used for the
5816 code generation.  The maximum number is 32.  Using more pseudo-soft
5817 register may or may not result in better code depending on the program.
5818 The default is 4 for 68HC11 and 2 for 68HC12.
5819
5820 @end table
5821
5822 @node VAX Options
5823 @subsection VAX Options
5824 @cindex VAX options
5825
5826 These @samp{-m} options are defined for the VAX:
5827
5828 @table @gcctabopt
5829 @item -munix
5830 @opindex munix
5831 Do not output certain jump instructions (@code{aobleq} and so on)
5832 that the Unix assembler for the VAX cannot handle across long
5833 ranges.
5834
5835 @item -mgnu
5836 @opindex mgnu
5837 Do output those jump instructions, on the assumption that you
5838 will assemble with the GNU assembler.
5839
5840 @item -mg
5841 @opindex mg
5842 Output code for g-format floating point numbers instead of d-format.
5843 @end table
5844
5845 @node SPARC Options
5846 @subsection SPARC Options
5847 @cindex SPARC options
5848
5849 These @samp{-m} switches are supported on the SPARC:
5850
5851 @table @gcctabopt
5852 @item -mno-app-regs
5853 @itemx -mapp-regs
5854 @opindex mno-app-regs
5855 @opindex mapp-regs
5856 Specify @option{-mapp-regs} to generate output using the global registers
5857 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
5858 is the default.
5859
5860 To be fully SVR4 ABI compliant at the cost of some performance loss,
5861 specify @option{-mno-app-regs}.  You should compile libraries and system
5862 software with this option.
5863
5864 @item -mfpu
5865 @itemx -mhard-float
5866 @opindex mfpu
5867 @opindex mhard-float
5868 Generate output containing floating point instructions.  This is the
5869 default.
5870
5871 @item -mno-fpu
5872 @itemx -msoft-float
5873 @opindex mno-fpu
5874 @opindex msoft-float
5875 Generate output containing library calls for floating point.
5876 @strong{Warning:} the requisite libraries are not available for all SPARC
5877 targets.  Normally the facilities of the machine's usual C compiler are
5878 used, but this cannot be done directly in cross-compilation.  You must make
5879 your own arrangements to provide suitable library functions for
5880 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
5881 @samp{sparclite-*-*} do provide software floating point support.
5882
5883 @option{-msoft-float} changes the calling convention in the output file;
5884 therefore, it is only useful if you compile @emph{all} of a program with
5885 this option.  In particular, you need to compile @file{libgcc.a}, the
5886 library that comes with GCC, with @option{-msoft-float} in order for
5887 this to work.
5888
5889 @item -mhard-quad-float
5890 @opindex mhard-quad-float
5891 Generate output containing quad-word (long double) floating point
5892 instructions.
5893
5894 @item -msoft-quad-float
5895 @opindex msoft-quad-float
5896 Generate output containing library calls for quad-word (long double)
5897 floating point instructions.  The functions called are those specified
5898 in the SPARC ABI@.  This is the default.
5899
5900 As of this writing, there are no sparc implementations that have hardware
5901 support for the quad-word floating point instructions.  They all invoke
5902 a trap handler for one of these instructions, and then the trap handler
5903 emulates the effect of the instruction.  Because of the trap handler overhead,
5904 this is much slower than calling the ABI library routines.  Thus the
5905 @option{-msoft-quad-float} option is the default.
5906
5907 @item -mno-flat
5908 @itemx -mflat
5909 @opindex mno-flat
5910 @opindex mflat
5911 With @option{-mflat}, the compiler does not generate save/restore instructions
5912 and will use a ``flat'' or single register window calling convention.
5913 This model uses %i7 as the frame pointer and is compatible with the normal
5914 register window model.  Code from either may be intermixed.
5915 The local registers and the input registers (0--5) are still treated as
5916 ``call saved'' registers and will be saved on the stack as necessary.
5917
5918 With @option{-mno-flat} (the default), the compiler emits save/restore
5919 instructions (except for leaf functions) and is the normal mode of operation.
5920
5921 @item -mno-unaligned-doubles
5922 @itemx -munaligned-doubles
5923 @opindex mno-unaligned-doubles
5924 @opindex munaligned-doubles
5925 Assume that doubles have 8 byte alignment.  This is the default.
5926
5927 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
5928 alignment only if they are contained in another type, or if they have an
5929 absolute address.  Otherwise, it assumes they have 4 byte alignment.
5930 Specifying this option avoids some rare compatibility problems with code
5931 generated by other compilers.  It is not the default because it results
5932 in a performance loss, especially for floating point code.
5933
5934 @item -mno-faster-structs
5935 @itemx -mfaster-structs
5936 @opindex mno-faster-structs
5937 @opindex mfaster-structs
5938 With @option{-mfaster-structs}, the compiler assumes that structures
5939 should have 8 byte alignment.  This enables the use of pairs of
5940 @code{ldd} and @code{std} instructions for copies in structure
5941 assignment, in place of twice as many @code{ld} and @code{st} pairs.
5942 However, the use of this changed alignment directly violates the SPARC
5943 ABI@.  Thus, it's intended only for use on targets where the developer
5944 acknowledges that their resulting code will not be directly in line with
5945 the rules of the ABI@.
5946
5947 @item -mv8
5948 @itemx -msparclite
5949 @opindex mv8
5950 @opindex msparclite
5951 These two options select variations on the SPARC architecture.
5952
5953 By default (unless specifically configured for the Fujitsu SPARClite),
5954 GCC generates code for the v7 variant of the SPARC architecture.
5955
5956 @option{-mv8} will give you SPARC v8 code.  The only difference from v7
5957 code is that the compiler emits the integer multiply and integer
5958 divide instructions which exist in SPARC v8 but not in SPARC v7.
5959
5960 @option{-msparclite} will give you SPARClite code.  This adds the integer
5961 multiply, integer divide step and scan (@code{ffs}) instructions which
5962 exist in SPARClite but not in SPARC v7.
5963
5964 These options are deprecated and will be deleted in a future GCC release.
5965 They have been replaced with @option{-mcpu=xxx}.
5966
5967 @item -mcypress
5968 @itemx -msupersparc
5969 @opindex mcypress
5970 @opindex msupersparc
5971 These two options select the processor for which the code is optimized.
5972
5973 With @option{-mcypress} (the default), the compiler optimizes code for the
5974 Cypress CY7C602 chip, as used in the SPARCStation/SPARCServer 3xx series.
5975 This is also appropriate for the older SPARCStation 1, 2, IPX etc.
5976
5977 With @option{-msupersparc} the compiler optimizes code for the SuperSPARC cpu, as
5978 used in the SPARCStation 10, 1000 and 2000 series.  This flag also enables use
5979 of the full SPARC v8 instruction set.
5980
5981 These options are deprecated and will be deleted in a future GCC release.
5982 They have been replaced with @option{-mcpu=xxx}.
5983
5984 @item -mcpu=@var{cpu_type}
5985 @opindex mcpu
5986 Set the instruction set, register set, and instruction scheduling parameters
5987 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
5988 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
5989 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
5990 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
5991 @samp{ultrasparc3}.
5992
5993 Default instruction scheduling parameters are used for values that select
5994 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
5995 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
5996
5997 Here is a list of each supported architecture and their supported
5998 implementations.
5999
6000 @smallexample
6001     v7:             cypress
6002     v8:             supersparc, hypersparc
6003     sparclite:      f930, f934, sparclite86x
6004     sparclet:       tsc701
6005     v9:             ultrasparc, ultrasparc3
6006 @end smallexample
6007
6008 @item -mtune=@var{cpu_type}
6009 @opindex mtune
6010 Set the instruction scheduling parameters for machine type
6011 @var{cpu_type}, but do not set the instruction set or register set that the
6012 option @option{-mcpu=@var{cpu_type}} would.
6013
6014 The same values for @option{-mcpu=@var{cpu_type}} can be used for
6015 @option{-mtune=@var{cpu_type}}, but the only useful values are those
6016 that select a particular cpu implementation.  Those are @samp{cypress},
6017 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
6018 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
6019 @samp{ultrasparc3}.
6020
6021 @end table
6022
6023 These @samp{-m} switches are supported in addition to the above
6024 on the SPARCLET processor.
6025
6026 @table @gcctabopt
6027 @item -mlittle-endian
6028 @opindex mlittle-endian
6029 Generate code for a processor running in little-endian mode.
6030
6031 @item -mlive-g0
6032 @opindex mlive-g0
6033 Treat register @code{%g0} as a normal register.
6034 GCC will continue to clobber it as necessary but will not assume
6035 it always reads as 0.
6036
6037 @item -mbroken-saverestore
6038 @opindex mbroken-saverestore
6039 Generate code that does not use non-trivial forms of the @code{save} and
6040 @code{restore} instructions.  Early versions of the SPARCLET processor do
6041 not correctly handle @code{save} and @code{restore} instructions used with
6042 arguments.  They correctly handle them used without arguments.  A @code{save}
6043 instruction used without arguments increments the current window pointer
6044 but does not allocate a new stack frame.  It is assumed that the window
6045 overflow trap handler will properly handle this case as will interrupt
6046 handlers.
6047 @end table
6048
6049 These @samp{-m} switches are supported in addition to the above
6050 on SPARC V9 processors in 64-bit environments.
6051
6052 @table @gcctabopt
6053 @item -mlittle-endian
6054 @opindex mlittle-endian
6055 Generate code for a processor running in little-endian mode.
6056
6057 @item -m32
6058 @itemx -m64
6059 @opindex m32
6060 @opindex m64
6061 Generate code for a 32-bit or 64-bit environment.
6062 The 32-bit environment sets int, long and pointer to 32 bits.
6063 The 64-bit environment sets int to 32 bits and long and pointer
6064 to 64 bits.
6065
6066 @item -mcmodel=medlow
6067 @opindex mcmodel=medlow
6068 Generate code for the Medium/Low code model: the program must be linked
6069 in the low 32 bits of the address space.  Pointers are 64 bits.
6070 Programs can be statically or dynamically linked.
6071
6072 @item -mcmodel=medmid
6073 @opindex mcmodel=medmid
6074 Generate code for the Medium/Middle code model: the program must be linked
6075 in the low 44 bits of the address space, the text segment must be less than
6076 2G bytes, and data segment must be within 2G of the text segment.
6077 Pointers are 64 bits.
6078
6079 @item -mcmodel=medany
6080 @opindex mcmodel=medany
6081 Generate code for the Medium/Anywhere code model: the program may be linked
6082 anywhere in the address space, the text segment must be less than
6083 2G bytes, and data segment must be within 2G of the text segment.
6084 Pointers are 64 bits.
6085
6086 @item -mcmodel=embmedany
6087 @opindex mcmodel=embmedany
6088 Generate code for the Medium/Anywhere code model for embedded systems:
6089 assume a 32-bit text and a 32-bit data segment, both starting anywhere
6090 (determined at link time).  Register %g4 points to the base of the
6091 data segment.  Pointers are still 64 bits.
6092 Programs are statically linked, PIC is not supported.
6093
6094 @item -mstack-bias
6095 @itemx -mno-stack-bias
6096 @opindex mstack-bias
6097 @opindex mno-stack-bias
6098 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
6099 frame pointer if present, are offset by @minus{}2047 which must be added back
6100 when making stack frame references.
6101 Otherwise, assume no such offset is present.
6102 @end table
6103
6104 @node ARM Options
6105 @subsection ARM Options
6106 @cindex ARM options
6107
6108 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6109 architectures:
6110
6111 @table @gcctabopt
6112 @item -mapcs-frame
6113 @opindex mapcs-frame
6114 Generate a stack frame that is compliant with the ARM Procedure Call
6115 Standard for all functions, even if this is not strictly necessary for
6116 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6117 with this option will cause the stack frames not to be generated for
6118 leaf functions.  The default is @option{-mno-apcs-frame}.
6119
6120 @item -mapcs
6121 @opindex mapcs
6122 This is a synonym for @option{-mapcs-frame}.
6123
6124 @item -mapcs-26
6125 @opindex mapcs-26
6126 Generate code for a processor running with a 26-bit program counter,
6127 and conforming to the function calling standards for the APCS 26-bit
6128 option.  This option replaces the @option{-m2} and @option{-m3} options
6129 of previous releases of the compiler.
6130
6131 @item -mapcs-32
6132 @opindex mapcs-32
6133 Generate code for a processor running with a 32-bit program counter,
6134 and conforming to the function calling standards for the APCS 32-bit
6135 option.  This option replaces the @option{-m6} option of previous releases
6136 of the compiler.
6137
6138 @ignore
6139 @c not currently implemented
6140 @item -mapcs-stack-check
6141 @opindex mapcs-stack-check
6142 Generate code to check the amount of stack space available upon entry to
6143 every function (that actually uses some stack space).  If there is
6144 insufficient space available then either the function
6145 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6146 called, depending upon the amount of stack space required.  The run time
6147 system is required to provide these functions.  The default is
6148 @option{-mno-apcs-stack-check}, since this produces smaller code.
6149
6150 @c not currently implemented
6151 @item -mapcs-float
6152 @opindex mapcs-float
6153 Pass floating point arguments using the float point registers.  This is
6154 one of the variants of the APCS@.  This option is recommended if the
6155 target hardware has a floating point unit or if a lot of floating point
6156 arithmetic is going to be performed by the code.  The default is
6157 @option{-mno-apcs-float}, since integer only code is slightly increased in
6158 size if @option{-mapcs-float} is used.
6159
6160 @c not currently implemented
6161 @item -mapcs-reentrant
6162 @opindex mapcs-reentrant
6163 Generate reentrant, position independent code.  The default is
6164 @option{-mno-apcs-reentrant}.
6165 @end ignore
6166
6167 @item -mthumb-interwork
6168 @opindex mthumb-interwork
6169 Generate code which supports calling between the ARM and Thumb
6170 instruction sets.  Without this option the two instruction sets cannot
6171 be reliably used inside one program.  The default is
6172 @option{-mno-thumb-interwork}, since slightly larger code is generated
6173 when @option{-mthumb-interwork} is specified.
6174
6175 @item -mno-sched-prolog
6176 @opindex mno-sched-prolog
6177 Prevent the reordering of instructions in the function prolog, or the
6178 merging of those instruction with the instructions in the function's
6179 body.  This means that all functions will start with a recognizable set
6180 of instructions (or in fact one of a choice from a small set of
6181 different function prologues), and this information can be used to
6182 locate the start if functions inside an executable piece of code.  The
6183 default is @option{-msched-prolog}.
6184
6185 @item -mhard-float
6186 @opindex mhard-float
6187 Generate output containing floating point instructions.  This is the
6188 default.
6189
6190 @item -msoft-float
6191 @opindex msoft-float
6192 Generate output containing library calls for floating point.
6193 @strong{Warning:} the requisite libraries are not available for all ARM
6194 targets.  Normally the facilities of the machine's usual C compiler are
6195 used, but this cannot be done directly in cross-compilation.  You must make
6196 your own arrangements to provide suitable library functions for
6197 cross-compilation.
6198
6199 @option{-msoft-float} changes the calling convention in the output file;
6200 therefore, it is only useful if you compile @emph{all} of a program with
6201 this option.  In particular, you need to compile @file{libgcc.a}, the
6202 library that comes with GCC, with @option{-msoft-float} in order for
6203 this to work.
6204
6205 @item -mlittle-endian
6206 @opindex mlittle-endian
6207 Generate code for a processor running in little-endian mode.  This is
6208 the default for all standard configurations.
6209
6210 @item -mbig-endian
6211 @opindex mbig-endian
6212 Generate code for a processor running in big-endian mode; the default is
6213 to compile code for a little-endian processor.
6214
6215 @item -mwords-little-endian
6216 @opindex mwords-little-endian
6217 This option only applies when generating code for big-endian processors.
6218 Generate code for a little-endian word order but a big-endian byte
6219 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6220 option should only be used if you require compatibility with code for
6221 big-endian ARM processors generated by versions of the compiler prior to
6222 2.8.
6223
6224 @item -malignment-traps
6225 @opindex malignment-traps
6226 Generate code that will not trap if the MMU has alignment traps enabled.
6227 On ARM architectures prior to ARMv4, there were no instructions to
6228 access half-word objects stored in memory.  However, when reading from
6229 memory a feature of the ARM architecture allows a word load to be used,
6230 even if the address is unaligned, and the processor core will rotate the
6231 data as it is being loaded.  This option tells the compiler that such
6232 misaligned accesses will cause a MMU trap and that it should instead
6233 synthesize the access as a series of byte accesses.  The compiler can
6234 still use word accesses to load half-word data if it knows that the
6235 address is aligned to a word boundary.
6236
6237 This option is ignored when compiling for ARM architecture 4 or later,
6238 since these processors have instructions to directly access half-word
6239 objects in memory.
6240
6241 @item -mno-alignment-traps
6242 @opindex mno-alignment-traps
6243 Generate code that assumes that the MMU will not trap unaligned
6244 accesses.  This produces better code when the target instruction set
6245 does not have half-word memory operations (i.e.@: implementations prior to
6246 ARMv4).
6247
6248 Note that you cannot use this option to access unaligned word objects,
6249 since the processor will only fetch one 32-bit aligned object from
6250 memory.
6251
6252 The default setting for most targets is @option{-mno-alignment-traps}, since
6253 this produces better code when there are no half-word memory
6254 instructions available.
6255
6256 @item -mshort-load-bytes
6257 @itemx -mno-short-load-words
6258 @opindex mshort-load-bytes
6259 @opindex mno-short-load-words
6260 These are deprecated aliases for @option{-malignment-traps}.
6261
6262 @item -mno-short-load-bytes
6263 @itemx -mshort-load-words
6264 @opindex mno-short-load-bytes
6265 @opindex mshort-load-words
6266 This are deprecated aliases for @option{-mno-alignment-traps}.
6267
6268 @item -mcpu=@var{name}
6269 @opindex mcpu
6270 This specifies the name of the target ARM processor.  GCC uses this name
6271 to determine what kind of instructions it can emit when generating
6272 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6273 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6274 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6275 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6276 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6277 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6278 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6279 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6280 @samp{arm920t}, @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi},
6281 @samp{arm1020t}, @samp{xscale}, @samp{ep9312}.
6282
6283 @itemx -mtune=@var{name}
6284 @opindex mtune
6285 This option is very similar to the @option{-mcpu=} option, except that
6286 instead of specifying the actual target processor type, and hence
6287 restricting which instructions can be used, it specifies that GCC should
6288 tune the performance of the code as if the target were of the type
6289 specified in this option, but still choosing the instructions that it
6290 will generate based on the cpu specified by a @option{-mcpu=} option.
6291 For some ARM implementations better performance can be obtained by using
6292 this option.
6293
6294 @item -march=@var{name}
6295 @opindex march
6296 This specifies the name of the target ARM architecture.  GCC uses this
6297 name to determine what kind of instructions it can emit when generating
6298 assembly code.  This option can be used in conjunction with or instead
6299 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6300 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6301 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{ep9312}.
6302
6303 @item -mfpe=@var{number}
6304 @itemx -mfp=@var{number}
6305 @opindex mfpe
6306 @opindex mfp
6307 This specifies the version of the floating point emulation available on
6308 the target.  Permissible values are 2 and 3.  @option{-mfp=} is a synonym
6309 for @option{-mfpe=}, for compatibility with older versions of GCC@.
6310
6311 @item -mstructure-size-boundary=@var{n}
6312 @opindex mstructure-size-boundary
6313 The size of all structures and unions will be rounded up to a multiple
6314 of the number of bits set by this option.  Permissible values are 8 and
6315 32.  The default value varies for different toolchains.  For the COFF
6316 targeted toolchain the default value is 8.  Specifying the larger number
6317 can produce faster, more efficient code, but can also increase the size
6318 of the program.  The two values are potentially incompatible.  Code
6319 compiled with one value cannot necessarily expect to work with code or
6320 libraries compiled with the other value, if they exchange information
6321 using structures or unions.
6322
6323 @item -mabort-on-noreturn
6324 @opindex mabort-on-noreturn
6325 Generate a call to the function @code{abort} at the end of a
6326 @code{noreturn} function.  It will be executed if the function tries to
6327 return.
6328
6329 @item -mlong-calls
6330 @itemx -mno-long-calls
6331 @opindex mlong-calls
6332 @opindex mno-long-calls
6333 Tells the compiler to perform function calls by first loading the
6334 address of the function into a register and then performing a subroutine
6335 call on this register.  This switch is needed if the target function
6336 will lie outside of the 64 megabyte addressing range of the offset based
6337 version of subroutine call instruction.
6338
6339 Even if this switch is enabled, not all function calls will be turned
6340 into long calls.  The heuristic is that static functions, functions
6341 which have the @samp{short-call} attribute, functions that are inside
6342 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6343 definitions have already been compiled within the current compilation
6344 unit, will not be turned into long calls.  The exception to this rule is
6345 that weak function definitions, functions with the @samp{long-call}
6346 attribute or the @samp{section} attribute, and functions that are within
6347 the scope of a @samp{#pragma long_calls} directive, will always be
6348 turned into long calls.
6349
6350 This feature is not enabled by default.  Specifying
6351 @option{-mno-long-calls} will restore the default behavior, as will
6352 placing the function calls within the scope of a @samp{#pragma
6353 long_calls_off} directive.  Note these switches have no effect on how
6354 the compiler generates code to handle function calls via function
6355 pointers.
6356
6357 @item -mnop-fun-dllimport
6358 @opindex mnop-fun-dllimport
6359 Disable support for the @code{dllimport} attribute.
6360
6361 @item -msingle-pic-base
6362 @opindex msingle-pic-base
6363 Treat the register used for PIC addressing as read-only, rather than
6364 loading it in the prologue for each function.  The run-time system is
6365 responsible for initializing this register with an appropriate value
6366 before execution begins.
6367
6368 @item -mpic-register=@var{reg}
6369 @opindex mpic-register
6370 Specify the register to be used for PIC addressing.  The default is R10
6371 unless stack-checking is enabled, when R9 is used.
6372
6373 @item -mcirrus-fix-invalid-insns
6374 @opindex -mcirrus-fix-invalid-insns
6375 @opindex -mno-cirrus-fix-invalid-insns
6376 Insert NOPs into the instruction stream to in order to work around
6377 problems with invalid Maverick instruction combinations.  This option
6378 is only valid if the @option{-mcpu=ep9312} option has been used to
6379 enable generation of instructions for the Cirrus Maverick floating
6380 point co-processor.  This option is not enabled by default, since the
6381 problem is only present in older Maverick implemenations.  The default
6382 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6383 switch.
6384
6385 @item -mpoke-function-name
6386 @opindex mpoke-function-name
6387 Write the name of each function into the text section, directly
6388 preceding the function prologue.  The generated code is similar to this:
6389
6390 @smallexample
6391      t0
6392          .ascii "arm_poke_function_name", 0
6393          .align
6394      t1
6395          .word 0xff000000 + (t1 - t0)
6396      arm_poke_function_name
6397          mov     ip, sp
6398          stmfd   sp!, @{fp, ip, lr, pc@}
6399          sub     fp, ip, #4
6400 @end smallexample
6401
6402 When performing a stack backtrace, code can inspect the value of
6403 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6404 location @code{pc - 12} and the top 8 bits are set, then we know that
6405 there is a function name embedded immediately preceding this location
6406 and has length @code{((pc[-3]) & 0xff000000)}.
6407
6408 @item -mthumb
6409 @opindex mthumb
6410 Generate code for the 16-bit Thumb instruction set.  The default is to
6411 use the 32-bit ARM instruction set.
6412
6413 @item -mtpcs-frame
6414 @opindex mtpcs-frame
6415 Generate a stack frame that is compliant with the Thumb Procedure Call
6416 Standard for all non-leaf functions.  (A leaf function is one that does
6417 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6418
6419 @item -mtpcs-leaf-frame
6420 @opindex mtpcs-leaf-frame
6421 Generate a stack frame that is compliant with the Thumb Procedure Call
6422 Standard for all leaf functions.  (A leaf function is one that does
6423 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6424
6425 @item -mcallee-super-interworking
6426 @opindex mcallee-super-interworking
6427 Gives all externally visible functions in the file being compiled an ARM
6428 instruction set header which switches to Thumb mode before executing the
6429 rest of the function.  This allows these functions to be called from
6430 non-interworking code.
6431
6432 @item -mcaller-super-interworking
6433 @opindex mcaller-super-interworking
6434 Allows calls via function pointers (including virtual functions) to
6435 execute correctly regardless of whether the target code has been
6436 compiled for interworking or not.  There is a small overhead in the cost
6437 of executing a function pointer if this option is enabled.
6438
6439 @end table
6440
6441 @node MN10200 Options
6442 @subsection MN10200 Options
6443 @cindex MN10200 options
6444 These @option{-m} options are defined for Matsushita MN10200 architectures:
6445 @table @gcctabopt
6446
6447 @item -mrelax
6448 @opindex mrelax
6449 Indicate to the linker that it should perform a relaxation optimization pass
6450 to shorten branches, calls and absolute memory addresses.  This option only
6451 has an effect when used on the command line for the final link step.
6452
6453 This option makes symbolic debugging impossible.
6454 @end table
6455
6456 @node MN10300 Options
6457 @subsection MN10300 Options
6458 @cindex MN10300 options
6459 These @option{-m} options are defined for Matsushita MN10300 architectures:
6460
6461 @table @gcctabopt
6462 @item -mmult-bug
6463 @opindex mmult-bug
6464 Generate code to avoid bugs in the multiply instructions for the MN10300
6465 processors.  This is the default.
6466
6467 @item -mno-mult-bug
6468 @opindex mno-mult-bug
6469 Do not generate code to avoid bugs in the multiply instructions for the
6470 MN10300 processors.
6471
6472 @item -mam33
6473 @opindex mam33
6474 Generate code which uses features specific to the AM33 processor.
6475
6476 @item -mno-am33
6477 @opindex mno-am33
6478 Do not generate code which uses features specific to the AM33 processor.  This
6479 is the default.
6480
6481 @item -mno-crt0
6482 @opindex mno-crt0
6483 Do not link in the C run-time initialization object file.
6484
6485 @item -mrelax
6486 @opindex mrelax
6487 Indicate to the linker that it should perform a relaxation optimization pass
6488 to shorten branches, calls and absolute memory addresses.  This option only
6489 has an effect when used on the command line for the final link step.
6490
6491 This option makes symbolic debugging impossible.
6492 @end table
6493
6494
6495 @node M32R/D Options
6496 @subsection M32R/D Options
6497 @cindex M32R/D options
6498
6499 These @option{-m} options are defined for Mitsubishi M32R/D architectures:
6500
6501 @table @gcctabopt
6502 @item -m32rx
6503 @opindex m32rx
6504 Generate code for the M32R/X@.
6505
6506 @item -m32r
6507 @opindex m32r
6508 Generate code for the M32R@.  This is the default.
6509
6510 @item -mcode-model=small
6511 @opindex mcode-model=small
6512 Assume all objects live in the lower 16MB of memory (so that their addresses
6513 can be loaded with the @code{ld24} instruction), and assume all subroutines
6514 are reachable with the @code{bl} instruction.
6515 This is the default.
6516
6517 The addressability of a particular object can be set with the
6518 @code{model} attribute.
6519
6520 @item -mcode-model=medium
6521 @opindex mcode-model=medium
6522 Assume objects may be anywhere in the 32-bit address space (the compiler
6523 will generate @code{seth/add3} instructions to load their addresses), and
6524 assume all subroutines are reachable with the @code{bl} instruction.
6525
6526 @item -mcode-model=large
6527 @opindex mcode-model=large
6528 Assume objects may be anywhere in the 32-bit address space (the compiler
6529 will generate @code{seth/add3} instructions to load their addresses), and
6530 assume subroutines may not be reachable with the @code{bl} instruction
6531 (the compiler will generate the much slower @code{seth/add3/jl}
6532 instruction sequence).
6533
6534 @item -msdata=none
6535 @opindex msdata=none
6536 Disable use of the small data area.  Variables will be put into
6537 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
6538 @code{section} attribute has been specified).
6539 This is the default.
6540
6541 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
6542 Objects may be explicitly put in the small data area with the
6543 @code{section} attribute using one of these sections.
6544
6545 @item -msdata=sdata
6546 @opindex msdata=sdata
6547 Put small global and static data in the small data area, but do not
6548 generate special code to reference them.
6549
6550 @item -msdata=use
6551 @opindex msdata=use
6552 Put small global and static data in the small data area, and generate
6553 special instructions to reference them.
6554
6555 @item -G @var{num}
6556 @opindex G
6557 @cindex smaller data references
6558 Put global and static objects less than or equal to @var{num} bytes
6559 into the small data or bss sections instead of the normal data or bss
6560 sections.  The default value of @var{num} is 8.
6561 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
6562 for this option to have any effect.
6563
6564 All modules should be compiled with the same @option{-G @var{num}} value.
6565 Compiling with different values of @var{num} may or may not work; if it
6566 doesn't the linker will give an error message---incorrect code will not be
6567 generated.
6568
6569 @end table
6570
6571 @node M88K Options
6572 @subsection M88K Options
6573 @cindex M88k options
6574
6575 These @samp{-m} options are defined for Motorola 88k architectures:
6576
6577 @table @gcctabopt
6578 @item -m88000
6579 @opindex m88000
6580 Generate code that works well on both the m88100 and the
6581 m88110.
6582
6583 @item -m88100
6584 @opindex m88100
6585 Generate code that works best for the m88100, but that also
6586 runs on the m88110.
6587
6588 @item -m88110
6589 @opindex m88110
6590 Generate code that works best for the m88110, and may not run
6591 on the m88100.
6592
6593 @item -mbig-pic
6594 @opindex mbig-pic
6595 Obsolete option to be removed from the next revision.
6596 Use @option{-fPIC}.
6597
6598 @item -midentify-revision
6599 @opindex midentify-revision
6600 @cindex identifying source, compiler (88k)
6601 Include an @code{ident} directive in the assembler output recording the
6602 source file name, compiler name and version, timestamp, and compilation
6603 flags used.
6604
6605 @item -mno-underscores
6606 @opindex mno-underscores
6607 @cindex underscores, avoiding (88k)
6608 In assembler output, emit symbol names without adding an underscore
6609 character at the beginning of each name.  The default is to use an
6610 underscore as prefix on each name.
6611
6612 @item -mocs-debug-info
6613 @itemx -mno-ocs-debug-info
6614 @opindex mocs-debug-info
6615 @opindex mno-ocs-debug-info
6616 @cindex OCS (88k)
6617 @cindex debugging, 88k OCS
6618 Include (or omit) additional debugging information (about registers used
6619 in each stack frame) as specified in the 88open Object Compatibility
6620 Standard, ``OCS''@.  This extra information allows debugging of code that
6621 has had the frame pointer eliminated.  The default for SVr4 and Delta 88
6622 SVr3.2 is to include this information; other 88k configurations omit this
6623 information by default.
6624
6625 @item -mocs-frame-position
6626 @opindex mocs-frame-position
6627 @cindex register positions in frame (88k)
6628 When emitting COFF debugging information for automatic variables and
6629 parameters stored on the stack, use the offset from the canonical frame
6630 address, which is the stack pointer (register 31) on entry to the
6631 function.  The SVr4 and Delta88 SVr3.2, and BCS configurations use
6632 @option{-mocs-frame-position}; other 88k configurations have the default
6633 @option{-mno-ocs-frame-position}.
6634
6635 @item -mno-ocs-frame-position
6636 @opindex mno-ocs-frame-position
6637 @cindex register positions in frame (88k)
6638 When emitting COFF debugging information for automatic variables and
6639 parameters stored on the stack, use the offset from the frame pointer
6640 register (register 30).  When this option is in effect, the frame
6641 pointer is not eliminated when debugging information is selected by the
6642 -g switch.
6643
6644 @item -moptimize-arg-area
6645 @opindex moptimize-arg-area
6646 @cindex arguments in frame (88k)
6647 Save space by reorganizing the stack frame.  This option generates code
6648 that does not agree with the 88open specifications, but uses less
6649 memory.
6650
6651 @itemx -mno-optimize-arg-area
6652 @opindex mno-optimize-arg-area
6653 Do not reorganize the stack frame to save space.  This is the default.
6654 The generated conforms to the specification, but uses more memory.
6655
6656 @item -mshort-data-@var{num}
6657 @opindex mshort-data
6658 @cindex smaller data references (88k)
6659 @cindex r0-relative references (88k)
6660 Generate smaller data references by making them relative to @code{r0},
6661 which allows loading a value using a single instruction (rather than the
6662 usual two).  You control which data references are affected by
6663 specifying @var{num} with this option.  For example, if you specify
6664 @option{-mshort-data-512}, then the data references affected are those
6665 involving displacements of less than 512 bytes.
6666 @option{-mshort-data-@var{num}} is not effective for @var{num} greater
6667 than 64k.
6668
6669 @item -mserialize-volatile
6670 @opindex mserialize-volatile
6671 @itemx -mno-serialize-volatile
6672 @opindex mno-serialize-volatile
6673 @cindex sequential consistency on 88k
6674 Do, or don't, generate code to guarantee sequential consistency
6675 of volatile memory references.  By default, consistency is
6676 guaranteed.
6677
6678 The order of memory references made by the MC88110 processor does
6679 not always match the order of the instructions requesting those
6680 references.  In particular, a load instruction may execute before
6681 a preceding store instruction.  Such reordering violates
6682 sequential consistency of volatile memory references, when there
6683 are multiple processors.   When consistency must be guaranteed,
6684 GCC generates special instructions, as needed, to force
6685 execution in the proper order.
6686
6687 The MC88100 processor does not reorder memory references and so
6688 always provides sequential consistency.  However, by default, GCC
6689 generates the special instructions to guarantee consistency
6690 even when you use @option{-m88100}, so that the code may be run on an
6691 MC88110 processor.  If you intend to run your code only on the
6692 MC88100 processor, you may use @option{-mno-serialize-volatile}.
6693
6694 The extra code generated to guarantee consistency may affect the
6695 performance of your application.  If you know that you can safely
6696 forgo this guarantee, you may use @option{-mno-serialize-volatile}.
6697
6698 @item -msvr4
6699 @itemx -msvr3
6700 @opindex msvr4
6701 @opindex msvr3
6702 @cindex assembler syntax, 88k
6703 @cindex SVr4
6704 Turn on (@option{-msvr4}) or off (@option{-msvr3}) compiler extensions
6705 related to System V release 4 (SVr4).  This controls the following:
6706
6707 @enumerate
6708 @item
6709 Which variant of the assembler syntax to emit.
6710 @item
6711 @option{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
6712 that is used on System V release 4.
6713 @item
6714 @option{-msvr4} makes GCC issue additional declaration directives used in
6715 SVr4.
6716 @end enumerate
6717
6718 @option{-msvr4} is the default for the m88k-motorola-sysv4 configuration.
6719 @option{-msvr3} is the default for all other m88k configurations.
6720
6721 @item -mversion-03.00
6722 @opindex mversion-03.00
6723 This option is obsolete, and is ignored.
6724 @c ??? which asm syntax better for GAS?  option there too?
6725
6726 @item -mno-check-zero-division
6727 @itemx -mcheck-zero-division
6728 @opindex mno-check-zero-division
6729 @opindex mcheck-zero-division
6730 @cindex zero division on 88k
6731 Do, or don't, generate code to guarantee that integer division by
6732 zero will be detected.  By default, detection is guaranteed.
6733
6734 Some models of the MC88100 processor fail to trap upon integer
6735 division by zero under certain conditions.  By default, when
6736 compiling code that might be run on such a processor, GCC
6737 generates code that explicitly checks for zero-valued divisors
6738 and traps with exception number 503 when one is detected.  Use of
6739 @option{-mno-check-zero-division} suppresses such checking for code
6740 generated to run on an MC88100 processor.
6741
6742 GCC assumes that the MC88110 processor correctly detects all instances
6743 of integer division by zero.  When @option{-m88110} is specified, no
6744 explicit checks for zero-valued divisors are generated, and both
6745 @option{-mcheck-zero-division} and @option{-mno-check-zero-division} are
6746 ignored.
6747
6748 @item -muse-div-instruction
6749 @opindex muse-div-instruction
6750 @cindex divide instruction, 88k
6751 Use the div instruction for signed integer division on the
6752 MC88100 processor.  By default, the div instruction is not used.
6753
6754 On the MC88100 processor the signed integer division instruction
6755 div) traps to the operating system on a negative operand.  The
6756 operating system transparently completes the operation, but at a
6757 large cost in execution time.  By default, when compiling code
6758 that might be run on an MC88100 processor, GCC emulates signed
6759 integer division using the unsigned integer division instruction
6760 divu), thereby avoiding the large penalty of a trap to the
6761 operating system.  Such emulation has its own, smaller, execution
6762 cost in both time and space.  To the extent that your code's
6763 important signed integer division operations are performed on two
6764 nonnegative operands, it may be desirable to use the div
6765 instruction directly.
6766
6767 On the MC88110 processor the div instruction (also known as the
6768 divs instruction) processes negative operands without trapping to
6769 the operating system.  When @option{-m88110} is specified,
6770 @option{-muse-div-instruction} is ignored, and the div instruction is used
6771 for signed integer division.
6772
6773 Note that the result of dividing @code{INT_MIN} by @minus{}1 is undefined.  In
6774 particular, the behavior of such a division with and without
6775 @option{-muse-div-instruction} may differ.
6776
6777 @item -mtrap-large-shift
6778 @itemx -mhandle-large-shift
6779 @opindex mtrap-large-shift
6780 @opindex mhandle-large-shift
6781 @cindex bit shift overflow (88k)
6782 @cindex large bit shifts (88k)
6783 Include code to detect bit-shifts of more than 31 bits; respectively,
6784 trap such shifts or emit code to handle them properly.  By default GCC
6785 makes no special provision for large bit shifts.
6786
6787 @item -mwarn-passed-structs
6788 @opindex mwarn-passed-structs
6789 @cindex structure passing (88k)
6790 Warn when a function passes a struct as an argument or result.
6791 Structure-passing conventions have changed during the evolution of the C
6792 language, and are often the source of portability problems.  By default,
6793 GCC issues no such warning.
6794 @end table
6795
6796 @c break page here to avoid unsightly interparagraph stretch.
6797 @c -zw, 2001-8-17
6798 @page
6799
6800 @node RS/6000 and PowerPC Options
6801 @subsection IBM RS/6000 and PowerPC Options
6802 @cindex RS/6000 and PowerPC Options
6803 @cindex IBM RS/6000 and PowerPC Options
6804
6805 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
6806 @table @gcctabopt
6807 @item -mpower
6808 @itemx -mno-power
6809 @itemx -mpower2
6810 @itemx -mno-power2
6811 @itemx -mpowerpc
6812 @itemx -mno-powerpc
6813 @itemx -mpowerpc-gpopt
6814 @itemx -mno-powerpc-gpopt
6815 @itemx -mpowerpc-gfxopt
6816 @itemx -mno-powerpc-gfxopt
6817 @itemx -mpowerpc64
6818 @itemx -mno-powerpc64
6819 @opindex mpower
6820 @opindex mno-power
6821 @opindex mpower2
6822 @opindex mno-power2
6823 @opindex mpowerpc
6824 @opindex mno-powerpc
6825 @opindex mpowerpc-gpopt
6826 @opindex mno-powerpc-gpopt
6827 @opindex mpowerpc-gfxopt
6828 @opindex mno-powerpc-gfxopt
6829 @opindex mpowerpc64
6830 @opindex mno-powerpc64
6831 GCC supports two related instruction set architectures for the
6832 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
6833 instructions supported by the @samp{rios} chip set used in the original
6834 RS/6000 systems and the @dfn{PowerPC} instruction set is the
6835 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
6836 the IBM 4xx microprocessors.
6837
6838 Neither architecture is a subset of the other.  However there is a
6839 large common subset of instructions supported by both.  An MQ
6840 register is included in processors supporting the POWER architecture.
6841
6842 You use these options to specify which instructions are available on the
6843 processor you are using.  The default value of these options is
6844 determined when configuring GCC@.  Specifying the
6845 @option{-mcpu=@var{cpu_type}} overrides the specification of these
6846 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
6847 rather than the options listed above.
6848
6849 The @option{-mpower} option allows GCC to generate instructions that
6850 are found only in the POWER architecture and to use the MQ register.
6851 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
6852 to generate instructions that are present in the POWER2 architecture but
6853 not the original POWER architecture.
6854
6855 The @option{-mpowerpc} option allows GCC to generate instructions that
6856 are found only in the 32-bit subset of the PowerPC architecture.
6857 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
6858 GCC to use the optional PowerPC architecture instructions in the
6859 General Purpose group, including floating-point square root.  Specifying
6860 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
6861 use the optional PowerPC architecture instructions in the Graphics
6862 group, including floating-point select.
6863
6864 The @option{-mpowerpc64} option allows GCC to generate the additional
6865 64-bit instructions that are found in the full PowerPC64 architecture
6866 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
6867 @option{-mno-powerpc64}.
6868
6869 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
6870 will use only the instructions in the common subset of both
6871 architectures plus some special AIX common-mode calls, and will not use
6872 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
6873 permits GCC to use any instruction from either architecture and to
6874 allow use of the MQ register; specify this for the Motorola MPC601.
6875
6876 @item -mnew-mnemonics
6877 @itemx -mold-mnemonics
6878 @opindex mnew-mnemonics
6879 @opindex mold-mnemonics
6880 Select which mnemonics to use in the generated assembler code.  With
6881 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
6882 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
6883 assembler mnemonics defined for the POWER architecture.  Instructions
6884 defined in only one architecture have only one mnemonic; GCC uses that
6885 mnemonic irrespective of which of these options is specified.
6886
6887 GCC defaults to the mnemonics appropriate for the architecture in
6888 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
6889 value of these option.  Unless you are building a cross-compiler, you
6890 should normally not specify either @option{-mnew-mnemonics} or
6891 @option{-mold-mnemonics}, but should instead accept the default.
6892
6893 @item -mcpu=@var{cpu_type}
6894 @opindex mcpu
6895 Set architecture type, register usage, choice of mnemonics, and
6896 instruction scheduling parameters for machine type @var{cpu_type}.
6897 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
6898 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
6899 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
6900 @samp{630}, @samp{740}, @samp{7400}, @samp{7450}, @samp{750},
6901 @samp{power}, @samp{power2}, @samp{powerpc}, @samp{403}, @samp{505},
6902 @samp{801}, @samp{821}, @samp{823}, and @samp{860} and @samp{common}.
6903
6904 @option{-mcpu=common} selects a completely generic processor.  Code
6905 generated under this option will run on any POWER or PowerPC processor.
6906 GCC will use only the instructions in the common subset of both
6907 architectures, and will not use the MQ register.  GCC assumes a generic
6908 processor model for scheduling purposes.
6909
6910 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
6911 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
6912 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
6913 types, with an appropriate, generic processor model assumed for
6914 scheduling purposes.
6915
6916 The other options specify a specific processor.  Code generated under
6917 those options will run best on that processor, and may not run at all on
6918 others.
6919
6920 The @option{-mcpu} options automatically enable or disable other
6921 @option{-m} options as follows:
6922
6923 @table @samp
6924 @item common
6925 @option{-mno-power}, @option{-mno-powerpc}
6926
6927 @item power
6928 @itemx power2
6929 @itemx rios1
6930 @itemx rios2
6931 @itemx rsc
6932 @option{-mpower}, @option{-mno-powerpc}, @option{-mno-new-mnemonics}
6933
6934 @item powerpc
6935 @itemx rs64a
6936 @itemx 602
6937 @itemx 603
6938 @itemx 603e
6939 @itemx 604
6940 @itemx 620
6941 @itemx 630
6942 @itemx 740
6943 @itemx 7400
6944 @itemx 7450
6945 @itemx 750
6946 @itemx 505
6947 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6948
6949 @item 601
6950 @option{-mpower}, @option{-mpowerpc}, @option{-mnew-mnemonics}
6951
6952 @item 403
6953 @itemx 821
6954 @itemx 860
6955 @option{-mno-power}, @option{-mpowerpc}, @option{-mnew-mnemonics}, @option{-msoft-float}
6956 @end table
6957
6958 @item -mtune=@var{cpu_type}
6959 @opindex mtune
6960 Set the instruction scheduling parameters for machine type
6961 @var{cpu_type}, but do not set the architecture type, register usage, or
6962 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
6963 values for @var{cpu_type} are used for @option{-mtune} as for
6964 @option{-mcpu}.  If both are specified, the code generated will use the
6965 architecture, registers, and mnemonics set by @option{-mcpu}, but the
6966 scheduling parameters set by @option{-mtune}.
6967
6968 @item -maltivec
6969 @itemx -mno-altivec
6970 @opindex maltivec
6971 @opindex mno-altivec
6972 These switches enable or disable the use of built-in functions that
6973 allow access to the AltiVec instruction set.  You may also need to set
6974 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
6975 enhancements.
6976
6977 @item -mabi=spe
6978 @opindex mabi=spe
6979 Extend the current ABI with SPE ABI extensions.  This does not change
6980 the default ABI, instead it adds the SPE ABI extensions to the current
6981 ABI@.
6982
6983 @item -mabi=no-spe
6984 @opindex mabi=no-spe
6985 Disable Booke SPE ABI extensions for the current ABI.
6986
6987 @item -misel=@var{yes/no}
6988 @itemx -misel
6989 @opindex misel
6990 This switch enables or disables the generation of ISEL instructions.
6991
6992 @item -mspe=@var{yes/no}
6993 @itemx -mspe
6994 @opindex mspe
6995 This switch enables or disables the generation of SPE simd
6996 instructions.
6997
6998 @item -mfull-toc
6999 @itemx -mno-fp-in-toc
7000 @itemx -mno-sum-in-toc
7001 @itemx -mminimal-toc
7002 @opindex mfull-toc
7003 @opindex mno-fp-in-toc
7004 @opindex mno-sum-in-toc
7005 @opindex mminimal-toc
7006 Modify generation of the TOC (Table Of Contents), which is created for
7007 every executable file.  The @option{-mfull-toc} option is selected by
7008 default.  In that case, GCC will allocate at least one TOC entry for
7009 each unique non-automatic variable reference in your program.  GCC
7010 will also place floating-point constants in the TOC@.  However, only
7011 16,384 entries are available in the TOC@.
7012
7013 If you receive a linker error message that saying you have overflowed
7014 the available TOC space, you can reduce the amount of TOC space used
7015 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
7016 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
7017 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
7018 generate code to calculate the sum of an address and a constant at
7019 run-time instead of putting that sum into the TOC@.  You may specify one
7020 or both of these options.  Each causes GCC to produce very slightly
7021 slower and larger code at the expense of conserving TOC space.
7022
7023 If you still run out of space in the TOC even when you specify both of
7024 these options, specify @option{-mminimal-toc} instead.  This option causes
7025 GCC to make only one TOC entry for every file.  When you specify this
7026 option, GCC will produce code that is slower and larger but which
7027 uses extremely little TOC space.  You may wish to use this option
7028 only on files that contain less frequently executed code.
7029
7030 @item -maix64
7031 @itemx -maix32
7032 @opindex maix64
7033 @opindex maix32
7034 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
7035 @code{long} type, and the infrastructure needed to support them.
7036 Specifying @option{-maix64} implies @option{-mpowerpc64} and
7037 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
7038 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
7039
7040 @item -mxl-call
7041 @itemx -mno-xl-call
7042 @opindex mxl-call
7043 @opindex mno-xl-call
7044 On AIX, pass floating-point arguments to prototyped functions beyond the
7045 register save area (RSA) on the stack in addition to argument FPRs.  The
7046 AIX calling convention was extended but not initially documented to
7047 handle an obscure K&R C case of calling a function that takes the
7048 address of its arguments with fewer arguments than declared.  AIX XL
7049 compilers access floating point arguments which do not fit in the
7050 RSA from the stack when a subroutine is compiled without
7051 optimization.  Because always storing floating-point arguments on the
7052 stack is inefficient and rarely needed, this option is not enabled by
7053 default and only is necessary when calling subroutines compiled by AIX
7054 XL compilers without optimization.
7055
7056 @item -mpe
7057 @opindex mpe
7058 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
7059 application written to use message passing with special startup code to
7060 enable the application to run.  The system must have PE installed in the
7061 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
7062 must be overridden with the @option{-specs=} option to specify the
7063 appropriate directory location.  The Parallel Environment does not
7064 support threads, so the @option{-mpe} option and the @option{-pthread}
7065 option are incompatible.
7066
7067 @item -msoft-float
7068 @itemx -mhard-float
7069 @opindex msoft-float
7070 @opindex mhard-float
7071 Generate code that does not use (uses) the floating-point register set.
7072 Software floating point emulation is provided if you use the
7073 @option{-msoft-float} option, and pass the option to GCC when linking.
7074
7075 @item -mmultiple
7076 @itemx -mno-multiple
7077 @opindex mmultiple
7078 @opindex mno-multiple
7079 Generate code that uses (does not use) the load multiple word
7080 instructions and the store multiple word instructions.  These
7081 instructions are generated by default on POWER systems, and not
7082 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
7083 endian PowerPC systems, since those instructions do not work when the
7084 processor is in little endian mode.  The exceptions are PPC740 and
7085 PPC750 which permit the instructions usage in little endian mode.
7086
7087 @item -mstring
7088 @itemx -mno-string
7089 @opindex mstring
7090 @opindex mno-string
7091 Generate code that uses (does not use) the load string instructions
7092 and the store string word instructions to save multiple registers and
7093 do small block moves.  These instructions are generated by default on
7094 POWER systems, and not generated on PowerPC systems.  Do not use
7095 @option{-mstring} on little endian PowerPC systems, since those
7096 instructions do not work when the processor is in little endian mode.
7097 The exceptions are PPC740 and PPC750 which permit the instructions
7098 usage in little endian mode.
7099
7100 @item -mupdate
7101 @itemx -mno-update
7102 @opindex mupdate
7103 @opindex mno-update
7104 Generate code that uses (does not use) the load or store instructions
7105 that update the base register to the address of the calculated memory
7106 location.  These instructions are generated by default.  If you use
7107 @option{-mno-update}, there is a small window between the time that the
7108 stack pointer is updated and the address of the previous frame is
7109 stored, which means code that walks the stack frame across interrupts or
7110 signals may get corrupted data.
7111
7112 @item -mfused-madd
7113 @itemx -mno-fused-madd
7114 @opindex mfused-madd
7115 @opindex mno-fused-madd
7116 Generate code that uses (does not use) the floating point multiply and
7117 accumulate instructions.  These instructions are generated by default if
7118 hardware floating is used.
7119
7120 @item -mno-bit-align
7121 @itemx -mbit-align
7122 @opindex mno-bit-align
7123 @opindex mbit-align
7124 On System V.4 and embedded PowerPC systems do not (do) force structures
7125 and unions that contain bit-fields to be aligned to the base type of the
7126 bit-field.
7127
7128 For example, by default a structure containing nothing but 8
7129 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
7130 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
7131 the structure would be aligned to a 1 byte boundary and be one byte in
7132 size.
7133
7134 @item -mno-strict-align
7135 @itemx -mstrict-align
7136 @opindex mno-strict-align
7137 @opindex mstrict-align
7138 On System V.4 and embedded PowerPC systems do not (do) assume that
7139 unaligned memory references will be handled by the system.
7140
7141 @item -mrelocatable
7142 @itemx -mno-relocatable
7143 @opindex mrelocatable
7144 @opindex mno-relocatable
7145 On embedded PowerPC systems generate code that allows (does not allow)
7146 the program to be relocated to a different address at runtime.  If you
7147 use @option{-mrelocatable} on any module, all objects linked together must
7148 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
7149
7150 @item -mrelocatable-lib
7151 @itemx -mno-relocatable-lib
7152 @opindex mrelocatable-lib
7153 @opindex mno-relocatable-lib
7154 On embedded PowerPC systems generate code that allows (does not allow)
7155 the program to be relocated to a different address at runtime.  Modules
7156 compiled with @option{-mrelocatable-lib} can be linked with either modules
7157 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
7158 with modules compiled with the @option{-mrelocatable} options.
7159
7160 @item -mno-toc
7161 @itemx -mtoc
7162 @opindex mno-toc
7163 @opindex mtoc
7164 On System V.4 and embedded PowerPC systems do not (do) assume that
7165 register 2 contains a pointer to a global area pointing to the addresses
7166 used in the program.
7167
7168 @item -mlittle
7169 @itemx -mlittle-endian
7170 @opindex mlittle
7171 @opindex mlittle-endian
7172 On System V.4 and embedded PowerPC systems compile code for the
7173 processor in little endian mode.  The @option{-mlittle-endian} option is
7174 the same as @option{-mlittle}.
7175
7176 @item -mbig
7177 @itemx -mbig-endian
7178 @opindex mbig
7179 @opindex mbig-endian
7180 On System V.4 and embedded PowerPC systems compile code for the
7181 processor in big endian mode.  The @option{-mbig-endian} option is
7182 the same as @option{-mbig}.
7183
7184 @item -mdynamic-no-pic
7185 @opindex mdynamic-no-pic
7186 On Darwin and Mac OS X systems, compile code so that it is not
7187 relocatable, but that its external references are relocatable.  The
7188 resulting code is suitable for applications, but not shared
7189 libraries.
7190
7191 @item -mcall-sysv
7192 @opindex mcall-sysv
7193 On System V.4 and embedded PowerPC systems compile code using calling
7194 conventions that adheres to the March 1995 draft of the System V
7195 Application Binary Interface, PowerPC processor supplement.  This is the
7196 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
7197
7198 @item -mcall-sysv-eabi
7199 @opindex mcall-sysv-eabi
7200 Specify both @option{-mcall-sysv} and @option{-meabi} options.
7201
7202 @item -mcall-sysv-noeabi
7203 @opindex mcall-sysv-noeabi
7204 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
7205
7206 @item -mcall-aix
7207 @opindex mcall-aix
7208 On System V.4 and embedded PowerPC systems compile code using calling
7209 conventions that are similar to those used on AIX@.  This is the
7210 default if you configured GCC using @samp{powerpc-*-eabiaix}.
7211
7212 @item -mcall-solaris
7213 @opindex mcall-solaris
7214 On System V.4 and embedded PowerPC systems compile code for the Solaris
7215 operating system.
7216
7217 @item -mcall-linux
7218 @opindex mcall-linux
7219 On System V.4 and embedded PowerPC systems compile code for the
7220 Linux-based GNU system.
7221
7222 @item -mcall-gnu
7223 @opindex mcall-gnu
7224 On System V.4 and embedded PowerPC systems compile code for the
7225 Hurd-based GNU system.
7226
7227 @item -mcall-netbsd
7228 @opindex mcall-netbsd
7229 On System V.4 and embedded PowerPC systems compile code for the
7230 NetBSD operating system.
7231
7232 @item -maix-struct-return
7233 @opindex maix-struct-return
7234 Return all structures in memory (as specified by the AIX ABI)@.
7235
7236 @item -msvr4-struct-return
7237 @opindex msvr4-struct-return
7238 Return structures smaller than 8 bytes in registers (as specified by the
7239 SVR4 ABI)@.
7240
7241 @item -mabi=altivec
7242 @opindex mabi=altivec
7243 Extend the current ABI with AltiVec ABI extensions.  This does not
7244 change the default ABI, instead it adds the AltiVec ABI extensions to
7245 the current ABI@.
7246
7247 @item -mabi=no-altivec
7248 @opindex mabi=no-altivec
7249 Disable AltiVec ABI extensions for the current ABI.
7250
7251 @item -mprototype
7252 @itemx -mno-prototype
7253 @opindex mprototype
7254 @opindex mno-prototype
7255 On System V.4 and embedded PowerPC systems assume that all calls to
7256 variable argument functions are properly prototyped.  Otherwise, the
7257 compiler must insert an instruction before every non prototyped call to
7258 set or clear bit 6 of the condition code register (@var{CR}) to
7259 indicate whether floating point values were passed in the floating point
7260 registers in case the function takes a variable arguments.  With
7261 @option{-mprototype}, only calls to prototyped variable argument functions
7262 will set or clear the bit.
7263
7264 @item -msim
7265 @opindex msim
7266 On embedded PowerPC systems, assume that the startup module is called
7267 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
7268 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
7269 configurations.
7270
7271 @item -mmvme
7272 @opindex mmvme
7273 On embedded PowerPC systems, assume that the startup module is called
7274 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
7275 @file{libc.a}.
7276
7277 @item -mads
7278 @opindex mads
7279 On embedded PowerPC systems, assume that the startup module is called
7280 @file{crt0.o} and the standard C libraries are @file{libads.a} and
7281 @file{libc.a}.
7282
7283 @item -myellowknife
7284 @opindex myellowknife
7285 On embedded PowerPC systems, assume that the startup module is called
7286 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
7287 @file{libc.a}.
7288
7289 @item -mvxworks
7290 @opindex mvxworks
7291 On System V.4 and embedded PowerPC systems, specify that you are
7292 compiling for a VxWorks system.
7293
7294 @item -mwindiss
7295 @opindex mwindiss
7296 Specify that you are compiling for the WindISS simulation environment.
7297
7298 @item -memb
7299 @opindex memb
7300 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
7301 header to indicate that @samp{eabi} extended relocations are used.
7302
7303 @item -meabi
7304 @itemx -mno-eabi
7305 @opindex meabi
7306 @opindex mno-eabi
7307 On System V.4 and embedded PowerPC systems do (do not) adhere to the
7308 Embedded Applications Binary Interface (eabi) which is a set of
7309 modifications to the System V.4 specifications.  Selecting @option{-meabi}
7310 means that the stack is aligned to an 8 byte boundary, a function
7311 @code{__eabi} is called to from @code{main} to set up the eabi
7312 environment, and the @option{-msdata} option can use both @code{r2} and
7313 @code{r13} to point to two separate small data areas.  Selecting
7314 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
7315 do not call an initialization function from @code{main}, and the
7316 @option{-msdata} option will only use @code{r13} to point to a single
7317 small data area.  The @option{-meabi} option is on by default if you
7318 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
7319
7320 @item -msdata=eabi
7321 @opindex msdata=eabi
7322 On System V.4 and embedded PowerPC systems, put small initialized
7323 @code{const} global and static data in the @samp{.sdata2} section, which
7324 is pointed to by register @code{r2}.  Put small initialized
7325 non-@code{const} global and static data in the @samp{.sdata} section,
7326 which is pointed to by register @code{r13}.  Put small uninitialized
7327 global and static data in the @samp{.sbss} section, which is adjacent to
7328 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
7329 incompatible with the @option{-mrelocatable} option.  The
7330 @option{-msdata=eabi} option also sets the @option{-memb} option.
7331
7332 @item -msdata=sysv
7333 @opindex msdata=sysv
7334 On System V.4 and embedded PowerPC systems, put small global and static
7335 data in the @samp{.sdata} section, which is pointed to by register
7336 @code{r13}.  Put small uninitialized global and static data in the
7337 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
7338 The @option{-msdata=sysv} option is incompatible with the
7339 @option{-mrelocatable} option.
7340
7341 @item -msdata=default
7342 @itemx -msdata
7343 @opindex msdata=default
7344 @opindex msdata
7345 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
7346 compile code the same as @option{-msdata=eabi}, otherwise compile code the
7347 same as @option{-msdata=sysv}.
7348
7349 @item -msdata-data
7350 @opindex msdata-data
7351 On System V.4 and embedded PowerPC systems, put small global and static
7352 data in the @samp{.sdata} section.  Put small uninitialized global and
7353 static data in the @samp{.sbss} section.  Do not use register @code{r13}
7354 to address small data however.  This is the default behavior unless
7355 other @option{-msdata} options are used.
7356
7357 @item -msdata=none
7358 @itemx -mno-sdata
7359 @opindex msdata=none
7360 @opindex mno-sdata
7361 On embedded PowerPC systems, put all initialized global and static data
7362 in the @samp{.data} section, and all uninitialized data in the
7363 @samp{.bss} section.
7364
7365 @item -G @var{num}
7366 @opindex G
7367 @cindex smaller data references (PowerPC)
7368 @cindex .sdata/.sdata2 references (PowerPC)
7369 On embedded PowerPC systems, put global and static items less than or
7370 equal to @var{num} bytes into the small data or bss sections instead of
7371 the normal data or bss section.  By default, @var{num} is 8.  The
7372 @option{-G @var{num}} switch is also passed to the linker.
7373 All modules should be compiled with the same @option{-G @var{num}} value.
7374
7375 @item -mregnames
7376 @itemx -mno-regnames
7377 @opindex mregnames
7378 @opindex mno-regnames
7379 On System V.4 and embedded PowerPC systems do (do not) emit register
7380 names in the assembly language output using symbolic forms.
7381
7382 @item -mlongcall
7383 @itemx -mno-longcall
7384 @opindex mlongcall
7385 @opindex mno-longcall
7386 Default to making all function calls via pointers, so that functions
7387 which reside further than 64 megabytes (67,108,864 bytes) from the
7388 current location can be called.  This setting can be overridden by the
7389 @code{shortcall} function attribute, or by @code{#pragma longcall(0)}.
7390
7391 Some linkers are capable of detecting out-of-range calls and generating
7392 glue code on the fly.  On these systems, long calls are unnecessary and
7393 generate slower code.  As of this writing, the AIX linker can do this,
7394 as can the GNU linker for PowerPC/64.  It is planned to add this feature
7395 to the GNU linker for 32-bit PowerPC systems as well.
7396
7397 In the future, we may cause GCC to ignore all longcall specifications
7398 when the linker is known to generate glue.
7399
7400 @item -pthread
7401 @opindex pthread
7402 Adds support for multithreading with the @dfn{pthreads} library.
7403 This option sets flags for both the preprocessor and linker.
7404
7405 @end table
7406
7407 @node Darwin Options
7408 @subsection Darwin Options
7409 @cindex Darwin options
7410 @table @gcctabopt
7411 @item -all_load    
7412 @opindex all_load   
7413 Loads all members of static archive libraries.
7414 See man ld(1) for more information.
7415
7416 @item -arch_errors_fatal
7417 @opindex arch_errors_fatal
7418 Cause the errors having to do with files that have the wrong architecture
7419 to be fatal.
7420
7421 @item -bind_at_load
7422 @opindex bind_at_load
7423 Causes the output file to be marked such that the dynamic linker will
7424 bind all undefined references when the file is loaded or launched.
7425
7426 @item -bundle     
7427 @opindex bundle
7428 Produce a Mach-o bundle format file.
7429 See man ld(1) for more information.
7430
7431 @item -bundle_loader @var{executable}
7432 @opindex bundle_loader
7433 This specifies the @var{executable} that will be loading the build
7434 output file being linked. See man ld(1) for more information.
7435
7436 @item -allowable_client  @var{client_name}
7437 @item -arch_only
7438
7439 @item -client_name       
7440 @item -compatibility_version
7441 @item -current_version    
7442 @item -dependency-file
7443 @item -dylib_file    
7444 @item -dylinker_install_name
7445 @item -dynamic
7446 @item -dynamiclib   
7447 @item -exported_symbols_list  
7448 @item -filelist
7449 @item -flat_namespace   
7450 @item -force_cpusubtype_ALL
7451 @item -force_flat_namespace   
7452 @item -headerpad_max_install_names
7453 @item -image_base  
7454 @item -init
7455 @item -install_name
7456 @item -keep_private_externs
7457 @item -multi_module
7458 @item -multiply_defined      
7459 @item -multiply_defined_unused      
7460 @item -noall_load  
7461 @item -nomultidefs
7462 @item -noprebind     
7463 @item -noseglinkedit
7464 @item -pagezero_size    
7465 @item -prebind
7466 @item -prebind_all_twolevel_modules
7467 @item -private_bundle
7468 @item -read_only_relocs
7469 @item -sectalign  
7470 @item -sectobjectsymbols    
7471 @item -whyload
7472 @item -seg1addr 
7473 @item -sectcreate
7474 @item -sectobjectsymbols
7475 @item -sectorder
7476 @item -seg_addr_table
7477 @item -seg_addr_table_filename
7478 @item -seglinkedit
7479 @item -segprot   
7480 @item -segs_read_only_addr
7481 @item -segs_read_write_addr
7482 @item -single_module   
7483 @item -static
7484 @item -sub_library
7485 @item -sub_umbrella 
7486 @item -twolevel_namespace
7487 @item -umbrella
7488 @item -undefined
7489 @item -unexported_symbols_list
7490 @item -weak_reference_mismatches
7491 @item -whatsloaded  
7492
7493 @opindex allowable_client
7494 @opindex arch_only    
7495 @opindex client_name
7496 @opindex compatibility_version
7497 @opindex current_version
7498 @opindex dependency-file
7499 @opindex dylib_file
7500 @opindex dylinker_install_name
7501 @opindex dynamic
7502 @opindex dynamiclib
7503 @opindex exported_symbols_list
7504 @opindex filelist  
7505 @opindex flat_namespace    
7506 @opindex force_cpusubtype_ALL
7507 @opindex force_flat_namespace
7508 @opindex headerpad_max_install_names
7509 @opindex image_base
7510 @opindex init     
7511 @opindex install_name
7512 @opindex keep_private_externs
7513 @opindex multi_module   
7514 @opindex multiply_defined
7515 @opindex multiply_defined_unused   
7516 @opindex noall_load  
7517 @opindex nomultidefs   
7518 @opindex noprebind
7519 @opindex noseglinkedit      
7520 @opindex pagezero_size
7521 @opindex prebind
7522 @opindex prebind_all_twolevel_modules
7523 @opindex private_bundle 
7524 @opindex read_only_relocs
7525 @opindex sectalign   
7526 @opindex sectobjectsymbols    
7527 @opindex whyload  
7528 @opindex seg1addr
7529 @opindex sectcreate       
7530 @opindex sectobjectsymbols 
7531 @opindex sectorder     
7532 @opindex seg_addr_table
7533 @opindex seg_addr_table_filename
7534 @opindex seglinkedit
7535 @opindex segprot
7536 @opindex segs_read_only_addr
7537 @opindex segs_read_write_addr
7538 @opindex single_module
7539 @opindex static
7540 @opindex sub_library
7541 @opindex sub_umbrella
7542 @opindex twolevel_namespace
7543 @opindex umbrella
7544 @opindex undefined
7545 @opindex unexported_symbols_list
7546 @opindex weak_reference_mismatches
7547 @opindex whatsloaded
7548
7549 This options are available for Darwin linker. Darwin linker man page
7550 describes them in detail.
7551 @end table
7552
7553
7554 @node RT Options
7555 @subsection IBM RT Options
7556 @cindex RT options
7557 @cindex IBM RT options
7558
7559 These @samp{-m} options are defined for the IBM RT PC:
7560
7561 @table @gcctabopt
7562 @item -min-line-mul
7563 @opindex min-line-mul
7564 Use an in-line code sequence for integer multiplies.  This is the
7565 default.
7566
7567 @item -mcall-lib-mul
7568 @opindex mcall-lib-mul
7569 Call @code{lmul$$} for integer multiples.
7570
7571 @item -mfull-fp-blocks
7572 @opindex mfull-fp-blocks
7573 Generate full-size floating point data blocks, including the minimum
7574 amount of scratch space recommended by IBM@.  This is the default.
7575
7576 @item -mminimum-fp-blocks
7577 @opindex mminimum-fp-blocks
7578 Do not include extra scratch space in floating point data blocks.  This
7579 results in smaller code, but slower execution, since scratch space must
7580 be allocated dynamically.
7581
7582 @cindex @file{stdarg.h} and RT PC
7583 @item -mfp-arg-in-fpregs
7584 @opindex mfp-arg-in-fpregs
7585 Use a calling sequence incompatible with the IBM calling convention in
7586 which floating point arguments are passed in floating point registers.
7587 Note that @code{stdarg.h} will not work with floating point operands
7588 if this option is specified.
7589
7590 @item -mfp-arg-in-gregs
7591 @opindex mfp-arg-in-gregs
7592 Use the normal calling convention for floating point arguments.  This is
7593 the default.
7594
7595 @item -mhc-struct-return
7596 @opindex mhc-struct-return
7597 Return structures of more than one word in memory, rather than in a
7598 register.  This provides compatibility with the MetaWare HighC (hc)
7599 compiler.  Use the option @option{-fpcc-struct-return} for compatibility
7600 with the Portable C Compiler (pcc).
7601
7602 @item -mnohc-struct-return
7603 @opindex mnohc-struct-return
7604 Return some structures of more than one word in registers, when
7605 convenient.  This is the default.  For compatibility with the
7606 IBM-supplied compilers, use the option @option{-fpcc-struct-return} or the
7607 option @option{-mhc-struct-return}.
7608 @end table
7609
7610 @node MIPS Options
7611 @subsection MIPS Options
7612 @cindex MIPS options
7613
7614 These @samp{-m} options are defined for the MIPS family of computers:
7615
7616 @table @gcctabopt
7617
7618 @item -march=@var{arch}
7619 @opindex march
7620 Generate code that will run on @var{arch}, which can be the name of a
7621 generic MIPS ISA, or the name of a particular processor.
7622 The ISA names are:
7623 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
7624 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
7625 The processor names are:
7626 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
7627 @samp{m4k},
7628 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
7629 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
7630 @samp{orion},
7631 @samp{sb1},
7632 @samp{vr4100}, @samp{vr4300}, and @samp{vr5000}.
7633 The special value @samp{from-abi} selects the
7634 most compatible architecture for the selected ABI (that is,
7635 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
7636
7637 In processor names, a final @samp{000} can be abbreviated as @samp{k}
7638 (for example, @samp{-march=r2k}).  Prefixes are optional, and
7639 @samp{vr} may be written @samp{r}.
7640
7641 GCC defines two macros based on the value of this option.  The first
7642 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
7643 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
7644 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
7645 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
7646 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
7647
7648 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
7649 above.  In other words, it will have the full prefix and will not
7650 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
7651 the macro names the resolved architecture (either @samp{"mips1"} or
7652 @samp{"mips3"}).  It names the default architecture when no
7653 @option{-march} option is given.
7654
7655 @item -mtune=@var{arch}
7656 @opindex mtune
7657 Optimize for @var{arch}.  Among other things, this option controls
7658 the way instructions are scheduled, and the perceived cost of arithmetic
7659 operations.  The list of @var{arch} values is the same as for
7660 @option{-march}.
7661
7662 When this option is not used, GCC will optimize for the processor
7663 specified by @option{-march}.  By using @option{-march} and
7664 @option{-mtune} together, it is possible to generate code that will
7665 run on a family of processors, but optimize the code for one
7666 particular member of that family.
7667
7668 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
7669 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
7670 @samp{-march} ones described above.
7671
7672 @item -mips1
7673 @opindex mips1
7674 Equivalent to @samp{-march=mips1}.
7675
7676 @item -mips2
7677 @opindex mips2
7678 Equivalent to @samp{-march=mips2}.
7679
7680 @item -mips3
7681 @opindex mips3
7682 Equivalent to @samp{-march=mips3}.
7683
7684 @item -mips4
7685 @opindex mips4
7686 Equivalent to @samp{-march=mips4}.
7687
7688 @item -mips32
7689 @opindex mips32
7690 Equivalent to @samp{-march=mips32}.
7691
7692 @item -mips32r2
7693 @opindex mips32r2
7694 Equivalent to @samp{-march=mips32r2}.
7695
7696 @item -mips64
7697 @opindex mips64
7698 Equivalent to @samp{-march=mips64}.
7699
7700 @item -mfused-madd
7701 @itemx -mno-fused-madd
7702 @opindex mfused-madd
7703 @opindex mno-fused-madd
7704 Generate code that uses (does not use) the floating point multiply and
7705 accumulate instructions, when they are available.  These instructions
7706 are generated by default if they are available, but this may be
7707 undesirable if the extra precision causes problems or on certain chips
7708 in the mode where denormals are rounded to zero where denormals
7709 generated by multiply and accumulate instructions cause exceptions
7710 anyway.
7711
7712 @item -mfp32
7713 @opindex mfp32
7714 Assume that floating point registers are 32 bits wide.
7715
7716 @item -mfp64
7717 @opindex mfp64
7718 Assume that floating point registers are 64 bits wide.
7719
7720 @item -mgp32
7721 @opindex mgp32
7722 Assume that general purpose registers are 32 bits wide.
7723
7724 @item -mgp64
7725 @opindex mgp64
7726 Assume that general purpose registers are 64 bits wide.
7727
7728 @item -mint64
7729 @opindex mint64
7730 Force int and long types to be 64 bits wide.  See @option{-mlong32} for an
7731 explanation of the default, and the width of pointers.
7732
7733 @item -mlong64
7734 @opindex mlong64
7735 Force long types to be 64 bits wide.  See @option{-mlong32} for an
7736 explanation of the default, and the width of pointers.
7737
7738 @item -mlong32
7739 @opindex mlong32
7740 Force long, int, and pointer types to be 32 bits wide.
7741
7742 The default size of ints, longs and pointers depends on the ABI@.  All
7743 the supported ABIs use 32-bit ints.  The n64 ABI uses 64-bit longs, as
7744 does the 64-bit Cygnus EABI; the others use 32-bit longs.  Pointers
7745 are the same size as longs, or the same size as integer registers,
7746 whichever is smaller.
7747
7748 @item -mabi=32
7749 @itemx -mabi=o64
7750 @itemx -mabi=n32
7751 @itemx -mabi=64
7752 @itemx -mabi=eabi
7753 @itemx -mabi=meabi
7754 @opindex mabi=32
7755 @opindex mabi=o64
7756 @opindex mabi=n32
7757 @opindex mabi=64
7758 @opindex mabi=eabi
7759 @opindex mabi=meabi
7760 Generate code for the given ABI@.
7761
7762 Note that there are two embedded ABIs: @option{-mabi=eabi}
7763 selects the one defined by Cygnus while @option{-meabi=meabi}
7764 selects the one defined by MIPS@.  Both these ABIs have
7765 32-bit and 64-bit variants.  Normally, GCC will generate
7766 64-bit code when you select a 64-bit architecture, but you
7767 can use @option{-mgp32} to get 32-bit code instead.
7768
7769 @item -mabi-fake-default
7770 @opindex mabi-fake-default
7771 You don't want to know what this option does.  No, really.  I mean
7772 it.  Move on to the next option.
7773
7774 What?  You're still here?  Oh, well@enddots{}  Ok, here's the deal.  GCC
7775 wants the default set of options to get the root of the multilib tree,
7776 and the shared library SONAMEs without any multilib-indicating
7777 suffixes.  This is not convenience for @samp{mips64-linux-gnu}, since
7778 we want to default to the N32 ABI, while still being binary-compatible
7779 with @samp{mips-linux-gnu} if you stick to the O32 ABI@.  Being
7780 binary-compatible means shared libraries should have the same SONAMEs,
7781 and libraries should live in the same location.  Having O32 libraries
7782 in a sub-directory named say @file{o32} is not acceptable.
7783
7784 So we trick GCC into believing that O32 is the default ABI, except
7785 that we override the default with some internal command-line
7786 processing magic.  Problem is, if we stopped at that, and you then
7787 created a multilib-aware package that used the output of @command{gcc
7788 -print-multi-lib} to decide which multilibs to build, and how, and
7789 you'd find yourself in an awkward situation when you found out that
7790 some of the options listed ended up mapping to the same multilib, and
7791 none of your libraries was actually built for the multilib that
7792 @option{-print-multi-lib} claims to be the default.  So we added this
7793 option that disables the default switcher, falling back to GCC's
7794 original notion of the default library.  Confused yet?
7795
7796 For short: don't ever use this option, unless you find it in the list
7797 of additional options to be used when building for multilibs, in the
7798 output of @option{gcc -print-multi-lib}.
7799
7800 @item -mmips-as
7801 @opindex mmips-as
7802 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
7803 add normal debug information.  This is the default for all
7804 platforms except for the OSF/1 reference platform, using the OSF/rose
7805 object format.  If the either of the @option{-gstabs} or @option{-gstabs+}
7806 switches are used, the @file{mips-tfile} program will encapsulate the
7807 stabs within MIPS ECOFF@.
7808
7809 @item -mgas
7810 @opindex mgas
7811 Generate code for the GNU assembler.  This is the default on the OSF/1
7812 reference platform, using the OSF/rose object format.  Also, this is
7813 the default if the configure option @option{--with-gnu-as} is used.
7814
7815 @item -msplit-addresses
7816 @itemx -mno-split-addresses
7817 @opindex msplit-addresses
7818 @opindex mno-split-addresses
7819 Generate code to load the high and low parts of address constants separately.
7820 This allows GCC to optimize away redundant loads of the high order
7821 bits of addresses.  This optimization requires GNU as and GNU ld.
7822 This optimization is enabled by default for some embedded targets where
7823 GNU as and GNU ld are standard.
7824
7825 @item -mrnames
7826 @itemx -mno-rnames
7827 @opindex mrnames
7828 @opindex mno-rnames
7829 The @option{-mrnames} switch says to output code using the MIPS software
7830 names for the registers, instead of the hardware names (ie, @var{a0}
7831 instead of @var{$4}).  The only known assembler that supports this option
7832 is the Algorithmics assembler.
7833
7834 @item -mgpopt
7835 @itemx -mno-gpopt
7836 @opindex mgpopt
7837 @opindex mno-gpopt
7838 The @option{-mgpopt} switch says to write all of the data declarations
7839 before the instructions in the text section, this allows the MIPS
7840 assembler to generate one word memory references instead of using two
7841 words for short global or static data items.  This is on by default if
7842 optimization is selected.
7843
7844 @item -mstats
7845 @itemx -mno-stats
7846 @opindex mstats
7847 @opindex mno-stats
7848 For each non-inline function processed, the @option{-mstats} switch
7849 causes the compiler to emit one line to the standard error file to
7850 print statistics about the program (number of registers saved, stack
7851 size, etc.).
7852
7853 @item -mmemcpy
7854 @itemx -mno-memcpy
7855 @opindex mmemcpy
7856 @opindex mno-memcpy
7857 The @option{-mmemcpy} switch makes all block moves call the appropriate
7858 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
7859 generating inline code.
7860
7861 @item -mmips-tfile
7862 @itemx -mno-mips-tfile
7863 @opindex mmips-tfile
7864 @opindex mno-mips-tfile
7865 The @option{-mno-mips-tfile} switch causes the compiler not
7866 postprocess the object file with the @file{mips-tfile} program,
7867 after the MIPS assembler has generated it to add debug support.  If
7868 @file{mips-tfile} is not run, then no local variables will be
7869 available to the debugger.  In addition, @file{stage2} and
7870 @file{stage3} objects will have the temporary file names passed to the
7871 assembler embedded in the object file, which means the objects will
7872 not compare the same.  The @option{-mno-mips-tfile} switch should only
7873 be used when there are bugs in the @file{mips-tfile} program that
7874 prevents compilation.
7875
7876 @item -msoft-float
7877 @opindex msoft-float
7878 Generate output containing library calls for floating point.
7879 @strong{Warning:} the requisite libraries are not part of GCC@.
7880 Normally the facilities of the machine's usual C compiler are used, but
7881 this can't be done directly in cross-compilation.  You must make your
7882 own arrangements to provide suitable library functions for
7883 cross-compilation.
7884
7885 @item -mhard-float
7886 @opindex mhard-float
7887 Generate output containing floating point instructions.  This is the
7888 default if you use the unmodified sources.
7889
7890 @item -mabicalls
7891 @itemx -mno-abicalls
7892 @opindex mabicalls
7893 @opindex mno-abicalls
7894 Emit (or do not emit) the pseudo operations @samp{.abicalls},
7895 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
7896 position independent code.
7897
7898 @item -mlong-calls
7899 @itemx -mno-long-calls
7900 @opindex mlong-calls
7901 @opindex mno-long-calls
7902 Do all calls with the @samp{JALR} instruction, which requires
7903 loading up a function's address into a register before the call.
7904 You need to use this switch, if you call outside of the current
7905 512 megabyte segment to functions that are not through pointers.
7906
7907 @item -mhalf-pic
7908 @itemx -mno-half-pic
7909 @opindex mhalf-pic
7910 @opindex mno-half-pic
7911 Put pointers to extern references into the data section and load them
7912 up, rather than put the references in the text section.
7913
7914 @item -membedded-pic
7915 @itemx -mno-embedded-pic
7916 @opindex membedded-pic
7917 @opindex mno-embedded-pic
7918 Generate PIC code suitable for some embedded systems.  All calls are
7919 made using PC relative address, and all data is addressed using the $gp
7920 register.  No more than 65536 bytes of global data may be used.  This
7921 requires GNU as and GNU ld which do most of the work.  This currently
7922 only works on targets which use ECOFF; it does not work with ELF@.
7923
7924 @item -membedded-data
7925 @itemx -mno-embedded-data
7926 @opindex membedded-data
7927 @opindex mno-embedded-data
7928 Allocate variables to the read-only data section first if possible, then
7929 next in the small data section if possible, otherwise in data.  This gives
7930 slightly slower code than the default, but reduces the amount of RAM required
7931 when executing, and thus may be preferred for some embedded systems.
7932
7933 @item -muninit-const-in-rodata
7934 @itemx -mno-uninit-const-in-rodata
7935 @opindex muninit-const-in-rodata
7936 @opindex mno-uninit-const-in-rodata
7937 When used together with @option{-membedded-data}, it will always store uninitialized
7938 const variables in the read-only data section.
7939
7940 @item -msingle-float
7941 @itemx -mdouble-float
7942 @opindex msingle-float
7943 @opindex mdouble-float
7944 The @option{-msingle-float} switch tells gcc to assume that the floating
7945 point coprocessor only supports single precision operations, as on the
7946 @samp{r4650} chip.  The @option{-mdouble-float} switch permits gcc to use
7947 double precision operations.  This is the default.
7948
7949 @item -mmad
7950 @itemx -mno-mad
7951 @opindex mmad
7952 @opindex mno-mad
7953 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
7954 as on the @samp{r4650} chip.
7955
7956 @item -m4650
7957 @opindex m4650
7958 Turns on @option{-msingle-float}, @option{-mmad}, and, at least for now,
7959 @option{-mcpu=r4650}.
7960
7961 @item -mips16
7962 @itemx -mno-mips16
7963 @opindex mips16
7964 @opindex mno-mips16
7965 Enable 16-bit instructions.
7966
7967 @item -mentry
7968 @opindex mentry
7969 Use the entry and exit pseudo ops.  This option can only be used with
7970 @option{-mips16}.
7971
7972 @item -EL
7973 @opindex EL
7974 Compile code for the processor in little endian mode.
7975 The requisite libraries are assumed to exist.
7976
7977 @item -EB
7978 @opindex EB
7979 Compile code for the processor in big endian mode.
7980 The requisite libraries are assumed to exist.
7981
7982 @item -G @var{num}
7983 @opindex G
7984 @cindex smaller data references (MIPS)
7985 @cindex gp-relative references (MIPS)
7986 Put global and static items less than or equal to @var{num} bytes into
7987 the small data or bss sections instead of the normal data or bss
7988 section.  This allows the assembler to emit one word memory reference
7989 instructions based on the global pointer (@var{gp} or @var{$28}),
7990 instead of the normal two words used.  By default, @var{num} is 8 when
7991 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
7992 @option{-G @var{num}} switch is also passed to the assembler and linker.
7993 All modules should be compiled with the same @option{-G @var{num}}
7994 value.
7995
7996 @item -nocpp
7997 @opindex nocpp
7998 Tell the MIPS assembler to not run its preprocessor over user
7999 assembler files (with a @samp{.s} suffix) when assembling them.
8000
8001 @item -mfix7000
8002 @opindex mfix7000
8003 Pass an option to gas which will cause nops to be inserted if
8004 the read of the destination register of an mfhi or mflo instruction
8005 occurs in the following two instructions.
8006
8007 @item -no-crt0
8008 @opindex no-crt0
8009 Do not include the default crt0.
8010
8011 @item -mflush-func=@var{func}
8012 @itemx -mno-flush-func
8013 @opindex mflush-func
8014 Specifies the function to call to flush the I and D caches, or to not
8015 call any such function.  If called, the function must take the same
8016 arguments as the common @code{_flush_func()}, that is, the address of the
8017 memory range for which the cache is being flushed, the size of the
8018 memory range, and the number 3 (to flush both caches).  The default
8019 depends on the target gcc was configured for, but commonly is either
8020 @samp{_flush_func} or @samp{__cpu_flush}.
8021
8022 @item -mbranch-likely
8023 @itemx -mno-branch-likely
8024 @opindex mbranch-likely
8025 @opindex mno-branch-likely
8026 Enable or disable use of Branch Likely instructions, regardless of the
8027 default for the selected architecture.  By default, Branch Likely
8028 instructions may be generated if they are supported by the selected
8029 architecture.  An exception is for the MIPS32 and MIPS64 architectures
8030 and processors which implement those architectures; for those, Branch
8031 Likely instructions will not be generated by default because the MIPS32
8032 and MIPS64 architectures specifically deprecate their use.
8033 @end table
8034
8035 @node i386 and x86-64 Options
8036 @subsection Intel 386 and AMD x86-64 Options
8037 @cindex i386 Options
8038 @cindex x86-64 Options
8039 @cindex Intel 386 Options
8040 @cindex AMD x86-64 Options
8041
8042 These @samp{-m} options are defined for the i386 and x86-64 family of
8043 computers:
8044
8045 @table @gcctabopt
8046 @item -mtune=@var{cpu-type}
8047 @opindex mtune
8048 Tune to @var{cpu-type} everything applicable about the generated code, except
8049 for the ABI and the set of available instructions.  The choices for
8050 @var{cpu-type} are @samp{i386}, @samp{i486}, @samp{i586}, @samp{i686},
8051 @samp{pentium}, @samp{pentium-mmx}, @samp{pentiumpro}, @samp{pentium2},
8052 @samp{pentium3}, @samp{pentium4}, @samp{k6}, @samp{k6-2}, @samp{k6-3},
8053 @samp{athlon}, @samp{athlon-tbird}, @samp{athlon-4}, @samp{athlon-xp},
8054 @samp{athlon-mp}, @samp{winchip-c6}, @samp{winchip2}, @samp{k8}, @samp{c3}
8055 and @samp{c3-2}.
8056
8057 While picking a specific @var{cpu-type} will schedule things appropriately
8058 for that particular chip, the compiler will not generate any code that
8059 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8060 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
8061 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
8062 AMD chips as opposed to the Intel ones.
8063
8064 @item -march=@var{cpu-type}
8065 @opindex march
8066 Generate instructions for the machine type @var{cpu-type}.  The choices
8067 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8068 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8069
8070 @item -mcpu=@var{cpu-type}
8071 @opindex mcpu
8072 A deprecated synonym for @option{-mtune}.
8073
8074 @item -m386
8075 @itemx -m486
8076 @itemx -mpentium
8077 @itemx -mpentiumpro
8078 @opindex m386
8079 @opindex m486
8080 @opindex mpentium
8081 @opindex mpentiumpro
8082 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8083 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8084 These synonyms are deprecated.
8085
8086 @item -mfpmath=@var{unit}
8087 @opindex march
8088 generate floating point arithmetics for selected unit @var{unit}.  the choices
8089 for @var{unit} are:
8090
8091 @table @samp
8092 @item 387
8093 Use the standard 387 floating point coprocessor present majority of chips and
8094 emulated otherwise.  Code compiled with this option will run almost everywhere.
8095 The temporary results are computed in 80bit precision instead of precision
8096 specified by the type resulting in slightly different results compared to most
8097 of other chips. See @option{-ffloat-store} for more detailed description.
8098
8099 This is the default choice for i386 compiler.
8100
8101 @item sse
8102 Use scalar floating point instructions present in the SSE instruction set.
8103 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8104 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8105 instruction set supports only single precision arithmetics, thus the double and
8106 extended precision arithmetics is still done using 387.  Later version, present
8107 only in Pentium4 and the future AMD x86-64 chips supports double precision
8108 arithmetics too.
8109
8110 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8111 @option{-msse2} switches to enable SSE extensions and make this option
8112 effective.  For x86-64 compiler, these extensions are enabled by default.
8113
8114 The resulting code should be considerably faster in majority of cases and avoid
8115 the numerical instability problems of 387 code, but may break some existing
8116 code that expects temporaries to be 80bit.
8117
8118 This is the default choice for x86-64 compiler.
8119
8120 @item sse,387
8121 Attempt to utilize both instruction sets at once.  This effectively double the
8122 amount of available registers and on chips with separate execution units for
8123 387 and SSE the execution resources too.  Use this option with care, as it is
8124 still experimental, because gcc register allocator does not model separate
8125 functional units well resulting in instable performance.
8126 @end table
8127
8128 @item -masm=@var{dialect}
8129 @opindex masm=@var{dialect}
8130 Output asm instructions using selected @var{dialect}. Supported choices are
8131 @samp{intel} or @samp{att} (the default one).
8132
8133 @item -mieee-fp
8134 @itemx -mno-ieee-fp
8135 @opindex mieee-fp
8136 @opindex mno-ieee-fp
8137 Control whether or not the compiler uses IEEE floating point
8138 comparisons.  These handle correctly the case where the result of a
8139 comparison is unordered.
8140
8141 @item -msoft-float
8142 @opindex msoft-float
8143 Generate output containing library calls for floating point.
8144 @strong{Warning:} the requisite libraries are not part of GCC@.
8145 Normally the facilities of the machine's usual C compiler are used, but
8146 this can't be done directly in cross-compilation.  You must make your
8147 own arrangements to provide suitable library functions for
8148 cross-compilation.
8149
8150 On machines where a function returns floating point results in the 80387
8151 register stack, some floating point opcodes may be emitted even if
8152 @option{-msoft-float} is used.
8153
8154 @item -mno-fp-ret-in-387
8155 @opindex mno-fp-ret-in-387
8156 Do not use the FPU registers for return values of functions.
8157
8158 The usual calling convention has functions return values of types
8159 @code{float} and @code{double} in an FPU register, even if there
8160 is no FPU@.  The idea is that the operating system should emulate
8161 an FPU@.
8162
8163 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8164 in ordinary CPU registers instead.
8165
8166 @item -mno-fancy-math-387
8167 @opindex mno-fancy-math-387
8168 Some 387 emulators do not support the @code{sin}, @code{cos} and
8169 @code{sqrt} instructions for the 387.  Specify this option to avoid
8170 generating those instructions.  This option is the default on FreeBSD,
8171 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8172 indicates that the target cpu will always have an FPU and so the
8173 instruction will not need emulation.  As of revision 2.6.1, these
8174 instructions are not generated unless you also use the
8175 @option{-funsafe-math-optimizations} switch.
8176
8177 @item -malign-double
8178 @itemx -mno-align-double
8179 @opindex malign-double
8180 @opindex mno-align-double
8181 Control whether GCC aligns @code{double}, @code{long double}, and
8182 @code{long long} variables on a two word boundary or a one word
8183 boundary.  Aligning @code{double} variables on a two word boundary will
8184 produce code that runs somewhat faster on a @samp{Pentium} at the
8185 expense of more memory.
8186
8187 @strong{Warning:} if you use the @option{-malign-double} switch,
8188 structures containing the above types will be aligned differently than
8189 the published application binary interface specifications for the 386
8190 and will not be binary compatible with structures in code compiled
8191 without that switch.
8192
8193 @item -m128bit-long-double
8194 @opindex m128bit-long-double
8195 Control the size of @code{long double} type. i386 application binary interface
8196 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
8197 prefer @code{long double} aligned to 8 or 16 byte boundary.  This is
8198 impossible to reach with 12 byte long doubles in the array accesses.
8199
8200 @strong{Warning:} if you use the @option{-m128bit-long-double} switch, the
8201 structures and arrays containing @code{long double} will change their size as
8202 well as function calling convention for function taking @code{long double}
8203 will be modified.
8204
8205 @item -m96bit-long-double
8206 @opindex m96bit-long-double
8207 Set the size of @code{long double} to 96 bits as required by the i386
8208 application binary interface.  This is the default.
8209
8210 @item -msvr3-shlib
8211 @itemx -mno-svr3-shlib
8212 @opindex msvr3-shlib
8213 @opindex mno-svr3-shlib
8214 Control whether GCC places uninitialized local variables into the
8215 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8216 into @code{bss}.  These options are meaningful only on System V Release 3.
8217
8218 @item -mrtd
8219 @opindex mrtd
8220 Use a different function-calling convention, in which functions that
8221 take a fixed number of arguments return with the @code{ret} @var{num}
8222 instruction, which pops their arguments while returning.  This saves one
8223 instruction in the caller since there is no need to pop the arguments
8224 there.
8225
8226 You can specify that an individual function is called with this calling
8227 sequence with the function attribute @samp{stdcall}.  You can also
8228 override the @option{-mrtd} option by using the function attribute
8229 @samp{cdecl}.  @xref{Function Attributes}.
8230
8231 @strong{Warning:} this calling convention is incompatible with the one
8232 normally used on Unix, so you cannot use it if you need to call
8233 libraries compiled with the Unix compiler.
8234
8235 Also, you must provide function prototypes for all functions that
8236 take variable numbers of arguments (including @code{printf});
8237 otherwise incorrect code will be generated for calls to those
8238 functions.
8239
8240 In addition, seriously incorrect code will result if you call a
8241 function with too many arguments.  (Normally, extra arguments are
8242 harmlessly ignored.)
8243
8244 @item -mregparm=@var{num}
8245 @opindex mregparm
8246 Control how many registers are used to pass integer arguments.  By
8247 default, no registers are used to pass arguments, and at most 3
8248 registers can be used.  You can control this behavior for a specific
8249 function by using the function attribute @samp{regparm}.
8250 @xref{Function Attributes}.
8251
8252 @strong{Warning:} if you use this switch, and
8253 @var{num} is nonzero, then you must build all modules with the same
8254 value, including any libraries.  This includes the system libraries and
8255 startup modules.
8256
8257 @item -mpreferred-stack-boundary=@var{num}
8258 @opindex mpreferred-stack-boundary
8259 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8260 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8261 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8262 size (@option{-Os}), in which case the default is the minimum correct
8263 alignment (4 bytes for x86, and 8 bytes for x86-64).
8264
8265 On Pentium and PentiumPro, @code{double} and @code{long double} values
8266 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8267 suffer significant run time performance penalties.  On Pentium III, the
8268 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8269 penalties if it is not 16 byte aligned.
8270
8271 To ensure proper alignment of this values on the stack, the stack boundary
8272 must be as aligned as that required by any value stored on the stack.
8273 Further, every function must be generated such that it keeps the stack
8274 aligned.  Thus calling a function compiled with a higher preferred
8275 stack boundary from a function compiled with a lower preferred stack
8276 boundary will most likely misalign the stack.  It is recommended that
8277 libraries that use callbacks always use the default setting.
8278
8279 This extra alignment does consume extra stack space, and generally
8280 increases code size.  Code that is sensitive to stack space usage, such
8281 as embedded systems and operating system kernels, may want to reduce the
8282 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8283
8284 @item -mmmx
8285 @itemx -mno-mmx
8286 @item -msse
8287 @itemx -mno-sse
8288 @item -msse2
8289 @itemx -mno-sse2
8290 @item -m3dnow
8291 @itemx -mno-3dnow
8292 @opindex mmmx
8293 @opindex mno-mmx
8294 @opindex msse
8295 @opindex mno-sse
8296 @opindex m3dnow
8297 @opindex mno-3dnow
8298 These switches enable or disable the use of built-in functions that allow
8299 direct access to the MMX, SSE and 3Dnow extensions of the instruction set.
8300
8301 @xref{X86 Built-in Functions}, for details of the functions enabled
8302 and disabled by these switches.
8303
8304 To have SSE/SSE2 instructions generated automatically from floating-point
8305 code, see @option{-mfpmath=sse}.
8306
8307 @item -mpush-args
8308 @itemx -mno-push-args
8309 @opindex mpush-args
8310 @opindex mno-push-args
8311 Use PUSH operations to store outgoing parameters.  This method is shorter
8312 and usually equally fast as method using SUB/MOV operations and is enabled
8313 by default.  In some cases disabling it may improve performance because of
8314 improved scheduling and reduced dependencies.
8315
8316 @item -maccumulate-outgoing-args
8317 @opindex maccumulate-outgoing-args
8318 If enabled, the maximum amount of space required for outgoing arguments will be
8319 computed in the function prologue.  This is faster on most modern CPUs
8320 because of reduced dependencies, improved scheduling and reduced stack usage
8321 when preferred stack boundary is not equal to 2.  The drawback is a notable
8322 increase in code size.  This switch implies @option{-mno-push-args}.
8323
8324 @item -mthreads
8325 @opindex mthreads
8326 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8327 on thread-safe exception handling must compile and link all code with the
8328 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8329 @option{-D_MT}; when linking, it links in a special thread helper library
8330 @option{-lmingwthrd} which cleans up per thread exception handling data.
8331
8332 @item -mno-align-stringops
8333 @opindex mno-align-stringops
8334 Do not align destination of inlined string operations.  This switch reduces
8335 code size and improves performance in case the destination is already aligned,
8336 but gcc don't know about it.
8337
8338 @item -minline-all-stringops
8339 @opindex minline-all-stringops
8340 By default GCC inlines string operations only when destination is known to be
8341 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8342 size, but may improve performance of code that depends on fast memcpy, strlen
8343 and memset for short lengths.
8344
8345 @item -momit-leaf-frame-pointer
8346 @opindex momit-leaf-frame-pointer
8347 Don't keep the frame pointer in a register for leaf functions.  This
8348 avoids the instructions to save, set up and restore frame pointers and
8349 makes an extra register available in leaf functions.  The option
8350 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8351 which might make debugging harder.
8352 @end table
8353
8354 These @samp{-m} switches are supported in addition to the above
8355 on AMD x86-64 processors in 64-bit environments.
8356
8357 @table @gcctabopt
8358 @item -m32
8359 @itemx -m64
8360 @opindex m32
8361 @opindex m64
8362 Generate code for a 32-bit or 64-bit environment.
8363 The 32-bit environment sets int, long and pointer to 32 bits and
8364 generates code that runs on any i386 system.
8365 The 64-bit environment sets int to 32 bits and long and pointer
8366 to 64 bits and generates code for AMD's x86-64 architecture.
8367
8368 @item -mno-red-zone
8369 @opindex no-red-zone
8370 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8371 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8372 stack pointer that will not be modified by signal or interrupt handlers
8373 and therefore can be used for temporary data without adjusting the stack
8374 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8375
8376 @item -mcmodel=small
8377 @opindex mcmodel=small
8378 Generate code for the small code model: the program and its symbols must
8379 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8380 Programs can be statically or dynamically linked.  This is the default
8381 code model.
8382
8383 @item -mcmodel=kernel
8384 @opindex mcmodel=kernel
8385 Generate code for the kernel code model.  The kernel runs in the
8386 negative 2 GB of the address space.
8387 This model has to be used for Linux kernel code.
8388
8389 @item -mcmodel=medium
8390 @opindex mcmodel=medium
8391 Generate code for the medium model: The program is linked in the lower 2
8392 GB of the address space but symbols can be located anywhere in the
8393 address space.  Programs can be statically or dynamically linked, but
8394 building of shared libraries are not supported with the medium model.
8395
8396 @item -mcmodel=large
8397 @opindex mcmodel=large
8398 Generate code for the large model: This model makes no assumptions
8399 about addresses and sizes of sections.  Currently GCC does not implement
8400 this model.
8401 @end table
8402
8403 @node HPPA Options
8404 @subsection HPPA Options
8405 @cindex HPPA Options
8406
8407 These @samp{-m} options are defined for the HPPA family of computers:
8408
8409 @table @gcctabopt
8410 @item -march=@var{architecture-type}
8411 @opindex march
8412 Generate code for the specified architecture.  The choices for
8413 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8414 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8415 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8416 architecture option for your machine.  Code compiled for lower numbered
8417 architectures will run on higher numbered architectures, but not the
8418 other way around.
8419
8420 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
8421 next release of binutils (current is 2.9.1) will probably contain PA 2.0
8422 support.
8423
8424 @item -mpa-risc-1-0
8425 @itemx -mpa-risc-1-1
8426 @itemx -mpa-risc-2-0
8427 @opindex mpa-risc-1-0
8428 @opindex mpa-risc-1-1
8429 @opindex mpa-risc-2-0
8430 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8431
8432 @item -mbig-switch
8433 @opindex mbig-switch
8434 Generate code suitable for big switch tables.  Use this option only if
8435 the assembler/linker complain about out of range branches within a switch
8436 table.
8437
8438 @item -mjump-in-delay
8439 @opindex mjump-in-delay
8440 Fill delay slots of function calls with unconditional jump instructions
8441 by modifying the return pointer for the function call to be the target
8442 of the conditional jump.
8443
8444 @item -mdisable-fpregs
8445 @opindex mdisable-fpregs
8446 Prevent floating point registers from being used in any manner.  This is
8447 necessary for compiling kernels which perform lazy context switching of
8448 floating point registers.  If you use this option and attempt to perform
8449 floating point operations, the compiler will abort.
8450
8451 @item -mdisable-indexing
8452 @opindex mdisable-indexing
8453 Prevent the compiler from using indexing address modes.  This avoids some
8454 rather obscure problems when compiling MIG generated code under MACH@.
8455
8456 @item -mno-space-regs
8457 @opindex mno-space-regs
8458 Generate code that assumes the target has no space registers.  This allows
8459 GCC to generate faster indirect calls and use unscaled index address modes.
8460
8461 Such code is suitable for level 0 PA systems and kernels.
8462
8463 @item -mfast-indirect-calls
8464 @opindex mfast-indirect-calls
8465 Generate code that assumes calls never cross space boundaries.  This
8466 allows GCC to emit code which performs faster indirect calls.
8467
8468 This option will not work in the presence of shared libraries or nested
8469 functions.
8470
8471 @item -mlong-load-store
8472 @opindex mlong-load-store
8473 Generate 3-instruction load and store sequences as sometimes required by
8474 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8475 the HP compilers.
8476
8477 @item -mportable-runtime
8478 @opindex mportable-runtime
8479 Use the portable calling conventions proposed by HP for ELF systems.
8480
8481 @item -mgas
8482 @opindex mgas
8483 Enable the use of assembler directives only GAS understands.
8484
8485 @item -mschedule=@var{cpu-type}
8486 @opindex mschedule
8487 Schedule code according to the constraints for the machine type
8488 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8489 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8490 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8491 proper scheduling option for your machine.  The default scheduling is
8492 @samp{8000}.
8493
8494 @item -mlinker-opt
8495 @opindex mlinker-opt
8496 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8497 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8498 linkers in which they give bogus error messages when linking some programs.
8499
8500 @item -msoft-float
8501 @opindex msoft-float
8502 Generate output containing library calls for floating point.
8503 @strong{Warning:} the requisite libraries are not available for all HPPA
8504 targets.  Normally the facilities of the machine's usual C compiler are
8505 used, but this cannot be done directly in cross-compilation.  You must make
8506 your own arrangements to provide suitable library functions for
8507 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8508 does provide software floating point support.
8509
8510 @option{-msoft-float} changes the calling convention in the output file;
8511 therefore, it is only useful if you compile @emph{all} of a program with
8512 this option.  In particular, you need to compile @file{libgcc.a}, the
8513 library that comes with GCC, with @option{-msoft-float} in order for
8514 this to work.
8515
8516 @item -msio
8517 @opindex msio
8518 Generate the predefine, @code{_SIO}, for server IO.  The default is
8519 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8520 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8521 options are available under HP-UX and HI-UX.
8522
8523 @item -mgnu-ld
8524 @opindex gnu-ld
8525 Use GNU ld specific options.  This passes @option{-shared} to ld when
8526 building a shared library.  It is the default when GCC is configured,
8527 explicitly or implicitly, with the GNU linker.  This option does not
8528 have any affect on which ld is called, it only changes what parameters
8529 are passed to that ld.  The ld that is called is determined by the
8530 @option{--with-ld} configure option, gcc's program search path, and
8531 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8532 using @samp{which `gcc -print-prog-name=ld`}.
8533
8534 @item -mhp-ld
8535 @opindex hp-ld
8536 Use HP ld specific options.  This passes @option{-b} to ld when building
8537 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8538 links.  It is the default when GCC is configured, explicitly or
8539 implicitly, with the HP linker.  This option does not have any affect on
8540 which ld is called, it only changes what parameters are passed to that
8541 ld.  The ld that is called is determined by the @option{--with-ld}
8542 configure option, gcc's program search path, and finally by the user's
8543 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8544 `gcc -print-prog-name=ld`}.
8545
8546 @item -mlong-calls
8547 @opindex mno-long-calls
8548 Generate code that uses long call sequences.  This ensures that a call
8549 is always able to reach linker generated stubs.  The default is to generate
8550 long calls only when the distance from the call site to the beginning
8551 of the function or translation unit, as the case may be, exceeds a
8552 predefined limit set by the branch type being used.  The limits for
8553 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8554 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8555 240,000 bytes.
8556
8557 Distances are measured from the beginning of functions when using the
8558 @option{-ffunction-sections} option, or when using the @option{-mgas}
8559 and @option{-mno-portable-runtime} options together under HP-UX with
8560 the SOM linker.
8561
8562 It is normally not desirable to use this option as it will degrade
8563 performance.  However, it may be useful in large applications,
8564 particularly when partial linking is used to build the application.
8565
8566 The types of long calls used depends on the capabilities of the
8567 assembler and linker, and the type of code being generated.  The
8568 impact on systems that support long absolute calls, and long pic
8569 symbol-difference or pc-relative calls should be relatively small.
8570 However, an indirect call is used on 32-bit ELF systems in pic code
8571 and it is quite long.
8572
8573 @end table
8574
8575 @node Intel 960 Options
8576 @subsection Intel 960 Options
8577
8578 These @samp{-m} options are defined for the Intel 960 implementations:
8579
8580 @table @gcctabopt
8581 @item -m@var{cpu-type}
8582 @opindex mka
8583 @opindex mkb
8584 @opindex mmc
8585 @opindex mca
8586 @opindex mcf
8587 @opindex msa
8588 @opindex msb
8589 Assume the defaults for the machine type @var{cpu-type} for some of
8590 the other options, including instruction scheduling, floating point
8591 support, and addressing modes.  The choices for @var{cpu-type} are
8592 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
8593 @samp{sa}, and @samp{sb}.
8594 The default is
8595 @samp{kb}.
8596
8597 @item -mnumerics
8598 @itemx -msoft-float
8599 @opindex mnumerics
8600 @opindex msoft-float
8601 The @option{-mnumerics} option indicates that the processor does support
8602 floating-point instructions.  The @option{-msoft-float} option indicates
8603 that floating-point support should not be assumed.
8604
8605 @item -mleaf-procedures
8606 @itemx -mno-leaf-procedures
8607 @opindex mleaf-procedures
8608 @opindex mno-leaf-procedures
8609 Do (or do not) attempt to alter leaf procedures to be callable with the
8610 @code{bal} instruction as well as @code{call}.  This will result in more
8611 efficient code for explicit calls when the @code{bal} instruction can be
8612 substituted by the assembler or linker, but less efficient code in other
8613 cases, such as calls via function pointers, or using a linker that doesn't
8614 support this optimization.
8615
8616 @item -mtail-call
8617 @itemx -mno-tail-call
8618 @opindex mtail-call
8619 @opindex mno-tail-call
8620 Do (or do not) make additional attempts (beyond those of the
8621 machine-independent portions of the compiler) to optimize tail-recursive
8622 calls into branches.  You may not want to do this because the detection of
8623 cases where this is not valid is not totally complete.  The default is
8624 @option{-mno-tail-call}.
8625
8626 @item -mcomplex-addr
8627 @itemx -mno-complex-addr
8628 @opindex mcomplex-addr
8629 @opindex mno-complex-addr
8630 Assume (or do not assume) that the use of a complex addressing mode is a
8631 win on this implementation of the i960.  Complex addressing modes may not
8632 be worthwhile on the K-series, but they definitely are on the C-series.
8633 The default is currently @option{-mcomplex-addr} for all processors except
8634 the CB and CC@.
8635
8636 @item -mcode-align
8637 @itemx -mno-code-align
8638 @opindex mcode-align
8639 @opindex mno-code-align
8640 Align code to 8-byte boundaries for faster fetching (or don't bother).
8641 Currently turned on by default for C-series implementations only.
8642
8643 @ignore
8644 @item -mclean-linkage
8645 @itemx -mno-clean-linkage
8646 @opindex mclean-linkage
8647 @opindex mno-clean-linkage
8648 These options are not fully implemented.
8649 @end ignore
8650
8651 @item -mic-compat
8652 @itemx -mic2.0-compat
8653 @itemx -mic3.0-compat
8654 @opindex mic-compat
8655 @opindex mic2.0-compat
8656 @opindex mic3.0-compat
8657 Enable compatibility with iC960 v2.0 or v3.0.
8658
8659 @item -masm-compat
8660 @itemx -mintel-asm
8661 @opindex masm-compat
8662 @opindex mintel-asm
8663 Enable compatibility with the iC960 assembler.
8664
8665 @item -mstrict-align
8666 @itemx -mno-strict-align
8667 @opindex mstrict-align
8668 @opindex mno-strict-align
8669 Do not permit (do permit) unaligned accesses.
8670
8671 @item -mold-align
8672 @opindex mold-align
8673 Enable structure-alignment compatibility with Intel's gcc release version
8674 1.3 (based on gcc 1.37).  This option implies @option{-mstrict-align}.
8675
8676 @item -mlong-double-64
8677 @opindex mlong-double-64
8678 Implement type @samp{long double} as 64-bit floating point numbers.
8679 Without the option @samp{long double} is implemented by 80-bit
8680 floating point numbers.  The only reason we have it because there is
8681 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
8682 is only useful for people using soft-float targets.  Otherwise, we
8683 should recommend against use of it.
8684
8685 @end table
8686
8687 @node DEC Alpha Options
8688 @subsection DEC Alpha Options
8689
8690 These @samp{-m} options are defined for the DEC Alpha implementations:
8691
8692 @table @gcctabopt
8693 @item -mno-soft-float
8694 @itemx -msoft-float
8695 @opindex mno-soft-float
8696 @opindex msoft-float
8697 Use (do not use) the hardware floating-point instructions for
8698 floating-point operations.  When @option{-msoft-float} is specified,
8699 functions in @file{libgcc.a} will be used to perform floating-point
8700 operations.  Unless they are replaced by routines that emulate the
8701 floating-point operations, or compiled in such a way as to call such
8702 emulations routines, these routines will issue floating-point
8703 operations.   If you are compiling for an Alpha without floating-point
8704 operations, you must ensure that the library is built so as not to call
8705 them.
8706
8707 Note that Alpha implementations without floating-point operations are
8708 required to have floating-point registers.
8709
8710 @item -mfp-reg
8711 @itemx -mno-fp-regs
8712 @opindex mfp-reg
8713 @opindex mno-fp-regs
8714 Generate code that uses (does not use) the floating-point register set.
8715 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8716 register set is not used, floating point operands are passed in integer
8717 registers as if they were integers and floating-point results are passed
8718 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8719 so any function with a floating-point argument or return value called by code
8720 compiled with @option{-mno-fp-regs} must also be compiled with that
8721 option.
8722
8723 A typical use of this option is building a kernel that does not use,
8724 and hence need not save and restore, any floating-point registers.
8725
8726 @item -mieee
8727 @opindex mieee
8728 The Alpha architecture implements floating-point hardware optimized for
8729 maximum performance.  It is mostly compliant with the IEEE floating
8730 point standard.  However, for full compliance, software assistance is
8731 required.  This option generates code fully IEEE compliant code
8732 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8733 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8734 defined during compilation.  The resulting code is less efficient but is
8735 able to correctly support denormalized numbers and exceptional IEEE
8736 values such as not-a-number and plus/minus infinity.  Other Alpha
8737 compilers call this option @option{-ieee_with_no_inexact}.
8738
8739 @item -mieee-with-inexact
8740 @opindex mieee-with-inexact
8741 This is like @option{-mieee} except the generated code also maintains
8742 the IEEE @var{inexact-flag}.  Turning on this option causes the
8743 generated code to implement fully-compliant IEEE math.  In addition to
8744 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8745 macro.  On some Alpha implementations the resulting code may execute
8746 significantly slower than the code generated by default.  Since there is
8747 very little code that depends on the @var{inexact-flag}, you should
8748 normally not specify this option.  Other Alpha compilers call this
8749 option @option{-ieee_with_inexact}.
8750
8751 @item -mfp-trap-mode=@var{trap-mode}
8752 @opindex mfp-trap-mode
8753 This option controls what floating-point related traps are enabled.
8754 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8755 The trap mode can be set to one of four values:
8756
8757 @table @samp
8758 @item n
8759 This is the default (normal) setting.  The only traps that are enabled
8760 are the ones that cannot be disabled in software (e.g., division by zero
8761 trap).
8762
8763 @item u
8764 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8765 as well.
8766
8767 @item su
8768 Like @samp{su}, but the instructions are marked to be safe for software
8769 completion (see Alpha architecture manual for details).
8770
8771 @item sui
8772 Like @samp{su}, but inexact traps are enabled as well.
8773 @end table
8774
8775 @item -mfp-rounding-mode=@var{rounding-mode}
8776 @opindex mfp-rounding-mode
8777 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8778 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8779 of:
8780
8781 @table @samp
8782 @item n
8783 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8784 the nearest machine number or towards the even machine number in case
8785 of a tie.
8786
8787 @item m
8788 Round towards minus infinity.
8789
8790 @item c
8791 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8792
8793 @item d
8794 Dynamic rounding mode.  A field in the floating point control register
8795 (@var{fpcr}, see Alpha architecture reference manual) controls the
8796 rounding mode in effect.  The C library initializes this register for
8797 rounding towards plus infinity.  Thus, unless your program modifies the
8798 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8799 @end table
8800
8801 @item -mtrap-precision=@var{trap-precision}
8802 @opindex mtrap-precision
8803 In the Alpha architecture, floating point traps are imprecise.  This
8804 means without software assistance it is impossible to recover from a
8805 floating trap and program execution normally needs to be terminated.
8806 GCC can generate code that can assist operating system trap handlers
8807 in determining the exact location that caused a floating point trap.
8808 Depending on the requirements of an application, different levels of
8809 precisions can be selected:
8810
8811 @table @samp
8812 @item p
8813 Program precision.  This option is the default and means a trap handler
8814 can only identify which program caused a floating point exception.
8815
8816 @item f
8817 Function precision.  The trap handler can determine the function that
8818 caused a floating point exception.
8819
8820 @item i
8821 Instruction precision.  The trap handler can determine the exact
8822 instruction that caused a floating point exception.
8823 @end table
8824
8825 Other Alpha compilers provide the equivalent options called
8826 @option{-scope_safe} and @option{-resumption_safe}.
8827
8828 @item -mieee-conformant
8829 @opindex mieee-conformant
8830 This option marks the generated code as IEEE conformant.  You must not
8831 use this option unless you also specify @option{-mtrap-precision=i} and either
8832 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8833 is to emit the line @samp{.eflag 48} in the function prologue of the
8834 generated assembly file.  Under DEC Unix, this has the effect that
8835 IEEE-conformant math library routines will be linked in.
8836
8837 @item -mbuild-constants
8838 @opindex mbuild-constants
8839 Normally GCC examines a 32- or 64-bit integer constant to
8840 see if it can construct it from smaller constants in two or three
8841 instructions.  If it cannot, it will output the constant as a literal and
8842 generate code to load it from the data segment at runtime.
8843
8844 Use this option to require GCC to construct @emph{all} integer constants
8845 using code, even if it takes more instructions (the maximum is six).
8846
8847 You would typically use this option to build a shared library dynamic
8848 loader.  Itself a shared library, it must relocate itself in memory
8849 before it can find the variables and constants in its own data segment.
8850
8851 @item -malpha-as
8852 @itemx -mgas
8853 @opindex malpha-as
8854 @opindex mgas
8855 Select whether to generate code to be assembled by the vendor-supplied
8856 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8857
8858 @item -mbwx
8859 @itemx -mno-bwx
8860 @itemx -mcix
8861 @itemx -mno-cix
8862 @itemx -mfix
8863 @itemx -mno-fix
8864 @itemx -mmax
8865 @itemx -mno-max
8866 @opindex mbwx
8867 @opindex mno-bwx
8868 @opindex mcix
8869 @opindex mno-cix
8870 @opindex mfix
8871 @opindex mno-fix
8872 @opindex mmax
8873 @opindex mno-max
8874 Indicate whether GCC should generate code to use the optional BWX,
8875 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8876 sets supported by the CPU type specified via @option{-mcpu=} option or that
8877 of the CPU on which GCC was built if none was specified.
8878
8879 @item -mfloat-vax
8880 @itemx -mfloat-ieee
8881 @opindex mfloat-vax
8882 @opindex mfloat-ieee
8883 Generate code that uses (does not use) VAX F and G floating point
8884 arithmetic instead of IEEE single and double precision.
8885
8886 @item -mexplicit-relocs
8887 @itemx -mno-explicit-relocs
8888 @opindex mexplicit-relocs
8889 @opindex mno-explicit-relocs
8890 Older Alpha assemblers provided no way to generate symbol relocations
8891 except via assembler macros.  Use of these macros does not allow
8892 optimal instruction scheduling.  GNU binutils as of version 2.12
8893 supports a new syntax that allows the compiler to explicitly mark
8894 which relocations should apply to which instructions.  This option
8895 is mostly useful for debugging, as GCC detects the capabilities of
8896 the assembler when it is built and sets the default accordingly.
8897
8898 @item -msmall-data
8899 @itemx -mlarge-data
8900 @opindex msmall-data
8901 @opindex mlarge-data
8902 When @option{-mexplicit-relocs} is in effect, static data is
8903 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8904 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8905 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8906 16-bit relocations off of the @code{$gp} register.  This limits the
8907 size of the small data area to 64KB, but allows the variables to be
8908 directly accessed via a single instruction.
8909
8910 The default is @option{-mlarge-data}.  With this option the data area
8911 is limited to just below 2GB.  Programs that require more than 2GB of
8912 data must use @code{malloc} or @code{mmap} to allocate the data in the
8913 heap instead of in the program's data segment.
8914
8915 When generating code for shared libraries, @option{-fpic} implies
8916 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8917
8918 @item -msmall-text
8919 @itemx -mlarge-text
8920 @opindex msmall-text
8921 @opindex mlarge-text
8922 When @option{-msmall-text} is used, the compiler assumes that the
8923 code of the entire program (or shared library) fits in 4MB, and is
8924 thus reachable with a branch instruction.  When @option{-msmall-data}
8925 is used, the compiler can assume that all local symbols share the
8926 same @code{$gp} value, and thus reduce the number of instructions
8927 required for a function call from 4 to 1.
8928
8929 The default is @option{-mlarge-text}.
8930
8931 @item -mcpu=@var{cpu_type}
8932 @opindex mcpu
8933 Set the instruction set and instruction scheduling parameters for
8934 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8935 style name or the corresponding chip number.  GCC supports scheduling
8936 parameters for the EV4, EV5 and EV6 family of processors and will
8937 choose the default values for the instruction set from the processor
8938 you specify.  If you do not specify a processor type, GCC will default
8939 to the processor on which the compiler was built.
8940
8941 Supported values for @var{cpu_type} are
8942
8943 @table @samp
8944 @item ev4
8945 @item ev45
8946 @itemx 21064
8947 Schedules as an EV4 and has no instruction set extensions.
8948
8949 @item ev5
8950 @itemx 21164
8951 Schedules as an EV5 and has no instruction set extensions.
8952
8953 @item ev56
8954 @itemx 21164a
8955 Schedules as an EV5 and supports the BWX extension.
8956
8957 @item pca56
8958 @itemx 21164pc
8959 @itemx 21164PC
8960 Schedules as an EV5 and supports the BWX and MAX extensions.
8961
8962 @item ev6
8963 @itemx 21264
8964 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8965
8966 @item ev67
8967 @item 21264a
8968 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8969 @end table
8970
8971 @item -mtune=@var{cpu_type}
8972 @opindex mtune
8973 Set only the instruction scheduling parameters for machine type
8974 @var{cpu_type}.  The instruction set is not changed.
8975
8976 @item -mmemory-latency=@var{time}
8977 @opindex mmemory-latency
8978 Sets the latency the scheduler should assume for typical memory
8979 references as seen by the application.  This number is highly
8980 dependent on the memory access patterns used by the application
8981 and the size of the external cache on the machine.
8982
8983 Valid options for @var{time} are
8984
8985 @table @samp
8986 @item @var{number}
8987 A decimal number representing clock cycles.
8988
8989 @item L1
8990 @itemx L2
8991 @itemx L3
8992 @itemx main
8993 The compiler contains estimates of the number of clock cycles for
8994 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8995 (also called Dcache, Scache, and Bcache), as well as to main memory.
8996 Note that L3 is only valid for EV5.
8997
8998 @end table
8999 @end table
9000
9001 @node DEC Alpha/VMS Options
9002 @subsection DEC Alpha/VMS Options
9003
9004 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
9005
9006 @table @gcctabopt
9007 @item -mvms-return-codes
9008 @opindex mvms-return-codes
9009 Return VMS condition codes from main.  The default is to return POSIX
9010 style condition (e.g.@ error) codes.
9011 @end table
9012
9013 @node H8/300 Options
9014 @subsection H8/300 Options
9015
9016 These @samp{-m} options are defined for the H8/300 implementations:
9017
9018 @table @gcctabopt
9019 @item -mrelax
9020 @opindex mrelax
9021 Shorten some address references at link time, when possible; uses the
9022 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
9023 ld.info, Using ld}, for a fuller description.
9024
9025 @item -mh
9026 @opindex mh
9027 Generate code for the H8/300H@.
9028
9029 @item -ms
9030 @opindex ms
9031 Generate code for the H8S@.
9032
9033 @item -mn
9034 @opindex mn
9035 Generate code for the H8S and H8/300H in the normal mode.  This switch
9036 must be used either with -mh or -ms.
9037
9038 @item -ms2600
9039 @opindex ms2600
9040 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
9041
9042 @item -mint32
9043 @opindex mint32
9044 Make @code{int} data 32 bits by default.
9045
9046 @item -malign-300
9047 @opindex malign-300
9048 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9049 The default for the H8/300H and H8S is to align longs and floats on 4
9050 byte boundaries.
9051 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9052 This option has no effect on the H8/300.
9053 @end table
9054
9055 @node SH Options
9056 @subsection SH Options
9057
9058 These @samp{-m} options are defined for the SH implementations:
9059
9060 @table @gcctabopt
9061 @item -m1
9062 @opindex m1
9063 Generate code for the SH1.
9064
9065 @item -m2
9066 @opindex m2
9067 Generate code for the SH2.
9068
9069 @item -m2e
9070 Generate code for the SH2e.
9071
9072 @item -m3
9073 @opindex m3
9074 Generate code for the SH3.
9075
9076 @item -m3e
9077 @opindex m3e
9078 Generate code for the SH3e.
9079
9080 @item -m4-nofpu
9081 @opindex m4-nofpu
9082 Generate code for the SH4 without a floating-point unit.
9083
9084 @item -m4-single-only
9085 @opindex m4-single-only
9086 Generate code for the SH4 with a floating-point unit that only
9087 supports single-precision arithmetic.
9088
9089 @item -m4-single
9090 @opindex m4-single
9091 Generate code for the SH4 assuming the floating-point unit is in
9092 single-precision mode by default.
9093
9094 @item -m4
9095 @opindex m4
9096 Generate code for the SH4.
9097
9098 @item -mb
9099 @opindex mb
9100 Compile code for the processor in big endian mode.
9101
9102 @item -ml
9103 @opindex ml
9104 Compile code for the processor in little endian mode.
9105
9106 @item -mdalign
9107 @opindex mdalign
9108 Align doubles at 64-bit boundaries.  Note that this changes the calling
9109 conventions, and thus some functions from the standard C library will
9110 not work unless you recompile it first with @option{-mdalign}.
9111
9112 @item -mrelax
9113 @opindex mrelax
9114 Shorten some address references at link time, when possible; uses the
9115 linker option @option{-relax}.
9116
9117 @item -mbigtable
9118 @opindex mbigtable
9119 Use 32-bit offsets in @code{switch} tables.  The default is to use
9120 16-bit offsets.
9121
9122 @item -mfmovd
9123 @opindex mfmovd
9124 Enable the use of the instruction @code{fmovd}.
9125
9126 @item -mhitachi
9127 @opindex mhitachi
9128 Comply with the calling conventions defined by Hitachi.
9129
9130 @item -mnomacsave
9131 @opindex mnomacsave
9132 Mark the @code{MAC} register as call-clobbered, even if
9133 @option{-mhitachi} is given.
9134
9135 @item -mieee
9136 @opindex mieee
9137 Increase IEEE-compliance of floating-point code.
9138
9139 @item -misize
9140 @opindex misize
9141 Dump instruction size and location in the assembly code.
9142
9143 @item -mpadstruct
9144 @opindex mpadstruct
9145 This option is deprecated.  It pads structures to multiple of 4 bytes,
9146 which is incompatible with the SH ABI@.
9147
9148 @item -mspace
9149 @opindex mspace
9150 Optimize for space instead of speed.  Implied by @option{-Os}.
9151
9152 @item -mprefergot
9153 @opindex mprefergot
9154 When generating position-independent code, emit function calls using
9155 the Global Offset Table instead of the Procedure Linkage Table.
9156
9157 @item -musermode
9158 @opindex musermode
9159 Generate a library function call to invalidate instruction cache
9160 entries, after fixing up a trampoline.  This library function call
9161 doesn't assume it can write to the whole memory address space.  This
9162 is the default when the target is @code{sh-*-linux*}.
9163 @end table
9164
9165 @node System V Options
9166 @subsection Options for System V
9167
9168 These additional options are available on System V Release 4 for
9169 compatibility with other compilers on those systems:
9170
9171 @table @gcctabopt
9172 @item -G
9173 @opindex G
9174 Create a shared object.
9175 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
9176
9177 @item -Qy
9178 @opindex Qy
9179 Identify the versions of each tool used by the compiler, in a
9180 @code{.ident} assembler directive in the output.
9181
9182 @item -Qn
9183 @opindex Qn
9184 Refrain from adding @code{.ident} directives to the output file (this is
9185 the default).
9186
9187 @item -YP,@var{dirs}
9188 @opindex YP
9189 Search the directories @var{dirs}, and no others, for libraries
9190 specified with @option{-l}.
9191
9192 @item -Ym,@var{dir}
9193 @opindex Ym
9194 Look in the directory @var{dir} to find the M4 preprocessor.
9195 The assembler uses this option.
9196 @c This is supposed to go with a -Yd for predefined M4 macro files, but
9197 @c the generic assembler that comes with Solaris takes just -Ym.
9198 @end table
9199
9200 @node TMS320C3x/C4x Options
9201 @subsection TMS320C3x/C4x Options
9202 @cindex TMS320C3x/C4x Options
9203
9204 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
9205
9206 @table @gcctabopt
9207
9208 @item -mcpu=@var{cpu_type}
9209 @opindex mcpu
9210 Set the instruction set, register set, and instruction scheduling
9211 parameters for machine type @var{cpu_type}.  Supported values for
9212 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
9213 @samp{c44}.  The default is @samp{c40} to generate code for the
9214 TMS320C40.
9215
9216 @item -mbig-memory
9217 @item -mbig
9218 @itemx -msmall-memory
9219 @itemx -msmall
9220 @opindex mbig-memory
9221 @opindex mbig
9222 @opindex msmall-memory
9223 @opindex msmall
9224 Generates code for the big or small memory model.  The small memory
9225 model assumed that all data fits into one 64K word page.  At run-time
9226 the data page (DP) register must be set to point to the 64K page
9227 containing the .bss and .data program sections.  The big memory model is
9228 the default and requires reloading of the DP register for every direct
9229 memory access.
9230
9231 @item -mbk
9232 @itemx -mno-bk
9233 @opindex mbk
9234 @opindex mno-bk
9235 Allow (disallow) allocation of general integer operands into the block
9236 count register BK@.
9237
9238 @item -mdb
9239 @itemx -mno-db
9240 @opindex mdb
9241 @opindex mno-db
9242 Enable (disable) generation of code using decrement and branch,
9243 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
9244 on the safe side, this is disabled for the C3x, since the maximum
9245 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
9246 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
9247 that it can utilize the decrement and branch instruction, but will give
9248 up if there is more than one memory reference in the loop.  Thus a loop
9249 where the loop counter is decremented can generate slightly more
9250 efficient code, in cases where the RPTB instruction cannot be utilized.
9251
9252 @item -mdp-isr-reload
9253 @itemx -mparanoid
9254 @opindex mdp-isr-reload
9255 @opindex mparanoid
9256 Force the DP register to be saved on entry to an interrupt service
9257 routine (ISR), reloaded to point to the data section, and restored on
9258 exit from the ISR@.  This should not be required unless someone has
9259 violated the small memory model by modifying the DP register, say within
9260 an object library.
9261
9262 @item -mmpyi
9263 @itemx -mno-mpyi
9264 @opindex mmpyi
9265 @opindex mno-mpyi
9266 For the C3x use the 24-bit MPYI instruction for integer multiplies
9267 instead of a library call to guarantee 32-bit results.  Note that if one
9268 of the operands is a constant, then the multiplication will be performed
9269 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
9270 then squaring operations are performed inline instead of a library call.
9271
9272 @item -mfast-fix
9273 @itemx -mno-fast-fix
9274 @opindex mfast-fix
9275 @opindex mno-fast-fix
9276 The C3x/C4x FIX instruction to convert a floating point value to an
9277 integer value chooses the nearest integer less than or equal to the
9278 floating point value rather than to the nearest integer.  Thus if the
9279 floating point number is negative, the result will be incorrectly
9280 truncated an additional code is necessary to detect and correct this
9281 case.  This option can be used to disable generation of the additional
9282 code required to correct the result.
9283
9284 @item -mrptb
9285 @itemx -mno-rptb
9286 @opindex mrptb
9287 @opindex mno-rptb
9288 Enable (disable) generation of repeat block sequences using the RPTB
9289 instruction for zero overhead looping.  The RPTB construct is only used
9290 for innermost loops that do not call functions or jump across the loop
9291 boundaries.  There is no advantage having nested RPTB loops due to the
9292 overhead required to save and restore the RC, RS, and RE registers.
9293 This is enabled by default with @option{-O2}.
9294
9295 @item -mrpts=@var{count}
9296 @itemx -mno-rpts
9297 @opindex mrpts
9298 @opindex mno-rpts
9299 Enable (disable) the use of the single instruction repeat instruction
9300 RPTS@.  If a repeat block contains a single instruction, and the loop
9301 count can be guaranteed to be less than the value @var{count}, GCC will
9302 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
9303 then a RPTS will be emitted even if the loop count cannot be determined
9304 at compile time.  Note that the repeated instruction following RPTS does
9305 not have to be reloaded from memory each iteration, thus freeing up the
9306 CPU buses for operands.  However, since interrupts are blocked by this
9307 instruction, it is disabled by default.
9308
9309 @item -mloop-unsigned
9310 @itemx -mno-loop-unsigned
9311 @opindex mloop-unsigned
9312 @opindex mno-loop-unsigned
9313 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
9314 is @math{2^{31} + 1} since these instructions test if the iteration count is
9315 negative to terminate the loop.  If the iteration count is unsigned
9316 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
9317 exceeded.  This switch allows an unsigned iteration count.
9318
9319 @item -mti
9320 @opindex mti
9321 Try to emit an assembler syntax that the TI assembler (asm30) is happy
9322 with.  This also enforces compatibility with the API employed by the TI
9323 C3x C compiler.  For example, long doubles are passed as structures
9324 rather than in floating point registers.
9325
9326 @item -mregparm
9327 @itemx -mmemparm
9328 @opindex mregparm
9329 @opindex mmemparm
9330 Generate code that uses registers (stack) for passing arguments to functions.
9331 By default, arguments are passed in registers where possible rather
9332 than by pushing arguments on to the stack.
9333
9334 @item -mparallel-insns
9335 @itemx -mno-parallel-insns
9336 @opindex mparallel-insns
9337 @opindex mno-parallel-insns
9338 Allow the generation of parallel instructions.  This is enabled by
9339 default with @option{-O2}.
9340
9341 @item -mparallel-mpy
9342 @itemx -mno-parallel-mpy
9343 @opindex mparallel-mpy
9344 @opindex mno-parallel-mpy
9345 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
9346 provided @option{-mparallel-insns} is also specified.  These instructions have
9347 tight register constraints which can pessimize the code generation
9348 of large functions.
9349
9350 @end table
9351
9352 @node V850 Options
9353 @subsection V850 Options
9354 @cindex V850 Options
9355
9356 These @samp{-m} options are defined for V850 implementations:
9357
9358 @table @gcctabopt
9359 @item -mlong-calls
9360 @itemx -mno-long-calls
9361 @opindex mlong-calls
9362 @opindex mno-long-calls
9363 Treat all calls as being far away (near).  If calls are assumed to be
9364 far away, the compiler will always load the functions address up into a
9365 register, and call indirect through the pointer.
9366
9367 @item -mno-ep
9368 @itemx -mep
9369 @opindex mno-ep
9370 @opindex mep
9371 Do not optimize (do optimize) basic blocks that use the same index
9372 pointer 4 or more times to copy pointer into the @code{ep} register, and
9373 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
9374 option is on by default if you optimize.
9375
9376 @item -mno-prolog-function
9377 @itemx -mprolog-function
9378 @opindex mno-prolog-function
9379 @opindex mprolog-function
9380 Do not use (do use) external functions to save and restore registers at
9381 the prolog and epilog of a function.  The external functions are slower,
9382 but use less code space if more than one function saves the same number
9383 of registers.  The @option{-mprolog-function} option is on by default if
9384 you optimize.
9385
9386 @item -mspace
9387 @opindex mspace
9388 Try to make the code as small as possible.  At present, this just turns
9389 on the @option{-mep} and @option{-mprolog-function} options.
9390
9391 @item -mtda=@var{n}
9392 @opindex mtda
9393 Put static or global variables whose size is @var{n} bytes or less into
9394 the tiny data area that register @code{ep} points to.  The tiny data
9395 area can hold up to 256 bytes in total (128 bytes for byte references).
9396
9397 @item -msda=@var{n}
9398 @opindex msda
9399 Put static or global variables whose size is @var{n} bytes or less into
9400 the small data area that register @code{gp} points to.  The small data
9401 area can hold up to 64 kilobytes.
9402
9403 @item -mzda=@var{n}
9404 @opindex mzda
9405 Put static or global variables whose size is @var{n} bytes or less into
9406 the first 32 kilobytes of memory.
9407
9408 @item -mv850
9409 @opindex mv850
9410 Specify that the target processor is the V850.
9411
9412 @item -mbig-switch
9413 @opindex mbig-switch
9414 Generate code suitable for big switch tables.  Use this option only if
9415 the assembler/linker complain about out of range branches within a switch
9416 table.
9417
9418 @item -mapp-regs
9419 @opindex -mapp-regs
9420 This option will cause r2 and r5 to be used in the code generated by
9421 the compiler.  This setting is the default.
9422
9423 @item -mno-app-regs
9424 @opindex -mno-app-regs
9425 This option will cause r2 and r5 to be treated as fixed registers.
9426   
9427 @item -mv850e
9428 @opindex -mv850e
9429 Specify that the target processor is the V850E.  The preprocessor
9430 constant @samp{__v850e__} will be defined if this option is used.
9431
9432 If neither @option{-mv850} nor @option{-mv850e} are defined
9433 then a default target processor will be chosen and the relevant
9434 @samp{__v850*__} preprocessor constant will be defined.
9435
9436 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
9437 defined, regardless of which processor variant is the target.
9438
9439 @item -mdisable-callt
9440 @opindex -mdisable-callt
9441 This option will suppress generation of the CALLT instruction for the
9442 v850e flavors of the v850 architecture.  The default is
9443 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
9444
9445 @end table
9446
9447 @node ARC Options
9448 @subsection ARC Options
9449 @cindex ARC Options
9450
9451 These options are defined for ARC implementations:
9452
9453 @table @gcctabopt
9454 @item -EL
9455 @opindex EL
9456 Compile code for little endian mode.  This is the default.
9457
9458 @item -EB
9459 @opindex EB
9460 Compile code for big endian mode.
9461
9462 @item -mmangle-cpu
9463 @opindex mmangle-cpu
9464 Prepend the name of the cpu to all public symbol names.
9465 In multiple-processor systems, there are many ARC variants with different
9466 instruction and register set characteristics.  This flag prevents code
9467 compiled for one cpu to be linked with code compiled for another.
9468 No facility exists for handling variants that are ``almost identical''.
9469 This is an all or nothing option.
9470
9471 @item -mcpu=@var{cpu}
9472 @opindex mcpu
9473 Compile code for ARC variant @var{cpu}.
9474 Which variants are supported depend on the configuration.
9475 All variants support @option{-mcpu=base}, this is the default.
9476
9477 @item -mtext=@var{text-section}
9478 @itemx -mdata=@var{data-section}
9479 @itemx -mrodata=@var{readonly-data-section}
9480 @opindex mtext
9481 @opindex mdata
9482 @opindex mrodata
9483 Put functions, data, and readonly data in @var{text-section},
9484 @var{data-section}, and @var{readonly-data-section} respectively
9485 by default.  This can be overridden with the @code{section} attribute.
9486 @xref{Variable Attributes}.
9487
9488 @end table
9489
9490 @node NS32K Options
9491 @subsection NS32K Options
9492 @cindex NS32K options
9493
9494 These are the @samp{-m} options defined for the 32000 series.  The default
9495 values for these options depends on which style of 32000 was selected when
9496 the compiler was configured; the defaults for the most common choices are
9497 given below.
9498
9499 @table @gcctabopt
9500 @item -m32032
9501 @itemx -m32032
9502 @opindex m32032
9503 @opindex m32032
9504 Generate output for a 32032.  This is the default
9505 when the compiler is configured for 32032 and 32016 based systems.
9506
9507 @item -m32332
9508 @itemx -m32332
9509 @opindex m32332
9510 @opindex m32332
9511 Generate output for a 32332.  This is the default
9512 when the compiler is configured for 32332-based systems.
9513
9514 @item -m32532
9515 @itemx -m32532
9516 @opindex m32532
9517 @opindex m32532
9518 Generate output for a 32532.  This is the default
9519 when the compiler is configured for 32532-based systems.
9520
9521 @item -m32081
9522 @opindex m32081
9523 Generate output containing 32081 instructions for floating point.
9524 This is the default for all systems.
9525
9526 @item -m32381
9527 @opindex m32381
9528 Generate output containing 32381 instructions for floating point.  This
9529 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9530 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9531
9532 @item -mmulti-add
9533 @opindex mmulti-add
9534 Try and generate multiply-add floating point instructions @code{polyF}
9535 and @code{dotF}.  This option is only available if the @option{-m32381}
9536 option is in effect.  Using these instructions requires changes to
9537 register allocation which generally has a negative impact on
9538 performance.  This option should only be enabled when compiling code
9539 particularly likely to make heavy use of multiply-add instructions.
9540
9541 @item -mnomulti-add
9542 @opindex mnomulti-add
9543 Do not try and generate multiply-add floating point instructions
9544 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9545
9546 @item -msoft-float
9547 @opindex msoft-float
9548 Generate output containing library calls for floating point.
9549 @strong{Warning:} the requisite libraries may not be available.
9550
9551 @item -mieee-compare
9552 @itemx -mno-ieee-compare
9553 @opindex mieee-compare
9554 @opindex mno-ieee-compare
9555 Control whether or not the compiler uses IEEE floating point
9556 comparisons.  These handle correctly the case where the result of a
9557 comparison is unordered.
9558 @strong{Warning:} the requisite kernel support may not be available.
9559
9560 @item -mnobitfield
9561 @opindex mnobitfield
9562 Do not use the bit-field instructions.  On some machines it is faster to
9563 use shifting and masking operations.  This is the default for the pc532.
9564
9565 @item -mbitfield
9566 @opindex mbitfield
9567 Do use the bit-field instructions.  This is the default for all platforms
9568 except the pc532.
9569
9570 @item -mrtd
9571 @opindex mrtd
9572 Use a different function-calling convention, in which functions
9573 that take a fixed number of arguments return pop their
9574 arguments on return with the @code{ret} instruction.
9575
9576 This calling convention is incompatible with the one normally
9577 used on Unix, so you cannot use it if you need to call libraries
9578 compiled with the Unix compiler.
9579
9580 Also, you must provide function prototypes for all functions that
9581 take variable numbers of arguments (including @code{printf});
9582 otherwise incorrect code will be generated for calls to those
9583 functions.
9584
9585 In addition, seriously incorrect code will result if you call a
9586 function with too many arguments.  (Normally, extra arguments are
9587 harmlessly ignored.)
9588
9589 This option takes its name from the 680x0 @code{rtd} instruction.
9590
9591
9592 @item -mregparam
9593 @opindex mregparam
9594 Use a different function-calling convention where the first two arguments
9595 are passed in registers.
9596
9597 This calling convention is incompatible with the one normally
9598 used on Unix, so you cannot use it if you need to call libraries
9599 compiled with the Unix compiler.
9600
9601 @item -mnoregparam
9602 @opindex mnoregparam
9603 Do not pass any arguments in registers.  This is the default for all
9604 targets.
9605
9606 @item -msb
9607 @opindex msb
9608 It is OK to use the sb as an index register which is always loaded with
9609 zero.  This is the default for the pc532-netbsd target.
9610
9611 @item -mnosb
9612 @opindex mnosb
9613 The sb register is not available for use or has not been initialized to
9614 zero by the run time system.  This is the default for all targets except
9615 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9616 @option{-fpic} is set.
9617
9618 @item -mhimem
9619 @opindex mhimem
9620 Many ns32000 series addressing modes use displacements of up to 512MB@.
9621 If an address is above 512MB then displacements from zero can not be used.
9622 This option causes code to be generated which can be loaded above 512MB@.
9623 This may be useful for operating systems or ROM code.
9624
9625 @item -mnohimem
9626 @opindex mnohimem
9627 Assume code will be loaded in the first 512MB of virtual address space.
9628 This is the default for all platforms.
9629
9630
9631 @end table
9632
9633 @node AVR Options
9634 @subsection AVR Options
9635 @cindex AVR Options
9636
9637 These options are defined for AVR implementations:
9638
9639 @table @gcctabopt
9640 @item -mmcu=@var{mcu}
9641 @opindex mmcu
9642 Specify ATMEL AVR instruction set or MCU type.
9643
9644 Instruction set avr1 is for the minimal AVR core, not supported by the C
9645 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9646 attiny11, attiny12, attiny15, attiny28).
9647
9648 Instruction set avr2 (default) is for the classic AVR core with up to
9649 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
9650 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
9651 at90c8534, at90s8535).
9652
9653 Instruction set avr3 is for the classic AVR core with up to 128K program
9654 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
9655
9656 Instruction set avr4 is for the enhanced AVR core with up to 8K program
9657 memory space (MCU types: atmega8, atmega83, atmega85).
9658
9659 Instruction set avr5 is for the enhanced AVR core with up to 128K program
9660 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
9661 atmega64, atmega128, at43usb355, at94k).
9662
9663 @item -msize
9664 @opindex msize
9665 Output instruction sizes to the asm file.
9666
9667 @item -minit-stack=@var{N}
9668 @opindex minit-stack
9669 Specify the initial stack address, which may be a symbol or numeric value,
9670 @samp{__stack} is the default.
9671
9672 @item -mno-interrupts
9673 @opindex mno-interrupts
9674 Generated code is not compatible with hardware interrupts.
9675 Code size will be smaller.
9676
9677 @item -mcall-prologues
9678 @opindex mcall-prologues
9679 Functions prologues/epilogues expanded as call to appropriate
9680 subroutines.  Code size will be smaller.
9681
9682 @item -mno-tablejump
9683 @opindex mno-tablejump
9684 Do not generate tablejump insns which sometimes increase code size.
9685
9686 @item -mtiny-stack
9687 @opindex mtiny-stack
9688 Change only the low 8 bits of the stack pointer.
9689 @end table
9690
9691 @node MCore Options
9692 @subsection MCore Options
9693 @cindex MCore options
9694
9695 These are the @samp{-m} options defined for the Motorola M*Core
9696 processors.
9697
9698 @table @gcctabopt
9699
9700 @item -mhardlit
9701 @itemx -mhardlit
9702 @itemx -mno-hardlit
9703 @opindex mhardlit
9704 @opindex mhardlit
9705 @opindex mno-hardlit
9706 Inline constants into the code stream if it can be done in two
9707 instructions or less.
9708
9709 @item -mdiv
9710 @itemx -mdiv
9711 @itemx -mno-div
9712 @opindex mdiv
9713 @opindex mdiv
9714 @opindex mno-div
9715 Use the divide instruction.  (Enabled by default).
9716
9717 @item -mrelax-immediate
9718 @itemx -mrelax-immediate
9719 @itemx -mno-relax-immediate
9720 @opindex mrelax-immediate
9721 @opindex mrelax-immediate
9722 @opindex mno-relax-immediate
9723 Allow arbitrary sized immediates in bit operations.
9724
9725 @item -mwide-bitfields
9726 @itemx -mwide-bitfields
9727 @itemx -mno-wide-bitfields
9728 @opindex mwide-bitfields
9729 @opindex mwide-bitfields
9730 @opindex mno-wide-bitfields
9731 Always treat bit-fields as int-sized.
9732
9733 @item -m4byte-functions
9734 @itemx -m4byte-functions
9735 @itemx -mno-4byte-functions
9736 @opindex m4byte-functions
9737 @opindex m4byte-functions
9738 @opindex mno-4byte-functions
9739 Force all functions to be aligned to a four byte boundary.
9740
9741 @item -mcallgraph-data
9742 @itemx -mcallgraph-data
9743 @itemx -mno-callgraph-data
9744 @opindex mcallgraph-data
9745 @opindex mcallgraph-data
9746 @opindex mno-callgraph-data
9747 Emit callgraph information.
9748
9749 @item -mslow-bytes
9750 @itemx -mslow-bytes
9751 @itemx -mno-slow-bytes
9752 @opindex mslow-bytes
9753 @opindex mslow-bytes
9754 @opindex mno-slow-bytes
9755 Prefer word access when reading byte quantities.
9756
9757 @item -mlittle-endian
9758 @itemx -mlittle-endian
9759 @itemx -mbig-endian
9760 @opindex mlittle-endian
9761 @opindex mlittle-endian
9762 @opindex mbig-endian
9763 Generate code for a little endian target.
9764
9765 @item -m210
9766 @itemx -m210
9767 @itemx -m340
9768 @opindex m210
9769 @opindex m210
9770 @opindex m340
9771 Generate code for the 210 processor.
9772 @end table
9773
9774 @node IA-64 Options
9775 @subsection IA-64 Options
9776 @cindex IA-64 Options
9777
9778 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9779
9780 @table @gcctabopt
9781 @item -mbig-endian
9782 @opindex mbig-endian
9783 Generate code for a big endian target.  This is the default for HP-UX@.
9784
9785 @item -mlittle-endian
9786 @opindex mlittle-endian
9787 Generate code for a little endian target.  This is the default for AIX5
9788 and Linux.
9789
9790 @item -mgnu-as
9791 @itemx -mno-gnu-as
9792 @opindex mgnu-as
9793 @opindex mno-gnu-as
9794 Generate (or don't) code for the GNU assembler.  This is the default.
9795 @c Also, this is the default if the configure option @option{--with-gnu-as}
9796 @c is used.
9797
9798 @item -mgnu-ld
9799 @itemx -mno-gnu-ld
9800 @opindex mgnu-ld
9801 @opindex mno-gnu-ld
9802 Generate (or don't) code for the GNU linker.  This is the default.
9803 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9804 @c is used.
9805
9806 @item -mno-pic
9807 @opindex mno-pic
9808 Generate code that does not use a global pointer register.  The result
9809 is not position independent code, and violates the IA-64 ABI@.
9810
9811 @item -mvolatile-asm-stop
9812 @itemx -mno-volatile-asm-stop
9813 @opindex mvolatile-asm-stop
9814 @opindex mno-volatile-asm-stop
9815 Generate (or don't) a stop bit immediately before and after volatile asm
9816 statements.
9817
9818 @item -mb-step
9819 @opindex mb-step
9820 Generate code that works around Itanium B step errata.
9821
9822 @item -mregister-names
9823 @itemx -mno-register-names
9824 @opindex mregister-names
9825 @opindex mno-register-names
9826 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9827 the stacked registers.  This may make assembler output more readable.
9828
9829 @item -mno-sdata
9830 @itemx -msdata
9831 @opindex mno-sdata
9832 @opindex msdata
9833 Disable (or enable) optimizations that use the small data section.  This may
9834 be useful for working around optimizer bugs.
9835
9836 @item -mconstant-gp
9837 @opindex mconstant-gp
9838 Generate code that uses a single constant global pointer value.  This is
9839 useful when compiling kernel code.
9840
9841 @item -mauto-pic
9842 @opindex mauto-pic
9843 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9844 This is useful when compiling firmware code.
9845
9846 @item -minline-float-divide-min-latency
9847 @opindex minline-float-divide-min-latency
9848 Generate code for inline divides of floating point values
9849 using the minimum latency algorithm.
9850
9851 @item -minline-float-divide-max-throughput
9852 @opindex minline-float-divide-max-throughput
9853 Generate code for inline divides of floating point values
9854 using the maximum throughput algorithm.
9855
9856 @item -minline-int-divide-min-latency
9857 @opindex minline-int-divide-min-latency
9858 Generate code for inline divides of integer values
9859 using the minimum latency algorithm.
9860
9861 @item -minline-int-divide-max-throughput
9862 @opindex minline-int-divide-max-throughput
9863 Generate code for inline divides of integer values
9864 using the maximum throughput algorithm.
9865
9866 @item -mno-dwarf2-asm
9867 @itemx -mdwarf2-asm
9868 @opindex mno-dwarf2-asm
9869 @opindex mdwarf2-asm
9870 Don't (or do) generate assembler code for the DWARF2 line number debugging
9871 info.  This may be useful when not using the GNU assembler.
9872
9873 @item -mfixed-range=@var{register-range}
9874 @opindex mfixed-range
9875 Generate code treating the given register range as fixed registers.
9876 A fixed register is one that the register allocator can not use.  This is
9877 useful when compiling kernel code.  A register range is specified as
9878 two registers separated by a dash.  Multiple register ranges can be
9879 specified separated by a comma.
9880
9881 @item -mearly-stop-bits
9882 @itemx -mno-early-stop-bits
9883 @opindex mearly-stop-bits
9884 @opindex mno-early-stop-bits
9885 Allow stop bits to be placed earlier than immediately preceding the
9886 instruction that triggered the stop bit.  This can improve instruction
9887 scheduling, but does not always do so.
9888 @end table
9889
9890 @node D30V Options
9891 @subsection D30V Options
9892 @cindex D30V Options
9893
9894 These @samp{-m} options are defined for D30V implementations:
9895
9896 @table @gcctabopt
9897 @item -mextmem
9898 @opindex mextmem
9899 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
9900 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
9901 memory, which starts at location @code{0x80000000}.
9902
9903 @item -mextmemory
9904 @opindex mextmemory
9905 Same as the @option{-mextmem} switch.
9906
9907 @item -monchip
9908 @opindex monchip
9909 Link the @samp{.text} section into onchip text memory, which starts at
9910 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
9911 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
9912 into onchip data memory, which starts at location @code{0x20000000}.
9913
9914 @item -mno-asm-optimize
9915 @itemx -masm-optimize
9916 @opindex mno-asm-optimize
9917 @opindex masm-optimize
9918 Disable (enable) passing @option{-O} to the assembler when optimizing.
9919 The assembler uses the @option{-O} option to automatically parallelize
9920 adjacent short instructions where possible.
9921
9922 @item -mbranch-cost=@var{n}
9923 @opindex mbranch-cost
9924 Increase the internal costs of branches to @var{n}.  Higher costs means
9925 that the compiler will issue more instructions to avoid doing a branch.
9926 The default is 2.
9927
9928 @item -mcond-exec=@var{n}
9929 @opindex mcond-exec
9930 Specify the maximum number of conditionally executed instructions that
9931 replace a branch.  The default is 4.
9932 @end table
9933
9934 @node S/390 and zSeries Options
9935 @subsection S/390 and zSeries Options
9936 @cindex S/390 and zSeries Options
9937
9938 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
9939
9940 @table @gcctabopt
9941 @item -mhard-float
9942 @itemx -msoft-float
9943 @opindex mhard-float
9944 @opindex msoft-float
9945 Use (do not use) the hardware floating-point instructions and registers
9946 for floating-point operations.  When @option{-msoft-float} is specified,
9947 functions in @file{libgcc.a} will be used to perform floating-point
9948 operations.  When @option{-mhard-float} is specified, the compiler
9949 generates IEEE floating-point instructions.  This is the default.
9950
9951 @item -mbackchain
9952 @itemx -mno-backchain
9953 @opindex mbackchain
9954 @opindex mno-backchain
9955 Generate (or do not generate) code which maintains an explicit
9956 backchain within the stack frame that points to the caller's frame.
9957 This is currently needed to allow debugging.  The default is to
9958 generate the backchain.
9959
9960 @item -msmall-exec
9961 @itemx -mno-small-exec
9962 @opindex msmall-exec
9963 @opindex mno-small-exec
9964 Generate (or do not generate) code using the @code{bras} instruction
9965 to do subroutine calls.
9966 This only works reliably if the total executable size does not
9967 exceed 64k.  The default is to use the @code{basr} instruction instead,
9968 which does not have this limitation.
9969
9970 @item -m64
9971 @itemx -m31
9972 @opindex m64
9973 @opindex m31
9974 When @option{-m31} is specified, generate code compliant to the
9975 Linux for S/390 ABI@.  When @option{-m64} is specified, generate
9976 code compliant to the Linux for zSeries ABI@.  This allows GCC in
9977 particular to generate 64-bit instructions.  For the @samp{s390}
9978 targets, the default is @option{-m31}, while the @samp{s390x}
9979 targets default to @option{-m64}.
9980
9981 @item -mzarch
9982 @itemx -mesa
9983 @opindex mzarch
9984 @opindex mesa
9985 When @option{-mzarch} is specified, generate code using the 
9986 instructions available on z/Architecture. 
9987 When @option{-mesa} is specified, generate code using the 
9988 instructions available on ESA/390. Note that @option{-mesa} is
9989 not possible with @option{-m64}.
9990 For the @samp{s390} targets, the default is @option{-mesa}, 
9991 while the @samp{s390x} targets default to @option{-mzarch}.
9992
9993 @item -mmvcle
9994 @itemx -mno-mvcle
9995 @opindex mmvcle
9996 @opindex mno-mvcle
9997 Generate (or do not generate) code using the @code{mvcle} instruction
9998 to perform block moves.  When @option{-mno-mvcle} is specified,
9999 use a @code{mvc} loop instead.  This is the default.
10000
10001 @item -mdebug
10002 @itemx -mno-debug
10003 @opindex mdebug
10004 @opindex mno-debug
10005 Print (or do not print) additional debug information when compiling.
10006 The default is to not print debug information.
10007
10008 @item -march=@var{arch}
10009 @opindex march
10010 Generate code that will run on @var{arch}, which is the name of system
10011 representing a certain processor type. Possible values for
10012 @var{cpu-type} are @samp{g5}, @samp{g6} and @samp{z900}. 
10013
10014 @item -mtune=@var{arch}
10015 @opindex mtune
10016 Tune to @var{cpu-type} everything applicable about the generated code,
10017  except for the ABI and the set of available instructions. 
10018 The list of @var{arch} values is the same as for @option{-march}.
10019
10020 @end table
10021
10022 @node CRIS Options
10023 @subsection CRIS Options
10024 @cindex CRIS Options
10025
10026 These options are defined specifically for the CRIS ports.
10027
10028 @table @gcctabopt
10029 @item -march=@var{architecture-type}
10030 @itemx -mcpu=@var{architecture-type}
10031 @opindex march
10032 @opindex mcpu
10033 Generate code for the specified architecture.  The choices for
10034 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10035 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
10036 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10037 @samp{v10}.
10038
10039 @item -mtune=@var{architecture-type}
10040 @opindex mtune
10041 Tune to @var{architecture-type} everything applicable about the generated
10042 code, except for the ABI and the set of available instructions.  The
10043 choices for @var{architecture-type} are the same as for
10044 @option{-march=@var{architecture-type}}.
10045
10046 @item -mmax-stack-frame=@var{n}
10047 @opindex mmax-stack-frame
10048 Warn when the stack frame of a function exceeds @var{n} bytes.
10049
10050 @item -melinux-stacksize=@var{n}
10051 @opindex melinux-stacksize
10052 Only available with the @samp{cris-axis-aout} target.  Arranges for
10053 indications in the program to the kernel loader that the stack of the
10054 program should be set to @var{n} bytes.
10055
10056 @item -metrax4
10057 @itemx -metrax100
10058 @opindex metrax4
10059 @opindex metrax100
10060 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10061 @option{-march=v3} and @option{-march=v8} respectively.
10062
10063 @item -mpdebug
10064 @opindex mpdebug
10065 Enable CRIS-specific verbose debug-related information in the assembly
10066 code.  This option also has the effect to turn off the @samp{#NO_APP}
10067 formatted-code indicator to the assembler at the beginning of the
10068 assembly file.
10069
10070 @item -mcc-init
10071 @opindex mcc-init
10072 Do not use condition-code results from previous instruction; always emit
10073 compare and test instructions before use of condition codes.
10074
10075 @item -mno-side-effects
10076 @opindex mno-side-effects
10077 Do not emit instructions with side-effects in addressing modes other than
10078 post-increment.
10079
10080 @item -mstack-align
10081 @itemx -mno-stack-align
10082 @itemx -mdata-align
10083 @itemx -mno-data-align
10084 @itemx -mconst-align
10085 @itemx -mno-const-align
10086 @opindex mstack-align
10087 @opindex mno-stack-align
10088 @opindex mdata-align
10089 @opindex mno-data-align
10090 @opindex mconst-align
10091 @opindex mno-const-align
10092 These options (no-options) arranges (eliminate arrangements) for the
10093 stack-frame, individual data and constants to be aligned for the maximum
10094 single data access size for the chosen CPU model.  The default is to
10095 arrange for 32-bit alignment.  ABI details such as structure layout are
10096 not affected by these options.
10097
10098 @item -m32-bit
10099 @itemx -m16-bit
10100 @itemx -m8-bit
10101 @opindex m32-bit
10102 @opindex m16-bit
10103 @opindex m8-bit
10104 Similar to the stack- data- and const-align options above, these options
10105 arrange for stack-frame, writable data and constants to all be 32-bit,
10106 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10107
10108 @item -mno-prologue-epilogue
10109 @itemx -mprologue-epilogue
10110 @opindex mno-prologue-epilogue
10111 @opindex mprologue-epilogue
10112 With @option{-mno-prologue-epilogue}, the normal function prologue and
10113 epilogue that sets up the stack-frame are omitted and no return
10114 instructions or return sequences are generated in the code.  Use this
10115 option only together with visual inspection of the compiled code: no
10116 warnings or errors are generated when call-saved registers must be saved,
10117 or storage for local variable needs to be allocated.
10118
10119 @item -mno-gotplt
10120 @itemx -mgotplt
10121 @opindex mno-gotplt
10122 @opindex mgotplt
10123 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10124 instruction sequences that load addresses for functions from the PLT part
10125 of the GOT rather than (traditional on other architectures) calls to the
10126 PLT.  The default is @option{-mgotplt}.
10127
10128 @item -maout
10129 @opindex maout
10130 Legacy no-op option only recognized with the cris-axis-aout target.
10131
10132 @item -melf
10133 @opindex melf
10134 Legacy no-op option only recognized with the cris-axis-elf and
10135 cris-axis-linux-gnu targets.
10136
10137 @item -melinux
10138 @opindex melinux
10139 Only recognized with the cris-axis-aout target, where it selects a
10140 GNU/linux-like multilib, include files and instruction set for
10141 @option{-march=v8}.
10142
10143 @item -mlinux
10144 @opindex mlinux
10145 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10146
10147 @item -sim
10148 @opindex sim
10149 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
10150 to link with input-output functions from a simulator library.  Code,
10151 initialized data and zero-initialized data are allocated consecutively.
10152
10153 @item -sim2
10154 @opindex sim2
10155 Like @option{-sim}, but pass linker options to locate initialized data at
10156 0x40000000 and zero-initialized data at 0x80000000.
10157 @end table
10158
10159 @node MMIX Options
10160 @subsection MMIX Options
10161 @cindex MMIX Options
10162
10163 These options are defined for the MMIX:
10164
10165 @table @gcctabopt
10166 @item -mlibfuncs
10167 @itemx -mno-libfuncs
10168 @opindex mlibfuncs
10169 @opindex mno-libfuncs
10170 Specify that intrinsic library functions are being compiled, passing all
10171 values in registers, no matter the size.
10172
10173 @item -mepsilon
10174 @itemx -mno-epsilon
10175 @opindex mepsilon
10176 @opindex mno-epsilon
10177 Generate floating-point comparison instructions that compare with respect
10178 to the @code{rE} epsilon register.
10179
10180 @item -mabi=mmixware
10181 @itemx -mabi=gnu
10182 @opindex mabi-mmixware
10183 @opindex mabi=gnu
10184 Generate code that passes function parameters and return values that (in
10185 the called function) are seen as registers @code{$0} and up, as opposed to
10186 the GNU ABI which uses global registers @code{$231} and up.
10187
10188 @item -mzero-extend
10189 @itemx -mno-zero-extend
10190 @opindex mzero-extend
10191 @opindex mno-zero-extend
10192 When reading data from memory in sizes shorter than 64 bits, use (do not
10193 use) zero-extending load instructions by default, rather than
10194 sign-extending ones.
10195
10196 @item -mknuthdiv
10197 @itemx -mno-knuthdiv
10198 @opindex mknuthdiv
10199 @opindex mno-knuthdiv
10200 Make the result of a division yielding a remainder have the same sign as
10201 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10202 remainder follows the sign of the dividend.  Both methods are
10203 arithmetically valid, the latter being almost exclusively used.
10204
10205 @item -mtoplevel-symbols
10206 @itemx -mno-toplevel-symbols
10207 @opindex mtoplevel-symbols
10208 @opindex mno-toplevel-symbols
10209 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10210 code can be used with the @code{PREFIX} assembly directive.
10211
10212 @item -melf
10213 @opindex melf
10214 Generate an executable in the ELF format, rather than the default
10215 @samp{mmo} format used by the @command{mmix} simulator.
10216
10217 @item -mbranch-predict
10218 @itemx -mno-branch-predict
10219 @opindex mbranch-predict
10220 @opindex mno-branch-predict
10221 Use (do not use) the probable-branch instructions, when static branch
10222 prediction indicates a probable branch.
10223
10224 @item -mbase-addresses
10225 @itemx -mno-base-addresses
10226 @opindex mbase-addresses
10227 @opindex mno-base-addresses
10228 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10229 base address automatically generates a request (handled by the assembler
10230 and the linker) for a constant to be set up in a global register.  The
10231 register is used for one or more base address requests within the range 0
10232 to 255 from the value held in the register.  The generally leads to short
10233 and fast code, but the number of different data items that can be
10234 addressed is limited.  This means that a program that uses lots of static
10235 data may require @option{-mno-base-addresses}.
10236
10237 @item -msingle-exit
10238 @itemx -mno-single-exit
10239 @opindex msingle-exit
10240 @opindex mno-single-exit
10241 Force (do not force) generated code to have a single exit point in each
10242 function.
10243 @end table
10244
10245 @node PDP-11 Options
10246 @subsection PDP-11 Options
10247 @cindex PDP-11 Options
10248
10249 These options are defined for the PDP-11:
10250
10251 @table @gcctabopt
10252 @item -mfpu
10253 @opindex mfpu
10254 Use hardware FPP floating point.  This is the default.  (FIS floating
10255 point on the PDP-11/40 is not supported.)
10256
10257 @item -msoft-float
10258 @opindex msoft-float
10259 Do not use hardware floating point.
10260
10261 @item -mac0
10262 @opindex mac0
10263 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10264
10265 @item -mno-ac0
10266 @opindex mno-ac0
10267 Return floating-point results in memory.  This is the default.
10268
10269 @item -m40
10270 @opindex m40
10271 Generate code for a PDP-11/40.
10272
10273 @item -m45
10274 @opindex m45
10275 Generate code for a PDP-11/45.  This is the default.
10276
10277 @item -m10
10278 @opindex m10
10279 Generate code for a PDP-11/10.
10280
10281 @item -mbcopy-builtin
10282 @opindex bcopy-builtin
10283 Use inline @code{movstrhi} patterns for copying memory.  This is the
10284 default.
10285
10286 @item -mbcopy
10287 @opindex mbcopy
10288 Do not use inline @code{movstrhi} patterns for copying memory.
10289
10290 @item -mint16
10291 @itemx -mno-int32
10292 @opindex mint16
10293 @opindex mno-int32
10294 Use 16-bit @code{int}.  This is the default.
10295
10296 @item -mint32
10297 @itemx -mno-int16
10298 @opindex mint32
10299 @opindex mno-int16
10300 Use 32-bit @code{int}.
10301
10302 @item -mfloat64
10303 @itemx -mno-float32
10304 @opindex mfloat64
10305 @opindex mno-float32
10306 Use 64-bit @code{float}.  This is the default.
10307
10308 @item -mfloat32
10309 @item -mno-float64
10310 @opindex mfloat32
10311 @opindex mno-float64
10312 Use 32-bit @code{float}.
10313
10314 @item -mabshi
10315 @opindex mabshi
10316 Use @code{abshi2} pattern.  This is the default.
10317
10318 @item -mno-abshi
10319 @opindex mno-abshi
10320 Do not use @code{abshi2} pattern.
10321
10322 @item -mbranch-expensive
10323 @opindex mbranch-expensive
10324 Pretend that branches are expensive.  This is for experimenting with
10325 code generation only.
10326
10327 @item -mbranch-cheap
10328 @opindex mbranch-cheap
10329 Do not pretend that branches are expensive.  This is the default.
10330
10331 @item -msplit
10332 @opindex msplit
10333 Generate code for a system with split I&D.
10334
10335 @item -mno-split
10336 @opindex mno-split
10337 Generate code for a system without split I&D.  This is the default.
10338
10339 @item -munix-asm
10340 @opindex munix-asm
10341 Use Unix assembler syntax.  This is the default when configured for
10342 @samp{pdp11-*-bsd}.
10343
10344 @item -mdec-asm
10345 @opindex mdec-asm
10346 Use DEC assembler syntax.  This is the default when configured for any
10347 PDP-11 target other than @samp{pdp11-*-bsd}.
10348 @end table
10349
10350 @node Xstormy16 Options
10351 @subsection Xstormy16 Options
10352 @cindex Xstormy16 Options
10353
10354 These options are defined for Xstormy16:
10355
10356 @table @gcctabopt
10357 @item -msim
10358 @opindex msim
10359 Choose startup files and linker script suitable for the simulator.
10360 @end table
10361
10362 @node FRV Options
10363 @subsection FRV Options
10364 @cindex FRV Options
10365
10366 @table @gcctabopt
10367 @item -mgpr-32
10368 @opindex mgpr-32
10369
10370 Only use the first 32 general purpose registers.
10371
10372 @item -mgpr-64
10373 @opindex mgpr-64
10374
10375 Use all 64 general purpose registers.
10376
10377 @item -mfpr-32
10378 @opindex mfpr-32
10379
10380 Use only the first 32 floating point registers.
10381
10382 @item -mfpr-64
10383 @opindex mfpr-64
10384
10385 Use all 64 floating point registers
10386
10387 @item -mhard-float
10388 @opindex mhard-float
10389
10390 Use hardware instructions for floating point operations.
10391
10392 @item -msoft-float
10393 @opindex msoft-float
10394
10395 Use library routines for floating point operations.
10396
10397 @item -malloc-cc
10398 @opindex malloc-cc
10399
10400 Dynamically allocate condition code registers.
10401
10402 @item -mfixed-cc
10403 @opindex mfixed-cc
10404
10405 Do not try to dynamically allocate condition code registers, only
10406 use @code{icc0} and @code{fcc0}.
10407
10408 @item -mdword
10409 @opindex mdword
10410
10411 Change ABI to use double word insns.
10412
10413 @item -mno-dword
10414 @opindex mno-dword
10415
10416 Do not use double word instructions.
10417
10418 @item -mdouble
10419 @opindex mdouble
10420
10421 Use floating point double instructions.
10422
10423 @item -mno-double
10424 @opindex mno-double
10425
10426 Do not use floating point double instructions.
10427
10428 @item -mmedia
10429 @opindex mmedia
10430
10431 Use media instructions.
10432
10433 @item -mno-media
10434 @opindex mno-media
10435
10436 Do not use media instructions.
10437
10438 @item -mmuladd
10439 @opindex mmuladd
10440
10441 Use multiply and add/subtract instructions.
10442
10443 @item -mno-muladd
10444 @opindex mno-muladd
10445
10446 Do not use multiply and add/subtract instructions.
10447
10448 @item -mlibrary-pic
10449 @opindex mlibrary-pic
10450
10451 Enable PIC support for building libraries
10452
10453 @item -macc-4
10454 @opindex macc-4
10455
10456 Use only the first four media accumulator registers.
10457
10458 @item -macc-8
10459 @opindex macc-8
10460
10461 Use all eight media accumulator registers.
10462
10463 @item -mpack
10464 @opindex mpack
10465
10466 Pack VLIW instructions.
10467
10468 @item -mno-pack
10469 @opindex mno-pack
10470
10471 Do not pack VLIW instructions.
10472
10473 @item -mno-eflags
10474 @opindex mno-eflags
10475
10476 Do not mark ABI switches in e_flags.
10477
10478 @item -mcond-move
10479 @opindex mcond-move
10480
10481 Enable the use of conditional-move instructions (default).
10482
10483 This switch is mainly for debugging the compiler and will likely be removed
10484 in a future version.
10485
10486 @item -mno-cond-move
10487 @opindex mno-cond-move
10488
10489 Disable the use of conditional-move instructions.
10490
10491 This switch is mainly for debugging the compiler and will likely be removed
10492 in a future version.
10493
10494 @item -mscc
10495 @opindex mscc
10496
10497 Enable the use of conditional set instructions (default).
10498
10499 This switch is mainly for debugging the compiler and will likely be removed
10500 in a future version.
10501
10502 @item -mno-scc
10503 @opindex mno-scc
10504
10505 Disable the use of conditional set instructions.
10506
10507 This switch is mainly for debugging the compiler and will likely be removed
10508 in a future version.
10509
10510 @item -mcond-exec
10511 @opindex mcond-exec
10512
10513 Enable the use of conditional execution (default).
10514
10515 This switch is mainly for debugging the compiler and will likely be removed
10516 in a future version.
10517
10518 @item -mno-cond-exec
10519 @opindex mno-cond-exec
10520
10521 Disable the use of conditional execution.
10522
10523 This switch is mainly for debugging the compiler and will likely be removed
10524 in a future version.
10525
10526 @item -mvliw-branch
10527 @opindex mvliw-branch
10528
10529 Run a pass to pack branches into VLIW instructions (default).
10530
10531 This switch is mainly for debugging the compiler and will likely be removed
10532 in a future version.
10533
10534 @item -mno-vliw-branch
10535 @opindex mno-vliw-branch
10536
10537 Do not run a pass to pack branches into VLIW instructions.
10538
10539 This switch is mainly for debugging the compiler and will likely be removed
10540 in a future version.
10541
10542 @item -mmulti-cond-exec
10543 @opindex mmulti-cond-exec
10544
10545 Enable optimization of @code{&&} and @code{||} in conditional execution
10546 (default).
10547
10548 This switch is mainly for debugging the compiler and will likely be removed
10549 in a future version.
10550
10551 @item -mno-multi-cond-exec
10552 @opindex mno-multi-cond-exec
10553
10554 Disable optimization of @code{&&} and @code{||} in conditional execution.
10555
10556 This switch is mainly for debugging the compiler and will likely be removed
10557 in a future version.
10558
10559 @item -mnested-cond-exec
10560 @opindex mnested-cond-exec
10561
10562 Enable nested conditional execution optimizations (default).
10563
10564 This switch is mainly for debugging the compiler and will likely be removed
10565 in a future version.
10566
10567 @item -mno-nested-cond-exec
10568 @opindex mno-nested-cond-exec
10569
10570 Disable nested conditional execution optimizations.
10571
10572 This switch is mainly for debugging the compiler and will likely be removed
10573 in a future version.
10574
10575 @item -mtomcat-stats
10576 @opindex mtomcat-stats
10577
10578 Cause gas to print out tomcat statistics.
10579
10580 @item -mcpu=@var{cpu}
10581 @opindex mcpu
10582
10583 Select the processor type for which to generate code.  Possible values are
10584 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
10585 @samp{frv}.
10586
10587 @end table
10588
10589 @node Xtensa Options
10590 @subsection Xtensa Options
10591 @cindex Xtensa Options
10592
10593 The Xtensa architecture is designed to support many different
10594 configurations.  The compiler's default options can be set to match a
10595 particular Xtensa configuration by copying a configuration file into the
10596 GCC sources when building GCC@.  The options below may be used to
10597 override the default options.
10598
10599 @table @gcctabopt
10600 @item -mbig-endian
10601 @itemx -mlittle-endian
10602 @opindex mbig-endian
10603 @opindex mlittle-endian
10604 Specify big-endian or little-endian byte ordering for the target Xtensa
10605 processor.
10606
10607 @item -mdensity
10608 @itemx -mno-density
10609 @opindex mdensity
10610 @opindex mno-density
10611 Enable or disable use of the optional Xtensa code density instructions.
10612
10613 @item -mmac16
10614 @itemx -mno-mac16
10615 @opindex mmac16
10616 @opindex mno-mac16
10617 Enable or disable use of the Xtensa MAC16 option.  When enabled, GCC
10618 will generate MAC16 instructions from standard C code, with the
10619 limitation that it will use neither the MR register file nor any
10620 instruction that operates on the MR registers.  When this option is
10621 disabled, GCC will translate 16-bit multiply/accumulate operations to a
10622 combination of core instructions and library calls, depending on whether
10623 any other multiplier options are enabled.
10624
10625 @item -mmul16
10626 @itemx -mno-mul16
10627 @opindex mmul16
10628 @opindex mno-mul16
10629 Enable or disable use of the 16-bit integer multiplier option.  When
10630 enabled, the compiler will generate 16-bit multiply instructions for
10631 multiplications of 16 bits or smaller in standard C code.  When this
10632 option is disabled, the compiler will either use 32-bit multiply or
10633 MAC16 instructions if they are available or generate library calls to
10634 perform the multiply operations using shifts and adds.
10635
10636 @item -mmul32
10637 @itemx -mno-mul32
10638 @opindex mmul32
10639 @opindex mno-mul32
10640 Enable or disable use of the 32-bit integer multiplier option.  When
10641 enabled, the compiler will generate 32-bit multiply instructions for
10642 multiplications of 32 bits or smaller in standard C code.  When this
10643 option is disabled, the compiler will generate library calls to perform
10644 the multiply operations using either shifts and adds or 16-bit multiply
10645 instructions if they are available.
10646
10647 @item -mnsa
10648 @itemx -mno-nsa
10649 @opindex mnsa
10650 @opindex mno-nsa
10651 Enable or disable use of the optional normalization shift amount
10652 (@code{NSA}) instructions to implement the built-in @code{ffs} function.
10653
10654 @item -mminmax
10655 @itemx -mno-minmax
10656 @opindex mminmax
10657 @opindex mno-minmax
10658 Enable or disable use of the optional minimum and maximum value
10659 instructions.
10660
10661 @item -msext
10662 @itemx -mno-sext
10663 @opindex msext
10664 @opindex mno-sext
10665 Enable or disable use of the optional sign extend (@code{SEXT})
10666 instruction.
10667
10668 @item -mbooleans
10669 @itemx -mno-booleans
10670 @opindex mbooleans
10671 @opindex mno-booleans
10672 Enable or disable support for the boolean register file used by Xtensa
10673 coprocessors.  This is not typically useful by itself but may be
10674 required for other options that make use of the boolean registers (e.g.,
10675 the floating-point option).
10676
10677 @item -mhard-float
10678 @itemx -msoft-float
10679 @opindex mhard-float
10680 @opindex msoft-float
10681 Enable or disable use of the floating-point option.  When enabled, GCC
10682 generates floating-point instructions for 32-bit @code{float}
10683 operations.  When this option is disabled, GCC generates library calls
10684 to emulate 32-bit floating-point operations using integer instructions.
10685 Regardless of this option, 64-bit @code{double} operations are always
10686 emulated with calls to library functions.
10687
10688 @item -mfused-madd
10689 @itemx -mno-fused-madd
10690 @opindex mfused-madd
10691 @opindex mno-fused-madd
10692 Enable or disable use of fused multiply/add and multiply/subtract
10693 instructions in the floating-point option.  This has no effect if the
10694 floating-point option is not also enabled.  Disabling fused multiply/add
10695 and multiply/subtract instructions forces the compiler to use separate
10696 instructions for the multiply and add/subtract operations.  This may be
10697 desirable in some cases where strict IEEE 754-compliant results are
10698 required: the fused multiply add/subtract instructions do not round the
10699 intermediate result, thereby producing results with @emph{more} bits of
10700 precision than specified by the IEEE standard.  Disabling fused multiply
10701 add/subtract instructions also ensures that the program output is not
10702 sensitive to the compiler's ability to combine multiply and add/subtract
10703 operations.
10704
10705 @item -mserialize-volatile
10706 @itemx -mno-serialize-volatile
10707 @opindex mserialize-volatile
10708 @opindex mno-serialize-volatile
10709 When this option is enabled, GCC inserts @code{MEMW} instructions before
10710 @code{volatile} memory references to guarantee sequential consistency.
10711 The default is @option{-mserialize-volatile}.  Use
10712 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
10713
10714 @item -mtext-section-literals
10715 @itemx -mno-text-section-literals
10716 @opindex mtext-section-literals
10717 @opindex mno-text-section-literals
10718 Control the treatment of literal pools.  The default is
10719 @option{-mno-text-section-literals}, which places literals in a separate
10720 section in the output file.  This allows the literal pool to be placed
10721 in a data RAM/ROM, and it also allows the linker to combine literal
10722 pools from separate object files to remove redundant literals and
10723 improve code size.  With @option{-mtext-section-literals}, the literals
10724 are interspersed in the text section in order to keep them as close as
10725 possible to their references.  This may be necessary for large assembly
10726 files.
10727
10728 @item -mtarget-align
10729 @itemx -mno-target-align
10730 @opindex mtarget-align
10731 @opindex mno-target-align
10732 When this option is enabled, GCC instructs the assembler to
10733 automatically align instructions to reduce branch penalties at the
10734 expense of some code density.  The assembler attempts to widen density
10735 instructions to align branch targets and the instructions following call
10736 instructions.  If there are not enough preceding safe density
10737 instructions to align a target, no widening will be performed.  The
10738 default is @option{-mtarget-align}.  These options do not affect the
10739 treatment of auto-aligned instructions like @code{LOOP}, which the
10740 assembler will always align, either by widening density instructions or
10741 by inserting no-op instructions.
10742
10743 @item -mlongcalls
10744 @itemx -mno-longcalls
10745 @opindex mlongcalls
10746 @opindex mno-longcalls
10747 When this option is enabled, GCC instructs the assembler to translate
10748 direct calls to indirect calls unless it can determine that the target
10749 of a direct call is in the range allowed by the call instruction.  This
10750 translation typically occurs for calls to functions in other source
10751 files.  Specifically, the assembler translates a direct @code{CALL}
10752 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
10753 The default is @option{-mno-longcalls}.  This option should be used in
10754 programs where the call target can potentially be out of range.  This
10755 option is implemented in the assembler, not the compiler, so the
10756 assembly code generated by GCC will still show direct call
10757 instructions---look at the disassembled object code to see the actual
10758 instructions.  Note that the assembler will use an indirect call for
10759 every cross-file call, not just those that really will be out of range.
10760 @end table
10761
10762 @node Code Gen Options
10763 @section Options for Code Generation Conventions
10764 @cindex code generation conventions
10765 @cindex options, code generation
10766 @cindex run-time options
10767
10768 These machine-independent options control the interface conventions
10769 used in code generation.
10770
10771 Most of them have both positive and negative forms; the negative form
10772 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
10773 one of the forms is listed---the one which is not the default.  You
10774 can figure out the other form by either removing @samp{no-} or adding
10775 it.
10776
10777 @table @gcctabopt
10778 @item -fbounds-check
10779 @opindex fbounds-check
10780 For front-ends that support it, generate additional code to check that
10781 indices used to access arrays are within the declared range.  This is
10782 currently only supported by the Java and Fortran 77 front-ends, where
10783 this option defaults to true and false respectively.
10784
10785 @item -ftrapv
10786 @opindex ftrapv
10787 This option generates traps for signed overflow on addition, subtraction,
10788 multiplication operations.
10789
10790 @item -fexceptions
10791 @opindex fexceptions
10792 Enable exception handling.  Generates extra code needed to propagate
10793 exceptions.  For some targets, this implies GCC will generate frame
10794 unwind information for all functions, which can produce significant data
10795 size overhead, although it does not affect execution.  If you do not
10796 specify this option, GCC will enable it by default for languages like
10797 C++ which normally require exception handling, and disable it for
10798 languages like C that do not normally require it.  However, you may need
10799 to enable this option when compiling C code that needs to interoperate
10800 properly with exception handlers written in C++.  You may also wish to
10801 disable this option if you are compiling older C++ programs that don't
10802 use exception handling.
10803
10804 @item -fnon-call-exceptions
10805 @opindex fnon-call-exceptions
10806 Generate code that allows trapping instructions to throw exceptions.
10807 Note that this requires platform-specific runtime support that does
10808 not exist everywhere.  Moreover, it only allows @emph{trapping}
10809 instructions to throw exceptions, i.e.@: memory references or floating
10810 point instructions.  It does not allow exceptions to be thrown from
10811 arbitrary signal handlers such as @code{SIGALRM}.
10812
10813 @item -fforced-unwind-exceptions
10814 @opindex fforced-unwind-exceptions
10815 Generate code that checks for non-catchable exceptions derived from
10816 @code{_Unwind_ForcedUnwind}, such as from @code{longjmp_unwind} or
10817 from pthread cancellation.  There is some amount of code-size 
10818 overhead associated with this, so it is not default.
10819
10820 @item -funwind-tables
10821 @opindex funwind-tables
10822 Similar to @option{-fexceptions}, except that it will just generate any needed
10823 static data, but will not affect the generated code in any other way.
10824 You will normally not enable this option; instead, a language processor
10825 that needs this handling would enable it on your behalf.
10826
10827 @item -fasynchronous-unwind-tables
10828 @opindex funwind-tables
10829 Generate unwind table in dwarf2 format, if supported by target machine.  The
10830 table is exact at each instruction boundary, so it can be used for stack
10831 unwinding from asynchronous events (such as debugger or garbage collector).
10832
10833 @item -fpcc-struct-return
10834 @opindex fpcc-struct-return
10835 Return ``short'' @code{struct} and @code{union} values in memory like
10836 longer ones, rather than in registers.  This convention is less
10837 efficient, but it has the advantage of allowing intercallability between
10838 GCC-compiled files and files compiled with other compilers, particularly
10839 the Portable C Compiler (pcc).
10840
10841 The precise convention for returning structures in memory depends
10842 on the target configuration macros.
10843
10844 Short structures and unions are those whose size and alignment match
10845 that of some integer type.
10846
10847 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
10848 switch is not binary compatible with code compiled with the
10849 @option{-freg-struct-return} switch.
10850 Use it to conform to a non-default application binary interface.
10851
10852 @item -freg-struct-return
10853 @opindex freg-struct-return
10854 Return @code{struct} and @code{union} values in registers when possible.
10855 This is more efficient for small structures than
10856 @option{-fpcc-struct-return}.
10857
10858 If you specify neither @option{-fpcc-struct-return} nor
10859 @option{-freg-struct-return}, GCC defaults to whichever convention is
10860 standard for the target.  If there is no standard convention, GCC
10861 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
10862 the principal compiler.  In those cases, we can choose the standard, and
10863 we chose the more efficient register return alternative.
10864
10865 @strong{Warning:} code compiled with the @option{-freg-struct-return}
10866 switch is not binary compatible with code compiled with the
10867 @option{-fpcc-struct-return} switch.
10868 Use it to conform to a non-default application binary interface.
10869
10870 @item -fshort-enums
10871 @opindex fshort-enums
10872 Allocate to an @code{enum} type only as many bytes as it needs for the
10873 declared range of possible values.  Specifically, the @code{enum} type
10874 will be equivalent to the smallest integer type which has enough room.
10875
10876 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
10877 code that is not binary compatible with code generated without that switch.
10878 Use it to conform to a non-default application binary interface.
10879
10880 @item -fshort-double
10881 @opindex fshort-double
10882 Use the same size for @code{double} as for @code{float}.
10883
10884 @strong{Warning:} the @option{-fshort-double} 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-wchar
10889 @opindex fshort-wchar
10890 Override the underlying type for @samp{wchar_t} to be @samp{short
10891 unsigned int} instead of the default for the target.  This option is
10892 useful for building programs to run under WINE@.
10893
10894 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
10895 code that is not binary compatible with code generated without that switch.
10896 Use it to conform to a non-default application binary interface.
10897
10898 @item -fshared-data
10899 @opindex fshared-data
10900 Requests that the data and non-@code{const} variables of this
10901 compilation be shared data rather than private data.  The distinction
10902 makes sense only on certain operating systems, where shared data is
10903 shared between processes running the same program, while private data
10904 exists in one copy per process.
10905
10906 @item -fno-common
10907 @opindex fno-common
10908 In C, allocate even uninitialized global variables in the data section of the
10909 object file, rather than generating them as common blocks.  This has the
10910 effect that if the same variable is declared (without @code{extern}) in
10911 two different compilations, you will get an error when you link them.
10912 The only reason this might be useful is if you wish to verify that the
10913 program will work on other systems which always work this way.
10914
10915 @item -fno-ident
10916 @opindex fno-ident
10917 Ignore the @samp{#ident} directive.
10918
10919 @item -fno-gnu-linker
10920 @opindex fno-gnu-linker
10921 Do not output global initializations (such as C++ constructors and
10922 destructors) in the form used by the GNU linker (on systems where the GNU
10923 linker is the standard method of handling them).  Use this option when
10924 you want to use a non-GNU linker, which also requires using the
10925 @command{collect2} program to make sure the system linker includes
10926 constructors and destructors.  (@command{collect2} is included in the GCC
10927 distribution.)  For systems which @emph{must} use @command{collect2}, the
10928 compiler driver @command{gcc} is configured to do this automatically.
10929
10930 @item -finhibit-size-directive
10931 @opindex finhibit-size-directive
10932 Don't output a @code{.size} assembler directive, or anything else that
10933 would cause trouble if the function is split in the middle, and the
10934 two halves are placed at locations far apart in memory.  This option is
10935 used when compiling @file{crtstuff.c}; you should not need to use it
10936 for anything else.
10937
10938 @item -fverbose-asm
10939 @opindex fverbose-asm
10940 Put extra commentary information in the generated assembly code to
10941 make it more readable.  This option is generally only of use to those
10942 who actually need to read the generated assembly code (perhaps while
10943 debugging the compiler itself).
10944
10945 @option{-fno-verbose-asm}, the default, causes the
10946 extra information to be omitted and is useful when comparing two assembler
10947 files.
10948
10949 @item -fpic
10950 @opindex fpic
10951 @cindex global offset table
10952 @cindex PIC
10953 Generate position-independent code (PIC) suitable for use in a shared
10954 library, if supported for the target machine.  Such code accesses all
10955 constant addresses through a global offset table (GOT)@.  The dynamic
10956 loader resolves the GOT entries when the program starts (the dynamic
10957 loader is not part of GCC; it is part of the operating system).  If
10958 the GOT size for the linked executable exceeds a machine-specific
10959 maximum size, you get an error message from the linker indicating that
10960 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
10961 instead.  (These maximums are 16k on the m88k, 8k on the SPARC, and 32k
10962 on the m68k and RS/6000.  The 386 has no such limit.)
10963
10964 Position-independent code requires special support, and therefore works
10965 only on certain machines.  For the 386, GCC supports PIC for System V
10966 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
10967 position-independent.
10968
10969 @item -fPIC
10970 @opindex fPIC
10971 If supported for the target machine, emit position-independent code,
10972 suitable for dynamic linking and avoiding any limit on the size of the
10973 global offset table.  This option makes a difference on the m68k, m88k,
10974 and the SPARC.
10975
10976 Position-independent code requires special support, and therefore works
10977 only on certain machines.
10978
10979 @item -ffixed-@var{reg}
10980 @opindex ffixed
10981 Treat the register named @var{reg} as a fixed register; generated code
10982 should never refer to it (except perhaps as a stack pointer, frame
10983 pointer or in some other fixed role).
10984
10985 @var{reg} must be the name of a register.  The register names accepted
10986 are machine-specific and are defined in the @code{REGISTER_NAMES}
10987 macro in the machine description macro file.
10988
10989 This flag does not have a negative form, because it specifies a
10990 three-way choice.
10991
10992 @item -fcall-used-@var{reg}
10993 @opindex fcall-used
10994 Treat the register named @var{reg} as an allocable register that is
10995 clobbered by function calls.  It may be allocated for temporaries or
10996 variables that do not live across a call.  Functions compiled this way
10997 will not save and restore the register @var{reg}.
10998
10999 It is an error to used this flag with the frame pointer or stack pointer.
11000 Use of this flag for other registers that have fixed pervasive roles in
11001 the machine's execution model will produce disastrous results.
11002
11003 This flag does not have a negative form, because it specifies a
11004 three-way choice.
11005
11006 @item -fcall-saved-@var{reg}
11007 @opindex fcall-saved
11008 Treat the register named @var{reg} as an allocable register saved by
11009 functions.  It may be allocated even for temporaries or variables that
11010 live across a call.  Functions compiled this way will save and restore
11011 the register @var{reg} if they use it.
11012
11013 It is an error to used this flag with the frame pointer or stack pointer.
11014 Use of this flag for other registers that have fixed pervasive roles in
11015 the machine's execution model will produce disastrous results.
11016
11017 A different sort of disaster will result from the use of this flag for
11018 a register in which function values may be returned.
11019
11020 This flag does not have a negative form, because it specifies a
11021 three-way choice.
11022
11023 @item -fpack-struct
11024 @opindex fpack-struct
11025 Pack all structure members together without holes.
11026
11027 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11028 code that is not binary compatible with code generated without that switch.
11029 Additionally, it makes the code suboptimal.
11030 Use it to conform to a non-default application binary interface.
11031
11032 @item -finstrument-functions
11033 @opindex finstrument-functions
11034 Generate instrumentation calls for entry and exit to functions.  Just
11035 after function entry and just before function exit, the following
11036 profiling functions will be called with the address of the current
11037 function and its call site.  (On some platforms,
11038 @code{__builtin_return_address} does not work beyond the current
11039 function, so the call site information may not be available to the
11040 profiling functions otherwise.)
11041
11042 @example
11043 void __cyg_profile_func_enter (void *this_fn,
11044                                void *call_site);
11045 void __cyg_profile_func_exit  (void *this_fn,
11046                                void *call_site);
11047 @end example
11048
11049 The first argument is the address of the start of the current function,
11050 which may be looked up exactly in the symbol table.
11051
11052 This instrumentation is also done for functions expanded inline in other
11053 functions.  The profiling calls will indicate where, conceptually, the
11054 inline function is entered and exited.  This means that addressable
11055 versions of such functions must be available.  If all your uses of a
11056 function are expanded inline, this may mean an additional expansion of
11057 code size.  If you use @samp{extern inline} in your C code, an
11058 addressable version of such functions must be provided.  (This is
11059 normally the case anyways, but if you get lucky and the optimizer always
11060 expands the functions inline, you might have gotten away without
11061 providing static copies.)
11062
11063 A function may be given the attribute @code{no_instrument_function}, in
11064 which case this instrumentation will not be done.  This can be used, for
11065 example, for the profiling functions listed above, high-priority
11066 interrupt routines, and any functions from which the profiling functions
11067 cannot safely be called (perhaps signal handlers, if the profiling
11068 routines generate output or allocate memory).
11069
11070 @item -fstack-check
11071 @opindex fstack-check
11072 Generate code to verify that you do not go beyond the boundary of the
11073 stack.  You should specify this flag if you are running in an
11074 environment with multiple threads, but only rarely need to specify it in
11075 a single-threaded environment since stack overflow is automatically
11076 detected on nearly all systems if there is only one stack.
11077
11078 Note that this switch does not actually cause checking to be done; the
11079 operating system must do that.  The switch causes generation of code
11080 to ensure that the operating system sees the stack being extended.
11081
11082 @item -fstack-limit-register=@var{reg}
11083 @itemx -fstack-limit-symbol=@var{sym}
11084 @itemx -fno-stack-limit
11085 @opindex fstack-limit-register
11086 @opindex fstack-limit-symbol
11087 @opindex fno-stack-limit
11088 Generate code to ensure that the stack does not grow beyond a certain value,
11089 either the value of a register or the address of a symbol.  If the stack
11090 would grow beyond the value, a signal is raised.  For most targets,
11091 the signal is raised before the stack overruns the boundary, so
11092 it is possible to catch the signal without taking special precautions.
11093
11094 For instance, if the stack starts at absolute address @samp{0x80000000}
11095 and grows downwards, you can use the flags
11096 @option{-fstack-limit-symbol=__stack_limit} and
11097 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11098 of 128KB@.  Note that this may only work with the GNU linker.
11099
11100 @cindex aliasing of parameters
11101 @cindex parameters, aliased
11102 @item -fargument-alias
11103 @itemx -fargument-noalias
11104 @itemx -fargument-noalias-global
11105 @opindex fargument-alias
11106 @opindex fargument-noalias
11107 @opindex fargument-noalias-global
11108 Specify the possible relationships among parameters and between
11109 parameters and global data.
11110
11111 @option{-fargument-alias} specifies that arguments (parameters) may
11112 alias each other and may alias global storage.@*
11113 @option{-fargument-noalias} specifies that arguments do not alias
11114 each other, but may alias global storage.@*
11115 @option{-fargument-noalias-global} specifies that arguments do not
11116 alias each other and do not alias global storage.
11117
11118 Each language will automatically use whatever option is required by
11119 the language standard.  You should not need to use these options yourself.
11120
11121 @item -fleading-underscore
11122 @opindex fleading-underscore
11123 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11124 change the way C symbols are represented in the object file.  One use
11125 is to help link with legacy assembly code.
11126
11127 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11128 generate code that is not binary compatible with code generated without that
11129 switch.  Use it to conform to a non-default application binary interface.
11130 Not all targets provide complete support for this switch.
11131
11132 @item -ftls-model=@var{model}
11133 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11134 The @var{model} argument should be one of @code{global-dynamic},
11135 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11136
11137 The default without @option{-fpic} is @code{initial-exec}; with
11138 @option{-fpic} the default is @code{global-dynamic}.
11139 @end table
11140
11141 @c man end
11142
11143 @node Environment Variables
11144 @section Environment Variables Affecting GCC
11145 @cindex environment variables
11146
11147 @c man begin ENVIRONMENT
11148
11149 This section describes several environment variables that affect how GCC
11150 operates.  Some of them work by specifying directories or prefixes to use
11151 when searching for various kinds of files.  Some are used to specify other
11152 aspects of the compilation environment.
11153
11154 Note that you can also specify places to search using options such as
11155 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11156 take precedence over places specified using environment variables, which
11157 in turn take precedence over those specified by the configuration of GCC@.
11158 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11159 GNU Compiler Collection (GCC) Internals}.
11160
11161 @table @env
11162 @item LANG
11163 @itemx LC_CTYPE
11164 @c @itemx LC_COLLATE
11165 @itemx LC_MESSAGES
11166 @c @itemx LC_MONETARY
11167 @c @itemx LC_NUMERIC
11168 @c @itemx LC_TIME
11169 @itemx LC_ALL
11170 @findex LANG
11171 @findex LC_CTYPE
11172 @c @findex LC_COLLATE
11173 @findex LC_MESSAGES
11174 @c @findex LC_MONETARY
11175 @c @findex LC_NUMERIC
11176 @c @findex LC_TIME
11177 @findex LC_ALL
11178 @cindex locale
11179 These environment variables control the way that GCC uses
11180 localization information that allow GCC to work with different
11181 national conventions.  GCC inspects the locale categories
11182 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11183 so.  These locale categories can be set to any value supported by your
11184 installation.  A typical value is @samp{en_UK} for English in the United
11185 Kingdom.
11186
11187 The @env{LC_CTYPE} environment variable specifies character
11188 classification.  GCC uses it to determine the character boundaries in
11189 a string; this is needed for some multibyte encodings that contain quote
11190 and escape characters that would otherwise be interpreted as a string
11191 end or escape.
11192
11193 The @env{LC_MESSAGES} environment variable specifies the language to
11194 use in diagnostic messages.
11195
11196 If the @env{LC_ALL} environment variable is set, it overrides the value
11197 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11198 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11199 environment variable.  If none of these variables are set, GCC
11200 defaults to traditional C English behavior.
11201
11202 @item TMPDIR
11203 @findex TMPDIR
11204 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11205 files.  GCC uses temporary files to hold the output of one stage of
11206 compilation which is to be used as input to the next stage: for example,
11207 the output of the preprocessor, which is the input to the compiler
11208 proper.
11209
11210 @item GCC_EXEC_PREFIX
11211 @findex GCC_EXEC_PREFIX
11212 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11213 names of the subprograms executed by the compiler.  No slash is added
11214 when this prefix is combined with the name of a subprogram, but you can
11215 specify a prefix that ends with a slash if you wish.
11216
11217 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11218 an appropriate prefix to use based on the pathname it was invoked with.
11219
11220 If GCC cannot find the subprogram using the specified prefix, it
11221 tries looking in the usual places for the subprogram.
11222
11223 The default value of @env{GCC_EXEC_PREFIX} is
11224 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
11225 of @code{prefix} when you ran the @file{configure} script.
11226
11227 Other prefixes specified with @option{-B} take precedence over this prefix.
11228
11229 This prefix is also used for finding files such as @file{crt0.o} that are
11230 used for linking.
11231
11232 In addition, the prefix is used in an unusual way in finding the
11233 directories to search for header files.  For each of the standard
11234 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
11235 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11236 replacing that beginning with the specified prefix to produce an
11237 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11238 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11239 These alternate directories are searched first; the standard directories
11240 come next.
11241
11242 @item COMPILER_PATH
11243 @findex COMPILER_PATH
11244 The value of @env{COMPILER_PATH} is a colon-separated list of
11245 directories, much like @env{PATH}.  GCC tries the directories thus
11246 specified when searching for subprograms, if it can't find the
11247 subprograms using @env{GCC_EXEC_PREFIX}.
11248
11249 @item LIBRARY_PATH
11250 @findex LIBRARY_PATH
11251 The value of @env{LIBRARY_PATH} is a colon-separated list of
11252 directories, much like @env{PATH}.  When configured as a native compiler,
11253 GCC tries the directories thus specified when searching for special
11254 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11255 using GCC also uses these directories when searching for ordinary
11256 libraries for the @option{-l} option (but directories specified with
11257 @option{-L} come first).
11258
11259 @item LANG
11260 @findex LANG
11261 @cindex locale definition
11262 This variable is used to pass locale information to the compiler.  One way in
11263 which this information is used is to determine the character set to be used
11264 when character literals, string literals and comments are parsed in C and C++.
11265 When the compiler is configured to allow multibyte characters,
11266 the following values for @env{LANG} are recognized:
11267
11268 @table @samp
11269 @item C-JIS
11270 Recognize JIS characters.
11271 @item C-SJIS
11272 Recognize SJIS characters.
11273 @item C-EUCJP
11274 Recognize EUCJP characters.
11275 @end table
11276
11277 If @env{LANG} is not defined, or if it has some other value, then the
11278 compiler will use mblen and mbtowc as defined by the default locale to
11279 recognize and translate multibyte characters.
11280 @end table
11281
11282 @noindent
11283 Some additional environments variables affect the behavior of the
11284 preprocessor.
11285
11286 @include cppenv.texi
11287
11288 @c man end
11289
11290 @node Precompiled Headers
11291 @section Using Precompiled Headers
11292 @cindex precompiled headers
11293 @cindex speed of compilation
11294
11295 Often large projects have many header files that are included in every
11296 source file.  The time the compiler takes to process these header files
11297 over and over again can account for nearly all of the time required to
11298 build the project.  To make builds faster, GCC allows users to
11299 `precompile' a header file; then, if builds can use the precompiled
11300 header file they will be much faster.
11301
11302 To create a precompiled header file, simply compile it as you would any
11303 other file, if necessary using the @option{-x} option to make the driver
11304 treat it as a C or C++ header file.  You will probably want to use a
11305 tool like @command{make} to keep the precompiled header up-to-date when
11306 the headers it contains change.
11307
11308 A precompiled header file will be searched for when @code{#include} is
11309 seen in the compilation.  As it searches for the included file
11310 (@pxref{Search Path,,Search Path,cpp.info,The C Preprocessor}) the
11311 compiler looks for a precompiled header in each directory just before it
11312 looks for the include file in that directory.  The name searched for is
11313 the name specified in the @code{#include} with @samp{.gch} appended.  If
11314 the precompiled header file can't be used, it is ignored.
11315
11316 For instance, if you have @code{#include "all.h"}, and you have
11317 @file{all.h.gch} in the same directory as @file{all.h}, then the
11318 precompiled header file will be used if possible, and the original
11319 header will be used otherwise.
11320
11321 Alternatively, you might decide to put the precompiled header file in a
11322 directory and use @option{-I} to ensure that directory is searched
11323 before (or instead of) the directory containing the original header.
11324 Then, if you want to check that the precompiled header file is always
11325 used, you can put a file of the same name as the original header in this
11326 directory containing an @code{#error} command.
11327
11328 This also works with @option{-include}.  So yet another way to use
11329 precompiled headers, good for projects not designed with precompiled
11330 header files in mind, is to simply take most of the header files used by
11331 a project, include them from another header file, precompile that header
11332 file, and @option{-include} the precompiled header.  If the header files
11333 have guards against multiple inclusion, they will be skipped because
11334 they've already been included (in the precompiled header).
11335
11336 If you need to precompile the same header file for different
11337 languages, targets, or compiler options, you can instead make a
11338 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11339 header in the directory.  (It doesn't matter what you call the files
11340 in the directory, every precompiled header in the directory will be
11341 considered.)  The first precompiled header encountered in the
11342 directory that is valid for this compilation will be used; they're
11343 searched in no particular order.
11344
11345 There are many other possibilities, limited only by your imagination,
11346 good sense, and the constraints of your build system.
11347
11348 A precompiled header file can be used only when these conditions apply:
11349
11350 @itemize
11351 @item
11352 Only one precompiled header can be used in a particular compilation.
11353 @item
11354 A precompiled header can't be used once the first C token is seen.  You
11355 can have preprocessor directives before a precompiled header; you can
11356 even include a precompiled header from inside another header, so long as
11357 there are no C tokens before the @code{#include}.
11358 @item
11359 The precompiled header file must be produced for the same language as
11360 the current compilation.  You can't use a C precompiled header for a C++
11361 compilation.
11362 @item
11363 The precompiled header file must be produced by the same compiler
11364 version and configuration as the current compilation is using.
11365 The easiest way to guarantee this is to use the same compiler binary
11366 for creating and using precompiled headers.
11367 @item
11368 Any macros defined before the precompiled header (including with
11369 @option{-D}) must either be defined in the same way as when the
11370 precompiled header was generated, or must not affect the precompiled
11371 header, which usually means that the they don't appear in the
11372 precompiled header at all.
11373 @item
11374 Certain command-line options must be defined in the same way as when the
11375 precompiled header was generated.  At present, it's not clear which
11376 options are safe to change and which are not; the safest choice is to
11377 use exactly the same options when generating and using the precompiled
11378 header.
11379 @end itemize
11380
11381 For all of these but the last, the compiler will automatically ignore
11382 the precompiled header if the conditions aren't met.  For the last item,
11383 some option changes will cause the precompiled header to be rejected,
11384 but not all incompatible option combinations have yet been found.  If
11385 you find a new incompatible combination, please consider filing a bug
11386 report, see @ref{Bugs}.
11387
11388 @node Running Protoize
11389 @section Running Protoize
11390
11391 The program @code{protoize} is an optional part of GCC@.  You can use
11392 it to add prototypes to a program, thus converting the program to ISO
11393 C in one respect.  The companion program @code{unprotoize} does the
11394 reverse: it removes argument types from any prototypes that are found.
11395
11396 When you run these programs, you must specify a set of source files as
11397 command line arguments.  The conversion programs start out by compiling
11398 these files to see what functions they define.  The information gathered
11399 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11400
11401 After scanning comes actual conversion.  The specified files are all
11402 eligible to be converted; any files they include (whether sources or
11403 just headers) are eligible as well.
11404
11405 But not all the eligible files are converted.  By default,
11406 @code{protoize} and @code{unprotoize} convert only source and header
11407 files in the current directory.  You can specify additional directories
11408 whose files should be converted with the @option{-d @var{directory}}
11409 option.  You can also specify particular files to exclude with the
11410 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11411 directory name matches one of the specified directory names, and its
11412 name within the directory has not been excluded.
11413
11414 Basic conversion with @code{protoize} consists of rewriting most
11415 function definitions and function declarations to specify the types of
11416 the arguments.  The only ones not rewritten are those for varargs
11417 functions.
11418
11419 @code{protoize} optionally inserts prototype declarations at the
11420 beginning of the source file, to make them available for any calls that
11421 precede the function's definition.  Or it can insert prototype
11422 declarations with block scope in the blocks where undeclared functions
11423 are called.
11424
11425 Basic conversion with @code{unprotoize} consists of rewriting most
11426 function declarations to remove any argument types, and rewriting
11427 function definitions to the old-style pre-ISO form.
11428
11429 Both conversion programs print a warning for any function declaration or
11430 definition that they can't convert.  You can suppress these warnings
11431 with @option{-q}.
11432
11433 The output from @code{protoize} or @code{unprotoize} replaces the
11434 original source file.  The original file is renamed to a name ending
11435 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11436 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11437 for DOS) file already exists, then the source file is simply discarded.
11438
11439 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11440 scan the program and collect information about the functions it uses.
11441 So neither of these programs will work until GCC is installed.
11442
11443 Here is a table of the options you can use with @code{protoize} and
11444 @code{unprotoize}.  Each option works with both programs unless
11445 otherwise stated.
11446
11447 @table @code
11448 @item -B @var{directory}
11449 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11450 usual directory (normally @file{/usr/local/lib}).  This file contains
11451 prototype information about standard system functions.  This option
11452 applies only to @code{protoize}.
11453
11454 @item -c @var{compilation-options}
11455 Use @var{compilation-options} as the options when running @command{gcc} to
11456 produce the @samp{.X} files.  The special option @option{-aux-info} is
11457 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11458
11459 Note that the compilation options must be given as a single argument to
11460 @code{protoize} or @code{unprotoize}.  If you want to specify several
11461 @command{gcc} options, you must quote the entire set of compilation options
11462 to make them a single word in the shell.
11463
11464 There are certain @command{gcc} arguments that you cannot use, because they
11465 would produce the wrong kind of output.  These include @option{-g},
11466 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11467 the @var{compilation-options}, they are ignored.
11468
11469 @item -C
11470 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11471 systems) instead of @samp{.c}.  This is convenient if you are converting
11472 a C program to C++.  This option applies only to @code{protoize}.
11473
11474 @item -g
11475 Add explicit global declarations.  This means inserting explicit
11476 declarations at the beginning of each source file for each function
11477 that is called in the file and was not declared.  These declarations
11478 precede the first function definition that contains a call to an
11479 undeclared function.  This option applies only to @code{protoize}.
11480
11481 @item -i @var{string}
11482 Indent old-style parameter declarations with the string @var{string}.
11483 This option applies only to @code{protoize}.
11484
11485 @code{unprotoize} converts prototyped function definitions to old-style
11486 function definitions, where the arguments are declared between the
11487 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11488 uses five spaces as the indentation.  If you want to indent with just
11489 one space instead, use @option{-i " "}.
11490
11491 @item -k
11492 Keep the @samp{.X} files.  Normally, they are deleted after conversion
11493 is finished.
11494
11495 @item -l
11496 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
11497 a prototype declaration for each function in each block which calls the
11498 function without any declaration.  This option applies only to
11499 @code{protoize}.
11500
11501 @item -n
11502 Make no real changes.  This mode just prints information about the conversions
11503 that would have been done without @option{-n}.
11504
11505 @item -N
11506 Make no @samp{.save} files.  The original files are simply deleted.
11507 Use this option with caution.
11508
11509 @item -p @var{program}
11510 Use the program @var{program} as the compiler.  Normally, the name
11511 @file{gcc} is used.
11512
11513 @item -q
11514 Work quietly.  Most warnings are suppressed.
11515
11516 @item -v
11517 Print the version number, just like @option{-v} for @command{gcc}.
11518 @end table
11519
11520 If you need special compiler options to compile one of your program's
11521 source files, then you should generate that file's @samp{.X} file
11522 specially, by running @command{gcc} on that source file with the
11523 appropriate options and the option @option{-aux-info}.  Then run
11524 @code{protoize} on the entire set of files.  @code{protoize} will use
11525 the existing @samp{.X} file because it is newer than the source file.
11526 For example:
11527
11528 @example
11529 gcc -Dfoo=bar file1.c -aux-info file1.X
11530 protoize *.c
11531 @end example
11532
11533 @noindent
11534 You need to include the special files along with the rest in the
11535 @code{protoize} command, even though their @samp{.X} files already
11536 exist, because otherwise they won't get converted.
11537
11538 @xref{Protoize Caveats}, for more information on how to use
11539 @code{protoize} successfully.